{ "openapi": "3.1.1", "info": { "title": "e-Boekhouden API", "description": "### Quick Start\r\n\r\n1. If you haven't already, first create an API-token on the website.\r\n API-tokens can be managed in the settings of your account. \r\n Make sure to save your token somewhere secure, as it will not be shown again after creation.\r\n2. Send a POST request to the `/v1/session` endpoint with your API-token. This creates a short-lived session token. \r\n Tip: A unique source can help us troubleshoot problems quicker when contacting support. \r\n ```json\r\n {\r\n \"accessToken\": \"API_TOKEN\",\r\n \"source\": \"Postman\"\r\n }\r\n ```\r\n3. Include the session token from the response in your request headers to access the rest of the API. \r\n ```\r\n Authorization: SESSION_TOKEN\r\n ```\r\n\r\n### Filters\r\n\r\nVarious parameters support filters. These can be identified with the format `($filter-type)`, where `type` is a known [OAS type format](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#data-types). \r\nCurrently only one filter can be applied to a parameter.\r\n\r\n
\r\nStrings\r\n\r\n#### Strings (`$filter-string`)\r\n\r\n
\r\n\r\n| Filter | Syntax | Example |\r\n|---|---|---|\r\n| Equal* | `[eq]` | `?parameter=value` |\r\n| Not equal | `[not_eq]` | `?parameter[not_eq]=value` |\r\n| Like** | `[like]` | `?parameter[like]=%25value%25` |\r\n| Not like** | `[not_like]` | `?parameter[not_like]=%25value%25` |\r\n\r\n
\r\n\r\n\\* Equal is used as the default filter if none is given.
\r\n\\*\\* Wildcards `?` (one character) and `%` (multiple characters) may be used. Keep in mind these must be escaped when used in a query.\r\n\r\n
\r\n\r\n
\r\nNumbers\r\n\r\n#### Numbers (`$filter-int32`, `$filter-int64`)\r\n\r\n
\r\n\r\n| Filter | Syntax | Example |\r\n|---|---|---|\r\n| Equal* | `[eq]` | `?parameter=5` |\r\n| Not equal | `[not_eq]` | `?parameter[not_eq]=5` |\r\n| Greater than | `[gt]` | `?parameter[gt]=5` |\r\n| Greater than or equal to | `[gte]` | `?parameter[gte]=5` |\r\n| Less than | `[lt]` | `?parameter[lt]=5` |\r\n| Less than or equal to | `[lte]` | `?parameter[lte]=5` |\r\n| Range** | `[range]` | `?parameter[range]=5,10` |\r\n\r\n
\r\n\r\n\\* Equal is used as the default filter if none is given. \r\n\\*\\* Values are inclusive.\r\n\r\n
\r\n\r\n
\r\nDates\r\n\r\n#### Dates (`$filter-date`)\r\n\r\n
\r\n\r\n| Filter | Syntax | Example |\r\n|---|---|---|\r\n| Equal* | `[eq]` | `?parameter=2025-01-01` |\r\n| Not equal | `[not_eq]` | `?parameter[not_eq]=2025-01-01` |\r\n| Greater than | `[gt]` | `?parameter[gt]=2025-01-01` |\r\n| Greater than or equal to | `[gte]` | `?parameter[gte]=2025-01-01` |\r\n| Less than | `[lt]` | `?parameter[lt]=2025-01-01` |\r\n| Less than or equal to | `[lte]` | `?parameter[lte]=2025-01-01` |\r\n| Range** | `[range]` | `?parameter[range]=2025-01-01,2025-12-31` |\r\n\r\n
\r\n\r\n\\* Equal is used as the default filter if none is given. \r\n\\*\\* Values are inclusive.\r\n\r\n
\r\n\r\n### Paging\r\n\r\nMost search endpoints have an optional `limit` and `offset` parameter. \r\nThe parameter `limit` defaults to 100 and must be an integer between 1 and 2000. \r\nThe parameter `offset` defaults to 0 and must be a positive integer.\r\n\r\n\r\n### Dates\r\n\r\nSome endpoints accept or return date properties. These should always follow the ISO 8601 format. \r\nThe format is `YYYY-MM-DD` for dates.\r\n\r\n\r\n### VAT codes\r\n\r\nSome endpoints accept or return VAT codes. Please ensure that you only use VAT codes relevant to the country your company is registered in.
\r\nThe available VAT codes are as follows.\r\n\r\n
\r\nNL\r\n\r\n| Code | Description | Rate | Type | Cut-off date |\r\n|---|---|---|---|---|\r\n| LAAG_VERK | VAT 6% | 6% | Sale | **2019-01-01** |\r\n| LAAG_VERK_9 | VAT 9% | 9% | Sale | |\r\n| HOOG_VERK_21 | VAT 21% | 21% | Sale | |\r\n| AFW_VERK | Divergent | | Sale | |\r\n| VERL_VERK | Reverse charge 21% | 21% | Sale | |\r\n| VERL_VERK_L9 | Reverse charge 9% | 9% | Sale | |\r\n| BU_EU_VERK | Delivery outside the EU 0% | 0% | Sale | |\r\n| AFST_VERK | Distance selling within the EU 0% | 0% | Sale | |\r\n| BI_EU_VERK_D | Services within the EU 0% | 0% | Sale | |\r\n| LAAG_INK | VAT 6% | 6% | Purchase | **2019-01-01** |\r\n| LAAG_INK_9 | VAT 9% | 9% | Purchase | |\r\n| HOOG_INK_21 | VAT 21% | 21% | Purchase | |\r\n| AFW | Divergent | | Purchase | |\r\n| VERL_INK_L9 | Reverse charge 9% | 9% | Purchase | |\r\n| VERL_INK_L | Reverse charge 6% | 6% | Purchase | **2019-01-01** |\r\n| VERL_INK | Reverse charge 21% | 21% | Purchase | |\r\n| BU_EU_INK | Delivery/services outside the EU 0% | 0% | Purchase | |\r\n| BI_EU_VERK | Delivery within the EU 0% | 0% | Purchase | |\r\n| BI_EU_INK | Delivery/services within the EU 0% | 0% | Purchase | |\r\n| GEEN | No VAT | 0% | | |\r\n\r\n
\r\n\r\n
\r\nBE\r\n\r\n| Code | Description | Rate | Type | Cut-off date |\r\n|---|---|---|---|---|\r\n| BE_0_INK | Domestic purchase (0%) | 0% | Purchase | |\r\n| BE_6_INK | Domestic purchase (6%) | 6% | Purchase | |\r\n| BE_12_INK | Domestic purchase (12%) | 12% | Purchase | |\r\n| BE_21_INK | Domestic purchase (21%) | 21% | Purchase | |\r\n| BE_VERL_0_INK | Reverse charge (co-contractor 0%) | 0% | Purchase | |\r\n| BE_VERL_6_INK | Reverse charge (co-contractor 6%) | 6% | Purchase | |\r\n| BE_VERL_12_INK | Reverse charge (co-contractor 12%) | 12% | Purchase | |\r\n| BE_VERL_21_INK | Reverse charge (co-contractor 21%) | 21% | Purchase | |\r\n| BE_IC_D_0_INK | Intra-comm. service (EU 0%) | 0% | Purchase | |\r\n| BE_IC_D_6_INK | Intra-comm. service (EU 6%) | 6% | Purchase | |\r\n| BE_IC_D_12_INK | Intra-comm. service (EU 12%) | 12% | Purchase | |\r\n| BE_IC_D_21_INK | Intra-comm. service (EU 21%) | 21% | Purchase | |\r\n| BE_IC_0_INK | Intra-comm. goods (EU 0%) | 0% | Purchase | |\r\n| BE_IC_6_INK | Intra-comm. goods (EU 6%) | 6% | Purchase | |\r\n| BE_IC_12_INK | Intra-comm. goods (EU 12%) | 12% | Purchase | |\r\n| BE_IC_21_INK | Intra-comm. goods (EU 21%) | 21% | Purchase | |\r\n| BE_IMP_0_INK | Import reverse charge (0%) | 0% | Purchase | |\r\n| BE_IMP_6_INK | Import reverse charge (6%) | 6% | Purchase | |\r\n| BE_IMP_12_INK | Import reverse charge (12%) | 12% | Purchase | |\r\n| BE_IMP_21_INK | Import reverse charge (21%) | 21% | Purchase | |\r\n| BE_0_VERK | Domestic sale (0%) | 0% | Sale | |\r\n| BE_6_VERK | Domestic sale (6%) | 6% | Sale | |\r\n| BE_12_VERK | Domestic sale (12%) | 12% | Sale | |\r\n| BE_21_VERK | Domestic sale (21%) | 21% | Sale | |\r\n| BE_IC_D_VERK | Intra-comm. service (EU 0%) | 0% | Sale | |\r\n| BE_VERL_VERK | Reverse charge (co-contractor 0%) | 0% | Sale | |\r\n| BE_IC_VERK | Intra-comm. goods (EU 0%) | 0% | Sale | |\r\n| BE_EXP_VERK | Export sale (0%) | 0% | Sale | |\r\n| GEEN | No VAT | 0% | | |\r\n\r\n
\r\n\r\n\r\n### Company registration number\r\n\r\nThe company registration number is a unique identifier for a company.\r\nIn the Netherlands this is the \"KVK-nummer\". In Belgium this is the \"ondernemingsnummer\".\r\n### Error Codes\r\nPossible error codes thrown by endpoints. If the property `code` is present on an error response, it will contain one of these codes.\r\n
\r\nError codes\r\n
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
ERR_001Something went wrong.
ERR_002Your request contains an invalid value.
DATA_01No content body provided.
MODULE_001The limit for the free trial of the accounting module has been reached.
MODULE_002The limit for the free trial of the invoicing module has been reached.
PAGE_001Limit must be between 1 and 2000.
PAGE_002Offset must be greater than or equal to 0.
SECURITY_001No permission to access the requested resource.
SECURITY_002No administration has been opened in the current session.
SECURITY_003No access to the requested administration.
SECURITY_004The requested administration has not been activated.
SECURITY_005The requested administration is not available due to an overdue payment.
SECURITY_006The requested administration is not accessible. Please contact the adminstration or log in on the website.
SECURITY_007The period has been closed by your accountant and can not be changed.
SECURITY_008The period has been closed by your accountant and can not be reopened.
SECURITY_009Connections with other parties can only be managed when the administration has customer access enabled.
SECURITY_010Not authenticated. Check your Authorization header.
SECURITY_011This account is registered under a different domain. Please make sure you're using the API on the correct domain.
SECURITY_999Something went wrong during authentication.
SMTP_001Sending the e-mail failed. Check your SMTP settings.
SMTP_002Sending the e-mail failed. Check your SMTP settings.
SMTP_003Sending the e-mail failed. Check your SMTP settings.
PAKKET_001Product limit reached.
PAKKET_002Product limit reached.
FACT_001Relation ID is missing.
FACT_002Relation not found.
FACT_003Relation is inactive.
FACT_004Total invoice amount too high.
FACT_005Total invoice amount too low.
FACT_006Invoice number is missing.
FACT_007Invoice number is too long.
FACT_008Invoice number is invalid.
FACT_009Invoice number does not end with a digit.
FACT_010Invoice VAT must be IN or EX.
FACT_011Invoice date is missing.
FACT_012Invoice date invalid.
FACT_013Invoice date out of range.
FACT_014Payment reference is too long.
FACT_015Term of payment is missing.
FACT_016Term of payment out of range.
FACT_017Invoice text is too long.
FACT_018Invoice template not found.
FACT_019Invoice items are missing.
FACT_020Email template not found.
FACT_021Invoice not found.
FACT_022Send to Peppol for relation without Peppol Id.
FACT_023Already sent to Peppol.
FACT_024Administration has no Peppol integration configured
FACT_025Too many items.
FACT_101Invoice number is in use.
FACT_102The limit for the free trial of the invoicing module has been reached. Upgrade your subscription to continue invoicing without restrictions.
FACT_EMAIL_001Relation email is missing.
FACT_EMAIL_002Relation email is invalid.
FACT_EMAIL_003Relation email for invoices is invalid.
FACT_EMAIL_004Relation email for reminders is invalid.
FACT_EMAIL_005Something went wrong while attaching files to the email.
FACT_EMAIL_006Sender email is invalid.
FACT_EMAIL_007Relation email is missing.
FACT_EMAIL_008Relation email is invalid.
FACT_EMAIL_009CC email is invalid.
FACT_EMAIL_010BCC email is invalid.
FACT_EMAIL_011Email body is too long
FACT_EMAIL_012CC or BCC contains a duplicate address.
FACT_EMAIL_013Subject is missing.
FACT_EMAIL_014Body is missing.
FACT_INCASSO_001Mandate type is missing.
FACT_INCASSO_002Mandate type is invalid.
FACT_INCASSO_003Mandate ID is missing.
FACT_INCASSO_004Mandate ID is too long.
FACT_INCASSO_005Mandate signed date is missing.
FACT_INCASSO_006Mandate signed date is invalid.
FACT_INCASSO_007Mandate signed date out of range.
FACT_INCASSO_008IBAN is missing.
FACT_INCASSO_009IBAN is too long.
FACT_INCASSO_010IBAN is invalid.
FACT_INCASSO_011Name is too long.
FACT_INCASSO_012City is too long.
FACT_INCASSO_013Description line 1 is too long.
FACT_INCASSO_014Description line 2 is too long.
FACT_INCASSO_015Description line 3 is too long.
FACT_VERWERK_001Invoice date resides in a closed period.
FACT_VERWERK_002Description is too long.
FACT_VERWERK_003Payment reference is too long.
FACT_VERWERK_004Payment reference already exists.
FACT_SJAB_001Name is missing.
FACT_SJAB_002Name is too long.
FACT_SJAB_003Type is missing.
FACT_SJAB_004Type is invalid.
ADM_001Email administration is missing.
ADM_002Email administration is invalid.
EP_001This endpoint is only available to accountants.
EP_002This endpoint is not available for accountants.
FACT_ITEM_001Description invoice item is missing.
FACT_ITEM_002Description invoice item is too long.
FACT_ITEM_003Code invoice item is too long.
FACT_ITEM_004Price per unit excl. VAT is missing.
FACT_ITEM_005Price per unit incl. VAT is missing.
FACT_ITEM_006VAT code is missing.
FACT_ITEM_007Ledger ID is missing
FACT_ITEM_008Total price is too high.
FACT_ITEM_009Total price is too low.
FACT_ITEM_010Unit not found.
FACT_ITEM_011Product not found.
FACT_ITEM_012Ledger account not found.
FACT_ITEM_013Discount amount cannot have a value when discount percentage is passed.
FACT_ITEM_014Invalid VAT code.
FACT_ITEM_015VAT amount must be used with VAT code: 'AFW_VERK'
REL_001Relation type is invalid (B,P).
REL_002Name is mandatory.
REL_003Name is too long.
REL_004Gender is invalid (m,v,a).
REL_005Code is invalid.
REL_006Code is too long.
REL_007Iban is invalid.
REL_008Company registration number must be numeric.
REL_009Contact is too long.
REL_010Salutation is too long.
REL_011Address is too long.
REL_012Postal code is too long.
REL_013City is too long.
REL_014Country is too long.
REL_015Address 2 is too long.
REL_016Postal code 2 is too long.
REL_017City 2 is too long.
REL_018Country 2 is too long.
REL_019Phone is too long.
REL_020Mobile is too long.
REL_021Fax is too long.
REL_022Email is too long.
REL_023Email is invalid.
REL_024Email invoice is too long.
REL_025Email invoice is invalid.
REL_026Email reminder is too long.
REL_027Email reminder is invalid.
REL_028Website is too long.
REL_029Iban is too long.
REL_030Term of payment too low.
REL_031Term of payment too high.
REL_032BIC is too long.
REL_033Mandate type is too long.
REL_034Mandate ID is too long.
REL_035VAT number is too long.
REL_037Free text 1 is too long.
REL_038Free text 2 is too long.
REL_039Free text 3 is too long.
REL_040Free text 4 is too long.
REL_041Free text 5 is too long.
REL_042Free text 6 is too long.
REL_043Free text 7 is too long.
REL_044Free text 8 is too long.
REL_045Free text 9 is too long.
REL_046Free text 10 is too long.
REL_047Note too long.
REL_048Ledger not found.
REL_049Code already exists.
REL_050Company registration number is too long.
REL_051Mandate type is invalid (E,D).
REL_052Mandate value is missing.
REL_054Relation ID is missing.
REL_055Relation not found.
REL_056Peppol ID is only for companies.
REL_057Peppol ID is invalid.
REL_058Company registration number is invalid. A Belgian company registration number consists of 9 or 10 digits; with 10 digits it starts with 0 or 1.
REL_059Ledger must be active and of category 'BAL' or 'VW'.
LEDG_001Code is missing.
LEDG_002Code is too long.
LEDG_003Description is missing.
LEDG_004Description is too long.
LEDG_005Category is missing.
LEDG_007Group is missing.
LEDG_009Ledger ID is missing.
LEDG_010Ledger category doesn't exist.
LEDG_011Ledger not found.
LEDG_012Ledger group doesn't exist.
LEDG_013Ledger code already exists.
LEDG_014The category of a ledger with booked mutations can not be changed.
LEDG_015This ledger has booked mutations. The category can only be changed to 'BAL' or 'VW'.
LEDG_016There has to be at least one ledger of each category.
LEDG_017Ledger code is already in use as a group code.
LEDG_018Ledger category is not allowed.
LEDG_019Ledger category may not be modified.
LEDG_020The request took too long to execute. Use `from` and `to` to filter a more specific period.
COST_001Cost center not found.
COST_002Cost center could not be deleted.
COST_003Cost center description is required.
COST_004Cost center description is too long.
COST_005Cost center with this name already exists on this level of the tree.
COST_006Cost center parent id cannot be changed.
COST_007Cost center parent is not active.
COST_008Cost center parent not found.
COST_009Cost center cannot be deleted. A cost center exists below this cost center.
COST_010Cost center cannot be deleted. This cost center is in use by an other cost center.
COST_011Cost center fullPath is too long.
COST_012Cost center description has invalid characters.
UUR_FACT_001Term of payment is missing.
MUTA_001Ledger id is missing.
MUTA_002Type is missing
MUTA_003Vat amount must be used with vatCode: 'AFW' or 'AFW_VERK'
MUTA_004Ledger ID for row is missing.
MUTA_005In/Ex VAT is missing.
MUTA_006Credit/Debit is missing.
MUTA_007Credit/Debit must be 'C' or 'D'.
MUTA_008Payment reference already exists.
MUTA_009Type is unknown.
API_SESSION_001Source is missing.
API_SESSION_002Source does not match pattern.
API_SESSION_003Access token is missing or empty.
API_SESSION_004Access token has expired.
ART_001Product not found.
ART_002Product ID is missing.
ART_003Product could not be deleted
ART_004Product Code is missing.
ART_005Product Description is missing.
ART_006Product Ledger ID is missing.
ART_007Product Code is too long.
ART_008Product Description is too long.
ART_009Product Ledger could not be found.
ART_010Product Cost center is inactive.
ART_011Product Unit could not be found.
ART_012Product Group could not be found.
ART_013Product VAT code could not be found.
ART_014Invalid value provided for the Product UpdateSubscriptions option.
ART_015Product cost center could not be found.
ART_016priceIncl cannot have a value when priceExcl is passed.
ART_017Product VAT code is required.
ART_018Either priceExcl or priceIncl is required.
ART_019Both priceExcl and priceIncl are required with current VAT code.
ART_020priceIncl cannot be null or empty.
ART_021priceExcl cannot be null or empty.
ART_022VAT code cannot be null or empty.
ART_023This VAT code cannot be used.
ART_024The value of PriceExcl exceeds the maximum value of 999999999999.00.
ART_025The value of PriceIncl exceeds the maximum value of 999999999999.00.
ART_026The value of PriceIncl after applying VAT exceeds the maximum value of 999999999999.00.
ART_027The value of PurchasePriceExcl exceeds the maximum value of 999999999999.00.
ART_028Ledger category must be 'BAL' or 'VW'.
ART_029The value of PriceExcl is below the minimum value of -999999999999.00.
ART_030The value of PriceIncl is below the minimum value of -999999999999.00.
ART_031The value of PriceIncl after applying VAT is below the minimum value of -999999999999.00.
ART_032The value of PurchasePriceExcl is below the minimum value of -999999999999.00.
MUT_001Type is invalid.
MUT_002Invoice number is missing.
MUT_003Date is missing.
MUT_004Date is invalid.
MUT_005Period is closed.
MUT_007Unknown ledger for mutation.
MUT_008Unknown ledger category for mutation.
MUT_009Invalid ledger category for mutation.
MUT_010Ledger must be of category creditor.
MUT_011Ledger must be of category debtor.
MUT_012Relation is missing.
MUT_013Relation not found.
MUT_014Relation is prohibited.
MUT_015Term of payment is not permitted.
MUT_016Term of payment is prohibited.
MUT_017In/Ex VAT must be 'IN' or 'EX'.
MUT_018Invoice number is too long.
MUT_019Invoice number already exists.
MUT_020Combination relation/invoice number already exists.
MUT_021Date of opening balance must be before the first mutation.
MUT_022Date of mutation must be after the date of opening balance.
MUT_025Opening balance mutation must always be ID 0.
MUT_026In/Ex VAT must always be 'EX' on purchases with reverse-charging VAT.
MUT_050Unknown administration.
MUT_100Rows are missing.
MUT_101Too many rows.
MUT_104Unknown ledger for row.
MUT_105Unknown ledger category for row.
MUT_106Invalid ledger category for row.
MUT_107Ledger of row must be of category creditor.
MUT_108Ledger of row must be of category debtor.
MUT_109Invalid VAT code.
MUT_110VAT code must be of type purchase.
MUT_111VAT code must be of type sale.
MUT_112Relation is missing.
MUT_113Relation not found.
MUT_114Relation is not permitted.
MUT_115Invoice not found.
MUT_116Invoice is not permitted.
MUT_117Cost center not found.
MUT_118Ledger is not in balance.
MUT_120Invoice number is missing.
MUT_300Mutation not found.
MUT_901Not all ledgers exist.
MEM_001Member not found.
MEM_002Name is mandatory.
MEM_003Name is too long.
MEM_004Gender is invalid (m,v,a).
MEM_005Member number is invalid.
MEM_006Member number is too long.
MEM_007Iban is invalid.
MEM_010Salutation is too long.
MEM_011Address is too long.
MEM_012Postal code is too long.
MEM_013City is too long.
MEM_014Country is too long.
MEM_019Phone is too long.
MEM_020Mobile is too long.
MEM_021Fax is too long.
MEM_022Email is too long.
MEM_023Email is invalid.
MEM_024Email invoice is too long.
MEM_025Email invoice is invalid.
MEM_026Email reminder is too long.
MEM_027Email reminder is invalid.
MEM_029Iban is too long.
MEM_030Term of payment too low.
MEM_031Term of payment too high.
MEM_032BIC is too long.
MEM_033Mandate type is too long.
MEM_034Mandate ID is too long.
MEM_037Free text 1 is too long.
MEM_038Free text 2 is too long.
MEM_039Free text 3 is too long.
MEM_040Free text 4 is too long.
MEM_041Free text 5 is too long.
MEM_042Free text 6 is too long.
MEM_043Free text 7 is too long.
MEM_044Free text 8 is too long.
MEM_045Free text 9 is too long.
MEM_046Free text 10 is too long.
MEM_047Note too long.
MEM_048Ledger not found.
MEM_049Member number already exists.
MEM_051Mandate type is invalid (E,D).
MEM_052Mandate value is missing.
MEM_054Member ID is missing.
MEM_055Member not found.
MEM_056This endpoint is only available to clubs or associations.
MEM_057Ledger must be active and of category 'BAL' or 'VW'.
\r\n", "version": "v1" }, "servers": [ { "url": "https://api.e-boekhouden.nl/" } ], "paths": { "/v1/session": { "post": { "tags": [ "Session" ], "description": "Start a new session. The response session token can be used as the `Authorization` header.", "operationId": "StartSession", "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "SessionRequest", "required": [ "accessToken", "source" ], "properties": { "accessToken": { "type": "string", "description": "Your secret API-token.

Error codes

API_SESSION_003Access token is missing or empty.
API_SESSION_004Access token has expired.
", "format": "string" }, "source": { "maxLength": 10, "pattern": "^[\\w_ ]{1,10}$", "type": "string", "description": "Code to identify your integration.

Error codes

API_SESSION_001Source is missing.
API_SESSION_002Source does not match pattern.
", "format": "string" } } } }, "application/json": { "schema": { "title": "SessionRequest", "required": [ "accessToken", "source" ], "properties": { "accessToken": { "type": "string", "description": "Your secret API-token.

Error codes

API_SESSION_003Access token is missing or empty.
API_SESSION_004Access token has expired.
", "format": "string" }, "source": { "maxLength": 10, "pattern": "^[\\w_ ]{1,10}$", "type": "string", "description": "Code to identify your integration.

Error codes

API_SESSION_001Source is missing.
API_SESSION_002Source does not match pattern.
", "format": "string" } } } }, "application/*+json": { "schema": { "title": "SessionRequest", "required": [ "accessToken", "source" ], "properties": { "accessToken": { "type": "string", "description": "Your secret API-token.

Error codes

API_SESSION_003Access token is missing or empty.
API_SESSION_004Access token has expired.
", "format": "string" }, "source": { "maxLength": 10, "pattern": "^[\\w_ ]{1,10}$", "type": "string", "description": "Code to identify your integration.

Error codes

API_SESSION_001Source is missing.
API_SESSION_002Source does not match pattern.
", "format": "string" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "Session", "required": [ "token", "expiresIn" ], "properties": { "token": { "type": "string", "description": "Your session token. Add this as the \"Authorization\" header to your requests.", "format": "string" }, "expiresIn": { "type": "integer", "description": "The number of seconds until the token expires.", "format": "int32" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityError" } } } } } }, "delete": { "tags": [ "Session" ], "description": "Revokes the session token.", "operationId": "EndSession", "responses": { "204": { "description": "No Content", "content": { "application/json": { } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/administration": { "get": { "tags": [ "Administration" ], "description": "Get all administrations managed by the authorized accountant.", "operationId": "GetAdministrations", "parameters": [ { "name": "limit", "in": "query", "description": "The number of items to retrieve.", "schema": { "maximum": 2000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of items to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDtoOfAdministrationResponseDto" }, "example": { "Items": [ { "Guid": "00000000-0000-0000-0000-000000000000", "Company": "Company Name" } ], "Count": 1 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/administration/linked": { "get": { "tags": [ "Administration" ], "description": "Get all administrations that are linked to the authorized administration.
Please note that this endpoint will always return administrations linked to the administration of the user that created the API credentials.", "operationId": "GetLinkedAdministrations", "parameters": [ { "name": "limit", "in": "query", "description": "The number of items to retrieve.", "schema": { "maximum": 2000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of items to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDtoOfAdministrationResponseDto" }, "example": { "Items": [ { "Guid": "00000000-0000-0000-0000-000000000000", "Company": "Company Name" } ], "Count": 1 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/costcenter": { "get": { "tags": [ "CostCenter" ], "description": "Get all cost centers.", "operationId": "GetCostCenters", "parameters": [ { "name": "limit", "in": "query", "description": "The number of items to retrieve.", "schema": { "maximum": 2000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of items to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "query", "description": "The parent ID of the cost center.", "schema": { "type": "string", "format": "filter-string" } }, { "name": "description", "in": "query", "description": "The description of the cost center.", "schema": { "type": "string", "format": "filter-string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDtoOfCostCenterSearchResponseDto" }, "example": { "Items": [ { "Id": 1, "Description": "Buy", "ParentId": 12, "Active": true } ], "Count": 1 } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] }, "post": { "tags": [ "CostCenter" ], "description": "Create a new cost center.", "operationId": "CreateCostCenter", "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "CostCenter", "properties": { "description": { "maxLength": 50, "type": "string", "description": "The description of the cost center.

Error codes

COST_003Cost center description is required.
COST_004Cost center description is too long.
COST_005Cost center with this name already exists on this level of the tree.
COST_011Cost center fullPath is too long.
COST_012Cost center description has invalid characters.
", "format": "string" }, "parentId": { "type": "integer", "description": "The parent ID of the cost center.

Error codes

COST_005Cost center with this name already exists on this level of the tree.
COST_006Cost center parent id cannot be changed.
COST_007Cost center parent is not active.
COST_008Cost center parent not found.
", "format": "int32" }, "active": { "type": "boolean", "description": "Whether the cost center is active.

Error codes

COST_007Cost center parent is not active.
" } } }, "example": { "Id": null, "Description": "Buy", "ParentId": 12, "Active": true } }, "application/json": { "schema": { "title": "CostCenter", "properties": { "description": { "maxLength": 50, "type": "string", "description": "The description of the cost center.

Error codes

COST_003Cost center description is required.
COST_004Cost center description is too long.
COST_005Cost center with this name already exists on this level of the tree.
COST_011Cost center fullPath is too long.
COST_012Cost center description has invalid characters.
", "format": "string" }, "parentId": { "type": "integer", "description": "The parent ID of the cost center.

Error codes

COST_005Cost center with this name already exists on this level of the tree.
COST_006Cost center parent id cannot be changed.
COST_007Cost center parent is not active.
COST_008Cost center parent not found.
", "format": "int32" }, "active": { "type": "boolean", "description": "Whether the cost center is active.

Error codes

COST_007Cost center parent is not active.
" } } }, "example": { "Id": null, "Description": "Buy", "ParentId": 12, "Active": true } }, "application/*+json": { "schema": { "title": "CostCenter", "properties": { "description": { "maxLength": 50, "type": "string", "description": "The description of the cost center.

Error codes

COST_003Cost center description is required.
COST_004Cost center description is too long.
COST_005Cost center with this name already exists on this level of the tree.
COST_011Cost center fullPath is too long.
COST_012Cost center description has invalid characters.
", "format": "string" }, "parentId": { "type": "integer", "description": "The parent ID of the cost center.

Error codes

COST_005Cost center with this name already exists on this level of the tree.
COST_006Cost center parent id cannot be changed.
COST_007Cost center parent is not active.
COST_008Cost center parent not found.
", "format": "int32" }, "active": { "type": "boolean", "description": "Whether the cost center is active.

Error codes

COST_007Cost center parent is not active.
" } } }, "example": { "Id": null, "Description": "Buy", "ParentId": 12, "Active": true } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "title": "CostCenterCreateResponse", "properties": { "id": { "type": "integer", "description": "The ID of the cost center.", "format": "int32" }, "active": { "type": "boolean", "description": "Whether the cost center is active." } } }, "example": { "Id": 1, "Description": null, "ParentId": null, "Active": true, "FullPath": null } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/costcenter/{id}": { "get": { "tags": [ "CostCenter" ], "description": "Get a cost center.", "operationId": "GetCostCenter", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "CostCenterResponse", "properties": { "id": { "type": "integer", "description": "The ID of the cost center.", "format": "int32" }, "description": { "type": "string", "description": "The description of the cost center.", "format": "string" }, "parentId": { "type": "integer", "description": "The parent ID of the cost center.", "format": "int32" }, "active": { "type": "boolean", "description": "Whether the cost center is active." }, "fullPath": { "type": "string", "description": "The full path to the cost center, including parents.", "format": "string" } } }, "example": { "Id": 1, "Description": "Buy", "ParentId": 12, "Active": true, "FullPath": "Buy>Inventory" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] }, "patch": { "tags": [ "CostCenter" ], "description": "Update a cost center.", "operationId": "UpdateCostCenter", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "CostCenter", "properties": { "description": { "maxLength": 50, "type": "string", "description": "The description of the cost center.

Error codes

COST_003Cost center description is required.
COST_004Cost center description is too long.
COST_005Cost center with this name already exists on this level of the tree.
COST_011Cost center fullPath is too long.
COST_012Cost center description has invalid characters.
", "format": "string" }, "active": { "type": "boolean", "description": "Whether the cost center is active.

Error codes

COST_007Cost center parent is not active.
" } } }, "example": { "Id": null, "Description": "Buy", "ParentId": null, "Active": true } }, "application/json": { "schema": { "title": "CostCenter", "properties": { "description": { "maxLength": 50, "type": "string", "description": "The description of the cost center.

Error codes

COST_003Cost center description is required.
COST_004Cost center description is too long.
COST_005Cost center with this name already exists on this level of the tree.
COST_011Cost center fullPath is too long.
COST_012Cost center description has invalid characters.
", "format": "string" }, "active": { "type": "boolean", "description": "Whether the cost center is active.

Error codes

COST_007Cost center parent is not active.
" } } }, "example": { "Id": null, "Description": "Buy", "ParentId": null, "Active": true } }, "application/*+json": { "schema": { "title": "CostCenter", "properties": { "description": { "maxLength": 50, "type": "string", "description": "The description of the cost center.

Error codes

COST_003Cost center description is required.
COST_004Cost center description is too long.
COST_005Cost center with this name already exists on this level of the tree.
COST_011Cost center fullPath is too long.
COST_012Cost center description has invalid characters.
", "format": "string" }, "active": { "type": "boolean", "description": "Whether the cost center is active.

Error codes

COST_007Cost center parent is not active.
" } } }, "example": { "Id": null, "Description": "Buy", "ParentId": null, "Active": true } } }, "required": true }, "responses": { "204": { "description": "No Content", "content": { "application/json": { } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] }, "delete": { "tags": [ "CostCenter" ], "description": "Delete a cost center.", "operationId": "DeleteCostCenter", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "204": { "description": "No Content", "content": { "application/json": { } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/emailtemplate": { "get": { "tags": [ "EmailTemplate" ], "description": "Get all email templates.", "operationId": "GetEmailTemplates", "parameters": [ { "name": "limit", "in": "query", "description": "The number of items to retrieve.", "schema": { "maximum": 2000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of items to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDtoOfEmailTemplateDto" }, "example": { "Items": [ { "Id": 1, "Name": "EmailSjabloon", "UseInvoice": true, "UseQuote": false, "UseMailing": false } ], "Count": 1 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/invoice": { "post": { "tags": [ "Invoice" ], "description": "Create a new invoice.", "operationId": "CreateInvoice", "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "CreateInvoice", "required": [ "relationId", "termOfPayment", "templateId", "items" ], "properties": { "invoiceNumber": { "maxLength": 50, "type": [ "null", "string" ], "description": "Invoice number. Must end with a number.
If empty, we will create a new number.

Error codes

FACT_006Invoice number is missing.
FACT_007Invoice number is too long.
FACT_008Invoice number is invalid.
FACT_009Invoice number does not end with a digit.
FACT_101Invoice number is in use.
", "format": "string", "example": "F00001" }, "relationId": { "type": "integer", "description": "The ID of a relation.

Error codes

FACT_001Relation ID is missing.
FACT_002Relation not found.
FACT_003Relation is inactive.
FACT_EMAIL_001Relation email is missing.
FACT_EMAIL_002Relation email is invalid.
FACT_EMAIL_003Relation email for invoices is invalid.
FACT_EMAIL_004Relation email for reminders is invalid.
FACT_EMAIL_007Relation email is missing.
", "format": "int32", "example": "12345" }, "date": { "type": "string", "description": "Invoice date.

Error codes

FACT_011Invoice date is missing.
FACT_012Invoice date invalid.
FACT_013Invoice date out of range.
", "format": "date" }, "termOfPayment": { "minimum": 0, "type": "integer", "description": "

Error codes

FACT_015Term of payment is missing.
FACT_016Term of payment out of range.
", "format": "int32", "default": 0, "example": 7 }, "inExVat": { "enum": [ "IN", "EX" ], "type": "string", "description": "Indicates if the amount on the invoice is including (`IN`) or excluding (`EX`) VAT. The corresponding value will be calculated based on the VAT code. If left empty the 'EX' option will be used

Error codes

FACT_010Invoice VAT must be IN or EX.
", "format": "string" }, "templateId": { "type": "integer", "description": "

Error codes

FACT_018Invoice template not found.
", "format": "int32", "example": "12345" }, "emailTemplateId": { "type": "integer", "description": "The ID of an email template.

Error codes

FACT_020Email template not found.
", "format": "int32", "example": "12345" }, "reference": { "maxLength": 50, "type": "string", "description": "Reference of the invoice.

Error codes

FACT_014Payment reference is too long.
", "format": "string", "example": "" }, "text": { "maxLength": 35000, "type": "string", "description": "Text of the invoice.

Error codes

FACT_017Invoice text is too long.
", "format": "string", "example": "" }, "print": { "type": "boolean", "description": "Determines whether the invoice should be prepared for printing." }, "email": { "title": "CreateInvoiceEmail", "properties": { "fromEmail": { "type": "string", "description": "Email address of the sender.

Error codes

FACT_EMAIL_006Sender email is invalid.
", "format": "string" }, "fromName": { "type": "string", "description": "Name of the sender.", "format": "string" }, "subject": { "type": "string", "description": "Email subject.

Error codes

FACT_EMAIL_013Subject is missing.
", "format": "string" }, "body": { "type": "string", "description": "Email body. Supports HTML.

Error codes

FACT_EMAIL_011Email body is too long
FACT_EMAIL_014Body is missing.
", "format": "string" }, "attachUbl": { "type": "boolean", "description": "Also attach the invoice UBL-file.", "default": false }, "invoiceUbl": { "type": "boolean", "description": "Obsolete; please use `attachUbl` instead. This field will be removed in the future." } }, "description": "If this object is provided, the invoice will be e-mailed to the relation immediately.

Error codes

FACT_EMAIL_005Something went wrong while attaching files to the email.
" }, "directDebit": { "title": "CreateInvoiceDebit", "required": [ "iban" ], "properties": { "iban": { "maxLength": 150, "type": "string", "description": "

Error codes

FACT_INCASSO_008IBAN is missing.
FACT_INCASSO_009IBAN is too long.
FACT_INCASSO_010IBAN is invalid.
", "format": "string" }, "mandateType": { "maxLength": 1, "enum": [ "O", "E", "R", "D" ], "type": "string", "description": "`O` or `E` (one-time debit), `R` or `D` (recurrent debit)

Error codes

FACT_INCASSO_001Mandate type is missing.
FACT_INCASSO_002Mandate type is invalid.
", "format": "string", "default": "E" }, "mandateId": { "maxLength": 35, "type": "string", "description": "

Error codes

FACT_INCASSO_003Mandate ID is missing.
FACT_INCASSO_004Mandate ID is too long.
", "format": "string" }, "mandateSignedDate": { "type": "string", "description": "

Error codes

FACT_INCASSO_005Mandate signed date is missing.
FACT_INCASSO_006Mandate signed date is invalid.
FACT_INCASSO_007Mandate signed date out of range.
", "format": "date" }, "name": { "maxLength": 150, "type": "string", "description": "In the name of.

Error codes

FACT_INCASSO_011Name is too long.
", "format": "string" }, "city": { "maxLength": 150, "type": "string", "description": "

Error codes

FACT_INCASSO_012City is too long.
", "format": "string" }, "descriptionLine1": { "maxLength": 50, "type": "string", "description": "

Error codes

FACT_INCASSO_013Description line 1 is too long.
", "format": "string" }, "descriptionLine2": { "maxLength": 50, "type": "string", "description": "

Error codes

FACT_INCASSO_014Description line 2 is too long.
", "format": "string" }, "descriptionLine3": { "maxLength": 50, "type": "string", "description": "

Error codes

FACT_INCASSO_015Description line 3 is too long.
", "format": "string" } }, "description": "If this object is provided, the invoice will be marked for direct debit with the provided details." }, "mutation": { "title": "CreateInvoiceMutation", "properties": { "description": { "maxLength": 200, "type": "string", "description": "Description of the mutation.

Error codes

FACT_VERWERK_002Description is too long.
", "format": "string" }, "checkPaymentReference": { "type": "boolean", "description": "If true, the provided `paymentReference` will be validated for uniqueness." }, "paymentReference": { "maxLength": 50, "type": "string", "description": "A reference that uniquely identifies the mutation.

Error codes

FACT_VERWERK_003Payment reference is too long.
FACT_VERWERK_004Payment reference already exists.
MUTA_008Payment reference already exists.
", "format": "string" }, "ledgerId": { "type": "integer", "description": "Ledger of the invoice entry.

Error codes

MUT_007Unknown ledger for mutation.
", "format": "int32" } }, "description": "If this object is provided, the invoice will also be processed as a new mutation.

Error codes

FACT_VERWERK_001Invoice date resides in a closed period.
" }, "items": { "maxItems": 500, "type": "array", "items": { "title": "CreateInvoiceItem", "required": [ "description", "vatCode", "ledgerId" ], "properties": { "quantity": { "type": "number", "description": "The item quantity, with up to 4 decimal places.", "default": 0 }, "amount": { "type": "number", "description": "The item quantity. To keep your code ready for future API versions it is recommended to use `quantity` instead.", "deprecated": true }, "unitId": { "type": [ "null", "integer" ], "description": "The ID of an existing unit.

Error codes

FACT_ITEM_010Unit not found.
", "format": "int32" }, "code": { "maxLength": 50, "type": "string", "description": "

Error codes

FACT_ITEM_003Code invoice item is too long.
", "format": "string" }, "productId": { "type": [ "null", "integer" ], "description": "The ID of an existing product. If given, `Code` is ignored.

Error codes

FACT_ITEM_011Product not found.
", "format": "int32" }, "description": { "type": "string", "description": "

Error codes

FACT_ITEM_001Description invoice item is missing.
FACT_ITEM_002Description invoice item is too long.
", "format": "string" }, "pricePerUnit": { "type": "number", "description": "

Error codes

FACT_ITEM_004Price per unit excl. VAT is missing.
FACT_ITEM_008Total price is too high.
FACT_ITEM_009Total price is too low.
" }, "vatCode": { "$ref": "#/components/schemas/VatCode" }, "vatAmount": { "type": "number", "description": "The VAT amount of the invoice item. Only use in combination with vatCode: 'AFW_VERK'. Only applicable for NL.

Error codes

FACT_ITEM_015VAT amount must be used with VAT code: 'AFW_VERK'
", "example": "20" }, "ledgerId": { "type": "integer", "description": "The ID of an existing ledger account

Error codes

FACT_ITEM_007Ledger ID is missing
FACT_ITEM_012Ledger account not found.
", "format": "int32" }, "costCenterId": { "type": [ "null", "integer" ], "format": "int32" }, "discountAmount": { "type": [ "null", "number" ], "description": "A fixed discount on the `pricePerUnit`. This field can not be combined with `discountPercentage`." }, "discountPercentage": { "type": [ "null", "number" ], "description": "A percentage discount on the `pricePerUnit`. This field can not be combined with `discountAmount`." } } }, "description": "At least one invoice item is required.

Error codes

FACT_004Total invoice amount too high.
FACT_005Total invoice amount too low.
FACT_019Invoice items are missing.
FACT_025Too many items.
" } } }, "example": { "Id": null, "InvoiceNumber": "F00001", "Relation": null, "RelationId": 1500, "Date": "2026-10-23", "TermOfPayment": 14, "InExVat": "EX", "TemplateId": 2100, "EmailTemplateId": 1700, "Reference": "Reference", "Text": "Text", "Print": false, "Email": { "FromEmail": "", "FromName": "", "Subject": "", "Body": "", "AttachUbl": false, "InvoiceUbl": null }, "DirectDebit": { "DirectDebit": null, "Iban": "", "MandateType": "", "MandateId": "", "MandateSignedDate": "2026-10-23", "Name": "", "City": "", "DescriptionLine1": "", "DescriptionLine2": "", "DescriptionLine3": "" }, "Mutation": { "Description": "", "CheckPaymentReference": true, "PaymentReference": "REF00123", "LedgerId": 1100 }, "InvoiceEntry": null, "Items": [ { "Quantity": 0.0, "Amount": 0.0, "UnitId": 0, "Code": "", "ProductId": 0, "Description": "", "PricePerUnit": 0.0, "VatCode": "HOOG_VERK_21", "VatAmount": null, "LedgerId": 0, "CostCenterId": 0, "DiscountAmount": 0.0, "DiscountPercentage": 0.0 } ] } }, "application/json": { "schema": { "title": "CreateInvoice", "required": [ "relationId", "termOfPayment", "templateId", "items" ], "properties": { "invoiceNumber": { "maxLength": 50, "type": [ "null", "string" ], "description": "Invoice number. Must end with a number.
If empty, we will create a new number.

Error codes

FACT_006Invoice number is missing.
FACT_007Invoice number is too long.
FACT_008Invoice number is invalid.
FACT_009Invoice number does not end with a digit.
FACT_101Invoice number is in use.
", "format": "string", "example": "F00001" }, "relationId": { "type": "integer", "description": "The ID of a relation.

Error codes

FACT_001Relation ID is missing.
FACT_002Relation not found.
FACT_003Relation is inactive.
FACT_EMAIL_001Relation email is missing.
FACT_EMAIL_002Relation email is invalid.
FACT_EMAIL_003Relation email for invoices is invalid.
FACT_EMAIL_004Relation email for reminders is invalid.
FACT_EMAIL_007Relation email is missing.
", "format": "int32", "example": "12345" }, "date": { "type": "string", "description": "Invoice date.

Error codes

FACT_011Invoice date is missing.
FACT_012Invoice date invalid.
FACT_013Invoice date out of range.
", "format": "date" }, "termOfPayment": { "minimum": 0, "type": "integer", "description": "

Error codes

FACT_015Term of payment is missing.
FACT_016Term of payment out of range.
", "format": "int32", "default": 0, "example": 7 }, "inExVat": { "enum": [ "IN", "EX" ], "type": "string", "description": "Indicates if the amount on the invoice is including (`IN`) or excluding (`EX`) VAT. The corresponding value will be calculated based on the VAT code. If left empty the 'EX' option will be used

Error codes

FACT_010Invoice VAT must be IN or EX.
", "format": "string" }, "templateId": { "type": "integer", "description": "

Error codes

FACT_018Invoice template not found.
", "format": "int32", "example": "12345" }, "emailTemplateId": { "type": "integer", "description": "The ID of an email template.

Error codes

FACT_020Email template not found.
", "format": "int32", "example": "12345" }, "reference": { "maxLength": 50, "type": "string", "description": "Reference of the invoice.

Error codes

FACT_014Payment reference is too long.
", "format": "string", "example": "" }, "text": { "maxLength": 35000, "type": "string", "description": "Text of the invoice.

Error codes

FACT_017Invoice text is too long.
", "format": "string", "example": "" }, "print": { "type": "boolean", "description": "Determines whether the invoice should be prepared for printing." }, "email": { "title": "CreateInvoiceEmail", "properties": { "fromEmail": { "type": "string", "description": "Email address of the sender.

Error codes

FACT_EMAIL_006Sender email is invalid.
", "format": "string" }, "fromName": { "type": "string", "description": "Name of the sender.", "format": "string" }, "subject": { "type": "string", "description": "Email subject.

Error codes

FACT_EMAIL_013Subject is missing.
", "format": "string" }, "body": { "type": "string", "description": "Email body. Supports HTML.

Error codes

FACT_EMAIL_011Email body is too long
FACT_EMAIL_014Body is missing.
", "format": "string" }, "attachUbl": { "type": "boolean", "description": "Also attach the invoice UBL-file.", "default": false }, "invoiceUbl": { "type": "boolean", "description": "Obsolete; please use `attachUbl` instead. This field will be removed in the future." } }, "description": "If this object is provided, the invoice will be e-mailed to the relation immediately.

Error codes

FACT_EMAIL_005Something went wrong while attaching files to the email.
" }, "directDebit": { "title": "CreateInvoiceDebit", "required": [ "iban" ], "properties": { "iban": { "maxLength": 150, "type": "string", "description": "

Error codes

FACT_INCASSO_008IBAN is missing.
FACT_INCASSO_009IBAN is too long.
FACT_INCASSO_010IBAN is invalid.
", "format": "string" }, "mandateType": { "maxLength": 1, "enum": [ "O", "E", "R", "D" ], "type": "string", "description": "`O` or `E` (one-time debit), `R` or `D` (recurrent debit)

Error codes

FACT_INCASSO_001Mandate type is missing.
FACT_INCASSO_002Mandate type is invalid.
", "format": "string", "default": "E" }, "mandateId": { "maxLength": 35, "type": "string", "description": "

Error codes

FACT_INCASSO_003Mandate ID is missing.
FACT_INCASSO_004Mandate ID is too long.
", "format": "string" }, "mandateSignedDate": { "type": "string", "description": "

Error codes

FACT_INCASSO_005Mandate signed date is missing.
FACT_INCASSO_006Mandate signed date is invalid.
FACT_INCASSO_007Mandate signed date out of range.
", "format": "date" }, "name": { "maxLength": 150, "type": "string", "description": "In the name of.

Error codes

FACT_INCASSO_011Name is too long.
", "format": "string" }, "city": { "maxLength": 150, "type": "string", "description": "

Error codes

FACT_INCASSO_012City is too long.
", "format": "string" }, "descriptionLine1": { "maxLength": 50, "type": "string", "description": "

Error codes

FACT_INCASSO_013Description line 1 is too long.
", "format": "string" }, "descriptionLine2": { "maxLength": 50, "type": "string", "description": "

Error codes

FACT_INCASSO_014Description line 2 is too long.
", "format": "string" }, "descriptionLine3": { "maxLength": 50, "type": "string", "description": "

Error codes

FACT_INCASSO_015Description line 3 is too long.
", "format": "string" } }, "description": "If this object is provided, the invoice will be marked for direct debit with the provided details." }, "mutation": { "title": "CreateInvoiceMutation", "properties": { "description": { "maxLength": 200, "type": "string", "description": "Description of the mutation.

Error codes

FACT_VERWERK_002Description is too long.
", "format": "string" }, "checkPaymentReference": { "type": "boolean", "description": "If true, the provided `paymentReference` will be validated for uniqueness." }, "paymentReference": { "maxLength": 50, "type": "string", "description": "A reference that uniquely identifies the mutation.

Error codes

FACT_VERWERK_003Payment reference is too long.
FACT_VERWERK_004Payment reference already exists.
MUTA_008Payment reference already exists.
", "format": "string" }, "ledgerId": { "type": "integer", "description": "Ledger of the invoice entry.

Error codes

MUT_007Unknown ledger for mutation.
", "format": "int32" } }, "description": "If this object is provided, the invoice will also be processed as a new mutation.

Error codes

FACT_VERWERK_001Invoice date resides in a closed period.
" }, "items": { "maxItems": 500, "type": "array", "items": { "title": "CreateInvoiceItem", "required": [ "description", "vatCode", "ledgerId" ], "properties": { "quantity": { "type": "number", "description": "The item quantity, with up to 4 decimal places.", "default": 0 }, "amount": { "type": "number", "description": "The item quantity. To keep your code ready for future API versions it is recommended to use `quantity` instead.", "deprecated": true }, "unitId": { "type": [ "null", "integer" ], "description": "The ID of an existing unit.

Error codes

FACT_ITEM_010Unit not found.
", "format": "int32" }, "code": { "maxLength": 50, "type": "string", "description": "

Error codes

FACT_ITEM_003Code invoice item is too long.
", "format": "string" }, "productId": { "type": [ "null", "integer" ], "description": "The ID of an existing product. If given, `Code` is ignored.

Error codes

FACT_ITEM_011Product not found.
", "format": "int32" }, "description": { "type": "string", "description": "

Error codes

FACT_ITEM_001Description invoice item is missing.
FACT_ITEM_002Description invoice item is too long.
", "format": "string" }, "pricePerUnit": { "type": "number", "description": "

Error codes

FACT_ITEM_004Price per unit excl. VAT is missing.
FACT_ITEM_008Total price is too high.
FACT_ITEM_009Total price is too low.
" }, "vatCode": { "$ref": "#/components/schemas/VatCode" }, "vatAmount": { "type": "number", "description": "The VAT amount of the invoice item. Only use in combination with vatCode: 'AFW_VERK'. Only applicable for NL.

Error codes

FACT_ITEM_015VAT amount must be used with VAT code: 'AFW_VERK'
", "example": "20" }, "ledgerId": { "type": "integer", "description": "The ID of an existing ledger account

Error codes

FACT_ITEM_007Ledger ID is missing
FACT_ITEM_012Ledger account not found.
", "format": "int32" }, "costCenterId": { "type": [ "null", "integer" ], "format": "int32" }, "discountAmount": { "type": [ "null", "number" ], "description": "A fixed discount on the `pricePerUnit`. This field can not be combined with `discountPercentage`." }, "discountPercentage": { "type": [ "null", "number" ], "description": "A percentage discount on the `pricePerUnit`. This field can not be combined with `discountAmount`." } } }, "description": "At least one invoice item is required.

Error codes

FACT_004Total invoice amount too high.
FACT_005Total invoice amount too low.
FACT_019Invoice items are missing.
FACT_025Too many items.
" } } }, "example": { "Id": null, "InvoiceNumber": "F00001", "Relation": null, "RelationId": 1500, "Date": "2026-10-23", "TermOfPayment": 14, "InExVat": "EX", "TemplateId": 2100, "EmailTemplateId": 1700, "Reference": "Reference", "Text": "Text", "Print": false, "Email": { "FromEmail": "", "FromName": "", "Subject": "", "Body": "", "AttachUbl": false, "InvoiceUbl": null }, "DirectDebit": { "DirectDebit": null, "Iban": "", "MandateType": "", "MandateId": "", "MandateSignedDate": "2026-10-23", "Name": "", "City": "", "DescriptionLine1": "", "DescriptionLine2": "", "DescriptionLine3": "" }, "Mutation": { "Description": "", "CheckPaymentReference": true, "PaymentReference": "REF00123", "LedgerId": 1100 }, "InvoiceEntry": null, "Items": [ { "Quantity": 0.0, "Amount": 0.0, "UnitId": 0, "Code": "", "ProductId": 0, "Description": "", "PricePerUnit": 0.0, "VatCode": "HOOG_VERK_21", "VatAmount": null, "LedgerId": 0, "CostCenterId": 0, "DiscountAmount": 0.0, "DiscountPercentage": 0.0 } ] } }, "application/*+json": { "schema": { "title": "CreateInvoice", "required": [ "relationId", "termOfPayment", "templateId", "items" ], "properties": { "invoiceNumber": { "maxLength": 50, "type": [ "null", "string" ], "description": "Invoice number. Must end with a number.
If empty, we will create a new number.

Error codes

FACT_006Invoice number is missing.
FACT_007Invoice number is too long.
FACT_008Invoice number is invalid.
FACT_009Invoice number does not end with a digit.
FACT_101Invoice number is in use.
", "format": "string", "example": "F00001" }, "relationId": { "type": "integer", "description": "The ID of a relation.

Error codes

FACT_001Relation ID is missing.
FACT_002Relation not found.
FACT_003Relation is inactive.
FACT_EMAIL_001Relation email is missing.
FACT_EMAIL_002Relation email is invalid.
FACT_EMAIL_003Relation email for invoices is invalid.
FACT_EMAIL_004Relation email for reminders is invalid.
FACT_EMAIL_007Relation email is missing.
", "format": "int32", "example": "12345" }, "date": { "type": "string", "description": "Invoice date.

Error codes

FACT_011Invoice date is missing.
FACT_012Invoice date invalid.
FACT_013Invoice date out of range.
", "format": "date" }, "termOfPayment": { "minimum": 0, "type": "integer", "description": "

Error codes

FACT_015Term of payment is missing.
FACT_016Term of payment out of range.
", "format": "int32", "default": 0, "example": 7 }, "inExVat": { "enum": [ "IN", "EX" ], "type": "string", "description": "Indicates if the amount on the invoice is including (`IN`) or excluding (`EX`) VAT. The corresponding value will be calculated based on the VAT code. If left empty the 'EX' option will be used

Error codes

FACT_010Invoice VAT must be IN or EX.
", "format": "string" }, "templateId": { "type": "integer", "description": "

Error codes

FACT_018Invoice template not found.
", "format": "int32", "example": "12345" }, "emailTemplateId": { "type": "integer", "description": "The ID of an email template.

Error codes

FACT_020Email template not found.
", "format": "int32", "example": "12345" }, "reference": { "maxLength": 50, "type": "string", "description": "Reference of the invoice.

Error codes

FACT_014Payment reference is too long.
", "format": "string", "example": "" }, "text": { "maxLength": 35000, "type": "string", "description": "Text of the invoice.

Error codes

FACT_017Invoice text is too long.
", "format": "string", "example": "" }, "print": { "type": "boolean", "description": "Determines whether the invoice should be prepared for printing." }, "email": { "title": "CreateInvoiceEmail", "properties": { "fromEmail": { "type": "string", "description": "Email address of the sender.

Error codes

FACT_EMAIL_006Sender email is invalid.
", "format": "string" }, "fromName": { "type": "string", "description": "Name of the sender.", "format": "string" }, "subject": { "type": "string", "description": "Email subject.

Error codes

FACT_EMAIL_013Subject is missing.
", "format": "string" }, "body": { "type": "string", "description": "Email body. Supports HTML.

Error codes

FACT_EMAIL_011Email body is too long
FACT_EMAIL_014Body is missing.
", "format": "string" }, "attachUbl": { "type": "boolean", "description": "Also attach the invoice UBL-file.", "default": false }, "invoiceUbl": { "type": "boolean", "description": "Obsolete; please use `attachUbl` instead. This field will be removed in the future." } }, "description": "If this object is provided, the invoice will be e-mailed to the relation immediately.

Error codes

FACT_EMAIL_005Something went wrong while attaching files to the email.
" }, "directDebit": { "title": "CreateInvoiceDebit", "required": [ "iban" ], "properties": { "iban": { "maxLength": 150, "type": "string", "description": "

Error codes

FACT_INCASSO_008IBAN is missing.
FACT_INCASSO_009IBAN is too long.
FACT_INCASSO_010IBAN is invalid.
", "format": "string" }, "mandateType": { "maxLength": 1, "enum": [ "O", "E", "R", "D" ], "type": "string", "description": "`O` or `E` (one-time debit), `R` or `D` (recurrent debit)

Error codes

FACT_INCASSO_001Mandate type is missing.
FACT_INCASSO_002Mandate type is invalid.
", "format": "string", "default": "E" }, "mandateId": { "maxLength": 35, "type": "string", "description": "

Error codes

FACT_INCASSO_003Mandate ID is missing.
FACT_INCASSO_004Mandate ID is too long.
", "format": "string" }, "mandateSignedDate": { "type": "string", "description": "

Error codes

FACT_INCASSO_005Mandate signed date is missing.
FACT_INCASSO_006Mandate signed date is invalid.
FACT_INCASSO_007Mandate signed date out of range.
", "format": "date" }, "name": { "maxLength": 150, "type": "string", "description": "In the name of.

Error codes

FACT_INCASSO_011Name is too long.
", "format": "string" }, "city": { "maxLength": 150, "type": "string", "description": "

Error codes

FACT_INCASSO_012City is too long.
", "format": "string" }, "descriptionLine1": { "maxLength": 50, "type": "string", "description": "

Error codes

FACT_INCASSO_013Description line 1 is too long.
", "format": "string" }, "descriptionLine2": { "maxLength": 50, "type": "string", "description": "

Error codes

FACT_INCASSO_014Description line 2 is too long.
", "format": "string" }, "descriptionLine3": { "maxLength": 50, "type": "string", "description": "

Error codes

FACT_INCASSO_015Description line 3 is too long.
", "format": "string" } }, "description": "If this object is provided, the invoice will be marked for direct debit with the provided details." }, "mutation": { "title": "CreateInvoiceMutation", "properties": { "description": { "maxLength": 200, "type": "string", "description": "Description of the mutation.

Error codes

FACT_VERWERK_002Description is too long.
", "format": "string" }, "checkPaymentReference": { "type": "boolean", "description": "If true, the provided `paymentReference` will be validated for uniqueness." }, "paymentReference": { "maxLength": 50, "type": "string", "description": "A reference that uniquely identifies the mutation.

Error codes

FACT_VERWERK_003Payment reference is too long.
FACT_VERWERK_004Payment reference already exists.
MUTA_008Payment reference already exists.
", "format": "string" }, "ledgerId": { "type": "integer", "description": "Ledger of the invoice entry.

Error codes

MUT_007Unknown ledger for mutation.
", "format": "int32" } }, "description": "If this object is provided, the invoice will also be processed as a new mutation.

Error codes

FACT_VERWERK_001Invoice date resides in a closed period.
" }, "items": { "maxItems": 500, "type": "array", "items": { "title": "CreateInvoiceItem", "required": [ "description", "vatCode", "ledgerId" ], "properties": { "quantity": { "type": "number", "description": "The item quantity, with up to 4 decimal places.", "default": 0 }, "amount": { "type": "number", "description": "The item quantity. To keep your code ready for future API versions it is recommended to use `quantity` instead.", "deprecated": true }, "unitId": { "type": [ "null", "integer" ], "description": "The ID of an existing unit.

Error codes

FACT_ITEM_010Unit not found.
", "format": "int32" }, "code": { "maxLength": 50, "type": "string", "description": "

Error codes

FACT_ITEM_003Code invoice item is too long.
", "format": "string" }, "productId": { "type": [ "null", "integer" ], "description": "The ID of an existing product. If given, `Code` is ignored.

Error codes

FACT_ITEM_011Product not found.
", "format": "int32" }, "description": { "type": "string", "description": "

Error codes

FACT_ITEM_001Description invoice item is missing.
FACT_ITEM_002Description invoice item is too long.
", "format": "string" }, "pricePerUnit": { "type": "number", "description": "

Error codes

FACT_ITEM_004Price per unit excl. VAT is missing.
FACT_ITEM_008Total price is too high.
FACT_ITEM_009Total price is too low.
" }, "vatCode": { "$ref": "#/components/schemas/VatCode" }, "vatAmount": { "type": "number", "description": "The VAT amount of the invoice item. Only use in combination with vatCode: 'AFW_VERK'. Only applicable for NL.

Error codes

FACT_ITEM_015VAT amount must be used with VAT code: 'AFW_VERK'
", "example": "20" }, "ledgerId": { "type": "integer", "description": "The ID of an existing ledger account

Error codes

FACT_ITEM_007Ledger ID is missing
FACT_ITEM_012Ledger account not found.
", "format": "int32" }, "costCenterId": { "type": [ "null", "integer" ], "format": "int32" }, "discountAmount": { "type": [ "null", "number" ], "description": "A fixed discount on the `pricePerUnit`. This field can not be combined with `discountPercentage`." }, "discountPercentage": { "type": [ "null", "number" ], "description": "A percentage discount on the `pricePerUnit`. This field can not be combined with `discountAmount`." } } }, "description": "At least one invoice item is required.

Error codes

FACT_004Total invoice amount too high.
FACT_005Total invoice amount too low.
FACT_019Invoice items are missing.
FACT_025Too many items.
" } } }, "example": { "Id": null, "InvoiceNumber": "F00001", "Relation": null, "RelationId": 1500, "Date": "2026-10-23", "TermOfPayment": 14, "InExVat": "EX", "TemplateId": 2100, "EmailTemplateId": 1700, "Reference": "Reference", "Text": "Text", "Print": false, "Email": { "FromEmail": "", "FromName": "", "Subject": "", "Body": "", "AttachUbl": false, "InvoiceUbl": null }, "DirectDebit": { "DirectDebit": null, "Iban": "", "MandateType": "", "MandateId": "", "MandateSignedDate": "2026-10-23", "Name": "", "City": "", "DescriptionLine1": "", "DescriptionLine2": "", "DescriptionLine3": "" }, "Mutation": { "Description": "", "CheckPaymentReference": true, "PaymentReference": "REF00123", "LedgerId": 1100 }, "InvoiceEntry": null, "Items": [ { "Quantity": 0.0, "Amount": 0.0, "UnitId": 0, "Code": "", "ProductId": 0, "Description": "", "PricePerUnit": 0.0, "VatCode": "HOOG_VERK_21", "VatAmount": null, "LedgerId": 0, "CostCenterId": 0, "DiscountAmount": 0.0, "DiscountPercentage": 0.0 } ] } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "title": "CreatedInvoice", "properties": { "id": { "type": "integer", "description": "The ID of the invoice.", "format": "int32" }, "invoiceNumber": { "type": "string", "description": "The invoice number.", "format": "string" }, "inExVat": { "enum": [ "IN", "EX" ], "type": "string", "description": "Indicates if the price per unit of the sub items on the invoice is including (`IN`) or excluding (`EX`) VAT.

Error codes

FACT_010Invoice VAT must be IN or EX.
", "format": "string" } } }, "example": { "Id": 1000, "InvoiceNumber": "F00001", "RelationId": null, "Date": null, "Reference": null, "Text": null, "TermOfPayment": null, "InExVat": null, "TotalExcl": null, "TotalAmount": null, "VatAmount": null, "UrlPdfFile": null } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] }, "get": { "tags": [ "Invoice" ], "description": "Search for invoices.", "operationId": "GetInvoices", "parameters": [ { "name": "limit", "in": "query", "description": "The number of items to retrieve.", "schema": { "maximum": 2000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of items to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "invoiceNumber", "in": "query", "description": "Only retrieve the invoice with this number.", "schema": { "type": "string", "format": "filter-string" } }, { "name": "relationId", "in": "query", "description": "Only retrieve invoices from this relation.", "schema": { "type": "integer", "format": "int32" } }, { "name": "date", "in": "query", "description": "Only retrieve invoices on this date.", "schema": { "type": "string", "format": "filter-date" }, "example": "2021-01-01" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDtoOfInvoicesResponseDto" }, "example": { "Items": [ { "Id": 1000, "InvoiceNumber": "F00001", "RelationId": 1500, "Date": "2026-10-23", "Reference": "Reference", "Text": "Text", "UrlPdfFile": "", "TotalExcl": 121.0, "TotalAmount": 131.89, "VatAmount": 10.89, "TermOfPayment": 14, "TemplateId": 2100, "Print": false } ], "Count": 1 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/invoice/{id}": { "get": { "tags": [ "Invoice" ], "description": "Get an invoice.", "operationId": "GetInvoice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "Invoice", "properties": { "id": { "type": "integer", "description": "The ID of the invoice.", "format": "int32" }, "invoiceNumber": { "type": "string", "description": "The invoice number.", "format": "string" }, "relationId": { "type": "integer", "description": "The ID of a relation.", "format": "int32" }, "date": { "type": "object", "description": "Invoice date.", "format": "date" }, "reference": { "type": "string", "description": "Reference of the invoice.", "format": "string" }, "text": { "type": "string", "description": "Text of the invoice.", "format": "string" }, "termOfPayment": { "type": "integer", "description": "Term of payment from the invoice date, in days.", "format": "int32" }, "inExVat": { "enum": [ "IN", "EX" ], "type": "string", "description": "Indicates if the price per unit of the sub items on the invoice is including (`IN`) or excluding (`EX`) VAT.

Error codes

FACT_010Invoice VAT must be IN or EX.
", "format": "string" }, "templateId": { "type": "integer", "description": "The ID of an invoice template.", "format": "int32" }, "emailTemplateId": { "type": "integer", "description": "The ID of an email template.", "format": "int32" }, "totalExcl": { "type": "number", "description": "The invoice amount, excluding VAT." }, "totalAmount": { "type": "number", "description": "The invoice amount, including VAT." }, "vatAmount": { "type": "number", "description": "The VAT amount." }, "urlPdfFile": { "type": "string", "description": "A shareable url to download the invoice as a PDF file.", "format": "string" }, "items": { "type": "array", "items": { "title": "InvoiceItem", "required": [ "description", "vatCode", "ledgerId" ], "properties": { "quantity": { "type": "number", "description": "The item quantity, with up to 4 decimal places.", "default": 0 }, "amount": { "type": "number", "description": "The item quantity. To keep your code ready for future API versions it is recommended to use `quantity` instead.", "deprecated": true }, "unitId": { "type": [ "null", "integer" ], "description": "The ID of an existing unit.

Error codes

FACT_ITEM_010Unit not found.
", "format": "int32" }, "code": { "maxLength": 50, "type": "string", "description": "

Error codes

FACT_ITEM_003Code invoice item is too long.
", "format": "string" }, "productId": { "type": [ "null", "integer" ], "description": "The ID of an existing product. If given, `Code` is ignored.

Error codes

FACT_ITEM_011Product not found.
", "format": "int32" }, "description": { "type": "string", "description": "

Error codes

FACT_ITEM_001Description invoice item is missing.
FACT_ITEM_002Description invoice item is too long.
", "format": "string" }, "pricePerUnit": { "type": "number", "description": "

Error codes

FACT_ITEM_004Price per unit excl. VAT is missing.
FACT_ITEM_008Total price is too high.
FACT_ITEM_009Total price is too low.
" }, "vatCode": { "$ref": "#/components/schemas/VatCode" }, "vatAmount": { "type": "number", "description": "The VAT amount of the invoice item. VAT amount is only shown when the setting 'btw-berekenig' has 'Btw per afzonderlijke factuurregel berekenen' enabled.

Error codes

FACT_ITEM_015VAT amount must be used with VAT code: 'AFW_VERK'
", "example": "20" }, "ledgerId": { "type": "integer", "description": "The ID of an existing ledger account

Error codes

FACT_ITEM_007Ledger ID is missing
FACT_ITEM_012Ledger account not found.
", "format": "int32" }, "costCenterId": { "type": [ "null", "integer" ], "format": "int32" }, "discountAmount": { "type": [ "null", "number" ], "description": "A fixed discount on the `pricePerUnit`. This field can not be combined with `discountPercentage`." }, "discountPercentage": { "type": [ "null", "number" ], "description": "A percentage discount on the `pricePerUnit`. This field can not be combined with `discountAmount`." } } }, "description": "At least one invoice item is required." } } }, "example": { "Id": 1000, "InvoiceNumber": "F00001", "RelationId": 1500, "Date": "2026-10-23", "Reference": "Reference", "Text": "Text", "TermOfPayment": 14, "InExVat": "EX", "TemplateId": 2100, "EmailTemplateId": 1100, "TotalExcl": 121.0, "TotalAmount": 131.89, "VatAmount": 10.89, "UrlPdfFile": "", "Items": [ { "Quantity": 2.0, "Amount": 2.0, "UnitId": 1, "Code": "PRD001", "ProductId": 101, "Description": "Product A", "PricePerUnit": 50.0, "VatCode": "HOOG_VERK_21", "VatAmount": 10.5, "LedgerId": 3001, "CostCenterId": 4001, "DiscountAmount": 5.0, "DiscountPercentage": null } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/invoicetemplate": { "get": { "tags": [ "InvoiceTemplate" ], "description": "Get all invoice templates.", "operationId": "GetInvoiceTemplates", "parameters": [ { "name": "limit", "in": "query", "description": "The number of items to retrieve.", "schema": { "maximum": 2000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of items to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "name", "in": "query", "description": "Name of the invoice template.", "schema": { "type": "string", "format": "filter-string" } }, { "name": "type", "in": "query", "description": "Template type. Editor (`E`) or advanced (`A`).", "schema": { "type": "string", "format": "string" } }, { "name": "active", "in": "query", "description": "Whether the invoice template is active.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDtoOfInvoiceTemplateDto" }, "example": { "Items": [ { "Id": 1, "Name": "Factuursjabloon", "Active": true, "Type": "E" } ], "Count": 1 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/ledger": { "get": { "tags": [ "Ledger" ], "description": "Get all ledgers.", "operationId": "GetLedgers", "parameters": [ { "name": "limit", "in": "query", "description": "The number of items to retrieve.", "schema": { "maximum": 2000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of items to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "code", "in": "query", "description": "The code of the ledger.", "schema": { "maxLength": 10, "type": "string", "format": "filter-string" } }, { "name": "category", "in": "query", "description": "The category of the ledger.", "schema": { "maxLength": 10, "type": "string", "format": "filter-string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDtoOfLedgersResponseDto" }, "example": { "Items": [ { "Id": 1, "Code": "7000", "Description": "Inkopen", "Category": "VW", "Group": null } ], "Count": 1 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] }, "post": { "tags": [ "Ledger" ], "description": "Create a new ledger.", "operationId": "CreateLedger", "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "CreateLedger", "required": [ "code", "description" ], "properties": { "code": { "type": "string", "description": "The code of the ledger.

Error codes

LEDG_001Code is missing.
LEDG_002Code is too long.
", "format": "string" }, "description": { "type": "string", "description": "The description of the ledger.

Error codes

LEDG_003Description is missing.
LEDG_004Description is too long.
", "format": "string" }, "category": { "$ref": "#/components/schemas/Category" }, "group": { "type": "string", "description": "The group of the ledger.

Error codes

LEDG_007Group is missing.
", "format": "string" } } }, "example": { "Id": 123, "Code": "E123", "Description": "This serves as an example.", "Category": "BAL", "Group": "01234" } }, "application/json": { "schema": { "title": "CreateLedger", "required": [ "code", "description" ], "properties": { "code": { "type": "string", "description": "The code of the ledger.

Error codes

LEDG_001Code is missing.
LEDG_002Code is too long.
", "format": "string" }, "description": { "type": "string", "description": "The description of the ledger.

Error codes

LEDG_003Description is missing.
LEDG_004Description is too long.
", "format": "string" }, "category": { "$ref": "#/components/schemas/Category" }, "group": { "type": "string", "description": "The group of the ledger.

Error codes

LEDG_007Group is missing.
", "format": "string" } } }, "example": { "Id": 123, "Code": "E123", "Description": "This serves as an example.", "Category": "BAL", "Group": "01234" } }, "application/*+json": { "schema": { "title": "CreateLedger", "required": [ "code", "description" ], "properties": { "code": { "type": "string", "description": "The code of the ledger.

Error codes

LEDG_001Code is missing.
LEDG_002Code is too long.
", "format": "string" }, "description": { "type": "string", "description": "The description of the ledger.

Error codes

LEDG_003Description is missing.
LEDG_004Description is too long.
", "format": "string" }, "category": { "$ref": "#/components/schemas/Category" }, "group": { "type": "string", "description": "The group of the ledger.

Error codes

LEDG_007Group is missing.
", "format": "string" } } }, "example": { "Id": 123, "Code": "E123", "Description": "This serves as an example.", "Category": "BAL", "Group": "01234" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "title": "CreatedLedger", "properties": { "id": { "type": "integer", "description": "The ID of the ledger.", "format": "int32" } } }, "example": { "Id": 123, "Code": null, "Description": null, "Category": null, "Group": null } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/ledger/{id}": { "get": { "tags": [ "Ledger" ], "description": "Get a ledger.", "operationId": "GetLedger", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "Ledger", "properties": { "id": { "type": "integer", "description": "The ID of the ledger.", "format": "int32" }, "code": { "type": "string", "description": "The code of the ledger.", "format": "string" }, "description": { "type": "string", "description": "The description of the ledger.", "format": "string" }, "category": { "type": "string", "description": "The category of the ledger.", "format": "string" }, "group": { "type": "string", "description": "The group of the ledger.", "format": "string" } } }, "example": { "Id": 123, "Code": "E123", "Description": "This serves as an example.", "Category": "BAL", "Group": "01234" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] }, "patch": { "tags": [ "Ledger" ], "description": "Update a ledger.", "operationId": "UpdateLedger", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "PatchLedger", "properties": { "code": { "maxLength": 10, "type": "string", "description": "The code of the ledger.

Error codes

LEDG_001Code is missing.
LEDG_002Code is too long.
", "format": "string" }, "description": { "maxLength": 100, "type": "string", "description": "The description of the ledger.

Error codes

LEDG_003Description is missing.
LEDG_004Description is too long.
", "format": "string" }, "category": { "$ref": "#/components/schemas/Category" }, "group": { "maxLength": 50, "type": "string", "description": "The group of the ledger.

Error codes

LEDG_007Group is missing.
", "format": "string" } } }, "example": { "Id": 123, "Code": "E123", "Description": "This serves as an example.", "Category": "BAL", "Group": "01234" } }, "application/json": { "schema": { "title": "PatchLedger", "properties": { "code": { "maxLength": 10, "type": "string", "description": "The code of the ledger.

Error codes

LEDG_001Code is missing.
LEDG_002Code is too long.
", "format": "string" }, "description": { "maxLength": 100, "type": "string", "description": "The description of the ledger.

Error codes

LEDG_003Description is missing.
LEDG_004Description is too long.
", "format": "string" }, "category": { "$ref": "#/components/schemas/Category" }, "group": { "maxLength": 50, "type": "string", "description": "The group of the ledger.

Error codes

LEDG_007Group is missing.
", "format": "string" } } }, "example": { "Id": 123, "Code": "E123", "Description": "This serves as an example.", "Category": "BAL", "Group": "01234" } }, "application/*+json": { "schema": { "title": "PatchLedger", "properties": { "code": { "maxLength": 10, "type": "string", "description": "The code of the ledger.

Error codes

LEDG_001Code is missing.
LEDG_002Code is too long.
", "format": "string" }, "description": { "maxLength": 100, "type": "string", "description": "The description of the ledger.

Error codes

LEDG_003Description is missing.
LEDG_004Description is too long.
", "format": "string" }, "category": { "$ref": "#/components/schemas/Category" }, "group": { "maxLength": 50, "type": "string", "description": "The group of the ledger.

Error codes

LEDG_007Group is missing.
", "format": "string" } } }, "example": { "Id": 123, "Code": "E123", "Description": "This serves as an example.", "Category": "BAL", "Group": "01234" } } }, "required": true }, "responses": { "204": { "description": "No Content", "content": { "application/json": { } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/ledger/{id}/balance": { "get": { "tags": [ "Ledger" ], "description": "Get the balance on the given ledger with optional filters.", "operationId": "GetBalance", "parameters": [ { "name": "costCenterId", "in": "query", "description": "The ID of the cost center.", "schema": { "type": "integer", "format": "int32" } }, { "name": "from", "in": "query", "description": "Show the balance starting from this date. When provided, the resulting balance is the difference over the period, rather than the actual balance.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Shows the active balance at this date. This date is inclusive.", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "LedgerBalance", "properties": { "code": { "type": "string", "description": "The code of the ledger.", "format": "string" }, "type": { "type": "string", "description": "The type of the ledger.", "format": "string" }, "balance": { "type": "number", "description": "The balance based on the sum of all mutations on the ledger." } } }, "example": { "Code": "1001", "Type": "DEB", "Balance": 500.0 } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/ledger/balances": { "get": { "tags": [ "Ledger" ], "description": "Get the balances on all ledgers with optional filters.", "operationId": "GetBalances", "parameters": [ { "name": "costCenterId", "in": "query", "description": "The ID of the cost center.", "schema": { "type": "integer", "format": "int32" } }, { "name": "from", "in": "query", "description": "Show the balance starting from this date. When provided, the resulting balance is the difference over the period, rather than the actual balance.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Shows the active balance at this date. This date is inclusive.", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDtoOfLedgerBalanceResponseDto" }, "example": { "Items": [ { "Code": "1001", "Type": "DEB", "Balance": 500.0 } ], "Count": 1 } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/member/{id}": { "get": { "tags": [ "Member" ], "description": "Get a member (only available to clubs or associations).", "operationId": "GetMember", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "Member", "properties": { "id": { "type": "integer", "description": "The ID of the member.", "format": "int32" }, "memberNumber": { "maxLength": 15, "type": "string", "description": "The number of the member.", "format": "string" }, "name": { "maxLength": 100, "type": "string", "description": "The (company) name of the member.", "format": "string" }, "salutation": { "maxLength": 50, "type": "string", "description": "The salutation of the member.", "format": "string" }, "gender": { "maxLength": 1, "enum": [ "m", "v", "a" ], "type": "string", "description": "Male (`m`), female (`v`) or department ('a')", "format": "string" }, "address": { "maxLength": 150, "type": "string", "description": "The primary address of the member.", "format": "string" }, "postalCode": { "maxLength": 50, "type": "string", "description": "The primary postal code of the member.", "format": "string" }, "city": { "maxLength": 50, "type": "string", "description": "The primary city of the member.", "format": "string" }, "country": { "maxLength": 50, "type": "string", "description": "The primary country of the member.", "format": "string" }, "phoneNumber": { "maxLength": 50, "type": "string", "description": "The phone number of the member.", "format": "string" }, "mobilePhoneNumber": { "maxLength": 50, "type": "string", "description": "The mobile phone number of the member.", "format": "string" }, "faxNumber": { "maxLength": 50, "type": "string", "description": "The fax number of the member.", "format": "string" }, "emailAddress": { "maxLength": 150, "type": "string", "description": "The email address of the member.", "format": "string" }, "emailAddressInvoice": { "maxLength": 150, "type": "string", "description": "The invoice email address of the member.", "format": "string" }, "emailAddressReminder": { "maxLength": 150, "type": "string", "description": "The reminder email address of the member.", "format": "string" }, "note": { "maxLength": 40000, "type": "string", "description": "The note of the member.", "format": "string" }, "termOfPayment": { "type": [ "null", "integer" ], "description": "The payment term of the member.", "format": "int32" }, "iban": { "maxLength": 50, "type": "string", "description": "The IBAN number of the member.", "format": "string" }, "bic": { "maxLength": 20, "type": "string", "description": "The BIC number of the member.", "format": "string" }, "freeText1": { "maxLength": 100, "type": [ "null", "string" ], "description": "Free text field for the member.", "format": "string" }, "freeText2": { "maxLength": 100, "type": [ "null", "string" ], "description": "Free text field for the member.", "format": "string" }, "freeText3": { "maxLength": 100, "type": [ "null", "string" ], "description": "Free text field for the member.", "format": "string" }, "freeText4": { "maxLength": 100, "type": "string", "description": "Free text field for the member.", "format": "string" }, "freeText5": { "maxLength": 100, "type": "string", "description": "Free text field for the member.", "format": "string" }, "freeText6": { "maxLength": 100, "type": "string", "description": "Free text field for the member.", "format": "string" }, "freeText7": { "maxLength": 100, "type": "string", "description": "Free text field for the member.", "format": "string" }, "freeText8": { "maxLength": 100, "type": "string", "description": "Free text field for the member.", "format": "string" }, "freeText9": { "maxLength": 100, "type": "string", "description": "Free text field for the member.", "format": "string" }, "freeText10": { "maxLength": 100, "type": "string", "description": "Free text field for the member.", "format": "string" }, "doNotReceiveNewsletters": { "type": [ "null", "integer" ], "description": "Whether the member will receive newsletters or not.", "format": "int32" }, "ledgerId": { "type": [ "null", "integer" ], "description": "The ledger ID of this member.", "format": "int32" }, "mandate": { "type": "boolean" }, "mandateType": { "maxLength": 1, "enum": [ "E", "D" ], "type": "string", "description": "one-time (`E`) or continuous (`D`)", "format": "string" }, "mandateId": { "maxLength": 35, "type": "string", "description": "The mandate ID of this member.", "format": "string" }, "mandateSignedDate": { "type": [ "null", "object" ], "description": "The signing date of the mandate for this member.", "format": "date" } } }, "example": { "Id": 27, "MemberNumber": "MEM001", "Name": "Jane Doe", "Salutation": "Ms.", "Gender": "v", "Address": "123 Main Street", "PostalCode": "12345", "City": "Example City", "Country": "Example Country", "PhoneNumber": "+123456789", "MobilePhoneNumber": "+987654321", "FaxNumber": "+1122334455", "EmailAddress": "example@example.com", "EmailAddressInvoice": "invoice@example.com", "EmailAddressReminder": "reminder@example.com", "Note": "This is a sample note.", "TermOfPayment": 30, "Iban": "NL91ABNA0417164300", "Bic": "ABNANL2A", "FreeText1": "", "FreeText2": "", "FreeText3": "", "FreeText4": "", "FreeText5": "", "FreeText6": "", "FreeText7": "", "FreeText8": "", "FreeText9": "", "FreeText10": "", "DoNotReceiveNewsletters": true, "LedgerId": 1001, "Mandate": true, "MandateType": "D", "MandateId": "MAND12345", "MandateSignedDate": "2023-10-01" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] }, "patch": { "tags": [ "Member" ], "description": "Update an existing member (only available to clubs or associations).", "operationId": "UpdateMember", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "Member", "required": [ "name" ], "properties": { "memberNumber": { "maxLength": 15, "type": "string", "description": "The code of the member.

Error codes

MEM_049Member number already exists.
MEM_005Member number is invalid.
MEM_006Member number is too long.
", "format": "string" }, "name": { "maxLength": 100, "type": "string", "description": "The name of the member.

Error codes

MEM_002Name is mandatory.
MEM_003Name is too long.
", "format": "string" }, "salutation": { "maxLength": 50, "type": "string", "description": "The salutation of the member.

Error codes

MEM_010Salutation is too long.
", "format": "string" }, "gender": { "maxLength": 1, "enum": [ "m", "v", "a" ], "type": "string", "description": "Male (`m`), female (`v`) or department ('a')

Error codes

MEM_004Gender is invalid (m,v,a).
", "format": "string" }, "address": { "maxLength": 150, "type": "string", "description": "The primary address of the member.

Error codes

MEM_011Address is too long.
", "format": "string" }, "postalCode": { "maxLength": 50, "type": "string", "description": "The primary postal code of the member.

Error codes

MEM_012Postal code is too long.
", "format": "string" }, "city": { "maxLength": 50, "type": "string", "description": "The primary city of the member.

Error codes

MEM_013City is too long.
", "format": "string" }, "country": { "maxLength": 50, "type": "string", "description": "The primary country of the member.

Error codes

MEM_014Country is too long.
", "format": "string" }, "phoneNumber": { "maxLength": 50, "type": "string", "description": "The phone number of the member.

Error codes

MEM_019Phone is too long.
", "format": "string" }, "mobilePhoneNumber": { "maxLength": 50, "type": "string", "description": "The mobile phone number of the member.

Error codes

MEM_020Mobile is too long.
", "format": "string" }, "faxNumber": { "maxLength": 50, "type": "string", "description": "The fax number of the member.

Error codes

MEM_021Fax is too long.
", "format": "string" }, "emailAddress": { "maxLength": 150, "type": "string", "description": "The email address of the member.

Error codes

MEM_022Email is too long.
MEM_023Email is invalid.
", "format": "string" }, "emailAddressInvoice": { "maxLength": 150, "type": "string", "description": "The invoice email address of the member.

Error codes

MEM_024Email invoice is too long.
MEM_025Email invoice is invalid.
", "format": "string" }, "emailAddressReminder": { "maxLength": 150, "type": "string", "description": "The reminder email address of the member.

Error codes

MEM_026Email reminder is too long.
MEM_027Email reminder is invalid.
", "format": "string" }, "note": { "maxLength": 40000, "type": "string", "description": "The note of the member.", "format": "string" }, "termOfPayment": { "type": [ "null", "integer" ], "description": "The payment term of the member.

Error codes

MEM_030Term of payment too low.
MEM_031Term of payment too high.
", "format": "int32" }, "iban": { "maxLength": 50, "type": "string", "description": "The IBAN number of the member.

Error codes

MEM_007Iban is invalid.
MEM_029Iban is too long.
", "format": "string" }, "bic": { "maxLength": 20, "type": "string", "description": "The BIC number of the member.

Error codes

MEM_032BIC is too long.
", "format": "string" }, "freeText1": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_037Free text 1 is too long.
", "format": "string" }, "freeText2": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_038Free text 2 is too long.
", "format": "string" }, "freeText3": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_039Free text 3 is too long.
", "format": "string" }, "freeText4": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_040Free text 4 is too long.
", "format": "string" }, "freeText5": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_041Free text 5 is too long.
", "format": "string" }, "freeText6": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_042Free text 6 is too long.
", "format": "string" }, "freeText7": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_043Free text 7 is too long.
", "format": "string" }, "freeText8": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_044Free text 8 is too long.
", "format": "string" }, "freeText9": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_045Free text 9 is too long.
", "format": "string" }, "freeText10": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_046Free text 10 is too long.
", "format": "string" }, "doNotReceiveNewsletters": { "type": [ "null", "boolean" ], "description": "Whether the member will receive newsletters or not." }, "ledgerId": { "type": [ "null", "integer" ], "description": "The ledger ID of this member.

Error codes

MEM_048Ledger not found.
MEM_057Ledger must be active and of category 'BAL' or 'VW'.
", "format": "int32" }, "mandate": { "type": "boolean", "description": "Enable or disable mandate." }, "mandateType": { "maxLength": 1, "enum": [ "E", "D" ], "type": "string", "description": "one-time (`E`) or continuous (`D`)

Error codes

MEM_033Mandate type is too long.
MEM_051Mandate type is invalid (E,D).
", "format": "string" }, "mandateId": { "maxLength": 35, "type": "string", "description": "The mandate ID of this member.

Error codes

MEM_034Mandate ID is too long.
", "format": "string" }, "mandateSignedDate": { "type": [ "null", "object" ], "description": "The signing date of the mandate for this member.", "format": "date" } } }, "example": { "Id": null, "MemberNumber": "MEM001", "Name": "Jane Doe", "Salutation": "Ms.", "Gender": "v", "Address": "123 Main Street", "PostalCode": "12345", "City": "Example City", "Country": "Example Country", "PhoneNumber": "+123456789", "MobilePhoneNumber": "+987654321", "FaxNumber": "+1122334455", "EmailAddress": "example@example.com", "EmailAddressInvoice": "invoice@example.com", "EmailAddressReminder": "reminder@example.com", "Note": "This is a sample note.", "TermOfPayment": 30, "Iban": "NL91ABNA0417164300", "Bic": "ABNANL2A", "FreeText1": "", "FreeText2": "", "FreeText3": "", "FreeText4": "", "FreeText5": "", "FreeText6": "", "FreeText7": "", "FreeText8": "", "FreeText9": "", "FreeText10": "", "DoNotReceiveNewsletters": true, "LedgerId": 1001, "Mandate": true, "MandateType": "D", "MandateId": "MAND12345", "MandateSignedDate": "2023-10-01" } }, "application/json": { "schema": { "title": "Member", "required": [ "name" ], "properties": { "memberNumber": { "maxLength": 15, "type": "string", "description": "The code of the member.

Error codes

MEM_049Member number already exists.
MEM_005Member number is invalid.
MEM_006Member number is too long.
", "format": "string" }, "name": { "maxLength": 100, "type": "string", "description": "The name of the member.

Error codes

MEM_002Name is mandatory.
MEM_003Name is too long.
", "format": "string" }, "salutation": { "maxLength": 50, "type": "string", "description": "The salutation of the member.

Error codes

MEM_010Salutation is too long.
", "format": "string" }, "gender": { "maxLength": 1, "enum": [ "m", "v", "a" ], "type": "string", "description": "Male (`m`), female (`v`) or department ('a')

Error codes

MEM_004Gender is invalid (m,v,a).
", "format": "string" }, "address": { "maxLength": 150, "type": "string", "description": "The primary address of the member.

Error codes

MEM_011Address is too long.
", "format": "string" }, "postalCode": { "maxLength": 50, "type": "string", "description": "The primary postal code of the member.

Error codes

MEM_012Postal code is too long.
", "format": "string" }, "city": { "maxLength": 50, "type": "string", "description": "The primary city of the member.

Error codes

MEM_013City is too long.
", "format": "string" }, "country": { "maxLength": 50, "type": "string", "description": "The primary country of the member.

Error codes

MEM_014Country is too long.
", "format": "string" }, "phoneNumber": { "maxLength": 50, "type": "string", "description": "The phone number of the member.

Error codes

MEM_019Phone is too long.
", "format": "string" }, "mobilePhoneNumber": { "maxLength": 50, "type": "string", "description": "The mobile phone number of the member.

Error codes

MEM_020Mobile is too long.
", "format": "string" }, "faxNumber": { "maxLength": 50, "type": "string", "description": "The fax number of the member.

Error codes

MEM_021Fax is too long.
", "format": "string" }, "emailAddress": { "maxLength": 150, "type": "string", "description": "The email address of the member.

Error codes

MEM_022Email is too long.
MEM_023Email is invalid.
", "format": "string" }, "emailAddressInvoice": { "maxLength": 150, "type": "string", "description": "The invoice email address of the member.

Error codes

MEM_024Email invoice is too long.
MEM_025Email invoice is invalid.
", "format": "string" }, "emailAddressReminder": { "maxLength": 150, "type": "string", "description": "The reminder email address of the member.

Error codes

MEM_026Email reminder is too long.
MEM_027Email reminder is invalid.
", "format": "string" }, "note": { "maxLength": 40000, "type": "string", "description": "The note of the member.", "format": "string" }, "termOfPayment": { "type": [ "null", "integer" ], "description": "The payment term of the member.

Error codes

MEM_030Term of payment too low.
MEM_031Term of payment too high.
", "format": "int32" }, "iban": { "maxLength": 50, "type": "string", "description": "The IBAN number of the member.

Error codes

MEM_007Iban is invalid.
MEM_029Iban is too long.
", "format": "string" }, "bic": { "maxLength": 20, "type": "string", "description": "The BIC number of the member.

Error codes

MEM_032BIC is too long.
", "format": "string" }, "freeText1": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_037Free text 1 is too long.
", "format": "string" }, "freeText2": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_038Free text 2 is too long.
", "format": "string" }, "freeText3": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_039Free text 3 is too long.
", "format": "string" }, "freeText4": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_040Free text 4 is too long.
", "format": "string" }, "freeText5": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_041Free text 5 is too long.
", "format": "string" }, "freeText6": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_042Free text 6 is too long.
", "format": "string" }, "freeText7": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_043Free text 7 is too long.
", "format": "string" }, "freeText8": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_044Free text 8 is too long.
", "format": "string" }, "freeText9": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_045Free text 9 is too long.
", "format": "string" }, "freeText10": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_046Free text 10 is too long.
", "format": "string" }, "doNotReceiveNewsletters": { "type": [ "null", "boolean" ], "description": "Whether the member will receive newsletters or not." }, "ledgerId": { "type": [ "null", "integer" ], "description": "The ledger ID of this member.

Error codes

MEM_048Ledger not found.
MEM_057Ledger must be active and of category 'BAL' or 'VW'.
", "format": "int32" }, "mandate": { "type": "boolean", "description": "Enable or disable mandate." }, "mandateType": { "maxLength": 1, "enum": [ "E", "D" ], "type": "string", "description": "one-time (`E`) or continuous (`D`)

Error codes

MEM_033Mandate type is too long.
MEM_051Mandate type is invalid (E,D).
", "format": "string" }, "mandateId": { "maxLength": 35, "type": "string", "description": "The mandate ID of this member.

Error codes

MEM_034Mandate ID is too long.
", "format": "string" }, "mandateSignedDate": { "type": [ "null", "object" ], "description": "The signing date of the mandate for this member.", "format": "date" } } }, "example": { "Id": null, "MemberNumber": "MEM001", "Name": "Jane Doe", "Salutation": "Ms.", "Gender": "v", "Address": "123 Main Street", "PostalCode": "12345", "City": "Example City", "Country": "Example Country", "PhoneNumber": "+123456789", "MobilePhoneNumber": "+987654321", "FaxNumber": "+1122334455", "EmailAddress": "example@example.com", "EmailAddressInvoice": "invoice@example.com", "EmailAddressReminder": "reminder@example.com", "Note": "This is a sample note.", "TermOfPayment": 30, "Iban": "NL91ABNA0417164300", "Bic": "ABNANL2A", "FreeText1": "", "FreeText2": "", "FreeText3": "", "FreeText4": "", "FreeText5": "", "FreeText6": "", "FreeText7": "", "FreeText8": "", "FreeText9": "", "FreeText10": "", "DoNotReceiveNewsletters": true, "LedgerId": 1001, "Mandate": true, "MandateType": "D", "MandateId": "MAND12345", "MandateSignedDate": "2023-10-01" } }, "application/*+json": { "schema": { "title": "Member", "required": [ "name" ], "properties": { "memberNumber": { "maxLength": 15, "type": "string", "description": "The code of the member.

Error codes

MEM_049Member number already exists.
MEM_005Member number is invalid.
MEM_006Member number is too long.
", "format": "string" }, "name": { "maxLength": 100, "type": "string", "description": "The name of the member.

Error codes

MEM_002Name is mandatory.
MEM_003Name is too long.
", "format": "string" }, "salutation": { "maxLength": 50, "type": "string", "description": "The salutation of the member.

Error codes

MEM_010Salutation is too long.
", "format": "string" }, "gender": { "maxLength": 1, "enum": [ "m", "v", "a" ], "type": "string", "description": "Male (`m`), female (`v`) or department ('a')

Error codes

MEM_004Gender is invalid (m,v,a).
", "format": "string" }, "address": { "maxLength": 150, "type": "string", "description": "The primary address of the member.

Error codes

MEM_011Address is too long.
", "format": "string" }, "postalCode": { "maxLength": 50, "type": "string", "description": "The primary postal code of the member.

Error codes

MEM_012Postal code is too long.
", "format": "string" }, "city": { "maxLength": 50, "type": "string", "description": "The primary city of the member.

Error codes

MEM_013City is too long.
", "format": "string" }, "country": { "maxLength": 50, "type": "string", "description": "The primary country of the member.

Error codes

MEM_014Country is too long.
", "format": "string" }, "phoneNumber": { "maxLength": 50, "type": "string", "description": "The phone number of the member.

Error codes

MEM_019Phone is too long.
", "format": "string" }, "mobilePhoneNumber": { "maxLength": 50, "type": "string", "description": "The mobile phone number of the member.

Error codes

MEM_020Mobile is too long.
", "format": "string" }, "faxNumber": { "maxLength": 50, "type": "string", "description": "The fax number of the member.

Error codes

MEM_021Fax is too long.
", "format": "string" }, "emailAddress": { "maxLength": 150, "type": "string", "description": "The email address of the member.

Error codes

MEM_022Email is too long.
MEM_023Email is invalid.
", "format": "string" }, "emailAddressInvoice": { "maxLength": 150, "type": "string", "description": "The invoice email address of the member.

Error codes

MEM_024Email invoice is too long.
MEM_025Email invoice is invalid.
", "format": "string" }, "emailAddressReminder": { "maxLength": 150, "type": "string", "description": "The reminder email address of the member.

Error codes

MEM_026Email reminder is too long.
MEM_027Email reminder is invalid.
", "format": "string" }, "note": { "maxLength": 40000, "type": "string", "description": "The note of the member.", "format": "string" }, "termOfPayment": { "type": [ "null", "integer" ], "description": "The payment term of the member.

Error codes

MEM_030Term of payment too low.
MEM_031Term of payment too high.
", "format": "int32" }, "iban": { "maxLength": 50, "type": "string", "description": "The IBAN number of the member.

Error codes

MEM_007Iban is invalid.
MEM_029Iban is too long.
", "format": "string" }, "bic": { "maxLength": 20, "type": "string", "description": "The BIC number of the member.

Error codes

MEM_032BIC is too long.
", "format": "string" }, "freeText1": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_037Free text 1 is too long.
", "format": "string" }, "freeText2": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_038Free text 2 is too long.
", "format": "string" }, "freeText3": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_039Free text 3 is too long.
", "format": "string" }, "freeText4": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_040Free text 4 is too long.
", "format": "string" }, "freeText5": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_041Free text 5 is too long.
", "format": "string" }, "freeText6": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_042Free text 6 is too long.
", "format": "string" }, "freeText7": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_043Free text 7 is too long.
", "format": "string" }, "freeText8": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_044Free text 8 is too long.
", "format": "string" }, "freeText9": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_045Free text 9 is too long.
", "format": "string" }, "freeText10": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_046Free text 10 is too long.
", "format": "string" }, "doNotReceiveNewsletters": { "type": [ "null", "boolean" ], "description": "Whether the member will receive newsletters or not." }, "ledgerId": { "type": [ "null", "integer" ], "description": "The ledger ID of this member.

Error codes

MEM_048Ledger not found.
MEM_057Ledger must be active and of category 'BAL' or 'VW'.
", "format": "int32" }, "mandate": { "type": "boolean", "description": "Enable or disable mandate." }, "mandateType": { "maxLength": 1, "enum": [ "E", "D" ], "type": "string", "description": "one-time (`E`) or continuous (`D`)

Error codes

MEM_033Mandate type is too long.
MEM_051Mandate type is invalid (E,D).
", "format": "string" }, "mandateId": { "maxLength": 35, "type": "string", "description": "The mandate ID of this member.

Error codes

MEM_034Mandate ID is too long.
", "format": "string" }, "mandateSignedDate": { "type": [ "null", "object" ], "description": "The signing date of the mandate for this member.", "format": "date" } } }, "example": { "Id": null, "MemberNumber": "MEM001", "Name": "Jane Doe", "Salutation": "Ms.", "Gender": "v", "Address": "123 Main Street", "PostalCode": "12345", "City": "Example City", "Country": "Example Country", "PhoneNumber": "+123456789", "MobilePhoneNumber": "+987654321", "FaxNumber": "+1122334455", "EmailAddress": "example@example.com", "EmailAddressInvoice": "invoice@example.com", "EmailAddressReminder": "reminder@example.com", "Note": "This is a sample note.", "TermOfPayment": 30, "Iban": "NL91ABNA0417164300", "Bic": "ABNANL2A", "FreeText1": "", "FreeText2": "", "FreeText3": "", "FreeText4": "", "FreeText5": "", "FreeText6": "", "FreeText7": "", "FreeText8": "", "FreeText9": "", "FreeText10": "", "DoNotReceiveNewsletters": true, "LedgerId": 1001, "Mandate": true, "MandateType": "D", "MandateId": "MAND12345", "MandateSignedDate": "2023-10-01" } } }, "required": true }, "responses": { "204": { "description": "No Content", "content": { "application/json": { } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/member": { "get": { "tags": [ "Member" ], "description": "Get all members (only available to clubs or associations).", "operationId": "GetMembers", "parameters": [ { "name": "limit", "in": "query", "description": "The number of items to retrieve.", "schema": { "maximum": 2000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of items to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "memberNumber", "in": "query", "description": "The number of the member.", "schema": { "type": "string", "format": "filter-string" } }, { "name": "name", "in": "query", "description": "Only retrieves members with this name.", "schema": { "type": "string", "format": "filter-string" } }, { "name": "email", "in": "query", "description": "Only retrieves members with this e-mailadress.", "schema": { "type": "string", "format": "filter-string" } }, { "name": "city", "in": "query", "description": "Only retrieves members from this city.", "schema": { "type": "string", "format": "filter-string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDtoOfMembersResponseDto" }, "example": { "Items": [ { "Id": 1, "MemberNumber": "MEM001", "Name": "Jane Doe", "Salutation": null, "Gender": null, "Address": null, "PostalCode": null, "City": null, "Country": null, "PhoneNumber": null, "MobilePhoneNumber": null, "FaxNumber": null, "EmailAddress": null, "EmailAddressInvoice": null, "EmailAddressReminder": null, "Note": null, "TermOfPayment": null, "Iban": null, "Bic": null, "FreeText1": null, "FreeText2": null, "FreeText3": null, "FreeText4": null, "FreeText5": null, "FreeText6": null, "FreeText7": null, "FreeText8": null, "FreeText9": null, "FreeText10": null, "DoNotReceiveNewsletters": null, "LedgerId": null, "Mandate": null, "MandateType": null, "MandateId": null, "MandateSignedDate": null } ], "Count": 1 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] }, "post": { "tags": [ "Member" ], "description": "Create a new member (only available to clubs or associations).", "operationId": "CreateMember", "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "Member", "required": [ "name" ], "properties": { "memberNumber": { "maxLength": 15, "type": "string", "description": "The code of the member. Auto-generated if empty.

Error codes

MEM_049Member number already exists.
MEM_005Member number is invalid.
MEM_006Member number is too long.
", "format": "string" }, "name": { "maxLength": 100, "type": "string", "description": "The name of the member.

Error codes

MEM_002Name is mandatory.
MEM_003Name is too long.
", "format": "string" }, "salutation": { "maxLength": 50, "type": "string", "description": "The salutation of the member.

Error codes

MEM_010Salutation is too long.
", "format": "string" }, "gender": { "maxLength": 1, "enum": [ "m", "v", "a" ], "type": "string", "description": "Male (`m`), female (`v`) or department ('a')

Error codes

MEM_004Gender is invalid (m,v,a).
", "format": "string" }, "address": { "maxLength": 150, "type": "string", "description": "The primary address of the member.

Error codes

MEM_011Address is too long.
", "format": "string" }, "postalCode": { "maxLength": 50, "type": "string", "description": "The primary postal code of the member.

Error codes

MEM_012Postal code is too long.
", "format": "string" }, "city": { "maxLength": 50, "type": "string", "description": "The primary city of the member.

Error codes

MEM_013City is too long.
", "format": "string" }, "country": { "maxLength": 50, "type": "string", "description": "The primary country of the member.

Error codes

MEM_014Country is too long.
", "format": "string" }, "phoneNumber": { "maxLength": 50, "type": "string", "description": "The phone number of the member.

Error codes

MEM_019Phone is too long.
", "format": "string" }, "mobilePhoneNumber": { "maxLength": 50, "type": "string", "description": "The mobile phone number of the member.

Error codes

MEM_020Mobile is too long.
", "format": "string" }, "faxNumber": { "maxLength": 50, "type": "string", "description": "The fax number of the member.

Error codes

MEM_021Fax is too long.
", "format": "string" }, "emailAddress": { "maxLength": 150, "type": "string", "description": "The email address of the member.

Error codes

MEM_022Email is too long.
MEM_023Email is invalid.
", "format": "string" }, "emailAddressInvoice": { "maxLength": 150, "type": "string", "description": "The invoice email address of the member.

Error codes

MEM_024Email invoice is too long.
MEM_025Email invoice is invalid.
", "format": "string" }, "emailAddressReminder": { "maxLength": 150, "type": "string", "description": "The reminder email address of the member.

Error codes

MEM_026Email reminder is too long.
MEM_027Email reminder is invalid.
", "format": "string" }, "note": { "maxLength": 40000, "type": "string", "description": "The note of the member.", "format": "string" }, "termOfPayment": { "type": [ "null", "integer" ], "description": "The payment term of the member.

Error codes

MEM_030Term of payment too low.
MEM_031Term of payment too high.
", "format": "int32" }, "iban": { "maxLength": 50, "type": "string", "description": "The IBAN number of the member.

Error codes

MEM_007Iban is invalid.
MEM_029Iban is too long.
", "format": "string" }, "bic": { "maxLength": 20, "type": "string", "description": "The BIC number of the member.

Error codes

MEM_032BIC is too long.
", "format": "string" }, "freeText1": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_037Free text 1 is too long.
", "format": "string" }, "freeText2": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_038Free text 2 is too long.
", "format": "string" }, "freeText3": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_039Free text 3 is too long.
", "format": "string" }, "freeText4": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_040Free text 4 is too long.
", "format": "string" }, "freeText5": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_041Free text 5 is too long.
", "format": "string" }, "freeText6": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_042Free text 6 is too long.
", "format": "string" }, "freeText7": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_043Free text 7 is too long.
", "format": "string" }, "freeText8": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_044Free text 8 is too long.
", "format": "string" }, "freeText9": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_045Free text 9 is too long.
", "format": "string" }, "freeText10": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_046Free text 10 is too long.
", "format": "string" }, "doNotReceiveNewsletters": { "type": [ "null", "boolean" ], "description": "Whether the member will receive newsletters or not." }, "ledgerId": { "type": [ "null", "integer" ], "description": "The ledger ID of this member.

Error codes

MEM_048Ledger not found.
MEM_057Ledger must be active and of category 'BAL' or 'VW'.
", "format": "int32" }, "mandate": { "type": "boolean", "description": "Enable or disable mandate." }, "mandateType": { "maxLength": 1, "enum": [ "E", "D" ], "type": "string", "description": "one-time (`E`) or continuous (`D`)

Error codes

MEM_033Mandate type is too long.
MEM_051Mandate type is invalid (E,D).
", "format": "string" }, "mandateId": { "maxLength": 35, "type": "string", "description": "The mandate ID of this member.

Error codes

MEM_034Mandate ID is too long.
", "format": "string" }, "mandateSignedDate": { "type": [ "null", "object" ], "description": "The signing date of the mandate for this member.", "format": "date" } } }, "example": { "Id": null, "MemberNumber": "MEM12345", "Name": "Jane Doe", "Salutation": "Ms.", "Gender": "v", "Address": "123 Main Street", "PostalCode": "12345", "City": "Sample City", "Country": "Sample Country", "PhoneNumber": "123-456-7890", "MobilePhoneNumber": "987-654-3210", "FaxNumber": "123-456-7891", "EmailAddress": "jane.doe@example.com", "EmailAddressInvoice": "invoice.jane.doe@example.com", "EmailAddressReminder": "reminder.jane.doe@example.com", "Note": "This is a sample note.", "TermOfPayment": 30, "Iban": "NL91ABNA0417164300", "Bic": "ABNANL2A", "FreeText1": "", "FreeText2": "", "FreeText3": "", "FreeText4": "", "FreeText5": "", "FreeText6": "", "FreeText7": "", "FreeText8": "", "FreeText9": "", "FreeText10": "", "DoNotReceiveNewsletters": false, "LedgerId": 1001, "Mandate": true, "MandateType": "D", "MandateId": "MAND12345", "MandateSignedDate": "2023-10-01" } }, "application/json": { "schema": { "title": "Member", "required": [ "name" ], "properties": { "memberNumber": { "maxLength": 15, "type": "string", "description": "The code of the member. Auto-generated if empty.

Error codes

MEM_049Member number already exists.
MEM_005Member number is invalid.
MEM_006Member number is too long.
", "format": "string" }, "name": { "maxLength": 100, "type": "string", "description": "The name of the member.

Error codes

MEM_002Name is mandatory.
MEM_003Name is too long.
", "format": "string" }, "salutation": { "maxLength": 50, "type": "string", "description": "The salutation of the member.

Error codes

MEM_010Salutation is too long.
", "format": "string" }, "gender": { "maxLength": 1, "enum": [ "m", "v", "a" ], "type": "string", "description": "Male (`m`), female (`v`) or department ('a')

Error codes

MEM_004Gender is invalid (m,v,a).
", "format": "string" }, "address": { "maxLength": 150, "type": "string", "description": "The primary address of the member.

Error codes

MEM_011Address is too long.
", "format": "string" }, "postalCode": { "maxLength": 50, "type": "string", "description": "The primary postal code of the member.

Error codes

MEM_012Postal code is too long.
", "format": "string" }, "city": { "maxLength": 50, "type": "string", "description": "The primary city of the member.

Error codes

MEM_013City is too long.
", "format": "string" }, "country": { "maxLength": 50, "type": "string", "description": "The primary country of the member.

Error codes

MEM_014Country is too long.
", "format": "string" }, "phoneNumber": { "maxLength": 50, "type": "string", "description": "The phone number of the member.

Error codes

MEM_019Phone is too long.
", "format": "string" }, "mobilePhoneNumber": { "maxLength": 50, "type": "string", "description": "The mobile phone number of the member.

Error codes

MEM_020Mobile is too long.
", "format": "string" }, "faxNumber": { "maxLength": 50, "type": "string", "description": "The fax number of the member.

Error codes

MEM_021Fax is too long.
", "format": "string" }, "emailAddress": { "maxLength": 150, "type": "string", "description": "The email address of the member.

Error codes

MEM_022Email is too long.
MEM_023Email is invalid.
", "format": "string" }, "emailAddressInvoice": { "maxLength": 150, "type": "string", "description": "The invoice email address of the member.

Error codes

MEM_024Email invoice is too long.
MEM_025Email invoice is invalid.
", "format": "string" }, "emailAddressReminder": { "maxLength": 150, "type": "string", "description": "The reminder email address of the member.

Error codes

MEM_026Email reminder is too long.
MEM_027Email reminder is invalid.
", "format": "string" }, "note": { "maxLength": 40000, "type": "string", "description": "The note of the member.", "format": "string" }, "termOfPayment": { "type": [ "null", "integer" ], "description": "The payment term of the member.

Error codes

MEM_030Term of payment too low.
MEM_031Term of payment too high.
", "format": "int32" }, "iban": { "maxLength": 50, "type": "string", "description": "The IBAN number of the member.

Error codes

MEM_007Iban is invalid.
MEM_029Iban is too long.
", "format": "string" }, "bic": { "maxLength": 20, "type": "string", "description": "The BIC number of the member.

Error codes

MEM_032BIC is too long.
", "format": "string" }, "freeText1": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_037Free text 1 is too long.
", "format": "string" }, "freeText2": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_038Free text 2 is too long.
", "format": "string" }, "freeText3": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_039Free text 3 is too long.
", "format": "string" }, "freeText4": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_040Free text 4 is too long.
", "format": "string" }, "freeText5": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_041Free text 5 is too long.
", "format": "string" }, "freeText6": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_042Free text 6 is too long.
", "format": "string" }, "freeText7": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_043Free text 7 is too long.
", "format": "string" }, "freeText8": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_044Free text 8 is too long.
", "format": "string" }, "freeText9": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_045Free text 9 is too long.
", "format": "string" }, "freeText10": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_046Free text 10 is too long.
", "format": "string" }, "doNotReceiveNewsletters": { "type": [ "null", "boolean" ], "description": "Whether the member will receive newsletters or not." }, "ledgerId": { "type": [ "null", "integer" ], "description": "The ledger ID of this member.

Error codes

MEM_048Ledger not found.
MEM_057Ledger must be active and of category 'BAL' or 'VW'.
", "format": "int32" }, "mandate": { "type": "boolean", "description": "Enable or disable mandate." }, "mandateType": { "maxLength": 1, "enum": [ "E", "D" ], "type": "string", "description": "one-time (`E`) or continuous (`D`)

Error codes

MEM_033Mandate type is too long.
MEM_051Mandate type is invalid (E,D).
", "format": "string" }, "mandateId": { "maxLength": 35, "type": "string", "description": "The mandate ID of this member.

Error codes

MEM_034Mandate ID is too long.
", "format": "string" }, "mandateSignedDate": { "type": [ "null", "object" ], "description": "The signing date of the mandate for this member.", "format": "date" } } }, "example": { "Id": null, "MemberNumber": "MEM12345", "Name": "Jane Doe", "Salutation": "Ms.", "Gender": "v", "Address": "123 Main Street", "PostalCode": "12345", "City": "Sample City", "Country": "Sample Country", "PhoneNumber": "123-456-7890", "MobilePhoneNumber": "987-654-3210", "FaxNumber": "123-456-7891", "EmailAddress": "jane.doe@example.com", "EmailAddressInvoice": "invoice.jane.doe@example.com", "EmailAddressReminder": "reminder.jane.doe@example.com", "Note": "This is a sample note.", "TermOfPayment": 30, "Iban": "NL91ABNA0417164300", "Bic": "ABNANL2A", "FreeText1": "", "FreeText2": "", "FreeText3": "", "FreeText4": "", "FreeText5": "", "FreeText6": "", "FreeText7": "", "FreeText8": "", "FreeText9": "", "FreeText10": "", "DoNotReceiveNewsletters": false, "LedgerId": 1001, "Mandate": true, "MandateType": "D", "MandateId": "MAND12345", "MandateSignedDate": "2023-10-01" } }, "application/*+json": { "schema": { "title": "Member", "required": [ "name" ], "properties": { "memberNumber": { "maxLength": 15, "type": "string", "description": "The code of the member. Auto-generated if empty.

Error codes

MEM_049Member number already exists.
MEM_005Member number is invalid.
MEM_006Member number is too long.
", "format": "string" }, "name": { "maxLength": 100, "type": "string", "description": "The name of the member.

Error codes

MEM_002Name is mandatory.
MEM_003Name is too long.
", "format": "string" }, "salutation": { "maxLength": 50, "type": "string", "description": "The salutation of the member.

Error codes

MEM_010Salutation is too long.
", "format": "string" }, "gender": { "maxLength": 1, "enum": [ "m", "v", "a" ], "type": "string", "description": "Male (`m`), female (`v`) or department ('a')

Error codes

MEM_004Gender is invalid (m,v,a).
", "format": "string" }, "address": { "maxLength": 150, "type": "string", "description": "The primary address of the member.

Error codes

MEM_011Address is too long.
", "format": "string" }, "postalCode": { "maxLength": 50, "type": "string", "description": "The primary postal code of the member.

Error codes

MEM_012Postal code is too long.
", "format": "string" }, "city": { "maxLength": 50, "type": "string", "description": "The primary city of the member.

Error codes

MEM_013City is too long.
", "format": "string" }, "country": { "maxLength": 50, "type": "string", "description": "The primary country of the member.

Error codes

MEM_014Country is too long.
", "format": "string" }, "phoneNumber": { "maxLength": 50, "type": "string", "description": "The phone number of the member.

Error codes

MEM_019Phone is too long.
", "format": "string" }, "mobilePhoneNumber": { "maxLength": 50, "type": "string", "description": "The mobile phone number of the member.

Error codes

MEM_020Mobile is too long.
", "format": "string" }, "faxNumber": { "maxLength": 50, "type": "string", "description": "The fax number of the member.

Error codes

MEM_021Fax is too long.
", "format": "string" }, "emailAddress": { "maxLength": 150, "type": "string", "description": "The email address of the member.

Error codes

MEM_022Email is too long.
MEM_023Email is invalid.
", "format": "string" }, "emailAddressInvoice": { "maxLength": 150, "type": "string", "description": "The invoice email address of the member.

Error codes

MEM_024Email invoice is too long.
MEM_025Email invoice is invalid.
", "format": "string" }, "emailAddressReminder": { "maxLength": 150, "type": "string", "description": "The reminder email address of the member.

Error codes

MEM_026Email reminder is too long.
MEM_027Email reminder is invalid.
", "format": "string" }, "note": { "maxLength": 40000, "type": "string", "description": "The note of the member.", "format": "string" }, "termOfPayment": { "type": [ "null", "integer" ], "description": "The payment term of the member.

Error codes

MEM_030Term of payment too low.
MEM_031Term of payment too high.
", "format": "int32" }, "iban": { "maxLength": 50, "type": "string", "description": "The IBAN number of the member.

Error codes

MEM_007Iban is invalid.
MEM_029Iban is too long.
", "format": "string" }, "bic": { "maxLength": 20, "type": "string", "description": "The BIC number of the member.

Error codes

MEM_032BIC is too long.
", "format": "string" }, "freeText1": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_037Free text 1 is too long.
", "format": "string" }, "freeText2": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_038Free text 2 is too long.
", "format": "string" }, "freeText3": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_039Free text 3 is too long.
", "format": "string" }, "freeText4": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_040Free text 4 is too long.
", "format": "string" }, "freeText5": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_041Free text 5 is too long.
", "format": "string" }, "freeText6": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_042Free text 6 is too long.
", "format": "string" }, "freeText7": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_043Free text 7 is too long.
", "format": "string" }, "freeText8": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_044Free text 8 is too long.
", "format": "string" }, "freeText9": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_045Free text 9 is too long.
", "format": "string" }, "freeText10": { "maxLength": 100, "type": "string", "description": "Free text field for the member.

Error codes

MEM_046Free text 10 is too long.
", "format": "string" }, "doNotReceiveNewsletters": { "type": [ "null", "boolean" ], "description": "Whether the member will receive newsletters or not." }, "ledgerId": { "type": [ "null", "integer" ], "description": "The ledger ID of this member.

Error codes

MEM_048Ledger not found.
MEM_057Ledger must be active and of category 'BAL' or 'VW'.
", "format": "int32" }, "mandate": { "type": "boolean", "description": "Enable or disable mandate." }, "mandateType": { "maxLength": 1, "enum": [ "E", "D" ], "type": "string", "description": "one-time (`E`) or continuous (`D`)

Error codes

MEM_033Mandate type is too long.
MEM_051Mandate type is invalid (E,D).
", "format": "string" }, "mandateId": { "maxLength": 35, "type": "string", "description": "The mandate ID of this member.

Error codes

MEM_034Mandate ID is too long.
", "format": "string" }, "mandateSignedDate": { "type": [ "null", "object" ], "description": "The signing date of the mandate for this member.", "format": "date" } } }, "example": { "Id": null, "MemberNumber": "MEM12345", "Name": "Jane Doe", "Salutation": "Ms.", "Gender": "v", "Address": "123 Main Street", "PostalCode": "12345", "City": "Sample City", "Country": "Sample Country", "PhoneNumber": "123-456-7890", "MobilePhoneNumber": "987-654-3210", "FaxNumber": "123-456-7891", "EmailAddress": "jane.doe@example.com", "EmailAddressInvoice": "invoice.jane.doe@example.com", "EmailAddressReminder": "reminder.jane.doe@example.com", "Note": "This is a sample note.", "TermOfPayment": 30, "Iban": "NL91ABNA0417164300", "Bic": "ABNANL2A", "FreeText1": "", "FreeText2": "", "FreeText3": "", "FreeText4": "", "FreeText5": "", "FreeText6": "", "FreeText7": "", "FreeText8": "", "FreeText9": "", "FreeText10": "", "DoNotReceiveNewsletters": false, "LedgerId": 1001, "Mandate": true, "MandateType": "D", "MandateId": "MAND12345", "MandateSignedDate": "2023-10-01" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "title": "MembersResponse", "properties": { "id": { "type": "integer", "description": "The ID of the relation.", "format": "int32" }, "memberNumber": { "maxLength": 15, "type": "string", "description": "The number of the member", "format": "string" } } }, "example": { "Id": 11, "MemberNumber": "MEM11", "Name": null, "Salutation": null, "Gender": null, "Address": null, "PostalCode": null, "City": null, "Country": null, "PhoneNumber": null, "MobilePhoneNumber": null, "FaxNumber": null, "EmailAddress": null, "EmailAddressInvoice": null, "EmailAddressReminder": null, "Note": null, "TermOfPayment": null, "Iban": null, "Bic": null, "FreeText1": null, "FreeText2": null, "FreeText3": null, "FreeText4": null, "FreeText5": null, "FreeText6": null, "FreeText7": null, "FreeText8": null, "FreeText9": null, "FreeText10": null, "DoNotReceiveNewsletters": null, "LedgerId": null, "Mandate": null, "MandateType": null, "MandateId": null, "MandateSignedDate": null } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/mutation": { "get": { "tags": [ "Mutation" ], "description": "Get all mutations.", "operationId": "GetMutations", "parameters": [ { "name": "limit", "in": "query", "description": "The number of items to retrieve.", "schema": { "maximum": 2000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of items to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "type", "in": "query", "description": "Only retrieves mutations of this type.", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "query", "description": "Only retrieves mutations with this number.", "schema": { "type": "integer", "format": "filter-int64" } }, { "name": "description", "in": "query", "description": "Only retrieves mutations with this description.", "schema": { "type": "string", "format": "filter-string" } }, { "name": "invoiceNumber", "in": "query", "description": "Only retrieves mutations with this invoice number.", "schema": { "type": "string", "format": "filter-string" } }, { "name": "date", "in": "query", "description": "Only retrieves mutations with this date.", "schema": { "type": "string", "format": "filter-date" }, "example": "2024-01-01" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDtoOfMutationsResponseDto" }, "example": { "Items": [ { "Id": 12, "Type": 2, "Date": "2026-10-23", "InvoiceNumber": "F00001", "LedgerId": 40444521, "Amount": 12.0, "EntryNumber": "ENTR001" } ], "Count": 1 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] }, "post": { "tags": [ "Mutation" ], "description": "Create a new mutation.", "operationId": "CreateMutation", "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "CreateMutation", "required": [ "type", "date", "ledgerId" ], "properties": { "type": { "$ref": "#/components/schemas/MutationType" }, "date": { "type": "string", "description": "The date of the mutation.

Error codes

MUT_003Date is missing.
", "format": "date", "example": "2025-01-01" }, "ledgerId": { "type": "integer", "description": "The ledger ID of the mutation.

Error codes

MUTA_001Ledger id is missing.
MUT_007Unknown ledger for mutation.
", "format": "int32" }, "invoiceNumber": { "maxLength": 50, "type": "string", "description": "The invoice number of the mutation.

Error codes

MUT_018Invoice number is too long.
MUT_019Invoice number already exists.
MUT_002Invoice number is missing.
", "format": "string" }, "entryNumber": { "maxLength": 50, "type": "string", "description": "The entry of the mutation.", "format": "string" }, "termOfPayment": { "type": "integer", "description": "The term of payment from `date`, in days.

Error codes

MUT_016Term of payment is prohibited.
", "format": "int32" }, "checkPaymentReference": { "type": "boolean", "description": "If true, the provided `paymentReference` will be validated for uniqueness." }, "paymentReference": { "type": "string", "description": "The payment reference of the mutation.", "format": "string" }, "inExVat": { "type": "string", "description": "Indicates if the amount on mutation rows is including (`IN`) or excluding (`EX`) VAT. The corresponding value will be calculated based on the VAT code.

Error codes

MUT_017In/Ex VAT must be 'IN' or 'EX'.
MUTA_005In/Ex VAT is missing.
", "format": "string" }, "description": { "maxLength": 50, "type": "string", "description": "The description of the mutation.", "format": "string" }, "relationId": { "type": "integer", "description": "The relation id of the mutation.

Error codes

MUT_012Relation is missing.
MUT_013Relation not found.
", "format": "int32" }, "rows": { "maxItems": 500, "type": "array", "items": { "title": "CreateMutationRow", "required": [ "vatCode", "amount" ], "properties": { "ledgerId": { "type": "integer", "description": "The ledger ID of the row. Required in combination with `type`: 1, 2, 5, 6, 7.
For `type` 1, 2, 5, 6 ledger cannot be in the category: `FIN`, `CRED`, `DEB`.
For `type` 7 ledger can be any.

Error codes

MUTA_004Ledger ID for row is missing.
MUT_007Unknown ledger for mutation.
MUT_104Unknown ledger for row.
MUT_106Invalid ledger category for row.
", "format": "int32", "example": "2" }, "vatCode": { "$ref": "#/components/schemas/VatCode" }, "vatAmount": { "type": "number", "description": "The VAT amount of the row. Only use in combination with vatCode: 'AFW_VERK' or 'AFW'. Only applicable for NL.", "example": "20" }, "costCenterId": { "type": "integer", "description": "The cost center id of the row.", "format": "int32" }, "amount": { "type": "number", "description": "The amount of the row. This value includes or excludes VAT depending on the `inExVat` value of the mutation." }, "description": { "type": "string", "description": "The description of the row.", "format": "string" }, "invoiceNumber": { "type": "string", "description": "The invoice number of the row. Required for type 'Invoice payment received' and 'Invoice payment sent'.

Error codes

MUT_115Invoice not found.
MUT_120Invoice number is missing.
", "format": "string" }, "relationId": { "type": "integer", "description": "The relation id of the row.

Error codes

MUT_112Relation is missing.
MUT_113Relation not found.
", "format": "int32" } } }, "description": "The rows of the mutation.

Error codes

MUT_100Rows are missing.
MUT_101Too many rows.
" } } }, "example": { "Id": null, "Type": 2, "Date": "2026-10-23", "LedgerId": 10111230, "InvoiceNumber": "INV-001", "EntryNumber": "VOU-001", "TermOfPayment": 14, "CheckPaymentReference": null, "PaymentReference": null, "InExVat": "IN", "Description": "Example description", "RelationId": 1, "Rows": [ { "LedgerId": 2, "VatCode": "LAAG_VERK_9", "VatAmount": null, "CostCenterId": 12, "Amount": 12.2, "Description": "Description 1", "InvoiceNumber": null, "RelationId": null }, { "LedgerId": 3, "VatCode": "LAAG_VERK_9", "VatAmount": null, "CostCenterId": 12, "Amount": 14.4, "Description": "Description 2", "InvoiceNumber": null, "RelationId": null } ] } }, "application/json": { "schema": { "title": "CreateMutation", "required": [ "type", "date", "ledgerId" ], "properties": { "type": { "$ref": "#/components/schemas/MutationType" }, "date": { "type": "string", "description": "The date of the mutation.

Error codes

MUT_003Date is missing.
", "format": "date", "example": "2025-01-01" }, "ledgerId": { "type": "integer", "description": "The ledger ID of the mutation.

Error codes

MUTA_001Ledger id is missing.
MUT_007Unknown ledger for mutation.
", "format": "int32" }, "invoiceNumber": { "maxLength": 50, "type": "string", "description": "The invoice number of the mutation.

Error codes

MUT_018Invoice number is too long.
MUT_019Invoice number already exists.
MUT_002Invoice number is missing.
", "format": "string" }, "entryNumber": { "maxLength": 50, "type": "string", "description": "The entry of the mutation.", "format": "string" }, "termOfPayment": { "type": "integer", "description": "The term of payment from `date`, in days.

Error codes

MUT_016Term of payment is prohibited.
", "format": "int32" }, "checkPaymentReference": { "type": "boolean", "description": "If true, the provided `paymentReference` will be validated for uniqueness." }, "paymentReference": { "type": "string", "description": "The payment reference of the mutation.", "format": "string" }, "inExVat": { "type": "string", "description": "Indicates if the amount on mutation rows is including (`IN`) or excluding (`EX`) VAT. The corresponding value will be calculated based on the VAT code.

Error codes

MUT_017In/Ex VAT must be 'IN' or 'EX'.
MUTA_005In/Ex VAT is missing.
", "format": "string" }, "description": { "maxLength": 50, "type": "string", "description": "The description of the mutation.", "format": "string" }, "relationId": { "type": "integer", "description": "The relation id of the mutation.

Error codes

MUT_012Relation is missing.
MUT_013Relation not found.
", "format": "int32" }, "rows": { "maxItems": 500, "type": "array", "items": { "title": "CreateMutationRow", "required": [ "vatCode", "amount" ], "properties": { "ledgerId": { "type": "integer", "description": "The ledger ID of the row. Required in combination with `type`: 1, 2, 5, 6, 7.
For `type` 1, 2, 5, 6 ledger cannot be in the category: `FIN`, `CRED`, `DEB`.
For `type` 7 ledger can be any.

Error codes

MUTA_004Ledger ID for row is missing.
MUT_007Unknown ledger for mutation.
MUT_104Unknown ledger for row.
MUT_106Invalid ledger category for row.
", "format": "int32", "example": "2" }, "vatCode": { "$ref": "#/components/schemas/VatCode" }, "vatAmount": { "type": "number", "description": "The VAT amount of the row. Only use in combination with vatCode: 'AFW_VERK' or 'AFW'. Only applicable for NL.", "example": "20" }, "costCenterId": { "type": "integer", "description": "The cost center id of the row.", "format": "int32" }, "amount": { "type": "number", "description": "The amount of the row. This value includes or excludes VAT depending on the `inExVat` value of the mutation." }, "description": { "type": "string", "description": "The description of the row.", "format": "string" }, "invoiceNumber": { "type": "string", "description": "The invoice number of the row. Required for type 'Invoice payment received' and 'Invoice payment sent'.

Error codes

MUT_115Invoice not found.
MUT_120Invoice number is missing.
", "format": "string" }, "relationId": { "type": "integer", "description": "The relation id of the row.

Error codes

MUT_112Relation is missing.
MUT_113Relation not found.
", "format": "int32" } } }, "description": "The rows of the mutation.

Error codes

MUT_100Rows are missing.
MUT_101Too many rows.
" } } }, "example": { "Id": null, "Type": 2, "Date": "2026-10-23", "LedgerId": 10111230, "InvoiceNumber": "INV-001", "EntryNumber": "VOU-001", "TermOfPayment": 14, "CheckPaymentReference": null, "PaymentReference": null, "InExVat": "IN", "Description": "Example description", "RelationId": 1, "Rows": [ { "LedgerId": 2, "VatCode": "LAAG_VERK_9", "VatAmount": null, "CostCenterId": 12, "Amount": 12.2, "Description": "Description 1", "InvoiceNumber": null, "RelationId": null }, { "LedgerId": 3, "VatCode": "LAAG_VERK_9", "VatAmount": null, "CostCenterId": 12, "Amount": 14.4, "Description": "Description 2", "InvoiceNumber": null, "RelationId": null } ] } }, "application/*+json": { "schema": { "title": "CreateMutation", "required": [ "type", "date", "ledgerId" ], "properties": { "type": { "$ref": "#/components/schemas/MutationType" }, "date": { "type": "string", "description": "The date of the mutation.

Error codes

MUT_003Date is missing.
", "format": "date", "example": "2025-01-01" }, "ledgerId": { "type": "integer", "description": "The ledger ID of the mutation.

Error codes

MUTA_001Ledger id is missing.
MUT_007Unknown ledger for mutation.
", "format": "int32" }, "invoiceNumber": { "maxLength": 50, "type": "string", "description": "The invoice number of the mutation.

Error codes

MUT_018Invoice number is too long.
MUT_019Invoice number already exists.
MUT_002Invoice number is missing.
", "format": "string" }, "entryNumber": { "maxLength": 50, "type": "string", "description": "The entry of the mutation.", "format": "string" }, "termOfPayment": { "type": "integer", "description": "The term of payment from `date`, in days.

Error codes

MUT_016Term of payment is prohibited.
", "format": "int32" }, "checkPaymentReference": { "type": "boolean", "description": "If true, the provided `paymentReference` will be validated for uniqueness." }, "paymentReference": { "type": "string", "description": "The payment reference of the mutation.", "format": "string" }, "inExVat": { "type": "string", "description": "Indicates if the amount on mutation rows is including (`IN`) or excluding (`EX`) VAT. The corresponding value will be calculated based on the VAT code.

Error codes

MUT_017In/Ex VAT must be 'IN' or 'EX'.
MUTA_005In/Ex VAT is missing.
", "format": "string" }, "description": { "maxLength": 50, "type": "string", "description": "The description of the mutation.", "format": "string" }, "relationId": { "type": "integer", "description": "The relation id of the mutation.

Error codes

MUT_012Relation is missing.
MUT_013Relation not found.
", "format": "int32" }, "rows": { "maxItems": 500, "type": "array", "items": { "title": "CreateMutationRow", "required": [ "vatCode", "amount" ], "properties": { "ledgerId": { "type": "integer", "description": "The ledger ID of the row. Required in combination with `type`: 1, 2, 5, 6, 7.
For `type` 1, 2, 5, 6 ledger cannot be in the category: `FIN`, `CRED`, `DEB`.
For `type` 7 ledger can be any.

Error codes

MUTA_004Ledger ID for row is missing.
MUT_007Unknown ledger for mutation.
MUT_104Unknown ledger for row.
MUT_106Invalid ledger category for row.
", "format": "int32", "example": "2" }, "vatCode": { "$ref": "#/components/schemas/VatCode" }, "vatAmount": { "type": "number", "description": "The VAT amount of the row. Only use in combination with vatCode: 'AFW_VERK' or 'AFW'. Only applicable for NL.", "example": "20" }, "costCenterId": { "type": "integer", "description": "The cost center id of the row.", "format": "int32" }, "amount": { "type": "number", "description": "The amount of the row. This value includes or excludes VAT depending on the `inExVat` value of the mutation." }, "description": { "type": "string", "description": "The description of the row.", "format": "string" }, "invoiceNumber": { "type": "string", "description": "The invoice number of the row. Required for type 'Invoice payment received' and 'Invoice payment sent'.

Error codes

MUT_115Invoice not found.
MUT_120Invoice number is missing.
", "format": "string" }, "relationId": { "type": "integer", "description": "The relation id of the row.

Error codes

MUT_112Relation is missing.
MUT_113Relation not found.
", "format": "int32" } } }, "description": "The rows of the mutation.

Error codes

MUT_100Rows are missing.
MUT_101Too many rows.
" } } }, "example": { "Id": null, "Type": 2, "Date": "2026-10-23", "LedgerId": 10111230, "InvoiceNumber": "INV-001", "EntryNumber": "VOU-001", "TermOfPayment": 14, "CheckPaymentReference": null, "PaymentReference": null, "InExVat": "IN", "Description": "Example description", "RelationId": 1, "Rows": [ { "LedgerId": 2, "VatCode": "LAAG_VERK_9", "VatAmount": null, "CostCenterId": 12, "Amount": 12.2, "Description": "Description 1", "InvoiceNumber": null, "RelationId": null }, { "LedgerId": 3, "VatCode": "LAAG_VERK_9", "VatAmount": null, "CostCenterId": 12, "Amount": 14.4, "Description": "Description 2", "InvoiceNumber": null, "RelationId": null } ] } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "title": "CreatedMutation", "properties": { "id": { "type": "integer", "description": "The ID (number) of the mutation.", "format": "int64" } } }, "example": { "Id": 12, "Type": null, "Date": null, "Description": null, "TermOfPayment": null, "LedgerId": null, "RelationId": null, "InExVat": null, "InvoiceNumber": null, "EntryNumber": null, "Rows": null, "Vat": null } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/mutation/{id}": { "get": { "tags": [ "Mutation" ], "description": "Get a mutation by id.", "operationId": "GetMutation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "Mutation", "properties": { "id": { "type": "integer", "description": "The ID (number) of the mutation.", "format": "int64" }, "type": { "$ref": "#/components/schemas/MutationType" }, "date": { "type": "string", "format": "date" }, "description": { "type": "string", "format": "string" }, "termOfPayment": { "type": "integer", "format": "int32" }, "ledgerId": { "type": "integer", "format": "int32" }, "relationId": { "type": "integer", "format": "int32" }, "inExVat": { "type": "string", "format": "string" }, "invoiceNumber": { "type": "string", "format": "string" }, "entryNumber": { "type": "string", "format": "string" }, "rows": { "type": "array", "items": { "title": "MutationRow", "properties": { "ledgerId": { "type": "integer", "description": "The ledger ID of the row. Required in combination with `type`: 1, 2, 5, 6, 7.
For `type` 1, 2, 5, 6 ledger cannot be in the category: `FIN`, `CRED`, `DEB`.
For `type` 7 ledger can be any.

Error codes

MUTA_004Ledger ID for row is missing.
MUT_007Unknown ledger for mutation.
MUT_104Unknown ledger for row.
MUT_106Invalid ledger category for row.
", "format": "int32", "example": "2" }, "vatCode": { "maxLength": 50, "type": "string", "description": "The VAT code of the row.

Error codes

MUT_109Invalid VAT code.
", "format": "string" }, "vatAmount": { "type": "number", "description": "The VAT amount of the row. Will only be returned when VAT is calculated per row for the given mutation.", "example": "20" }, "costCenterId": { "type": "integer", "description": "The cost center id of the row.", "format": "int32" }, "amount": { "type": "number", "description": "The amount of the row. This value includes or excludes VAT depending on the `inExVat` value of the mutation." }, "description": { "type": "string", "description": "The description of the row.", "format": "string" }, "invoiceNumber": { "type": "string", "description": "The invoice number of the row. Required for type 'Invoice payment received' and 'Invoice payment sent'.

Error codes

MUT_115Invoice not found.
MUT_120Invoice number is missing.
", "format": "string" }, "relationId": { "type": "integer", "description": "The relation id of the row.

Error codes

MUT_112Relation is missing.
MUT_113Relation not found.
", "format": "int32" } } } }, "vat": { "type": "array", "items": { "title": "VatAmount", "properties": { "vatCode": { "$ref": "#/components/schemas/VatCode" }, "amount": { "type": "number", "description": "The total amount of VAT for this code" } } }, "description": "VAT totals for this mutation per VAT code" } } }, "example": { "Id": 12, "Type": 2, "Date": "2026-10-23", "Description": "Description", "TermOfPayment": 12, "LedgerId": 40444521, "RelationId": 111, "InExVat": "EX", "InvoiceNumber": "F00001", "EntryNumber": "ENTR001", "Rows": [ { "LedgerId": 2001, "VatCode": "NL21", "VatAmount": 2.10, "CostCenterId": 10, "Amount": 10.00, "Description": "Row 1 description", "InvoiceNumber": "F00001", "RelationId": 111 } ], "Vat": [ { "VatCode": "NL21", "Amount": 2.10 } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/mutation/invoice/outstanding": { "get": { "tags": [ "Mutation" ], "description": "Get all outstanding invoices.", "operationId": "GetOutstandingInvoices", "parameters": [ { "name": "limit", "in": "query", "description": "The number of items to retrieve.", "schema": { "maximum": 2000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of items to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "credDeb", "in": "query", "description": "Retrieve creditors (`C`) or debtors (`D`).", "required": true, "schema": { "maxLength": 1, "type": "string", "format": "string" } }, { "name": "invoiceNumber", "in": "query", "description": "Only retrieve invoices with this number.", "schema": { "type": "string", "format": "filter-string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDtoOfOutstandingInvoiceDto" }, "example": { "Items": [ { "Date": "0001-01-01", "MutationId": 1, "InvoiceNumber": null, "RelationId": 101, "RelationCode": null, "Company": "SkillSource", "TotalAmount": 100.0, "PaidAmount": 0.0, "OutstandingAmount": 0.0 } ], "Count": 1 } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/product": { "get": { "tags": [ "Product" ], "description": "Get all products.", "operationId": "GetProducts", "parameters": [ { "name": "limit", "in": "query", "description": "The number of items to retrieve.", "schema": { "maximum": 2000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of items to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "code", "in": "query", "description": "The code of the product.", "schema": { "type": "string", "format": "filter-string" } }, { "name": "groupCode", "in": "query", "description": "The product group code.", "schema": { "type": "string", "format": "filter-string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDtoOfProductsResponseDto" }, "example": { "Items": [ { "Id": 1, "Code": "Fiets001", "Description": "Fiets001", "UnitId": 25, "Active": true, "GroupId": null, "PurchasePriceExcl": null, "PriceExcl": null, "PriceIncl": null, "Vat": null, "LedgerId": null, "CostCenterId": null, "InStockManagement": null, "UpdateSubscriptions": null } ], "Count": 1 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] }, "post": { "tags": [ "Product" ], "description": "Create a new product.", "operationId": "CreateProduct", "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "CreateProduct", "required": [ "code", "description", "vat", "ledgerId" ], "properties": { "code": { "maxLength": 20, "type": "string", "description": "The code of the product.

Error codes

ART_004Product Code is missing.
ART_007Product Code is too long.
", "format": "string" }, "description": { "maxLength": 35000, "type": "string", "description": "The description of the product.

Error codes

ART_005Product Description is missing.
", "format": "string" }, "unitId": { "type": "integer", "description": "The unit ID of the product.

Error codes

ART_011Product Unit could not be found.
", "format": "int32" }, "active": { "type": "boolean", "description": "Whether the product is active.", "default": "true" }, "groupId": { "type": "integer", "description": "The group ID of the product.

Error codes

ART_012Product Group could not be found.
", "format": "int32" }, "purchasePriceExcl": { "type": "number", "description": "The purchase price (excluding VAT) of the product.

Error codes

ART_027The value of PurchasePriceExcl exceeds the maximum value of 999999999999.00.
ART_032The value of PurchasePriceExcl is below the minimum value of -999999999999.00.
" }, "priceExcl": { "type": "number", "description": "The price (excluding VAT) of the product. This field can not be combined with `priceIncl`.

Error codes

ART_018Either priceExcl or priceIncl is required.
ART_019Both priceExcl and priceIncl are required with current VAT code.
ART_024The value of PriceExcl exceeds the maximum value of 999999999999.00.
ART_026The value of PriceIncl after applying VAT exceeds the maximum value of 999999999999.00.
ART_029The value of PriceExcl is below the minimum value of -999999999999.00.
ART_031The value of PriceIncl after applying VAT is below the minimum value of -999999999999.00.
" }, "priceIncl": { "type": "number", "description": "The price (including VAT) of the product. This field can not be combined with `priceExcl`.

Error codes

ART_016priceIncl cannot have a value when priceExcl is passed.
ART_018Either priceExcl or priceIncl is required.
ART_019Both priceExcl and priceIncl are required with current VAT code.
ART_025The value of PriceIncl exceeds the maximum value of 999999999999.00.
ART_030The value of PriceIncl is below the minimum value of -999999999999.00.
" }, "vat": { "type": "string", "description": "The VAT code of the product. Only supports VAT codes of type 'Sale'.

Error codes

ART_013Product VAT code could not be found.
ART_017Product VAT code is required.
", "format": "string" }, "ledgerId": { "type": "integer", "description": "The ledger ID of the product.

Error codes

ART_006Product Ledger ID is missing.
ART_009Product Ledger could not be found.
ART_028Ledger category must be 'BAL' or 'VW'.
", "format": "int32" }, "costCenterId": { "type": "integer", "description": "The cost center ID of the product.

Error codes

ART_010Product Cost center is inactive.
ART_015Product cost center could not be found.
", "format": "int32" }, "inStockManagement": { "type": "boolean", "description": "Whether the product will be Included in automatic inventory management." } }, "description": "Good or service." }, "example": { "Id": null, "Code": "Fiets001", "Description": "Fiets", "UnitId": 1, "Active": true, "GroupId": 1, "PurchasePriceExcl": 100.0, "PriceExcl": 150.0, "PriceIncl": 150.0, "Vat": "HOOG_VERK_21", "LedgerId": 1, "CostCenterId": 1, "InStockManagement": false, "UpdateSubscriptions": null } }, "application/json": { "schema": { "title": "CreateProduct", "required": [ "code", "description", "vat", "ledgerId" ], "properties": { "code": { "maxLength": 20, "type": "string", "description": "The code of the product.

Error codes

ART_004Product Code is missing.
ART_007Product Code is too long.
", "format": "string" }, "description": { "maxLength": 35000, "type": "string", "description": "The description of the product.

Error codes

ART_005Product Description is missing.
", "format": "string" }, "unitId": { "type": "integer", "description": "The unit ID of the product.

Error codes

ART_011Product Unit could not be found.
", "format": "int32" }, "active": { "type": "boolean", "description": "Whether the product is active.", "default": "true" }, "groupId": { "type": "integer", "description": "The group ID of the product.

Error codes

ART_012Product Group could not be found.
", "format": "int32" }, "purchasePriceExcl": { "type": "number", "description": "The purchase price (excluding VAT) of the product.

Error codes

ART_027The value of PurchasePriceExcl exceeds the maximum value of 999999999999.00.
ART_032The value of PurchasePriceExcl is below the minimum value of -999999999999.00.
" }, "priceExcl": { "type": "number", "description": "The price (excluding VAT) of the product. This field can not be combined with `priceIncl`.

Error codes

ART_018Either priceExcl or priceIncl is required.
ART_019Both priceExcl and priceIncl are required with current VAT code.
ART_024The value of PriceExcl exceeds the maximum value of 999999999999.00.
ART_026The value of PriceIncl after applying VAT exceeds the maximum value of 999999999999.00.
ART_029The value of PriceExcl is below the minimum value of -999999999999.00.
ART_031The value of PriceIncl after applying VAT is below the minimum value of -999999999999.00.
" }, "priceIncl": { "type": "number", "description": "The price (including VAT) of the product. This field can not be combined with `priceExcl`.

Error codes

ART_016priceIncl cannot have a value when priceExcl is passed.
ART_018Either priceExcl or priceIncl is required.
ART_019Both priceExcl and priceIncl are required with current VAT code.
ART_025The value of PriceIncl exceeds the maximum value of 999999999999.00.
ART_030The value of PriceIncl is below the minimum value of -999999999999.00.
" }, "vat": { "type": "string", "description": "The VAT code of the product. Only supports VAT codes of type 'Sale'.

Error codes

ART_013Product VAT code could not be found.
ART_017Product VAT code is required.
", "format": "string" }, "ledgerId": { "type": "integer", "description": "The ledger ID of the product.

Error codes

ART_006Product Ledger ID is missing.
ART_009Product Ledger could not be found.
ART_028Ledger category must be 'BAL' or 'VW'.
", "format": "int32" }, "costCenterId": { "type": "integer", "description": "The cost center ID of the product.

Error codes

ART_010Product Cost center is inactive.
ART_015Product cost center could not be found.
", "format": "int32" }, "inStockManagement": { "type": "boolean", "description": "Whether the product will be Included in automatic inventory management." } }, "description": "Good or service." }, "example": { "Id": null, "Code": "Fiets001", "Description": "Fiets", "UnitId": 1, "Active": true, "GroupId": 1, "PurchasePriceExcl": 100.0, "PriceExcl": 150.0, "PriceIncl": 150.0, "Vat": "HOOG_VERK_21", "LedgerId": 1, "CostCenterId": 1, "InStockManagement": false, "UpdateSubscriptions": null } }, "application/*+json": { "schema": { "title": "CreateProduct", "required": [ "code", "description", "vat", "ledgerId" ], "properties": { "code": { "maxLength": 20, "type": "string", "description": "The code of the product.

Error codes

ART_004Product Code is missing.
ART_007Product Code is too long.
", "format": "string" }, "description": { "maxLength": 35000, "type": "string", "description": "The description of the product.

Error codes

ART_005Product Description is missing.
", "format": "string" }, "unitId": { "type": "integer", "description": "The unit ID of the product.

Error codes

ART_011Product Unit could not be found.
", "format": "int32" }, "active": { "type": "boolean", "description": "Whether the product is active.", "default": "true" }, "groupId": { "type": "integer", "description": "The group ID of the product.

Error codes

ART_012Product Group could not be found.
", "format": "int32" }, "purchasePriceExcl": { "type": "number", "description": "The purchase price (excluding VAT) of the product.

Error codes

ART_027The value of PurchasePriceExcl exceeds the maximum value of 999999999999.00.
ART_032The value of PurchasePriceExcl is below the minimum value of -999999999999.00.
" }, "priceExcl": { "type": "number", "description": "The price (excluding VAT) of the product. This field can not be combined with `priceIncl`.

Error codes

ART_018Either priceExcl or priceIncl is required.
ART_019Both priceExcl and priceIncl are required with current VAT code.
ART_024The value of PriceExcl exceeds the maximum value of 999999999999.00.
ART_026The value of PriceIncl after applying VAT exceeds the maximum value of 999999999999.00.
ART_029The value of PriceExcl is below the minimum value of -999999999999.00.
ART_031The value of PriceIncl after applying VAT is below the minimum value of -999999999999.00.
" }, "priceIncl": { "type": "number", "description": "The price (including VAT) of the product. This field can not be combined with `priceExcl`.

Error codes

ART_016priceIncl cannot have a value when priceExcl is passed.
ART_018Either priceExcl or priceIncl is required.
ART_019Both priceExcl and priceIncl are required with current VAT code.
ART_025The value of PriceIncl exceeds the maximum value of 999999999999.00.
ART_030The value of PriceIncl is below the minimum value of -999999999999.00.
" }, "vat": { "type": "string", "description": "The VAT code of the product. Only supports VAT codes of type 'Sale'.

Error codes

ART_013Product VAT code could not be found.
ART_017Product VAT code is required.
", "format": "string" }, "ledgerId": { "type": "integer", "description": "The ledger ID of the product.

Error codes

ART_006Product Ledger ID is missing.
ART_009Product Ledger could not be found.
ART_028Ledger category must be 'BAL' or 'VW'.
", "format": "int32" }, "costCenterId": { "type": "integer", "description": "The cost center ID of the product.

Error codes

ART_010Product Cost center is inactive.
ART_015Product cost center could not be found.
", "format": "int32" }, "inStockManagement": { "type": "boolean", "description": "Whether the product will be Included in automatic inventory management." } }, "description": "Good or service." }, "example": { "Id": null, "Code": "Fiets001", "Description": "Fiets", "UnitId": 1, "Active": true, "GroupId": 1, "PurchasePriceExcl": 100.0, "PriceExcl": 150.0, "PriceIncl": 150.0, "Vat": "HOOG_VERK_21", "LedgerId": 1, "CostCenterId": 1, "InStockManagement": false, "UpdateSubscriptions": null } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "title": "CreateProduct", "properties": { "id": { "type": "integer", "description": "The ID of the product.", "format": "int32" } }, "description": "Good or service." }, "example": { "Id": 123, "Code": null, "Description": null, "UnitId": null, "Active": null, "GroupId": null, "PurchasePriceExcl": null, "PriceExcl": null, "PriceIncl": null, "Vat": null, "LedgerId": null, "CostCenterId": null, "InStockManagement": null, "UpdateSubscriptions": null } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/product/groups": { "get": { "tags": [ "Product" ], "description": "Get all product groups.", "operationId": "GetProductGroup", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDtoOfProductGroupDto" }, "example": { "Items": [ { "Id": 1, "Code": "P001", "Description": "Product Group 1" } ], "Count": 1 } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/product/{id}": { "get": { "tags": [ "Product" ], "description": "Get a product.", "operationId": "GetProduct", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "Product", "properties": { "id": { "type": "integer", "description": "The ID of the product.

Error codes

ART_001Product not found.
ART_003Product could not be deleted
", "format": "int32" }, "code": { "type": "string", "description": "The code of the product.

Error codes

ART_004Product Code is missing.
ART_007Product Code is too long.
", "format": "string" }, "description": { "type": "string", "description": "The description of the product.

Error codes

ART_005Product Description is missing.
", "format": "string" }, "unitId": { "type": "integer", "description": "The unit ID of the product.

Error codes

ART_011Product Unit could not be found.
", "format": "int32" }, "active": { "type": "boolean", "description": "Whether the product is active.", "default": "true" }, "groupId": { "type": "integer", "description": "The group ID of the product.

Error codes

ART_012Product Group could not be found.
", "format": "int32" }, "purchasePriceExcl": { "type": "number", "description": "The purchase price (excluding VAT) of the product.

Error codes

ART_027The value of PurchasePriceExcl exceeds the maximum value of 999999999999.00.
ART_032The value of PurchasePriceExcl is below the minimum value of -999999999999.00.
" }, "priceExcl": { "type": "number", "description": "The price (excluding VAT) of the product. This field can not be combined with `priceIncl`." }, "priceIncl": { "type": "number", "description": "The price (including VAT) of the product. This field can not be combined with `priceExcl`." }, "vat": { "type": "string", "description": "The VAT code of the product. Only supports VAT codes of type 'Sale'.", "format": "string" }, "ledgerId": { "type": "integer", "description": "The ledger ID of the product.

Error codes

ART_006Product Ledger ID is missing.
ART_009Product Ledger could not be found.
ART_028Ledger category must be 'BAL' or 'VW'.
", "format": "int32" }, "costCenterId": { "type": "integer", "description": "The cost center ID of the product.

Error codes

ART_010Product Cost center is inactive.
ART_015Product cost center could not be found.
", "format": "int32" }, "inStockManagement": { "type": "boolean", "description": "Whether the product will be Included in automatic inventory management." } }, "description": "Good or service." }, "example": { "Id": 1, "Code": "Fiets001", "Description": "Fiets", "UnitId": 1, "Active": true, "GroupId": 1, "PurchasePriceExcl": 100.0, "PriceExcl": 150.0, "PriceIncl": 150.0, "Vat": "HOOG_VERK_21", "LedgerId": 1, "CostCenterId": 1, "InStockManagement": false, "UpdateSubscriptions": null } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] }, "patch": { "tags": [ "Product" ], "description": "Update a product.", "operationId": "UpdateProduct", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "PatchProduct", "properties": { "code": { "type": "string", "description": "The code of the product.

Error codes

ART_004Product Code is missing.
ART_007Product Code is too long.
", "format": "string" }, "description": { "type": "string", "description": "The description of the product.

Error codes

ART_005Product Description is missing.
", "format": "string" }, "unitId": { "type": "integer", "description": "The unit ID of the product.

Error codes

ART_011Product Unit could not be found.
", "format": "int32" }, "active": { "type": "boolean", "description": "Whether the product is active.", "default": "true" }, "groupId": { "type": "integer", "description": "The group ID of the product.

Error codes

ART_012Product Group could not be found.
", "format": "int32" }, "purchasePriceExcl": { "type": "number", "description": "The purchase price (excluding VAT) of the product.

Error codes

ART_027The value of PurchasePriceExcl exceeds the maximum value of 999999999999.00.
ART_032The value of PurchasePriceExcl is below the minimum value of -999999999999.00.
" }, "priceExcl": { "type": "number", "description": "The price (excluding VAT) of the product. This field can not be combined with `priceIncl`.

Error codes

ART_021priceExcl cannot be null or empty.
ART_024The value of PriceExcl exceeds the maximum value of 999999999999.00.
ART_026The value of PriceIncl after applying VAT exceeds the maximum value of 999999999999.00.
ART_029The value of PriceExcl is below the minimum value of -999999999999.00.
ART_031The value of PriceIncl after applying VAT is below the minimum value of -999999999999.00.
" }, "priceIncl": { "type": "number", "description": "The price (including VAT) of the product. This field can not be combined with `priceExcl`.

Error codes

ART_016priceIncl cannot have a value when priceExcl is passed.
ART_020priceIncl cannot be null or empty.
ART_025The value of PriceIncl exceeds the maximum value of 999999999999.00.
ART_030The value of PriceIncl is below the minimum value of -999999999999.00.
" }, "vat": { "type": "string", "description": "The VAT code of the product. Only supports VAT codes of type 'Sale'.

Error codes

ART_013Product VAT code could not be found.
ART_022VAT code cannot be null or empty.
", "format": "string" }, "ledgerId": { "type": "integer", "description": "The ledger ID of the product.

Error codes

ART_006Product Ledger ID is missing.
ART_009Product Ledger could not be found.
ART_028Ledger category must be 'BAL' or 'VW'.
", "format": "int32" }, "costCenterId": { "type": "integer", "description": "The cost center ID of the product.

Error codes

ART_010Product Cost center is inactive.
ART_015Product cost center could not be found.
", "format": "int32" }, "inStockManagement": { "type": "boolean", "description": "Whether the product will be Included in automatic inventory management." }, "updateSubscriptions": { "$ref": "#/components/schemas/UpdateSubscriptions" } }, "description": "Good or service." }, "example": { "Id": null, "Code": "Fiets001", "Description": "Fiets", "UnitId": 1, "Active": true, "GroupId": 1, "PurchasePriceExcl": 100.0, "PriceExcl": 150.0, "PriceIncl": 150.0, "Vat": "HOOG_VERK_21", "LedgerId": 1, "CostCenterId": 1, "InStockManagement": false, "UpdateSubscriptions": 1 } }, "application/json": { "schema": { "title": "PatchProduct", "properties": { "code": { "type": "string", "description": "The code of the product.

Error codes

ART_004Product Code is missing.
ART_007Product Code is too long.
", "format": "string" }, "description": { "type": "string", "description": "The description of the product.

Error codes

ART_005Product Description is missing.
", "format": "string" }, "unitId": { "type": "integer", "description": "The unit ID of the product.

Error codes

ART_011Product Unit could not be found.
", "format": "int32" }, "active": { "type": "boolean", "description": "Whether the product is active.", "default": "true" }, "groupId": { "type": "integer", "description": "The group ID of the product.

Error codes

ART_012Product Group could not be found.
", "format": "int32" }, "purchasePriceExcl": { "type": "number", "description": "The purchase price (excluding VAT) of the product.

Error codes

ART_027The value of PurchasePriceExcl exceeds the maximum value of 999999999999.00.
ART_032The value of PurchasePriceExcl is below the minimum value of -999999999999.00.
" }, "priceExcl": { "type": "number", "description": "The price (excluding VAT) of the product. This field can not be combined with `priceIncl`.

Error codes

ART_021priceExcl cannot be null or empty.
ART_024The value of PriceExcl exceeds the maximum value of 999999999999.00.
ART_026The value of PriceIncl after applying VAT exceeds the maximum value of 999999999999.00.
ART_029The value of PriceExcl is below the minimum value of -999999999999.00.
ART_031The value of PriceIncl after applying VAT is below the minimum value of -999999999999.00.
" }, "priceIncl": { "type": "number", "description": "The price (including VAT) of the product. This field can not be combined with `priceExcl`.

Error codes

ART_016priceIncl cannot have a value when priceExcl is passed.
ART_020priceIncl cannot be null or empty.
ART_025The value of PriceIncl exceeds the maximum value of 999999999999.00.
ART_030The value of PriceIncl is below the minimum value of -999999999999.00.
" }, "vat": { "type": "string", "description": "The VAT code of the product. Only supports VAT codes of type 'Sale'.

Error codes

ART_013Product VAT code could not be found.
ART_022VAT code cannot be null or empty.
", "format": "string" }, "ledgerId": { "type": "integer", "description": "The ledger ID of the product.

Error codes

ART_006Product Ledger ID is missing.
ART_009Product Ledger could not be found.
ART_028Ledger category must be 'BAL' or 'VW'.
", "format": "int32" }, "costCenterId": { "type": "integer", "description": "The cost center ID of the product.

Error codes

ART_010Product Cost center is inactive.
ART_015Product cost center could not be found.
", "format": "int32" }, "inStockManagement": { "type": "boolean", "description": "Whether the product will be Included in automatic inventory management." }, "updateSubscriptions": { "$ref": "#/components/schemas/UpdateSubscriptions" } }, "description": "Good or service." }, "example": { "Id": null, "Code": "Fiets001", "Description": "Fiets", "UnitId": 1, "Active": true, "GroupId": 1, "PurchasePriceExcl": 100.0, "PriceExcl": 150.0, "PriceIncl": 150.0, "Vat": "HOOG_VERK_21", "LedgerId": 1, "CostCenterId": 1, "InStockManagement": false, "UpdateSubscriptions": 1 } }, "application/*+json": { "schema": { "title": "PatchProduct", "properties": { "code": { "type": "string", "description": "The code of the product.

Error codes

ART_004Product Code is missing.
ART_007Product Code is too long.
", "format": "string" }, "description": { "type": "string", "description": "The description of the product.

Error codes

ART_005Product Description is missing.
", "format": "string" }, "unitId": { "type": "integer", "description": "The unit ID of the product.

Error codes

ART_011Product Unit could not be found.
", "format": "int32" }, "active": { "type": "boolean", "description": "Whether the product is active.", "default": "true" }, "groupId": { "type": "integer", "description": "The group ID of the product.

Error codes

ART_012Product Group could not be found.
", "format": "int32" }, "purchasePriceExcl": { "type": "number", "description": "The purchase price (excluding VAT) of the product.

Error codes

ART_027The value of PurchasePriceExcl exceeds the maximum value of 999999999999.00.
ART_032The value of PurchasePriceExcl is below the minimum value of -999999999999.00.
" }, "priceExcl": { "type": "number", "description": "The price (excluding VAT) of the product. This field can not be combined with `priceIncl`.

Error codes

ART_021priceExcl cannot be null or empty.
ART_024The value of PriceExcl exceeds the maximum value of 999999999999.00.
ART_026The value of PriceIncl after applying VAT exceeds the maximum value of 999999999999.00.
ART_029The value of PriceExcl is below the minimum value of -999999999999.00.
ART_031The value of PriceIncl after applying VAT is below the minimum value of -999999999999.00.
" }, "priceIncl": { "type": "number", "description": "The price (including VAT) of the product. This field can not be combined with `priceExcl`.

Error codes

ART_016priceIncl cannot have a value when priceExcl is passed.
ART_020priceIncl cannot be null or empty.
ART_025The value of PriceIncl exceeds the maximum value of 999999999999.00.
ART_030The value of PriceIncl is below the minimum value of -999999999999.00.
" }, "vat": { "type": "string", "description": "The VAT code of the product. Only supports VAT codes of type 'Sale'.

Error codes

ART_013Product VAT code could not be found.
ART_022VAT code cannot be null or empty.
", "format": "string" }, "ledgerId": { "type": "integer", "description": "The ledger ID of the product.

Error codes

ART_006Product Ledger ID is missing.
ART_009Product Ledger could not be found.
ART_028Ledger category must be 'BAL' or 'VW'.
", "format": "int32" }, "costCenterId": { "type": "integer", "description": "The cost center ID of the product.

Error codes

ART_010Product Cost center is inactive.
ART_015Product cost center could not be found.
", "format": "int32" }, "inStockManagement": { "type": "boolean", "description": "Whether the product will be Included in automatic inventory management." }, "updateSubscriptions": { "$ref": "#/components/schemas/UpdateSubscriptions" } }, "description": "Good or service." }, "example": { "Id": null, "Code": "Fiets001", "Description": "Fiets", "UnitId": 1, "Active": true, "GroupId": 1, "PurchasePriceExcl": 100.0, "PriceExcl": 150.0, "PriceIncl": 150.0, "Vat": "HOOG_VERK_21", "LedgerId": 1, "CostCenterId": 1, "InStockManagement": false, "UpdateSubscriptions": 1 } } }, "required": true }, "responses": { "204": { "description": "No Content", "content": { "application/json": { } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] }, "delete": { "tags": [ "Product" ], "description": "Delete a product.", "operationId": "DeleteProduct", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "204": { "description": "No Content", "content": { "application/json": { } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/relation/{id}": { "get": { "tags": [ "Relation" ], "description": "Get a relation.", "operationId": "GetRelation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "Relation", "properties": { "id": { "type": "integer", "description": "The ID of the relation.", "format": "int32" }, "type": { "maxLength": 1, "enum": [ "B", "P" ], "type": "string", "description": "Business (`B`) or Private (`P`)", "format": "string" }, "code": { "maxLength": 15, "type": "string", "description": "The code of the relation.", "format": "string" }, "date": { "type": "string", "description": "The date the relation was created.", "format": "date" }, "name": { "maxLength": 100, "type": "string", "description": "The (company) name of the relation.", "format": "string" }, "salutation": { "maxLength": 50, "type": "string", "description": "The salutation of the relation.", "format": "string" }, "contact": { "maxLength": 50, "type": "string", "description": "The contact of the relation.", "format": "string" }, "gender": { "maxLength": 1, "enum": [ "m", "v", "a" ], "type": "string", "description": "Male (`m`) or female (`v`) or department (`a`)", "format": "string" }, "address": { "maxLength": 150, "type": "string", "description": "The primary address of the relation.", "format": "string" }, "postalCode": { "maxLength": 50, "type": "string", "description": "The primary postal code of the relation.", "format": "string" }, "city": { "maxLength": 50, "type": "string", "description": "The primary city of the relation.", "format": "string" }, "country": { "maxLength": 50, "type": "string", "description": "The primary country of the relation.", "format": "string" }, "address2": { "maxLength": 150, "type": "string", "description": "The secondary address of the relation.", "format": "string" }, "postalCode2": { "maxLength": 50, "type": "string", "description": "The secondary postal code of the relation.", "format": "string" }, "city2": { "maxLength": 50, "type": "string", "description": "The secondary city of the relation.", "format": "string" }, "country2": { "maxLength": 50, "type": "string", "description": "The secondary country of the relation.", "format": "string" }, "phoneNumber": { "maxLength": 50, "type": "string", "description": "The phone number of the relation.", "format": "string" }, "mobilePhoneNumber": { "maxLength": 50, "type": "string", "description": "The mobile phone number of the relation.", "format": "string" }, "faxNumber": { "maxLength": 50, "type": "string", "description": "The fax number of the relation.", "format": "string" }, "emailAddress": { "maxLength": 150, "type": "string", "description": "The email address of the relation.", "format": "string" }, "emailAddressInvoice": { "maxLength": 150, "type": "string", "description": "The invoice email address of the relation.", "format": "string" }, "emailAddressReminder": { "maxLength": 150, "type": "string", "description": "The reminder email address of the relation.", "format": "string" }, "website": { "maxLength": 50, "type": "string", "description": "The website of the relation.", "format": "string" }, "note": { "maxLength": 40000, "type": "string", "description": "The note of the relation.", "format": "string" }, "vatNumber": { "maxLength": 50, "type": "string", "description": "The VAT Number of the relation.", "format": "string" }, "inactive": { "type": [ "null", "boolean" ], "description": "Whether the relation is active or not." }, "termOfPayment": { "type": [ "null", "integer" ], "description": "The payment term of the relation.", "format": "int32" }, "companyRegistrationNumber": { "maxLength": 50, "type": "string", "description": "The company registration number of the relation.", "format": "string" }, "iban": { "maxLength": 50, "type": "string", "description": "The IBAN number of the relation.", "format": "string" }, "bic": { "maxLength": 20, "type": "string", "description": "The BIC number of the relation.", "format": "string" }, "freeText1": { "maxLength": 100, "type": [ "null", "string" ], "description": "Free text field for the relation.", "format": "string" }, "freeText2": { "maxLength": 100, "type": [ "null", "string" ], "description": "Free text field for the relation.", "format": "string" }, "freeText3": { "maxLength": 100, "type": [ "null", "string" ], "description": "Free text field for the relation.", "format": "string" }, "freeText4": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.", "format": "string" }, "freeText5": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.", "format": "string" }, "freeText6": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.", "format": "string" }, "freeText7": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.", "format": "string" }, "freeText8": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.", "format": "string" }, "freeText9": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.", "format": "string" }, "freeText10": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.", "format": "string" }, "isClubOrAssociationMember": { "type": "integer", "description": "Please use the dedicated member endpoints for club or association-members. Members will be removed from the relation endpoints in a future version.", "format": "int32", "deprecated": true }, "doNotReceiveNewsletters": { "type": [ "null", "integer" ], "description": "Whether the relation will receive newsletters or not.", "format": "int32" }, "ledgerId": { "type": [ "null", "integer" ], "description": "The ledger ID of this relation.", "format": "int32" }, "mandate": { "type": "boolean" }, "mandateType": { "maxLength": 1, "enum": [ "E", "D" ], "type": "string", "description": "one-time (`E`) or continuous (`D`)", "format": "string" }, "mandateId": { "maxLength": 35, "type": "string", "description": "The mandate ID of this relation.", "format": "string" }, "mandateSignedDate": { "type": [ "null", "object" ], "description": "The signing date of the mandate for this relation.", "format": "date" } } }, "example": { "Id": 1, "Type": "B", "Code": "REL123", "Date": "2026-10-23T00:00:00+02:00", "Name": "Company", "Salutation": "Mr.", "Contact": "John Doe", "Gender": "m", "Address": "Company Street 2", "PostalCode": "1000 AB", "City": "Amsterdam", "Country": "Netherlands", "Address2": "Secondary Street 5", "PostalCode2": "2000 CD", "City2": "Rotterdam", "Country2": "Netherlands", "PhoneNumber": "+31612345678", "MobilePhoneNumber": "+31687654321", "FaxNumber": "+31201234567", "EmailAddress": "contact@company.com", "EmailAddressInvoice": "invoice@company.com", "EmailAddressReminder": "reminder@company.com", "Website": "https://www.e-boekhouden.nl/", "Note": "This is a test note.", "VatNumber": "NL123456789B01", "Inactive": false, "TermOfPayment": 30, "CompanyRegistrationNumber": "12345678", "Iban": "NL91ABNA0417164300", "Bic": "ABNANL2A", "FreeText1": "", "FreeText2": "", "FreeText3": "", "FreeText4": "", "FreeText5": "", "FreeText6": "", "FreeText7": "", "FreeText8": "", "FreeText9": "", "FreeText10": "", "IsClubOrAssociationMember": 0, "DoNotReceiveNewsletters": 0, "LedgerId": 101, "Mandate": true, "MandateType": "D", "MandateId": "MAND12345", "MandateSignedDate": "2023-10-01" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] }, "patch": { "tags": [ "Relation" ], "description": "Update an existing relation.", "operationId": "UpdateRelation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "PatchRelation", "required": [ "name" ], "properties": { "type": { "maxLength": 1, "enum": [ "B", "P" ], "type": "string", "description": "Business (`B`) or Private (`P`). Defaults to `B` if empty.

Error codes

REL_001Relation type is invalid (B,P).
", "format": "string" }, "code": { "maxLength": 15, "type": "string", "description": "The code of the relation.

Error codes

REL_049Code already exists.
REL_005Code is invalid.
REL_006Code is too long.
", "format": "string" }, "name": { "maxLength": 100, "type": "string", "description": "The (company) name of the relation.

Error codes

REL_002Name is mandatory.
REL_003Name is too long.
", "format": "string" }, "salutation": { "maxLength": 50, "type": "string", "description": "The salutation of the relation.

Error codes

REL_010Salutation is too long.
", "format": "string" }, "contact": { "maxLength": 50, "type": "string", "description": "The contact of the relation.

Error codes

REL_009Contact is too long.
", "format": "string" }, "gender": { "maxLength": 1, "enum": [ "m", "v", "a" ], "type": "string", "description": "Male (`m`) or female (`v`) or department (`a`)

Error codes

REL_004Gender is invalid (m,v,a).
", "format": "string" }, "address": { "maxLength": 150, "type": "string", "description": "The primary address of the relation.

Error codes

REL_011Address is too long.
", "format": "string" }, "postalCode": { "maxLength": 50, "type": "string", "description": "The primary postal code of the relation.

Error codes

REL_012Postal code is too long.
", "format": "string" }, "city": { "maxLength": 50, "type": "string", "description": "The primary city of the relation.

Error codes

REL_013City is too long.
", "format": "string" }, "country": { "maxLength": 50, "type": "string", "description": "The primary country of the relation.

Error codes

REL_014Country is too long.
", "format": "string" }, "address2": { "maxLength": 150, "type": "string", "description": "The secondary address of the relation.

Error codes

REL_015Address 2 is too long.
", "format": "string" }, "postalCode2": { "maxLength": 50, "type": "string", "description": "The secondary postal code of the relation.

Error codes

REL_016Postal code 2 is too long.
", "format": "string" }, "city2": { "maxLength": 50, "type": "string", "description": "The secondary city of the relation.

Error codes

REL_017City 2 is too long.
", "format": "string" }, "country2": { "maxLength": 50, "type": "string", "description": "The secondary country of the relation.

Error codes

REL_018Country 2 is too long.
", "format": "string" }, "phoneNumber": { "maxLength": 50, "type": "string", "description": "The phone number of the relation.

Error codes

REL_019Phone is too long.
", "format": "string" }, "mobilePhoneNumber": { "maxLength": 50, "type": "string", "description": "The mobile phone number of the relation.

Error codes

REL_020Mobile is too long.
", "format": "string" }, "faxNumber": { "maxLength": 50, "type": "string", "description": "The fax number of the relation.

Error codes

REL_021Fax is too long.
", "format": "string" }, "emailAddress": { "maxLength": 150, "type": "string", "description": "The email address of the relation.

Error codes

REL_022Email is too long.
REL_023Email is invalid.
", "format": "string" }, "emailAddressInvoice": { "maxLength": 150, "type": "string", "description": "The invoice email address of the relation.

Error codes

REL_024Email invoice is too long.
REL_025Email invoice is invalid.
", "format": "string" }, "emailAddressReminder": { "maxLength": 150, "type": "string", "description": "The reminder email address of the relation.

Error codes

REL_026Email reminder is too long.
REL_027Email reminder is invalid.
", "format": "string" }, "website": { "maxLength": 50, "type": "string", "description": "The website of the relation.

Error codes

REL_028Website is too long.
", "format": "string" }, "note": { "maxLength": 40000, "type": "string", "description": "The note of the relation.", "format": "string" }, "vatNumber": { "maxLength": 50, "type": "string", "description": "The VAT number of the relation.

Error codes

REL_035VAT number is too long.
", "format": "string" }, "inactive": { "type": [ "null", "boolean" ], "description": "Whether the relation is inactive." }, "termOfPayment": { "type": [ "null", "integer" ], "description": "The payment term of the relation.

Error codes

REL_030Term of payment too low.
REL_031Term of payment too high.
", "format": "int32" }, "companyRegistrationNumber": { "maxLength": 50, "type": "string", "description": "The company registration number of the relation.

Error codes

REL_008Company registration number must be numeric.
REL_050Company registration number is too long.
REL_058Company registration number is invalid. A Belgian company registration number consists of 9 or 10 digits; with 10 digits it starts with 0 or 1.
", "format": "string" }, "iban": { "maxLength": 50, "type": "string", "description": "The IBAN number of the relation.

Error codes

REL_007Iban is invalid.
REL_029Iban is too long.
", "format": "string" }, "bic": { "maxLength": 20, "type": "string", "description": "The BIC number of the relation.

Error codes

REL_032BIC is too long.
", "format": "string" }, "freeText1": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_037Free text 1 is too long.
", "format": "string" }, "freeText2": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_038Free text 2 is too long.
", "format": "string" }, "freeText3": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_039Free text 3 is too long.
", "format": "string" }, "freeText4": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_040Free text 4 is too long.
", "format": "string" }, "freeText5": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_041Free text 5 is too long.
", "format": "string" }, "freeText6": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_042Free text 6 is too long.
", "format": "string" }, "freeText7": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_043Free text 7 is too long.
", "format": "string" }, "freeText8": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_044Free text 8 is too long.
", "format": "string" }, "freeText9": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_045Free text 9 is too long.
", "format": "string" }, "freeText10": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_046Free text 10 is too long.
", "format": "string" }, "doNotReceiveNewsletters": { "type": [ "null", "boolean" ], "description": "Whether the relation will receive newsletters or not." }, "ledgerId": { "type": [ "null", "integer" ], "description": "The ledger ID of this relation.

Error codes

REL_048Ledger not found.
REL_059Ledger must be active and of category 'BAL' or 'VW'.
", "format": "int32" }, "mandate": { "type": "boolean", "description": "Enable or disable mandate." }, "mandateType": { "maxLength": 1, "enum": [ "E", "D" ], "type": "string", "description": "one-time (`E`) or continuous (`D`)

Error codes

REL_033Mandate type is too long.
REL_051Mandate type is invalid (E,D).
", "format": "string" }, "mandateId": { "maxLength": 35, "type": "string", "description": "The mandate ID of this relation.

Error codes

REL_034Mandate ID is too long.
", "format": "string" }, "mandateSignedDate": { "type": [ "null", "object" ], "description": "The signing date of the mandate for this relation.", "format": "date" } } }, "example": { "Id": null, "Type": "B", "Code": "REL123", "Name": "Company", "Salutation": "Mr.", "Contact": "John Doe", "Gender": "m", "Address": "Company Street 2", "PostalCode": "1000 AB", "City": "Amsterdam", "Country": "Netherlands", "Address2": "Secondary Street 5", "PostalCode2": "2000 CD", "City2": "Rotterdam", "Country2": "Netherlands", "PhoneNumber": "+31612345678", "MobilePhoneNumber": "+31687654321", "FaxNumber": "+31201234567", "EmailAddress": "contact@company.com", "EmailAddressInvoice": "invoice@company.com", "EmailAddressReminder": "reminder@company.com", "Website": "https://www.e-boekhouden.nl/", "Note": "This is a test note.", "VatNumber": "NL123456789B01", "Inactive": false, "TermOfPayment": 30, "CompanyRegistrationNumber": "12345678", "Iban": "NL91ABNA0417164300", "Bic": "ABNANL2A", "FreeText1": "", "FreeText2": "", "FreeText3": "", "FreeText4": "", "FreeText5": "", "FreeText6": "", "FreeText7": "", "FreeText8": "", "FreeText9": "", "FreeText10": "", "DoNotReceiveNewsletters": true, "LedgerId": 101, "Mandate": true, "MandateType": "D", "MandateId": "MAND12345", "MandateSignedDate": "2023-10-01" } }, "application/json": { "schema": { "title": "PatchRelation", "required": [ "name" ], "properties": { "type": { "maxLength": 1, "enum": [ "B", "P" ], "type": "string", "description": "Business (`B`) or Private (`P`). Defaults to `B` if empty.

Error codes

REL_001Relation type is invalid (B,P).
", "format": "string" }, "code": { "maxLength": 15, "type": "string", "description": "The code of the relation.

Error codes

REL_049Code already exists.
REL_005Code is invalid.
REL_006Code is too long.
", "format": "string" }, "name": { "maxLength": 100, "type": "string", "description": "The (company) name of the relation.

Error codes

REL_002Name is mandatory.
REL_003Name is too long.
", "format": "string" }, "salutation": { "maxLength": 50, "type": "string", "description": "The salutation of the relation.

Error codes

REL_010Salutation is too long.
", "format": "string" }, "contact": { "maxLength": 50, "type": "string", "description": "The contact of the relation.

Error codes

REL_009Contact is too long.
", "format": "string" }, "gender": { "maxLength": 1, "enum": [ "m", "v", "a" ], "type": "string", "description": "Male (`m`) or female (`v`) or department (`a`)

Error codes

REL_004Gender is invalid (m,v,a).
", "format": "string" }, "address": { "maxLength": 150, "type": "string", "description": "The primary address of the relation.

Error codes

REL_011Address is too long.
", "format": "string" }, "postalCode": { "maxLength": 50, "type": "string", "description": "The primary postal code of the relation.

Error codes

REL_012Postal code is too long.
", "format": "string" }, "city": { "maxLength": 50, "type": "string", "description": "The primary city of the relation.

Error codes

REL_013City is too long.
", "format": "string" }, "country": { "maxLength": 50, "type": "string", "description": "The primary country of the relation.

Error codes

REL_014Country is too long.
", "format": "string" }, "address2": { "maxLength": 150, "type": "string", "description": "The secondary address of the relation.

Error codes

REL_015Address 2 is too long.
", "format": "string" }, "postalCode2": { "maxLength": 50, "type": "string", "description": "The secondary postal code of the relation.

Error codes

REL_016Postal code 2 is too long.
", "format": "string" }, "city2": { "maxLength": 50, "type": "string", "description": "The secondary city of the relation.

Error codes

REL_017City 2 is too long.
", "format": "string" }, "country2": { "maxLength": 50, "type": "string", "description": "The secondary country of the relation.

Error codes

REL_018Country 2 is too long.
", "format": "string" }, "phoneNumber": { "maxLength": 50, "type": "string", "description": "The phone number of the relation.

Error codes

REL_019Phone is too long.
", "format": "string" }, "mobilePhoneNumber": { "maxLength": 50, "type": "string", "description": "The mobile phone number of the relation.

Error codes

REL_020Mobile is too long.
", "format": "string" }, "faxNumber": { "maxLength": 50, "type": "string", "description": "The fax number of the relation.

Error codes

REL_021Fax is too long.
", "format": "string" }, "emailAddress": { "maxLength": 150, "type": "string", "description": "The email address of the relation.

Error codes

REL_022Email is too long.
REL_023Email is invalid.
", "format": "string" }, "emailAddressInvoice": { "maxLength": 150, "type": "string", "description": "The invoice email address of the relation.

Error codes

REL_024Email invoice is too long.
REL_025Email invoice is invalid.
", "format": "string" }, "emailAddressReminder": { "maxLength": 150, "type": "string", "description": "The reminder email address of the relation.

Error codes

REL_026Email reminder is too long.
REL_027Email reminder is invalid.
", "format": "string" }, "website": { "maxLength": 50, "type": "string", "description": "The website of the relation.

Error codes

REL_028Website is too long.
", "format": "string" }, "note": { "maxLength": 40000, "type": "string", "description": "The note of the relation.", "format": "string" }, "vatNumber": { "maxLength": 50, "type": "string", "description": "The VAT number of the relation.

Error codes

REL_035VAT number is too long.
", "format": "string" }, "inactive": { "type": [ "null", "boolean" ], "description": "Whether the relation is inactive." }, "termOfPayment": { "type": [ "null", "integer" ], "description": "The payment term of the relation.

Error codes

REL_030Term of payment too low.
REL_031Term of payment too high.
", "format": "int32" }, "companyRegistrationNumber": { "maxLength": 50, "type": "string", "description": "The company registration number of the relation.

Error codes

REL_008Company registration number must be numeric.
REL_050Company registration number is too long.
REL_058Company registration number is invalid. A Belgian company registration number consists of 9 or 10 digits; with 10 digits it starts with 0 or 1.
", "format": "string" }, "iban": { "maxLength": 50, "type": "string", "description": "The IBAN number of the relation.

Error codes

REL_007Iban is invalid.
REL_029Iban is too long.
", "format": "string" }, "bic": { "maxLength": 20, "type": "string", "description": "The BIC number of the relation.

Error codes

REL_032BIC is too long.
", "format": "string" }, "freeText1": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_037Free text 1 is too long.
", "format": "string" }, "freeText2": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_038Free text 2 is too long.
", "format": "string" }, "freeText3": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_039Free text 3 is too long.
", "format": "string" }, "freeText4": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_040Free text 4 is too long.
", "format": "string" }, "freeText5": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_041Free text 5 is too long.
", "format": "string" }, "freeText6": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_042Free text 6 is too long.
", "format": "string" }, "freeText7": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_043Free text 7 is too long.
", "format": "string" }, "freeText8": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_044Free text 8 is too long.
", "format": "string" }, "freeText9": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_045Free text 9 is too long.
", "format": "string" }, "freeText10": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_046Free text 10 is too long.
", "format": "string" }, "doNotReceiveNewsletters": { "type": [ "null", "boolean" ], "description": "Whether the relation will receive newsletters or not." }, "ledgerId": { "type": [ "null", "integer" ], "description": "The ledger ID of this relation.

Error codes

REL_048Ledger not found.
REL_059Ledger must be active and of category 'BAL' or 'VW'.
", "format": "int32" }, "mandate": { "type": "boolean", "description": "Enable or disable mandate." }, "mandateType": { "maxLength": 1, "enum": [ "E", "D" ], "type": "string", "description": "one-time (`E`) or continuous (`D`)

Error codes

REL_033Mandate type is too long.
REL_051Mandate type is invalid (E,D).
", "format": "string" }, "mandateId": { "maxLength": 35, "type": "string", "description": "The mandate ID of this relation.

Error codes

REL_034Mandate ID is too long.
", "format": "string" }, "mandateSignedDate": { "type": [ "null", "object" ], "description": "The signing date of the mandate for this relation.", "format": "date" } } }, "example": { "Id": null, "Type": "B", "Code": "REL123", "Name": "Company", "Salutation": "Mr.", "Contact": "John Doe", "Gender": "m", "Address": "Company Street 2", "PostalCode": "1000 AB", "City": "Amsterdam", "Country": "Netherlands", "Address2": "Secondary Street 5", "PostalCode2": "2000 CD", "City2": "Rotterdam", "Country2": "Netherlands", "PhoneNumber": "+31612345678", "MobilePhoneNumber": "+31687654321", "FaxNumber": "+31201234567", "EmailAddress": "contact@company.com", "EmailAddressInvoice": "invoice@company.com", "EmailAddressReminder": "reminder@company.com", "Website": "https://www.e-boekhouden.nl/", "Note": "This is a test note.", "VatNumber": "NL123456789B01", "Inactive": false, "TermOfPayment": 30, "CompanyRegistrationNumber": "12345678", "Iban": "NL91ABNA0417164300", "Bic": "ABNANL2A", "FreeText1": "", "FreeText2": "", "FreeText3": "", "FreeText4": "", "FreeText5": "", "FreeText6": "", "FreeText7": "", "FreeText8": "", "FreeText9": "", "FreeText10": "", "DoNotReceiveNewsletters": true, "LedgerId": 101, "Mandate": true, "MandateType": "D", "MandateId": "MAND12345", "MandateSignedDate": "2023-10-01" } }, "application/*+json": { "schema": { "title": "PatchRelation", "required": [ "name" ], "properties": { "type": { "maxLength": 1, "enum": [ "B", "P" ], "type": "string", "description": "Business (`B`) or Private (`P`). Defaults to `B` if empty.

Error codes

REL_001Relation type is invalid (B,P).
", "format": "string" }, "code": { "maxLength": 15, "type": "string", "description": "The code of the relation.

Error codes

REL_049Code already exists.
REL_005Code is invalid.
REL_006Code is too long.
", "format": "string" }, "name": { "maxLength": 100, "type": "string", "description": "The (company) name of the relation.

Error codes

REL_002Name is mandatory.
REL_003Name is too long.
", "format": "string" }, "salutation": { "maxLength": 50, "type": "string", "description": "The salutation of the relation.

Error codes

REL_010Salutation is too long.
", "format": "string" }, "contact": { "maxLength": 50, "type": "string", "description": "The contact of the relation.

Error codes

REL_009Contact is too long.
", "format": "string" }, "gender": { "maxLength": 1, "enum": [ "m", "v", "a" ], "type": "string", "description": "Male (`m`) or female (`v`) or department (`a`)

Error codes

REL_004Gender is invalid (m,v,a).
", "format": "string" }, "address": { "maxLength": 150, "type": "string", "description": "The primary address of the relation.

Error codes

REL_011Address is too long.
", "format": "string" }, "postalCode": { "maxLength": 50, "type": "string", "description": "The primary postal code of the relation.

Error codes

REL_012Postal code is too long.
", "format": "string" }, "city": { "maxLength": 50, "type": "string", "description": "The primary city of the relation.

Error codes

REL_013City is too long.
", "format": "string" }, "country": { "maxLength": 50, "type": "string", "description": "The primary country of the relation.

Error codes

REL_014Country is too long.
", "format": "string" }, "address2": { "maxLength": 150, "type": "string", "description": "The secondary address of the relation.

Error codes

REL_015Address 2 is too long.
", "format": "string" }, "postalCode2": { "maxLength": 50, "type": "string", "description": "The secondary postal code of the relation.

Error codes

REL_016Postal code 2 is too long.
", "format": "string" }, "city2": { "maxLength": 50, "type": "string", "description": "The secondary city of the relation.

Error codes

REL_017City 2 is too long.
", "format": "string" }, "country2": { "maxLength": 50, "type": "string", "description": "The secondary country of the relation.

Error codes

REL_018Country 2 is too long.
", "format": "string" }, "phoneNumber": { "maxLength": 50, "type": "string", "description": "The phone number of the relation.

Error codes

REL_019Phone is too long.
", "format": "string" }, "mobilePhoneNumber": { "maxLength": 50, "type": "string", "description": "The mobile phone number of the relation.

Error codes

REL_020Mobile is too long.
", "format": "string" }, "faxNumber": { "maxLength": 50, "type": "string", "description": "The fax number of the relation.

Error codes

REL_021Fax is too long.
", "format": "string" }, "emailAddress": { "maxLength": 150, "type": "string", "description": "The email address of the relation.

Error codes

REL_022Email is too long.
REL_023Email is invalid.
", "format": "string" }, "emailAddressInvoice": { "maxLength": 150, "type": "string", "description": "The invoice email address of the relation.

Error codes

REL_024Email invoice is too long.
REL_025Email invoice is invalid.
", "format": "string" }, "emailAddressReminder": { "maxLength": 150, "type": "string", "description": "The reminder email address of the relation.

Error codes

REL_026Email reminder is too long.
REL_027Email reminder is invalid.
", "format": "string" }, "website": { "maxLength": 50, "type": "string", "description": "The website of the relation.

Error codes

REL_028Website is too long.
", "format": "string" }, "note": { "maxLength": 40000, "type": "string", "description": "The note of the relation.", "format": "string" }, "vatNumber": { "maxLength": 50, "type": "string", "description": "The VAT number of the relation.

Error codes

REL_035VAT number is too long.
", "format": "string" }, "inactive": { "type": [ "null", "boolean" ], "description": "Whether the relation is inactive." }, "termOfPayment": { "type": [ "null", "integer" ], "description": "The payment term of the relation.

Error codes

REL_030Term of payment too low.
REL_031Term of payment too high.
", "format": "int32" }, "companyRegistrationNumber": { "maxLength": 50, "type": "string", "description": "The company registration number of the relation.

Error codes

REL_008Company registration number must be numeric.
REL_050Company registration number is too long.
REL_058Company registration number is invalid. A Belgian company registration number consists of 9 or 10 digits; with 10 digits it starts with 0 or 1.
", "format": "string" }, "iban": { "maxLength": 50, "type": "string", "description": "The IBAN number of the relation.

Error codes

REL_007Iban is invalid.
REL_029Iban is too long.
", "format": "string" }, "bic": { "maxLength": 20, "type": "string", "description": "The BIC number of the relation.

Error codes

REL_032BIC is too long.
", "format": "string" }, "freeText1": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_037Free text 1 is too long.
", "format": "string" }, "freeText2": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_038Free text 2 is too long.
", "format": "string" }, "freeText3": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_039Free text 3 is too long.
", "format": "string" }, "freeText4": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_040Free text 4 is too long.
", "format": "string" }, "freeText5": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_041Free text 5 is too long.
", "format": "string" }, "freeText6": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_042Free text 6 is too long.
", "format": "string" }, "freeText7": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_043Free text 7 is too long.
", "format": "string" }, "freeText8": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_044Free text 8 is too long.
", "format": "string" }, "freeText9": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_045Free text 9 is too long.
", "format": "string" }, "freeText10": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_046Free text 10 is too long.
", "format": "string" }, "doNotReceiveNewsletters": { "type": [ "null", "boolean" ], "description": "Whether the relation will receive newsletters or not." }, "ledgerId": { "type": [ "null", "integer" ], "description": "The ledger ID of this relation.

Error codes

REL_048Ledger not found.
REL_059Ledger must be active and of category 'BAL' or 'VW'.
", "format": "int32" }, "mandate": { "type": "boolean", "description": "Enable or disable mandate." }, "mandateType": { "maxLength": 1, "enum": [ "E", "D" ], "type": "string", "description": "one-time (`E`) or continuous (`D`)

Error codes

REL_033Mandate type is too long.
REL_051Mandate type is invalid (E,D).
", "format": "string" }, "mandateId": { "maxLength": 35, "type": "string", "description": "The mandate ID of this relation.

Error codes

REL_034Mandate ID is too long.
", "format": "string" }, "mandateSignedDate": { "type": [ "null", "object" ], "description": "The signing date of the mandate for this relation.", "format": "date" } } }, "example": { "Id": null, "Type": "B", "Code": "REL123", "Name": "Company", "Salutation": "Mr.", "Contact": "John Doe", "Gender": "m", "Address": "Company Street 2", "PostalCode": "1000 AB", "City": "Amsterdam", "Country": "Netherlands", "Address2": "Secondary Street 5", "PostalCode2": "2000 CD", "City2": "Rotterdam", "Country2": "Netherlands", "PhoneNumber": "+31612345678", "MobilePhoneNumber": "+31687654321", "FaxNumber": "+31201234567", "EmailAddress": "contact@company.com", "EmailAddressInvoice": "invoice@company.com", "EmailAddressReminder": "reminder@company.com", "Website": "https://www.e-boekhouden.nl/", "Note": "This is a test note.", "VatNumber": "NL123456789B01", "Inactive": false, "TermOfPayment": 30, "CompanyRegistrationNumber": "12345678", "Iban": "NL91ABNA0417164300", "Bic": "ABNANL2A", "FreeText1": "", "FreeText2": "", "FreeText3": "", "FreeText4": "", "FreeText5": "", "FreeText6": "", "FreeText7": "", "FreeText8": "", "FreeText9": "", "FreeText10": "", "DoNotReceiveNewsletters": true, "LedgerId": 101, "Mandate": true, "MandateType": "D", "MandateId": "MAND12345", "MandateSignedDate": "2023-10-01" } } }, "required": true }, "responses": { "204": { "description": "No Content", "content": { "application/json": { } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/relation": { "get": { "tags": [ "Relation" ], "description": "Get all relations.", "operationId": "GetRelations", "parameters": [ { "name": "limit", "in": "query", "description": "The number of items to retrieve.", "schema": { "maximum": 2000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of items to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "code", "in": "query", "description": "The code of the relation.", "schema": { "type": "string", "format": "filter-string" } }, { "name": "type", "in": "query", "description": "Business (`B`) or Private (`P`).", "schema": { "type": "string", "format": "filter-string" }, "example": "B" }, { "name": "email", "in": "query", "description": "Only retrieves relations with this e-mailadress.", "schema": { "type": "string", "format": "filter-string" } }, { "name": "name", "in": "query", "description": "Only retrieves relations with this (company) name.", "schema": { "type": "string", "format": "filter-string" } }, { "name": "contact", "in": "query", "description": "Only retrieves relations with this contact information.", "schema": { "type": "string", "format": "filter-string" } }, { "name": "city", "in": "query", "description": "Only retrieves relations from this primary city.", "schema": { "type": "string", "format": "filter-string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDtoOfRelationsResponseDto" }, "example": { "Items": [ { "Id": 1, "Type": "B", "Code": "R0001", "Name": null, "Salutation": null, "Contact": null, "Gender": null, "Address": null, "PostalCode": null, "City": null, "Country": null, "Address2": null, "PostalCode2": null, "City2": null, "Country2": null, "PhoneNumber": null, "MobilePhoneNumber": null, "FaxNumber": null, "EmailAddress": null, "EmailAddressInvoice": null, "EmailAddressReminder": null, "Website": null, "Note": null, "VatNumber": null, "Inactive": null, "TermOfPayment": null, "CompanyRegistrationNumber": null, "Iban": null, "Bic": null, "FreeText1": null, "FreeText2": null, "FreeText3": null, "FreeText4": null, "FreeText5": null, "FreeText6": null, "FreeText7": null, "FreeText8": null, "FreeText9": null, "FreeText10": null, "DoNotReceiveNewsletters": null, "LedgerId": null, "Mandate": null, "MandateType": null, "MandateId": null, "MandateSignedDate": null } ], "Count": 1 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] }, "post": { "tags": [ "Relation" ], "description": "Create a new relation.", "operationId": "CreateRelation", "requestBody": { "content": { "application/json-patch+json": { "schema": { "title": "CreateRelation", "required": [ "name" ], "properties": { "type": { "maxLength": 1, "enum": [ "B", "P" ], "type": "string", "description": "Business (`B`) or Private (`P`). Defaults to `B` if empty.

Error codes

REL_001Relation type is invalid (B,P).
", "format": "string" }, "code": { "maxLength": 15, "type": "string", "description": "The code of the relation. Auto-generated if empty.

Error codes

REL_049Code already exists.
REL_005Code is invalid.
REL_006Code is too long.
", "format": "string" }, "name": { "maxLength": 100, "type": "string", "description": "The (company) name of the relation.

Error codes

REL_002Name is mandatory.
REL_003Name is too long.
", "format": "string" }, "salutation": { "maxLength": 50, "type": "string", "description": "The salutation of the relation.

Error codes

REL_010Salutation is too long.
", "format": "string" }, "contact": { "maxLength": 50, "type": "string", "description": "The contact of the relation.

Error codes

REL_009Contact is too long.
", "format": "string" }, "gender": { "maxLength": 1, "enum": [ "m", "v", "a" ], "type": "string", "description": "Male (`m`) or female (`v`) or department (`a`)

Error codes

REL_004Gender is invalid (m,v,a).
", "format": "string" }, "address": { "maxLength": 150, "type": "string", "description": "The primary address of the relation.

Error codes

REL_011Address is too long.
", "format": "string" }, "postalCode": { "maxLength": 50, "type": "string", "description": "The primary postal code of the relation.

Error codes

REL_012Postal code is too long.
", "format": "string" }, "city": { "maxLength": 50, "type": "string", "description": "The primary city of the relation.

Error codes

REL_013City is too long.
", "format": "string" }, "country": { "maxLength": 50, "type": "string", "description": "The primary country of the relation.

Error codes

REL_014Country is too long.
", "format": "string" }, "address2": { "maxLength": 150, "type": "string", "description": "The secondary address of the relation.

Error codes

REL_015Address 2 is too long.
", "format": "string" }, "postalCode2": { "maxLength": 50, "type": "string", "description": "The secondary postal code of the relation.

Error codes

REL_016Postal code 2 is too long.
", "format": "string" }, "city2": { "maxLength": 50, "type": "string", "description": "The secondary city of the relation.

Error codes

REL_017City 2 is too long.
", "format": "string" }, "country2": { "maxLength": 50, "type": "string", "description": "The secondary country of the relation.

Error codes

REL_018Country 2 is too long.
", "format": "string" }, "phoneNumber": { "maxLength": 50, "type": "string", "description": "The phone number of the relation.

Error codes

REL_019Phone is too long.
", "format": "string" }, "mobilePhoneNumber": { "maxLength": 50, "type": "string", "description": "The mobile phone number of the relation.

Error codes

REL_020Mobile is too long.
", "format": "string" }, "faxNumber": { "maxLength": 50, "type": "string", "description": "The fax number of the relation.

Error codes

REL_021Fax is too long.
", "format": "string" }, "emailAddress": { "maxLength": 150, "type": "string", "description": "The email address of the relation.

Error codes

REL_022Email is too long.
REL_023Email is invalid.
", "format": "string" }, "emailAddressInvoice": { "maxLength": 150, "type": "string", "description": "The invoice email address of the relation.

Error codes

REL_024Email invoice is too long.
REL_025Email invoice is invalid.
", "format": "string" }, "emailAddressReminder": { "maxLength": 150, "type": "string", "description": "The reminder email address of the relation.

Error codes

REL_026Email reminder is too long.
REL_027Email reminder is invalid.
", "format": "string" }, "website": { "maxLength": 50, "type": "string", "description": "The website of the relation.

Error codes

REL_028Website is too long.
", "format": "string" }, "note": { "maxLength": 40000, "type": "string", "description": "The note of the relation.", "format": "string" }, "vatNumber": { "maxLength": 50, "type": "string", "description": "The VAT number of the relation.

Error codes

REL_035VAT number is too long.
", "format": "string" }, "inactive": { "type": [ "null", "boolean" ], "description": "Whether the relation is inactive." }, "termOfPayment": { "type": [ "null", "integer" ], "description": "The payment term of the relation.

Error codes

REL_030Term of payment too low.
REL_031Term of payment too high.
", "format": "int32" }, "companyRegistrationNumber": { "maxLength": 50, "type": "string", "description": "The company registration number of the relation.

Error codes

REL_008Company registration number must be numeric.
REL_050Company registration number is too long.
REL_058Company registration number is invalid. A Belgian company registration number consists of 9 or 10 digits; with 10 digits it starts with 0 or 1.
", "format": "string" }, "iban": { "maxLength": 50, "type": "string", "description": "The IBAN number of the relation.

Error codes

REL_007Iban is invalid.
REL_029Iban is too long.
", "format": "string" }, "bic": { "maxLength": 20, "type": "string", "description": "The BIC number of the relation.

Error codes

REL_032BIC is too long.
", "format": "string" }, "freeText1": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_037Free text 1 is too long.
", "format": "string" }, "freeText2": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_038Free text 2 is too long.
", "format": "string" }, "freeText3": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_039Free text 3 is too long.
", "format": "string" }, "freeText4": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_040Free text 4 is too long.
", "format": "string" }, "freeText5": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_041Free text 5 is too long.
", "format": "string" }, "freeText6": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_042Free text 6 is too long.
", "format": "string" }, "freeText7": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_043Free text 7 is too long.
", "format": "string" }, "freeText8": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_044Free text 8 is too long.
", "format": "string" }, "freeText9": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_045Free text 9 is too long.
", "format": "string" }, "freeText10": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_046Free text 10 is too long.
", "format": "string" }, "doNotReceiveNewsletters": { "type": [ "null", "boolean" ], "description": "Whether the relation will receive newsletters or not." }, "ledgerId": { "type": [ "null", "integer" ], "description": "The ledger ID of this relation.

Error codes

REL_048Ledger not found.
REL_059Ledger must be active and of category 'BAL' or 'VW'.
", "format": "int32" }, "mandate": { "type": "boolean", "description": "Enable or disable mandate." }, "mandateType": { "maxLength": 1, "enum": [ "E", "D" ], "type": "string", "description": "one-time (`E`) or continuous (`D`)

Error codes

REL_033Mandate type is too long.
REL_051Mandate type is invalid (E,D).
", "format": "string" }, "mandateId": { "maxLength": 35, "type": "string", "description": "The mandate ID of this relation.

Error codes

REL_034Mandate ID is too long.
", "format": "string" }, "mandateSignedDate": { "type": [ "null", "object" ], "description": "The signing date of the mandate for this relation.", "format": "date" } } }, "example": { "Id": null, "Type": "B", "Code": "REL123", "Name": "Company", "Salutation": "Mr.", "Contact": "John Doe", "Gender": "m", "Address": "Company Street 2", "PostalCode": "1000 AB", "City": "Amsterdam", "Country": "Netherlands", "Address2": "Secondary Street 5", "PostalCode2": "2000 CD", "City2": "Rotterdam", "Country2": "Netherlands", "PhoneNumber": "+31612345678", "MobilePhoneNumber": "+31687654321", "FaxNumber": "+31201234567", "EmailAddress": "contact@company.com", "EmailAddressInvoice": "invoice@company.com", "EmailAddressReminder": "reminder@company.com", "Website": "https://www.e-boekhouden.nl/", "Note": "This is a test note.", "VatNumber": "NL123456789B01", "Inactive": false, "TermOfPayment": 30, "CompanyRegistrationNumber": "12345678", "Iban": "NL91ABNA0417164300", "Bic": "ABNANL2A", "FreeText1": "", "FreeText2": "", "FreeText3": "", "FreeText4": "", "FreeText5": "", "FreeText6": "", "FreeText7": "", "FreeText8": "", "FreeText9": "", "FreeText10": "", "DoNotReceiveNewsletters": true, "LedgerId": 101, "Mandate": true, "MandateType": "D", "MandateId": "MAND12345", "MandateSignedDate": "2023-10-01" } }, "application/json": { "schema": { "title": "CreateRelation", "required": [ "name" ], "properties": { "type": { "maxLength": 1, "enum": [ "B", "P" ], "type": "string", "description": "Business (`B`) or Private (`P`). Defaults to `B` if empty.

Error codes

REL_001Relation type is invalid (B,P).
", "format": "string" }, "code": { "maxLength": 15, "type": "string", "description": "The code of the relation. Auto-generated if empty.

Error codes

REL_049Code already exists.
REL_005Code is invalid.
REL_006Code is too long.
", "format": "string" }, "name": { "maxLength": 100, "type": "string", "description": "The (company) name of the relation.

Error codes

REL_002Name is mandatory.
REL_003Name is too long.
", "format": "string" }, "salutation": { "maxLength": 50, "type": "string", "description": "The salutation of the relation.

Error codes

REL_010Salutation is too long.
", "format": "string" }, "contact": { "maxLength": 50, "type": "string", "description": "The contact of the relation.

Error codes

REL_009Contact is too long.
", "format": "string" }, "gender": { "maxLength": 1, "enum": [ "m", "v", "a" ], "type": "string", "description": "Male (`m`) or female (`v`) or department (`a`)

Error codes

REL_004Gender is invalid (m,v,a).
", "format": "string" }, "address": { "maxLength": 150, "type": "string", "description": "The primary address of the relation.

Error codes

REL_011Address is too long.
", "format": "string" }, "postalCode": { "maxLength": 50, "type": "string", "description": "The primary postal code of the relation.

Error codes

REL_012Postal code is too long.
", "format": "string" }, "city": { "maxLength": 50, "type": "string", "description": "The primary city of the relation.

Error codes

REL_013City is too long.
", "format": "string" }, "country": { "maxLength": 50, "type": "string", "description": "The primary country of the relation.

Error codes

REL_014Country is too long.
", "format": "string" }, "address2": { "maxLength": 150, "type": "string", "description": "The secondary address of the relation.

Error codes

REL_015Address 2 is too long.
", "format": "string" }, "postalCode2": { "maxLength": 50, "type": "string", "description": "The secondary postal code of the relation.

Error codes

REL_016Postal code 2 is too long.
", "format": "string" }, "city2": { "maxLength": 50, "type": "string", "description": "The secondary city of the relation.

Error codes

REL_017City 2 is too long.
", "format": "string" }, "country2": { "maxLength": 50, "type": "string", "description": "The secondary country of the relation.

Error codes

REL_018Country 2 is too long.
", "format": "string" }, "phoneNumber": { "maxLength": 50, "type": "string", "description": "The phone number of the relation.

Error codes

REL_019Phone is too long.
", "format": "string" }, "mobilePhoneNumber": { "maxLength": 50, "type": "string", "description": "The mobile phone number of the relation.

Error codes

REL_020Mobile is too long.
", "format": "string" }, "faxNumber": { "maxLength": 50, "type": "string", "description": "The fax number of the relation.

Error codes

REL_021Fax is too long.
", "format": "string" }, "emailAddress": { "maxLength": 150, "type": "string", "description": "The email address of the relation.

Error codes

REL_022Email is too long.
REL_023Email is invalid.
", "format": "string" }, "emailAddressInvoice": { "maxLength": 150, "type": "string", "description": "The invoice email address of the relation.

Error codes

REL_024Email invoice is too long.
REL_025Email invoice is invalid.
", "format": "string" }, "emailAddressReminder": { "maxLength": 150, "type": "string", "description": "The reminder email address of the relation.

Error codes

REL_026Email reminder is too long.
REL_027Email reminder is invalid.
", "format": "string" }, "website": { "maxLength": 50, "type": "string", "description": "The website of the relation.

Error codes

REL_028Website is too long.
", "format": "string" }, "note": { "maxLength": 40000, "type": "string", "description": "The note of the relation.", "format": "string" }, "vatNumber": { "maxLength": 50, "type": "string", "description": "The VAT number of the relation.

Error codes

REL_035VAT number is too long.
", "format": "string" }, "inactive": { "type": [ "null", "boolean" ], "description": "Whether the relation is inactive." }, "termOfPayment": { "type": [ "null", "integer" ], "description": "The payment term of the relation.

Error codes

REL_030Term of payment too low.
REL_031Term of payment too high.
", "format": "int32" }, "companyRegistrationNumber": { "maxLength": 50, "type": "string", "description": "The company registration number of the relation.

Error codes

REL_008Company registration number must be numeric.
REL_050Company registration number is too long.
REL_058Company registration number is invalid. A Belgian company registration number consists of 9 or 10 digits; with 10 digits it starts with 0 or 1.
", "format": "string" }, "iban": { "maxLength": 50, "type": "string", "description": "The IBAN number of the relation.

Error codes

REL_007Iban is invalid.
REL_029Iban is too long.
", "format": "string" }, "bic": { "maxLength": 20, "type": "string", "description": "The BIC number of the relation.

Error codes

REL_032BIC is too long.
", "format": "string" }, "freeText1": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_037Free text 1 is too long.
", "format": "string" }, "freeText2": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_038Free text 2 is too long.
", "format": "string" }, "freeText3": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_039Free text 3 is too long.
", "format": "string" }, "freeText4": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_040Free text 4 is too long.
", "format": "string" }, "freeText5": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_041Free text 5 is too long.
", "format": "string" }, "freeText6": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_042Free text 6 is too long.
", "format": "string" }, "freeText7": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_043Free text 7 is too long.
", "format": "string" }, "freeText8": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_044Free text 8 is too long.
", "format": "string" }, "freeText9": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_045Free text 9 is too long.
", "format": "string" }, "freeText10": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_046Free text 10 is too long.
", "format": "string" }, "doNotReceiveNewsletters": { "type": [ "null", "boolean" ], "description": "Whether the relation will receive newsletters or not." }, "ledgerId": { "type": [ "null", "integer" ], "description": "The ledger ID of this relation.

Error codes

REL_048Ledger not found.
REL_059Ledger must be active and of category 'BAL' or 'VW'.
", "format": "int32" }, "mandate": { "type": "boolean", "description": "Enable or disable mandate." }, "mandateType": { "maxLength": 1, "enum": [ "E", "D" ], "type": "string", "description": "one-time (`E`) or continuous (`D`)

Error codes

REL_033Mandate type is too long.
REL_051Mandate type is invalid (E,D).
", "format": "string" }, "mandateId": { "maxLength": 35, "type": "string", "description": "The mandate ID of this relation.

Error codes

REL_034Mandate ID is too long.
", "format": "string" }, "mandateSignedDate": { "type": [ "null", "object" ], "description": "The signing date of the mandate for this relation.", "format": "date" } } }, "example": { "Id": null, "Type": "B", "Code": "REL123", "Name": "Company", "Salutation": "Mr.", "Contact": "John Doe", "Gender": "m", "Address": "Company Street 2", "PostalCode": "1000 AB", "City": "Amsterdam", "Country": "Netherlands", "Address2": "Secondary Street 5", "PostalCode2": "2000 CD", "City2": "Rotterdam", "Country2": "Netherlands", "PhoneNumber": "+31612345678", "MobilePhoneNumber": "+31687654321", "FaxNumber": "+31201234567", "EmailAddress": "contact@company.com", "EmailAddressInvoice": "invoice@company.com", "EmailAddressReminder": "reminder@company.com", "Website": "https://www.e-boekhouden.nl/", "Note": "This is a test note.", "VatNumber": "NL123456789B01", "Inactive": false, "TermOfPayment": 30, "CompanyRegistrationNumber": "12345678", "Iban": "NL91ABNA0417164300", "Bic": "ABNANL2A", "FreeText1": "", "FreeText2": "", "FreeText3": "", "FreeText4": "", "FreeText5": "", "FreeText6": "", "FreeText7": "", "FreeText8": "", "FreeText9": "", "FreeText10": "", "DoNotReceiveNewsletters": true, "LedgerId": 101, "Mandate": true, "MandateType": "D", "MandateId": "MAND12345", "MandateSignedDate": "2023-10-01" } }, "application/*+json": { "schema": { "title": "CreateRelation", "required": [ "name" ], "properties": { "type": { "maxLength": 1, "enum": [ "B", "P" ], "type": "string", "description": "Business (`B`) or Private (`P`). Defaults to `B` if empty.

Error codes

REL_001Relation type is invalid (B,P).
", "format": "string" }, "code": { "maxLength": 15, "type": "string", "description": "The code of the relation. Auto-generated if empty.

Error codes

REL_049Code already exists.
REL_005Code is invalid.
REL_006Code is too long.
", "format": "string" }, "name": { "maxLength": 100, "type": "string", "description": "The (company) name of the relation.

Error codes

REL_002Name is mandatory.
REL_003Name is too long.
", "format": "string" }, "salutation": { "maxLength": 50, "type": "string", "description": "The salutation of the relation.

Error codes

REL_010Salutation is too long.
", "format": "string" }, "contact": { "maxLength": 50, "type": "string", "description": "The contact of the relation.

Error codes

REL_009Contact is too long.
", "format": "string" }, "gender": { "maxLength": 1, "enum": [ "m", "v", "a" ], "type": "string", "description": "Male (`m`) or female (`v`) or department (`a`)

Error codes

REL_004Gender is invalid (m,v,a).
", "format": "string" }, "address": { "maxLength": 150, "type": "string", "description": "The primary address of the relation.

Error codes

REL_011Address is too long.
", "format": "string" }, "postalCode": { "maxLength": 50, "type": "string", "description": "The primary postal code of the relation.

Error codes

REL_012Postal code is too long.
", "format": "string" }, "city": { "maxLength": 50, "type": "string", "description": "The primary city of the relation.

Error codes

REL_013City is too long.
", "format": "string" }, "country": { "maxLength": 50, "type": "string", "description": "The primary country of the relation.

Error codes

REL_014Country is too long.
", "format": "string" }, "address2": { "maxLength": 150, "type": "string", "description": "The secondary address of the relation.

Error codes

REL_015Address 2 is too long.
", "format": "string" }, "postalCode2": { "maxLength": 50, "type": "string", "description": "The secondary postal code of the relation.

Error codes

REL_016Postal code 2 is too long.
", "format": "string" }, "city2": { "maxLength": 50, "type": "string", "description": "The secondary city of the relation.

Error codes

REL_017City 2 is too long.
", "format": "string" }, "country2": { "maxLength": 50, "type": "string", "description": "The secondary country of the relation.

Error codes

REL_018Country 2 is too long.
", "format": "string" }, "phoneNumber": { "maxLength": 50, "type": "string", "description": "The phone number of the relation.

Error codes

REL_019Phone is too long.
", "format": "string" }, "mobilePhoneNumber": { "maxLength": 50, "type": "string", "description": "The mobile phone number of the relation.

Error codes

REL_020Mobile is too long.
", "format": "string" }, "faxNumber": { "maxLength": 50, "type": "string", "description": "The fax number of the relation.

Error codes

REL_021Fax is too long.
", "format": "string" }, "emailAddress": { "maxLength": 150, "type": "string", "description": "The email address of the relation.

Error codes

REL_022Email is too long.
REL_023Email is invalid.
", "format": "string" }, "emailAddressInvoice": { "maxLength": 150, "type": "string", "description": "The invoice email address of the relation.

Error codes

REL_024Email invoice is too long.
REL_025Email invoice is invalid.
", "format": "string" }, "emailAddressReminder": { "maxLength": 150, "type": "string", "description": "The reminder email address of the relation.

Error codes

REL_026Email reminder is too long.
REL_027Email reminder is invalid.
", "format": "string" }, "website": { "maxLength": 50, "type": "string", "description": "The website of the relation.

Error codes

REL_028Website is too long.
", "format": "string" }, "note": { "maxLength": 40000, "type": "string", "description": "The note of the relation.", "format": "string" }, "vatNumber": { "maxLength": 50, "type": "string", "description": "The VAT number of the relation.

Error codes

REL_035VAT number is too long.
", "format": "string" }, "inactive": { "type": [ "null", "boolean" ], "description": "Whether the relation is inactive." }, "termOfPayment": { "type": [ "null", "integer" ], "description": "The payment term of the relation.

Error codes

REL_030Term of payment too low.
REL_031Term of payment too high.
", "format": "int32" }, "companyRegistrationNumber": { "maxLength": 50, "type": "string", "description": "The company registration number of the relation.

Error codes

REL_008Company registration number must be numeric.
REL_050Company registration number is too long.
REL_058Company registration number is invalid. A Belgian company registration number consists of 9 or 10 digits; with 10 digits it starts with 0 or 1.
", "format": "string" }, "iban": { "maxLength": 50, "type": "string", "description": "The IBAN number of the relation.

Error codes

REL_007Iban is invalid.
REL_029Iban is too long.
", "format": "string" }, "bic": { "maxLength": 20, "type": "string", "description": "The BIC number of the relation.

Error codes

REL_032BIC is too long.
", "format": "string" }, "freeText1": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_037Free text 1 is too long.
", "format": "string" }, "freeText2": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_038Free text 2 is too long.
", "format": "string" }, "freeText3": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_039Free text 3 is too long.
", "format": "string" }, "freeText4": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_040Free text 4 is too long.
", "format": "string" }, "freeText5": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_041Free text 5 is too long.
", "format": "string" }, "freeText6": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_042Free text 6 is too long.
", "format": "string" }, "freeText7": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_043Free text 7 is too long.
", "format": "string" }, "freeText8": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_044Free text 8 is too long.
", "format": "string" }, "freeText9": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_045Free text 9 is too long.
", "format": "string" }, "freeText10": { "maxLength": 100, "type": "string", "description": "Free text field for the relation.

Error codes

REL_046Free text 10 is too long.
", "format": "string" }, "doNotReceiveNewsletters": { "type": [ "null", "boolean" ], "description": "Whether the relation will receive newsletters or not." }, "ledgerId": { "type": [ "null", "integer" ], "description": "The ledger ID of this relation.

Error codes

REL_048Ledger not found.
REL_059Ledger must be active and of category 'BAL' or 'VW'.
", "format": "int32" }, "mandate": { "type": "boolean", "description": "Enable or disable mandate." }, "mandateType": { "maxLength": 1, "enum": [ "E", "D" ], "type": "string", "description": "one-time (`E`) or continuous (`D`)

Error codes

REL_033Mandate type is too long.
REL_051Mandate type is invalid (E,D).
", "format": "string" }, "mandateId": { "maxLength": 35, "type": "string", "description": "The mandate ID of this relation.

Error codes

REL_034Mandate ID is too long.
", "format": "string" }, "mandateSignedDate": { "type": [ "null", "object" ], "description": "The signing date of the mandate for this relation.", "format": "date" } } }, "example": { "Id": null, "Type": "B", "Code": "REL123", "Name": "Company", "Salutation": "Mr.", "Contact": "John Doe", "Gender": "m", "Address": "Company Street 2", "PostalCode": "1000 AB", "City": "Amsterdam", "Country": "Netherlands", "Address2": "Secondary Street 5", "PostalCode2": "2000 CD", "City2": "Rotterdam", "Country2": "Netherlands", "PhoneNumber": "+31612345678", "MobilePhoneNumber": "+31687654321", "FaxNumber": "+31201234567", "EmailAddress": "contact@company.com", "EmailAddressInvoice": "invoice@company.com", "EmailAddressReminder": "reminder@company.com", "Website": "https://www.e-boekhouden.nl/", "Note": "This is a test note.", "VatNumber": "NL123456789B01", "Inactive": false, "TermOfPayment": 30, "CompanyRegistrationNumber": "12345678", "Iban": "NL91ABNA0417164300", "Bic": "ABNANL2A", "FreeText1": "", "FreeText2": "", "FreeText3": "", "FreeText4": "", "FreeText5": "", "FreeText6": "", "FreeText7": "", "FreeText8": "", "FreeText9": "", "FreeText10": "", "DoNotReceiveNewsletters": true, "LedgerId": 101, "Mandate": true, "MandateType": "D", "MandateId": "MAND12345", "MandateSignedDate": "2023-10-01" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "title": "CreatedRelation", "properties": { "id": { "type": "integer", "description": "The ID of the relation.", "format": "int32" }, "code": { "type": "string", "description": "The code of the relation.", "format": "string" } } }, "example": { "Id": 1001, "Type": null, "Code": "REL000154", "Date": null, "Name": null, "Salutation": null, "Contact": null, "Gender": null, "Address": null, "PostalCode": null, "City": null, "Country": null, "Address2": null, "PostalCode2": null, "City2": null, "Country2": null, "PhoneNumber": null, "MobilePhoneNumber": null, "FaxNumber": null, "EmailAddress": null, "EmailAddressInvoice": null, "EmailAddressReminder": null, "Website": null, "Note": null, "VatNumber": null, "Inactive": null, "TermOfPayment": null, "CompanyRegistrationNumber": null, "Iban": null, "Bic": null, "FreeText1": null, "FreeText2": null, "FreeText3": null, "FreeText4": null, "FreeText5": null, "FreeText6": null, "FreeText7": null, "FreeText8": null, "FreeText9": null, "FreeText10": null, "IsClubOrAssociationMember": null, "DoNotReceiveNewsletters": null, "LedgerId": null, "Mandate": null, "MandateType": null, "MandateId": null, "MandateSignedDate": null } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/v1/unit": { "get": { "tags": [ "Unit" ], "description": "Get all units.", "operationId": "GetUnits", "parameters": [ { "name": "limit", "in": "query", "description": "The number of items to retrieve.", "schema": { "maximum": 2000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of items to skip.", "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "singular", "in": "query", "description": "The singular form for the unit.", "schema": { "type": "string", "format": "filter-string" } }, { "name": "plural", "in": "query", "description": "The plural form for the unit.", "schema": { "type": "string", "format": "filter-string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDtoOfUnitDto" }, "example": { "Items": [ { "Id": 1, "Singular": "doos", "Plural": "dozen" } ], "Count": 1 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "Errors": { "object.field": [ "Field is missing." ] }, "Type": "validation", "PropertyName": "object.field", "Code": "EXAMPLE_001", "Title": "Field is missing.", "Message": "Extended error information.", "Status": 400, "TraceId": "ABCDEF-123456." } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearer": [ "EB.WebAPI.Core.Attributes.EbAuthAttribute" ] } ] } }, "/swagger": { "get": { "tags": [ "EB.WebAPI.Public" ], "responses": { "200": { "description": "OK" } } } }, "/swagger/{catchAll}": { "get": { "tags": [ "EB.WebAPI.Public" ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "Category": { "enum": [ "BAL", "VW", "AF6", "AF19", "AFOVERIG", "VOOR", "BTWRC", "FIN", "DEB", "CRED", "AF" ], "type": "string", "description": "A list of ledger categories is displayed below. Only these values may be used in `POST` and `PATCH` operations: `[\"BAL\", \"VW\", \"FIN\", \"DEB\", \"CRED\"]`.
\r\n| Value | Description |\r\n|---|---|\r\n| BAL | Balance |
\r\n| VW | Profit and loss |
\r\n| AF6 | Turnover tax low rate |
\r\n| AF19 | Turnover tax high rate |
\r\n| AFOVERIG | Turnover tax other |
\r\n| VOOR | Input tax |
\r\n| BTWRC | VAT current account |
\r\n| FIN | Liquid Assets |
\r\n| DEB | Debtors |
\r\n| CRED | Creditors |
\r\n| AF | Turnover tax |
\r\n" }, "Error": { "title": "Error", "required": [ "type", "title", "status" ], "properties": { "errors": { "type": "array", "items": { "type": "string" }, "description": "Collection of multiple validation errors. Only present when the Type is \"validation\"." }, "type": { "type": "string", "description": "The error type, e.g. \"validation\" or \"security\".", "format": "string" }, "propertyName": { "type": "string", "description": "The property related to this exception.", "format": "string" }, "code": { "type": "string", "description": "The error code.", "format": "string" }, "title": { "type": "string", "description": "The short error message.", "format": "string" }, "message": { "type": "string", "description": "Additional error info. Not always present.", "format": "string" }, "status": { "type": "integer", "description": "The HTTP status.", "format": "int32" }, "traceId": { "type": "string", "description": "Unique trace to identify this error. Not always present.", "format": "string" } } }, "ListDtoOfAdministrationResponseDto": { "type": "object", "properties": { "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/AdministrationResponseDto" } }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ListDtoOfCostCenterSearchResponseDto": { "type": "object", "properties": { "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CostCenterSearchResponseDto" } }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ListDtoOfEmailTemplateDto": { "type": "object", "properties": { "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/EmailTemplateDto" } }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ListDtoOfInvoicesResponseDto": { "type": "object", "properties": { "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/InvoicesResponseDto" } }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ListDtoOfInvoiceTemplateDto": { "type": "object", "properties": { "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/InvoiceTemplateDto" } }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ListDtoOfLedgerBalanceResponseDto": { "type": "object", "properties": { "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/LedgerBalanceResponseDto" } }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ListDtoOfLedgersResponseDto": { "type": "object", "properties": { "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/LedgersResponseDto" } }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ListDtoOfMembersResponseDto": { "type": "object", "properties": { "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/MembersResponseDto" } }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ListDtoOfMutationsResponseDto": { "type": "object", "properties": { "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/MutationsResponseDto" } }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ListDtoOfOutstandingInvoiceDto": { "type": "object", "properties": { "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OutstandingInvoiceDto" } }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ListDtoOfProductGroupDto": { "type": "object", "properties": { "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ProductGroupDto" } }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ListDtoOfProductsResponseDto": { "type": "object", "properties": { "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ProductsResponseDto" } }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ListDtoOfRelationsResponseDto": { "type": "object", "properties": { "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/RelationsResponseDto" } }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ListDtoOfUnitDto": { "type": "object", "properties": { "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/UnitDto" } }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "MutationType": { "enum": [ "1", "2", "3", "4", "5", "6", "7" ], "type": "string", "description": "A list of mutation types is displayed below.
\r\n| Value | Description |\r\n|---|---|\r\n| 1 | Invoice received |
\r\n| 2 | Invoice sent |
\r\n| 3 | Invoice payment received |
\r\n| 4 | Invoice payment sent |
\r\n| 5 | Money received |
\r\n| 6 | Money sent |
\r\n| 7 | General journal entry |
\r\n" }, "SecurityError": { "title": "SecurityError", "required": [ "securityType", "type", "title", "status" ], "properties": { "securityType": { "$ref": "#/components/schemas/SecurityErrorType" }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Collection of multiple validation errors. Only present when the Type is \"validation\"." }, "type": { "type": "string", "description": "The error type, e.g. \"validation\" or \"security\".", "format": "string" }, "propertyName": { "type": "string", "description": "The property related to this exception.", "format": "string" }, "code": { "type": "string", "description": "The error code.", "format": "string" }, "title": { "type": "string", "description": "The short error message.", "format": "string" }, "message": { "type": "string", "description": "Additional error info. Not always present.", "format": "string" }, "status": { "type": "integer", "description": "The HTTP status.", "format": "int32" }, "traceId": { "type": "string", "description": "Unique trace to identify this error. Not always present.", "format": "string" } } }, "SecurityErrorType": { "enum": [ "0", "1", "2" ], "type": "string", "description": "Type of security error.
\r\n| Value | Description |\r\n|---|---|\r\n| 0 | Generic error. |
\r\n| 1 | No access to the requested administration. |
\r\n| 2 | No administration opened. |
\r\n" }, "UpdateSubscriptions": { "enum": [ "0", "1", "2" ], "type": "string", "description": "Specifies the level of changes to be applied to existing subscriptions when a product is updated.
\r\n| Value | Description |\r\n|---|---|\r\n| 0 | No changes will be applied. |
\r\n| 1 | Only price changes will be applied. |
\r\n| 2 | All changes will be applied. |
\r\n" }, "VatCode": { "enum": [ "HOOG_VERK_21", "LAAG_VERK_9", "VERL_VERK", "VERL_VERK_L9", "AFW", "BU_EU_VERK", "BI_EU_VERK", "BI_EU_VERK_D", "AFST_VERK", "LAAG_INK_9", "HOOG_INK_21", "VERL_INK", "AFW_VERK", "BU_EU_INK", "BI_EU_INK", "GEEN" ], "type": "string", "description": "A list of VAT codes is displayed below.
\r\n| Value | Description |\r\n|---|---|\r\n| HOOG_VERK_21 | For selling with 21% VAT. |
\r\n| LAAG_VERK_9 | For selling with 9% VAT. |
\r\n| VERL_VERK | For selling with reverse-charging 21% VAT. |
\r\n| VERL_VERK_L9 | For selling with reverse-charging 9% VAT. |
\r\n| AFW | VAT percentage is unspecified. Price values will be used |
\r\n| BU_EU_VERK | Deliveries outside the EU, 0% VAT. |
\r\n| BI_EU_VERK | Goods inside the EU, 0% VAT. |
\r\n| BI_EU_VERK_D | Services inside the EU, 0% VAT. |
\r\n| AFST_VERK | Distance sales inside the EU, 0% VAT. |
\r\n| LAAG_INK_9 | For buying with 9% VAT. |
\r\n| HOOG_INK_21 | For buying with 21% VAT. |
\r\n| VERL_INK | For buying with reverse-charging VAT. |
\r\n| AFW_VERK | For selling with unspecified VAT percentage. Price values will be used. |
\r\n| BU_EU_INK | For buying goods/services from outside the EU, 0% VAT. |
\r\n| BI_EU_INK | For buying goods/services from inside the EU, 0% VAT. |
\r\n| GEEN | No VAT. |
\r\n" } }, "securitySchemes": { "bearer": { "type": "apiKey", "description": "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"", "name": "Authorization", "in": "header" } } }, "tags": [ { "name": "Administration" }, { "name": "CostCenter" }, { "name": "EmailTemplate" }, { "name": "Invoice" }, { "name": "InvoiceTemplate" }, { "name": "Ledger" }, { "name": "Member" }, { "name": "Mutation" }, { "name": "Product" }, { "name": "Relation" }, { "name": "Session" }, { "name": "Unit" }, { "name": "EB.WebAPI.Public" } ] }