eboekhouden 1.0.2

OpenAPI client for e-Boekhouden.
Documentation
# PatchRelation

## Properties

| Name                            | Type                                 | Description                                                                                                                                                                                                                                                                                                                 | Notes      |
| ------------------------------- | ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| **r#type**                      | Option<**String**>                   | Business (`B`) or Private (`P`). Defaults to `B` if empty.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_001\">REL_001</a></td><td>Relation type is invalid (B,P).</td></table></div>                                                                                                                           | [optional] |
| **code**                        | Option<**String**>                   | The code of the relation. Auto-generated if empty.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_049\">REL_049</a></td><td>Code already exists.</td><tr><td><a href=\"#REL_005\">REL_005</a></td><td>Code is invalid.</td><tr><td><a href=\"#REL_006\">REL_006</a></td><td>Code is too long.</td></table></div> | [optional] |
| **name**                        | **String**                           | The (company) name of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_002\">REL_002</a></td><td>Name is mandatory.</td><tr><td><a href=\"#REL_003\">REL_003</a></td><td>Name is too long.</td></table></div>                                                                                        |
| **salutation**                  | Option<**String**>                   | The salutation of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_010\">REL_010</a></td><td>Salutation is too long.</td></table></div>                                                                                                                                                              | [optional] |
| **contact**                     | Option<**String**>                   | The contact of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_009\">REL_009</a></td><td>Contact is too long.</td></table></div>                                                                                                                                                                    | [optional] |
| **gender**                      | Option<**String**>                   | Male (`m`) or female (`v`) or department (`a`)<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_004\">REL_004</a></td><td>Gender is invalid (m,v,a).</td></table></div>                                                                                                                                            | [optional] |
| **address**                     | Option<**String**>                   | The primary address of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_011\">REL_011</a></td><td>Address is too long.</td></table></div>                                                                                                                                                            | [optional] |
| **postal_code**                 | Option<**String**>                   | The primary postal code of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_012\">REL_012</a></td><td>Postal code is too long.</td></table></div>                                                                                                                                                    | [optional] |
| **city**                        | Option<**String**>                   | The primary city of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_013\">REL_013</a></td><td>City is too long.</td></table></div>                                                                                                                                                                  | [optional] |
| **country**                     | Option<**String**>                   | The primary country of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_014\">REL_014</a></td><td>Country is too long.</td></table></div>                                                                                                                                                            | [optional] |
| **address2**                    | Option<**String**>                   | The secondary address of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_015\">REL_015</a></td><td>Address 2 is too long.</td></table></div>                                                                                                                                                        | [optional] |
| **postal_code2**                | Option<**String**>                   | The secondary postal code of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_016\">REL_016</a></td><td>Postal code 2 is too long.</td></table></div>                                                                                                                                                | [optional] |
| **city2**                       | Option<**String**>                   | The secondary city of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_017\">REL_017</a></td><td>City 2 is too long.</td></table></div>                                                                                                                                                              | [optional] |
| **country2**                    | Option<**String**>                   | The secondary country of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_018\">REL_018</a></td><td>Country 2 is too long.</td></table></div>                                                                                                                                                        | [optional] |
| **phone_number**                | Option<**String**>                   | The phone number of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_019\">REL_019</a></td><td>Phone is too long.</td></table></div>                                                                                                                                                                 | [optional] |
| **mobile_phone_number**         | Option<**String**>                   | The mobile phone number of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_020\">REL_020</a></td><td>Mobile is too long.</td></table></div>                                                                                                                                                         | [optional] |
| **fax_number**                  | Option<**String**>                   | The fax number of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_021\">REL_021</a></td><td>Fax is too long.</td></table></div>                                                                                                                                                                     | [optional] |
| **email_address**               | Option<**String**>                   | The email address of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_022\">REL_022</a></td><td>Email is too long.</td><tr><td><a href=\"#REL_023\">REL_023</a></td><td>Email is invalid.</td></table></div>                                                                                         | [optional] |
| **email_address_invoice**       | Option<**String**>                   | The invoice email address of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_024\">REL_024</a></td><td>Email invoice is too long.</td><tr><td><a href=\"#REL_025\">REL_025</a></td><td>Email invoice is invalid.</td></table></div>                                                                 | [optional] |
| **email_address_reminder**      | Option<**String**>                   | The reminder email address of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_026\">REL_026</a></td><td>Email reminder is too long.</td><tr><td><a href=\"#REL_027\">REL_027</a></td><td>Email reminder is invalid.</td></table></div>                                                              | [optional] |
| **website**                     | Option<**String**>                   | The website of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_028\">REL_028</a></td><td>Website is too long.</td></table></div>                                                                                                                                                                    | [optional] |
| **note**                        | Option<**String**>                   | The note of the relation.                                                                                                                                                                                                                                                                                                   | [optional] |
| **vat_number**                  | Option<**String**>                   | The VAT number of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_035\">REL_035</a></td><td>VAT number is too long.</td></table></div>                                                                                                                                                              | [optional] |
| **inactive**                    | Option<**bool**>                     | Whether the relation is inactive.                                                                                                                                                                                                                                                                                           | [optional] |
| **term_of_payment**             | Option<**i32**>                      | The payment term of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_030\">REL_030</a></td><td>Term of payment too low.</td><tr><td><a href=\"#REL_031\">REL_031</a></td><td>Term of payment too high.</td></table></div>                                                                            | [optional] |
| **company_registration_number** | Option<**String**>                   | The company registration number of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_008\">REL_008</a></td><td>Company registration number must be numeric.</td><tr><td><a href=\"#REL_050\">REL_050</a></td><td>Company registration number is too long.</td></table></div>                          | [optional] |
| **iban**                        | Option<**String**>                   | The IBAN number of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_007\">REL_007</a></td><td>Iban is invalid.</td><tr><td><a href=\"#REL_029\">REL_029</a></td><td>Iban is too long.</td></table></div>                                                                                             | [optional] |
| **bic**                         | Option<**String**>                   | The BIC number of the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_032\">REL_032</a></td><td>BIC is too long.</td></table></div>                                                                                                                                                                     | [optional] |
| **free_text1**                  | Option<**String**>                   | Free text field for the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_037\">REL_037</a></td><td>Free text 1 is too long.</td></table></div>                                                                                                                                                           | [optional] |
| **free_text2**                  | Option<**String**>                   | Free text field for the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_038\">REL_038</a></td><td>Free text 2 is too long.</td></table></div>                                                                                                                                                           | [optional] |
| **free_text3**                  | Option<**String**>                   | Free text field for the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_039\">REL_039</a></td><td>Free text 3 is too long.</td></table></div>                                                                                                                                                           | [optional] |
| **free_text4**                  | Option<**String**>                   | Free text field for the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_040\">REL_040</a></td><td>Free text 4 is too long.</td></table></div>                                                                                                                                                           | [optional] |
| **free_text5**                  | Option<**String**>                   | Free text field for the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_041\">REL_041</a></td><td>Free text 5 is too long.</td></table></div>                                                                                                                                                           | [optional] |
| **free_text6**                  | Option<**String**>                   | Free text field for the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_042\">REL_042</a></td><td>Free text 6 is too long.</td></table></div>                                                                                                                                                           | [optional] |
| **free_text7**                  | Option<**String**>                   | Free text field for the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_043\">REL_043</a></td><td>Free text 7 is too long.</td></table></div>                                                                                                                                                           | [optional] |
| **free_text8**                  | Option<**String**>                   | Free text field for the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_044\">REL_044</a></td><td>Free text 8 is too long.</td></table></div>                                                                                                                                                           | [optional] |
| **free_text9**                  | Option<**String**>                   | Free text field for the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_045\">REL_045</a></td><td>Free text 9 is too long.</td></table></div>                                                                                                                                                           | [optional] |
| **free_text10**                 | Option<**String**>                   | Free text field for the relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_046\">REL_046</a></td><td>Free text 10 is too long.</td></table></div>                                                                                                                                                          | [optional] |
| **do_not_receive_newsletters**  | Option<**bool**>                     | Whether the relation will receive newsletters or not.                                                                                                                                                                                                                                                                       | [optional] |
| **ledger_id**                   | Option<**i32**>                      | The ledger ID of this relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_048\">REL_048</a></td><td>Ledger not found.</td></table></div>                                                                                                                                                                    | [optional] |
| **mandate**                     | Option<**bool**>                     | Enable or disable mandate.                                                                                                                                                                                                                                                                                                  | [optional] |
| **mandate_type**                | Option<**String**>                   | one-time (`E`) or continuous (`D`)<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_033\">REL_033</a></td><td>Mandate type is too long.</td><tr><td><a href=\"#REL_051\">REL_051</a></td><td>Mandate type is invalid (E,D).</td></table></div>                                                                     | [optional] |
| **mandate_id**                  | Option<**String**>                   | The mandate ID of this relation.<br><div><h3>Error codes</h3><table><tr><td><a href=\"#REL_034\">REL_034</a></td><td>Mandate ID is too long.</td></table></div>                                                                                                                                                             | [optional] |
| **mandate_signed_date**         | Option<[**serde_json::Value**].md> | The signing date of the mandate for this relation.                                                                                                                                                                                                                                                                          | [optional] |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)