From d1232308e2d3203534ef915e7a0f9dc2ce49aa8d Mon Sep 17 00:00:00 2001 From: Eric Zwaal Date: Thu, 22 Jan 2026 14:34:59 +0100 Subject: [PATCH 1/8] Experttoets Integraties genoemd --- .../profit/en/partner-certification-steps.md | 14 ++++++++------ .../profit/nl/partner-certification-steps.md | 2 ++ 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/markdownpages/profit/en/partner-certification-steps.md b/markdownpages/profit/en/partner-certification-steps.md index 9597aa9..78ccd11 100644 --- a/markdownpages/profit/en/partner-certification-steps.md +++ b/markdownpages/profit/en/partner-certification-steps.md @@ -17,10 +17,10 @@ Welcome to the partner certification journey! In this document, we guide you ste ### Security check -Safety first! A pentest is an absolutely essential part of the partnership. At the start of the certification process, a pentest must have been performed, or a concrete date must be scheduled. Preferably the pentest is performed by a [CCV-certified party](https://hetccv.nl/certificaat-schema/pentesten). +Safety first! A pentest is an absolutely essential part of the certification. At the start of the certification process, a pentest must have been performed, or a concrete date must be scheduled. Make sure the pentest is preferably performed by a [CCV-certified party](https://hetccv.nl/certificaat-schema/pentesten). Questions about this? Check https://partner.afas.nl/portal-landingspagina/faq#Security. Instead of a pentest, you can also have a Security Quickscan performed by Defion. [Read more in this article.](https://partner.afas.nl/portal-partnerportal/security-quickscan) -Of course, we handle the results of the pentest or Security Quickscan confidentially. +Of course, we handle the results of the pentest or Security Quickscan confidentially. All our employees are bound by a confidentiality agreement and have a Certificate of Good Conduct. ### Add contacts @@ -49,11 +49,13 @@ Go to https://klant.afas.nl/supportplus and activate it! Register for a course where you will learn everything about calling our API. There is a lot of focus on creating your own [GetConnectors](#supplying-getconnectors). This course is free for 1 colleague. Check https://klant.afas.nl/opleiding/specialisatiecursus-connector for information and dates. +**Making integrations for other partners?** In that case, at least 1 colleague in your company must have completed the expert test "Integrations" with a score of at least 7. Please contact the System Integrator if this applies to you. + ### Sending IntegrationId Send a special HTTP header with all calls to the AFAS API. This header identifies the calls from your integration and is always the same. -[This article describes in detail what it is](./integrationid), what we use it for, and how to implement it. +[This article](./integrationid) describes in detail what it is, what we use it for, and how to implement it. The specific IntegrationId for your integration can be found in the task and in the [AppConnector Auditor](./app-connector-auditor-partner). @@ -90,7 +92,7 @@ Ensure that our mutual customers use the checked GetConnectors. For example, mak Did you land a new customer? Congratulations! Some setup in AFAS will need to be done before the new customer can go live. This is not much work and it is not difficult, so the customer can easily do it themselves. But because each integration uses its own set of Get and UpdateConnectors, it is important that there is a document that tells the AFAS administrator exactly what needs to be done. -Use this help page as the basis for the document: [https://partner.afas.nl/portal-partnerportal/template-documentatie](https://partner.afas.nl/portal-partnerportal/template-documentatie). +Use this help page as the basis for the document: https://partner.afas.nl/portal-partnerportal/template-documentatie Submit the document as an attachment in a reply to the task. Or even better: make it a web page that you can always keep up to date. Post the link in a reply. @@ -105,7 +107,7 @@ If the demo is approved, you can move on to the next part. Is the [demo](#give-a-demo) approved? -Then go to [https://partner.afas.nl/mijn-paginas](https://partner.afas.nl/mijn-paginas) and follow the instructions so that your integration is displayed on our partner page. By using Markdown for formatting, you can make it an attractive page. +Then go to https://partner.afas.nl/mijn-paginas and follow the instructions so that your integration is displayed on our partner page. By using Markdown for formatting, you can make it an attractive page. **Tip**: In the Website field, refer to a landing page on your own site, where the integration with AFAS is described in more detail. @@ -115,7 +117,7 @@ From now on you may also use the AFAS name and logo on your website. At [www.afa An integration without customers is not an integration. To give our mutual customers confidence that the integration has been well tested and runs smoothly, your certification is only complete when you serve 5 or more mutual customers with your integration. We check this based on the IntegrationId ([see above](#sending-integrationid)). -Proud of your customers? Then submit references from customers where the integration runs to their satisfaction. You can do this at [https://partner.afas.nl/aanmaken-aanvraag-partnerportal/referentie](https://partner.afas.nl/aanmaken-aanvraag-partnerportal/referentie). +Proud of your customers? Then submit references from customers where the integration runs to their satisfaction. You can do this at https://partner.afas.nl/aanmaken-aanvraag-partnerportal/referentie. ## Contact diff --git a/markdownpages/profit/nl/partner-certification-steps.md b/markdownpages/profit/nl/partner-certification-steps.md index 330a36b..8be21fe 100644 --- a/markdownpages/profit/nl/partner-certification-steps.md +++ b/markdownpages/profit/nl/partner-certification-steps.md @@ -58,6 +58,8 @@ Ga naar https://klant.afas.nl/supportplus en activeer het! Schrijf je in voor een cursus waarin je alles leert over de aanroep van onze API. Er is veel aandacht voor het maken van je eigen [GetConnectoren](#getconnectoren-aanleveren). Deze cursus is gratis voor 1 collega. Kijk op https://klant.afas.nl/opleiding/specialisatiecursus-connector voor informatie en data. +**Maak je integraties voor andere partners?** In dat geval moet er in jouw bedrijf minimaal 1 collega de experttoets "Integraties" met ten minste een 7 afgerond hebben. Neem contact op met de Systemintegrator als dit voor jou van toepassing is. + ### IntegrationId meesturen From d8b7940125bd87312f7011d21e0eac9a2a5e9812 Mon Sep 17 00:00:00 2001 From: Eric Zwaal Date: Wed, 3 Dec 2025 14:09:24 +0100 Subject: [PATCH 2/8] =?UTF-8?q?Lege=20regels=20en=20=C3=A9=C3=A9n?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- markdownpages/profit/en/bi-models.md | 13 ++++++++++--- markdownpages/profit/nl/bi-modellen.md | 14 +++++++++++--- 2 files changed, 21 insertions(+), 6 deletions(-) diff --git a/markdownpages/profit/en/bi-models.md b/markdownpages/profit/en/bi-models.md index ce84626..313ee14 100644 --- a/markdownpages/profit/en/bi-models.md +++ b/markdownpages/profit/en/bi-models.md @@ -1,20 +1,24 @@ --- title: BI-models author: TOKL -date: 2025-11-20 +date: 2025-12-03 tags: BI, OData, bi-modellen --- ## Introduction + The BI models in AFAS Profit can be accessed via OData connectors. OData connectors are interfaces that allow applications to exchange data in a standardized and secure manner using the OData protocol (Open Data Protocol). ## BI Models vs. GET Connectors + The BI models in AFAS Profit operate differently from GET connectors. With GET connectors, data is generated and returned at the time of the request. This can lead to longer wait times and performance issues with more complex GET connectors (where a lot of data from different tables needs to be combined). In BI models, the data is pre-calculated and stored in a separate model, significantly improving performance when retrieving large amounts of data. This makes BI models very suitable for reports and analyses involving large datasets. ## Versions of the BI models and redirects + The endpoints of the BI models remain consistent and unchanged. However, when you call the standard endpoint, a redirect is performed. It is important that your client follows this redirect to access the correct resource. ### Example + ``` curl https://12345.rest.afas.online/ProfitRestServices/bi/Verkoopomzet ``` @@ -26,9 +30,11 @@ https://12345.rest.afas.online/ProfitRestServices/bi/Verkoopomzet/v2/ ## Pagination ### Client-side + You can specify how many records you want to fetch and from which record you want to start using the 'skip' and 'top' parameters. You don't need to provide sorting because the server already maintains a fixed order. ### Server-side + When you retrieve large amounts of data via an OData connector and do not include skip and top parameters in your query, server-side pagination will be applied. This means the server returns the data in smaller chunks (pages) instead of everything at once. The server sends a response that includes a link to the next page of data. When there is no more data, no link is provided. ## Creating BI models @@ -41,13 +47,14 @@ The BI model editor opens; a **fact table** is automatically created in the mode It is often more efficient not to include all fields in one fact table, but to build the model as a so-called **star schema**. You place values that occur frequently in a separate table (*dimension table*) and reference that dimension table from the fact table. -__Example__ +**Example** -An example of this is the field DebtorName in Financial mutations. Suppose there are 150 mutations for one debtor. This debtor's name is: EenHeleLangeNaam B.V. +An example of this is the field DebtorName in Financial mutations. Suppose there are 150 mutations for one debtor. This debtor's name is: AVeryLongDebtorName ltd. If you use only one fact table, that name will be stored 150 times in the table. If you create a dimension table with debtor names, each debtor name will only appear once. In the fact table you then store not the full name but a reference to the debtor name table, for example 115. The number of characters then goes from 21 to 3. This is much more efficient when transferring information. ### Adding a dimension table + You can add fields that can be expanded into the fact table, or you can include them as a new dimension. To do this, right-click the field and choose *New dimension* from the menu. A new dimension table is then created automatically. A reference to this dimension table is added in the fact table. In Profit there are two options for adding a new dimension: 1. New dimension diff --git a/markdownpages/profit/nl/bi-modellen.md b/markdownpages/profit/nl/bi-modellen.md index fb5b5ca..2f984de 100644 --- a/markdownpages/profit/nl/bi-modellen.md +++ b/markdownpages/profit/nl/bi-modellen.md @@ -1,21 +1,25 @@ --- title: BI-modellen author: TOKL -date: 2025-11-20 +date: 2025-12-03 tags: BI, OData, bi-modellen --- ## Introductie + De BI-modellen in AFAS Profit kunnen worden uitgevraagd via OData-connectoren. OData-connectoren zijn koppelstukken waarmee applicaties standaard en veilig gegevens kunnen uitwisselen via het OData-protocol (Open Data Protocol). ## BI-modellen vs. GET connectoren + De BI-modellen in AFAS Profit werken anders dan de GET connectoren. Bij GET connectoren wordt de data op het moment van de aanvraag gegenereerd en teruggegeven. Dit kan bij complexere GET connectoren (waarbij veel gegevens uit verschillende tabellen moet worden samengevoegd) leiden tot langere wachttijden en prestatieproblemen. Bij de BI-modellen wordt de data vooraf berekend en opgeslagen in een apart model, waardoor de prestaties bij het opvragen van grote hoeveelheden data aanzienlijk verbeteren. Hierdoor zijn BI-modellen zeer geschikt voor rapportages en analyses waarbij grote datasets betrokken zijn. ## Versies van de BI-modellen en redirects + De endpoints van de BI-modellen blijven consistent en onveranderd. Wanneer je echter het standaard endpoint aanroept, wordt er een redirect uitgevoerd. Het is belangrijk dat je client deze redirect volgt om toegang te krijgen tot de juiste resource. ### Voorbeeld + ``` curl https://12345.rest.afas.online/ProfitRestServices/bi/Verkoopomzet ``` @@ -27,13 +31,16 @@ https://12345.rest.afas.online/ProfitRestServices/bi/Verkoopomzet/v2/ ## Pagination ### Client side + Je kunt zelf aangeven hoeveel records je wilt ophalen en vanaf welk record je wilt beginnen met de 'skip' en 'top' parameters. Je hoeft hierbij geen sortering mee te geven omdat aan de server kant al een vaste volgorde wordt aangehouden. ### Server side -Wanneer je grote hoeveelheden data ophaald via een OData-connector en je geeft geen skip en top parameters mee in je query, dan zal er server side pagination worden toegepast. Dit betekent dat de server de data in kleinere brokken (pagina's) teruggeeft in plaats van alles in ��n keer. De server stuurt een response terug en in deze response zit een link naar de volgende pagina met data. Wanneer er geen data meer is, wordt er geen link meer meegegeven. + +Wanneer je grote hoeveelheden data ophaald via een OData-connector en je geeft geen skip en top parameters mee in je query, dan zal er server side pagination worden toegepast. Dit betekent dat de server de data in kleinere brokken (pagina's) teruggeeft in plaats van alles in één keer. De server stuurt een response terug en in deze response zit een link naar de volgende pagina met data. Wanneer er geen data meer is, wordt er geen link meer meegegeven. ## BI-modellen creëren + Wanneer je een BI-model maakt, kan dit op basis van een **Bestaand BI-model** of op basis van een **Brontabel**. Als je kiest voor een *Bestaand BI-model*, krijg je een kopie die je vervolgens kunt aanpassen. Als je kiest voor *Brontabel*, selecteer je een brontabel uit de lijst, bijvoorbeeld **Financiële mutaties**. @@ -42,7 +49,7 @@ De BI-modeleditor opent zich; er wordt automatisch een **feitentabel** aangemaak Het is vaak efficiënter om niet alle velden in één feitentabel op te nemen, maar het model op te bouwen in een zogenoemd **ster-model**. Je plaatst waarden die vaak terugkomen in een aparte tabel (*dimensietabel*) en verwijst vanuit de feitentabel naar die dimensietabel. -__Voorbeeld__ +**Voorbeeld** Een voorbeeld is het veld Debiteurnaam in Financiële mutaties. Stel dat er voor één debiteur 150 mutaties zijn. Deze debiteur heet: EenHeleLangeNaam B.V. @@ -50,6 +57,7 @@ Als je slechts één feitentabel gebruikt, wordt die naam dus 150 keer in de tab ### Dimensietabel toevoegen + Je kunt velden die uitgeklapt kunnen worden aan de feitentabel toevoegen, maar je kunt ze ook als nieuwe dimensie opnemen. Dit doe je door met de rechtermuisknop op het veld te klikken en in het menu te kiezen voor Nieuwe dimensie. Er wordt dan automatisch een nieuwe dimensietabel gemaakt. In de feitentabel wordt een verwijzing naar deze dimensietabel opgenomen. In Profit zijn er twee opties voor het toevoegen van een nieuwe dimensie: 1. Nieuwe dimensie From 70d44e3331481ca98321b102efc80946f4e8d9ec Mon Sep 17 00:00:00 2001 From: Heimmot24 Date: Wed, 7 Jan 2026 16:49:27 +0100 Subject: [PATCH 3/8] Change StId value from 5 to -5 --- markdownpages/profit/nl/howto-finance-mutation-purch.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/markdownpages/profit/nl/howto-finance-mutation-purch.md b/markdownpages/profit/nl/howto-finance-mutation-purch.md index ddb921d..bd93613 100644 --- a/markdownpages/profit/nl/howto-finance-mutation-purch.md +++ b/markdownpages/profit/nl/howto-finance-mutation-purch.md @@ -212,7 +212,7 @@ In het voorbeeld hieronder wordt er een bijlage gekoppeld aan de inkoopfactuur u "KnSubject": { "Element": { "Fields": { - "StId": 5, + "StId": -5, "Ds": "Purchase PUR004979", "Da": "2026-03-21T13:42:59" }, @@ -324,4 +324,4 @@ De laatste stap is het aanmaken van de confrontatie zelf. Hiervoor heb je het `I "CfSt": "2" } } -``` \ No newline at end of file +``` From 562b9bbc4a88d4fe64d5d332ad1cc314913690fe Mon Sep 17 00:00:00 2001 From: Rein de Jager Date: Thu, 15 Jan 2026 13:27:07 +0100 Subject: [PATCH 4/8] 7.1 update --- OpenApiSpecs/sb/en/7-1-0.json | 17646 ++++++++++++++++ .../responses/example.json | 12 + .../responses/example.json | 165 + .../examples/Inkoopjournaalpost.json | 30 + .../responses/response.json | 9 + .../examples/example.json | 4 + .../responses/success.json | 8 + .../BTW Verlegd binnen Nederland.json | 24 + .../examples/BTW binnen en buiten EU.json | 22 + .../examples/Sales with attachment.json | 29 + .../examples/verkoop 1 regel.json | 18 + .../examples/verkoop aan persoon.json | 25 + .../examples/verkoop alle soorten btw.json | 44 + .../verkoop meerdere btw soorten.json | 37 + .../responses/400/already exists.json | 8 + .../responses/400/error on date.json | 9 + .../responses/400/error on line.json | 10 + .../responses/400/error.json | 8 + .../responses/success.json | 8 + .../examples/PaymentReference.json | 5 + .../responses/success.json | 7 + OpenApiSpecs/sb/nl/7-1-0.json | 17646 ++++++++++++++++ OpenApiSpecs/sb/nl/release-spec.json | 13616 ++++++++++++ scripts/merge_openapi_examples.py | 43 +- 24 files changed, 49430 insertions(+), 3 deletions(-) create mode 100644 OpenApiSpecs/sb/en/7-1-0.json create mode 100644 OpenApiSpecs/sb/files/getconnector-adminlicenseinformation-get-1.0/responses/example.json create mode 100644 OpenApiSpecs/sb/files/getconnector-salesinvoices-get-1.1/responses/example.json create mode 100644 OpenApiSpecs/sb/files/updateconnector-purchasejournalentry-Post-2.0/examples/Inkoopjournaalpost.json create mode 100644 OpenApiSpecs/sb/files/updateconnector-purchasejournalentry-Post-2.0/responses/response.json create mode 100644 OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Delete-2.1/examples/example.json create mode 100644 OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Delete-2.1/responses/success.json create mode 100644 OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/BTW Verlegd binnen Nederland.json create mode 100644 OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/BTW binnen en buiten EU.json create mode 100644 OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/Sales with attachment.json create mode 100644 OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/verkoop 1 regel.json create mode 100644 OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/verkoop aan persoon.json create mode 100644 OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/verkoop alle soorten btw.json create mode 100644 OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/verkoop meerdere btw soorten.json create mode 100644 OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/responses/400/already exists.json create mode 100644 OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/responses/400/error on date.json create mode 100644 OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/responses/400/error on line.json create mode 100644 OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/responses/400/error.json create mode 100644 OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/responses/success.json create mode 100644 OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Put-2.1/examples/PaymentReference.json create mode 100644 OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Put-2.1/responses/success.json create mode 100644 OpenApiSpecs/sb/nl/7-1-0.json create mode 100644 OpenApiSpecs/sb/nl/release-spec.json diff --git a/OpenApiSpecs/sb/en/7-1-0.json b/OpenApiSpecs/sb/en/7-1-0.json new file mode 100644 index 0000000..b7981b2 --- /dev/null +++ b/OpenApiSpecs/sb/en/7-1-0.json @@ -0,0 +1,17646 @@ +{ + "openapi": "3.0.2", + "info": { + "version": "7.1", + "title": "AFAS SB API", + "description": "AFAS SB API for integrating with the accounting software for accountants and entrepreneurs." + }, + "servers": [ + { + "url": "https://{domain}.afasfocus.nl/{customerenvironment}", + "description": "Customer environment URL", + "variables": { + "domain": { + "description": "Identifier for the accountancy environment", + "default": "app-center-demo" + }, + "customerenvironment": { + "description": "Identifier for the customer environment", + "default": "scope" + } + } + }, + { + "url": "https://{subdomein}.afasfocus.nl/admin", + "description": "Accounting center URL", + "variables": { + "subdomein": { + "description": "URL unique for the accounting office.", + "default": "app-center-demo" + } + } + } + ], + "paths": { + "/api/blob/{uuid}": { + "get": { + "description": "Retrieve a specific blob by UUI.", + "summary": "/api/blob/{uuid}", + "operationId": "getBlob", + "parameters": [ + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1" + } + }, + { + "in": "header", + "name": "Authorization", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "uuid", + "schema": { + "type": "string", + "format": "uuid", + "example": "00000000-0000-0000-0000-000000000000" + }, + "required": true, + "description": "UUID of the blob" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "tags": [ + "Bijlagen", + "Inkoopjournaalpost", + "Verkoopfactuur", + "Verkoopjournaalpost", + "Publiek: Externe facturatie" + ], + "deprecated": false + }, + "put": { + "description": "This operation consists of two requests. First call this endpoint with the Blob-* headers, without body to prepare the blob. Then call this endpoint without the Blob-* headers with a body to upload the file. The blob UUID must be generated client side.", + "summary": "/api/blob/{uuid}", + "operationId": "reserveBlobSpace", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "path", + "name": "uuid", + "schema": { + "type": "string", + "format": "uuid", + "example": "00000000-0000-0000-0000-000000000000" + }, + "required": true, + "description": "UUID of the blob. This should be generated client side." + }, + { + "in": "header", + "name": "Blob-Content-Length", + "schema": { + "type": "integer", + "example": "100" + } + }, + { + "in": "header", + "name": "Blob-Content-Type", + "schema": { + "type": "string", + "example": "image/jpeg" + } + }, + { + "in": "header", + "name": "Blob-Content-FileName", + "schema": { + "type": "string", + "example": "attachment.jpg" + } + }, + { + "in": "header", + "name": "Blob-Upload-Type", + "schema": { + "type": "string", + "example": "Blob/Image" + }, + "required": true + }, + { + "in": "header", + "name": "Blob-Format", + "schema": { + "type": "string", + "example": "Default/Thumb/Small/Medium" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + } + ], + "requestBody": { + "description": "Binary content of the blob", + "required": true + }, + "responses": { + "200": { + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "tags": [ + "Bijlagen", + "Inkoopjournaalpost", + "Verkoopfactuur", + "Verkoopjournaalpost", + "Publiek: Externe facturatie" + ], + "deprecated": false + } + }, + "/authentication/getaccesstoken": { + "post": { + "description": "Get AccessToken: Provide an application token created in the current application. An access token is returned which can be used for the \"AccessToken\" header to execute connector requests. The 'scope' property is required in accountancy environments. When scope is not provided in accountancy environments, an identity token is returned which can be used in the 'ScopeSelection' api.", + "summary": "/authentication/getaccesstoken", + "operationId": "updateconnector-getaccesstoken", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/json" + } + } + ], + "requestBody": { + "description": "Application token", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "apptoken": { + "type": "string", + "example": "APPTOKEN" + }, + "scope": { + "type": "string", + "example": "demo" + } + }, + "required": [ + "apptoken" + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "tags": [ + "Autorisatie" + ], + "deprecated": false + } + }, + "/authentication/getscopes": { + "post": { + "description": "Get scopes: Provide an identity token returned by the 'AccessToken' api.", + "summary": "/authentication/getscopes", + "operationId": "updateconnector-getscopes", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/json" + } + }, + { + "in": "header", + "name": "IdentityToken", + "schema": { + "type": "string", + "example": "IDENTITYTOKEN" + } + } + ], + "requestBody": { + "description": "Scopes", + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Name": { + "type": "string", + "example": "Beheer" + }, + "Path": { + "type": "string", + "example": "admin" + } + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "tags": [ + "Autorisatie" + ], + "deprecated": false + } + }, + "/app/token": { + "post": { + "description": "Get an access token for a scope.", + "summary": "app/token", + "operationId": "updateconnector-token", + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "grant_type": { + "type": "string", + "example": "refresh_token" + }, + "refresh_token": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "client_secret": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "multipart/form-data": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_token": { + "type": "string" + }, + "expires_in": { + "type": "integer" + }, + "token_type": { + "type": "string" + } + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "tags": [ + "Autorisatie" + ], + "deprecated": false + } + }, + "/api/adminlicenseinformation": { + "get": { + "description": "Retrieve license information for all scopes in the environment. This endpoint requires admin rights, and should be called from the 'admin' scope (e.g. yourdomain.afasfocus.nl/admin/api/adminlicenseinformation).", + "summary": "/api/adminlicenseinformation", + "operationId": "getconnector-adminlicenseinformation-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/json" + } + }, + { + "in": "header", + "name": "IdentityToken", + "schema": { + "type": "string", + "example": "IDENTITYTOKEN" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Name": { + "type": "string", + "example": "Beheer" + }, + "Url": { + "type": "string", + "example": "beheer" + }, + "ScopeId": { + "type": "integer", + "example": "1" + }, + "License": { + "type": "string", + "example": "Ondernemen" + }, + "AdministrationCount": { + "type": "integer", + "example": "5" + }, + "ExtraAdministrationCount": { + "type": "integer", + "example": "2" + }, + "UserCount": { + "type": "integer", + "example": "2" + }, + "ExtraUserCount": { + "type": "integer", + "example": "0" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "Name": "Enyoi", + "Url": "enyoi", + "ScopeId": 1, + "License": "2Gether", + "AdministrationCount": 2, + "ExtraAdministrationCount": 0, + "UserCount": 0, + "ExtraUserCount": 0 + } + ] + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "tags": [ + "Admin center data", + "Publiek: Admin center data" + ], + "deprecated": false + } + }, + "/api/accountingperiod": { + "get": { + "description": "Retrieve accounting periods for a specific administration", + "summary": "accountingperiod 2.0", + "operationId": "getconnector-accountingperiod-get-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "AccountingYear": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "StartDate": { + "type": "string", + "format": "date-time" + }, + "EndDate": { + "type": "string", + "format": "date-time" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "PeriodNumber": { + "type": "number" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "Id": "6b39b98c-4fc0-4c51-9cc6-d9b6657b725a", + "Description": "Januari 2024", + "StartDate": "2024-01-01T00:00:00Z", + "EndDate": "2024-01-31T00:00:00Z", + "PeriodNumber": 1.0, + "AccountingYear": "2024" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële dashboarding", + "Publiek: Financiële rapportage", + "Financiele rapportage" + ] + } + }, + "/api/accountingyear": { + "get": { + "description": "Retrieve accounting years for financial reporting periods", + "summary": "accountingyear 2.0", + "operationId": "getconnector-accountingyear-get-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + }, + "StartDate": { + "type": "string", + "format": "date-time" + }, + "EndDate": { + "type": "string", + "format": "date-time" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "Id": "313e40a2-1d9d-4672-b852-209f9ea9e167", + "Description": "2024", + "StartDate": "2024-01-01T00:00:00Z", + "EndDate": "2024-12-31T00:00:00Z" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële dashboarding", + "Publiek: Financiële rapportage", + "Financiele rapportage" + ] + } + }, + "/api/addresses": { + "get": { + "description": "Retrieve multiple addresses with detailed contact information", + "summary": "addresses 1.0", + "operationId": "getconnector-addresses-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "StreetName": { + "type": "string" + }, + "HouseNumber": { + "type": "string" + }, + "HouseNumberAddition": { + "type": "string" + }, + "PostalZone": { + "type": "string" + }, + "CityName": { + "type": "string" + }, + "CountryName": { + "type": "string" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "IsPreferedInvoiceAddress": { + "type": "boolean" + }, + "IsPreferedSupplierAddress": { + "type": "boolean" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + } + } + } + }, + "examples": { + "example": { + "value": { + "TrackingToken": "202409230720571", + "Result": [ + { + "Id": "56528a1b-4bea-5699-abb8-f66155e9c497", + "StreetName": "Reactorweg", + "HouseNumber": "47", + "HouseNumberAddition": null, + "PostalZone": "3542 AD", + "RelationId": "4fa13b8e-44dc-5cf7-b2ef-35e14be401e8", + "IsPreferedInvoiceAddress": true, + "IsPreferedSupplierAddress": true, + "CityName": "Utrecht", + "CountryName": "Nederland", + "RelationType": "organisation" + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost", + "Publiek: Relatiemanagement", + "Relaties", + "Publiek: Facturatie", + "Verkoopfactuur" + ] + } + }, + "/api/administration": { + "get": { + "description": "ListAdministration", + "summary": "administration 1.0", + "operationId": "getconnector-administration-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Description Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Description": { + "type": "string" + }, + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "Id": { + "type": "string", + "format": "uuid" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "Id": "701b747b-eea2-5ed1-8518-973e5c670252", + "Description": "EnYoi Holding B.V.", + "InstanceId": "701b747b-eea2-5ed1-8518-973e5c670252" + }, + { + "Id": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "EnYoi ICT Services B.V.", + "InstanceId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Loonjournaalpost", + "POS Transacties", + "Inkoopjournaalpost", + "Verkoopfactuur", + "Verkoopjournaalpost" + ] + } + }, + "/api/administrations": { + "get": { + "description": "Retrieve all available administrations and their details", + "summary": "administrations 1.0", + "operationId": "getconnector-administrations-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Description Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Description": { + "type": "string" + }, + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "Id": { + "type": "string", + "format": "uuid" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "Id": "701b747b-eea2-5ed1-8518-973e5c670252", + "Description": "EnYoi Holding B.V.", + "InstanceId": "701b747b-eea2-5ed1-8518-973e5c670252" + }, + { + "Id": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "EnYoi ICT Services B.V.", + "InstanceId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële dashboarding", + "Publiek: Financiële journaalpost", + "Financiële journaalpost", + "Publiek: Financiële rapportage", + "Financiele rapportage", + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Loonjournaalpost", + "Publiek: POS Transacties", + "POS Transacties", + "Inkoopjournaalpost", + "Publiek: Relatiemanagement", + "Publiek: Facturatie", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/bankaccounts": { + "get": { + "description": "Get bankaccount for organisation or person.", + "summary": "bankaccounts 1.0", + "operationId": "getconnector-bankaccounts-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "AccountNumber": { + "type": "string" + }, + "RelationIsOrganisationOrAdministration": { + "type": "boolean" + }, + "PreferredIncommingPayments": { + "type": "boolean" + }, + "PreferredOutgoingPayments": { + "type": "boolean" + }, + "RelationId": { + "type": "string", + "format": "uuid" + } + } + } + }, + "examples": { + "bankaccounts": { + "value": { + "TrackingToken": "202406211216501", + "Result": [ + { + "Id": "0d83610b-e1fc-53a2-a951-00f9098e0154", + "AccountNumber": "NL10INGB0675488052", + "RelationId": "b323458f-5bae-542b-8294-9040c9801805" + }, + { + "Id": "dd6cbc4b-6ec6-59c0-95ca-020b5977b39a", + "AccountNumber": "NL16RABO0300417497", + "RelationId": "b24405d6-fee2-52f5-8f24-c1a0180e46f2" + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost", + "Publiek: Relatiemanagement", + "Relaties", + "Publiek: Facturatie", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/cashregisters": { + "get": { + "description": "Retrieve cash register configurations and settings", + "summary": "cashregisters 1.0", + "operationId": "getconnector-cashregisters-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "InstanceId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + } + } + } + }, + "examples": { + "cashregisters": { + "value": [ + { + "InstanceId": "265424ab-253e-57d4-9d65-036c65ad05c8", + "Description": "Kas", + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8" + }, + { + "InstanceId": "25e93133-ec28-543f-9f23-312ddb4e10a3", + "Description": "Kas", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: POS Transacties", + "POS Transacties" + ] + } + }, + "/api/contacts": { + "get": { + "description": "Retrieve contact information for persons and organizations", + "summary": "contacts 1.0", + "operationId": "getconnector-contacts-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "OrganisationId": { + "type": "string", + "format": "uuid" + }, + "PersonId": { + "type": "string", + "format": "uuid" + }, + "Name": { + "type": "string" + }, + "Firstname": { + "type": "string" + }, + "Initials": { + "type": "string" + }, + "Prefix": { + "type": "string" + }, + "Lastname": { + "type": "string" + }, + "PhoneNumber": { + "type": "string" + }, + "Emailaddress": { + "type": "string" + }, + "ExternalId": { + "type": "string" + }, + "IsArchived": { + "type": "boolean" + }, + "PersonIsArchived": { + "type": "boolean" + }, + "OrganisationIsArchived": { + "type": "boolean" + } + } + } + }, + "examples": { + "example": { + "value": { + "TrackingToken": "202403280856491", + "Result": [ + { + "Id": "0236d0dc-b5be-5b6e-b191-17f6b767aa5b", + "IsArchived": false, + "OrganisationId": "e97ecfe3-8bcb-5baf-82e4-4e46b2b02126", + "OrganisatieIsArchived": false, + "Name": "Peter de Jager", + "FirstName": "Peter", + "Initials": "P.", + "Prefix": "de", + "Lastname": "Jager", + "ExternalId": null, + "PersoonIsArchived": false + }, + { + "Id": "2c5b3f1d-1689-5257-9ab2-2ba634203b2c", + "IsArchived": false, + "OrganisationId": "c589e4b3-d131-5a1b-9eca-44dd2fc17600", + "OrganisatieIsArchived": false, + "Name": "Trudie Feenstra", + "FirstName": "Trudie", + "Initials": "T.", + "Prefix": null, + "Lastname": "Feenstra", + "ExternalId": null, + "PersoonIsArchived": false + }, + { + "Id": "416b5ea9-93bd-5cfc-af07-37f1681da00b", + "IsArchived": false, + "OrganisationId": "bb3fd8ef-5a0e-5919-8e67-77b396abf212", + "OrganisatieIsArchived": false, + "Name": "Yousef Martiqui", + "FirstName": "Yousef", + "Initials": "Y.", + "Prefix": null, + "Lastname": "Martiqui", + "ExternalId": null, + "PersoonIsArchived": false + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Relatiemanagement", + "Relaties" + ] + } + }, + "/api/countries": { + "get": { + "description": "Retrieve country information with ISO codes and descriptions", + "summary": "countries 1.0", + "operationId": "getconnector-countries-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + }, + "CodeISOAlpha2": { + "type": "string" + } + } + } + }, + "examples": { + "countries": { + "value": { + "TrackingToken": "202406211218251", + "Result": [ + { + "Id": "afa50000-0000-0ab9-bf40-00958bc94cc8", + "Description": "Tadzjikistan", + "CodeISOAlpha2": "TJ" + }, + { + "Id": "afa50000-0000-0be2-8a70-01f36103d3cd", + "Description": "Heard Eiland en McDonald Eilanden", + "CodeISOAlpha2": "HM" + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost", + "Publiek: Relatiemanagement", + "Relaties" + ] + } + }, + "/api/creditorbalance": { + "get": { + "description": "Retrieve creditor balance information for suppliers", + "summary": "creditorbalance 1.0", + "operationId": "getconnector-creditorbalance-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationName": { + "type": "string" + }, + "LastCompleted": { + "type": "string", + "format": "date-time" + }, + "OutstandingAmount": { + "type": "number" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "OutstandingAmount": 1586.31, + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "296a5ec3-0efb-528d-9afd-7ab3b3c914c1", + "RelationName": "Stichting Mollie Payments", + "InstanceId": "8b0ecc00-2b87-4eaa-bd19-3b9db7f297c4", + "RelationType": "organisation" + }, + { + "OutstandingAmount": 28597.14, + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "RelationName": "AFAS Software B.V.", + "InstanceId": "072672c2-c859-4eef-a0be-7e760b57af6f", + "RelationType": "organisation" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Crediteuren" + ] + } + }, + "/api/creditorinvoicebalance": { + "get": { + "description": "Retrieve creditor invoice balance details for payable transactions", + "summary": "creditorinvoicebalance 1.0", + "operationId": "getconnector-creditorinvoicebalance-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "InvoiceNumber Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "InvoiceNumber": { + "type": "string" + }, + "InvoiceDate": { + "type": "string", + "format": "date-time" + }, + "CustomerReference": { + "type": "string" + }, + "DueDate": { + "type": "string", + "format": "date-time" + }, + "InternalInvoiceNumber": { + "type": "string" + }, + "InvoiceId": { + "type": "string", + "format": "uuid" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationName": { + "type": "string" + }, + "LastCompleted": { + "type": "string", + "format": "date-time" + }, + "OutstandingAmount": { + "type": "number" + }, + "PaidAmount": { + "type": "number" + }, + "ProcessingAmount": { + "type": "number" + }, + "TotalAmount": { + "type": "number" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "OutstandingAmount": 1586.31, + "PaidAmount": 0.0, + "ProcessingAmount": 0.0, + "TotalAmount": 1586.31, + "DueDate": "2024-12-13T00:00:00Z", + "InvoiceId": "1ae8da84-9dd1-427a-a636-25aa53162dbf", + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "InvoiceNumber": "123", + "InvoiceDate": "2024-12-13T00:00:00Z", + "CustomerReference": null, + "InternalInvoiceNumber": "IF240003", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "296a5ec3-0efb-528d-9afd-7ab3b3c914c1", + "RelationName": "Stichting Mollie Payments", + "InstanceId": "9ea0e72a-b424-485d-82b1-09363aefcdce", + "RelationType": "organisation" + }, + { + "OutstandingAmount": 28341.83, + "PaidAmount": 0.0, + "ProcessingAmount": 0.0, + "TotalAmount": 28341.83, + "DueDate": "2024-12-27T00:00:00Z", + "InvoiceId": "b3823933-d138-468a-a071-4e517feca9b9", + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "InvoiceNumber": "20241231", + "InvoiceDate": "2024-12-13T00:00:00Z", + "CustomerReference": null, + "InternalInvoiceNumber": "IF240001", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "RelationName": "AFAS Software B.V.", + "InstanceId": "b7e76bdf-1152-4d54-8224-ad6a421fc84f", + "RelationType": "organisation" + }, + { + "OutstandingAmount": 255.31, + "PaidAmount": 0.0, + "ProcessingAmount": 0.0, + "TotalAmount": 255.31, + "DueDate": "2025-01-14T00:00:00Z", + "InvoiceId": "6a25941f-2c35-4736-b963-6c63be0e82b4", + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "InvoiceNumber": "20241232", + "InvoiceDate": "2024-12-31T00:00:00Z", + "CustomerReference": null, + "InternalInvoiceNumber": "IF240002", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "RelationName": "AFAS Software B.V.", + "InstanceId": "ac5f3b30-6296-4864-86c6-cecede47984d", + "RelationType": "organisation" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Crediteuren" + ] + } + }, + "/api/debtorbalance": { + "get": { + "description": "Retrieve debtor balance information for customers", + "summary": "debtorbalance 2.0", + "operationId": "getconnector-debtorbalance-get-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "RelationName": { + "type": "string" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "LastCompleted": { + "type": "string", + "format": "date-time" + }, + "OutstandingAmount": { + "type": "number" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "OutstandingAmount": 684.86, + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "RelationName": "AFAS Software B.V.", + "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "InstanceId": "9b9c7f38-d059-4a9c-b3a0-3e0562bd0115", + "RelationType": "organisation" + }, + { + "OutstandingAmount": 640.09, + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "RelationName": "Mollie B.V.", + "RelationId": "3709fb45-c646-5cca-8de7-e6433404316a", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "InstanceId": "d33f3c36-d120-448c-92bd-0dbdeb2985bd", + "RelationType": "organisation" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Debiteuren" + ] + } + }, + "/api/debtorinvoicebalance": { + "get": { + "description": "Retrieve debtor invoice balance details for receivable transactions", + "summary": "debtorinvoicebalance 3.0", + "operationId": "getconnector-debtorinvoicebalance-get-3.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "3.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "InvoiceDate": { + "type": "string", + "format": "date-time" + }, + "DueDate": { + "type": "string", + "format": "date-time" + }, + "InvoiceNumber": { + "type": "string" + }, + "CustomerReference": { + "type": "string" + }, + "RelationName": { + "type": "string" + }, + "InvoiceId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "LastCompleted": { + "type": "string", + "format": "date-time" + }, + "OutstandingAmount": { + "type": "number" + }, + "TotalAmount": { + "type": "number" + }, + "PaidAmount": { + "type": "number" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "OutstandingAmount": 123.42, + "TotalAmount": 123.42, + "PaidAmount": 0.0, + "DueDate": "2024-12-27T00:00:00Z", + "InvoiceId": "a9095b6f-990d-4f5a-bda3-737939ab5fda", + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "InvoiceDate": "2024-12-13T00:00:00Z", + "InvoiceNumber": "VF240002", + "CustomerReference": null, + "RelationName": "AFAS Software B.V.", + "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "InstanceId": "206b831d-d5b1-43cd-a6d3-949bab3f45ee", + "RelationType": "organisation" + }, + { + "OutstandingAmount": 561.44, + "TotalAmount": 561.44, + "PaidAmount": 0.0, + "DueDate": "2024-12-27T00:00:00Z", + "InvoiceId": "157f441e-530d-4571-b6f7-e6681dc0ddac", + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "InvoiceDate": "2024-12-13T00:00:00Z", + "InvoiceNumber": "VF240001", + "CustomerReference": null, + "RelationName": "AFAS Software B.V.", + "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "InstanceId": "3f5ac81a-89d5-423d-ad2c-dea22585dc36", + "RelationType": "organisation" + }, + { + "OutstandingAmount": 640.09, + "TotalAmount": 640.09, + "PaidAmount": 0.0, + "DueDate": "2024-12-27T00:00:00Z", + "InvoiceId": "5fa9bfee-7a07-4ea9-b438-f19b3cdda6ca", + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "InvoiceDate": "2024-12-13T00:00:00Z", + "InvoiceNumber": "VF240003", + "CustomerReference": null, + "RelationName": "Mollie B.V.", + "RelationId": "3709fb45-c646-5cca-8de7-e6433404316a", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "InstanceId": "961616ec-27db-436c-bd86-eb95a46bb141", + "RelationType": "organisation" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "3.0", + "deprecated": false, + "tags": [ + "Debiteuren", + "Publiek: Externe facturatie" + ] + } + }, + "/api/debtorpaymentterms": { + "get": { + "description": "Retrieve payment terms configured for debtor relationships", + "summary": "debtorpaymentterms 1.0", + "operationId": "getconnector-debtorpaymentterms-get-1.0", + "parameters": [ + { + "in": "query", + "name": "BusinessActivityVersion", + "schema": { + "type": "integer" + } + }, + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministationId": { + "type": "string", + "format": "uuid" + }, + "OrganisationId": { + "type": "string", + "format": "uuid" + }, + "PersonId": { + "type": "string", + "format": "uuid" + }, + "UnknownRelationId": { + "type": "string", + "format": "uuid" + }, + "InvoiceDate": { + "type": "string", + "format": "date-time" + }, + "InvoiceId": { + "type": "string" + }, + "Address": { + "type": "string" + }, + "AddressId": { + "type": "string", + "format": "uuid" + }, + "DueDate": { + "type": "string", + "format": "date-time" + }, + "RelationId": { + "type": "string" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "DueDate": "2024-02-16T00:00:00Z", + "AdministationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "InvoiceDate": "2024-02-02T00:00:00Z", + "InvoiceId": "V01240018", + "CustomerId": "c9e0fced-a61e-544e-b7ca-3e0428579f9f", + "CustomerName": "Administratiekantoor Beers", + "OrganisationId": "bb3fd8ef-5a0e-5919-8e67-77b396abf212", + "AddressId": "9e009e67-42d5-508c-9939-eb09cadb8f81", + "Address": "Postbus 779, 2700 AT, Zoetermeer, Nederland" + }, + { + "DueDate": "2024-02-02T00:00:00Z", + "AdministationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "InvoiceDate": "2024-01-19T00:00:00Z", + "InvoiceId": "V01240012", + "CustomerId": "c6734a65-7205-59e7-9777-ed5aef340c68", + "CustomerName": "Bus Grondstoffen B.V.", + "OrganisationId": "1ac6ea9d-9a7f-54f4-b9ef-fe161a55d9f6", + "AddressId": "b6fc9651-1785-53f9-9862-d7a2c84d664b", + "Address": "Eerste Tochtweg 2, 2913 LP, Capelle aan den IJssel, Nederland" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Debiteuren" + ] + } + }, + "/api/featuretoggles": { + "get": { + "description": "Retrieve feature toggle settings and configurations", + "summary": "featuretoggles 1.0", + "operationId": "getconnector-featuretoggles-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "SalesInvoices": { + "type": "boolean" + }, + "SalesJournalEntries": { + "type": "boolean" + }, + "LinesToBeInvoiced": { + "type": "boolean" + }, + "Projects": { + "type": "boolean" + }, + "Supplies": { + "type": "boolean" + }, + "Services": { + "type": "boolean" + }, + "FixedAssets": { + "type": "boolean" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "LinesToBeInvoiced": false, + "Projects": false, + "Supplies": true, + "Services": true, + "FixedAssets": true + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "LinesToBeInvoiced": false, + "Projects": false, + "Supplies": true, + "Services": true, + "FixedAssets": true + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "TechnischeInfo" + ] + } + }, + "/api/journalentries": { + "get": { + "description": "Retrieve journal entries for financial bookkeeping", + "summary": "journalentries 1.1", + "operationId": "getconnector-journalentries-get-1.1", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.1" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "HeaderId": { + "type": "string", + "format": "uuid" + }, + "LineId": { + "type": "string", + "format": "uuid" + }, + "AccountingPeriodId": { + "type": "string", + "format": "uuid" + }, + "AccountingYearId": { + "type": "string", + "format": "uuid" + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid" + }, + "AmountDebit": { + "type": "number" + }, + "AmountCredit": { + "type": "number" + }, + "AmountTotal": { + "type": "number" + }, + "Number": { + "type": "string" + }, + "PostingDate": { + "type": "string", + "format": "date-time" + }, + "Description": { + "type": "string" + }, + "DocumentIdentification": { + "type": "string" + }, + "DocumentDate": { + "type": "string", + "format": "date-time" + }, + "VatPercentage": { + "type": "number" + }, + "VatSection": { + "oneOf": [ + { + "const": "Rubriek1a", + "title": "1a verkopen hoog" + }, + { + "const": "Rubriek1b", + "title": "1b verkopen laag" + }, + { + "const": "Rubriek1c", + "title": "1c verkopen overige tarieven" + }, + { + "const": "Rubriek1d", + "title": "1d btw privé" + }, + { + "const": "Rubriek2a", + "title": "2a/5b inkopen verlegd" + }, + { + "const": "Rubriek3a", + "title": "3a verkopen buiten de EU" + }, + { + "const": "Rubriek3b", + "title": "3b verkopen binnen de EU" + }, + { + "const": "Rubriek3c", + "title": "3c afstandsverkopen" + }, + { + "const": "Rubriek4a", + "title": "4a/5b inkopen buiten de EU" + }, + { + "const": "Rubriek4b", + "title": "4b/5b inkopen binnen de EU" + }, + { + "const": "Rubriek5b", + "title": "5b voorbelasting" + }, + { + "const": "Rubriek1e", + "title": "1e verkopen 0%" + } + ] + }, + "VatAmount": { + "type": "number" + }, + "AuditCreatedOnDate": { + "type": "string", + "format": "date-time" + } + } + } + }, + "examples": { + "journalentries": { + "value": [ + { + "LineId": "20a899d9-7a95-56f7-a54b-000b17fb8d24", + "AmountDebit": 3932.17, + "AmountCredit": 0.0, + "AmountTotal": 3932.17, + "VatPercentage": null, + "VatSection": null, + "VatAmount": null, + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "HeaderId": "938afbd9-f317-53af-bcde-b1c8e5d28472", + "Number": "2477", + "PostingDate": "2022-10-31T00:00:00Z", + "DocumentDate": "2022-10-31T00:00:00Z", + "AccountingPeriodId": "59aaf644-e6da-45eb-962f-bc37555d4262", + "AccountingYearId": "f37fc13c-870f-45ae-96e1-a5fa70c861c1", + "LedgerAccountId": "349016af-3fa7-5b11-b77d-454cc05a17ee", + "Description": "Overige uitgave - NL77ABNA0441631347 - Salarisbetaling", + "DocumentIdentification": null + }, + { + "LineId": "a34bf47d-ecab-5185-b4ac-002cdb062855", + "AmountDebit": 88.94, + "AmountCredit": 0.0, + "AmountTotal": 88.94, + "VatPercentage": null, + "VatSection": null, + "VatAmount": null, + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "HeaderId": "c0c3b86b-a023-5838-9353-ceb1ab7198fa", + "Number": "2112", + "PostingDate": "2024-04-02T00:00:00Z", + "DocumentDate": "2024-03-15T00:00:00Z", + "AccountingPeriodId": "49a93c26-2f8c-44c3-9be2-552f3b6a8fce", + "AccountingYearId": "cc0b784f-a591-4e37-8cb4-ba06374d18df", + "LedgerAccountId": "78685f08-fb5c-593f-a7d8-b4ed2886ef9d", + "Description": "Verkoopfactuur - Erbi Lara B.V.", + "DocumentIdentification": "V01240034" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.1", + "deprecated": false, + "tags": [ + "Financiele rapportage" + ] + } + }, + "/api/ledgeraccounts": { + "get": { + "description": "Retrieve all ledger accounts", + "summary": "ledgeraccounts 1.0", + "operationId": "getconnector-ledgeraccounts-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + }, + "LedgerAccountNumber": { + "type": "string" + }, + "TypeId": { + "oneOf": [ + { + "const": "Activa", + "title": "activa" + }, + { + "const": "Kosten", + "title": "kosten" + }, + { + "const": "Opbrengsten", + "title": "opbrengsten" + }, + { + "const": "Passiva", + "title": "passiva" + } + ] + }, + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "InvestInAsset": { + "type": "boolean" + } + } + } + }, + "examples": { + "ledgeraccounts": { + "value": [ + { + "Id": "cfb59b79-b3ec-55ef-8cde-000499c3179e", + "Description": "Omzet Algemeen", + "LedgerAccountNumber": "8000", + "TypeId": "aae9334f-0fa8-43cb-ad52-cff973b4c863", + "InstanceId": "cfb59b79-b3ec-55ef-8cde-000499c3179e", + "InvestInAsset": false, + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911" + }, + { + "Id": "68730415-2a59-50ce-9968-00303319780d", + "Description": "Schepen", + "LedgerAccountNumber": "0247", + "TypeId": "980eb36a-8bec-45d9-97f6-06dd2c551818", + "InstanceId": "68730415-2a59-50ce-9968-00303319780d", + "InvestInAsset": true, + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële dashboarding", + "Publiek: Financiële journaalpost", + "Financiële journaalpost", + "Publiek: Financiële rapportage", + "Financiele rapportage", + "Loonjournaalpost", + "Publiek: POS Transacties", + "POS Transacties", + "Inkoopjournaalpost", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/ledgerperiodtotals": { + "get": { + "description": "Retrieve ledger account totals grouped by period for reporting", + "summary": "ledgerperiodtotals 1.0", + "operationId": "getconnector-ledgerperiodtotals-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "AccountingYear": { + "type": "string" + }, + "AccountingYearId": { + "type": "string", + "format": "uuid" + }, + "AccountingYearStartDate": { + "type": "string", + "format": "date-time" + }, + "AccountingYearEndDate": { + "type": "string", + "format": "date-time" + }, + "AccountingPeriod": { + "type": "string" + }, + "AccountingPeriodId": { + "type": "string", + "format": "uuid" + }, + "AccountingPeriodStartDate": { + "type": "string", + "format": "date-time" + }, + "AccountingPeriodEndDate": { + "type": "string", + "format": "date-time" + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid" + }, + "LedgerAccount": { + "type": "string" + }, + "IsOpeningBalance": { + "type": "boolean" + }, + "RgsCode": { + "type": "string" + }, + "RgsDescription": { + "type": "string" + }, + "LedgerAccountNumber": { + "type": "string" + }, + "Total": { + "type": "number" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "Total": -210.0, + "IsOpeningBalance": false, + "AdministrationId": "4fef7d35-e93c-4cb2-b367-0deb692e5647", + "AccountingYearId": "2ebff944-f3d0-4335-a3b7-ff637df54ca4", + "AccountingYear": "2024", + "AccountingYearStartDate": "2024-01-01T00:00:00Z", + "AccountingYearEndDate": "2024-12-31T00:00:00Z", + "AccountingPeriodId": "c2ebc6d5-c5af-4bb5-8fea-2e8a7e91399c", + "AccountingPeriod": "Januari 2024", + "AccountingPeriodStartDate": "2024-01-01T00:00:00Z", + "AccountingPeriodEndDate": "2024-01-31T00:00:00Z", + "LedgerAccountId": "90aee254-9eeb-56af-abe2-064fffbd1c00", + "LedgerAccount": "Te betalen btw (1800)", + "LedgerAccountNumber": "90aee254-9eeb-56af-abe2-064fffbd1c00", + "RgsCode": "BSchBepBtw", + "RgsDescription": "Te betalen Omzetbelasting", + "InstanceId": "b0c63c7b-5b65-469a-bbdf-319579d649b4" + }, + { + "Total": -1000.0, + "IsOpeningBalance": false, + "AdministrationId": "4fef7d35-e93c-4cb2-b367-0deb692e5647", + "AccountingYearId": "2ebff944-f3d0-4335-a3b7-ff637df54ca4", + "AccountingYear": "2024", + "AccountingYearStartDate": "2024-01-01T00:00:00Z", + "AccountingYearEndDate": "2024-12-31T00:00:00Z", + "AccountingPeriodId": "c2ebc6d5-c5af-4bb5-8fea-2e8a7e91399c", + "AccountingPeriod": "Januari 2024", + "AccountingPeriodStartDate": "2024-01-01T00:00:00Z", + "AccountingPeriodEndDate": "2024-01-31T00:00:00Z", + "LedgerAccountId": "8aa84f79-4892-5cae-b6d1-2e4f9365b892", + "LedgerAccount": "Omzet groep 1 (8000)", + "LedgerAccountNumber": "8aa84f79-4892-5cae-b6d1-2e4f9365b892", + "RgsCode": "WOmzGrpGr1", + "RgsDescription": "Netto-omzet groep 1", + "InstanceId": "89bd2a01-d2e0-418d-9585-5c25f5b471e4" + }, + { + "Total": 1210.0, + "IsOpeningBalance": false, + "AdministrationId": "4fef7d35-e93c-4cb2-b367-0deb692e5647", + "AccountingYearId": "2ebff944-f3d0-4335-a3b7-ff637df54ca4", + "AccountingYear": "2024", + "AccountingYearStartDate": "2024-01-01T00:00:00Z", + "AccountingYearEndDate": "2024-12-31T00:00:00Z", + "AccountingPeriodId": "c2ebc6d5-c5af-4bb5-8fea-2e8a7e91399c", + "AccountingPeriod": "Januari 2024", + "AccountingPeriodStartDate": "2024-01-01T00:00:00Z", + "AccountingPeriodEndDate": "2024-01-31T00:00:00Z", + "LedgerAccountId": "2fc1ada7-a66a-5b4b-9644-af29d46865c5", + "LedgerAccount": "Debiteuren (1300)", + "LedgerAccountNumber": "2fc1ada7-a66a-5b4b-9644-af29d46865c5", + "RgsCode": "BVorDebHad", + "RgsDescription": "Handelsdebiteuren nominaal", + "InstanceId": "cf9671f4-96c3-40f6-8048-ebc86c1f2dc4" + }, + { + "Total": -1000.0, + "IsOpeningBalance": false, + "AdministrationId": "4fef7d35-e93c-4cb2-b367-0deb692e5647", + "AccountingYearId": "2ebff944-f3d0-4335-a3b7-ff637df54ca4", + "AccountingYear": "2024", + "AccountingYearStartDate": "2024-01-01T00:00:00Z", + "AccountingYearEndDate": "2024-12-31T00:00:00Z", + "AccountingPeriodId": "c2ebc6d5-c5af-4bb5-8fea-2e8a7e91399c", + "AccountingPeriod": "Januari 2024", + "AccountingPeriodStartDate": "2024-01-01T00:00:00Z", + "AccountingPeriodEndDate": "2024-01-31T00:00:00Z", + "LedgerAccountId": "38b36a37-32a8-5775-8d3a-b118dd32f77a", + "LedgerAccount": "Onverdeeld resultaat (0900)", + "LedgerAccountNumber": "38b36a37-32a8-5775-8d3a-b118dd32f77a", + "RgsCode": "BEivOreOvw", + "RgsDescription": "Niet verdeelde winst", + "InstanceId": "36bc8088-7d06-42b5-9ea1-06d47d4a4fd1" + }, + { + "Total": 1000.0, + "IsOpeningBalance": false, + "AdministrationId": "4fef7d35-e93c-4cb2-b367-0deb692e5647", + "AccountingYearId": "2ebff944-f3d0-4335-a3b7-ff637df54ca4", + "AccountingYear": "2024", + "AccountingYearStartDate": "2024-01-01T00:00:00Z", + "AccountingYearEndDate": "2024-12-31T00:00:00Z", + "AccountingPeriodId": "c2ebc6d5-c5af-4bb5-8fea-2e8a7e91399c", + "AccountingPeriod": "Januari 2024", + "AccountingPeriodStartDate": "2024-01-01T00:00:00Z", + "AccountingPeriodEndDate": "2024-01-31T00:00:00Z", + "LedgerAccountId": "e8485631-976a-55f6-8c16-c031723460b1", + "LedgerAccount": "Overboeking van het resultaat (9999)", + "LedgerAccountNumber": "e8485631-976a-55f6-8c16-c031723460b1", + "RgsCode": "ResultaatNiveau2", + "RgsDescription": "Resultaat", + "InstanceId": "4e7b8b7d-d577-4cdd-9748-20e4742b8880" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële dashboarding", + "Publiek: Financiële rapportage", + "Financiele rapportage" + ] + } + }, + "/api/linestobeinvoiced": { + "get": { + "description": "Retrieve lines that are pending to be invoiced", + "summary": "linestobeinvoiced 1.0", + "operationId": "getconnector-linestobeinvoiced-get-1.0", + "parameters": [ + { + "in": "query", + "name": "BusinessActivityVersion", + "schema": { + "type": "integer" + } + }, + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "InstanceId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationNumber": { + "type": "string" + }, + "RelationDescription": { + "type": "string" + }, + "ProductId": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + }, + "Quantity": { + "type": "number" + }, + "Price": { + "type": "number" + }, + "TotalAmount": { + "type": "number" + }, + "ProjectId": { + "type": "string", + "format": "uuid" + }, + "ProjectDescription": { + "type": "string" + }, + "Status": { + "oneOf": [ + { + "const": "TODO", + "title": "te factureren" + }, + { + "const": "BUSY", + "title": "onderweg" + }, + { + "const": "DONE", + "title": "gefactureerd" + }, + { + "const": "DONEEDIT", + "title": "bezig met wijzigen van gefactureerd" + }, + { + "const": "DONEERROR", + "title": "in fout staat" + }, + { + "const": "REDO", + "title": "opnieuw te factureren" + }, + { + "const": "CANNOTBEDONE", + "title": "niet te factureren" + }, + { + "const": "CANNOTBEREDONE", + "title": "niet opnieuw te factureren" + }, + { + "const": "TOCREDIT", + "title": "te crediteren" + }, + { + "const": "CREDITED", + "title": "gecrediteerd" + }, + { + "const": "DELETED", + "title": "verwijderd" + }, + { + "const": "TODOERROR", + "title": "in fout staat" + }, + { + "const": "TODOEDIT", + "title": "bezig met wijzigen van te factureren" + }, + { + "const": "TODOPENDING", + "title": "bezig met wachten" + }, + { + "const": "REPLACED", + "title": "gespecificeerd" + }, + { + "const": "TOSPECIFY", + "title": "af te letteren" + }, + { + "const": "SPECIFIED", + "title": "afgeletterd" + }, + { + "const": "ALTERNATIVELYSPECIFIED", + "title": "alternatief gespecificeerd" + }, + { + "const": "INITIALIZED", + "title": "geïnitialiseerd" + }, + { + "const": "INITIALIZEDEDIT", + "title": "geïnitialiseerd" + }, + { + "const": "PENDINGAPPROVAL", + "title": "te accorderen" + }, + { + "const": "PENDINGCOMPLETION", + "title": "te factureren" + }, + { + "const": "COMPLETED", + "title": "gefactureerd" + }, + { + "const": "DECLINED", + "title": "afgewezen" + }, + { + "const": "TEMPLATE", + "title": "sjabloon" + }, + { + "const": "TEMPLATEEDIT", + "title": "bezig met wijzigen van factureren" + }, + { + "const": "TEMPLATEERROR", + "title": "in fout staat" + } + ] + }, + "SalesInvoiceNumber": { + "type": "string" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "InstanceId": "fcb31b25-8da1-4a90-ae33-a93d932184f0", + "Ownorganization": { + "Id": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "ComponentId": "cbb9b7ef-ef04-4c84-9e80-4989bd526865" + }, + "DatumGepland": "2024-12-04T00:00:00Z", + "Klant": { + "Id": "509e24de-67fb-4e02-b149-f8c615fef64c", + "ComponentId": "8e352e23-04af-45b7-952a-0afc7575ea7a" + }, + "ProjectKoppelen": true, + "Project": { + "Id": "e03c053d-3e72-400b-821d-c3398edf1ccc", + "ComponentId": "497fc9c2-340d-4d18-b097-c6bbd06bbab7" + }, + "Verkoopproduct": { + "Id": "aaf04330-151c-44d9-9700-8793b1c0d4b4", + "ComponentId": "230b4172-613e-4e1b-9ed5-93496c4eed6b" + }, + "Description": "AFAS Software B.V. (000003) - 04-12-2024", + "Aantal": 32.0, + "Prijs": 539.7, + "Bedrag": 17270.4, + "MethodeBepalenPrijs": "52085b0b-a85a-418e-8e33-a00e48666512", + "Status": "692a0b09-b83b-44cb-b75a-e431eb66302f", + "KlantDescription": "AFAS Software B.V. (000003)", + "ProjectDescription": "Implementation Exceptional", + "VerkoopproductDescription": "Acer Laptop (3320, 000001)" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels" + ] + }, + "post": { + "description": "Create lines to be invoiced for billing processes", + "summary": "linestobeinvoiced 1.0", + "operationId": "updateconnector-linestobeinvoiced-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "linestobeinvoiced 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/linestobeinvoiced-1.0-Create-JsonSchema" + }, + "examples": { + "new linestobeinvoiced": { + "value": { + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "Date": "2024-12-04", + "Description": "Dell Laptop", + "RelationType": "organisation", + "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "ItemId": "aaf04330-151c-44d9-9700-8793b1c0d4b4", + "Quantity": 32, + "ProjectId": "e03c053d-3e72-400b-821d-c3398edf1ccc" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "succes": { + "value": { + "result": "Succeeded", + "traceId": "3614178a-f801-47b7-bae1-dad6439f2c54", + "data": { + "LinesToBeInvoiced": "fcb31b25-8da1-4a90-ae33-a93d932184f0" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "LinesToBeInvoiced": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + }, + "400": { + "content": { + "application/json": { + "examples": { + "not enabled": { + "value": { + "result": "Failed", + "traceId": "339ee3cf-e6bb-4201-9fd0-577906f9f96a", + "instances": [], + "errors": [ + "FeatureToggle not enabled" + ] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "instances": { + "type": "array", + "items": {} + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels" + ] + }, + "delete": { + "description": "Delete lines to be invoiced from billing processes", + "summary": "linestobeinvoiced 1.0", + "operationId": "updateconnector-linestobeinvoiced-Delete-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "linestobeinvoiced 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/linestobeinvoiced-1.0-Delete-JsonSchema" + }, + "examples": { + "minimal": { + "value": { + "AdministrationId": "e877fb82-b546-4d20-94cf-05c72765fc47", + "Id": "e877fb82-b546-4d20-94cf-05c72765fc47" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "success": { + "value": { + "result": "Succeeded", + "traceId": "3614178a-f801-47b7-bae1-dad6439f2c54", + "data": { + "LinesToBeInvoiced": "fcb31b25-8da1-4a90-ae33-a93d932184f0" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "LinesToBeInvoiced": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels" + ] + }, + "put": { + "description": "Update lines to be invoiced for billing processes", + "summary": "linestobeinvoiced 1.0", + "operationId": "updateconnector-linestobeinvoiced-Put-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "linestobeinvoiced 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/linestobeinvoiced-1.0-Update-JsonSchema" + }, + "examples": { + "example": { + "value": { + "LineToBeInvoicedId": "547a03a2-19c9-4058-bc77-452063b25d6d", + "AdministrationId": "5c86c621-14fc-5d09-a387-772c599caa5d", + "Date": "2024-11-04", + "Description": "Dell Laptop", + "RelationType": "organisation", + "RelationId": "30bf2fcc-306d-5680-9e03-d99fbfe46bc2", + "ItemId": "4689e028-02c7-5324-885a-556701bd1a9f", + "Quantity": 50 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "succes": { + "value": { + "result": "Succeeded", + "traceId": "3614178a-f801-47b7-bae1-dad6439f2c54", + "data": { + "LinesToBeInvoiced": "fcb31b25-8da1-4a90-ae33-a93d932184f0" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "LinesToBeInvoiced": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels" + ] + } + }, + "/api/organisations": { + "get": { + "description": "Retrieve organization information and business details", + "summary": "organisations 2.0", + "operationId": "getconnector-organisations-get-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Name": { + "type": "string" + }, + "CocNumber": { + "type": "string" + }, + "VatNumber": { + "type": "string" + }, + "PhoneNumber": { + "type": "string" + }, + "EmailAddress": { + "type": "string" + }, + "SbiCode": { + "type": "string" + }, + "RelationId": { + "type": "string" + }, + "ExternalId": { + "type": "string" + }, + "IsArchived": { + "type": "boolean" + } + } + } + }, + "examples": { + "example": { + "value": { + "TrackingToken": "202401291319301", + "Result": [ + { + "Id": "e36e77f0-9a1c-50d0-a3f3-004f1fee8720", + "Name": "Erbi Lara B.V. (000019)", + "CocNumber": null, + "VatNumber": null, + "RelationId": "000019", + "ExternalId": null, + "IsArchived": false, + "EmailAddress": "info@erbilara.afas" + }, + { + "Id": "45aafd00-a21b-5440-bf57-0aa5fa6c2294", + "Name": "Alsach Musik GmbH (000037)", + "CocNumber": null, + "VatNumber": "DE184475234", + "RelationId": "000037", + "ExternalId": null, + "IsArchived": false, + "EmailAddress": "info@alsachmusic.afasde" + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Inkoopjournaalpost", + "Publiek: Relatiemanagement", + "Relaties", + "Publiek: Facturatie", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/paymentconditions": { + "get": { + "description": "Retrieve payment conditions and terms settings", + "summary": "paymentconditions 1.0", + "operationId": "getconnector-paymentconditions-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "Id": "9b5d768a-c71b-583e-b6ee-09d64aa935d4", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "Description": "21 dagen" + }, + { + "Id": "b8ca9e8d-6fef-5ef6-95ba-0bd221aebc6f", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "Description": "60 dagen" + }, + { + "Id": "a59bab3a-36bb-5974-bdad-276f6395d6b6", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "Description": "14 dagen" + }, + { + "Id": "b98e24e9-a611-5a98-8cf9-40fed321dc6c", + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "60 dagen" + }, + { + "Id": "c06d2eb9-1332-5e78-a8b3-58dd62dcee45", + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "7 dagen" + }, + { + "Id": "0066f624-c140-5262-9fbb-5e3141d32876", + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "14 dagen" + }, + { + "Id": "eb44c60d-06e4-564b-a90c-7715c78788a5", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "Description": "45 dagen" + }, + { + "Id": "a629b70b-6a91-5906-9f9d-97f83dfd0c58", + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "90 dagen" + }, + { + "Id": "ab8b0914-74a2-5db5-a948-ae34ea6b7f7e", + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "30 dagen" + }, + { + "Id": "2d8304eb-1472-5fad-8fed-b1c30b2a1749", + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "21 dagen" + }, + { + "Id": "3bed98d9-94d0-5147-9cb8-cad047a0b9bd", + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "45 dagen" + }, + { + "Id": "6372c28d-7468-5c58-8826-cea9bf70758a", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "Description": "90 dagen" + }, + { + "Id": "4a09121c-4f48-5a29-9cef-ecfb5bb74dcf", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "Description": "7 dagen" + }, + { + "Id": "596a0343-fd85-597a-8918-ed3198de119d", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "Description": "30 dagen" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Inkoopjournaalpost", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/persons": { + "get": { + "description": "Retrieve person information and personal details", + "summary": "persons 2.0", + "operationId": "getconnector-persons-get-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Name": { + "type": "string" + }, + "FirstName": { + "type": "string" + }, + "Initials": { + "type": "string" + }, + "Prefix": { + "type": "string" + }, + "Lastname": { + "type": "string" + }, + "PhoneNumber": { + "type": "string" + }, + "EmailAddress": { + "type": "string" + }, + "ExternalId": { + "type": "string" + }, + "IsArchived": { + "type": "boolean" + } + } + } + }, + "examples": { + "example": { + "value": { + "TrackingToken": "202401291327471", + "Result": [ + { + "Id": "2aacc092-9c6c-5020-b1cf-0d8ecd6485dc", + "Name": "Cas de Graaf", + "FirstName": "Cas", + "Initials": "C.", + "Prefix": "de", + "Lastname": "Graaf", + "ExternalId": null, + "IsArchived": false + }, + { + "Id": "1242493d-bd93-53b3-9852-1c82c83316aa", + "Name": "Tarik el Erdol", + "FirstName": "Tarik", + "Initials": "T.", + "Prefix": "el", + "Lastname": "Erdol", + "ExternalId": null, + "IsArchived": false + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Inkoopjournaalpost", + "Publiek: Relatiemanagement", + "Relaties", + "Publiek: Facturatie", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/products": { + "get": { + "description": "Retrieve product catalog with pricing and inventory information", + "summary": "products 3.0", + "operationId": "getconnector-products-get-3.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "3.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "Id": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + }, + "Code": { + "type": "string" + }, + "InternalId": { + "type": "string" + }, + "PriceExcludingVAT": { + "type": "number" + }, + "PriceIncludingVAT": { + "type": "number" + }, + "ProductGroup": { + "type": "string" + }, + "Barcode": { + "type": "string" + }, + "Category": { + "type": "string" + }, + "ExtraDescription": { + "type": "string" + }, + "ProductStyle": { + "oneOf": [ + { + "const": "AantalVanSoort", + "title": "aantal van soort" + }, + { + "const": "Afdeling", + "title": "afdeling" + }, + { + "const": "Bankrekening", + "title": "bankrekening" + }, + { + "const": "Contactpersoon", + "title": "contactpersoon" + }, + { + "const": "Deelname", + "title": "deelname" + }, + { + "const": "Gegeven", + "title": "gegeven" + }, + { + "const": "Goed", + "title": "goed" + }, + { + "const": "Kas", + "title": "kas" + }, + { + "const": "Kosten", + "title": "kosten" + }, + { + "const": "Land", + "title": "land" + }, + { + "const": "Onbekend", + "title": "onbekend" + }, + { + "const": "Organisatie", + "title": "organisatie" + }, + { + "const": "Persoon", + "title": "persoon" + }, + { + "const": "Ruimte", + "title": "ruimte" + }, + { + "const": "Tijd", + "title": "tijd" + } + ] + }, + "IsArchived": { + "type": "boolean" + }, + "IsBlocked": { + "type": "boolean" + }, + "IsDisabled": { + "type": "boolean" + }, + "Blob": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "ReadKey": { + "type": "string" + }, + "FileName": { + "type": "string" + }, + "ContentType": { + "type": "string" + }, + "ContentLength": { + "type": "number" + } + } + } + } + } + }, + "examples": { + "example": { + "value": { + "TrackingToken": "202504011910441", + "Result": [ + { + "Id": "c38525f4-845d-5dd8-9b3a-00eec99c34ab", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Vast actief (btw nul)", + "InternalId": null, + "Barcode": null, + "Category": null, + "ProductStyle": "d55d181a-4ab5-4d68-9296-4fbd534cc998", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 0.0, + "ProductGroup": "Vaste activa", + "ProductType": "unknown" + }, + { + "Id": "f469cfc6-1b8b-587f-9ac6-10a975e5edcd", + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "Description": "Vast actief (btw hoog)", + "InternalId": null, + "Barcode": null, + "Category": null, + "ProductStyle": "d55d181a-4ab5-4d68-9296-4fbd534cc998", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 0.0, + "ProductGroup": "Vaste activa", + "ProductType": "unknown" + }, + { + "Id": "c4617493-a611-59ea-9a0c-293391c3466e", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Bouwen (2002, 000017)", + "InternalId": "000017", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 75.0, + "ProductGroup": "Web Design", + "ProductType": "supplies" + }, + { + "Id": "7f54afa4-dc32-5538-be15-4279863ca5e6", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Muis Logitech (5100, 000004)", + "InternalId": "000004", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 9.98, + "ProductGroup": "Randapparatuur", + "ProductType": "supplies" + }, + { + "Id": "6d5a94f4-6911-5771-9517-4420b101439a", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Draadloos toestenbord + muis Lenovo (5003, 000011)", + "InternalId": "000011", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 67.73, + "ProductGroup": "Randapparatuur", + "ProductType": "supplies" + }, + { + "Id": "411a8c24-5406-5bd6-9fd1-5425a67130c9", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Lenovo Monitor 24 inch (4201, 000012)", + "InternalId": "000012", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 340.73, + "ProductGroup": "Monitoren", + "ProductType": "supplies" + }, + { + "Id": "5dbb40d7-52b5-51b6-809e-5a16dddeb650", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Draadloos toetsenbord + muis Logitech (5002, 000010)", + "InternalId": "000010", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 29.93, + "ProductGroup": "Randapparatuur", + "ProductType": "supplies" + }, + { + "Id": "f871b91d-bb1e-5f52-a70c-5cddf2108929", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Acer Laptop (3320, 000008)", + "InternalId": "000008", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 539.7, + "ProductGroup": "Systemen", + "ProductType": "supplies" + }, + { + "Id": "db17280f-6105-5d22-975b-6c4e49c8682f", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Klassiek (Qwerty) toetsenbord Logitech (5000, 000003)", + "InternalId": "000003", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 13.65, + "ProductGroup": "Randapparatuur", + "ProductType": "supplies" + }, + { + "Id": "347d7d36-994b-5b4d-80a1-9a15532e6035", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Dell Monitor 24 inch (4003, 000009)", + "InternalId": "000009", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 240.98, + "ProductGroup": "Monitoren", + "ProductType": "supplies" + }, + { + "Id": "d1247d55-a298-55ca-bb55-9ed75bdc7c34", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Ontwerpen (2001, 000019)", + "InternalId": "000019", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 75.0, + "ProductGroup": "Web Design", + "ProductType": "supplies" + }, + { + "Id": "f4b51c75-1e2b-522a-aca2-a2dd8eab3a24", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Management Fee (MF, 000013)", + "InternalId": "000013", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 8825.0, + "ProductGroup": "Management Fee", + "ProductType": "supplies" + }, + { + "Id": "f4b51c75-1e2b-522a-aca2-a2dd8eab3a24", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Management Fee (MF, 000013)", + "InternalId": "000013", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 8000.0, + "ProductGroup": "Management Fee", + "ProductType": "supplies" + }, + { + "Id": "1be89d6d-9d74-53f4-af12-aa22bc76d896", + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "Description": "Vast actief (btw laag)", + "InternalId": null, + "Barcode": null, + "Category": null, + "ProductStyle": "d55d181a-4ab5-4d68-9296-4fbd534cc998", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 0.0, + "ProductGroup": "Vaste activa", + "ProductType": "unknown" + }, + { + "Id": "f84c1bb4-9de9-578f-989e-ae39a19e3cb7", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Vast actief (btw hoog)", + "InternalId": null, + "Barcode": null, + "Category": null, + "ProductStyle": "d55d181a-4ab5-4d68-9296-4fbd534cc998", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 0.0, + "ProductGroup": "Vaste activa", + "ProductType": "unknown" + }, + { + "Id": "e4a2db09-8534-55f1-8bfc-b30a40024f5e", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Microsoft Office 365 gebruikerstraining (1000, 000015)", + "InternalId": "000015", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 995.0, + "ProductGroup": "Cursussen", + "ProductType": "supplies" + }, + { + "Id": "a48526d9-3bb2-57e0-b4c2-b43f0ab137b5", + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "Description": "Vast actief (btw nul)", + "InternalId": null, + "Barcode": null, + "Category": null, + "ProductStyle": "d55d181a-4ab5-4d68-9296-4fbd534cc998", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 0.0, + "ProductGroup": "Vaste activa", + "ProductType": "unknown" + }, + { + "Id": "171cc8aa-d9bd-5800-ad05-c1b38878d584", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Onderhoud (2003, 000018)", + "InternalId": "000018", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 75.0, + "ProductGroup": "Web Design", + "ProductType": "supplies" + }, + { + "Id": "ea4fcede-5143-5860-ab4e-c763cfae25f0", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Projectleiding (2000, 000014)", + "InternalId": "000014", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 95.0, + "ProductGroup": "Web Design", + "ProductType": "supplies" + }, + { + "Id": "aa760e86-92da-50d1-bdb7-c873a9443264", + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "Description": "Management Fee (MF, 000013)", + "InternalId": "000013", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 8825.0, + "ProductGroup": "Management Fee", + "ProductType": "supplies" + }, + { + "Id": "aa760e86-92da-50d1-bdb7-c873a9443264", + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "Description": "Management Fee (MF, 000013)", + "InternalId": "000013", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 8000.0, + "ProductGroup": "Management Fee", + "ProductType": "supplies" + }, + { + "Id": "f766cf32-c4a2-5123-bbe9-d69b9ce8b37b", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Diverse producten", + "InternalId": null, + "Barcode": null, + "Category": null, + "ProductStyle": "d55d181a-4ab5-4d68-9296-4fbd534cc998", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "ProductGroup": "Diverse producten", + "ProductType": "unknown" + }, + { + "Id": "4ac33af1-ae7d-5923-9506-e1dedf7b7c14", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Lenovo Laptop (3330, 000002)", + "InternalId": "000002", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 431.55, + "ProductGroup": "Systemen", + "ProductType": "supplies" + }, + { + "Id": "c35a780e-c4ba-504c-a54f-e1eee1d16dce", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Draadloos toestenbord + muis Dell (5102, 000006)", + "InternalId": "000006", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 36.75, + "ProductGroup": "Randapparatuur", + "ProductType": "supplies" + }, + { + "Id": "1048caf1-d7bb-52e9-a638-e525d375e672", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Acer Monitor 24 inch (4104, 000001)", + "InternalId": "000001", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 519.23, + "ProductGroup": "Monitoren", + "ProductType": "supplies" + }, + { + "Id": "b1b6cf37-3ec0-52b5-bde7-e5c34a0dbdb8", + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "Description": "Diverse producten", + "InternalId": null, + "Barcode": null, + "Category": null, + "ProductStyle": "d55d181a-4ab5-4d68-9296-4fbd534cc998", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "ProductGroup": "Diverse producten", + "ProductType": "unknown" + }, + { + "Id": "dd306400-eb3c-594a-91bd-e7291250f90f", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Vast actief (btw laag)", + "InternalId": null, + "Barcode": null, + "Category": null, + "ProductStyle": "d55d181a-4ab5-4d68-9296-4fbd534cc998", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 0.0, + "ProductGroup": "Vaste activa", + "ProductType": "unknown" + }, + { + "Id": "e974bd03-fe5f-5d70-a3ef-ec6f4485143a", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Dell Laptop (3310, 000005)", + "InternalId": "000005", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 205.28, + "ProductGroup": "Systemen", + "ProductType": "supplies" + }, + { + "Id": "01911013-b8ba-5dfd-a250-fa7f6f709220", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Samsung Monitor 32 inch (4203, 000007)", + "InternalId": "000007", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 822.15, + "ProductGroup": "Monitoren", + "ProductType": "supplies" + }, + { + "Id": "ce109323-b122-5acd-bd3a-fbc9ff934f9a", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Microsoft Power Platform App maker (1001, 000016)", + "InternalId": "000016", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 250.0, + "ProductGroup": "Cursussen", + "ProductType": "supplies" + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "3.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Publiek: Facturatie", + "Verkoopfactuur" + ] + } + }, + "/api/projects": { + "get": { + "description": "Retrieve project information for time tracking and billing", + "summary": "projects 1.0", + "operationId": "getconnector-projects-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "Omschrijving": { + "type": "string" + } + } + } + }, + "examples": { + "example": { + "value": { + "TrackingToken": "202412131017330", + "Result": [ + { + "InstanceId": "96d5ef01-0d3f-4a60-b5ee-8a915693f5c2", + "Omschrijving": "Implementation Greenshop", + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502" + }, + { + "InstanceId": "e03c053d-3e72-400b-821d-c3398edf1ccc", + "Omschrijving": "Implementation Exceptional", + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502" + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels" + ] + } + }, + "/api/salesinvoices": { + "get": { + "description": "Retrieve sales invoices and billing information", + "summary": "salesinvoices 1.1", + "operationId": "getconnector-salesinvoices-get-1.1", + "parameters": [ + { + "in": "query", + "name": "BusinessActivityVersion", + "schema": { + "type": "integer" + } + }, + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.1" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "InstanceId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "SalesInvoiceNumber": { + "type": "string" + }, + "IssueDate": { + "type": "string", + "format": "date-time" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationNumber": { + "type": "string" + }, + "RelationDescription": { + "type": "string" + }, + "Status": { + "oneOf": [ + { + "const": "TODO", + "title": "te verzenden" + }, + { + "const": "BUSY", + "title": "onderweg" + }, + { + "const": "DONE", + "title": "verzonden" + }, + { + "const": "DONEEDIT", + "title": "bezig met wijzigen van verzonden" + }, + { + "const": "DONEERROR", + "title": "in fout staat" + }, + { + "const": "REDO", + "title": "opnieuw te verzenden" + }, + { + "const": "CANNOTBEDONE", + "title": "niet te verzenden" + }, + { + "const": "CANNOTBEREDONE", + "title": "niet opnieuw te verzenden" + }, + { + "const": "TOCREDIT", + "title": "te crediteren" + }, + { + "const": "CREDITED", + "title": "gecrediteerd" + }, + { + "const": "DELETED", + "title": "verwijderd" + }, + { + "const": "TODOERROR", + "title": "in fout staat" + }, + { + "const": "TODOEDIT", + "title": "bezig met wijzigen van te verzenden" + }, + { + "const": "TODOPENDING", + "title": "bezig met wachten" + }, + { + "const": "REPLACED", + "title": "gespecificeerd" + }, + { + "const": "TOSPECIFY", + "title": "af te letteren" + }, + { + "const": "SPECIFIED", + "title": "afgeletterd" + }, + { + "const": "ALTERNATIVELYSPECIFIED", + "title": "alternatief gespecificeerd" + }, + { + "const": "INITIALIZED", + "title": "geïnitialiseerd" + }, + { + "const": "INITIALIZEDEDIT", + "title": "geïnitialiseerd" + }, + { + "const": "PENDINGAPPROVAL", + "title": "te accorderen" + }, + { + "const": "PENDINGCOMPLETION", + "title": "te factureren" + }, + { + "const": "COMPLETED", + "title": "gefactureerd" + }, + { + "const": "DECLINED", + "title": "afgewezen" + }, + { + "const": "TEMPLATE", + "title": "sjabloon" + }, + { + "const": "TEMPLATEEDIT", + "title": "bezig met wijzigen van verzenden" + }, + { + "const": "TEMPLATEERROR", + "title": "in fout staat" + }, + { + "const": "MESSAGEPENDING", + "title": "Bezig met verzenden" + }, + { + "const": "MESSAGESEND", + "title": "Verzonden" + }, + { + "const": "MESSAGEFAILED", + "title": "Fout bij verzenden" + } + ] + }, + "Blob": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "ReadKey": { + "type": "string" + }, + "FileName": { + "type": "string" + }, + "ContentType": { + "type": "string" + }, + "ContentLength": { + "type": "number" + } + } + } + }, + "AmountExcludingVat": { + "type": "number" + }, + "AmountVat": { + "type": "number" + }, + "AmountInvoiced": { + "type": "number" + } + } + } + }, + "examples": { + "example": { + "value": { + "TrackingToken": "202601141348101", + "Result": [ + { + "InstanceId": "76ccd112-3faf-5243-8ee8-001638826d4c", + "AmountExcludingVat": 225.0, + "AmountVat": null, + "AmountInvoiced": 225.0, + "SalesInvoiceNumber": "V01250154", + "IssueDate": "2025-12-05T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "c08e2474-976c-5c7c-94dc-eb02580009d0", + "RelationNumber": "000039", + "RelationDescription": "Administratiekantoor Beers", + "RelationType": "organisation" + }, + { + "InstanceId": "a25d4251-74f9-5406-8639-003be5b0a58e", + "AmountExcludingVat": 1644.3, + "AmountVat": null, + "AmountInvoiced": 1644.3, + "SalesInvoiceNumber": "V01250150", + "IssueDate": "2025-12-05T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "2fdc272a-5da6-55b8-a352-928d3c1e79b6", + "RelationNumber": "000024", + "RelationDescription": "Schreurs Administratiekantoor B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "6645f89b-4d85-56d5-90a4-00701269aeec", + "AmountExcludingVat": 95.0, + "AmountVat": null, + "AmountInvoiced": 95.0, + "SalesInvoiceNumber": "V01240035", + "IssueDate": "2024-03-15T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": null, + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "9fc15edd-9431-5a98-b2e1-0d90f2064527", + "RelationNumber": "000035", + "RelationDescription": "Architectenbureau Brauw B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "bed4a8fe-745e-56ae-a39c-01056ea488af", + "AmountExcludingVat": 150.0, + "AmountVat": null, + "AmountInvoiced": 150.0, + "SalesInvoiceNumber": "V01250133", + "IssueDate": "2025-10-17T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "200dae98-c4db-5da1-b8dd-018f934bcaa0", + "RelationNumber": "000037", + "RelationDescription": "Meepo Instituut B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "284454af-5f23-569b-8735-011f328b1f14", + "AmountExcludingVat": 59.86, + "AmountVat": null, + "AmountInvoiced": 59.86, + "SalesInvoiceNumber": "V01250137", + "IssueDate": "2025-11-07T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "43ff15dd-50a5-5d24-9dba-5271c80e5a8f", + "RelationNumber": "000016", + "RelationDescription": "Beentjes & Zn. Dakbedekking B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "c5277238-d627-59ad-a7cd-017268ac23f1", + "AmountExcludingVat": 1703.65, + "AmountVat": null, + "AmountInvoiced": 1703.65, + "SalesInvoiceNumber": "V01240031", + "IssueDate": "2024-03-01T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": null, + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "c08e2474-976c-5c7c-94dc-eb02580009d0", + "RelationNumber": "000039", + "RelationDescription": "Administratiekantoor Beers", + "RelationType": "organisation" + }, + { + "InstanceId": "bad2f2a1-8522-5d64-a5ed-01b63853b141", + "AmountExcludingVat": 81.9, + "AmountVat": null, + "AmountInvoiced": 81.9, + "SalesInvoiceNumber": "V01250043", + "IssueDate": "2025-04-04T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "7458b139-298f-5f53-aa52-0f9fbeb560b6", + "RelationNumber": "000044", + "RelationDescription": "Stukadoorsbedrijf Burgers B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "b5d6f5e1-9c7e-5e0d-8b31-01da69dc7a69", + "AmountExcludingVat": 963.92, + "AmountVat": null, + "AmountInvoiced": 963.92, + "SalesInvoiceNumber": "V01250029", + "IssueDate": "2025-03-07T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "2fdc272a-5da6-55b8-a352-928d3c1e79b6", + "RelationNumber": "000024", + "RelationDescription": "Schreurs Administratiekantoor B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "c57d4396-e6d4-59d9-a7a6-01ed068afbac", + "AmountExcludingVat": 149.65, + "AmountVat": null, + "AmountInvoiced": 149.65, + "SalesInvoiceNumber": "V01250045", + "IssueDate": "2025-04-11T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "889f3aac-684c-552e-b566-3de14d38c2c5", + "RelationNumber": "000025", + "RelationDescription": "Gebroeders Van Kooten B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "325cca0c-7a2e-5880-aea5-0215220f301c", + "AmountExcludingVat": 406.38, + "AmountVat": null, + "AmountInvoiced": 406.38, + "SalesInvoiceNumber": "V01250064", + "IssueDate": "2025-05-02T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "dd74709e-1fd0-5ab1-a8ab-2a40ad645217", + "RelationNumber": "000041", + "RelationDescription": "Van Kempen Afbouw b.v.", + "RelationType": "organisation" + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.1", + "deprecated": false, + "tags": [ + "Publiek: Facturatie", + "Verkoopfactuur" + ] + } + }, + "/api/salespricesperrelation": { + "get": { + "description": "Retrieve sales prices configured per customer relation", + "summary": "salespricesperrelation 1.0", + "operationId": "getconnector-salespricesperrelation-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "ProductDescription": { + "type": "string" + }, + "PriceExcludingVAT": { + "type": "number" + }, + "StartDate": { + "type": "string", + "format": "date-time" + }, + "EndDate": { + "type": "string", + "format": "date-time" + }, + "RelationDescription": { + "type": "string" + }, + "ProductId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + } + } + } + }, + "examples": { + "example": { + "value": { + "TrackingToken": "202410211314120", + "Result": [ + { + "Id": "b4632ca6-2298-4139-8d67-2f5ca122d039", + "PriceExcludingVAT": 1512.15, + "StartDate": null, + "EndDate": null, + "ProductId": "4eb7c821-7e37-4132-b27d-95563f93687a", + "ProductDescription": "Acer Laptop", + "RelationDescription": "Architectenbureau Brauw B.V.", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "3eff9a76-45d7-4595-a372-09e1e076c540", + "InstanceId": "bcd2883b-0559-4337-aa87-9583d1860a51", + "RelationType": "organisation" + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Publiek: Facturatie", + "Verkoopfactuur" + ] + } + }, + "/api/salesrelations": { + "get": { + "description": "Retrieve sales relations and customer account information", + "summary": "salesrelations 1.0", + "operationId": "getconnector-salesrelations-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationNumber": { + "type": "string" + }, + "RelationDescription": { + "type": "string" + }, + "VatNumber": { + "type": "string" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "0bb78a38-dc5c-5a8f-9990-1f72e3a86b35", + "RelationNumber": "000014", + "RelationDescription": "EnYoi ICT Services B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "a73fa34f-528b-5e26-97af-496c2a33a607", + "RelationNumber": "000019", + "RelationDescription": "Euro Vacaturebank N.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "38a4e8ff-e844-598d-aa15-9db683b606e0", + "RelationNumber": "000033", + "RelationDescription": "Alsach Musik GmbH", + "VatNumber": "DE184475234", + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "f16d144f-fa67-5c04-9d9e-9e4c2f37d864", + "RelationNumber": "000029", + "RelationDescription": "Vlasblom Communicatie B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "a77a2b57-9164-5f2a-b54f-fb287f0e1133", + "RelationNumber": "000042", + "RelationDescription": "Tijhuis Market B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "43ff15dd-50a5-5d24-9dba-5271c80e5a8f", + "RelationNumber": "000016", + "RelationDescription": "Beentjes & Zn. Dakbedekking B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "4664e931-37ea-5520-b869-937740226db5", + "RelationNumber": "000035", + "RelationDescription": "Deventer Adviseurs B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "RelationTypeId": "d3315773-5c05-4e91-96f3-2e21b05c5a10", + "RelationId": "adef5ea1-c4ec-557d-93a5-0ac82709ad8a", + "RelationNumber": null, + "RelationDescription": "Diverse debiteuren", + "VatNumber": null, + "RelationType": "unknown" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "872618f9-9b1a-547c-beb8-6e07e42a0815", + "RelationNumber": "000013", + "RelationDescription": "Erbi Lara B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "c512e0c5-ec1d-5b0e-9924-581cb9209337", + "RelationNumber": "000039", + "RelationDescription": "Industrial Software Ltd", + "VatNumber": "GB548321855485", + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "8983209d-a19a-5f81-bc84-66f3c52d00af", + "RelationNumber": "000024", + "RelationDescription": "Nilfisk Reisorganisatie B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "d3315773-5c05-4e91-96f3-2e21b05c5a10", + "RelationId": "adef5ea1-c4ec-557d-93a5-0ac82709ad8a", + "RelationNumber": null, + "RelationDescription": "Diverse debiteuren", + "VatNumber": null, + "RelationType": "unknown" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "67d2a9cb-5d49-5fe0-a103-2cdadd2bcc75", + "RelationNumber": "000022", + "RelationDescription": "Van Ubbens Advies B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "41186c50-138c-5bc7-bd54-8dd8a3ee3e21", + "RelationNumber": "000018", + "RelationDescription": "Hafkamp Kappers B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "2fdc272a-5da6-55b8-a352-928d3c1e79b6", + "RelationNumber": "000023", + "RelationDescription": "Schreurs Administratiekantoor B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "dd74709e-1fd0-5ab1-a8ab-2a40ad645217", + "RelationNumber": "000037", + "RelationDescription": "Van Kempen Afbouw b.v.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "63e6ad8e-5c78-586e-b35b-48d0a4566075", + "RelationNumber": "000041", + "RelationDescription": "Bus Grondstoffen B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "9fc15edd-9431-5a98-b2e1-0d90f2064527", + "RelationNumber": "000031", + "RelationDescription": "Architectenbureau Brauw B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "493b57bf-2ef7-5f92-a1dc-30e8be2dd8e7", + "RelationNumber": "000040", + "RelationDescription": "Talens Havenbedrijf B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "9fbf635d-5d9c-5f81-b879-48de533d6887", + "RelationNumber": "000043", + "RelationDescription": "Schouten Kunststofprofielen C.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "4a9442b4-1126-5688-8636-7f19ee500ee8", + "RelationNumber": "000021", + "RelationDescription": "Hesta Touringcars B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "c08e2474-976c-5c7c-94dc-eb02580009d0", + "RelationNumber": "000034", + "RelationDescription": "Administratiekantoor Beers", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "3c3c8593-8de5-5c20-bccb-3afeb9dd4a82", + "RelationNumber": "000030", + "RelationDescription": "Oostendorp-Nederland Service B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "7458b139-298f-5f53-aa52-0f9fbeb560b6", + "RelationNumber": "000032", + "RelationDescription": "Stukadoorsbedrijf Burgers B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "39a415bc-43e8-5a6a-bbf9-808f807d4575", + "RelationNumber": "000044", + "RelationDescription": "Ingenieursbureau Zwijndrecht", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "0bb78a38-dc5c-5a8f-9990-1f72e3a86b35", + "RelationNumber": "000014", + "RelationDescription": "EnYoi ICT Services B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "685136cf-ce62-5352-a341-457e99a9bc63", + "RelationNumber": "000028", + "RelationDescription": "Kuiper Marketing N.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "200dae98-c4db-5da1-b8dd-018f934bcaa0", + "RelationNumber": "000036", + "RelationDescription": "Meepo Instituut B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "889f3aac-684c-552e-b566-3de14d38c2c5", + "RelationNumber": "000026", + "RelationDescription": "Gebroeders Van Kooten B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "db59b6c9-0309-5d31-b0d8-5bf3993d4ad0", + "RelationNumber": "000027", + "RelationDescription": "Notariskantoor Verhoeven B.V.", + "VatNumber": null, + "RelationType": "organisation" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels" + ] + } + }, + "/api/unknownrelation": { + "get": { + "description": "Retrieve unknown relation for invoicing without known name or address", + "summary": "unknownrelation 1.0", + "operationId": "getconnector-unknownrelation-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Name": { + "type": "string" + }, + "SalesRelation": { + "type": "boolean" + }, + "PurchaseRelation": { + "type": "boolean" + }, + "IsBlocked": { + "type": "boolean" + } + } + } + }, + "examples": { + "example response": { + "value": { + "TrackingToken": "202405021144501", + "Result": [ + { + "Id": "adef5ea1-c4ec-557d-93a5-0ac82709ad8a", + "Name": "Diverse debiteuren", + "IsBlocked": false, + "SalesRelation": true + }, + { + "Id": "2438541d-5088-5d1d-8caa-94a87cb14dc2", + "Name": "Diverse crediteuren", + "IsBlocked": false, + "PurchaseRelation": true + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Inkoopjournaalpost", + "Publiek: Facturatie", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/vatrate": { + "get": { + "description": "Retrieve VAT rates and tax calculation settings", + "summary": "vatrate 1.0", + "operationId": "getconnector-vatrate-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "Id": "afa50000-0000-0b1e-8a4b-309cd658b570", + "Description": "Nul" + }, + { + "Id": "afa50000-0000-07cf-8b24-5ef474ab1b2a", + "Description": "Extra laag" + }, + { + "Id": "afa50000-0000-0246-9965-b18e164c600e", + "Description": "Speciaal" + }, + { + "Id": "afa50000-0000-0465-aa85-e1a761ca3a33", + "Description": "Laag" + }, + { + "Id": "afa50000-0000-0b41-9465-e9f88bcaef86", + "Description": "Hoog" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost" + ] + } + }, + "/api/vattype": { + "get": { + "description": "Retrieve VAT types and tax category classifications", + "summary": "vattype 1.0", + "operationId": "getconnector-vattype-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "Id": "afa50000-0000-02bb-9338-0a6629f07fce", + "Description": "Verlegd" + }, + { + "Id": "afa50000-0000-0d9c-9502-4fc953f3e012", + "Description": "Vrijgesteld" + }, + { + "Id": "afa50000-0000-0b71-8790-807f97e85c54", + "Description": "Belast" + }, + { + "Id": "afa50000-0000-0a2d-9cec-bd890979929c", + "Description": "Geen btw" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost" + ] + } + }, + "/api/address": { + "post": { + "description": "Create new address information for organizations and persons", + "summary": "address 1.0", + "operationId": "updateconnector-address-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "address 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/address-1.0-Create-JsonSchema" + }, + "examples": { + "New addres for organisation": { + "value": { + "RelationType": "organisation", + "RelationId": "8afb1a9a-1613-5e2b-ab19-20c0f4f3e216", + "StreetName": "Voorthuizerstraat", + "HouseNumber": 16, + "HouseNumberAddition": "A", + "PostalZone": "3881SH", + "CityName": "Putten", + "CountryCode": "NL" + } + }, + "New addres for person": { + "value": { + "RelationType": "person", + "RelationId": "8afb1a9a-1613-5e2b-ab19-20c0f4f3e216", + "StreetName": "Voorthuizerstraat", + "HouseNumber": 16, + "HouseNumberAddition": "A", + "PostalZone": "3881SH", + "CityName": "Putten", + "CountryCode": "NL" + } + }, + "New address DE": { + "value": { + "RelationType": "organisation", + "RelationId": "8afb1a9a-1613-5e2b-ab19-20c0f4f3e216", + "StreetName": "Berliner Straße", + "HouseNumber": 10, + "HouseNumberAddition": "", + "PostalZone": "10115", + "CityName": "Berlijn", + "CountryCode": "DE" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "success": { + "value": { + "result": "Succeeded", + "instances": [ + { + "Code": "Adres", + "Id": "bea5e01e-e1a0-4b04-819a-3347ebca2ba4" + } + ], + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "instances": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Code": { + "type": "string" + }, + "Id": { + "type": "string", + "format": "uuid" + } + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Relaties" + ] + } + }, + "/api/bankaccount": { + "post": { + "description": "Create new bank account information for financial transactions", + "summary": "bankaccount 1.0", + "operationId": "updateconnector-bankaccount-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "bankaccount 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/bankaccount-1.0-Create-JsonSchema" + }, + "examples": { + "New bankaccount organisation": { + "value": { + "RelationType": "organisation", + "RelationId": "8afb1a9a-1613-5e2b-ab19-20c0f4f3e216", + "AccountNumber": "NL82BKCH0618141243", + "BIC": "BKCHNL2R", + "CountryCode": "NL", + "AccountHolderName": "Balistreri" + } + }, + "New bankaccount person": { + "value": { + "RelationType": "person", + "RelationId": "8afb1a9a-1613-5e2b-ab19-20c0f4f3e216", + "AccountNumber": "NL82BKCH0618141243", + "BIC": "BKCHNL2R", + "CountryCode": "NL", + "AccountHolderName": "Balistreri" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "Success": { + "value": { + "result": "Succeeded", + "instances": [ + { + "Code": "Bankrekening", + "Id": "4738e143-e582-4b38-a8af-9d1f1e12bfca" + } + ], + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "instances": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Code": { + "type": "string" + }, + "Id": { + "type": "string", + "format": "uuid" + } + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Relaties" + ] + } + }, + "/api/cashmutation": { + "post": { + "description": "Create cash mutations for cash register transactions", + "summary": "cashmutation 3.0", + "operationId": "updateconnector-cashmutation-Post-3.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "3.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "cashmutation 3.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/cashmutation-3.0-Create-JsonSchema" + }, + "examples": { + "Minimum cash mutuation": { + "value": { + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "Creates only a cashmutation without a reconciliation mutation.", + "Date": "2024-03-15", + "AmountIncludingVat": 400 + } + }, + "purchase": { + "value": { + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "Aanschaf kleine machines en gereedschap", + "Date": "2024-03-15", + "LedgerAccountId": "c031b2e8-f8ac-5ab2-a428-93bf9789fc5e", + "VatPercentage": 21, + "VatTarive": "high", + "AmountIncludingVat": -200 + } + }, + "sales": { + "value": { + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "Omzet algemeen", + "Date": "2024-03-15", + "LedgerAccountId": "cfb59b79-b3ec-55ef-8cde-000499c3179e", + "VatPercentage": 21, + "VatTarive": "high", + "AmountIncludingVat": 400 + } + }, + "specificcashregister": { + "value": { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Omzet algemeen", + "Date": "2025-03-15", + "LedgerAccountId": "0cc7471d-9973-5214-8106-a960bbaa348e", + "VatTarive": "high", + "CashregisterId": "25e93133-ec28-543f-9f23-312ddb4e10a3", + "AmountIncludingVat": 800 + } + }, + "with attachments": { + "value": { + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "Aanschaf kleine machines en gereedschap_387", + "Date": "2024-03-15", + "LedgerAccountId": "c031b2e8-f8ac-5ab2-a428-93bf9789fc5e", + "VatPercentage": 21, + "VatTarive": "high", + "AmountIncludingVat": -200, + "Attachments": [ + { + "AttachmentId": "bcbee6a4-f3de-44c3-91c8-e8921bf15107" + }, + { + "AttachmentId": "6676ad1f-9fc3-4a4f-8a44-d88d8284c598" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "normal response": { + "value": { + "result": "Succeeded", + "traceId": "8f266c6b-f405-4107-92ff-32130bd13a6b", + "data": { + "CashMutationId": "1bff704a-d4a1-4d92-b276-79eece12bb87", + "FinancialBookingId": "723e515f-c997-4d27-ae89-b922f3975a07" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "CashMutationId": { + "type": "string", + "format": "uuid" + }, + "FinancialBookingId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "3.0", + "deprecated": false, + "tags": [ + "Publiek: POS Transacties", + "POS Transacties" + ] + } + }, + "/api/contact": { + "post": { + "description": "Contact", + "summary": "contact 2.0", + "operationId": "updateconnector-contact-Post-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "contact 2.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/contact-2.0-Create-JsonSchema" + }, + "examples": { + "new contact": { + "value": { + "OrganisationId": "8afb1a9a-1613-5e2b-ab19-20c0f4f3e216", + "Firstname": "Rosella", + "Initials": "III", + "Prefix": "Mr.", + "Lastname": "Predovic", + "EmailAddress": "Karli61@example.com", + "PhoneNumber": "223-385-8892" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "success": { + "value": { + "result": "Succeeded", + "instances": [ + { + "Code": "Persoon", + "Id": "3375a0f0-1cf0-5408-98f9-cd3599d96721" + }, + { + "Code": "Emailadres", + "Id": "3f669df2-b5d2-41fd-bb7e-7d7030e9d8be" + }, + { + "Code": "Telefoonnummer", + "Id": "2349ac50-64eb-4d05-b440-f8372dbd850f" + }, + { + "Code": "Contactpersoon", + "Id": "ba9a935d-32ac-447d-9749-105a02079372" + } + ], + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "instances": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Code": { + "type": "string" + }, + "Id": { + "type": "string", + "format": "uuid" + } + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Relaties" + ] + } + }, + "/api/emailaddress": { + "post": { + "description": "CreateEmailAddress", + "summary": "emailaddress 2.0", + "operationId": "updateconnector-emailaddress-Post-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "emailaddress 2.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/emailaddress-2.0-Create-JsonSchema" + }, + "examples": { + "new email for organisation": { + "value": { + "RelationType": "organisation", + "RelationId": "dde06573-1190-5b31-a400-064588aa62e0", + "EmailAddress": "user@example.com" + } + }, + "new email for person": { + "value": { + "RelationType": "person", + "RelationId": "2aacc092-9c6c-5020-b1cf-0d8ecd6485dc", + "EmailAddress": "user@example.com" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "success": { + "value": { + "result": "Succeeded", + "instances": [ + { + "Code": "Emailadres", + "Id": "cb052971-6312-42cf-b3fd-de274f248a88" + } + ], + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "instances": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Code": { + "type": "string" + }, + "Id": { + "type": "string", + "format": "uuid" + } + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Relaties" + ] + } + }, + "/api/financialjournalentry": { + "post": { + "description": "Create financial journal entries for bookkeeping", + "summary": "financialjournalentry 1.0", + "operationId": "updateconnector-financialjournalentry-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "financialjournalentry 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/financialjournalentry-1.0-Create-JsonSchema" + }, + "examples": { + "new financialjournalentry periodallocation": { + "value": { + "AdministrationId": "95c0de1b-e269-4c74-ab6a-ece7fb15a4ff", + "Description": "journaalpost_001", + "EntryDate": "2024-01-22", + "EntryLine": [ + { + "Description": "Regel1", + "LedgerAccountId": "5a663714-2c36-5d94-a009-3a210bc2ce52", + "AmountDebit": 4000.65, + "VatDirection": "Sales", + "VatType": "High", + "AmountCredit": 0, + "PeriodAllocation": true, + "PeriodAllocationBeginDate": "2024-01-01", + "PeriodAllocationEndDate": "2024-12-31" + }, + { + "Description": "Regel2", + "LedgerAccountId": "5a663714-2c36-5d94-a009-3a210bc2ce52", + "AmountCredit": 4000.65, + "AmountDebit": 0 + } + ] + } + }, + "new financialjournalentry": { + "value": { + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "Description": "journaalpost_002", + "EntryDate": "2024-01-22", + "EntryLine": [ + { + "Description": "Regel1", + "LedgerAccountId": "5a663714-2c36-5d94-a009-3a210bc2ce52", + "AmountDebit": 4000.65, + "VatDirection": "sales", + "VatType": "high" + }, + { + "Description": "Regel2", + "LedgerAccountId": "5a663714-2c36-5d94-a009-3a210bc2ce52", + "AmountCredit": 4000.65 + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "success": { + "value": { + "result": "Succeeded", + "traceId": "39f2f0fc-58cc-4f7b-a26b-5aa93d77ba88", + "data": { + "FinancialJournalEntryId": "6f30c816-3a77-4c2b-9484-9a09cc5edd7f" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "FinancialJournalEntryId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële journaalpost", + "Financiële journaalpost" + ] + }, + "delete": { + "description": "Delete financial journal entries from bookkeeping", + "summary": "financialjournalentry 1.0", + "operationId": "updateconnector-financialjournalentry-Delete-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "financialjournalentry 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/financialjournalentry-1.0-Delete-JsonSchema" + }, + "examples": { + "delete financialjournalentry": { + "value": { + "AdministrationId": "e877fb82-b546-4d20-94cf-05c72765fc47", + "Id": "e877fb82-b546-4d20-94cf-05c72765fc47" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "success": { + "value": { + "result": "Succeeded", + "traceId": "9b99528e-3bf0-4485-91f9-b9bba34550e0", + "data": { + "FinancialJournalEntryId": "6f30c816-3a77-4c2b-9484-9a09cc5edd7f" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "FinancialJournalEntryId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële journaalpost", + "Financiële journaalpost" + ] + } + }, + "/api/mandates": { + "post": { + "description": "Create SEPA direct debit mandates for automated payments", + "summary": "mandates 1.0", + "operationId": "updateconnector-mandates-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "mandates 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/mandates-1.0-Create-JsonSchema" + }, + "examples": { + "example": { + "value": { + "AdministrationId": "e5a3aaef-0cc7-46d0-9eb5-8d039c88109e", + "RelationType": "organisation", + "RelationId": "046800d6-8160-41a9-a422-ef3c04b8d373", + "RelationBankAccountId": "27548bd4-45ad-4652-bdd2-f1615dc28245", + "MandateReference": "Test31Con33tract3nr.FL-2322/2P", + "DateOfSignature": "2024-12-31" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "response": { + "value": { + "result": "Succeeded", + "traceId": "3511f4e3-869c-4ed6-9dde-e4a45acd8f04", + "data": { + "MandateId": "ef03c8a1-4254-498e-a819-343184ce9aad" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "MandateId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Facturatie", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/organisation": { + "post": { + "description": "Create new organization records and business relationships", + "summary": "organisation 4.0", + "operationId": "updateconnector-organisation-Post-4.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "4.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "organisation 4.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/organisation-4.0-Create-JsonSchema" + }, + "examples": { + "new organisation maximal": { + "value": { + "Name": "Nitzsche, Dickinson and Predovic", + "CocNumber": "38012622", + "VatNumber": "NL003276211B01", + "Tradename": "Johns - Swaniawski", + "EmailAddress": "Damion94@example.org", + "Website": "https://astrid.info", + "PhoneNumber": "738-407-2156", + "ExternalId": "123456789", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "inspiratielaan", + "HouseNumber": 3, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL44DNIB0736664289", + "BankId": "DNIB", + "Bic": "DNIBNL2G", + "CountryCode": "NL", + "AccountHolderName": "Jan Zandbergen", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + }, + "new organisation minimal": { + "value": { + "Name": "Larkin Inc" + } + }, + "new organisation": { + "value": { + "Name": "Terry - Powlowski", + "CocNumber": "38012622", + "VatNumber": "NL003276211B01", + "EmailAddress": "Amelie_Bogisich@example.com", + "PhoneNumber": "738-407-2156", + "ExternalId": "801-331-6473", + "Addresses": [ + { + "StreetName": "Tillman Glen", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL" + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "minimum": { + "value": { + "result": "Succeeded", + "data": { + "RelationId": "9ef691ac-b12c-4e14-9368-8191e03b54c0", + "Addresses": [ + { + "AddressId": "a329ffce-7e6c-4e79-acb4-43ac57157dc9", + "AddressDescription": "inspiratielaan 2 3833AV Leusden Nederland" + } + ], + "BankAccounts": [ + { + "AccountNumberId": "4395b94c-af56-429b-ab52-52bdc9986fb4", + "AccountNumber": "NL68INGB0801705542" + } + ] + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "data": { + "type": "object", + "properties": { + "RelationId": { + "type": "string", + "format": "uuid" + }, + "Addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AddressId": { + "type": "string", + "format": "uuid" + }, + "AddressDescription": { + "type": "string" + } + } + } + }, + "BankAccounts": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AccountNumberId": { + "type": "string", + "format": "uuid" + }, + "AccountNumber": { + "type": "string" + } + } + } + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "4.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Inkoopjournaalpost", + "Relaties", + "Publiek: Externe facturatie" + ] + }, + "put": { + "description": "Update existing organization records and business relationships", + "summary": "organisation 4.0", + "operationId": "updateconnector-organisation-Put-4.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "4.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "organisation 4.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/organisation-4.0-Update-JsonSchema" + }, + "examples": { + "update organisation": { + "value": { + "RelationId": "978638a5-394f-4ecc-a31f-21332f9f79e5", + "Name": "AFAS Software", + "CocNumber": "54041813", + "ExternalId": "SWR23244", + "Tradename": "AFAS Software BV", + "EmailAddress": "info@afas.NL", + "WebSite": "www.afas.nl", + "phoneNumber": "+31334341800", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 5, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "preferredSupplierAddress": true, + "preferredShippingAddress": false, + "preferredBillingAddress": true + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "response": { + "value": { + "result": "Succeeded", + "traceId": "d8b6d497-cd52-46b1-a4c3-78dd7f9fb957", + "data": { + "RelationId": "978638a5-394f-4ecc-a31f-21332f9f79e5" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "RelationId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "4.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Inkoopjournaalpost", + "Relaties", + "Publiek: Externe facturatie" + ] + } + }, + "/api/payrolljournalentry": { + "post": { + "description": "Create payroll journal entries for salary processing", + "summary": "payrolljournalentry 1.0", + "operationId": "updateconnector-payrolljournalentry-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "payrolljournalentry 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/payrolljournalentry-1.0-Create-JsonSchema" + }, + "examples": { + "Loonjournaalpost": { + "value": { + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "Description": "Loonjournaalpost_001", + "Date": "2024-01-22", + "PayrollJournalEntryLine": [ + { + "LedgerAccountNumber": "1700", + "AmountDebit": 4000 + }, + { + "LedgerAccountNumber": "1710", + "AmountCredit": 1300 + }, + { + "LedgerAccountNumber": "2300", + "AmountCredit": 2700 + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "Success": { + "value": { + "result": "Succeeded", + "instances": [ + { + "Code": "Memoriaalboeking2", + "Id": "a70c4e79-a04f-57cf-875b-150434c56e17" + } + ], + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "instances": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Code": { + "type": "string" + }, + "Id": { + "type": "string", + "format": "uuid" + } + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Loonjournaalpost" + ] + } + }, + "/api/person": { + "post": { + "description": "Create new person records and personal relationships", + "summary": "person 4.0", + "operationId": "updateconnector-person-Post-4.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "4.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "person 4.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/person-4.0-Create-JsonSchema" + }, + "examples": { + "create person with 2 addresses and 2 backaccounts": { + "value": { + "Firstname": "John", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Doe", + "Emailaddress": "johndoe@gmail.com", + "Phonenumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": false + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": true + } + ] + } + }, + "create person with address and bankaccount": { + "value": { + "Firstname": "Julianne", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Pouros", + "Emailaddress": "Alyce58@gmail.com", + "Phonenumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Krommeweg", + "HouseNumber": 18, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "8071TE", + "CityName": "Nunspeet", + "CountryCode": "NL", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": true, + "PreferredBillingAddress": true + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + } + ] + } + }, + "create person": { + "value": { + "Firstname": "John", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Doe", + "Emailaddress": "johndoe@gmail.com", + "Phonenumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": false + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": true + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "minimum": { + "value": { + "result": "Succeeded", + "data": { + "RelationId": "9ef691ac-b12c-4e14-9368-8191e03b54c0", + "Addresses": [ + { + "AddressId": "a329ffce-7e6c-4e79-acb4-43ac57157dc9", + "AddressDescription": "inspiratielaan 2 3833AV Leusden Nederland" + } + ], + "BankAccounts": [ + { + "AccountNumberId": "4395b94c-af56-429b-ab52-52bdc9986fb4", + "AccountNumber": "NL68INGB0801705542" + } + ] + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "data": { + "type": "object", + "properties": { + "RelationId": { + "type": "string", + "format": "uuid" + }, + "Addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AddressId": { + "type": "string", + "format": "uuid" + }, + "AddressDescription": { + "type": "string" + } + } + } + }, + "BankAccounts": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AccountNumberId": { + "type": "string", + "format": "uuid" + }, + "AccountNumber": { + "type": "string" + } + } + } + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "4.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Inkoopjournaalpost", + "Relaties", + "Publiek: Externe facturatie" + ] + }, + "put": { + "description": "Update existing person records and personal relationships", + "summary": "person 4.0", + "operationId": "updateconnector-person-Put-4.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "4.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "person 4.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/person-4.0-Update-JsonSchema" + }, + "examples": { + "update person": { + "value": { + "RelationId": "69a7cab4-3a34-4fdf-8017-c6df8a9375df", + "FirstName": "John", + "LastName": "Doe", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 5, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "preferredSupplierAddress": true, + "preferredShippingAddress": true, + "preferredBillingAddress": true + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "response": { + "value": { + "result": "Succeeded", + "traceId": "f0dddf19-12a8-4bf2-b782-359d32679491", + "data": { + "RelationId": "7b97c9cc-d0ef-48bf-a896-657dfb494059" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "RelationId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "4.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Inkoopjournaalpost", + "Relaties", + "Publiek: Externe facturatie" + ] + } + }, + "/api/phonenumber": { + "post": { + "description": "CreatePhoneNumber", + "summary": "phonenumber 1.0", + "operationId": "updateconnector-phonenumber-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "phonenumber 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/phonenumber-1.0-Create-JsonSchema" + }, + "examples": { + "Nieuw telefoonnummer voor organisatie": { + "value": { + "RelationType": "organisation", + "RelationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "PhoneNumber": "033546786" + } + }, + "Nieuw telefoonnummer voor persoon": { + "value": { + "RelationType": "person", + "RelationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "PhoneNumber": "033546786" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "response": { + "value": { + "result": "Succeeded", + "instances": [ + { + "Code": "Telefoonnummer", + "Id": "0127112f-48ed-4e09-b981-914913cc1807" + } + ], + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "instances": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Code": { + "type": "string" + }, + "Id": { + "type": "string", + "format": "uuid" + } + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Relaties" + ] + } + }, + "/api/purchasejournalentry": { + "post": { + "description": "Create purchase journal entries for supplier transactions (C# script version)", + "summary": "purchasejournalentry 2.0", + "operationId": "updateconnector-purchasejournalentry-Post-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "purchasejournalentry 2.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/purchasejournalentry-2.0-Create-JsonSchema" + }, + "examples": { + "Inkoopjournaalpost": { + "value": { + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "InvoiceNumber": "3gKm5gtrBcjWHNY3dwwjyza4AZYAyBW", + "RelationType": "organisation", + "RelationId": "863d895a-3782-5500-b933-dd487d736138", + "InvoiceDate": "2024-01-22", + "DueDate": "2024-02-28", + "PaymentMethod": "creditcard", + "Attachments": [ + { + "AttachmentId": "039e63a5-5761-4a6e-a58b-d0fcda003e0c" + } + ], + "InvoiceLine": [ + { + "Description": "Inkopen btw hoog", + "LedgerAccountId": "55eeb0a9-25d0-5c60-830b-07f515fc0c0c", + "VatType": "high", + "AmountExcludingVat": 22, + "AmountVat": 4.62 + }, + { + "Description": "Inkopen btw laag", + "LedgerAccountId": "22edee70-753a-5f8c-a613-39fe661fffbe", + "VatType": "low", + "AmountExcludingVat": 100, + "AmountVat": 9 + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "response": { + "value": { + "result": "Succeeded", + "traceId": "90666ba6-6211-4582-9a19-0c0429c84b4e", + "data": { + "PurchaseJournalEntryId": "a29631fe-cc81-40ba-bc6c-b813be75423c", + "PurchaseInternalInvoiceNumber": "IF250002" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "PurchaseJournalEntryId": { + "type": "string", + "format": "uuid" + }, + "PurchaseInternalInvoiceNumber": { + "type": "string" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost" + ] + } + }, + "/api/salesinvoice": { + "post": { + "description": "Create sales invoices for customer billing", + "summary": "salesinvoice 2.0", + "operationId": "updateconnector-salesinvoice-Post-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "salesinvoice 2.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/salesinvoice-2.0-Create-JsonSchema" + }, + "examples": { + "example": { + "value": { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "IssueDate": "2025-05-16", + "RelationType": "organisation", + "SentInvoiceEmail": false, + "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "PaymentMethod": "banktransfer", + "InvoiceLine": [ + { + "ItemId": "5dbb40d7-52b5-51b6-809e-5a16dddeb650", + "Quantity": 2 + } + ] + } + }, + "exampleAlternativeAllocation copy": { + "value": { + "AdministrationId": "3f73bc84-fb32-4d1d-83d9-5de1af8245b1", + "IssueDate": "2024-05-16", + "RelationType": "organisation", + "SentInvoiceEmail": false, + "ToBeInvoiced": true, + "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "InvoiceLine": [ + { + "ItemId": "7e94bf59-594c-5c28-9fe5-5e238f821b0d", + "Price": 10, + "Quantity": 2, + "AlternativeAllocationDate": "2024-12-31" + } + ] + } + }, + "exampleToBeInvoiced": { + "value": { + "AdministrationId": "3f73bc84-fb32-4d1d-83d9-5de1af8245b1", + "IssueDate": "2024-05-16", + "RelationType": "organisation", + "SentInvoiceEmail": false, + "ToBeInvoiced": true, + "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "InvoiceLine": [ + { + "ItemId": "7e94bf59-594c-5c28-9fe5-5e238f821b0d", + "Quantity": 2 + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "Example": { + "value": { + "result": "Succeeded", + "traceId": "8ede5c56-1e84-4134-b243-007e8bac57cc", + "data": { + "SalesInvoiceId": "61296199-a131-4b4e-9511-54a599ae8541" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "SalesInvoiceId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Publiek: Facturatie", + "Verkoopfactuur" + ] + }, + "delete": { + "description": "Delete sales invoices from customer billing", + "summary": "salesinvoice 2.0", + "operationId": "updateconnector-salesinvoice-Delete-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "salesinvoice 2.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/salesinvoice-2.0-Delete-JsonSchema" + }, + "examples": { + "example": { + "value": { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Id": "c7e0773e-7904-41b7-a09e-56643261b6f4" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "Example": { + "value": { + "result": "Succeeded", + "traceId": "e491eb78-6969-45c2-ba20-f94d68364427", + "data": { + "salesinvoiceId": "c7e0773e-7904-41b7-a09e-56643261b6f4" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "salesinvoiceId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + }, + "400": { + "content": { + "application/json": { + "examples": { + "ExampleAlreadySend": { + "value": { + "result": "Failed", + "traceId": "93a3cfbe-f20b-4fd2-9ec3-5cdd930eebc7", + "instances": [], + "errors": [ + "SalesInvoice cannot be deleted because it is not a draft or it is already deleted" + ] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "instances": { + "type": "array", + "items": {} + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Publiek: Facturatie", + "Verkoopfactuur" + ] + } + }, + "/api/salesjournalentry": { + "post": { + "description": "Create sales journal entries for customer transactions", + "summary": "salesjournalentry 2.1", + "operationId": "updateconnector-salesjournalentry-Post-2.1", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.1" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "salesjournalentry 2.1", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/salesjournalentry-2.1-Create-JsonSchema" + }, + "examples": { + "BTW binnen en buiten EU": { + "value": { + "InvoiceNumber": "a", + "InvoiceDate": "2024-01-30", + "Description": "Unbranded Fresh Pizza", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "organisation", + "RelationId": "c6f3b724-845c-5af2-8360-2fc751601115", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "9b5d768a-c71b-583e-b6ee-09d64aa935d4", + "InvoiceLine": [ + { + "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", + "VatType": "zero", + "AmountExcludingVat": 100 + }, + { + "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", + "VatType": "zero", + "AmountExcludingVat": 211 + } + ] + } + }, + "BTW Verlegd binnen Nederland": { + "value": { + "InvoiceNumber": "d", + "InvoiceDate": "2024-01-30", + "Description": "Practical Plastic Chips", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "organisation", + "RelationId": "c6f3b724-845c-5af2-8360-2fc751601115", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "9b5d768a-c71b-583e-b6ee-09d64aa935d4", + "InvoiceLine": [ + { + "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", + "VatType": "high", + "VatCalculation": "reversecharged", + "AmountExcludingVat": 100 + }, + { + "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", + "VatType": "high", + "VatCalculation": "reversecharged", + "AmountExcludingVat": 396 + } + ] + } + }, + "Sales with attachment": { + "value": { + "InvoiceNumber": "1", + "InvoiceDate": "2024-02-01", + "Description": "Ergonomic Rubber Bacon", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "organisation", + "RelationId": "a8cce7bd-ced8-5ca4-b3b8-f0584ffe5993", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "9b5d768a-c71b-583e-b6ee-09d64aa935d4", + "Attachments": [ + { + "AttachmentId": "b031446a-b98e-4378-b7ee-8543e05f34c0" + } + ], + "InvoiceLine": [ + { + "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", + "AmountVat": 21, + "VatType": "high", + "AmountExcludingVat": 100 + }, + { + "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", + "AmountExcludingVat": 427, + "VatType": "zero", + "VatCalculation": "exempt" + } + ] + } + }, + "verkoop 1 regel": { + "value": { + "InvoiceNumber": "7", + "InvoiceDate": "2024-01-24", + "Description": "Unbranded Steel Sausages", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "organisation", + "RelationId": "9bafbc7a-611b-5465-a584-5f0c88734b35", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "eb44c60d-06e4-564b-a90c-7715c78788a5", + "InvoiceLine": [ + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 183.54, + "VatType": "high", + "AmountExcludingVat": 874 + } + ] + } + }, + "verkoop aan persoon": { + "value": { + "InvoiceNumber": "SAL341434345403", + "InvoiceDate": "2024-01-24", + "Description": "null", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "person", + "RelationId": "d36cb9bb-0e5f-5253-ab28-2331804d65ba", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "eb44c60d-06e4-564b-a90c-7715c78788a5", + "InvoiceLine": [ + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 21, + "VatType": "high", + "AmountExcludingVat": 100 + }, + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 450.55, + "VatType": "low", + "AmountExcludingVat": 40.55, + "VatCalculation": "exempt" + } + ] + } + }, + "verkoop alle soorten btw": { + "value": { + "InvoiceNumber": "d", + "InvoiceDate": "2024-01-23", + "Description": "Sleek Metal Tuna", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "organisation", + "RelationId": "9bafbc7a-611b-5465-a584-5f0c88734b35", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "eb44c60d-06e4-564b-a90c-7715c78788a5", + "InvoiceLine": [ + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 21, + "VatType": "high", + "AmountExcludingVat": 100 + }, + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 40.55, + "VatType": "low", + "AmountExcludingVat": 40.55, + "VatCalculation": "exempt" + }, + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 0, + "VatType": "zero", + "AmountExcludingVat": 40.55 + }, + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 18, + "VatType": "low", + "AmountExcludingVat": 200 + }, + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 18, + "VatType": "high", + "AmountExcludingVat": 200, + "VatCalculation": "reversecharged" + } + ] + } + }, + "verkoop meerdere btw soorten": { + "value": { + "InvoiceNumber": "t", + "InvoiceDate": "2024-01-23", + "Description": "Handmade Concrete Car", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "organisation", + "RelationId": "863d895a-3782-5500-b933-dd487d736138", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "b98e24e9-a611-5a98-8cf9-40fed321dc6c", + "InvoiceLine": [ + { + "LedgerAccountId": "de3184b9-23f0-55e6-9bd0-ccb5c2b5b5ce", + "AmountVat": 21, + "VatType": "high", + "AmountExcludingVat": 100 + }, + { + "LedgerAccountId": "de3184b9-23f0-55e6-9bd0-ccb5c2b5b5ce", + "AmountVat": 40.55, + "VatType": "low", + "AmountExcludingVat": 40.55, + "VatCalculation": "exempt" + }, + { + "LedgerAccountId": "de3184b9-23f0-55e6-9bd0-ccb5c2b5b5ce", + "AmountVat": 0, + "VatType": "zero", + "AmountExcludingVat": 40.55 + }, + { + "LedgerAccountId": "de3184b9-23f0-55e6-9bd0-ccb5c2b5b5ce", + "AmountVat": 18, + "VatType": "low", + "AmountExcludingVat": 200 + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "success": { + "value": { + "result": "Succeeded", + "traceId": "ab84df36-19aa-477c-9f71-c0c61cb542a1", + "data": { + "SalesJournalEntryId": "2fe9d143-52aa-4d9f-9eba-a97656f2741c" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "SalesJournalEntryId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + }, + "400": { + "content": { + "application/json": { + "examples": { + "already exists": { + "value": { + "result": "Failed", + "traceId": "3ca43e3a-00b6-460d-8bf1-be2f391f3f4c", + "instances": [], + "errors": [ + "SalesJournalEntry with invoicenumber SB_API_2204202410006 already exists" + ] + } + }, + "error on date": { + "value": { + "result": "Failed", + "traceId": "57f10a49-6720-4bb8-8826-8ef92387560f", + "instances": [], + "errors": [ + "Entity is made with one or more errors. Please correct this error in application or delete SalesJournalEntry with id: b32ee6e1-f807-4644-a6d5-d785d8bd7c61", + "De factuurdatum ligt vóór de beginbalansdatum. Dit is niet toegestaan." + ] + } + }, + "error on line": { + "value": { + "result": "Failed", + "traceId": "010e0485-1e22-4f1a-8573-405090824d35", + "instances": [], + "errors": [ + "Entity is made with one or more errors in the lines. Please correct this error in application or delete SalesJournalEntry with id: eee53305-8851-4859-a53e-b4b18f14040e.", + "Field 'Grootboekrekening' contains an invalid reference (a18e0f9a-c73d-58c4-ae80-64c2e4228de4)", + "Field 'Grootboekrekening' contains an invalid reference (a18e0f9a-c73d-58c4-ae80-64c2e4228de4)" + ] + } + }, + "error": { + "value": { + "result": "Failed", + "traceId": "e193dbe5-8f65-4035-aa81-879bd9828f98", + "instances": [], + "errors": [ + "FeatureToggle not enabled" + ] + } + } + }, + "schema": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "type": "string" + } + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "result": { + "type": "string" + }, + "instances": { + "type": "array", + "items": {} + } + } + } + } + } + } + }, + "version": "2.1", + "deprecated": false, + "tags": [ + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + }, + "delete": { + "description": "Delete sales journal entries from customer transactions", + "summary": "salesjournalentry 2.1", + "operationId": "updateconnector-salesjournalentry-Delete-2.1", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.1" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "salesjournalentry 2.1", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/salesjournalentry-2.1-Delete-JsonSchema" + }, + "examples": { + "example": { + "value": { + "AdministrationId": "a15620b1-90bf-46d8-a155-15f59a3ed460", + "Id": "8f8d5e92-bd85-4deb-8184-6abf57a5b24d" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "success": { + "value": { + "result": "Succeeded", + "traceId": "ab84df36-19aa-477c-9f71-c0c61cb542a1", + "data": { + "SalesJournalEntryId": "2fe9d143-52aa-4d9f-9eba-a97656f2741c" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "SalesJournalEntryId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.1", + "deprecated": false, + "tags": [ + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + }, + "put": { + "description": "Update sales journal entries for customer transactions", + "summary": "salesjournalentry 2.1", + "operationId": "updateconnector-salesjournalentry-Put-2.1", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.1" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "salesjournalentry 2.1", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/salesjournalentry-2.1-Update-JsonSchema" + }, + "examples": { + "PaymentReference": { + "value": { + "AdministrationId": "f49f54a4-835d-532f-a117-79054e726808", + "Id": "2857a5b4-777d-44cd-b10d-9721c0281d7d", + "PaymentReference": "2024-10124" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "success": { + "value": { + "result": "Succeeded", + "data": { + "SalesJournalEntryId": "f365059e-5918-49ec-9a7c-d4f0a0c8beb4" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "data": { + "type": "object", + "properties": { + "SalesJournalEntryId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.1", + "deprecated": false, + "tags": [ + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/supplier": { + "post": { + "description": "Create new supplier relationships and vendor setup", + "summary": "supplier 1.0", + "operationId": "updateconnector-supplier-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "supplier 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/supplier-1.0-Create-JsonSchema" + }, + "examples": { + "New supplier organisation": { + "value": { + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "EmailAddress": "klant@afas.nl", + "PhoneNumber": "0696856831", + "BankAccountNumber": "NL29TRIO0110845005", + "Bic": "TRIONL2U", + "LedgerAccountId": "4a2014b0-dcdc-500d-add2-fcf73ac8f88d", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "ee64c81b-56ff-506f-9dac-855d64bf193a", + "Organisation": { + "Name": "Jansen Haarden", + "CompanyIdCoc": "80446353", + "CompanyIdVat": "NL861674881B01", + "TradeName": "Jansen Holding B.V." + } + } + }, + "New supplier person": { + "value": { + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "EmailAddress": "Delfina2@example.net", + "PhoneNumber": "30-702-386-4989", + "BankAccountNumber": "NL29TRIO0110845005", + "Bic": "TRIONL2U", + "Person": { + "Firstname": "Lacy", + "Initials": "MD", + "Prefix": "Ms.", + "Lastname": "Harber" + }, + "PaymentMethod": "null", + "LedgerAccountId": "cfb59b79-b3ec-55ef-8cde-000499c3179e", + "PaymentCondition": "b98e24e9-a611-5a98-8cf9-40fed321dc6c", + "VatCalculation": "null" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "success": { + "value": { + "result": "Succeeded", + "instances": [ + { + "Code": "Persoon", + "Id": "e55f5d3b-780b-576b-9370-760b58e937ec" + }, + { + "Code": "Instelling", + "Id": "20eb199e-c652-5513-b7eb-c39f927d1ef3" + }, + { + "Code": "Leverancier", + "Id": "20eb199e-c652-5513-b7eb-c39f927d1ef3" + }, + { + "Code": "Begunstigde", + "Id": "7afec8a8-c9f4-4ec7-aa68-8d9bc995468d" + }, + { + "Code": "Emailadres", + "Id": "4fc10096-8bb4-4be8-8039-5239b4125757" + }, + { + "Code": "Telefoonnummer", + "Id": "5e553026-0ad2-4f4c-bd2e-5dbdd6c0096f" + }, + { + "Code": "Bankrekening", + "Id": "d18e1122-e014-4468-aa65-585b333359c1" + } + ], + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "instances": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Code": { + "type": "string" + }, + "Id": { + "type": "string", + "format": "uuid" + } + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost" + ] + } + } + }, + "tags": [ + { + "name": "Autorisatie", + "description": "Endpoints voor autorisatie" + }, + { + "name": "Bijlagen", + "description": "Endpoints voor bijlagen" + }, + { + "name": "Publiek: Admin center data", + "description": "Admin center data connectoren" + }, + { + "name": "Crediteuren", + "description": "Crediteuren connectoren" + }, + { + "name": "Debiteuren", + "description": "Debiteuren connectoren" + }, + { + "name": "Publiek: Financiële dashboarding", + "description": "Financiële dashboarding voor publieke api" + }, + { + "name": "Publiek: Financiële journaalpost", + "description": "Financiële journaalpost voor publieke api" + }, + { + "name": "Financiële journaalpost", + "description": "Financiële journaalpost connectors" + }, + { + "name": "Publiek: Financiële rapportage", + "description": "Financiële rapportage voor publieke api" + }, + { + "name": "Financiele rapportage", + "description": "Financiele rapportage connectoren" + }, + { + "name": "Publiek: Externe verkoopregels", + "description": "Verkoopregels voor publieke api" + }, + { + "name": "Verkoopregels", + "description": "Verkoopregels connectors" + }, + { + "name": "Loonjournaalpost", + "description": "Loonjournaalpost connectors" + }, + { + "name": "Publiek: POS Transacties", + "description": "POS transacties voor publieke api" + }, + { + "name": "POS Transacties", + "description": "POS transacties" + }, + { + "name": "Inkoopjournaalpost", + "description": "Inkoopjournaalpost connectors" + }, + { + "name": "Publiek: Relatiemanagement", + "description": "Relatiemanagement voor publieke api" + }, + { + "name": "Relaties", + "description": "Relatie connectors" + }, + { + "name": "Publiek: Facturatie", + "description": "Facturatie voor publieke api" + }, + { + "name": "Verkoopfactuur", + "description": "Verkoopfactuur connectors" + }, + { + "name": "Publiek: Externe facturatie", + "description": "Externe facturatie voor publieke api" + }, + { + "name": "Verkoopjournaalpost", + "description": "Verkoopjournaalpost connectors" + }, + { + "name": "TechnischeInfo", + "description": "Technische informatie" + } + ], + "components": { + "securitySchemes": { + "oAuth2": { + "type": "oauth2", + "flows": { + "authorizationCode": { + "authorizationUrl": "https://{{domain}}.afasfocus.nl/{{customerenvironment}}/app/auth", + "tokenUrl": "https://{{domain}}.afasfocus.nl/{{customerenvironment}}/app/token", + "scopes": {} + } + } + } + }, + "requestBodies": { + "address-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "description": "Use this endpoint to create a new address for a person or organisation.", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "RelationType": { + "type": "string", + "description": "Must contain one of the enums. Will be required in a future version.", + "enum": [ + "organisation", + "person" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation or person. Will be required in a future version.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + } + }, + "examples": [ + { + "RelationType": "organisation", + "RelationId": "c8a288c1-3dbb-483d-840d-9cc601368a92", + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "a", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL" + } + ] + }, + "bankaccount-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "description": "Use this endpoint to create a new bankaccount data for a person or organisation.", + "required": [ + "AccountNumber", + "AccountHolderName", + "CountryCode", + "RelationType", + "RelationId" + ], + "properties": { + "RelationType": { + "type": "string", + "description": "Must contain one of the enums. Will be required in a future version.", + "enum": [ + "organisation", + "person" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation or person. Will be required in a future version.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL01RABO0123456789" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "RABO" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "RABONL2U" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "DE" + ] + }, + "AccountHolderName": { + "type": "string", + "default": "", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen" + ] + } + }, + "examples": [ + { + "RelationType": "organisation", + "RelationId": "c8a288c1-3dbb-483d-840d-9cc601368a92", + "AccountNumber": "NL01RABO0123456789", + "BankId": "RABO", + "Bic": "RABONL2U", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen" + } + ] + }, + "cashmutation-1.0-Create-JsonSchema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "description": "This endpoint allows you to add cash mutations directly from Point of Sale (POS) applications to the accounting software, streamlining the process of recording and managing cash transactions for businesses. For each cashmutation an request must be done.", + "properties": { + "administrationId": { + "type": "string", + "format": "uuid", + "description": "The Administration ID uniquely identifying an administration. Retrieve it from the endpoint: api/administration" + }, + "description": { + "type": "string", + "description": "The description providing information about the cash mutation and other bookings" + }, + "date": { + "type": "string", + "format": "date", + "description": "The date when the cash mutation and other bookings occurred" + }, + "ledgerAccountId": { + "type": "string", + "format": "uuid", + "description": "The Ledger Account ID uniquely identifying a ledger account. Retrieve it from the endpoint: api/ledgeraccounts" + }, + "amountIncludingVat": { + "type": "number", + "multipleOf": 0.01, + "description": "The amount including VAT for the cash mutation and other bookings" + }, + "vatPercentage": { + "type": "integer", + "description": "The percentage of VAT applied to the cash mutation and other bookings" + }, + "vatTarive": { + "type": "string", + "enum": [ + "high", + "low", + "zero" + ], + "description": "The VAT tarive/category - 'high', 'low', or 'zero'" + }, + "vatType": { + "type": "string", + "enum": [ + "purchase", + "sales" + ], + "description": "The type of VAT operation - 'purchase' or 'sales'" + }, + "attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "required": [ + "attachmentId" + ], + "properties": { + "attachmentId": { + "type": "string", + "format": "uuid" + } + } + } + } + }, + "required": [ + "administrationId", + "description", + "date", + "amountIncludingVat" + ] + }, + "cashmutation-2.0-Create-JsonSchema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "description": "This endpoint allows you to add cash mutations directly from Point of Sale (POS) applications to the accounting software, streamlining the process of recording and managing cash transactions for businesses. For each cashmutation an request must be done.", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "The Administration ID uniquely identifying an administration. Retrieve it from the endpoint: api/administration" + }, + "Description": { + "type": "string", + "description": "The description providing information about the cash mutation and other bookings" + }, + "Date": { + "type": "string", + "format": "date", + "description": "The date when the cash mutation and other bookings occurred" + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "The Ledger Account ID uniquely identifying a ledger account. Retrieve it from the endpoint: api/ledgeraccounts" + }, + "AmountIncludingVat": { + "type": "number", + "multipleOf": 0.01, + "description": "The amount including VAT for the cash mutation and other bookings" + }, + "VatPercentage": { + "type": "integer", + "description": "The percentage of VAT applied to the cash mutation and other bookings" + }, + "VatTarive": { + "type": "string", + "enum": [ + "high", + "low", + "zero" + ], + "description": "The VAT tarive/category - 'high', 'low', or 'zero'" + }, + "VatType": { + "type": "string", + "enum": [ + "purchase", + "sales" + ], + "description": "The type of VAT operation - 'purchase' or 'sales'" + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid" + } + } + } + } + }, + "required": [ + "AdministrationId", + "Description", + "Date", + "AmountIncludingVat" + ] + }, + "cashmutation-3.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "This endpoint allows you to add cash mutations directly from Point of Sale (POS) applications to the accounting software, streamlining the process of recording and managing cash transactions for businesses. For each cashmutation an request must be done. Only the default cash location is supported.", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "The Administration ID uniquely identifying an administration. Retrieve it from the endpoint: api/administrations" + }, + "CashRegisterId": { + "type": "string", + "format": "uuid", + "description": "The CashRegister ID uniquely identifying an cash register. Retrieve it from the endpoint: api/cashregisters. Falls back to default when empty." + }, + "Description": { + "type": "string", + "description": "The description providing information about the cash mutation and other bookings" + }, + "Date": { + "type": "string", + "format": "date", + "description": "The date when the cash mutation and other bookings occurred" + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "The Ledger Account ID uniquely identifying a ledger account. Retrieve it from the endpoint: api/ledgeraccounts" + }, + "AmountIncludingVat": { + "type": "number", + "multipleOf": 0.01, + "description": "The amount including VAT for the cash mutation and other bookings" + }, + "VatTarive": { + "type": "string", + "enum": [ + "high", + "low", + "zero" + ], + "description": "The VAT tarive/category - 'high', 'low', or 'zero'" + }, + "VatType": { + "type": "string", + "enum": [ + "purchase", + "sales" + ], + "description": "The type of VAT operation - 'purchase' or 'sales'" + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid" + } + } + } + } + }, + "required": [ + "AdministrationId", + "Description", + "Date", + "AmountIncludingVat" + ] + }, + "contact-1.0-Create-JsonSchema": { + "type": "object", + "description": "Create a contact by organisation.", + "required": [ + "OrganisationId", + "Lastname" + ], + "properties": { + "OrganisationId": { + "type": "string", + "format": "uuid", + "examples": [ + "c3bf8c80-08ed-44ea-a842-661a9085d6bf" + ] + }, + "ContactId": { + "type": "string", + "format": "uuid", + "examples": [ + "880ed307-af2e-447d-8440-e26fed53ecc5" + ] + }, + "Firstname": { + "type": "string", + "examples": [ + "Maarten" + ] + }, + "Initials": { + "type": "string", + "examples": [ + "M.H." + ] + }, + "Prefix": { + "type": "string", + "examples": [ + "van" + ] + }, + "Lastname": { + "type": "string", + "examples": [ + "Zandbergen" + ] + }, + "emailaddress": { + "type": "string", + "format": "email", + "examples": [ + "Maarten@vanZandbergen.nl" + ] + }, + "phonenumber": { + "type": "string", + "examples": [ + "+31655887744" + ] + } + }, + "examples": [ + { + "OrganisationId": "c3bf8c80-08ed-44ea-a842-661a9085d6bf", + "Firstname": "Maarten", + "Initials": "M.H.", + "Prefix": "van", + "Lastname": "Zandbergen", + "emailaddress": "Maarten@vanZandbergen.nl", + "phonenumber": "+31655887744" + } + ] + }, + "contact-2.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a contact by organisation.", + "required": [ + "OrganisationId", + "LastName" + ], + "properties": { + "OrganisationId": { + "type": "string", + "format": "uuid", + "examples": [ + "c3bf8c80-08ed-44ea-a842-661a9085d6bf" + ] + }, + "ContactId": { + "type": "string", + "format": "uuid", + "examples": [ + "880ed307-af2e-447d-8440-e26fed53ecc5" + ] + }, + "FirstName": { + "type": "string", + "examples": [ + "Maarten" + ] + }, + "Initials": { + "type": "string", + "examples": [ + "M.H." + ] + }, + "Prefix": { + "type": "string", + "examples": [ + "van" + ] + }, + "LastName": { + "type": "string", + "examples": [ + "Zandbergen" + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "examples": [ + "Maarten@vanZandbergen.nl" + ] + }, + "PhoneNumber": { + "type": "string", + "examples": [ + "+31655887744" + ] + } + }, + "examples": [ + { + "OrganisationId": "c3bf8c80-08ed-44ea-a842-661a9085d6bf", + "FirstName": "Maarten", + "Initials": "M.H.", + "Prefix": "van", + "LastName": "Zandbergen", + "EmailAddress": "Maarten@vanZandbergen.nl", + "PhoneNumber": "+31655887744" + } + ] + }, + "emailaddress-1.0-Create-JsonSchema": { + "type": "object", + "x-examples": { + "Example 1": { + "OrganisationId": "8f03496b-1f42-5ac3-a770-91f9da4e6e12", + "EmailAddress": "j.zandbergen@afasSbPlus.nl" + } + }, + "title": "EmailAddress", + "examples": [ + { + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "EmailAddress": "user@example.com" + } + ], + "properties": { + "OrganisationId": { + "type": "string", + "format": "uuid", + "example": "32abaca0-b4c6-4dce-af80-9de42a830e62" + }, + "EmailAddress": { + "type": "string", + "format": "email" + } + }, + "required": [ + "EmailAddress", + "OrganisationId" + ], + "description": "Create an emailaddress for an organisation." + }, + "emailaddress-2.0-Create-JsonSchema": { + "type": "object", + "x-examples": { + "Organiation": { + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "EmailAddress": "user@example.com" + }, + "Person": { + "RelationType": "person", + "RelationId": "963578e8-7831-4aa4-83c4-e7c3262f0572", + "EmailAddress": "user@example.com" + } + }, + "title": "EmailAddress", + "properties": { + "RelationType": { + "type": "string", + "description": "Must contain one of the enums. Will be required in a future version.", + "enum": [ + "organisation", + "person" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation or person. Will be required in a future version.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "EmailAddress": { + "type": "string", + "format": "email" + } + }, + "required": [ + "EmailAddress", + "RelationType", + "RelationId" + ], + "description": "Create an emailaddress for an organisation or person." + }, + "financialjournalentry-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a financial journal entry.", + "required": [ + "AdministrationId", + "EntryDate", + "Description", + "EntryLine" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "EntryDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-10-12" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntry.", + "examples": [ + "Example Journal 001" + ] + }, + "Attachments": { + "type": "array", + "default": [], + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "default": {}, + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + } + }, + "EntryLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "default": {}, + "required": [ + "LedgerAccountId" + ], + "properties": { + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntryLine.", + "examples": [ + "Sales with high vat type" + ] + }, + "AmountDebit": { + "type": "number", + "multipleOf": 0.01, + "examples": [ + 100.26 + ] + }, + "AmountCredit": { + "type": "number", + "multipleOf": 0.01, + "examples": [ + 100.64 + ] + }, + "VatDirection": { + "type": "string", + "enum": [ + "sales", + "purchases", + "", + "null" + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "special", + "zero", + "", + "null" + ] + }, + "PeriodAllocation": { + "type": "boolean", + "description": "Apportion over a period", + "default": false + }, + "PeriodAllocationBeginDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-01-01" + ] + }, + "PeriodAllocationEndDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + } + }, + "allOf": [ + { + "if": { + "properties": { + "PeriodAllocation": { + "const": true + } + }, + "required": [ + "PeriodAllocation" + ] + }, + "then": { + "required": [ + "PeriodAllocationBeginDate", + "PeriodAllocationEndDate" + ] + } + }, + { + "anyOf": [ + { + "required": [ + "AmountDebit" + ], + "not": { + "required": [ + "AmountCredit" + ] + } + }, + { + "required": [ + "AmountCredit" + ], + "not": { + "required": [ + "AmountDebit" + ] + } + } + ] + } + ] + } + } + } + }, + "financialjournalentry-1.0-Delete-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Delete a financialjournalentry", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of financialjournalentry.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + } + ] + }, + "linestobeinvoiced-1.0-Create-JsonSchema": { + "type": "object", + "description": "Create a line to be invoiced", + "required": [ + "AdministrationId", + "Date", + "Description", + "RelationType", + "RelationId", + "Quantity" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Date": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "Description": { + "type": "string", + "description": "Must contain a description for the Line to be invoiced.", + "examples": [ + "Productomschrijving" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "format": "uuid" + }, + "ItemId": { + "type": "string", + "description": "Must contain Product guid. This can be retrieved through the products endpoint.", + "format": "uuid" + }, + "Quantity": { + "type": "number", + "description": "Quantity of products of this type", + "multipleOf": 0.01 + }, + "Price": { + "type": [ + "number", + "null" + ], + "description": "Price per product, may be left empty if product with price is provided", + "minimum": 0, + "multipleOf": 0.01 + }, + "ProjectId": { + "type": "string", + "description": "Must contain the guid of the project.", + "format": "uuid" + } + } + }, + "linestobeinvoiced-1.0-Delete-JsonSchema": { + "type": "object", + "description": "Delete a line to be invoiced", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of line to be invoiced.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + } + ] + }, + "linestobeinvoiced-1.0-Update-JsonSchema": { + "type": "object", + "description": "Update a line to be invoiced", + "required": [ + "AdministrationId", + "LineToBeInvoicedId", + "Date", + "Description", + "RelationType", + "RelationId", + "Quantity" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "LineToBeInvoicedId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the line to be invoiced", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Date": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the Line to be invoiced.", + "examples": [ + "Example Journal 001" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "format": "uuid" + }, + "ItemId": { + "type": "string", + "description": "Must contain Product guid. This can be retrieved through the products endpoint.", + "format": "uuid" + }, + "Quantity": { + "type": "number", + "description": "Quantity of products of this type", + "multipleOf": 0.01 + }, + "Price": { + "type": [ + "number", + "null" + ], + "description": "Price per product, may be left empty if product with price is provided", + "minimum": 0, + "multipleOf": 0.01 + }, + "ProjectId": { + "type": "string", + "description": "Must contain the guid of the project.", + "format": "uuid" + } + } + }, + "mandates-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create mandate for direct debit payments.", + "required": [ + "AdministrationId", + "RelationType", + "RelationId", + "RelationBankAccountId", + "DateOfSignature" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "RelationBankAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the bankaccount id of the organisation or person.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "AdministrationBankAccountId": { + "type": "string", + "format": "uuid", + "description": "Can contain the guid bankaccount of administration. If none provided de default bankaccount is used.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "MandateReference": { + "type": "string", + "description": "Can contain a reference of the mandates.If none provided an autonumber is used.", + "examples": [ + "Contractnr.FL-23904/P" + ] + }, + "DateOfSignature": { + "type": "string", + "description": "Must contain a date of signature/ approval.", + "format": "date", + "examples": [ + "2025-12-31" + ] + }, + "Attachments": { + "type": "array", + "default": [], + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "default": {}, + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "PeriodOfValidity": { + "type": "boolean", + "description": "Valid over a period", + "default": false + }, + "PeriodOfValidityBeginDate": { + "type": "string", + "format": "date", + "examples": [ + "2025-01-01" + ] + }, + "PeriodOfValidityEndDate": { + "type": "string", + "format": "date", + "examples": [ + "2025-12-31" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "RelationBankAccountId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "AdministrationBankAccountId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "MandateReference": "Contractnr.FL-23904/P", + "DateOfSignature": "2024-12-31", + "Attachments": [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ], + "PeriodOfValidity": true, + "PeriodOfValidityBeginDate": "2025-01-01", + "PeriodOfValidityEndDate": "2025-12-31" + } + ] + }, + "organisation-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "title": "Organisation", + "description": "A JSON schema to represent an organization", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the organisation", + "minLength": 1 + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application." + }, + "cocNumber": { + "type": "string", + "description": "The Chamber of Commerce (CoC) number of the organisation", + "pattern": "^[0-9]+$" + }, + "vatNumber": { + "type": "string", + "description": "The Value-Added Tax (VAT) number of the organisation", + "pattern": "^[A-Z0-9]+$" + }, + "tradename": { + "type": "string", + "description": "The tradename of the organisation" + }, + "sbiCode": { + "type": "string", + "description": "The SBICode of the organisation" + }, + "emailAddress": { + "type": "string", + "format": "email", + "description": "The email address of the organisation" + }, + "website": { + "type": "string", + "format": "uri", + "description": "The website of the organisation" + }, + "phoneNumber": { + "type": "string", + "description": "The phone number of the organisation" + }, + "address": { + "type": "array", + "default": [], + "title": "The address Schema", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "preferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "preferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "preferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "bankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for an organisation", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "AccountHolderName" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "AccountHolderName": { + "type": "string", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen", + "Jan Zandbergen" + ] + }, + "preferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "preferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "name": "Cremin Group", + "cocNumber": "38012622", + "vatNumber": "NL003276211B01", + "tradename": "Quitzon, Schinner and Jakubowski", + "emailAddress": "Kirsten_Bogisich27@example.org", + "website": "http://antoinette.name", + "phoneNumber": "758-646-8786", + "address": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "preferredSupplierAddress": true, + "preferredShippingAddress": false, + "preferredBillingAddress": true + }, + { + "StreetName": "inspiratielaan", + "HouseNumber": 3, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "preferredSupplierAddress": false, + "preferredShippingAddress": true, + "preferredBillingAddress": false + } + ], + "bankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen", + "preferredOutgoingPayments": true, + "preferredIncommingPayments": true + }, + { + "AccountNumber": "NL44DNIB0736664289", + "BankId": "DNIB", + "Bic": "DNIBNL2G", + "CountryCode": "NL", + "AccountHolderName": "Jan Zandbergen", + "preferredOutgoingPayments": false, + "preferredIncommingPayments": false + } + ] + } + ] + }, + "organisation-1.0-Update-JsonSchema": { + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "https://example.com/organization-update-schema", + "type": "object", + "title": "Organization Update Schema", + "description": "A schema for updating the information of an organization, including its name, external identifier, Chamber of Commerce number, and Value-Added Tax number.", + "properties": { + "name": { + "type": "string", + "description": "The name of the organisation", + "minLength": 1, + "maxLength": 100 + }, + "externalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application" + }, + "cocNumber": { + "type": "string", + "pattern": "^[0-9]{8}$", + "description": "The Chamber of Commerce (CoC) number of the organisation" + }, + "vatNumber": { + "type": "string", + "pattern": "^[A-Z0-9]+$", + "description": "The Value-Added Tax (VAT) number of the organisation" + } + } + }, + "organisation-2.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "title": "Organisation", + "description": "A JSON schema to represent an organization", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string", + "description": "The name of the organisation", + "minLength": 1 + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application." + }, + "CocNumber": { + "type": "string", + "description": "The Chamber of Commerce (CoC) number of the organisation", + "pattern": "^[0-9]+$" + }, + "VatNumber": { + "type": "string", + "description": "The Value-Added Tax (VAT) number of the organisation", + "pattern": "^[A-Z0-9]+$" + }, + "Tradename": { + "type": "string", + "description": "The tradename of the organisation" + }, + "SbiCode": { + "type": "string", + "description": "The SBICode of the organisation" + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The email address of the organisation" + }, + "Website": { + "type": "string", + "format": "uri", + "description": "The website of the organisation" + }, + "PhoneNumber": { + "type": "string", + "description": "The phone number of the organisation" + }, + "Addresses": { + "type": "array", + "default": [], + "title": "The address Schema", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for an organisation", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "AccountHolderName" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "AccountHolderName": { + "type": "string", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen", + "Jan Zandbergen" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "Name": "Cremin Group", + "CocNumber": "38012622", + "VatNumber": "NL003276211B01", + "Tradename": "Quitzon, Schinner and Jakubowski", + "EmailAddress": "Kirsten_Bogisich27@example.org", + "Website": "http://antoinette.name", + "PhoneNumber": "758-646-8786", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "inspiratielaan", + "HouseNumber": 3, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL44DNIB0736664289", + "BankId": "DNIB", + "Bic": "DNIBNL2G", + "CountryCode": "NL", + "AccountHolderName": "Jan Zandbergen", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "organisation-3.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "title": "Organisation", + "description": "A JSON schema to represent an organization", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string", + "description": "The name of the organisation", + "minLength": 1 + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application." + }, + "CocNumber": { + "type": "string", + "description": "The Chamber of Commerce (CoC) number of the organisation", + "pattern": "^[0-9]+$" + }, + "VatNumber": { + "type": "string", + "description": "The Value-Added Tax (VAT) number of the organisation", + "pattern": "^[A-Z0-9]+$" + }, + "Tradename": { + "type": "string", + "description": "The tradename of the organisation" + }, + "SbiCode": { + "type": "string", + "description": "The SBICode of the organisation" + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The email address of the organisation" + }, + "Website": { + "type": "string", + "format": "uri", + "description": "The website of the organisation" + }, + "PhoneNumber": { + "type": "string", + "description": "The phone number of the organisation" + }, + "Addresses": { + "type": "array", + "default": [], + "title": "The address Schema", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for an organisation", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "AccountHolderName" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "AccountHolderName": { + "type": "string", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen", + "Jan Zandbergen" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "Name": "Cremin Group", + "CocNumber": "38012622", + "VatNumber": "NL003276211B01", + "Tradename": "Quitzon, Schinner and Jakubowski", + "EmailAddress": "Kirsten_Bogisich27@example.org", + "Website": "http://antoinette.name", + "PhoneNumber": "758-646-8786", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "inspiratielaan", + "HouseNumber": 3, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL44DNIB0736664289", + "BankId": "DNIB", + "Bic": "DNIBNL2G", + "CountryCode": "NL", + "AccountHolderName": "Jan Zandbergen", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "organisation-3.0-Update-JsonSchema": { + "type": "object", + "default": {}, + "title": "Organisation", + "description": "A JSON schema to represent an organization", + "required": [ + "RelationId" + ], + "properties": { + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "Name": { + "type": "string", + "description": "The name of the organisation" + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application." + }, + "CocNumber": { + "type": "string", + "description": "The Chamber of Commerce (CoC) number of the organisation", + "pattern": "^[0-9]+$" + }, + "VatNumber": { + "type": "string", + "description": "The Value-Added Tax (VAT) number of the organisation", + "pattern": "^[A-Z0-9]+$" + }, + "Tradename": { + "type": "string", + "description": "The tradename of the organisation" + }, + "SbiCode": { + "type": "string", + "description": "The SBICode of the organisation" + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The email address of the organisation" + }, + "Website": { + "type": "string", + "format": "uri", + "description": "The website of the organisation" + }, + "PhoneNumber": { + "type": "string", + "description": "The phone number of the organisation" + }, + "Addresses": { + "type": "array", + "default": [], + "title": "The address Schema", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for an organisation", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "AccountHolderName" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "AccountHolderName": { + "type": "string", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen", + "Jan Zandbergen" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "Name": "Cremin Group", + "CocNumber": "38012622", + "VatNumber": "NL003276211B01", + "Tradename": "Quitzon, Schinner and Jakubowski", + "EmailAddress": "Kirsten_Bogisich27@example.org", + "Website": "http://antoinette.name", + "PhoneNumber": "758-646-8786", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "inspiratielaan", + "HouseNumber": 3, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL44DNIB0736664289", + "BankId": "DNIB", + "Bic": "DNIBNL2G", + "CountryCode": "NL", + "AccountHolderName": "Jan Zandbergen", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "organisation-4.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "title": "Organisation", + "description": "A JSON schema to represent an organization", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string", + "description": "The name of the organisation", + "minLength": 1 + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application." + }, + "CocNumber": { + "type": "string", + "description": "The Chamber of Commerce (CoC) number of the organisation", + "pattern": "^[0-9]+$" + }, + "VatNumber": { + "type": "string", + "description": "The Value-Added Tax (VAT) number of the organisation", + "pattern": "^[A-Z0-9]+$" + }, + "Tradename": { + "type": "string", + "description": "The tradename of the organisation" + }, + "SbiCode": { + "type": "string", + "description": "The SBICode of the organisation" + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The email address of the organisation" + }, + "Website": { + "type": "string", + "description": "The website of the organisation" + }, + "PhoneNumber": { + "type": "string", + "description": "The phone number of the organisation" + }, + "Addresses": { + "type": "array", + "default": [], + "title": "The address Schema", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for an organisation", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "AccountHolderName" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "AccountHolderName": { + "type": "string", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen", + "Jan Zandbergen" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "Name": "Cremin Group", + "CocNumber": "38012622", + "VatNumber": "NL003276211B01", + "Tradename": "Quitzon, Schinner and Jakubowski", + "EmailAddress": "Kirsten_Bogisich27@example.org", + "Website": "http://antoinette.name", + "PhoneNumber": "758-646-8786", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "inspiratielaan", + "HouseNumber": 3, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL44DNIB0736664289", + "BankId": "DNIB", + "Bic": "DNIBNL2G", + "CountryCode": "NL", + "AccountHolderName": "Jan Zandbergen", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "organisation-4.0-Update-JsonSchema": { + "type": "object", + "default": {}, + "title": "Organisation", + "description": "A JSON schema to represent an organization", + "required": [ + "RelationId" + ], + "properties": { + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "Name": { + "type": "string", + "description": "The name of the organisation" + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application." + }, + "CocNumber": { + "type": "string", + "description": "The Chamber of Commerce (CoC) number of the organisation", + "pattern": "^[0-9]+$" + }, + "VatNumber": { + "type": "string", + "description": "The Value-Added Tax (VAT) number of the organisation", + "pattern": "^[A-Z0-9]+$" + }, + "Tradename": { + "type": "string", + "description": "The tradename of the organisation" + }, + "SbiCode": { + "type": "string", + "description": "The SBICode of the organisation" + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The email address of the organisation" + }, + "Website": { + "type": "string", + "description": "The website of the organisation" + }, + "PhoneNumber": { + "type": "string", + "description": "The phone number of the organisation" + }, + "Addresses": { + "type": "array", + "default": [], + "title": "The address Schema", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for an organisation", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "AccountHolderName" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "AccountHolderName": { + "type": "string", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen", + "Jan Zandbergen" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "Name": "Cremin Group", + "CocNumber": "38012622", + "VatNumber": "NL003276211B01", + "Tradename": "Quitzon, Schinner and Jakubowski", + "EmailAddress": "Kirsten_Bogisich27@example.org", + "Website": "http://antoinette.name", + "PhoneNumber": "758-646-8786", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "inspiratielaan", + "HouseNumber": 3, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL44DNIB0736664289", + "BankId": "DNIB", + "Bic": "DNIBNL2G", + "CountryCode": "NL", + "AccountHolderName": "Jan Zandbergen", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "payrolljournalentry-1.0-Create-JsonSchema": { + "type": "object", + "title": "PayrollJournalEntry", + "description": "Create a Payroll entry.", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Use GET ../Administration" + }, + "Description": { + "type": "string" + }, + "Date": { + "type": "string", + "format": "date", + "example": "2023-01-31" + }, + "PayrollJournalEntryLine": { + "type": "array", + "items": { + "type": "object", + "properties": { + "LedgerAccountNumber": { + "type": "string", + "description": "Number of the ledger account GET ../LegderAccount" + }, + "AmountDebit": { + "type": "number", + "minimum": 0, + "multipleOf": 0.01, + "example": 1403.65 + }, + "AmountCredit": { + "type": "number", + "minimum": 0, + "multipleOf": 0.01, + "example": 2650.33 + } + }, + "required": [ + "LedgerAccountNumber" + ] + } + } + }, + "required": [ + "AdministrationId", + "Description", + "Date", + "PayrollJournalEntryLine" + ] + }, + "person-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "title": "Person", + "type": "object", + "required": [ + "lastName" + ], + "properties": { + "firstName": { + "type": "string", + "description": "The first name of the person.", + "examples": [ + "John" + ] + }, + "lastName": { + "type": "string", + "description": "The last name of the person.", + "examples": [ + "Doe" + ] + }, + "Initials": { + "type": "string", + "description": "The initials of the person.", + "examples": [ + "J.D." + ] + }, + "Prefix": { + "type": "string", + "description": "The prefix of the lastname.", + "examples": [ + "van." + ] + }, + "emailaddress": { + "type": "string", + "format": "email", + "description": "The emailaddress of the person", + "examples": [ + "johndoe@gmail.com" + ] + }, + "phonenumber": { + "type": "string", + "description": "The phonenumber of the person", + "examples": [ + "1-555-123-4567" + ] + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the person to use for a client application.", + "examples": [ + "987654321" + ] + }, + "address": { + "type": "array", + "default": [], + "description": "Create 1 or more addresses for a person", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "preferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "preferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "preferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "bankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for a person", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "CountryCode" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "preferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "preferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "Firstname": "John", + "Initials": "J", + "Prefix": "Mr", + "lastName": "Doe", + "emailaddress": "johndoe@gmail.com", + "phonenumber": "1-555-123-4567", + "address": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "preferredSupplierAddress": true, + "preferredShippingAddress": false, + "preferredBillingAddress": true + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "preferredSupplierAddress": false, + "preferredShippingAddress": true, + "preferredBillingAddress": false + } + ], + "bankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "preferredOutgoingPayments": true, + "preferredIncommingPayments": true + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "preferredOutgoingPayments": false, + "preferredIncommingPayments": false + } + ] + } + ] + }, + "person-2.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "title": "Person", + "type": "object", + "required": [ + "LastName" + ], + "properties": { + "FirstName": { + "type": "string", + "description": "The first name of the person.", + "examples": [ + "John" + ] + }, + "LastName": { + "type": "string", + "description": "The last name of the person.", + "examples": [ + "Doe" + ] + }, + "Initials": { + "type": "string", + "description": "The initials of the person.", + "examples": [ + "J.D." + ] + }, + "Prefix": { + "type": "string", + "description": "The prefix of the lastname.", + "examples": [ + "van." + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The emailaddress of the person", + "examples": [ + "johndoe@gmail.com" + ] + }, + "PhoneNumber": { + "type": "string", + "description": "The phonenumber of the person", + "examples": [ + "1-555-123-4567" + ] + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the person to use for a client application.", + "examples": [ + "987654321" + ] + }, + "Addresses": { + "type": "array", + "default": [], + "description": "Create 1 or more addresses for a person", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for a person", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "CountryCode" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "FirstName": "John", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Doe", + "EmailAddress": "johndoe@gmail.com", + "PhoneNumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "person-3.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "title": "Person", + "type": "object", + "required": [ + "LastName" + ], + "properties": { + "FirstName": { + "type": "string", + "description": "The first name of the person.", + "examples": [ + "John" + ] + }, + "LastName": { + "type": "string", + "description": "The last name of the person.", + "examples": [ + "Doe" + ] + }, + "Initials": { + "type": "string", + "description": "The initials of the person.", + "examples": [ + "J.D." + ] + }, + "Prefix": { + "type": "string", + "description": "The prefix of the lastname.", + "examples": [ + "van." + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The emailaddress of the person", + "examples": [ + "johndoe@gmail.com" + ] + }, + "PhoneNumber": { + "type": "string", + "description": "The phonenumber of the person", + "examples": [ + "1-555-123-4567" + ] + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the person to use for a client application.", + "examples": [ + "987654321" + ] + }, + "Addresses": { + "type": "array", + "default": [], + "description": "Create 1 or more addresses for a person", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for a person", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "CountryCode", + "BankId" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "FirstName": "John", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Doe", + "EmailAddress": "johndoe@gmail.com", + "PhoneNumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "person-3.0-Update-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "title": "Person", + "type": "object", + "required": [ + "RelationId" + ], + "properties": { + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the person.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "FirstName": { + "type": "string", + "description": "The first name of the person.", + "examples": [ + "John" + ] + }, + "LastName": { + "type": "string", + "description": "The last name of the person.", + "examples": [ + "Doe" + ] + }, + "Initials": { + "type": "string", + "description": "The initials of the person.", + "examples": [ + "J.D." + ] + }, + "Prefix": { + "type": "string", + "description": "The prefix of the lastname.", + "examples": [ + "van." + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The emailaddress of the person", + "examples": [ + "johndoe@gmail.com" + ] + }, + "PhoneNumber": { + "type": "string", + "description": "The phonenumber of the person", + "examples": [ + "1-555-123-4567" + ] + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the person to use for a client application.", + "examples": [ + "987654321" + ] + }, + "Addresses": { + "type": "array", + "default": [], + "description": "Create 1 or more addresses for a person", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for a person", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "CountryCode" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "FirstName": "John", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Doe", + "EmailAddress": "johndoe@gmail.com", + "PhoneNumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "person-4.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "title": "Person", + "type": "object", + "required": [ + "LastName" + ], + "properties": { + "FirstName": { + "type": "string", + "description": "The first name of the person.", + "examples": [ + "John" + ] + }, + "LastName": { + "type": "string", + "description": "The last name of the person.", + "examples": [ + "Doe" + ] + }, + "Initials": { + "type": "string", + "description": "The initials of the person.", + "examples": [ + "J.D." + ] + }, + "Prefix": { + "type": "string", + "description": "The prefix of the lastname.", + "examples": [ + "van." + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The emailaddress of the person", + "examples": [ + "johndoe@gmail.com" + ] + }, + "PhoneNumber": { + "type": "string", + "description": "The phonenumber of the person", + "examples": [ + "1-555-123-4567" + ] + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the person to use for a client application.", + "examples": [ + "987654321" + ] + }, + "Addresses": { + "type": "array", + "default": [], + "description": "Create 1 or more addresses for a person", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for a person", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "CountryCode", + "BankId" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "FirstName": "John", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Doe", + "EmailAddress": "johndoe@gmail.com", + "PhoneNumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "person-4.0-Update-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "title": "Person", + "type": "object", + "required": [ + "RelationId" + ], + "properties": { + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the person.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "FirstName": { + "type": "string", + "description": "The first name of the person.", + "examples": [ + "John" + ] + }, + "LastName": { + "type": "string", + "description": "The last name of the person.", + "examples": [ + "Doe" + ] + }, + "Initials": { + "type": "string", + "description": "The initials of the person.", + "examples": [ + "J.D." + ] + }, + "Prefix": { + "type": "string", + "description": "The prefix of the lastname.", + "examples": [ + "van." + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The emailaddress of the person", + "examples": [ + "johndoe@gmail.com" + ] + }, + "PhoneNumber": { + "type": "string", + "description": "The phonenumber of the person", + "examples": [ + "1-555-123-4567" + ] + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the person to use for a client application.", + "examples": [ + "987654321" + ] + }, + "Addresses": { + "type": "array", + "default": [], + "description": "Create 1 or more addresses for a person", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for a person", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "CountryCode" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "FirstName": "John", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Doe", + "EmailAddress": "johndoe@gmail.com", + "PhoneNumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "phonenumber-1.0-Create-JsonSchema": { + "type": "object", + "x-stoplight": { + "id": "vfjbed9j7fve7" + }, + "x-examples": { + "Example 1": { + "OrganisationId": "8f03496b-1f42-5ac3-a770-91f9da4e6e12", + "EmailAddress": "j.zandbergen@afasSbPlus.nl" + } + }, + "title": "PhoneNumber", + "examples": [ + { + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "PhoneNumber": "112346546546" + }, + { + "OrganisationId": "32abaca0-b4c6-4dce-af80-9de42a830e62", + "PhoneNumber": "65465454" + }, + { + "RelationType": "person", + "RelationId": "963578e8-7831-4aa4-83c4-e7c3262f0572", + "PhoneNumber": "6546545" + } + ], + "description": "Create a PhoneNumber for an organisation or person.", + "properties": { + "RelationType": { + "type": "string", + "description": "Must contain one of the enums. Will be required in a future version.", + "enum": [ + "organisation", + "person" + ], + "x-stoplight": { + "id": "uqd7z1nx8fqye" + } + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation or person. Will be required in a future version.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ], + "x-stoplight": { + "id": "iwy8izvm2ahpb" + } + }, + "OrganisationId": { + "type": "string", + "format": "uuid", + "example": "32abaca0-b4c6-4dce-af80-9de42a830e62", + "x-stoplight": { + "id": "n7l99rqkoa197" + } + }, + "PhoneNumber": { + "type": "string", + "description": " All characters of the phonenumber that are not a diget will be removed.", + "x-stoplight": { + "id": "8gusb7enrefaq" + } + } + }, + "required": [ + "PhoneNumber" + ] + }, + "purchaseinvoice-1.0-Create-JsonSchema": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string" + }, + "SupplierInvoiceId": { + "type": "string" + }, + "OrderReference": { + "type": "string" + }, + "SupplierOrganisationId": { + "type": "string" + }, + "IssueDate": { + "type": "string" + }, + "DueDate": { + "type": "string" + }, + "PlannedPaymentDate": { + "type": "string" + }, + "PaymentMethodId": { + "type": "string" + }, + "Attachments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AttachmentId": { + "type": "string" + } + } + } + }, + "InvoiceLine": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Description": { + "type": "string" + }, + "LedgerAccountNumberId": { + "type": "string" + }, + "LineExtensionAmount": { + "type": "string" + }, + "TaxAmount": { + "type": "string" + }, + "VatTypeId": { + "type": "string" + }, + "VatRateId": { + "type": "string" + }, + "PerformanceDateTypeId": { + "type": "string" + }, + "OtherPerformanceDate": { + "type": "string" + }, + "PerformanceStartDate": { + "type": "string" + }, + "PerformanceEndDate": { + "type": "string" + }, + "LineNumber": { + "type": "integer" + } + } + } + } + }, + "x-examples": { + "Example 1": { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "SupplierInvoiceId": "Pur002", + "OrderReference": "stringstringstring", + "SupplierOrganisationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "IssueDate": "2022-10-10", + "DueDate": "2022-10-31", + "PlannedPaymentDate": "2022-10-15", + "PaymentMethodId": "afa50000-0000-0102-b0d1-f91a25e6c442", + "Attachments": [ + { + "AttachmentId": "46db28a3-ad46-43aa-a8da-226ead20010a" + } + ], + "InvoiceLine": [ + { + "Description": "test inkoop", + "LedgerAccountNumberId": "6099", + "LineExtensionAmount": "100", + "TaxAmount": "21", + "VatTypeId": "afa50000-0000-0b71-8790-807f97e85c54", + "VatRateId": "afa50000-0000-0465-aa85-e1a761ca3a33", + "PerformanceDateTypeId": "", + "OtherPerformanceDate": "", + "PerformanceStartDate": "", + "PerformanceEndDate": "", + "LineNumber": 0 + } + ] + } + }, + "title": "PurchaseInvoice", + "description": "", + "examples": [ + { + "AdministrationId": "string", + "SupplierInvoiceId": "string", + "OrderReference": "string", + "SupplierOrganisationId": "string", + "IssueDate": "string", + "DueDate": "string", + "PlannedPaymentDate": "string", + "PaymentMethodId": "string", + "Attachments": [ + { + "AttachmentId": "string" + } + ], + "InvoiceLine": [ + { + "Description": "string", + "LedgerAccountNumberId": "string", + "LineExtensionAmount": "string", + "TaxAmount": "string", + "VatTypeId": "string", + "VatRateId": "string", + "PerformanceDateTypeId": "string", + "OtherPerformanceDate": "string", + "PerformanceStartDate": "string", + "PerformanceEndDate": "string", + "LineNumber": 0 + } + ] + } + ] + }, + "purchasejournalentry-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a purchase journal entry.", + "required": [ + "AdministrationId", + "InvoiceNumber", + "RelationType", + "RelationId", + "InvoiceDate", + "InvoiceLine", + "DueDate" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "InvoiceNumber": { + "type": "string", + "description": "Must contain the InvoiceNumber", + "examples": [ + "PUR00001" + ] + }, + "Reference": { + "type": "string", + "description": "Can contain a reference id to the origin app.", + "examples": [ + "ExternalAppId001" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "InvoiceDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "DueDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-12-31" + ] + }, + "PlannedPaymentDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-12-15" + ] + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to customer default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "InvoiceLine": { + "type": "array", + "items": { + "type": "object", + "required": [ + "LedgerAccountId", + "AmountExcludingVat", + "VatType" + ], + "properties": { + "Description": { + "type": "string", + "examples": [ + "Dell Custom keyboard" + ] + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "AmountExcludingVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 100 + ] + }, + "AmountVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 21 + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Only include if vat is reverse-charge or exemption.", + "enum": [ + "reversecharged", + "exempt", + "", + "null" + ] + } + } + } + } + } + }, + "purchasejournalentry-1.1-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a purchase journal entry.", + "required": [ + "AdministrationId", + "InvoiceNumber", + "RelationType", + "RelationId", + "InvoiceDate", + "InvoiceLine", + "DueDate" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "InvoiceNumber": { + "type": "string", + "description": "Must contain the InvoiceNumber", + "examples": [ + "PUR00001" + ] + }, + "Reference": { + "type": "string", + "description": "Can contain a reference id to the origin app.", + "examples": [ + "ExternalAppId001" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "InvoiceDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "DueDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-12-31" + ] + }, + "PlannedPaymentDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-12-15" + ] + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to supplier default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "InvoiceLine": { + "type": "array", + "items": { + "type": "object", + "required": [ + "LedgerAccountId", + "AmountExcludingVat", + "VatType" + ], + "properties": { + "Description": { + "type": "string", + "examples": [ + "Dell Custom keyboard" + ] + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "AmountExcludingVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 100 + ] + }, + "AmountVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 21 + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Only include if vat is reverse-charge or exemption.", + "enum": [ + "reversecharged", + "exempt", + "", + "null" + ] + } + } + } + } + } + }, + "purchasejournalentry-2.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a purchase journal entry", + "required": [ + "AdministrationId", + "InvoiceNumber", + "RelationType", + "RelationId", + "InvoiceDate", + "InvoiceLine", + "DueDate" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "InvoiceNumber": { + "type": "string", + "description": "Must contain the InvoiceNumber", + "examples": [ + "PUR00001" + ] + }, + "Reference": { + "type": "string", + "description": "Can contain a reference id to the origin app.", + "examples": [ + "ExternalAppId001" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "InvoiceDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "DueDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-12-31" + ] + }, + "PlannedPaymentDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-12-15" + ] + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to supplier default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "InvoiceLine": { + "type": "array", + "items": { + "type": "object", + "required": [ + "LedgerAccountId", + "AmountExcludingVat", + "VatType" + ], + "properties": { + "Description": { + "type": "string", + "examples": [ + "Dell Custom keyboard" + ] + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "AmountExcludingVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 100 + ] + }, + "AmountVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 21 + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Only include if vat is reverse-charge or exemption.", + "enum": [ + "reversecharged", + "exempt", + "", + "null" + ] + }, + "AlternativeAllocationDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + }, + "PeriodAllocation": { + "type": "boolean", + "description": "Apportion over a period", + "default": false + }, + "PeriodAllocationBeginDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-01-01" + ] + }, + "PeriodAllocationEndDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + } + } + } + } + } + }, + "salesinvoice-1.0-Create-JsonSchema": { + "type": "object", + "description": "Create a sales invoice.", + "properties": { + "AdministrationId": { + "type": "string", + "description": "Must contain the Administration guid of the target Administration", + "format": "uuid" + }, + "IssueDate": { + "type": "string", + "format": "date" + }, + "Reference": { + "type": "string" + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "format": "uuid" + }, + "AddressId": { + "type": "string", + "format": "uuid" + }, + "SentInvoiceEmail": { + "type": "boolean", + "description": "Sent the invoice as an email to the relation.", + "default": true + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid" + } + }, + "required": [ + "AttachmentId" + ] + } + }, + "InvoiceLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "properties": { + "ItemId": { + "type": "string", + "description": "Must contain Product guid. This can be retrieved through the products endpoint.", + "format": "uuid" + }, + "Price": { + "type": "number", + "description": "Price per product excluding VAT.", + "minimum": 0, + "multipleOf": 0.01 + }, + "Quantity": { + "type": "integer", + "description": "Quantity of products of this type" + }, + "ExtraDescription": { + "type": "string", + "description": "Optional field for extra information about the invoiceline" + } + }, + "required": [ + "ItemId", + "Price", + "Quantity" + ] + } + } + }, + "required": [ + "AdministrationId", + "IssueDate", + "RelationType", + "RelationId", + "InvoiceLine" + ] + }, + "salesinvoice-1.1-Create-JsonSchema": { + "type": "object", + "description": "Create a sales invoice.", + "properties": { + "AdministrationId": { + "type": "string", + "description": "Must contain the Administration guid of the target Administration", + "format": "uuid" + }, + "IssueDate": { + "type": "string", + "format": "date" + }, + "Reference": { + "type": "string" + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "format": "uuid" + }, + "AddressId": { + "type": "string", + "format": "uuid" + }, + "SentInvoiceEmail": { + "type": "boolean", + "description": "Sent the invoice as an email to the relation.", + "default": true + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid" + } + }, + "required": [ + "AttachmentId" + ] + } + }, + "InvoiceLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "properties": { + "ItemId": { + "type": "string", + "description": "Must contain Product guid. This can be retrieved through the products endpoint.", + "format": "uuid" + }, + "Price": { + "type": "number", + "multipleOf": 0.01, + "description": "Price per product excluding VAT." + }, + "Quantity": { + "type": "number", + "description": "Quantity of products of this type", + "multipleOf": 0.01 + }, + "ExtraDescription": { + "type": "string", + "description": "Optional field for extra information about the invoiceline" + } + }, + "required": [ + "ItemId", + "Quantity" + ] + } + } + }, + "required": [ + "AdministrationId", + "IssueDate", + "RelationType", + "RelationId", + "InvoiceLine" + ] + }, + "salesinvoice-2.0-Create-JsonSchema": { + "type": "object", + "description": "Create a sales invoice.", + "properties": { + "AdministrationId": { + "type": "string", + "description": "Must contain the Administration guid of the target Administration", + "format": "uuid" + }, + "IssueDate": { + "type": "string", + "format": "date" + }, + "Reference": { + "type": "string" + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "format": "uuid" + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to customer default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "AddressId": { + "type": "string", + "format": "uuid" + }, + "SentInvoiceEmail": { + "type": "boolean", + "description": "Sent the invoice as an email to the relation." + }, + "ToBeInvoiced": { + "type": "boolean", + "description": "Make a invoice that is not yet completed or sent to the relation." + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid" + } + }, + "required": [ + "AttachmentId" + ] + } + }, + "InvoiceLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "properties": { + "ItemId": { + "type": "string", + "description": "Must contain Product guid. This can be retrieved through the products endpoint.", + "format": "uuid" + }, + "Price": { + "type": "number", + "description": "Price per product excluding VAT. Falls back to product default when empty." + }, + "Quantity": { + "type": "number", + "description": "Quantity of products of this type", + "multipleOf": 0.01 + }, + "VatType": { + "type": "string", + "description": "Vat tarive. Falls back to product default when empty.", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "ExtraDescription": { + "type": "string", + "description": "Optional field for extra information about the invoiceline" + }, + "AlternativeAllocationDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + }, + "PeriodAllocation": { + "type": "boolean", + "description": "Apportion over a period", + "default": false + }, + "PeriodAllocationBeginDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-01-01" + ] + }, + "PeriodAllocationEndDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + } + }, + "required": [ + "ItemId", + "Quantity" + ] + } + } + }, + "required": [ + "AdministrationId", + "IssueDate", + "RelationType", + "RelationId", + "InvoiceLine", + "SentInvoiceEmail" + ] + }, + "salesinvoice-2.0-Delete-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Delete a salesinvoice", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of salesinvoice.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + } + ] + }, + "salesjournalentry-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a sales journal entry.", + "required": [ + "AdministrationId", + "InvoiceDate", + "InvoiceNumber", + "RelationType", + "RelationId", + "InvoiceLine" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "InvoiceDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "InvoiceNumber": { + "type": "string", + "description": "Must contain the InvoiceNumber", + "examples": [ + "VK004917" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "Reference": { + "type": "string", + "description": "Can contain a reference id to the origin app.", + "examples": [ + "ExternalAppId001" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntry.", + "examples": [ + "Example Invoice 001" + ] + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to customer default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "PaymentConditionId": { + "type": "string", + "format": "uuid", + "description": "Payment condition guids can be requested with the PaymentCondition Get endpoint. Falls back to default when empty.", + "examples": [ + "986d98be-e74d-58f2-95f7-e641769ac64f" + ] + }, + "Attachments": { + "type": "array", + "default": [], + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "default": {}, + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "InvoiceLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "default": {}, + "required": [ + "LedgerAccountId", + "AmountExcludingVat", + "VatType" + ], + "allOf": [ + { + "if": { + "properties": { + "VatType": { + "enum": [ + "high", + "low" + ] + } + }, + "required": [ + "VatType" + ] + }, + "then": { + "required": [ + "AmountVat" + ] + } + } + ], + "properties": { + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntryLine.", + "examples": [ + "Sales with high vat type" + ] + }, + "AmountExcludingVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 100 + ] + }, + "AmountVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 21 + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "IntraCommunityType": { + "type": "string", + "description": "Only include if sale is B2B and inside EU (ICP purposes). Falls back to setting (default 'supplies') when empty.", + "enum": [ + "supplies", + "services", + "", + "null" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Only include if vat is reverse-charge or exemption.", + "enum": [ + "reversecharged", + "exempt", + "", + "null" + ] + } + } + }, + "examples": [ + [ + { + "LedgerAccountId": "93b4b2cb-2174-56ff-b6f6-0031527e01e1", + "AmountExcludingVat": 116.52, + "AmountVat": 24.47, + "VatType": "high", + "VatCalculation": "exempt" + } + ] + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "InvoiceDate": "2022-10-12", + "InvoiceNumber": "VK004917", + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "Reference": "ExternalAppId001", + "Description": "Example Invoice 001", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "986d98be-e74d-58f2-95f7-e641769ac64f", + "Attachments": [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ], + "InvoiceLine": [ + { + "LedgerAccountId": "93b4b2cb-2174-56ff-b6f6-0031527e01e1", + "AmountExcludingVat": 116.52, + "AmountVat": 24.47, + "VatType": "high", + "VatCalculation": "exempt" + } + ] + } + ] + }, + "salesjournalentry-2.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a sales journal entry.", + "required": [ + "AdministrationId", + "InvoiceDate", + "InvoiceNumber", + "RelationType", + "RelationId", + "InvoiceLine" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "InvoiceDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "InvoiceNumber": { + "type": "string", + "description": "Must contain the InvoiceNumber", + "examples": [ + "VK004917" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "Reference": { + "type": "string", + "description": "Can contain a reference id to the origin app.", + "examples": [ + "ExternalAppId001" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntry.", + "examples": [ + "Example Invoice 001" + ] + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to customer default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "PaymentConditionId": { + "type": "string", + "format": "uuid", + "description": "Payment condition guids can be requested with the PaymentCondition Get endpoint. Falls back to default when empty.", + "examples": [ + "986d98be-e74d-58f2-95f7-e641769ac64f" + ] + }, + "PaymentReference": { + "type": "string", + "description": "Can contain the PaymentReference", + "examples": [ + "tr_FLtHQ7oSDG" + ] + }, + "Attachments": { + "type": "array", + "default": [], + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "default": {}, + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "InvoiceLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "default": {}, + "required": [ + "LedgerAccountId", + "AmountExcludingVat", + "VatType" + ], + "allOf": [ + { + "if": { + "properties": { + "VatType": { + "enum": [ + "high", + "low" + ] + } + }, + "required": [ + "VatType" + ] + }, + "then": { + "required": [ + "AmountVat" + ] + } + } + ], + "properties": { + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntryLine.", + "examples": [ + "Sales with high vat type" + ] + }, + "AmountExcludingVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 100 + ] + }, + "AmountVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 21 + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "IntraCommunityType": { + "type": "string", + "description": "Only include if sale is B2B and inside EU (ICP purposes). Falls back to default 'supplies' when empty.", + "enum": [ + "supplies", + "services", + "", + "null" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Only include if vat is reverse-charge or exemption.", + "enum": [ + "reversecharged", + "exempt", + "", + "null" + ] + } + } + }, + "examples": [ + [ + { + "LedgerAccountId": "93b4b2cb-2174-56ff-b6f6-0031527e01e1", + "AmountExcludingVat": 116.52, + "AmountVat": 24.47, + "VatType": "high", + "VatCalculation": "exempt" + } + ] + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "InvoiceDate": "2022-10-12", + "InvoiceNumber": "VK004917", + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "Reference": "ExternalAppId001", + "Description": "Example Invoice 001", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "986d98be-e74d-58f2-95f7-e641769ac64f", + "Attachments": [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ], + "InvoiceLine": [ + { + "LedgerAccountId": "93b4b2cb-2174-56ff-b6f6-0031527e01e1", + "AmountExcludingVat": 116.52, + "AmountVat": 24.47, + "VatType": "high", + "VatCalculation": "exempt" + } + ] + } + ] + }, + "salesjournalentry-2.0-Delete-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Delete a salesjournalentry", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of salesjournal.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + } + ] + }, + "salesjournalentry-2.0-Update-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Update a sales journal entry.", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the salesjournalentry.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "PaymentReference": { + "type": "string", + "description": "Can contain the PaymentReference", + "examples": [ + "tr_FLtHQ7oSDG" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "PaymentReference": "tr_FLtHQ7oSDG" + } + ] + }, + "salesjournalentry-2.1-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a sales journal entry.", + "required": [ + "AdministrationId", + "InvoiceDate", + "InvoiceNumber", + "RelationType", + "RelationId", + "InvoiceLine" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "InvoiceDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "InvoiceNumber": { + "type": "string", + "description": "Must contain the InvoiceNumber", + "examples": [ + "VK004917" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "Reference": { + "type": "string", + "description": "Can contain a reference id to the origin app.", + "examples": [ + "ExternalAppId001" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntry.", + "examples": [ + "Example Invoice 001" + ] + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to customer default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "PaymentConditionId": { + "type": "string", + "format": "uuid", + "description": "Payment condition guids can be requested with the PaymentCondition Get endpoint. Falls back to default when empty.", + "examples": [ + "986d98be-e74d-58f2-95f7-e641769ac64f" + ] + }, + "PaymentReference": { + "type": "string", + "description": "Can contain the PaymentReference", + "examples": [ + "tr_FLtHQ7oSDG" + ] + }, + "Attachments": { + "type": "array", + "default": [], + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "default": {}, + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "InvoiceLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "default": {}, + "required": [ + "LedgerAccountId", + "AmountExcludingVat" + ], + "allOf": [ + { + "if": { + "properties": { + "VatType": { + "enum": [ + "high", + "low" + ] + } + }, + "required": [ + "VatType" + ] + }, + "then": { + "required": [ + "AmountVat" + ] + } + }, + { + "if": { + "not": { + "properties": { + "VatCalculation": { + "const": "novat" + } + } + } + }, + "then": { + "required": [ + "VatType" + ] + } + } + ], + "properties": { + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntryLine.", + "examples": [ + "Sales with high vat type" + ] + }, + "AmountExcludingVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 100 + ] + }, + "AmountVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 21 + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "IntraCommunityType": { + "type": "string", + "description": "Only include if sale is B2B and inside EU (ICP purposes). Falls back to default 'supplies' when empty.", + "enum": [ + "supplies", + "services", + "", + "null" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Only include if vat is reverse-charge or exemption.", + "enum": [ + "reversecharged", + "exempt", + "novat", + "", + "null" + ] + }, + "AlternativeAllocationDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + }, + "PeriodAllocation": { + "type": "boolean", + "description": "Apportion over a period", + "default": false + }, + "PeriodAllocationBeginDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-01-01" + ] + }, + "PeriodAllocationEndDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + } + } + }, + "examples": [ + [ + { + "LedgerAccountId": "93b4b2cb-2174-56ff-b6f6-0031527e01e1", + "AmountExcludingVat": 116.52, + "AmountVat": 24.47, + "VatType": "high", + "VatCalculation": "exempt" + } + ] + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "InvoiceDate": "2022-10-12", + "InvoiceNumber": "VK004917", + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "Reference": "ExternalAppId001", + "Description": "Example Invoice 001", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "986d98be-e74d-58f2-95f7-e641769ac64f", + "Attachments": [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ], + "InvoiceLine": [ + { + "LedgerAccountId": "93b4b2cb-2174-56ff-b6f6-0031527e01e1", + "AmountExcludingVat": 116.52, + "AmountVat": 24.47, + "VatType": "high", + "VatCalculation": "exempt" + } + ] + } + ] + }, + "salesjournalentry-2.1-Delete-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Delete a salesjournalentry", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of salesjournal.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + } + ] + }, + "salesjournalentry-2.1-Update-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Update a sales journal entry.", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the salesjournalentry.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "PaymentReference": { + "type": "string", + "description": "Can contain the PaymentReference", + "examples": [ + "tr_FLtHQ7oSDG" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "PaymentReference": "tr_FLtHQ7oSDG" + } + ] + }, + "supplier-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "description": "Create a supplier.", + "required": [ + "AdministrationId" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "examples": [ + "leverancier@afas.nl" + ] + }, + "PhoneNumber": { + "type": "string", + "examples": [ + "+31655887744" + ] + }, + "BankAccountNumber": { + "type": "string", + "description": "Must be in IBAN format. Creates a bankaccount record for the supplier", + "examples": [ + "NL03BOFA0011792833" + ] + }, + "BIC": { + "type": "string", + "description": "If the Bic code is not available the BIC code will be looked up. If its not found an error will be raised", + "examples": [ + "BOFANLNX" + ] + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Set default value for supplier.", + "examples": [ + "c0441b65-1ca8-534c-8e45-acab8d30b325" + ] + }, + "PaymentMethod": { + "type": "string", + "default": "banktransfer", + "description": "Set default value for supplier. Falls back to supplier default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "PaymentConditionId": { + "type": "string", + "format": "uuid", + "description": "Set default value for supplier. Payment condition guids can be requested with the PaymentCondition Get endpoint. Falls back to default when empty.", + "examples": [ + "986d98be-e74d-58f2-95f7-e641769ac64f" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Set de value for supplier.", + "enum": [ + "charged", + "novat", + "reversecharged", + "exempt", + "", + "null" + ] + }, + "Person": { + "type": "object", + "default": {}, + "title": "The Person Schema", + "required": [ + "Lastname" + ], + "properties": { + "Firstname": { + "type": "string", + "title": "The Firstname Schema", + "examples": [ + "Jan" + ] + }, + "Initials": { + "type": "string", + "title": "The Initials Schema", + "examples": [ + "JH" + ] + }, + "Prefix": { + "type": "string", + "title": "The Prefix Schema", + "examples": [ + "van" + ] + }, + "Lastname": { + "type": "string", + "title": "The Lastname Schema", + "examples": [ + "Pinksteren" + ] + } + }, + "examples": [ + { + "Firstname": "Jan", + "Initials": "JH", + "Prefix": "van", + "Lastname": "Pinksteren" + } + ] + }, + "Organisation": { + "type": "object", + "default": {}, + "title": "The Organisation Schema", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string", + "default": "", + "title": "The Name Schema", + "examples": [ + "Jansen IJzerwaren" + ] + }, + "CompanyIdCoc": { + "type": "string", + "description": "Contains the CompanyCode also known in dutch as KVK nummer", + "examples": [ + "04019167" + ] + }, + "CompanyIdVat": { + "type": "string", + "description": "Contains the VAT code of the supplier", + "examples": [ + "NL818785639B01" + ] + }, + "TradeName": { + "type": "string", + "description": "The formal trade name of the organisation. If empty will be filled with the field Name", + "examples": [ + "Jansen Holding B.V." + ] + } + }, + "examples": [ + { + "Name": "Jansen Haarden", + "CompanyIdCoc": "80446353", + "CompanyIdVat": "NL861674881B01", + "TradeName": "Jansen Holding B.V." + } + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "EmailAddress": "leverancier@afas.nl", + "PhoneNumber": "0645789865", + "BankAccountNumber": "NL29TRIO0110845005", + "Bic": "TRIONL2U", + "VatType": "high", + "PaymentMethod": "banktransfer", + "IncludeInBankFile": "true", + "LedgerAccountId": "7f9a01a1-0352-5726-9111-03214874de74", + "Person": { + "Firstname": "Jan", + "Initials": "JH", + "Prefix": "van", + "Lastname": "Pinksteren" + }, + "Organisation": { + "Name": "Jansen IJzerwaren", + "CompanyIdCoc": "80446353", + "CompanyIdVat": "NL861674881B01", + "TradeName": "Jansen IJzerwaren B.V." + } + } + ] + } + }, + "responses": { + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "object", + "x-examples": { + "Example 1": { + "result": "PartiallySucceeded", + "traceId": "b06e41e4-4ff1-4b40-9331-5f2145b2a9a2", + "instances": [ + { + "Code": "Organisatie", + "Id": "1bfbc287-5fb4-59b5-9782-376fa601e4ad", + "Relatienummer": "000025" + }, + { + "Code": "Instelling", + "Id": "32a8c5d4-2227-512f-9f45-495192933809" + }, + { + "Code": "Leverancier", + "Id": "0afea90d-4ecb-5791-8e4b-787c70656f75" + }, + { + "Code": "Begunstigde", + "Id": "32a8c5d4-2227-512f-9f45-495192933809" + } + ], + "errors": [ + { + "Instelling": "'identificatie' bevat een verwijzing naar een ongeldige waarde." + } + ] + } + }, + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string" + }, + "instances": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Code": { + "type": "string" + }, + "Id": { + "type": "string" + } + } + } + }, + "errors": { + "type": "array", + "items": { + "type": "object" + } + } + } + }, + "examples": { + "PartiallySucceeded": { + "value": { + "result": "PartiallySucceeded", + "traceId": "b06e41e4-4ff1-4b40-9331-5f2145b2a9a2", + "instances": [ + { + "Code": "Organisatie", + "Id": "1bfbc287-5fb4-59b5-9782-376fa601e4ad", + "Relatienummer": "000025" + }, + { + "Code": "Instelling", + "Id": "32a8c5d4-2227-512f-9f45-495192933809" + }, + { + "Code": "Leverancier", + "Id": "0afea90d-4ecb-5791-8e4b-787c70656f75" + }, + { + "Code": "Begunstigde", + "Id": "32a8c5d4-2227-512f-9f45-495192933809" + } + ], + "errors": [ + { + "Instelling": "'identificatie' bevat een verwijzing naar een ongeldige waarde." + } + ] + } + }, + "Bad Request - Invalid JSON": { + "value": { + "StatusCode": 400, + "Message": "Invalid JSON request String", + "ExceptionCode": "DS3100", + "TraceId": "802033b876ed48bbb83a01a717ccb960", + "AdditionalInfo": { + "ExceptionType": "DeserializationException", + "DefinitionName": "salesinvoice.UpdateConnectorHandler", + "PropertyNames": "" + } + } + }, + "Bad request - Invalid UUID": { + "value": { + "StatusCode": 400, + "Message": "Invalid JSON request String '' does not validate against format 'uuid'. Path 'RelationId', line 3, position 18.", + "ExceptionCode": "DS3100", + "TraceId": "57887d8213dd4327ae1429e860250b24", + "AdditionalInfo": { + "ExceptionType": "DeserializationException", + "DefinitionName": "address.UpdateConnectorHandler", + "PropertyNames": "" + } + } + }, + "Ongeldig gebruikersfilter": { + "value": { + "StatusCode": 400, + "Message": "Ongeldig gebruikersfilter.", + "TraceId": "3b022f499ab040dea4ef992d90901963", + "AdditionalInfo": { + "ExceptionType": "AntaUserException" + } + } + } + } + } + }, + "headers": { + "Server": { + "schema": { + "type": "string", + "example": "nginx" + } + }, + "Date": { + "schema": { + "type": "string", + "example": "Wed, 19 Oct 2022 12:05:20 GMT" + } + }, + "Content-Type": { + "schema": { + "type": "string", + "example": "application/json" + } + }, + "Transfer-Encoding": { + "schema": { + "type": "string", + "example": "chunked" + } + }, + "Connection": { + "schema": { + "type": "string", + "example": "keep-alive" + } + }, + "Content-Version": { + "schema": { + "type": "number", + "example": 1 + } + }, + "X-Content-Type-Options": { + "schema": { + "type": "string", + "example": "nosniff" + } + }, + "X-XSS-Protection": { + "schema": { + "type": "string", + "example": "1; mode=block" + } + }, + "X-Frame-Options": { + "schema": { + "type": "string", + "example": "SAMEORIGIN" + } + }, + "Strict-Transport-Security": { + "schema": { + "type": "string", + "example": "max-age=300" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "StatusCode": { + "type": "integer" + }, + "Message": { + "type": "string" + }, + "TraceId": { + "type": "string" + }, + "AdditionalInfo": { + "type": "object", + "properties": { + "ExceptionType": { + "type": "string" + } + } + } + } + }, + "examples": { + "Unauthorized": { + "value": { + "StatusCode": 401, + "Message": "Er is geen ingelogde gebruiker.", + "TraceId": "b41c2c8219494f40bef50bc24ea6844d", + "AdditionalInfo": { + "ExceptionType": "NotAuthenticatedException" + } + } + } + } + } + }, + "headers": { + "Server": { + "schema": { + "type": "string", + "example": "nginx" + } + }, + "Date": { + "schema": { + "type": "string", + "example": "Wed, 19 Oct 2024 12:05:20 GMT" + } + }, + "Transfer-Encoding": { + "schema": { + "type": "string", + "example": "chunked" + } + }, + "Connection": { + "schema": { + "type": "string", + "example": "keep-alive" + } + }, + "Content-Version": { + "schema": { + "type": "number", + "example": 1 + } + }, + "X-Content-Type-Options": { + "schema": { + "type": "string", + "example": "nosniff" + } + }, + "X-XSS-Protection": { + "schema": { + "type": "string", + "example": "1; mode=block" + } + }, + "X-Frame-Options": { + "schema": { + "type": "string", + "example": "SAMEORIGIN" + } + }, + "Strict-Transport-Security": { + "schema": { + "type": "string", + "example": "max-age=300" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "StatusCode": { + "type": "integer" + }, + "Message": { + "type": "string" + }, + "TraceId": { + "type": "string" + }, + "AdditionalInfo": { + "type": "object", + "properties": { + "ExceptionType": { + "type": "string" + } + } + } + } + }, + "examples": { + "Unauthorized": { + "value": { + "StatusCode": 403, + "Message": "De ingelogde gebruiker heeft niet voldoende rechten.", + "TraceId": "7c4cdf827b824c5384a3b9b22966c3c3", + "AdditionalInfo": { + "ExceptionType": "NotAuthorizedException" + } + } + } + } + } + } + }, + "404": { + "description": "Item Not Found", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "StatusCode": { + "type": "string" + }, + "Message": { + "type": "string" + }, + "TraceId": { + "type": "string" + }, + "AdditionalInfo": { + "type": "object", + "properties": { + "ExceptionType": { + "type": "string" + } + } + } + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/files/getconnector-adminlicenseinformation-get-1.0/responses/example.json b/OpenApiSpecs/sb/files/getconnector-adminlicenseinformation-get-1.0/responses/example.json new file mode 100644 index 0000000..0cc77af --- /dev/null +++ b/OpenApiSpecs/sb/files/getconnector-adminlicenseinformation-get-1.0/responses/example.json @@ -0,0 +1,12 @@ +[ + { + "Name": "Enyoi", + "Url": "enyoi", + "ScopeId": 1, + "License": "2Gether", + "AdministrationCount": 2, + "ExtraAdministrationCount": 0, + "UserCount": 0, + "ExtraUserCount": 0 + } +] \ No newline at end of file diff --git a/OpenApiSpecs/sb/files/getconnector-salesinvoices-get-1.1/responses/example.json b/OpenApiSpecs/sb/files/getconnector-salesinvoices-get-1.1/responses/example.json new file mode 100644 index 0000000..a911821 --- /dev/null +++ b/OpenApiSpecs/sb/files/getconnector-salesinvoices-get-1.1/responses/example.json @@ -0,0 +1,165 @@ +{ + "TrackingToken": "202601141348101", + "Result": [ + { + "InstanceId": "76ccd112-3faf-5243-8ee8-001638826d4c", + "AmountExcludingVat": 225.0000000000, + "AmountVat": null, + "AmountInvoiced": 225.0000000000, + "SalesInvoiceNumber": "V01250154", + "IssueDate": "2025-12-05T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "c08e2474-976c-5c7c-94dc-eb02580009d0", + "RelationNumber": "000039", + "RelationDescription": "Administratiekantoor Beers", + "RelationType": "organisation" + }, + { + "InstanceId": "a25d4251-74f9-5406-8639-003be5b0a58e", + "AmountExcludingVat": 1644.3000000000, + "AmountVat": null, + "AmountInvoiced": 1644.3000000000, + "SalesInvoiceNumber": "V01250150", + "IssueDate": "2025-12-05T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "2fdc272a-5da6-55b8-a352-928d3c1e79b6", + "RelationNumber": "000024", + "RelationDescription": "Schreurs Administratiekantoor B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "6645f89b-4d85-56d5-90a4-00701269aeec", + "AmountExcludingVat": 95.0000000000, + "AmountVat": null, + "AmountInvoiced": 95.0000000000, + "SalesInvoiceNumber": "V01240035", + "IssueDate": "2024-03-15T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": null, + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "9fc15edd-9431-5a98-b2e1-0d90f2064527", + "RelationNumber": "000035", + "RelationDescription": "Architectenbureau Brauw B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "bed4a8fe-745e-56ae-a39c-01056ea488af", + "AmountExcludingVat": 150.0000000000, + "AmountVat": null, + "AmountInvoiced": 150.0000000000, + "SalesInvoiceNumber": "V01250133", + "IssueDate": "2025-10-17T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "200dae98-c4db-5da1-b8dd-018f934bcaa0", + "RelationNumber": "000037", + "RelationDescription": "Meepo Instituut B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "284454af-5f23-569b-8735-011f328b1f14", + "AmountExcludingVat": 59.8600000000, + "AmountVat": null, + "AmountInvoiced": 59.8600000000, + "SalesInvoiceNumber": "V01250137", + "IssueDate": "2025-11-07T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "43ff15dd-50a5-5d24-9dba-5271c80e5a8f", + "RelationNumber": "000016", + "RelationDescription": "Beentjes & Zn. Dakbedekking B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "c5277238-d627-59ad-a7cd-017268ac23f1", + "AmountExcludingVat": 1703.6500000000, + "AmountVat": null, + "AmountInvoiced": 1703.6500000000, + "SalesInvoiceNumber": "V01240031", + "IssueDate": "2024-03-01T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": null, + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "c08e2474-976c-5c7c-94dc-eb02580009d0", + "RelationNumber": "000039", + "RelationDescription": "Administratiekantoor Beers", + "RelationType": "organisation" + }, + { + "InstanceId": "bad2f2a1-8522-5d64-a5ed-01b63853b141", + "AmountExcludingVat": 81.9000000000, + "AmountVat": null, + "AmountInvoiced": 81.9000000000, + "SalesInvoiceNumber": "V01250043", + "IssueDate": "2025-04-04T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "7458b139-298f-5f53-aa52-0f9fbeb560b6", + "RelationNumber": "000044", + "RelationDescription": "Stukadoorsbedrijf Burgers B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "b5d6f5e1-9c7e-5e0d-8b31-01da69dc7a69", + "AmountExcludingVat": 963.9200000000, + "AmountVat": null, + "AmountInvoiced": 963.9200000000, + "SalesInvoiceNumber": "V01250029", + "IssueDate": "2025-03-07T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "2fdc272a-5da6-55b8-a352-928d3c1e79b6", + "RelationNumber": "000024", + "RelationDescription": "Schreurs Administratiekantoor B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "c57d4396-e6d4-59d9-a7a6-01ed068afbac", + "AmountExcludingVat": 149.6500000000, + "AmountVat": null, + "AmountInvoiced": 149.6500000000, + "SalesInvoiceNumber": "V01250045", + "IssueDate": "2025-04-11T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "889f3aac-684c-552e-b566-3de14d38c2c5", + "RelationNumber": "000025", + "RelationDescription": "Gebroeders Van Kooten B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "325cca0c-7a2e-5880-aea5-0215220f301c", + "AmountExcludingVat": 406.3800000000, + "AmountVat": null, + "AmountInvoiced": 406.3800000000, + "SalesInvoiceNumber": "V01250064", + "IssueDate": "2025-05-02T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "dd74709e-1fd0-5ab1-a8ab-2a40ad645217", + "RelationNumber": "000041", + "RelationDescription": "Van Kempen Afbouw b.v.", + "RelationType": "organisation" + } + ] +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/files/updateconnector-purchasejournalentry-Post-2.0/examples/Inkoopjournaalpost.json b/OpenApiSpecs/sb/files/updateconnector-purchasejournalentry-Post-2.0/examples/Inkoopjournaalpost.json new file mode 100644 index 0000000..361f6cf --- /dev/null +++ b/OpenApiSpecs/sb/files/updateconnector-purchasejournalentry-Post-2.0/examples/Inkoopjournaalpost.json @@ -0,0 +1,30 @@ +{ + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "InvoiceNumber": "3gKm5gtrBcjWHNY3dwwjyza4AZYAyBW", + "RelationType": "organisation", + "RelationId": "863d895a-3782-5500-b933-dd487d736138", + "InvoiceDate": "2024-01-22", + "DueDate": "2024-02-28", + "PaymentMethod": "creditcard", + "Attachments": [ + { + "AttachmentId": "039e63a5-5761-4a6e-a58b-d0fcda003e0c" + } + ], + "InvoiceLine": [ + { + "Description": "Inkopen btw hoog", + "LedgerAccountId": "55eeb0a9-25d0-5c60-830b-07f515fc0c0c", + "VatType": "high", + "AmountExcludingVat": 22, + "AmountVat": 4.62 + }, + { + "Description": "Inkopen btw laag", + "LedgerAccountId": "22edee70-753a-5f8c-a613-39fe661fffbe", + "VatType": "low", + "AmountExcludingVat": 100, + "AmountVat": 9 + } + ] +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/files/updateconnector-purchasejournalentry-Post-2.0/responses/response.json b/OpenApiSpecs/sb/files/updateconnector-purchasejournalentry-Post-2.0/responses/response.json new file mode 100644 index 0000000..bb89ad1 --- /dev/null +++ b/OpenApiSpecs/sb/files/updateconnector-purchasejournalentry-Post-2.0/responses/response.json @@ -0,0 +1,9 @@ +{ + "result": "Succeeded", + "traceId": "90666ba6-6211-4582-9a19-0c0429c84b4e", + "data": { + "PurchaseJournalEntryId": "a29631fe-cc81-40ba-bc6c-b813be75423c", + "PurchaseInternalInvoiceNumber": "IF250002" + }, + "errors": [] +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Delete-2.1/examples/example.json b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Delete-2.1/examples/example.json new file mode 100644 index 0000000..2b7c206 --- /dev/null +++ b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Delete-2.1/examples/example.json @@ -0,0 +1,4 @@ +{ + "AdministrationId": "a15620b1-90bf-46d8-a155-15f59a3ed460", + "Id": "8f8d5e92-bd85-4deb-8184-6abf57a5b24d" +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Delete-2.1/responses/success.json b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Delete-2.1/responses/success.json new file mode 100644 index 0000000..91a8347 --- /dev/null +++ b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Delete-2.1/responses/success.json @@ -0,0 +1,8 @@ +{ + "result": "Succeeded", + "traceId": "ab84df36-19aa-477c-9f71-c0c61cb542a1", + "data": { + "SalesJournalEntryId": "2fe9d143-52aa-4d9f-9eba-a97656f2741c" + }, + "errors": [] +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/BTW Verlegd binnen Nederland.json b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/BTW Verlegd binnen Nederland.json new file mode 100644 index 0000000..9dd492e --- /dev/null +++ b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/BTW Verlegd binnen Nederland.json @@ -0,0 +1,24 @@ +{ + "InvoiceNumber": "d", + "InvoiceDate": "2024-01-30", + "Description": "Practical Plastic Chips", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "organisation", + "RelationId": "c6f3b724-845c-5af2-8360-2fc751601115", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "9b5d768a-c71b-583e-b6ee-09d64aa935d4", + "InvoiceLine": [ + { + "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", + "VatType": "high", + "VatCalculation": "reversecharged", + "AmountExcludingVat": 100 + }, + { + "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", + "VatType": "high", + "VatCalculation": "reversecharged", + "AmountExcludingVat": 396 + } + ] +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/BTW binnen en buiten EU.json b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/BTW binnen en buiten EU.json new file mode 100644 index 0000000..417bcb6 --- /dev/null +++ b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/BTW binnen en buiten EU.json @@ -0,0 +1,22 @@ +{ + "InvoiceNumber": "a", + "InvoiceDate": "2024-01-30", + "Description": "Unbranded Fresh Pizza", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "organisation", + "RelationId": "c6f3b724-845c-5af2-8360-2fc751601115", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "9b5d768a-c71b-583e-b6ee-09d64aa935d4", + "InvoiceLine": [ + { + "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", + "VatType": "zero", + "AmountExcludingVat": 100 + }, + { + "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", + "VatType": "zero", + "AmountExcludingVat": 211 + } + ] +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/Sales with attachment.json b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/Sales with attachment.json new file mode 100644 index 0000000..8d06314 --- /dev/null +++ b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/Sales with attachment.json @@ -0,0 +1,29 @@ +{ + "InvoiceNumber": "1", + "InvoiceDate": "2024-02-01", + "Description": "Ergonomic Rubber Bacon", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "organisation", + "RelationId": "a8cce7bd-ced8-5ca4-b3b8-f0584ffe5993", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "9b5d768a-c71b-583e-b6ee-09d64aa935d4", + "Attachments": [ + { + "AttachmentId": "b031446a-b98e-4378-b7ee-8543e05f34c0" + } + ], + "InvoiceLine": [ + { + "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", + "AmountVat": 21, + "VatType": "high", + "AmountExcludingVat": 100 + }, + { + "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", + "AmountExcludingVat": 427, + "VatType": "zero", + "VatCalculation": "exempt" + } + ] +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/verkoop 1 regel.json b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/verkoop 1 regel.json new file mode 100644 index 0000000..584b453 --- /dev/null +++ b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/verkoop 1 regel.json @@ -0,0 +1,18 @@ +{ + "InvoiceNumber": "7", + "InvoiceDate": "2024-01-24", + "Description": "Unbranded Steel Sausages", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "organisation", + "RelationId": "9bafbc7a-611b-5465-a584-5f0c88734b35", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "eb44c60d-06e4-564b-a90c-7715c78788a5", + "InvoiceLine": [ + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 183.54, + "VatType": "high", + "AmountExcludingVat": 874 + } + ] +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/verkoop aan persoon.json b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/verkoop aan persoon.json new file mode 100644 index 0000000..9b58e6f --- /dev/null +++ b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/verkoop aan persoon.json @@ -0,0 +1,25 @@ +{ + "InvoiceNumber": "SAL341434345403", + "InvoiceDate": "2024-01-24", + "Description": "null", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "person", + "RelationId": "d36cb9bb-0e5f-5253-ab28-2331804d65ba", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "eb44c60d-06e4-564b-a90c-7715c78788a5", + "InvoiceLine": [ + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 21, + "VatType": "high", + "AmountExcludingVat": 100 + }, + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 450.55, + "VatType": "low", + "AmountExcludingVat": 40.55, + "VatCalculation": "exempt" + } + ] +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/verkoop alle soorten btw.json b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/verkoop alle soorten btw.json new file mode 100644 index 0000000..8072505 --- /dev/null +++ b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/verkoop alle soorten btw.json @@ -0,0 +1,44 @@ +{ + "InvoiceNumber": "d", + "InvoiceDate": "2024-01-23", + "Description": "Sleek Metal Tuna", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "organisation", + "RelationId": "9bafbc7a-611b-5465-a584-5f0c88734b35", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "eb44c60d-06e4-564b-a90c-7715c78788a5", + "InvoiceLine": [ + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 21, + "VatType": "high", + "AmountExcludingVat": 100 + }, + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 40.55, + "VatType": "low", + "AmountExcludingVat": 40.55, + "VatCalculation": "exempt" + }, + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 0, + "VatType": "zero", + "AmountExcludingVat": 40.55 + }, + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 18, + "VatType": "low", + "AmountExcludingVat": 200 + } , + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 18, + "VatType": "high", + "AmountExcludingVat": 200, + "VatCalculation": "reversecharged" + } + ] +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/verkoop meerdere btw soorten.json b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/verkoop meerdere btw soorten.json new file mode 100644 index 0000000..3c7e3ee --- /dev/null +++ b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/examples/verkoop meerdere btw soorten.json @@ -0,0 +1,37 @@ +{ + "InvoiceNumber": "t", + "InvoiceDate": "2024-01-23", + "Description": "Handmade Concrete Car", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "organisation", + "RelationId": "863d895a-3782-5500-b933-dd487d736138", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "b98e24e9-a611-5a98-8cf9-40fed321dc6c", + "InvoiceLine": [ + { + "LedgerAccountId": "de3184b9-23f0-55e6-9bd0-ccb5c2b5b5ce", + "AmountVat": 21, + "VatType": "high", + "AmountExcludingVat": 100 + }, + { + "LedgerAccountId": "de3184b9-23f0-55e6-9bd0-ccb5c2b5b5ce", + "AmountVat": 40.55, + "VatType": "low", + "AmountExcludingVat": 40.55, + "VatCalculation": "exempt" + }, + { + "LedgerAccountId": "de3184b9-23f0-55e6-9bd0-ccb5c2b5b5ce", + "AmountVat": 0, + "VatType": "zero", + "AmountExcludingVat": 40.55 + }, + { + "LedgerAccountId": "de3184b9-23f0-55e6-9bd0-ccb5c2b5b5ce", + "AmountVat": 18, + "VatType": "low", + "AmountExcludingVat": 200 + } + ] +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/responses/400/already exists.json b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/responses/400/already exists.json new file mode 100644 index 0000000..21d842e --- /dev/null +++ b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/responses/400/already exists.json @@ -0,0 +1,8 @@ +{ + "result": "Failed", + "traceId": "3ca43e3a-00b6-460d-8bf1-be2f391f3f4c", + "instances": [], + "errors": [ + "SalesJournalEntry with invoicenumber SB_API_2204202410006 already exists" + ] +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/responses/400/error on date.json b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/responses/400/error on date.json new file mode 100644 index 0000000..afdd070 --- /dev/null +++ b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/responses/400/error on date.json @@ -0,0 +1,9 @@ +{ + "result": "Failed", + "traceId": "57f10a49-6720-4bb8-8826-8ef92387560f", + "instances": [], + "errors": [ + "Entity is made with one or more errors. Please correct this error in application or delete SalesJournalEntry with id: b32ee6e1-f807-4644-a6d5-d785d8bd7c61", + "De factuurdatum ligt vóór de beginbalansdatum. Dit is niet toegestaan." + ] +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/responses/400/error on line.json b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/responses/400/error on line.json new file mode 100644 index 0000000..7efd1e1 --- /dev/null +++ b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/responses/400/error on line.json @@ -0,0 +1,10 @@ +{ + "result": "Failed", + "traceId": "010e0485-1e22-4f1a-8573-405090824d35", + "instances": [], + "errors": [ + "Entity is made with one or more errors in the lines. Please correct this error in application or delete SalesJournalEntry with id: eee53305-8851-4859-a53e-b4b18f14040e.", + "Field 'Grootboekrekening' contains an invalid reference (a18e0f9a-c73d-58c4-ae80-64c2e4228de4)", + "Field 'Grootboekrekening' contains an invalid reference (a18e0f9a-c73d-58c4-ae80-64c2e4228de4)" + ] +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/responses/400/error.json b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/responses/400/error.json new file mode 100644 index 0000000..12fdfb5 --- /dev/null +++ b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/responses/400/error.json @@ -0,0 +1,8 @@ +{ + "result": "Failed", + "traceId": "e193dbe5-8f65-4035-aa81-879bd9828f98", + "instances": [], + "errors": [ + "FeatureToggle not enabled" + ] +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/responses/success.json b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/responses/success.json new file mode 100644 index 0000000..91a8347 --- /dev/null +++ b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Post-2.1/responses/success.json @@ -0,0 +1,8 @@ +{ + "result": "Succeeded", + "traceId": "ab84df36-19aa-477c-9f71-c0c61cb542a1", + "data": { + "SalesJournalEntryId": "2fe9d143-52aa-4d9f-9eba-a97656f2741c" + }, + "errors": [] +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Put-2.1/examples/PaymentReference.json b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Put-2.1/examples/PaymentReference.json new file mode 100644 index 0000000..43bfe7c --- /dev/null +++ b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Put-2.1/examples/PaymentReference.json @@ -0,0 +1,5 @@ +{ + "AdministrationId": "f49f54a4-835d-532f-a117-79054e726808", + "Id": "2857a5b4-777d-44cd-b10d-9721c0281d7d", + "PaymentReference": "2024-10124" +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Put-2.1/responses/success.json b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Put-2.1/responses/success.json new file mode 100644 index 0000000..79aaad3 --- /dev/null +++ b/OpenApiSpecs/sb/files/updateconnector-salesjournalentry-Put-2.1/responses/success.json @@ -0,0 +1,7 @@ +{ + "result": "Succeeded", + "data": { + "SalesJournalEntryId": "f365059e-5918-49ec-9a7c-d4f0a0c8beb4" + }, + "errors": [] +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/nl/7-1-0.json b/OpenApiSpecs/sb/nl/7-1-0.json new file mode 100644 index 0000000..b7981b2 --- /dev/null +++ b/OpenApiSpecs/sb/nl/7-1-0.json @@ -0,0 +1,17646 @@ +{ + "openapi": "3.0.2", + "info": { + "version": "7.1", + "title": "AFAS SB API", + "description": "AFAS SB API for integrating with the accounting software for accountants and entrepreneurs." + }, + "servers": [ + { + "url": "https://{domain}.afasfocus.nl/{customerenvironment}", + "description": "Customer environment URL", + "variables": { + "domain": { + "description": "Identifier for the accountancy environment", + "default": "app-center-demo" + }, + "customerenvironment": { + "description": "Identifier for the customer environment", + "default": "scope" + } + } + }, + { + "url": "https://{subdomein}.afasfocus.nl/admin", + "description": "Accounting center URL", + "variables": { + "subdomein": { + "description": "URL unique for the accounting office.", + "default": "app-center-demo" + } + } + } + ], + "paths": { + "/api/blob/{uuid}": { + "get": { + "description": "Retrieve a specific blob by UUI.", + "summary": "/api/blob/{uuid}", + "operationId": "getBlob", + "parameters": [ + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1" + } + }, + { + "in": "header", + "name": "Authorization", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "uuid", + "schema": { + "type": "string", + "format": "uuid", + "example": "00000000-0000-0000-0000-000000000000" + }, + "required": true, + "description": "UUID of the blob" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "tags": [ + "Bijlagen", + "Inkoopjournaalpost", + "Verkoopfactuur", + "Verkoopjournaalpost", + "Publiek: Externe facturatie" + ], + "deprecated": false + }, + "put": { + "description": "This operation consists of two requests. First call this endpoint with the Blob-* headers, without body to prepare the blob. Then call this endpoint without the Blob-* headers with a body to upload the file. The blob UUID must be generated client side.", + "summary": "/api/blob/{uuid}", + "operationId": "reserveBlobSpace", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "path", + "name": "uuid", + "schema": { + "type": "string", + "format": "uuid", + "example": "00000000-0000-0000-0000-000000000000" + }, + "required": true, + "description": "UUID of the blob. This should be generated client side." + }, + { + "in": "header", + "name": "Blob-Content-Length", + "schema": { + "type": "integer", + "example": "100" + } + }, + { + "in": "header", + "name": "Blob-Content-Type", + "schema": { + "type": "string", + "example": "image/jpeg" + } + }, + { + "in": "header", + "name": "Blob-Content-FileName", + "schema": { + "type": "string", + "example": "attachment.jpg" + } + }, + { + "in": "header", + "name": "Blob-Upload-Type", + "schema": { + "type": "string", + "example": "Blob/Image" + }, + "required": true + }, + { + "in": "header", + "name": "Blob-Format", + "schema": { + "type": "string", + "example": "Default/Thumb/Small/Medium" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + } + ], + "requestBody": { + "description": "Binary content of the blob", + "required": true + }, + "responses": { + "200": { + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "tags": [ + "Bijlagen", + "Inkoopjournaalpost", + "Verkoopfactuur", + "Verkoopjournaalpost", + "Publiek: Externe facturatie" + ], + "deprecated": false + } + }, + "/authentication/getaccesstoken": { + "post": { + "description": "Get AccessToken: Provide an application token created in the current application. An access token is returned which can be used for the \"AccessToken\" header to execute connector requests. The 'scope' property is required in accountancy environments. When scope is not provided in accountancy environments, an identity token is returned which can be used in the 'ScopeSelection' api.", + "summary": "/authentication/getaccesstoken", + "operationId": "updateconnector-getaccesstoken", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/json" + } + } + ], + "requestBody": { + "description": "Application token", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "apptoken": { + "type": "string", + "example": "APPTOKEN" + }, + "scope": { + "type": "string", + "example": "demo" + } + }, + "required": [ + "apptoken" + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "tags": [ + "Autorisatie" + ], + "deprecated": false + } + }, + "/authentication/getscopes": { + "post": { + "description": "Get scopes: Provide an identity token returned by the 'AccessToken' api.", + "summary": "/authentication/getscopes", + "operationId": "updateconnector-getscopes", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/json" + } + }, + { + "in": "header", + "name": "IdentityToken", + "schema": { + "type": "string", + "example": "IDENTITYTOKEN" + } + } + ], + "requestBody": { + "description": "Scopes", + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Name": { + "type": "string", + "example": "Beheer" + }, + "Path": { + "type": "string", + "example": "admin" + } + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "tags": [ + "Autorisatie" + ], + "deprecated": false + } + }, + "/app/token": { + "post": { + "description": "Get an access token for a scope.", + "summary": "app/token", + "operationId": "updateconnector-token", + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "grant_type": { + "type": "string", + "example": "refresh_token" + }, + "refresh_token": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "client_secret": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "multipart/form-data": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_token": { + "type": "string" + }, + "expires_in": { + "type": "integer" + }, + "token_type": { + "type": "string" + } + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "tags": [ + "Autorisatie" + ], + "deprecated": false + } + }, + "/api/adminlicenseinformation": { + "get": { + "description": "Retrieve license information for all scopes in the environment. This endpoint requires admin rights, and should be called from the 'admin' scope (e.g. yourdomain.afasfocus.nl/admin/api/adminlicenseinformation).", + "summary": "/api/adminlicenseinformation", + "operationId": "getconnector-adminlicenseinformation-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/json" + } + }, + { + "in": "header", + "name": "IdentityToken", + "schema": { + "type": "string", + "example": "IDENTITYTOKEN" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Name": { + "type": "string", + "example": "Beheer" + }, + "Url": { + "type": "string", + "example": "beheer" + }, + "ScopeId": { + "type": "integer", + "example": "1" + }, + "License": { + "type": "string", + "example": "Ondernemen" + }, + "AdministrationCount": { + "type": "integer", + "example": "5" + }, + "ExtraAdministrationCount": { + "type": "integer", + "example": "2" + }, + "UserCount": { + "type": "integer", + "example": "2" + }, + "ExtraUserCount": { + "type": "integer", + "example": "0" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "Name": "Enyoi", + "Url": "enyoi", + "ScopeId": 1, + "License": "2Gether", + "AdministrationCount": 2, + "ExtraAdministrationCount": 0, + "UserCount": 0, + "ExtraUserCount": 0 + } + ] + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "tags": [ + "Admin center data", + "Publiek: Admin center data" + ], + "deprecated": false + } + }, + "/api/accountingperiod": { + "get": { + "description": "Retrieve accounting periods for a specific administration", + "summary": "accountingperiod 2.0", + "operationId": "getconnector-accountingperiod-get-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "AccountingYear": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "StartDate": { + "type": "string", + "format": "date-time" + }, + "EndDate": { + "type": "string", + "format": "date-time" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "PeriodNumber": { + "type": "number" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "Id": "6b39b98c-4fc0-4c51-9cc6-d9b6657b725a", + "Description": "Januari 2024", + "StartDate": "2024-01-01T00:00:00Z", + "EndDate": "2024-01-31T00:00:00Z", + "PeriodNumber": 1.0, + "AccountingYear": "2024" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële dashboarding", + "Publiek: Financiële rapportage", + "Financiele rapportage" + ] + } + }, + "/api/accountingyear": { + "get": { + "description": "Retrieve accounting years for financial reporting periods", + "summary": "accountingyear 2.0", + "operationId": "getconnector-accountingyear-get-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + }, + "StartDate": { + "type": "string", + "format": "date-time" + }, + "EndDate": { + "type": "string", + "format": "date-time" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "Id": "313e40a2-1d9d-4672-b852-209f9ea9e167", + "Description": "2024", + "StartDate": "2024-01-01T00:00:00Z", + "EndDate": "2024-12-31T00:00:00Z" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële dashboarding", + "Publiek: Financiële rapportage", + "Financiele rapportage" + ] + } + }, + "/api/addresses": { + "get": { + "description": "Retrieve multiple addresses with detailed contact information", + "summary": "addresses 1.0", + "operationId": "getconnector-addresses-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "StreetName": { + "type": "string" + }, + "HouseNumber": { + "type": "string" + }, + "HouseNumberAddition": { + "type": "string" + }, + "PostalZone": { + "type": "string" + }, + "CityName": { + "type": "string" + }, + "CountryName": { + "type": "string" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "IsPreferedInvoiceAddress": { + "type": "boolean" + }, + "IsPreferedSupplierAddress": { + "type": "boolean" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + } + } + } + }, + "examples": { + "example": { + "value": { + "TrackingToken": "202409230720571", + "Result": [ + { + "Id": "56528a1b-4bea-5699-abb8-f66155e9c497", + "StreetName": "Reactorweg", + "HouseNumber": "47", + "HouseNumberAddition": null, + "PostalZone": "3542 AD", + "RelationId": "4fa13b8e-44dc-5cf7-b2ef-35e14be401e8", + "IsPreferedInvoiceAddress": true, + "IsPreferedSupplierAddress": true, + "CityName": "Utrecht", + "CountryName": "Nederland", + "RelationType": "organisation" + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost", + "Publiek: Relatiemanagement", + "Relaties", + "Publiek: Facturatie", + "Verkoopfactuur" + ] + } + }, + "/api/administration": { + "get": { + "description": "ListAdministration", + "summary": "administration 1.0", + "operationId": "getconnector-administration-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Description Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Description": { + "type": "string" + }, + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "Id": { + "type": "string", + "format": "uuid" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "Id": "701b747b-eea2-5ed1-8518-973e5c670252", + "Description": "EnYoi Holding B.V.", + "InstanceId": "701b747b-eea2-5ed1-8518-973e5c670252" + }, + { + "Id": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "EnYoi ICT Services B.V.", + "InstanceId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Loonjournaalpost", + "POS Transacties", + "Inkoopjournaalpost", + "Verkoopfactuur", + "Verkoopjournaalpost" + ] + } + }, + "/api/administrations": { + "get": { + "description": "Retrieve all available administrations and their details", + "summary": "administrations 1.0", + "operationId": "getconnector-administrations-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Description Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Description": { + "type": "string" + }, + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "Id": { + "type": "string", + "format": "uuid" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "Id": "701b747b-eea2-5ed1-8518-973e5c670252", + "Description": "EnYoi Holding B.V.", + "InstanceId": "701b747b-eea2-5ed1-8518-973e5c670252" + }, + { + "Id": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "EnYoi ICT Services B.V.", + "InstanceId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële dashboarding", + "Publiek: Financiële journaalpost", + "Financiële journaalpost", + "Publiek: Financiële rapportage", + "Financiele rapportage", + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Loonjournaalpost", + "Publiek: POS Transacties", + "POS Transacties", + "Inkoopjournaalpost", + "Publiek: Relatiemanagement", + "Publiek: Facturatie", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/bankaccounts": { + "get": { + "description": "Get bankaccount for organisation or person.", + "summary": "bankaccounts 1.0", + "operationId": "getconnector-bankaccounts-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "AccountNumber": { + "type": "string" + }, + "RelationIsOrganisationOrAdministration": { + "type": "boolean" + }, + "PreferredIncommingPayments": { + "type": "boolean" + }, + "PreferredOutgoingPayments": { + "type": "boolean" + }, + "RelationId": { + "type": "string", + "format": "uuid" + } + } + } + }, + "examples": { + "bankaccounts": { + "value": { + "TrackingToken": "202406211216501", + "Result": [ + { + "Id": "0d83610b-e1fc-53a2-a951-00f9098e0154", + "AccountNumber": "NL10INGB0675488052", + "RelationId": "b323458f-5bae-542b-8294-9040c9801805" + }, + { + "Id": "dd6cbc4b-6ec6-59c0-95ca-020b5977b39a", + "AccountNumber": "NL16RABO0300417497", + "RelationId": "b24405d6-fee2-52f5-8f24-c1a0180e46f2" + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost", + "Publiek: Relatiemanagement", + "Relaties", + "Publiek: Facturatie", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/cashregisters": { + "get": { + "description": "Retrieve cash register configurations and settings", + "summary": "cashregisters 1.0", + "operationId": "getconnector-cashregisters-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "InstanceId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + } + } + } + }, + "examples": { + "cashregisters": { + "value": [ + { + "InstanceId": "265424ab-253e-57d4-9d65-036c65ad05c8", + "Description": "Kas", + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8" + }, + { + "InstanceId": "25e93133-ec28-543f-9f23-312ddb4e10a3", + "Description": "Kas", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: POS Transacties", + "POS Transacties" + ] + } + }, + "/api/contacts": { + "get": { + "description": "Retrieve contact information for persons and organizations", + "summary": "contacts 1.0", + "operationId": "getconnector-contacts-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "OrganisationId": { + "type": "string", + "format": "uuid" + }, + "PersonId": { + "type": "string", + "format": "uuid" + }, + "Name": { + "type": "string" + }, + "Firstname": { + "type": "string" + }, + "Initials": { + "type": "string" + }, + "Prefix": { + "type": "string" + }, + "Lastname": { + "type": "string" + }, + "PhoneNumber": { + "type": "string" + }, + "Emailaddress": { + "type": "string" + }, + "ExternalId": { + "type": "string" + }, + "IsArchived": { + "type": "boolean" + }, + "PersonIsArchived": { + "type": "boolean" + }, + "OrganisationIsArchived": { + "type": "boolean" + } + } + } + }, + "examples": { + "example": { + "value": { + "TrackingToken": "202403280856491", + "Result": [ + { + "Id": "0236d0dc-b5be-5b6e-b191-17f6b767aa5b", + "IsArchived": false, + "OrganisationId": "e97ecfe3-8bcb-5baf-82e4-4e46b2b02126", + "OrganisatieIsArchived": false, + "Name": "Peter de Jager", + "FirstName": "Peter", + "Initials": "P.", + "Prefix": "de", + "Lastname": "Jager", + "ExternalId": null, + "PersoonIsArchived": false + }, + { + "Id": "2c5b3f1d-1689-5257-9ab2-2ba634203b2c", + "IsArchived": false, + "OrganisationId": "c589e4b3-d131-5a1b-9eca-44dd2fc17600", + "OrganisatieIsArchived": false, + "Name": "Trudie Feenstra", + "FirstName": "Trudie", + "Initials": "T.", + "Prefix": null, + "Lastname": "Feenstra", + "ExternalId": null, + "PersoonIsArchived": false + }, + { + "Id": "416b5ea9-93bd-5cfc-af07-37f1681da00b", + "IsArchived": false, + "OrganisationId": "bb3fd8ef-5a0e-5919-8e67-77b396abf212", + "OrganisatieIsArchived": false, + "Name": "Yousef Martiqui", + "FirstName": "Yousef", + "Initials": "Y.", + "Prefix": null, + "Lastname": "Martiqui", + "ExternalId": null, + "PersoonIsArchived": false + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Relatiemanagement", + "Relaties" + ] + } + }, + "/api/countries": { + "get": { + "description": "Retrieve country information with ISO codes and descriptions", + "summary": "countries 1.0", + "operationId": "getconnector-countries-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + }, + "CodeISOAlpha2": { + "type": "string" + } + } + } + }, + "examples": { + "countries": { + "value": { + "TrackingToken": "202406211218251", + "Result": [ + { + "Id": "afa50000-0000-0ab9-bf40-00958bc94cc8", + "Description": "Tadzjikistan", + "CodeISOAlpha2": "TJ" + }, + { + "Id": "afa50000-0000-0be2-8a70-01f36103d3cd", + "Description": "Heard Eiland en McDonald Eilanden", + "CodeISOAlpha2": "HM" + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost", + "Publiek: Relatiemanagement", + "Relaties" + ] + } + }, + "/api/creditorbalance": { + "get": { + "description": "Retrieve creditor balance information for suppliers", + "summary": "creditorbalance 1.0", + "operationId": "getconnector-creditorbalance-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationName": { + "type": "string" + }, + "LastCompleted": { + "type": "string", + "format": "date-time" + }, + "OutstandingAmount": { + "type": "number" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "OutstandingAmount": 1586.31, + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "296a5ec3-0efb-528d-9afd-7ab3b3c914c1", + "RelationName": "Stichting Mollie Payments", + "InstanceId": "8b0ecc00-2b87-4eaa-bd19-3b9db7f297c4", + "RelationType": "organisation" + }, + { + "OutstandingAmount": 28597.14, + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "RelationName": "AFAS Software B.V.", + "InstanceId": "072672c2-c859-4eef-a0be-7e760b57af6f", + "RelationType": "organisation" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Crediteuren" + ] + } + }, + "/api/creditorinvoicebalance": { + "get": { + "description": "Retrieve creditor invoice balance details for payable transactions", + "summary": "creditorinvoicebalance 1.0", + "operationId": "getconnector-creditorinvoicebalance-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "InvoiceNumber Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "InvoiceNumber": { + "type": "string" + }, + "InvoiceDate": { + "type": "string", + "format": "date-time" + }, + "CustomerReference": { + "type": "string" + }, + "DueDate": { + "type": "string", + "format": "date-time" + }, + "InternalInvoiceNumber": { + "type": "string" + }, + "InvoiceId": { + "type": "string", + "format": "uuid" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationName": { + "type": "string" + }, + "LastCompleted": { + "type": "string", + "format": "date-time" + }, + "OutstandingAmount": { + "type": "number" + }, + "PaidAmount": { + "type": "number" + }, + "ProcessingAmount": { + "type": "number" + }, + "TotalAmount": { + "type": "number" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "OutstandingAmount": 1586.31, + "PaidAmount": 0.0, + "ProcessingAmount": 0.0, + "TotalAmount": 1586.31, + "DueDate": "2024-12-13T00:00:00Z", + "InvoiceId": "1ae8da84-9dd1-427a-a636-25aa53162dbf", + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "InvoiceNumber": "123", + "InvoiceDate": "2024-12-13T00:00:00Z", + "CustomerReference": null, + "InternalInvoiceNumber": "IF240003", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "296a5ec3-0efb-528d-9afd-7ab3b3c914c1", + "RelationName": "Stichting Mollie Payments", + "InstanceId": "9ea0e72a-b424-485d-82b1-09363aefcdce", + "RelationType": "organisation" + }, + { + "OutstandingAmount": 28341.83, + "PaidAmount": 0.0, + "ProcessingAmount": 0.0, + "TotalAmount": 28341.83, + "DueDate": "2024-12-27T00:00:00Z", + "InvoiceId": "b3823933-d138-468a-a071-4e517feca9b9", + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "InvoiceNumber": "20241231", + "InvoiceDate": "2024-12-13T00:00:00Z", + "CustomerReference": null, + "InternalInvoiceNumber": "IF240001", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "RelationName": "AFAS Software B.V.", + "InstanceId": "b7e76bdf-1152-4d54-8224-ad6a421fc84f", + "RelationType": "organisation" + }, + { + "OutstandingAmount": 255.31, + "PaidAmount": 0.0, + "ProcessingAmount": 0.0, + "TotalAmount": 255.31, + "DueDate": "2025-01-14T00:00:00Z", + "InvoiceId": "6a25941f-2c35-4736-b963-6c63be0e82b4", + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "InvoiceNumber": "20241232", + "InvoiceDate": "2024-12-31T00:00:00Z", + "CustomerReference": null, + "InternalInvoiceNumber": "IF240002", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "RelationName": "AFAS Software B.V.", + "InstanceId": "ac5f3b30-6296-4864-86c6-cecede47984d", + "RelationType": "organisation" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Crediteuren" + ] + } + }, + "/api/debtorbalance": { + "get": { + "description": "Retrieve debtor balance information for customers", + "summary": "debtorbalance 2.0", + "operationId": "getconnector-debtorbalance-get-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "RelationName": { + "type": "string" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "LastCompleted": { + "type": "string", + "format": "date-time" + }, + "OutstandingAmount": { + "type": "number" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "OutstandingAmount": 684.86, + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "RelationName": "AFAS Software B.V.", + "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "InstanceId": "9b9c7f38-d059-4a9c-b3a0-3e0562bd0115", + "RelationType": "organisation" + }, + { + "OutstandingAmount": 640.09, + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "RelationName": "Mollie B.V.", + "RelationId": "3709fb45-c646-5cca-8de7-e6433404316a", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "InstanceId": "d33f3c36-d120-448c-92bd-0dbdeb2985bd", + "RelationType": "organisation" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Debiteuren" + ] + } + }, + "/api/debtorinvoicebalance": { + "get": { + "description": "Retrieve debtor invoice balance details for receivable transactions", + "summary": "debtorinvoicebalance 3.0", + "operationId": "getconnector-debtorinvoicebalance-get-3.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "3.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "InvoiceDate": { + "type": "string", + "format": "date-time" + }, + "DueDate": { + "type": "string", + "format": "date-time" + }, + "InvoiceNumber": { + "type": "string" + }, + "CustomerReference": { + "type": "string" + }, + "RelationName": { + "type": "string" + }, + "InvoiceId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "LastCompleted": { + "type": "string", + "format": "date-time" + }, + "OutstandingAmount": { + "type": "number" + }, + "TotalAmount": { + "type": "number" + }, + "PaidAmount": { + "type": "number" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "OutstandingAmount": 123.42, + "TotalAmount": 123.42, + "PaidAmount": 0.0, + "DueDate": "2024-12-27T00:00:00Z", + "InvoiceId": "a9095b6f-990d-4f5a-bda3-737939ab5fda", + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "InvoiceDate": "2024-12-13T00:00:00Z", + "InvoiceNumber": "VF240002", + "CustomerReference": null, + "RelationName": "AFAS Software B.V.", + "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "InstanceId": "206b831d-d5b1-43cd-a6d3-949bab3f45ee", + "RelationType": "organisation" + }, + { + "OutstandingAmount": 561.44, + "TotalAmount": 561.44, + "PaidAmount": 0.0, + "DueDate": "2024-12-27T00:00:00Z", + "InvoiceId": "157f441e-530d-4571-b6f7-e6681dc0ddac", + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "InvoiceDate": "2024-12-13T00:00:00Z", + "InvoiceNumber": "VF240001", + "CustomerReference": null, + "RelationName": "AFAS Software B.V.", + "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "InstanceId": "3f5ac81a-89d5-423d-ad2c-dea22585dc36", + "RelationType": "organisation" + }, + { + "OutstandingAmount": 640.09, + "TotalAmount": 640.09, + "PaidAmount": 0.0, + "DueDate": "2024-12-27T00:00:00Z", + "InvoiceId": "5fa9bfee-7a07-4ea9-b438-f19b3cdda6ca", + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "InvoiceDate": "2024-12-13T00:00:00Z", + "InvoiceNumber": "VF240003", + "CustomerReference": null, + "RelationName": "Mollie B.V.", + "RelationId": "3709fb45-c646-5cca-8de7-e6433404316a", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "InstanceId": "961616ec-27db-436c-bd86-eb95a46bb141", + "RelationType": "organisation" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "3.0", + "deprecated": false, + "tags": [ + "Debiteuren", + "Publiek: Externe facturatie" + ] + } + }, + "/api/debtorpaymentterms": { + "get": { + "description": "Retrieve payment terms configured for debtor relationships", + "summary": "debtorpaymentterms 1.0", + "operationId": "getconnector-debtorpaymentterms-get-1.0", + "parameters": [ + { + "in": "query", + "name": "BusinessActivityVersion", + "schema": { + "type": "integer" + } + }, + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministationId": { + "type": "string", + "format": "uuid" + }, + "OrganisationId": { + "type": "string", + "format": "uuid" + }, + "PersonId": { + "type": "string", + "format": "uuid" + }, + "UnknownRelationId": { + "type": "string", + "format": "uuid" + }, + "InvoiceDate": { + "type": "string", + "format": "date-time" + }, + "InvoiceId": { + "type": "string" + }, + "Address": { + "type": "string" + }, + "AddressId": { + "type": "string", + "format": "uuid" + }, + "DueDate": { + "type": "string", + "format": "date-time" + }, + "RelationId": { + "type": "string" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "DueDate": "2024-02-16T00:00:00Z", + "AdministationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "InvoiceDate": "2024-02-02T00:00:00Z", + "InvoiceId": "V01240018", + "CustomerId": "c9e0fced-a61e-544e-b7ca-3e0428579f9f", + "CustomerName": "Administratiekantoor Beers", + "OrganisationId": "bb3fd8ef-5a0e-5919-8e67-77b396abf212", + "AddressId": "9e009e67-42d5-508c-9939-eb09cadb8f81", + "Address": "Postbus 779, 2700 AT, Zoetermeer, Nederland" + }, + { + "DueDate": "2024-02-02T00:00:00Z", + "AdministationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "InvoiceDate": "2024-01-19T00:00:00Z", + "InvoiceId": "V01240012", + "CustomerId": "c6734a65-7205-59e7-9777-ed5aef340c68", + "CustomerName": "Bus Grondstoffen B.V.", + "OrganisationId": "1ac6ea9d-9a7f-54f4-b9ef-fe161a55d9f6", + "AddressId": "b6fc9651-1785-53f9-9862-d7a2c84d664b", + "Address": "Eerste Tochtweg 2, 2913 LP, Capelle aan den IJssel, Nederland" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Debiteuren" + ] + } + }, + "/api/featuretoggles": { + "get": { + "description": "Retrieve feature toggle settings and configurations", + "summary": "featuretoggles 1.0", + "operationId": "getconnector-featuretoggles-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "SalesInvoices": { + "type": "boolean" + }, + "SalesJournalEntries": { + "type": "boolean" + }, + "LinesToBeInvoiced": { + "type": "boolean" + }, + "Projects": { + "type": "boolean" + }, + "Supplies": { + "type": "boolean" + }, + "Services": { + "type": "boolean" + }, + "FixedAssets": { + "type": "boolean" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "LinesToBeInvoiced": false, + "Projects": false, + "Supplies": true, + "Services": true, + "FixedAssets": true + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "LinesToBeInvoiced": false, + "Projects": false, + "Supplies": true, + "Services": true, + "FixedAssets": true + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "TechnischeInfo" + ] + } + }, + "/api/journalentries": { + "get": { + "description": "Retrieve journal entries for financial bookkeeping", + "summary": "journalentries 1.1", + "operationId": "getconnector-journalentries-get-1.1", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.1" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "HeaderId": { + "type": "string", + "format": "uuid" + }, + "LineId": { + "type": "string", + "format": "uuid" + }, + "AccountingPeriodId": { + "type": "string", + "format": "uuid" + }, + "AccountingYearId": { + "type": "string", + "format": "uuid" + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid" + }, + "AmountDebit": { + "type": "number" + }, + "AmountCredit": { + "type": "number" + }, + "AmountTotal": { + "type": "number" + }, + "Number": { + "type": "string" + }, + "PostingDate": { + "type": "string", + "format": "date-time" + }, + "Description": { + "type": "string" + }, + "DocumentIdentification": { + "type": "string" + }, + "DocumentDate": { + "type": "string", + "format": "date-time" + }, + "VatPercentage": { + "type": "number" + }, + "VatSection": { + "oneOf": [ + { + "const": "Rubriek1a", + "title": "1a verkopen hoog" + }, + { + "const": "Rubriek1b", + "title": "1b verkopen laag" + }, + { + "const": "Rubriek1c", + "title": "1c verkopen overige tarieven" + }, + { + "const": "Rubriek1d", + "title": "1d btw privé" + }, + { + "const": "Rubriek2a", + "title": "2a/5b inkopen verlegd" + }, + { + "const": "Rubriek3a", + "title": "3a verkopen buiten de EU" + }, + { + "const": "Rubriek3b", + "title": "3b verkopen binnen de EU" + }, + { + "const": "Rubriek3c", + "title": "3c afstandsverkopen" + }, + { + "const": "Rubriek4a", + "title": "4a/5b inkopen buiten de EU" + }, + { + "const": "Rubriek4b", + "title": "4b/5b inkopen binnen de EU" + }, + { + "const": "Rubriek5b", + "title": "5b voorbelasting" + }, + { + "const": "Rubriek1e", + "title": "1e verkopen 0%" + } + ] + }, + "VatAmount": { + "type": "number" + }, + "AuditCreatedOnDate": { + "type": "string", + "format": "date-time" + } + } + } + }, + "examples": { + "journalentries": { + "value": [ + { + "LineId": "20a899d9-7a95-56f7-a54b-000b17fb8d24", + "AmountDebit": 3932.17, + "AmountCredit": 0.0, + "AmountTotal": 3932.17, + "VatPercentage": null, + "VatSection": null, + "VatAmount": null, + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "HeaderId": "938afbd9-f317-53af-bcde-b1c8e5d28472", + "Number": "2477", + "PostingDate": "2022-10-31T00:00:00Z", + "DocumentDate": "2022-10-31T00:00:00Z", + "AccountingPeriodId": "59aaf644-e6da-45eb-962f-bc37555d4262", + "AccountingYearId": "f37fc13c-870f-45ae-96e1-a5fa70c861c1", + "LedgerAccountId": "349016af-3fa7-5b11-b77d-454cc05a17ee", + "Description": "Overige uitgave - NL77ABNA0441631347 - Salarisbetaling", + "DocumentIdentification": null + }, + { + "LineId": "a34bf47d-ecab-5185-b4ac-002cdb062855", + "AmountDebit": 88.94, + "AmountCredit": 0.0, + "AmountTotal": 88.94, + "VatPercentage": null, + "VatSection": null, + "VatAmount": null, + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "HeaderId": "c0c3b86b-a023-5838-9353-ceb1ab7198fa", + "Number": "2112", + "PostingDate": "2024-04-02T00:00:00Z", + "DocumentDate": "2024-03-15T00:00:00Z", + "AccountingPeriodId": "49a93c26-2f8c-44c3-9be2-552f3b6a8fce", + "AccountingYearId": "cc0b784f-a591-4e37-8cb4-ba06374d18df", + "LedgerAccountId": "78685f08-fb5c-593f-a7d8-b4ed2886ef9d", + "Description": "Verkoopfactuur - Erbi Lara B.V.", + "DocumentIdentification": "V01240034" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.1", + "deprecated": false, + "tags": [ + "Financiele rapportage" + ] + } + }, + "/api/ledgeraccounts": { + "get": { + "description": "Retrieve all ledger accounts", + "summary": "ledgeraccounts 1.0", + "operationId": "getconnector-ledgeraccounts-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + }, + "LedgerAccountNumber": { + "type": "string" + }, + "TypeId": { + "oneOf": [ + { + "const": "Activa", + "title": "activa" + }, + { + "const": "Kosten", + "title": "kosten" + }, + { + "const": "Opbrengsten", + "title": "opbrengsten" + }, + { + "const": "Passiva", + "title": "passiva" + } + ] + }, + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "InvestInAsset": { + "type": "boolean" + } + } + } + }, + "examples": { + "ledgeraccounts": { + "value": [ + { + "Id": "cfb59b79-b3ec-55ef-8cde-000499c3179e", + "Description": "Omzet Algemeen", + "LedgerAccountNumber": "8000", + "TypeId": "aae9334f-0fa8-43cb-ad52-cff973b4c863", + "InstanceId": "cfb59b79-b3ec-55ef-8cde-000499c3179e", + "InvestInAsset": false, + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911" + }, + { + "Id": "68730415-2a59-50ce-9968-00303319780d", + "Description": "Schepen", + "LedgerAccountNumber": "0247", + "TypeId": "980eb36a-8bec-45d9-97f6-06dd2c551818", + "InstanceId": "68730415-2a59-50ce-9968-00303319780d", + "InvestInAsset": true, + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële dashboarding", + "Publiek: Financiële journaalpost", + "Financiële journaalpost", + "Publiek: Financiële rapportage", + "Financiele rapportage", + "Loonjournaalpost", + "Publiek: POS Transacties", + "POS Transacties", + "Inkoopjournaalpost", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/ledgerperiodtotals": { + "get": { + "description": "Retrieve ledger account totals grouped by period for reporting", + "summary": "ledgerperiodtotals 1.0", + "operationId": "getconnector-ledgerperiodtotals-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "AccountingYear": { + "type": "string" + }, + "AccountingYearId": { + "type": "string", + "format": "uuid" + }, + "AccountingYearStartDate": { + "type": "string", + "format": "date-time" + }, + "AccountingYearEndDate": { + "type": "string", + "format": "date-time" + }, + "AccountingPeriod": { + "type": "string" + }, + "AccountingPeriodId": { + "type": "string", + "format": "uuid" + }, + "AccountingPeriodStartDate": { + "type": "string", + "format": "date-time" + }, + "AccountingPeriodEndDate": { + "type": "string", + "format": "date-time" + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid" + }, + "LedgerAccount": { + "type": "string" + }, + "IsOpeningBalance": { + "type": "boolean" + }, + "RgsCode": { + "type": "string" + }, + "RgsDescription": { + "type": "string" + }, + "LedgerAccountNumber": { + "type": "string" + }, + "Total": { + "type": "number" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "Total": -210.0, + "IsOpeningBalance": false, + "AdministrationId": "4fef7d35-e93c-4cb2-b367-0deb692e5647", + "AccountingYearId": "2ebff944-f3d0-4335-a3b7-ff637df54ca4", + "AccountingYear": "2024", + "AccountingYearStartDate": "2024-01-01T00:00:00Z", + "AccountingYearEndDate": "2024-12-31T00:00:00Z", + "AccountingPeriodId": "c2ebc6d5-c5af-4bb5-8fea-2e8a7e91399c", + "AccountingPeriod": "Januari 2024", + "AccountingPeriodStartDate": "2024-01-01T00:00:00Z", + "AccountingPeriodEndDate": "2024-01-31T00:00:00Z", + "LedgerAccountId": "90aee254-9eeb-56af-abe2-064fffbd1c00", + "LedgerAccount": "Te betalen btw (1800)", + "LedgerAccountNumber": "90aee254-9eeb-56af-abe2-064fffbd1c00", + "RgsCode": "BSchBepBtw", + "RgsDescription": "Te betalen Omzetbelasting", + "InstanceId": "b0c63c7b-5b65-469a-bbdf-319579d649b4" + }, + { + "Total": -1000.0, + "IsOpeningBalance": false, + "AdministrationId": "4fef7d35-e93c-4cb2-b367-0deb692e5647", + "AccountingYearId": "2ebff944-f3d0-4335-a3b7-ff637df54ca4", + "AccountingYear": "2024", + "AccountingYearStartDate": "2024-01-01T00:00:00Z", + "AccountingYearEndDate": "2024-12-31T00:00:00Z", + "AccountingPeriodId": "c2ebc6d5-c5af-4bb5-8fea-2e8a7e91399c", + "AccountingPeriod": "Januari 2024", + "AccountingPeriodStartDate": "2024-01-01T00:00:00Z", + "AccountingPeriodEndDate": "2024-01-31T00:00:00Z", + "LedgerAccountId": "8aa84f79-4892-5cae-b6d1-2e4f9365b892", + "LedgerAccount": "Omzet groep 1 (8000)", + "LedgerAccountNumber": "8aa84f79-4892-5cae-b6d1-2e4f9365b892", + "RgsCode": "WOmzGrpGr1", + "RgsDescription": "Netto-omzet groep 1", + "InstanceId": "89bd2a01-d2e0-418d-9585-5c25f5b471e4" + }, + { + "Total": 1210.0, + "IsOpeningBalance": false, + "AdministrationId": "4fef7d35-e93c-4cb2-b367-0deb692e5647", + "AccountingYearId": "2ebff944-f3d0-4335-a3b7-ff637df54ca4", + "AccountingYear": "2024", + "AccountingYearStartDate": "2024-01-01T00:00:00Z", + "AccountingYearEndDate": "2024-12-31T00:00:00Z", + "AccountingPeriodId": "c2ebc6d5-c5af-4bb5-8fea-2e8a7e91399c", + "AccountingPeriod": "Januari 2024", + "AccountingPeriodStartDate": "2024-01-01T00:00:00Z", + "AccountingPeriodEndDate": "2024-01-31T00:00:00Z", + "LedgerAccountId": "2fc1ada7-a66a-5b4b-9644-af29d46865c5", + "LedgerAccount": "Debiteuren (1300)", + "LedgerAccountNumber": "2fc1ada7-a66a-5b4b-9644-af29d46865c5", + "RgsCode": "BVorDebHad", + "RgsDescription": "Handelsdebiteuren nominaal", + "InstanceId": "cf9671f4-96c3-40f6-8048-ebc86c1f2dc4" + }, + { + "Total": -1000.0, + "IsOpeningBalance": false, + "AdministrationId": "4fef7d35-e93c-4cb2-b367-0deb692e5647", + "AccountingYearId": "2ebff944-f3d0-4335-a3b7-ff637df54ca4", + "AccountingYear": "2024", + "AccountingYearStartDate": "2024-01-01T00:00:00Z", + "AccountingYearEndDate": "2024-12-31T00:00:00Z", + "AccountingPeriodId": "c2ebc6d5-c5af-4bb5-8fea-2e8a7e91399c", + "AccountingPeriod": "Januari 2024", + "AccountingPeriodStartDate": "2024-01-01T00:00:00Z", + "AccountingPeriodEndDate": "2024-01-31T00:00:00Z", + "LedgerAccountId": "38b36a37-32a8-5775-8d3a-b118dd32f77a", + "LedgerAccount": "Onverdeeld resultaat (0900)", + "LedgerAccountNumber": "38b36a37-32a8-5775-8d3a-b118dd32f77a", + "RgsCode": "BEivOreOvw", + "RgsDescription": "Niet verdeelde winst", + "InstanceId": "36bc8088-7d06-42b5-9ea1-06d47d4a4fd1" + }, + { + "Total": 1000.0, + "IsOpeningBalance": false, + "AdministrationId": "4fef7d35-e93c-4cb2-b367-0deb692e5647", + "AccountingYearId": "2ebff944-f3d0-4335-a3b7-ff637df54ca4", + "AccountingYear": "2024", + "AccountingYearStartDate": "2024-01-01T00:00:00Z", + "AccountingYearEndDate": "2024-12-31T00:00:00Z", + "AccountingPeriodId": "c2ebc6d5-c5af-4bb5-8fea-2e8a7e91399c", + "AccountingPeriod": "Januari 2024", + "AccountingPeriodStartDate": "2024-01-01T00:00:00Z", + "AccountingPeriodEndDate": "2024-01-31T00:00:00Z", + "LedgerAccountId": "e8485631-976a-55f6-8c16-c031723460b1", + "LedgerAccount": "Overboeking van het resultaat (9999)", + "LedgerAccountNumber": "e8485631-976a-55f6-8c16-c031723460b1", + "RgsCode": "ResultaatNiveau2", + "RgsDescription": "Resultaat", + "InstanceId": "4e7b8b7d-d577-4cdd-9748-20e4742b8880" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële dashboarding", + "Publiek: Financiële rapportage", + "Financiele rapportage" + ] + } + }, + "/api/linestobeinvoiced": { + "get": { + "description": "Retrieve lines that are pending to be invoiced", + "summary": "linestobeinvoiced 1.0", + "operationId": "getconnector-linestobeinvoiced-get-1.0", + "parameters": [ + { + "in": "query", + "name": "BusinessActivityVersion", + "schema": { + "type": "integer" + } + }, + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "InstanceId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationNumber": { + "type": "string" + }, + "RelationDescription": { + "type": "string" + }, + "ProductId": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + }, + "Quantity": { + "type": "number" + }, + "Price": { + "type": "number" + }, + "TotalAmount": { + "type": "number" + }, + "ProjectId": { + "type": "string", + "format": "uuid" + }, + "ProjectDescription": { + "type": "string" + }, + "Status": { + "oneOf": [ + { + "const": "TODO", + "title": "te factureren" + }, + { + "const": "BUSY", + "title": "onderweg" + }, + { + "const": "DONE", + "title": "gefactureerd" + }, + { + "const": "DONEEDIT", + "title": "bezig met wijzigen van gefactureerd" + }, + { + "const": "DONEERROR", + "title": "in fout staat" + }, + { + "const": "REDO", + "title": "opnieuw te factureren" + }, + { + "const": "CANNOTBEDONE", + "title": "niet te factureren" + }, + { + "const": "CANNOTBEREDONE", + "title": "niet opnieuw te factureren" + }, + { + "const": "TOCREDIT", + "title": "te crediteren" + }, + { + "const": "CREDITED", + "title": "gecrediteerd" + }, + { + "const": "DELETED", + "title": "verwijderd" + }, + { + "const": "TODOERROR", + "title": "in fout staat" + }, + { + "const": "TODOEDIT", + "title": "bezig met wijzigen van te factureren" + }, + { + "const": "TODOPENDING", + "title": "bezig met wachten" + }, + { + "const": "REPLACED", + "title": "gespecificeerd" + }, + { + "const": "TOSPECIFY", + "title": "af te letteren" + }, + { + "const": "SPECIFIED", + "title": "afgeletterd" + }, + { + "const": "ALTERNATIVELYSPECIFIED", + "title": "alternatief gespecificeerd" + }, + { + "const": "INITIALIZED", + "title": "geïnitialiseerd" + }, + { + "const": "INITIALIZEDEDIT", + "title": "geïnitialiseerd" + }, + { + "const": "PENDINGAPPROVAL", + "title": "te accorderen" + }, + { + "const": "PENDINGCOMPLETION", + "title": "te factureren" + }, + { + "const": "COMPLETED", + "title": "gefactureerd" + }, + { + "const": "DECLINED", + "title": "afgewezen" + }, + { + "const": "TEMPLATE", + "title": "sjabloon" + }, + { + "const": "TEMPLATEEDIT", + "title": "bezig met wijzigen van factureren" + }, + { + "const": "TEMPLATEERROR", + "title": "in fout staat" + } + ] + }, + "SalesInvoiceNumber": { + "type": "string" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "InstanceId": "fcb31b25-8da1-4a90-ae33-a93d932184f0", + "Ownorganization": { + "Id": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "ComponentId": "cbb9b7ef-ef04-4c84-9e80-4989bd526865" + }, + "DatumGepland": "2024-12-04T00:00:00Z", + "Klant": { + "Id": "509e24de-67fb-4e02-b149-f8c615fef64c", + "ComponentId": "8e352e23-04af-45b7-952a-0afc7575ea7a" + }, + "ProjectKoppelen": true, + "Project": { + "Id": "e03c053d-3e72-400b-821d-c3398edf1ccc", + "ComponentId": "497fc9c2-340d-4d18-b097-c6bbd06bbab7" + }, + "Verkoopproduct": { + "Id": "aaf04330-151c-44d9-9700-8793b1c0d4b4", + "ComponentId": "230b4172-613e-4e1b-9ed5-93496c4eed6b" + }, + "Description": "AFAS Software B.V. (000003) - 04-12-2024", + "Aantal": 32.0, + "Prijs": 539.7, + "Bedrag": 17270.4, + "MethodeBepalenPrijs": "52085b0b-a85a-418e-8e33-a00e48666512", + "Status": "692a0b09-b83b-44cb-b75a-e431eb66302f", + "KlantDescription": "AFAS Software B.V. (000003)", + "ProjectDescription": "Implementation Exceptional", + "VerkoopproductDescription": "Acer Laptop (3320, 000001)" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels" + ] + }, + "post": { + "description": "Create lines to be invoiced for billing processes", + "summary": "linestobeinvoiced 1.0", + "operationId": "updateconnector-linestobeinvoiced-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "linestobeinvoiced 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/linestobeinvoiced-1.0-Create-JsonSchema" + }, + "examples": { + "new linestobeinvoiced": { + "value": { + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "Date": "2024-12-04", + "Description": "Dell Laptop", + "RelationType": "organisation", + "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "ItemId": "aaf04330-151c-44d9-9700-8793b1c0d4b4", + "Quantity": 32, + "ProjectId": "e03c053d-3e72-400b-821d-c3398edf1ccc" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "succes": { + "value": { + "result": "Succeeded", + "traceId": "3614178a-f801-47b7-bae1-dad6439f2c54", + "data": { + "LinesToBeInvoiced": "fcb31b25-8da1-4a90-ae33-a93d932184f0" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "LinesToBeInvoiced": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + }, + "400": { + "content": { + "application/json": { + "examples": { + "not enabled": { + "value": { + "result": "Failed", + "traceId": "339ee3cf-e6bb-4201-9fd0-577906f9f96a", + "instances": [], + "errors": [ + "FeatureToggle not enabled" + ] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "instances": { + "type": "array", + "items": {} + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels" + ] + }, + "delete": { + "description": "Delete lines to be invoiced from billing processes", + "summary": "linestobeinvoiced 1.0", + "operationId": "updateconnector-linestobeinvoiced-Delete-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "linestobeinvoiced 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/linestobeinvoiced-1.0-Delete-JsonSchema" + }, + "examples": { + "minimal": { + "value": { + "AdministrationId": "e877fb82-b546-4d20-94cf-05c72765fc47", + "Id": "e877fb82-b546-4d20-94cf-05c72765fc47" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "success": { + "value": { + "result": "Succeeded", + "traceId": "3614178a-f801-47b7-bae1-dad6439f2c54", + "data": { + "LinesToBeInvoiced": "fcb31b25-8da1-4a90-ae33-a93d932184f0" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "LinesToBeInvoiced": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels" + ] + }, + "put": { + "description": "Update lines to be invoiced for billing processes", + "summary": "linestobeinvoiced 1.0", + "operationId": "updateconnector-linestobeinvoiced-Put-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "linestobeinvoiced 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/linestobeinvoiced-1.0-Update-JsonSchema" + }, + "examples": { + "example": { + "value": { + "LineToBeInvoicedId": "547a03a2-19c9-4058-bc77-452063b25d6d", + "AdministrationId": "5c86c621-14fc-5d09-a387-772c599caa5d", + "Date": "2024-11-04", + "Description": "Dell Laptop", + "RelationType": "organisation", + "RelationId": "30bf2fcc-306d-5680-9e03-d99fbfe46bc2", + "ItemId": "4689e028-02c7-5324-885a-556701bd1a9f", + "Quantity": 50 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "succes": { + "value": { + "result": "Succeeded", + "traceId": "3614178a-f801-47b7-bae1-dad6439f2c54", + "data": { + "LinesToBeInvoiced": "fcb31b25-8da1-4a90-ae33-a93d932184f0" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "LinesToBeInvoiced": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels" + ] + } + }, + "/api/organisations": { + "get": { + "description": "Retrieve organization information and business details", + "summary": "organisations 2.0", + "operationId": "getconnector-organisations-get-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Name": { + "type": "string" + }, + "CocNumber": { + "type": "string" + }, + "VatNumber": { + "type": "string" + }, + "PhoneNumber": { + "type": "string" + }, + "EmailAddress": { + "type": "string" + }, + "SbiCode": { + "type": "string" + }, + "RelationId": { + "type": "string" + }, + "ExternalId": { + "type": "string" + }, + "IsArchived": { + "type": "boolean" + } + } + } + }, + "examples": { + "example": { + "value": { + "TrackingToken": "202401291319301", + "Result": [ + { + "Id": "e36e77f0-9a1c-50d0-a3f3-004f1fee8720", + "Name": "Erbi Lara B.V. (000019)", + "CocNumber": null, + "VatNumber": null, + "RelationId": "000019", + "ExternalId": null, + "IsArchived": false, + "EmailAddress": "info@erbilara.afas" + }, + { + "Id": "45aafd00-a21b-5440-bf57-0aa5fa6c2294", + "Name": "Alsach Musik GmbH (000037)", + "CocNumber": null, + "VatNumber": "DE184475234", + "RelationId": "000037", + "ExternalId": null, + "IsArchived": false, + "EmailAddress": "info@alsachmusic.afasde" + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Inkoopjournaalpost", + "Publiek: Relatiemanagement", + "Relaties", + "Publiek: Facturatie", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/paymentconditions": { + "get": { + "description": "Retrieve payment conditions and terms settings", + "summary": "paymentconditions 1.0", + "operationId": "getconnector-paymentconditions-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "Id": "9b5d768a-c71b-583e-b6ee-09d64aa935d4", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "Description": "21 dagen" + }, + { + "Id": "b8ca9e8d-6fef-5ef6-95ba-0bd221aebc6f", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "Description": "60 dagen" + }, + { + "Id": "a59bab3a-36bb-5974-bdad-276f6395d6b6", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "Description": "14 dagen" + }, + { + "Id": "b98e24e9-a611-5a98-8cf9-40fed321dc6c", + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "60 dagen" + }, + { + "Id": "c06d2eb9-1332-5e78-a8b3-58dd62dcee45", + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "7 dagen" + }, + { + "Id": "0066f624-c140-5262-9fbb-5e3141d32876", + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "14 dagen" + }, + { + "Id": "eb44c60d-06e4-564b-a90c-7715c78788a5", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "Description": "45 dagen" + }, + { + "Id": "a629b70b-6a91-5906-9f9d-97f83dfd0c58", + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "90 dagen" + }, + { + "Id": "ab8b0914-74a2-5db5-a948-ae34ea6b7f7e", + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "30 dagen" + }, + { + "Id": "2d8304eb-1472-5fad-8fed-b1c30b2a1749", + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "21 dagen" + }, + { + "Id": "3bed98d9-94d0-5147-9cb8-cad047a0b9bd", + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "45 dagen" + }, + { + "Id": "6372c28d-7468-5c58-8826-cea9bf70758a", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "Description": "90 dagen" + }, + { + "Id": "4a09121c-4f48-5a29-9cef-ecfb5bb74dcf", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "Description": "7 dagen" + }, + { + "Id": "596a0343-fd85-597a-8918-ed3198de119d", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "Description": "30 dagen" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Inkoopjournaalpost", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/persons": { + "get": { + "description": "Retrieve person information and personal details", + "summary": "persons 2.0", + "operationId": "getconnector-persons-get-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Name": { + "type": "string" + }, + "FirstName": { + "type": "string" + }, + "Initials": { + "type": "string" + }, + "Prefix": { + "type": "string" + }, + "Lastname": { + "type": "string" + }, + "PhoneNumber": { + "type": "string" + }, + "EmailAddress": { + "type": "string" + }, + "ExternalId": { + "type": "string" + }, + "IsArchived": { + "type": "boolean" + } + } + } + }, + "examples": { + "example": { + "value": { + "TrackingToken": "202401291327471", + "Result": [ + { + "Id": "2aacc092-9c6c-5020-b1cf-0d8ecd6485dc", + "Name": "Cas de Graaf", + "FirstName": "Cas", + "Initials": "C.", + "Prefix": "de", + "Lastname": "Graaf", + "ExternalId": null, + "IsArchived": false + }, + { + "Id": "1242493d-bd93-53b3-9852-1c82c83316aa", + "Name": "Tarik el Erdol", + "FirstName": "Tarik", + "Initials": "T.", + "Prefix": "el", + "Lastname": "Erdol", + "ExternalId": null, + "IsArchived": false + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Inkoopjournaalpost", + "Publiek: Relatiemanagement", + "Relaties", + "Publiek: Facturatie", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/products": { + "get": { + "description": "Retrieve product catalog with pricing and inventory information", + "summary": "products 3.0", + "operationId": "getconnector-products-get-3.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "3.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "Id": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + }, + "Code": { + "type": "string" + }, + "InternalId": { + "type": "string" + }, + "PriceExcludingVAT": { + "type": "number" + }, + "PriceIncludingVAT": { + "type": "number" + }, + "ProductGroup": { + "type": "string" + }, + "Barcode": { + "type": "string" + }, + "Category": { + "type": "string" + }, + "ExtraDescription": { + "type": "string" + }, + "ProductStyle": { + "oneOf": [ + { + "const": "AantalVanSoort", + "title": "aantal van soort" + }, + { + "const": "Afdeling", + "title": "afdeling" + }, + { + "const": "Bankrekening", + "title": "bankrekening" + }, + { + "const": "Contactpersoon", + "title": "contactpersoon" + }, + { + "const": "Deelname", + "title": "deelname" + }, + { + "const": "Gegeven", + "title": "gegeven" + }, + { + "const": "Goed", + "title": "goed" + }, + { + "const": "Kas", + "title": "kas" + }, + { + "const": "Kosten", + "title": "kosten" + }, + { + "const": "Land", + "title": "land" + }, + { + "const": "Onbekend", + "title": "onbekend" + }, + { + "const": "Organisatie", + "title": "organisatie" + }, + { + "const": "Persoon", + "title": "persoon" + }, + { + "const": "Ruimte", + "title": "ruimte" + }, + { + "const": "Tijd", + "title": "tijd" + } + ] + }, + "IsArchived": { + "type": "boolean" + }, + "IsBlocked": { + "type": "boolean" + }, + "IsDisabled": { + "type": "boolean" + }, + "Blob": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "ReadKey": { + "type": "string" + }, + "FileName": { + "type": "string" + }, + "ContentType": { + "type": "string" + }, + "ContentLength": { + "type": "number" + } + } + } + } + } + }, + "examples": { + "example": { + "value": { + "TrackingToken": "202504011910441", + "Result": [ + { + "Id": "c38525f4-845d-5dd8-9b3a-00eec99c34ab", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Vast actief (btw nul)", + "InternalId": null, + "Barcode": null, + "Category": null, + "ProductStyle": "d55d181a-4ab5-4d68-9296-4fbd534cc998", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 0.0, + "ProductGroup": "Vaste activa", + "ProductType": "unknown" + }, + { + "Id": "f469cfc6-1b8b-587f-9ac6-10a975e5edcd", + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "Description": "Vast actief (btw hoog)", + "InternalId": null, + "Barcode": null, + "Category": null, + "ProductStyle": "d55d181a-4ab5-4d68-9296-4fbd534cc998", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 0.0, + "ProductGroup": "Vaste activa", + "ProductType": "unknown" + }, + { + "Id": "c4617493-a611-59ea-9a0c-293391c3466e", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Bouwen (2002, 000017)", + "InternalId": "000017", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 75.0, + "ProductGroup": "Web Design", + "ProductType": "supplies" + }, + { + "Id": "7f54afa4-dc32-5538-be15-4279863ca5e6", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Muis Logitech (5100, 000004)", + "InternalId": "000004", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 9.98, + "ProductGroup": "Randapparatuur", + "ProductType": "supplies" + }, + { + "Id": "6d5a94f4-6911-5771-9517-4420b101439a", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Draadloos toestenbord + muis Lenovo (5003, 000011)", + "InternalId": "000011", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 67.73, + "ProductGroup": "Randapparatuur", + "ProductType": "supplies" + }, + { + "Id": "411a8c24-5406-5bd6-9fd1-5425a67130c9", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Lenovo Monitor 24 inch (4201, 000012)", + "InternalId": "000012", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 340.73, + "ProductGroup": "Monitoren", + "ProductType": "supplies" + }, + { + "Id": "5dbb40d7-52b5-51b6-809e-5a16dddeb650", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Draadloos toetsenbord + muis Logitech (5002, 000010)", + "InternalId": "000010", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 29.93, + "ProductGroup": "Randapparatuur", + "ProductType": "supplies" + }, + { + "Id": "f871b91d-bb1e-5f52-a70c-5cddf2108929", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Acer Laptop (3320, 000008)", + "InternalId": "000008", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 539.7, + "ProductGroup": "Systemen", + "ProductType": "supplies" + }, + { + "Id": "db17280f-6105-5d22-975b-6c4e49c8682f", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Klassiek (Qwerty) toetsenbord Logitech (5000, 000003)", + "InternalId": "000003", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 13.65, + "ProductGroup": "Randapparatuur", + "ProductType": "supplies" + }, + { + "Id": "347d7d36-994b-5b4d-80a1-9a15532e6035", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Dell Monitor 24 inch (4003, 000009)", + "InternalId": "000009", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 240.98, + "ProductGroup": "Monitoren", + "ProductType": "supplies" + }, + { + "Id": "d1247d55-a298-55ca-bb55-9ed75bdc7c34", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Ontwerpen (2001, 000019)", + "InternalId": "000019", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 75.0, + "ProductGroup": "Web Design", + "ProductType": "supplies" + }, + { + "Id": "f4b51c75-1e2b-522a-aca2-a2dd8eab3a24", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Management Fee (MF, 000013)", + "InternalId": "000013", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 8825.0, + "ProductGroup": "Management Fee", + "ProductType": "supplies" + }, + { + "Id": "f4b51c75-1e2b-522a-aca2-a2dd8eab3a24", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Management Fee (MF, 000013)", + "InternalId": "000013", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 8000.0, + "ProductGroup": "Management Fee", + "ProductType": "supplies" + }, + { + "Id": "1be89d6d-9d74-53f4-af12-aa22bc76d896", + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "Description": "Vast actief (btw laag)", + "InternalId": null, + "Barcode": null, + "Category": null, + "ProductStyle": "d55d181a-4ab5-4d68-9296-4fbd534cc998", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 0.0, + "ProductGroup": "Vaste activa", + "ProductType": "unknown" + }, + { + "Id": "f84c1bb4-9de9-578f-989e-ae39a19e3cb7", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Vast actief (btw hoog)", + "InternalId": null, + "Barcode": null, + "Category": null, + "ProductStyle": "d55d181a-4ab5-4d68-9296-4fbd534cc998", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 0.0, + "ProductGroup": "Vaste activa", + "ProductType": "unknown" + }, + { + "Id": "e4a2db09-8534-55f1-8bfc-b30a40024f5e", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Microsoft Office 365 gebruikerstraining (1000, 000015)", + "InternalId": "000015", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 995.0, + "ProductGroup": "Cursussen", + "ProductType": "supplies" + }, + { + "Id": "a48526d9-3bb2-57e0-b4c2-b43f0ab137b5", + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "Description": "Vast actief (btw nul)", + "InternalId": null, + "Barcode": null, + "Category": null, + "ProductStyle": "d55d181a-4ab5-4d68-9296-4fbd534cc998", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 0.0, + "ProductGroup": "Vaste activa", + "ProductType": "unknown" + }, + { + "Id": "171cc8aa-d9bd-5800-ad05-c1b38878d584", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Onderhoud (2003, 000018)", + "InternalId": "000018", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 75.0, + "ProductGroup": "Web Design", + "ProductType": "supplies" + }, + { + "Id": "ea4fcede-5143-5860-ab4e-c763cfae25f0", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Projectleiding (2000, 000014)", + "InternalId": "000014", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 95.0, + "ProductGroup": "Web Design", + "ProductType": "supplies" + }, + { + "Id": "aa760e86-92da-50d1-bdb7-c873a9443264", + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "Description": "Management Fee (MF, 000013)", + "InternalId": "000013", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 8825.0, + "ProductGroup": "Management Fee", + "ProductType": "supplies" + }, + { + "Id": "aa760e86-92da-50d1-bdb7-c873a9443264", + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "Description": "Management Fee (MF, 000013)", + "InternalId": "000013", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 8000.0, + "ProductGroup": "Management Fee", + "ProductType": "supplies" + }, + { + "Id": "f766cf32-c4a2-5123-bbe9-d69b9ce8b37b", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Diverse producten", + "InternalId": null, + "Barcode": null, + "Category": null, + "ProductStyle": "d55d181a-4ab5-4d68-9296-4fbd534cc998", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "ProductGroup": "Diverse producten", + "ProductType": "unknown" + }, + { + "Id": "4ac33af1-ae7d-5923-9506-e1dedf7b7c14", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Lenovo Laptop (3330, 000002)", + "InternalId": "000002", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 431.55, + "ProductGroup": "Systemen", + "ProductType": "supplies" + }, + { + "Id": "c35a780e-c4ba-504c-a54f-e1eee1d16dce", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Draadloos toestenbord + muis Dell (5102, 000006)", + "InternalId": "000006", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 36.75, + "ProductGroup": "Randapparatuur", + "ProductType": "supplies" + }, + { + "Id": "1048caf1-d7bb-52e9-a638-e525d375e672", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Acer Monitor 24 inch (4104, 000001)", + "InternalId": "000001", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 519.23, + "ProductGroup": "Monitoren", + "ProductType": "supplies" + }, + { + "Id": "b1b6cf37-3ec0-52b5-bde7-e5c34a0dbdb8", + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "Description": "Diverse producten", + "InternalId": null, + "Barcode": null, + "Category": null, + "ProductStyle": "d55d181a-4ab5-4d68-9296-4fbd534cc998", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "ProductGroup": "Diverse producten", + "ProductType": "unknown" + }, + { + "Id": "dd306400-eb3c-594a-91bd-e7291250f90f", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Vast actief (btw laag)", + "InternalId": null, + "Barcode": null, + "Category": null, + "ProductStyle": "d55d181a-4ab5-4d68-9296-4fbd534cc998", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 0.0, + "ProductGroup": "Vaste activa", + "ProductType": "unknown" + }, + { + "Id": "e974bd03-fe5f-5d70-a3ef-ec6f4485143a", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Dell Laptop (3310, 000005)", + "InternalId": "000005", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 205.28, + "ProductGroup": "Systemen", + "ProductType": "supplies" + }, + { + "Id": "01911013-b8ba-5dfd-a250-fa7f6f709220", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Samsung Monitor 32 inch (4203, 000007)", + "InternalId": "000007", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 822.15, + "ProductGroup": "Monitoren", + "ProductType": "supplies" + }, + { + "Id": "ce109323-b122-5acd-bd3a-fbc9ff934f9a", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Microsoft Power Platform App maker (1001, 000016)", + "InternalId": "000016", + "Barcode": null, + "Category": null, + "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", + "IsArchived": false, + "IsBlocked": false, + "IsDisabled": false, + "Blob": null, + "PriceExcludingVAT": 250.0, + "ProductGroup": "Cursussen", + "ProductType": "supplies" + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "3.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Publiek: Facturatie", + "Verkoopfactuur" + ] + } + }, + "/api/projects": { + "get": { + "description": "Retrieve project information for time tracking and billing", + "summary": "projects 1.0", + "operationId": "getconnector-projects-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "Omschrijving": { + "type": "string" + } + } + } + }, + "examples": { + "example": { + "value": { + "TrackingToken": "202412131017330", + "Result": [ + { + "InstanceId": "96d5ef01-0d3f-4a60-b5ee-8a915693f5c2", + "Omschrijving": "Implementation Greenshop", + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502" + }, + { + "InstanceId": "e03c053d-3e72-400b-821d-c3398edf1ccc", + "Omschrijving": "Implementation Exceptional", + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502" + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels" + ] + } + }, + "/api/salesinvoices": { + "get": { + "description": "Retrieve sales invoices and billing information", + "summary": "salesinvoices 1.1", + "operationId": "getconnector-salesinvoices-get-1.1", + "parameters": [ + { + "in": "query", + "name": "BusinessActivityVersion", + "schema": { + "type": "integer" + } + }, + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.1" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "InstanceId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "SalesInvoiceNumber": { + "type": "string" + }, + "IssueDate": { + "type": "string", + "format": "date-time" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationNumber": { + "type": "string" + }, + "RelationDescription": { + "type": "string" + }, + "Status": { + "oneOf": [ + { + "const": "TODO", + "title": "te verzenden" + }, + { + "const": "BUSY", + "title": "onderweg" + }, + { + "const": "DONE", + "title": "verzonden" + }, + { + "const": "DONEEDIT", + "title": "bezig met wijzigen van verzonden" + }, + { + "const": "DONEERROR", + "title": "in fout staat" + }, + { + "const": "REDO", + "title": "opnieuw te verzenden" + }, + { + "const": "CANNOTBEDONE", + "title": "niet te verzenden" + }, + { + "const": "CANNOTBEREDONE", + "title": "niet opnieuw te verzenden" + }, + { + "const": "TOCREDIT", + "title": "te crediteren" + }, + { + "const": "CREDITED", + "title": "gecrediteerd" + }, + { + "const": "DELETED", + "title": "verwijderd" + }, + { + "const": "TODOERROR", + "title": "in fout staat" + }, + { + "const": "TODOEDIT", + "title": "bezig met wijzigen van te verzenden" + }, + { + "const": "TODOPENDING", + "title": "bezig met wachten" + }, + { + "const": "REPLACED", + "title": "gespecificeerd" + }, + { + "const": "TOSPECIFY", + "title": "af te letteren" + }, + { + "const": "SPECIFIED", + "title": "afgeletterd" + }, + { + "const": "ALTERNATIVELYSPECIFIED", + "title": "alternatief gespecificeerd" + }, + { + "const": "INITIALIZED", + "title": "geïnitialiseerd" + }, + { + "const": "INITIALIZEDEDIT", + "title": "geïnitialiseerd" + }, + { + "const": "PENDINGAPPROVAL", + "title": "te accorderen" + }, + { + "const": "PENDINGCOMPLETION", + "title": "te factureren" + }, + { + "const": "COMPLETED", + "title": "gefactureerd" + }, + { + "const": "DECLINED", + "title": "afgewezen" + }, + { + "const": "TEMPLATE", + "title": "sjabloon" + }, + { + "const": "TEMPLATEEDIT", + "title": "bezig met wijzigen van verzenden" + }, + { + "const": "TEMPLATEERROR", + "title": "in fout staat" + }, + { + "const": "MESSAGEPENDING", + "title": "Bezig met verzenden" + }, + { + "const": "MESSAGESEND", + "title": "Verzonden" + }, + { + "const": "MESSAGEFAILED", + "title": "Fout bij verzenden" + } + ] + }, + "Blob": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "ReadKey": { + "type": "string" + }, + "FileName": { + "type": "string" + }, + "ContentType": { + "type": "string" + }, + "ContentLength": { + "type": "number" + } + } + } + }, + "AmountExcludingVat": { + "type": "number" + }, + "AmountVat": { + "type": "number" + }, + "AmountInvoiced": { + "type": "number" + } + } + } + }, + "examples": { + "example": { + "value": { + "TrackingToken": "202601141348101", + "Result": [ + { + "InstanceId": "76ccd112-3faf-5243-8ee8-001638826d4c", + "AmountExcludingVat": 225.0, + "AmountVat": null, + "AmountInvoiced": 225.0, + "SalesInvoiceNumber": "V01250154", + "IssueDate": "2025-12-05T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "c08e2474-976c-5c7c-94dc-eb02580009d0", + "RelationNumber": "000039", + "RelationDescription": "Administratiekantoor Beers", + "RelationType": "organisation" + }, + { + "InstanceId": "a25d4251-74f9-5406-8639-003be5b0a58e", + "AmountExcludingVat": 1644.3, + "AmountVat": null, + "AmountInvoiced": 1644.3, + "SalesInvoiceNumber": "V01250150", + "IssueDate": "2025-12-05T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "2fdc272a-5da6-55b8-a352-928d3c1e79b6", + "RelationNumber": "000024", + "RelationDescription": "Schreurs Administratiekantoor B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "6645f89b-4d85-56d5-90a4-00701269aeec", + "AmountExcludingVat": 95.0, + "AmountVat": null, + "AmountInvoiced": 95.0, + "SalesInvoiceNumber": "V01240035", + "IssueDate": "2024-03-15T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": null, + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "9fc15edd-9431-5a98-b2e1-0d90f2064527", + "RelationNumber": "000035", + "RelationDescription": "Architectenbureau Brauw B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "bed4a8fe-745e-56ae-a39c-01056ea488af", + "AmountExcludingVat": 150.0, + "AmountVat": null, + "AmountInvoiced": 150.0, + "SalesInvoiceNumber": "V01250133", + "IssueDate": "2025-10-17T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "200dae98-c4db-5da1-b8dd-018f934bcaa0", + "RelationNumber": "000037", + "RelationDescription": "Meepo Instituut B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "284454af-5f23-569b-8735-011f328b1f14", + "AmountExcludingVat": 59.86, + "AmountVat": null, + "AmountInvoiced": 59.86, + "SalesInvoiceNumber": "V01250137", + "IssueDate": "2025-11-07T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "43ff15dd-50a5-5d24-9dba-5271c80e5a8f", + "RelationNumber": "000016", + "RelationDescription": "Beentjes & Zn. Dakbedekking B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "c5277238-d627-59ad-a7cd-017268ac23f1", + "AmountExcludingVat": 1703.65, + "AmountVat": null, + "AmountInvoiced": 1703.65, + "SalesInvoiceNumber": "V01240031", + "IssueDate": "2024-03-01T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": null, + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "c08e2474-976c-5c7c-94dc-eb02580009d0", + "RelationNumber": "000039", + "RelationDescription": "Administratiekantoor Beers", + "RelationType": "organisation" + }, + { + "InstanceId": "bad2f2a1-8522-5d64-a5ed-01b63853b141", + "AmountExcludingVat": 81.9, + "AmountVat": null, + "AmountInvoiced": 81.9, + "SalesInvoiceNumber": "V01250043", + "IssueDate": "2025-04-04T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "7458b139-298f-5f53-aa52-0f9fbeb560b6", + "RelationNumber": "000044", + "RelationDescription": "Stukadoorsbedrijf Burgers B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "b5d6f5e1-9c7e-5e0d-8b31-01da69dc7a69", + "AmountExcludingVat": 963.92, + "AmountVat": null, + "AmountInvoiced": 963.92, + "SalesInvoiceNumber": "V01250029", + "IssueDate": "2025-03-07T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "2fdc272a-5da6-55b8-a352-928d3c1e79b6", + "RelationNumber": "000024", + "RelationDescription": "Schreurs Administratiekantoor B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "c57d4396-e6d4-59d9-a7a6-01ed068afbac", + "AmountExcludingVat": 149.65, + "AmountVat": null, + "AmountInvoiced": 149.65, + "SalesInvoiceNumber": "V01250045", + "IssueDate": "2025-04-11T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "889f3aac-684c-552e-b566-3de14d38c2c5", + "RelationNumber": "000025", + "RelationDescription": "Gebroeders Van Kooten B.V.", + "RelationType": "organisation" + }, + { + "InstanceId": "325cca0c-7a2e-5880-aea5-0215220f301c", + "AmountExcludingVat": 406.38, + "AmountVat": null, + "AmountInvoiced": 406.38, + "SalesInvoiceNumber": "V01250064", + "IssueDate": "2025-05-02T00:00:00Z", + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Status": "DONE", + "Blob": [], + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "dd74709e-1fd0-5ab1-a8ab-2a40ad645217", + "RelationNumber": "000041", + "RelationDescription": "Van Kempen Afbouw b.v.", + "RelationType": "organisation" + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.1", + "deprecated": false, + "tags": [ + "Publiek: Facturatie", + "Verkoopfactuur" + ] + } + }, + "/api/salespricesperrelation": { + "get": { + "description": "Retrieve sales prices configured per customer relation", + "summary": "salespricesperrelation 1.0", + "operationId": "getconnector-salespricesperrelation-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "ProductDescription": { + "type": "string" + }, + "PriceExcludingVAT": { + "type": "number" + }, + "StartDate": { + "type": "string", + "format": "date-time" + }, + "EndDate": { + "type": "string", + "format": "date-time" + }, + "RelationDescription": { + "type": "string" + }, + "ProductId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + } + } + } + }, + "examples": { + "example": { + "value": { + "TrackingToken": "202410211314120", + "Result": [ + { + "Id": "b4632ca6-2298-4139-8d67-2f5ca122d039", + "PriceExcludingVAT": 1512.15, + "StartDate": null, + "EndDate": null, + "ProductId": "4eb7c821-7e37-4132-b27d-95563f93687a", + "ProductDescription": "Acer Laptop", + "RelationDescription": "Architectenbureau Brauw B.V.", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "3eff9a76-45d7-4595-a372-09e1e076c540", + "InstanceId": "bcd2883b-0559-4337-aa87-9583d1860a51", + "RelationType": "organisation" + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Publiek: Facturatie", + "Verkoopfactuur" + ] + } + }, + "/api/salesrelations": { + "get": { + "description": "Retrieve sales relations and customer account information", + "summary": "salesrelations 1.0", + "operationId": "getconnector-salesrelations-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationNumber": { + "type": "string" + }, + "RelationDescription": { + "type": "string" + }, + "VatNumber": { + "type": "string" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "0bb78a38-dc5c-5a8f-9990-1f72e3a86b35", + "RelationNumber": "000014", + "RelationDescription": "EnYoi ICT Services B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "a73fa34f-528b-5e26-97af-496c2a33a607", + "RelationNumber": "000019", + "RelationDescription": "Euro Vacaturebank N.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "38a4e8ff-e844-598d-aa15-9db683b606e0", + "RelationNumber": "000033", + "RelationDescription": "Alsach Musik GmbH", + "VatNumber": "DE184475234", + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "f16d144f-fa67-5c04-9d9e-9e4c2f37d864", + "RelationNumber": "000029", + "RelationDescription": "Vlasblom Communicatie B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "a77a2b57-9164-5f2a-b54f-fb287f0e1133", + "RelationNumber": "000042", + "RelationDescription": "Tijhuis Market B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "43ff15dd-50a5-5d24-9dba-5271c80e5a8f", + "RelationNumber": "000016", + "RelationDescription": "Beentjes & Zn. Dakbedekking B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "4664e931-37ea-5520-b869-937740226db5", + "RelationNumber": "000035", + "RelationDescription": "Deventer Adviseurs B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "d8497bdd-a324-5145-afd0-a78acc7e07a8", + "RelationTypeId": "d3315773-5c05-4e91-96f3-2e21b05c5a10", + "RelationId": "adef5ea1-c4ec-557d-93a5-0ac82709ad8a", + "RelationNumber": null, + "RelationDescription": "Diverse debiteuren", + "VatNumber": null, + "RelationType": "unknown" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "872618f9-9b1a-547c-beb8-6e07e42a0815", + "RelationNumber": "000013", + "RelationDescription": "Erbi Lara B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "c512e0c5-ec1d-5b0e-9924-581cb9209337", + "RelationNumber": "000039", + "RelationDescription": "Industrial Software Ltd", + "VatNumber": "GB548321855485", + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "8983209d-a19a-5f81-bc84-66f3c52d00af", + "RelationNumber": "000024", + "RelationDescription": "Nilfisk Reisorganisatie B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "d3315773-5c05-4e91-96f3-2e21b05c5a10", + "RelationId": "adef5ea1-c4ec-557d-93a5-0ac82709ad8a", + "RelationNumber": null, + "RelationDescription": "Diverse debiteuren", + "VatNumber": null, + "RelationType": "unknown" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "67d2a9cb-5d49-5fe0-a103-2cdadd2bcc75", + "RelationNumber": "000022", + "RelationDescription": "Van Ubbens Advies B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "41186c50-138c-5bc7-bd54-8dd8a3ee3e21", + "RelationNumber": "000018", + "RelationDescription": "Hafkamp Kappers B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "2fdc272a-5da6-55b8-a352-928d3c1e79b6", + "RelationNumber": "000023", + "RelationDescription": "Schreurs Administratiekantoor B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "dd74709e-1fd0-5ab1-a8ab-2a40ad645217", + "RelationNumber": "000037", + "RelationDescription": "Van Kempen Afbouw b.v.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "63e6ad8e-5c78-586e-b35b-48d0a4566075", + "RelationNumber": "000041", + "RelationDescription": "Bus Grondstoffen B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "9fc15edd-9431-5a98-b2e1-0d90f2064527", + "RelationNumber": "000031", + "RelationDescription": "Architectenbureau Brauw B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "493b57bf-2ef7-5f92-a1dc-30e8be2dd8e7", + "RelationNumber": "000040", + "RelationDescription": "Talens Havenbedrijf B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "9fbf635d-5d9c-5f81-b879-48de533d6887", + "RelationNumber": "000043", + "RelationDescription": "Schouten Kunststofprofielen C.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "4a9442b4-1126-5688-8636-7f19ee500ee8", + "RelationNumber": "000021", + "RelationDescription": "Hesta Touringcars B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "c08e2474-976c-5c7c-94dc-eb02580009d0", + "RelationNumber": "000034", + "RelationDescription": "Administratiekantoor Beers", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "3c3c8593-8de5-5c20-bccb-3afeb9dd4a82", + "RelationNumber": "000030", + "RelationDescription": "Oostendorp-Nederland Service B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "7458b139-298f-5f53-aa52-0f9fbeb560b6", + "RelationNumber": "000032", + "RelationDescription": "Stukadoorsbedrijf Burgers B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "39a415bc-43e8-5a6a-bbf9-808f807d4575", + "RelationNumber": "000044", + "RelationDescription": "Ingenieursbureau Zwijndrecht", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "0bb78a38-dc5c-5a8f-9990-1f72e3a86b35", + "RelationNumber": "000014", + "RelationDescription": "EnYoi ICT Services B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "685136cf-ce62-5352-a341-457e99a9bc63", + "RelationNumber": "000028", + "RelationDescription": "Kuiper Marketing N.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "200dae98-c4db-5da1-b8dd-018f934bcaa0", + "RelationNumber": "000036", + "RelationDescription": "Meepo Instituut B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "889f3aac-684c-552e-b566-3de14d38c2c5", + "RelationNumber": "000026", + "RelationDescription": "Gebroeders Van Kooten B.V.", + "VatNumber": null, + "RelationType": "organisation" + }, + { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", + "RelationId": "db59b6c9-0309-5d31-b0d8-5bf3993d4ad0", + "RelationNumber": "000027", + "RelationDescription": "Notariskantoor Verhoeven B.V.", + "VatNumber": null, + "RelationType": "organisation" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels" + ] + } + }, + "/api/unknownrelation": { + "get": { + "description": "Retrieve unknown relation for invoicing without known name or address", + "summary": "unknownrelation 1.0", + "operationId": "getconnector-unknownrelation-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Name": { + "type": "string" + }, + "SalesRelation": { + "type": "boolean" + }, + "PurchaseRelation": { + "type": "boolean" + }, + "IsBlocked": { + "type": "boolean" + } + } + } + }, + "examples": { + "example response": { + "value": { + "TrackingToken": "202405021144501", + "Result": [ + { + "Id": "adef5ea1-c4ec-557d-93a5-0ac82709ad8a", + "Name": "Diverse debiteuren", + "IsBlocked": false, + "SalesRelation": true + }, + { + "Id": "2438541d-5088-5d1d-8caa-94a87cb14dc2", + "Name": "Diverse crediteuren", + "IsBlocked": false, + "PurchaseRelation": true + } + ] + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Inkoopjournaalpost", + "Publiek: Facturatie", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/vatrate": { + "get": { + "description": "Retrieve VAT rates and tax calculation settings", + "summary": "vatrate 1.0", + "operationId": "getconnector-vatrate-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "Id": "afa50000-0000-0b1e-8a4b-309cd658b570", + "Description": "Nul" + }, + { + "Id": "afa50000-0000-07cf-8b24-5ef474ab1b2a", + "Description": "Extra laag" + }, + { + "Id": "afa50000-0000-0246-9965-b18e164c600e", + "Description": "Speciaal" + }, + { + "Id": "afa50000-0000-0465-aa85-e1a761ca3a33", + "Description": "Laag" + }, + { + "Id": "afa50000-0000-0b41-9465-e9f88bcaef86", + "Description": "Hoog" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost" + ] + } + }, + "/api/vattype": { + "get": { + "description": "Retrieve VAT types and tax category classifications", + "summary": "vattype 1.0", + "operationId": "getconnector-vattype-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + } + } + } + }, + "examples": { + "example": { + "value": [ + { + "Id": "afa50000-0000-02bb-9338-0a6629f07fce", + "Description": "Verlegd" + }, + { + "Id": "afa50000-0000-0d9c-9502-4fc953f3e012", + "Description": "Vrijgesteld" + }, + { + "Id": "afa50000-0000-0b71-8790-807f97e85c54", + "Description": "Belast" + }, + { + "Id": "afa50000-0000-0a2d-9cec-bd890979929c", + "Description": "Geen btw" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost" + ] + } + }, + "/api/address": { + "post": { + "description": "Create new address information for organizations and persons", + "summary": "address 1.0", + "operationId": "updateconnector-address-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "address 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/address-1.0-Create-JsonSchema" + }, + "examples": { + "New addres for organisation": { + "value": { + "RelationType": "organisation", + "RelationId": "8afb1a9a-1613-5e2b-ab19-20c0f4f3e216", + "StreetName": "Voorthuizerstraat", + "HouseNumber": 16, + "HouseNumberAddition": "A", + "PostalZone": "3881SH", + "CityName": "Putten", + "CountryCode": "NL" + } + }, + "New addres for person": { + "value": { + "RelationType": "person", + "RelationId": "8afb1a9a-1613-5e2b-ab19-20c0f4f3e216", + "StreetName": "Voorthuizerstraat", + "HouseNumber": 16, + "HouseNumberAddition": "A", + "PostalZone": "3881SH", + "CityName": "Putten", + "CountryCode": "NL" + } + }, + "New address DE": { + "value": { + "RelationType": "organisation", + "RelationId": "8afb1a9a-1613-5e2b-ab19-20c0f4f3e216", + "StreetName": "Berliner Straße", + "HouseNumber": 10, + "HouseNumberAddition": "", + "PostalZone": "10115", + "CityName": "Berlijn", + "CountryCode": "DE" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "success": { + "value": { + "result": "Succeeded", + "instances": [ + { + "Code": "Adres", + "Id": "bea5e01e-e1a0-4b04-819a-3347ebca2ba4" + } + ], + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "instances": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Code": { + "type": "string" + }, + "Id": { + "type": "string", + "format": "uuid" + } + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Relaties" + ] + } + }, + "/api/bankaccount": { + "post": { + "description": "Create new bank account information for financial transactions", + "summary": "bankaccount 1.0", + "operationId": "updateconnector-bankaccount-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "bankaccount 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/bankaccount-1.0-Create-JsonSchema" + }, + "examples": { + "New bankaccount organisation": { + "value": { + "RelationType": "organisation", + "RelationId": "8afb1a9a-1613-5e2b-ab19-20c0f4f3e216", + "AccountNumber": "NL82BKCH0618141243", + "BIC": "BKCHNL2R", + "CountryCode": "NL", + "AccountHolderName": "Balistreri" + } + }, + "New bankaccount person": { + "value": { + "RelationType": "person", + "RelationId": "8afb1a9a-1613-5e2b-ab19-20c0f4f3e216", + "AccountNumber": "NL82BKCH0618141243", + "BIC": "BKCHNL2R", + "CountryCode": "NL", + "AccountHolderName": "Balistreri" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "Success": { + "value": { + "result": "Succeeded", + "instances": [ + { + "Code": "Bankrekening", + "Id": "4738e143-e582-4b38-a8af-9d1f1e12bfca" + } + ], + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "instances": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Code": { + "type": "string" + }, + "Id": { + "type": "string", + "format": "uuid" + } + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Relaties" + ] + } + }, + "/api/cashmutation": { + "post": { + "description": "Create cash mutations for cash register transactions", + "summary": "cashmutation 3.0", + "operationId": "updateconnector-cashmutation-Post-3.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "3.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "cashmutation 3.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/cashmutation-3.0-Create-JsonSchema" + }, + "examples": { + "Minimum cash mutuation": { + "value": { + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "Creates only a cashmutation without a reconciliation mutation.", + "Date": "2024-03-15", + "AmountIncludingVat": 400 + } + }, + "purchase": { + "value": { + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "Aanschaf kleine machines en gereedschap", + "Date": "2024-03-15", + "LedgerAccountId": "c031b2e8-f8ac-5ab2-a428-93bf9789fc5e", + "VatPercentage": 21, + "VatTarive": "high", + "AmountIncludingVat": -200 + } + }, + "sales": { + "value": { + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "Omzet algemeen", + "Date": "2024-03-15", + "LedgerAccountId": "cfb59b79-b3ec-55ef-8cde-000499c3179e", + "VatPercentage": 21, + "VatTarive": "high", + "AmountIncludingVat": 400 + } + }, + "specificcashregister": { + "value": { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Description": "Omzet algemeen", + "Date": "2025-03-15", + "LedgerAccountId": "0cc7471d-9973-5214-8106-a960bbaa348e", + "VatTarive": "high", + "CashregisterId": "25e93133-ec28-543f-9f23-312ddb4e10a3", + "AmountIncludingVat": 800 + } + }, + "with attachments": { + "value": { + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "Description": "Aanschaf kleine machines en gereedschap_387", + "Date": "2024-03-15", + "LedgerAccountId": "c031b2e8-f8ac-5ab2-a428-93bf9789fc5e", + "VatPercentage": 21, + "VatTarive": "high", + "AmountIncludingVat": -200, + "Attachments": [ + { + "AttachmentId": "bcbee6a4-f3de-44c3-91c8-e8921bf15107" + }, + { + "AttachmentId": "6676ad1f-9fc3-4a4f-8a44-d88d8284c598" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "normal response": { + "value": { + "result": "Succeeded", + "traceId": "8f266c6b-f405-4107-92ff-32130bd13a6b", + "data": { + "CashMutationId": "1bff704a-d4a1-4d92-b276-79eece12bb87", + "FinancialBookingId": "723e515f-c997-4d27-ae89-b922f3975a07" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "CashMutationId": { + "type": "string", + "format": "uuid" + }, + "FinancialBookingId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "3.0", + "deprecated": false, + "tags": [ + "Publiek: POS Transacties", + "POS Transacties" + ] + } + }, + "/api/contact": { + "post": { + "description": "Contact", + "summary": "contact 2.0", + "operationId": "updateconnector-contact-Post-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "contact 2.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/contact-2.0-Create-JsonSchema" + }, + "examples": { + "new contact": { + "value": { + "OrganisationId": "8afb1a9a-1613-5e2b-ab19-20c0f4f3e216", + "Firstname": "Rosella", + "Initials": "III", + "Prefix": "Mr.", + "Lastname": "Predovic", + "EmailAddress": "Karli61@example.com", + "PhoneNumber": "223-385-8892" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "success": { + "value": { + "result": "Succeeded", + "instances": [ + { + "Code": "Persoon", + "Id": "3375a0f0-1cf0-5408-98f9-cd3599d96721" + }, + { + "Code": "Emailadres", + "Id": "3f669df2-b5d2-41fd-bb7e-7d7030e9d8be" + }, + { + "Code": "Telefoonnummer", + "Id": "2349ac50-64eb-4d05-b440-f8372dbd850f" + }, + { + "Code": "Contactpersoon", + "Id": "ba9a935d-32ac-447d-9749-105a02079372" + } + ], + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "instances": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Code": { + "type": "string" + }, + "Id": { + "type": "string", + "format": "uuid" + } + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Relaties" + ] + } + }, + "/api/emailaddress": { + "post": { + "description": "CreateEmailAddress", + "summary": "emailaddress 2.0", + "operationId": "updateconnector-emailaddress-Post-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "emailaddress 2.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/emailaddress-2.0-Create-JsonSchema" + }, + "examples": { + "new email for organisation": { + "value": { + "RelationType": "organisation", + "RelationId": "dde06573-1190-5b31-a400-064588aa62e0", + "EmailAddress": "user@example.com" + } + }, + "new email for person": { + "value": { + "RelationType": "person", + "RelationId": "2aacc092-9c6c-5020-b1cf-0d8ecd6485dc", + "EmailAddress": "user@example.com" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "success": { + "value": { + "result": "Succeeded", + "instances": [ + { + "Code": "Emailadres", + "Id": "cb052971-6312-42cf-b3fd-de274f248a88" + } + ], + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "instances": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Code": { + "type": "string" + }, + "Id": { + "type": "string", + "format": "uuid" + } + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Relaties" + ] + } + }, + "/api/financialjournalentry": { + "post": { + "description": "Create financial journal entries for bookkeeping", + "summary": "financialjournalentry 1.0", + "operationId": "updateconnector-financialjournalentry-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "financialjournalentry 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/financialjournalentry-1.0-Create-JsonSchema" + }, + "examples": { + "new financialjournalentry periodallocation": { + "value": { + "AdministrationId": "95c0de1b-e269-4c74-ab6a-ece7fb15a4ff", + "Description": "journaalpost_001", + "EntryDate": "2024-01-22", + "EntryLine": [ + { + "Description": "Regel1", + "LedgerAccountId": "5a663714-2c36-5d94-a009-3a210bc2ce52", + "AmountDebit": 4000.65, + "VatDirection": "Sales", + "VatType": "High", + "AmountCredit": 0, + "PeriodAllocation": true, + "PeriodAllocationBeginDate": "2024-01-01", + "PeriodAllocationEndDate": "2024-12-31" + }, + { + "Description": "Regel2", + "LedgerAccountId": "5a663714-2c36-5d94-a009-3a210bc2ce52", + "AmountCredit": 4000.65, + "AmountDebit": 0 + } + ] + } + }, + "new financialjournalentry": { + "value": { + "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", + "Description": "journaalpost_002", + "EntryDate": "2024-01-22", + "EntryLine": [ + { + "Description": "Regel1", + "LedgerAccountId": "5a663714-2c36-5d94-a009-3a210bc2ce52", + "AmountDebit": 4000.65, + "VatDirection": "sales", + "VatType": "high" + }, + { + "Description": "Regel2", + "LedgerAccountId": "5a663714-2c36-5d94-a009-3a210bc2ce52", + "AmountCredit": 4000.65 + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "success": { + "value": { + "result": "Succeeded", + "traceId": "39f2f0fc-58cc-4f7b-a26b-5aa93d77ba88", + "data": { + "FinancialJournalEntryId": "6f30c816-3a77-4c2b-9484-9a09cc5edd7f" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "FinancialJournalEntryId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële journaalpost", + "Financiële journaalpost" + ] + }, + "delete": { + "description": "Delete financial journal entries from bookkeeping", + "summary": "financialjournalentry 1.0", + "operationId": "updateconnector-financialjournalentry-Delete-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "financialjournalentry 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/financialjournalentry-1.0-Delete-JsonSchema" + }, + "examples": { + "delete financialjournalentry": { + "value": { + "AdministrationId": "e877fb82-b546-4d20-94cf-05c72765fc47", + "Id": "e877fb82-b546-4d20-94cf-05c72765fc47" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "success": { + "value": { + "result": "Succeeded", + "traceId": "9b99528e-3bf0-4485-91f9-b9bba34550e0", + "data": { + "FinancialJournalEntryId": "6f30c816-3a77-4c2b-9484-9a09cc5edd7f" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "FinancialJournalEntryId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële journaalpost", + "Financiële journaalpost" + ] + } + }, + "/api/mandates": { + "post": { + "description": "Create SEPA direct debit mandates for automated payments", + "summary": "mandates 1.0", + "operationId": "updateconnector-mandates-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "mandates 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/mandates-1.0-Create-JsonSchema" + }, + "examples": { + "example": { + "value": { + "AdministrationId": "e5a3aaef-0cc7-46d0-9eb5-8d039c88109e", + "RelationType": "organisation", + "RelationId": "046800d6-8160-41a9-a422-ef3c04b8d373", + "RelationBankAccountId": "27548bd4-45ad-4652-bdd2-f1615dc28245", + "MandateReference": "Test31Con33tract3nr.FL-2322/2P", + "DateOfSignature": "2024-12-31" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "response": { + "value": { + "result": "Succeeded", + "traceId": "3511f4e3-869c-4ed6-9dde-e4a45acd8f04", + "data": { + "MandateId": "ef03c8a1-4254-498e-a819-343184ce9aad" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "MandateId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Facturatie", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/organisation": { + "post": { + "description": "Create new organization records and business relationships", + "summary": "organisation 4.0", + "operationId": "updateconnector-organisation-Post-4.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "4.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "organisation 4.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/organisation-4.0-Create-JsonSchema" + }, + "examples": { + "new organisation maximal": { + "value": { + "Name": "Nitzsche, Dickinson and Predovic", + "CocNumber": "38012622", + "VatNumber": "NL003276211B01", + "Tradename": "Johns - Swaniawski", + "EmailAddress": "Damion94@example.org", + "Website": "https://astrid.info", + "PhoneNumber": "738-407-2156", + "ExternalId": "123456789", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "inspiratielaan", + "HouseNumber": 3, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL44DNIB0736664289", + "BankId": "DNIB", + "Bic": "DNIBNL2G", + "CountryCode": "NL", + "AccountHolderName": "Jan Zandbergen", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + }, + "new organisation minimal": { + "value": { + "Name": "Larkin Inc" + } + }, + "new organisation": { + "value": { + "Name": "Terry - Powlowski", + "CocNumber": "38012622", + "VatNumber": "NL003276211B01", + "EmailAddress": "Amelie_Bogisich@example.com", + "PhoneNumber": "738-407-2156", + "ExternalId": "801-331-6473", + "Addresses": [ + { + "StreetName": "Tillman Glen", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL" + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "minimum": { + "value": { + "result": "Succeeded", + "data": { + "RelationId": "9ef691ac-b12c-4e14-9368-8191e03b54c0", + "Addresses": [ + { + "AddressId": "a329ffce-7e6c-4e79-acb4-43ac57157dc9", + "AddressDescription": "inspiratielaan 2 3833AV Leusden Nederland" + } + ], + "BankAccounts": [ + { + "AccountNumberId": "4395b94c-af56-429b-ab52-52bdc9986fb4", + "AccountNumber": "NL68INGB0801705542" + } + ] + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "data": { + "type": "object", + "properties": { + "RelationId": { + "type": "string", + "format": "uuid" + }, + "Addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AddressId": { + "type": "string", + "format": "uuid" + }, + "AddressDescription": { + "type": "string" + } + } + } + }, + "BankAccounts": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AccountNumberId": { + "type": "string", + "format": "uuid" + }, + "AccountNumber": { + "type": "string" + } + } + } + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "4.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Inkoopjournaalpost", + "Relaties", + "Publiek: Externe facturatie" + ] + }, + "put": { + "description": "Update existing organization records and business relationships", + "summary": "organisation 4.0", + "operationId": "updateconnector-organisation-Put-4.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "4.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "organisation 4.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/organisation-4.0-Update-JsonSchema" + }, + "examples": { + "update organisation": { + "value": { + "RelationId": "978638a5-394f-4ecc-a31f-21332f9f79e5", + "Name": "AFAS Software", + "CocNumber": "54041813", + "ExternalId": "SWR23244", + "Tradename": "AFAS Software BV", + "EmailAddress": "info@afas.NL", + "WebSite": "www.afas.nl", + "phoneNumber": "+31334341800", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 5, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "preferredSupplierAddress": true, + "preferredShippingAddress": false, + "preferredBillingAddress": true + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "response": { + "value": { + "result": "Succeeded", + "traceId": "d8b6d497-cd52-46b1-a4c3-78dd7f9fb957", + "data": { + "RelationId": "978638a5-394f-4ecc-a31f-21332f9f79e5" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "RelationId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "4.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Inkoopjournaalpost", + "Relaties", + "Publiek: Externe facturatie" + ] + } + }, + "/api/payrolljournalentry": { + "post": { + "description": "Create payroll journal entries for salary processing", + "summary": "payrolljournalentry 1.0", + "operationId": "updateconnector-payrolljournalentry-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "payrolljournalentry 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/payrolljournalentry-1.0-Create-JsonSchema" + }, + "examples": { + "Loonjournaalpost": { + "value": { + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "Description": "Loonjournaalpost_001", + "Date": "2024-01-22", + "PayrollJournalEntryLine": [ + { + "LedgerAccountNumber": "1700", + "AmountDebit": 4000 + }, + { + "LedgerAccountNumber": "1710", + "AmountCredit": 1300 + }, + { + "LedgerAccountNumber": "2300", + "AmountCredit": 2700 + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "Success": { + "value": { + "result": "Succeeded", + "instances": [ + { + "Code": "Memoriaalboeking2", + "Id": "a70c4e79-a04f-57cf-875b-150434c56e17" + } + ], + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "instances": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Code": { + "type": "string" + }, + "Id": { + "type": "string", + "format": "uuid" + } + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Loonjournaalpost" + ] + } + }, + "/api/person": { + "post": { + "description": "Create new person records and personal relationships", + "summary": "person 4.0", + "operationId": "updateconnector-person-Post-4.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "4.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "person 4.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/person-4.0-Create-JsonSchema" + }, + "examples": { + "create person with 2 addresses and 2 backaccounts": { + "value": { + "Firstname": "John", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Doe", + "Emailaddress": "johndoe@gmail.com", + "Phonenumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": false + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": true + } + ] + } + }, + "create person with address and bankaccount": { + "value": { + "Firstname": "Julianne", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Pouros", + "Emailaddress": "Alyce58@gmail.com", + "Phonenumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Krommeweg", + "HouseNumber": 18, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "8071TE", + "CityName": "Nunspeet", + "CountryCode": "NL", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": true, + "PreferredBillingAddress": true + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + } + ] + } + }, + "create person": { + "value": { + "Firstname": "John", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Doe", + "Emailaddress": "johndoe@gmail.com", + "Phonenumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": false + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": true + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "minimum": { + "value": { + "result": "Succeeded", + "data": { + "RelationId": "9ef691ac-b12c-4e14-9368-8191e03b54c0", + "Addresses": [ + { + "AddressId": "a329ffce-7e6c-4e79-acb4-43ac57157dc9", + "AddressDescription": "inspiratielaan 2 3833AV Leusden Nederland" + } + ], + "BankAccounts": [ + { + "AccountNumberId": "4395b94c-af56-429b-ab52-52bdc9986fb4", + "AccountNumber": "NL68INGB0801705542" + } + ] + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "data": { + "type": "object", + "properties": { + "RelationId": { + "type": "string", + "format": "uuid" + }, + "Addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AddressId": { + "type": "string", + "format": "uuid" + }, + "AddressDescription": { + "type": "string" + } + } + } + }, + "BankAccounts": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AccountNumberId": { + "type": "string", + "format": "uuid" + }, + "AccountNumber": { + "type": "string" + } + } + } + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "4.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Inkoopjournaalpost", + "Relaties", + "Publiek: Externe facturatie" + ] + }, + "put": { + "description": "Update existing person records and personal relationships", + "summary": "person 4.0", + "operationId": "updateconnector-person-Put-4.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "4.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "person 4.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/person-4.0-Update-JsonSchema" + }, + "examples": { + "update person": { + "value": { + "RelationId": "69a7cab4-3a34-4fdf-8017-c6df8a9375df", + "FirstName": "John", + "LastName": "Doe", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 5, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "preferredSupplierAddress": true, + "preferredShippingAddress": true, + "preferredBillingAddress": true + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "response": { + "value": { + "result": "Succeeded", + "traceId": "f0dddf19-12a8-4bf2-b782-359d32679491", + "data": { + "RelationId": "7b97c9cc-d0ef-48bf-a896-657dfb494059" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "RelationId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "4.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Inkoopjournaalpost", + "Relaties", + "Publiek: Externe facturatie" + ] + } + }, + "/api/phonenumber": { + "post": { + "description": "CreatePhoneNumber", + "summary": "phonenumber 1.0", + "operationId": "updateconnector-phonenumber-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "phonenumber 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/phonenumber-1.0-Create-JsonSchema" + }, + "examples": { + "Nieuw telefoonnummer voor organisatie": { + "value": { + "RelationType": "organisation", + "RelationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "PhoneNumber": "033546786" + } + }, + "Nieuw telefoonnummer voor persoon": { + "value": { + "RelationType": "person", + "RelationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "PhoneNumber": "033546786" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "response": { + "value": { + "result": "Succeeded", + "instances": [ + { + "Code": "Telefoonnummer", + "Id": "0127112f-48ed-4e09-b981-914913cc1807" + } + ], + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "instances": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Code": { + "type": "string" + }, + "Id": { + "type": "string", + "format": "uuid" + } + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Relaties" + ] + } + }, + "/api/purchasejournalentry": { + "post": { + "description": "Create purchase journal entries for supplier transactions (C# script version)", + "summary": "purchasejournalentry 2.0", + "operationId": "updateconnector-purchasejournalentry-Post-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "purchasejournalentry 2.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/purchasejournalentry-2.0-Create-JsonSchema" + }, + "examples": { + "Inkoopjournaalpost": { + "value": { + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "InvoiceNumber": "3gKm5gtrBcjWHNY3dwwjyza4AZYAyBW", + "RelationType": "organisation", + "RelationId": "863d895a-3782-5500-b933-dd487d736138", + "InvoiceDate": "2024-01-22", + "DueDate": "2024-02-28", + "PaymentMethod": "creditcard", + "Attachments": [ + { + "AttachmentId": "039e63a5-5761-4a6e-a58b-d0fcda003e0c" + } + ], + "InvoiceLine": [ + { + "Description": "Inkopen btw hoog", + "LedgerAccountId": "55eeb0a9-25d0-5c60-830b-07f515fc0c0c", + "VatType": "high", + "AmountExcludingVat": 22, + "AmountVat": 4.62 + }, + { + "Description": "Inkopen btw laag", + "LedgerAccountId": "22edee70-753a-5f8c-a613-39fe661fffbe", + "VatType": "low", + "AmountExcludingVat": 100, + "AmountVat": 9 + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "response": { + "value": { + "result": "Succeeded", + "traceId": "90666ba6-6211-4582-9a19-0c0429c84b4e", + "data": { + "PurchaseJournalEntryId": "a29631fe-cc81-40ba-bc6c-b813be75423c", + "PurchaseInternalInvoiceNumber": "IF250002" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "PurchaseJournalEntryId": { + "type": "string", + "format": "uuid" + }, + "PurchaseInternalInvoiceNumber": { + "type": "string" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost" + ] + } + }, + "/api/salesinvoice": { + "post": { + "description": "Create sales invoices for customer billing", + "summary": "salesinvoice 2.0", + "operationId": "updateconnector-salesinvoice-Post-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "salesinvoice 2.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/salesinvoice-2.0-Create-JsonSchema" + }, + "examples": { + "example": { + "value": { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "IssueDate": "2025-05-16", + "RelationType": "organisation", + "SentInvoiceEmail": false, + "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "PaymentMethod": "banktransfer", + "InvoiceLine": [ + { + "ItemId": "5dbb40d7-52b5-51b6-809e-5a16dddeb650", + "Quantity": 2 + } + ] + } + }, + "exampleAlternativeAllocation copy": { + "value": { + "AdministrationId": "3f73bc84-fb32-4d1d-83d9-5de1af8245b1", + "IssueDate": "2024-05-16", + "RelationType": "organisation", + "SentInvoiceEmail": false, + "ToBeInvoiced": true, + "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "InvoiceLine": [ + { + "ItemId": "7e94bf59-594c-5c28-9fe5-5e238f821b0d", + "Price": 10, + "Quantity": 2, + "AlternativeAllocationDate": "2024-12-31" + } + ] + } + }, + "exampleToBeInvoiced": { + "value": { + "AdministrationId": "3f73bc84-fb32-4d1d-83d9-5de1af8245b1", + "IssueDate": "2024-05-16", + "RelationType": "organisation", + "SentInvoiceEmail": false, + "ToBeInvoiced": true, + "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "InvoiceLine": [ + { + "ItemId": "7e94bf59-594c-5c28-9fe5-5e238f821b0d", + "Quantity": 2 + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "Example": { + "value": { + "result": "Succeeded", + "traceId": "8ede5c56-1e84-4134-b243-007e8bac57cc", + "data": { + "SalesInvoiceId": "61296199-a131-4b4e-9511-54a599ae8541" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "SalesInvoiceId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Publiek: Facturatie", + "Verkoopfactuur" + ] + }, + "delete": { + "description": "Delete sales invoices from customer billing", + "summary": "salesinvoice 2.0", + "operationId": "updateconnector-salesinvoice-Delete-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "salesinvoice 2.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/salesinvoice-2.0-Delete-JsonSchema" + }, + "examples": { + "example": { + "value": { + "AdministrationId": "bb837613-26e7-52bd-bc56-f3721b90a42e", + "Id": "c7e0773e-7904-41b7-a09e-56643261b6f4" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "Example": { + "value": { + "result": "Succeeded", + "traceId": "e491eb78-6969-45c2-ba20-f94d68364427", + "data": { + "salesinvoiceId": "c7e0773e-7904-41b7-a09e-56643261b6f4" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "salesinvoiceId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + }, + "400": { + "content": { + "application/json": { + "examples": { + "ExampleAlreadySend": { + "value": { + "result": "Failed", + "traceId": "93a3cfbe-f20b-4fd2-9ec3-5cdd930eebc7", + "instances": [], + "errors": [ + "SalesInvoice cannot be deleted because it is not a draft or it is already deleted" + ] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "instances": { + "type": "array", + "items": {} + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Publiek: Facturatie", + "Verkoopfactuur" + ] + } + }, + "/api/salesjournalentry": { + "post": { + "description": "Create sales journal entries for customer transactions", + "summary": "salesjournalentry 2.1", + "operationId": "updateconnector-salesjournalentry-Post-2.1", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.1" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "salesjournalentry 2.1", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/salesjournalentry-2.1-Create-JsonSchema" + }, + "examples": { + "BTW binnen en buiten EU": { + "value": { + "InvoiceNumber": "a", + "InvoiceDate": "2024-01-30", + "Description": "Unbranded Fresh Pizza", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "organisation", + "RelationId": "c6f3b724-845c-5af2-8360-2fc751601115", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "9b5d768a-c71b-583e-b6ee-09d64aa935d4", + "InvoiceLine": [ + { + "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", + "VatType": "zero", + "AmountExcludingVat": 100 + }, + { + "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", + "VatType": "zero", + "AmountExcludingVat": 211 + } + ] + } + }, + "BTW Verlegd binnen Nederland": { + "value": { + "InvoiceNumber": "d", + "InvoiceDate": "2024-01-30", + "Description": "Practical Plastic Chips", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "organisation", + "RelationId": "c6f3b724-845c-5af2-8360-2fc751601115", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "9b5d768a-c71b-583e-b6ee-09d64aa935d4", + "InvoiceLine": [ + { + "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", + "VatType": "high", + "VatCalculation": "reversecharged", + "AmountExcludingVat": 100 + }, + { + "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", + "VatType": "high", + "VatCalculation": "reversecharged", + "AmountExcludingVat": 396 + } + ] + } + }, + "Sales with attachment": { + "value": { + "InvoiceNumber": "1", + "InvoiceDate": "2024-02-01", + "Description": "Ergonomic Rubber Bacon", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "organisation", + "RelationId": "a8cce7bd-ced8-5ca4-b3b8-f0584ffe5993", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "9b5d768a-c71b-583e-b6ee-09d64aa935d4", + "Attachments": [ + { + "AttachmentId": "b031446a-b98e-4378-b7ee-8543e05f34c0" + } + ], + "InvoiceLine": [ + { + "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", + "AmountVat": 21, + "VatType": "high", + "AmountExcludingVat": 100 + }, + { + "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", + "AmountExcludingVat": 427, + "VatType": "zero", + "VatCalculation": "exempt" + } + ] + } + }, + "verkoop 1 regel": { + "value": { + "InvoiceNumber": "7", + "InvoiceDate": "2024-01-24", + "Description": "Unbranded Steel Sausages", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "organisation", + "RelationId": "9bafbc7a-611b-5465-a584-5f0c88734b35", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "eb44c60d-06e4-564b-a90c-7715c78788a5", + "InvoiceLine": [ + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 183.54, + "VatType": "high", + "AmountExcludingVat": 874 + } + ] + } + }, + "verkoop aan persoon": { + "value": { + "InvoiceNumber": "SAL341434345403", + "InvoiceDate": "2024-01-24", + "Description": "null", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "person", + "RelationId": "d36cb9bb-0e5f-5253-ab28-2331804d65ba", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "eb44c60d-06e4-564b-a90c-7715c78788a5", + "InvoiceLine": [ + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 21, + "VatType": "high", + "AmountExcludingVat": 100 + }, + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 450.55, + "VatType": "low", + "AmountExcludingVat": 40.55, + "VatCalculation": "exempt" + } + ] + } + }, + "verkoop alle soorten btw": { + "value": { + "InvoiceNumber": "d", + "InvoiceDate": "2024-01-23", + "Description": "Sleek Metal Tuna", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "organisation", + "RelationId": "9bafbc7a-611b-5465-a584-5f0c88734b35", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "eb44c60d-06e4-564b-a90c-7715c78788a5", + "InvoiceLine": [ + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 21, + "VatType": "high", + "AmountExcludingVat": 100 + }, + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 40.55, + "VatType": "low", + "AmountExcludingVat": 40.55, + "VatCalculation": "exempt" + }, + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 0, + "VatType": "zero", + "AmountExcludingVat": 40.55 + }, + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 18, + "VatType": "low", + "AmountExcludingVat": 200 + }, + { + "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", + "AmountVat": 18, + "VatType": "high", + "AmountExcludingVat": 200, + "VatCalculation": "reversecharged" + } + ] + } + }, + "verkoop meerdere btw soorten": { + "value": { + "InvoiceNumber": "t", + "InvoiceDate": "2024-01-23", + "Description": "Handmade Concrete Car", + "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", + "RelationType": "organisation", + "RelationId": "863d895a-3782-5500-b933-dd487d736138", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "b98e24e9-a611-5a98-8cf9-40fed321dc6c", + "InvoiceLine": [ + { + "LedgerAccountId": "de3184b9-23f0-55e6-9bd0-ccb5c2b5b5ce", + "AmountVat": 21, + "VatType": "high", + "AmountExcludingVat": 100 + }, + { + "LedgerAccountId": "de3184b9-23f0-55e6-9bd0-ccb5c2b5b5ce", + "AmountVat": 40.55, + "VatType": "low", + "AmountExcludingVat": 40.55, + "VatCalculation": "exempt" + }, + { + "LedgerAccountId": "de3184b9-23f0-55e6-9bd0-ccb5c2b5b5ce", + "AmountVat": 0, + "VatType": "zero", + "AmountExcludingVat": 40.55 + }, + { + "LedgerAccountId": "de3184b9-23f0-55e6-9bd0-ccb5c2b5b5ce", + "AmountVat": 18, + "VatType": "low", + "AmountExcludingVat": 200 + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "success": { + "value": { + "result": "Succeeded", + "traceId": "ab84df36-19aa-477c-9f71-c0c61cb542a1", + "data": { + "SalesJournalEntryId": "2fe9d143-52aa-4d9f-9eba-a97656f2741c" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "SalesJournalEntryId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + }, + "400": { + "content": { + "application/json": { + "examples": { + "already exists": { + "value": { + "result": "Failed", + "traceId": "3ca43e3a-00b6-460d-8bf1-be2f391f3f4c", + "instances": [], + "errors": [ + "SalesJournalEntry with invoicenumber SB_API_2204202410006 already exists" + ] + } + }, + "error on date": { + "value": { + "result": "Failed", + "traceId": "57f10a49-6720-4bb8-8826-8ef92387560f", + "instances": [], + "errors": [ + "Entity is made with one or more errors. Please correct this error in application or delete SalesJournalEntry with id: b32ee6e1-f807-4644-a6d5-d785d8bd7c61", + "De factuurdatum ligt vóór de beginbalansdatum. Dit is niet toegestaan." + ] + } + }, + "error on line": { + "value": { + "result": "Failed", + "traceId": "010e0485-1e22-4f1a-8573-405090824d35", + "instances": [], + "errors": [ + "Entity is made with one or more errors in the lines. Please correct this error in application or delete SalesJournalEntry with id: eee53305-8851-4859-a53e-b4b18f14040e.", + "Field 'Grootboekrekening' contains an invalid reference (a18e0f9a-c73d-58c4-ae80-64c2e4228de4)", + "Field 'Grootboekrekening' contains an invalid reference (a18e0f9a-c73d-58c4-ae80-64c2e4228de4)" + ] + } + }, + "error": { + "value": { + "result": "Failed", + "traceId": "e193dbe5-8f65-4035-aa81-879bd9828f98", + "instances": [], + "errors": [ + "FeatureToggle not enabled" + ] + } + } + }, + "schema": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "type": "string" + } + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "result": { + "type": "string" + }, + "instances": { + "type": "array", + "items": {} + } + } + } + } + } + } + }, + "version": "2.1", + "deprecated": false, + "tags": [ + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + }, + "delete": { + "description": "Delete sales journal entries from customer transactions", + "summary": "salesjournalentry 2.1", + "operationId": "updateconnector-salesjournalentry-Delete-2.1", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.1" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "salesjournalentry 2.1", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/salesjournalentry-2.1-Delete-JsonSchema" + }, + "examples": { + "example": { + "value": { + "AdministrationId": "a15620b1-90bf-46d8-a155-15f59a3ed460", + "Id": "8f8d5e92-bd85-4deb-8184-6abf57a5b24d" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "success": { + "value": { + "result": "Succeeded", + "traceId": "ab84df36-19aa-477c-9f71-c0c61cb542a1", + "data": { + "SalesJournalEntryId": "2fe9d143-52aa-4d9f-9eba-a97656f2741c" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string", + "format": "uuid" + }, + "data": { + "type": "object", + "properties": { + "SalesJournalEntryId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.1", + "deprecated": false, + "tags": [ + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + }, + "put": { + "description": "Update sales journal entries for customer transactions", + "summary": "salesjournalentry 2.1", + "operationId": "updateconnector-salesjournalentry-Put-2.1", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.1" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "salesjournalentry 2.1", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/salesjournalentry-2.1-Update-JsonSchema" + }, + "examples": { + "PaymentReference": { + "value": { + "AdministrationId": "f49f54a4-835d-532f-a117-79054e726808", + "Id": "2857a5b4-777d-44cd-b10d-9721c0281d7d", + "PaymentReference": "2024-10124" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "success": { + "value": { + "result": "Succeeded", + "data": { + "SalesJournalEntryId": "f365059e-5918-49ec-9a7c-d4f0a0c8beb4" + }, + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "data": { + "type": "object", + "properties": { + "SalesJournalEntryId": { + "type": "string", + "format": "uuid" + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.1", + "deprecated": false, + "tags": [ + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/supplier": { + "post": { + "description": "Create new supplier relationships and vendor setup", + "summary": "supplier 1.0", + "operationId": "updateconnector-supplier-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "supplier 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/supplier-1.0-Create-JsonSchema" + }, + "examples": { + "New supplier organisation": { + "value": { + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "EmailAddress": "klant@afas.nl", + "PhoneNumber": "0696856831", + "BankAccountNumber": "NL29TRIO0110845005", + "Bic": "TRIONL2U", + "LedgerAccountId": "4a2014b0-dcdc-500d-add2-fcf73ac8f88d", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "ee64c81b-56ff-506f-9dac-855d64bf193a", + "Organisation": { + "Name": "Jansen Haarden", + "CompanyIdCoc": "80446353", + "CompanyIdVat": "NL861674881B01", + "TradeName": "Jansen Holding B.V." + } + } + }, + "New supplier person": { + "value": { + "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", + "EmailAddress": "Delfina2@example.net", + "PhoneNumber": "30-702-386-4989", + "BankAccountNumber": "NL29TRIO0110845005", + "Bic": "TRIONL2U", + "Person": { + "Firstname": "Lacy", + "Initials": "MD", + "Prefix": "Ms.", + "Lastname": "Harber" + }, + "PaymentMethod": "null", + "LedgerAccountId": "cfb59b79-b3ec-55ef-8cde-000499c3179e", + "PaymentCondition": "b98e24e9-a611-5a98-8cf9-40fed321dc6c", + "VatCalculation": "null" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "success": { + "value": { + "result": "Succeeded", + "instances": [ + { + "Code": "Persoon", + "Id": "e55f5d3b-780b-576b-9370-760b58e937ec" + }, + { + "Code": "Instelling", + "Id": "20eb199e-c652-5513-b7eb-c39f927d1ef3" + }, + { + "Code": "Leverancier", + "Id": "20eb199e-c652-5513-b7eb-c39f927d1ef3" + }, + { + "Code": "Begunstigde", + "Id": "7afec8a8-c9f4-4ec7-aa68-8d9bc995468d" + }, + { + "Code": "Emailadres", + "Id": "4fc10096-8bb4-4be8-8039-5239b4125757" + }, + { + "Code": "Telefoonnummer", + "Id": "5e553026-0ad2-4f4c-bd2e-5dbdd6c0096f" + }, + { + "Code": "Bankrekening", + "Id": "d18e1122-e014-4468-aa65-585b333359c1" + } + ], + "errors": [] + } + } + }, + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + }, + "instances": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Code": { + "type": "string" + }, + "Id": { + "type": "string", + "format": "uuid" + } + } + } + }, + "errors": { + "type": "array", + "items": {} + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost" + ] + } + } + }, + "tags": [ + { + "name": "Autorisatie", + "description": "Endpoints voor autorisatie" + }, + { + "name": "Bijlagen", + "description": "Endpoints voor bijlagen" + }, + { + "name": "Publiek: Admin center data", + "description": "Admin center data connectoren" + }, + { + "name": "Crediteuren", + "description": "Crediteuren connectoren" + }, + { + "name": "Debiteuren", + "description": "Debiteuren connectoren" + }, + { + "name": "Publiek: Financiële dashboarding", + "description": "Financiële dashboarding voor publieke api" + }, + { + "name": "Publiek: Financiële journaalpost", + "description": "Financiële journaalpost voor publieke api" + }, + { + "name": "Financiële journaalpost", + "description": "Financiële journaalpost connectors" + }, + { + "name": "Publiek: Financiële rapportage", + "description": "Financiële rapportage voor publieke api" + }, + { + "name": "Financiele rapportage", + "description": "Financiele rapportage connectoren" + }, + { + "name": "Publiek: Externe verkoopregels", + "description": "Verkoopregels voor publieke api" + }, + { + "name": "Verkoopregels", + "description": "Verkoopregels connectors" + }, + { + "name": "Loonjournaalpost", + "description": "Loonjournaalpost connectors" + }, + { + "name": "Publiek: POS Transacties", + "description": "POS transacties voor publieke api" + }, + { + "name": "POS Transacties", + "description": "POS transacties" + }, + { + "name": "Inkoopjournaalpost", + "description": "Inkoopjournaalpost connectors" + }, + { + "name": "Publiek: Relatiemanagement", + "description": "Relatiemanagement voor publieke api" + }, + { + "name": "Relaties", + "description": "Relatie connectors" + }, + { + "name": "Publiek: Facturatie", + "description": "Facturatie voor publieke api" + }, + { + "name": "Verkoopfactuur", + "description": "Verkoopfactuur connectors" + }, + { + "name": "Publiek: Externe facturatie", + "description": "Externe facturatie voor publieke api" + }, + { + "name": "Verkoopjournaalpost", + "description": "Verkoopjournaalpost connectors" + }, + { + "name": "TechnischeInfo", + "description": "Technische informatie" + } + ], + "components": { + "securitySchemes": { + "oAuth2": { + "type": "oauth2", + "flows": { + "authorizationCode": { + "authorizationUrl": "https://{{domain}}.afasfocus.nl/{{customerenvironment}}/app/auth", + "tokenUrl": "https://{{domain}}.afasfocus.nl/{{customerenvironment}}/app/token", + "scopes": {} + } + } + } + }, + "requestBodies": { + "address-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "description": "Use this endpoint to create a new address for a person or organisation.", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "RelationType": { + "type": "string", + "description": "Must contain one of the enums. Will be required in a future version.", + "enum": [ + "organisation", + "person" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation or person. Will be required in a future version.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + } + }, + "examples": [ + { + "RelationType": "organisation", + "RelationId": "c8a288c1-3dbb-483d-840d-9cc601368a92", + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "a", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL" + } + ] + }, + "bankaccount-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "description": "Use this endpoint to create a new bankaccount data for a person or organisation.", + "required": [ + "AccountNumber", + "AccountHolderName", + "CountryCode", + "RelationType", + "RelationId" + ], + "properties": { + "RelationType": { + "type": "string", + "description": "Must contain one of the enums. Will be required in a future version.", + "enum": [ + "organisation", + "person" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation or person. Will be required in a future version.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL01RABO0123456789" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "RABO" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "RABONL2U" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "DE" + ] + }, + "AccountHolderName": { + "type": "string", + "default": "", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen" + ] + } + }, + "examples": [ + { + "RelationType": "organisation", + "RelationId": "c8a288c1-3dbb-483d-840d-9cc601368a92", + "AccountNumber": "NL01RABO0123456789", + "BankId": "RABO", + "Bic": "RABONL2U", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen" + } + ] + }, + "cashmutation-1.0-Create-JsonSchema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "description": "This endpoint allows you to add cash mutations directly from Point of Sale (POS) applications to the accounting software, streamlining the process of recording and managing cash transactions for businesses. For each cashmutation an request must be done.", + "properties": { + "administrationId": { + "type": "string", + "format": "uuid", + "description": "The Administration ID uniquely identifying an administration. Retrieve it from the endpoint: api/administration" + }, + "description": { + "type": "string", + "description": "The description providing information about the cash mutation and other bookings" + }, + "date": { + "type": "string", + "format": "date", + "description": "The date when the cash mutation and other bookings occurred" + }, + "ledgerAccountId": { + "type": "string", + "format": "uuid", + "description": "The Ledger Account ID uniquely identifying a ledger account. Retrieve it from the endpoint: api/ledgeraccounts" + }, + "amountIncludingVat": { + "type": "number", + "multipleOf": 0.01, + "description": "The amount including VAT for the cash mutation and other bookings" + }, + "vatPercentage": { + "type": "integer", + "description": "The percentage of VAT applied to the cash mutation and other bookings" + }, + "vatTarive": { + "type": "string", + "enum": [ + "high", + "low", + "zero" + ], + "description": "The VAT tarive/category - 'high', 'low', or 'zero'" + }, + "vatType": { + "type": "string", + "enum": [ + "purchase", + "sales" + ], + "description": "The type of VAT operation - 'purchase' or 'sales'" + }, + "attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "required": [ + "attachmentId" + ], + "properties": { + "attachmentId": { + "type": "string", + "format": "uuid" + } + } + } + } + }, + "required": [ + "administrationId", + "description", + "date", + "amountIncludingVat" + ] + }, + "cashmutation-2.0-Create-JsonSchema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "description": "This endpoint allows you to add cash mutations directly from Point of Sale (POS) applications to the accounting software, streamlining the process of recording and managing cash transactions for businesses. For each cashmutation an request must be done.", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "The Administration ID uniquely identifying an administration. Retrieve it from the endpoint: api/administration" + }, + "Description": { + "type": "string", + "description": "The description providing information about the cash mutation and other bookings" + }, + "Date": { + "type": "string", + "format": "date", + "description": "The date when the cash mutation and other bookings occurred" + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "The Ledger Account ID uniquely identifying a ledger account. Retrieve it from the endpoint: api/ledgeraccounts" + }, + "AmountIncludingVat": { + "type": "number", + "multipleOf": 0.01, + "description": "The amount including VAT for the cash mutation and other bookings" + }, + "VatPercentage": { + "type": "integer", + "description": "The percentage of VAT applied to the cash mutation and other bookings" + }, + "VatTarive": { + "type": "string", + "enum": [ + "high", + "low", + "zero" + ], + "description": "The VAT tarive/category - 'high', 'low', or 'zero'" + }, + "VatType": { + "type": "string", + "enum": [ + "purchase", + "sales" + ], + "description": "The type of VAT operation - 'purchase' or 'sales'" + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid" + } + } + } + } + }, + "required": [ + "AdministrationId", + "Description", + "Date", + "AmountIncludingVat" + ] + }, + "cashmutation-3.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "This endpoint allows you to add cash mutations directly from Point of Sale (POS) applications to the accounting software, streamlining the process of recording and managing cash transactions for businesses. For each cashmutation an request must be done. Only the default cash location is supported.", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "The Administration ID uniquely identifying an administration. Retrieve it from the endpoint: api/administrations" + }, + "CashRegisterId": { + "type": "string", + "format": "uuid", + "description": "The CashRegister ID uniquely identifying an cash register. Retrieve it from the endpoint: api/cashregisters. Falls back to default when empty." + }, + "Description": { + "type": "string", + "description": "The description providing information about the cash mutation and other bookings" + }, + "Date": { + "type": "string", + "format": "date", + "description": "The date when the cash mutation and other bookings occurred" + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "The Ledger Account ID uniquely identifying a ledger account. Retrieve it from the endpoint: api/ledgeraccounts" + }, + "AmountIncludingVat": { + "type": "number", + "multipleOf": 0.01, + "description": "The amount including VAT for the cash mutation and other bookings" + }, + "VatTarive": { + "type": "string", + "enum": [ + "high", + "low", + "zero" + ], + "description": "The VAT tarive/category - 'high', 'low', or 'zero'" + }, + "VatType": { + "type": "string", + "enum": [ + "purchase", + "sales" + ], + "description": "The type of VAT operation - 'purchase' or 'sales'" + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid" + } + } + } + } + }, + "required": [ + "AdministrationId", + "Description", + "Date", + "AmountIncludingVat" + ] + }, + "contact-1.0-Create-JsonSchema": { + "type": "object", + "description": "Create a contact by organisation.", + "required": [ + "OrganisationId", + "Lastname" + ], + "properties": { + "OrganisationId": { + "type": "string", + "format": "uuid", + "examples": [ + "c3bf8c80-08ed-44ea-a842-661a9085d6bf" + ] + }, + "ContactId": { + "type": "string", + "format": "uuid", + "examples": [ + "880ed307-af2e-447d-8440-e26fed53ecc5" + ] + }, + "Firstname": { + "type": "string", + "examples": [ + "Maarten" + ] + }, + "Initials": { + "type": "string", + "examples": [ + "M.H." + ] + }, + "Prefix": { + "type": "string", + "examples": [ + "van" + ] + }, + "Lastname": { + "type": "string", + "examples": [ + "Zandbergen" + ] + }, + "emailaddress": { + "type": "string", + "format": "email", + "examples": [ + "Maarten@vanZandbergen.nl" + ] + }, + "phonenumber": { + "type": "string", + "examples": [ + "+31655887744" + ] + } + }, + "examples": [ + { + "OrganisationId": "c3bf8c80-08ed-44ea-a842-661a9085d6bf", + "Firstname": "Maarten", + "Initials": "M.H.", + "Prefix": "van", + "Lastname": "Zandbergen", + "emailaddress": "Maarten@vanZandbergen.nl", + "phonenumber": "+31655887744" + } + ] + }, + "contact-2.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a contact by organisation.", + "required": [ + "OrganisationId", + "LastName" + ], + "properties": { + "OrganisationId": { + "type": "string", + "format": "uuid", + "examples": [ + "c3bf8c80-08ed-44ea-a842-661a9085d6bf" + ] + }, + "ContactId": { + "type": "string", + "format": "uuid", + "examples": [ + "880ed307-af2e-447d-8440-e26fed53ecc5" + ] + }, + "FirstName": { + "type": "string", + "examples": [ + "Maarten" + ] + }, + "Initials": { + "type": "string", + "examples": [ + "M.H." + ] + }, + "Prefix": { + "type": "string", + "examples": [ + "van" + ] + }, + "LastName": { + "type": "string", + "examples": [ + "Zandbergen" + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "examples": [ + "Maarten@vanZandbergen.nl" + ] + }, + "PhoneNumber": { + "type": "string", + "examples": [ + "+31655887744" + ] + } + }, + "examples": [ + { + "OrganisationId": "c3bf8c80-08ed-44ea-a842-661a9085d6bf", + "FirstName": "Maarten", + "Initials": "M.H.", + "Prefix": "van", + "LastName": "Zandbergen", + "EmailAddress": "Maarten@vanZandbergen.nl", + "PhoneNumber": "+31655887744" + } + ] + }, + "emailaddress-1.0-Create-JsonSchema": { + "type": "object", + "x-examples": { + "Example 1": { + "OrganisationId": "8f03496b-1f42-5ac3-a770-91f9da4e6e12", + "EmailAddress": "j.zandbergen@afasSbPlus.nl" + } + }, + "title": "EmailAddress", + "examples": [ + { + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "EmailAddress": "user@example.com" + } + ], + "properties": { + "OrganisationId": { + "type": "string", + "format": "uuid", + "example": "32abaca0-b4c6-4dce-af80-9de42a830e62" + }, + "EmailAddress": { + "type": "string", + "format": "email" + } + }, + "required": [ + "EmailAddress", + "OrganisationId" + ], + "description": "Create an emailaddress for an organisation." + }, + "emailaddress-2.0-Create-JsonSchema": { + "type": "object", + "x-examples": { + "Organiation": { + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "EmailAddress": "user@example.com" + }, + "Person": { + "RelationType": "person", + "RelationId": "963578e8-7831-4aa4-83c4-e7c3262f0572", + "EmailAddress": "user@example.com" + } + }, + "title": "EmailAddress", + "properties": { + "RelationType": { + "type": "string", + "description": "Must contain one of the enums. Will be required in a future version.", + "enum": [ + "organisation", + "person" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation or person. Will be required in a future version.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "EmailAddress": { + "type": "string", + "format": "email" + } + }, + "required": [ + "EmailAddress", + "RelationType", + "RelationId" + ], + "description": "Create an emailaddress for an organisation or person." + }, + "financialjournalentry-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a financial journal entry.", + "required": [ + "AdministrationId", + "EntryDate", + "Description", + "EntryLine" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "EntryDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-10-12" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntry.", + "examples": [ + "Example Journal 001" + ] + }, + "Attachments": { + "type": "array", + "default": [], + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "default": {}, + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + } + }, + "EntryLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "default": {}, + "required": [ + "LedgerAccountId" + ], + "properties": { + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntryLine.", + "examples": [ + "Sales with high vat type" + ] + }, + "AmountDebit": { + "type": "number", + "multipleOf": 0.01, + "examples": [ + 100.26 + ] + }, + "AmountCredit": { + "type": "number", + "multipleOf": 0.01, + "examples": [ + 100.64 + ] + }, + "VatDirection": { + "type": "string", + "enum": [ + "sales", + "purchases", + "", + "null" + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "special", + "zero", + "", + "null" + ] + }, + "PeriodAllocation": { + "type": "boolean", + "description": "Apportion over a period", + "default": false + }, + "PeriodAllocationBeginDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-01-01" + ] + }, + "PeriodAllocationEndDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + } + }, + "allOf": [ + { + "if": { + "properties": { + "PeriodAllocation": { + "const": true + } + }, + "required": [ + "PeriodAllocation" + ] + }, + "then": { + "required": [ + "PeriodAllocationBeginDate", + "PeriodAllocationEndDate" + ] + } + }, + { + "anyOf": [ + { + "required": [ + "AmountDebit" + ], + "not": { + "required": [ + "AmountCredit" + ] + } + }, + { + "required": [ + "AmountCredit" + ], + "not": { + "required": [ + "AmountDebit" + ] + } + } + ] + } + ] + } + } + } + }, + "financialjournalentry-1.0-Delete-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Delete a financialjournalentry", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of financialjournalentry.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + } + ] + }, + "linestobeinvoiced-1.0-Create-JsonSchema": { + "type": "object", + "description": "Create a line to be invoiced", + "required": [ + "AdministrationId", + "Date", + "Description", + "RelationType", + "RelationId", + "Quantity" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Date": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "Description": { + "type": "string", + "description": "Must contain a description for the Line to be invoiced.", + "examples": [ + "Productomschrijving" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "format": "uuid" + }, + "ItemId": { + "type": "string", + "description": "Must contain Product guid. This can be retrieved through the products endpoint.", + "format": "uuid" + }, + "Quantity": { + "type": "number", + "description": "Quantity of products of this type", + "multipleOf": 0.01 + }, + "Price": { + "type": [ + "number", + "null" + ], + "description": "Price per product, may be left empty if product with price is provided", + "minimum": 0, + "multipleOf": 0.01 + }, + "ProjectId": { + "type": "string", + "description": "Must contain the guid of the project.", + "format": "uuid" + } + } + }, + "linestobeinvoiced-1.0-Delete-JsonSchema": { + "type": "object", + "description": "Delete a line to be invoiced", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of line to be invoiced.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + } + ] + }, + "linestobeinvoiced-1.0-Update-JsonSchema": { + "type": "object", + "description": "Update a line to be invoiced", + "required": [ + "AdministrationId", + "LineToBeInvoicedId", + "Date", + "Description", + "RelationType", + "RelationId", + "Quantity" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "LineToBeInvoicedId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the line to be invoiced", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Date": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the Line to be invoiced.", + "examples": [ + "Example Journal 001" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "format": "uuid" + }, + "ItemId": { + "type": "string", + "description": "Must contain Product guid. This can be retrieved through the products endpoint.", + "format": "uuid" + }, + "Quantity": { + "type": "number", + "description": "Quantity of products of this type", + "multipleOf": 0.01 + }, + "Price": { + "type": [ + "number", + "null" + ], + "description": "Price per product, may be left empty if product with price is provided", + "minimum": 0, + "multipleOf": 0.01 + }, + "ProjectId": { + "type": "string", + "description": "Must contain the guid of the project.", + "format": "uuid" + } + } + }, + "mandates-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create mandate for direct debit payments.", + "required": [ + "AdministrationId", + "RelationType", + "RelationId", + "RelationBankAccountId", + "DateOfSignature" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "RelationBankAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the bankaccount id of the organisation or person.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "AdministrationBankAccountId": { + "type": "string", + "format": "uuid", + "description": "Can contain the guid bankaccount of administration. If none provided de default bankaccount is used.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "MandateReference": { + "type": "string", + "description": "Can contain a reference of the mandates.If none provided an autonumber is used.", + "examples": [ + "Contractnr.FL-23904/P" + ] + }, + "DateOfSignature": { + "type": "string", + "description": "Must contain a date of signature/ approval.", + "format": "date", + "examples": [ + "2025-12-31" + ] + }, + "Attachments": { + "type": "array", + "default": [], + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "default": {}, + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "PeriodOfValidity": { + "type": "boolean", + "description": "Valid over a period", + "default": false + }, + "PeriodOfValidityBeginDate": { + "type": "string", + "format": "date", + "examples": [ + "2025-01-01" + ] + }, + "PeriodOfValidityEndDate": { + "type": "string", + "format": "date", + "examples": [ + "2025-12-31" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "RelationBankAccountId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "AdministrationBankAccountId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "MandateReference": "Contractnr.FL-23904/P", + "DateOfSignature": "2024-12-31", + "Attachments": [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ], + "PeriodOfValidity": true, + "PeriodOfValidityBeginDate": "2025-01-01", + "PeriodOfValidityEndDate": "2025-12-31" + } + ] + }, + "organisation-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "title": "Organisation", + "description": "A JSON schema to represent an organization", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the organisation", + "minLength": 1 + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application." + }, + "cocNumber": { + "type": "string", + "description": "The Chamber of Commerce (CoC) number of the organisation", + "pattern": "^[0-9]+$" + }, + "vatNumber": { + "type": "string", + "description": "The Value-Added Tax (VAT) number of the organisation", + "pattern": "^[A-Z0-9]+$" + }, + "tradename": { + "type": "string", + "description": "The tradename of the organisation" + }, + "sbiCode": { + "type": "string", + "description": "The SBICode of the organisation" + }, + "emailAddress": { + "type": "string", + "format": "email", + "description": "The email address of the organisation" + }, + "website": { + "type": "string", + "format": "uri", + "description": "The website of the organisation" + }, + "phoneNumber": { + "type": "string", + "description": "The phone number of the organisation" + }, + "address": { + "type": "array", + "default": [], + "title": "The address Schema", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "preferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "preferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "preferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "bankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for an organisation", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "AccountHolderName" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "AccountHolderName": { + "type": "string", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen", + "Jan Zandbergen" + ] + }, + "preferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "preferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "name": "Cremin Group", + "cocNumber": "38012622", + "vatNumber": "NL003276211B01", + "tradename": "Quitzon, Schinner and Jakubowski", + "emailAddress": "Kirsten_Bogisich27@example.org", + "website": "http://antoinette.name", + "phoneNumber": "758-646-8786", + "address": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "preferredSupplierAddress": true, + "preferredShippingAddress": false, + "preferredBillingAddress": true + }, + { + "StreetName": "inspiratielaan", + "HouseNumber": 3, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "preferredSupplierAddress": false, + "preferredShippingAddress": true, + "preferredBillingAddress": false + } + ], + "bankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen", + "preferredOutgoingPayments": true, + "preferredIncommingPayments": true + }, + { + "AccountNumber": "NL44DNIB0736664289", + "BankId": "DNIB", + "Bic": "DNIBNL2G", + "CountryCode": "NL", + "AccountHolderName": "Jan Zandbergen", + "preferredOutgoingPayments": false, + "preferredIncommingPayments": false + } + ] + } + ] + }, + "organisation-1.0-Update-JsonSchema": { + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "https://example.com/organization-update-schema", + "type": "object", + "title": "Organization Update Schema", + "description": "A schema for updating the information of an organization, including its name, external identifier, Chamber of Commerce number, and Value-Added Tax number.", + "properties": { + "name": { + "type": "string", + "description": "The name of the organisation", + "minLength": 1, + "maxLength": 100 + }, + "externalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application" + }, + "cocNumber": { + "type": "string", + "pattern": "^[0-9]{8}$", + "description": "The Chamber of Commerce (CoC) number of the organisation" + }, + "vatNumber": { + "type": "string", + "pattern": "^[A-Z0-9]+$", + "description": "The Value-Added Tax (VAT) number of the organisation" + } + } + }, + "organisation-2.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "title": "Organisation", + "description": "A JSON schema to represent an organization", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string", + "description": "The name of the organisation", + "minLength": 1 + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application." + }, + "CocNumber": { + "type": "string", + "description": "The Chamber of Commerce (CoC) number of the organisation", + "pattern": "^[0-9]+$" + }, + "VatNumber": { + "type": "string", + "description": "The Value-Added Tax (VAT) number of the organisation", + "pattern": "^[A-Z0-9]+$" + }, + "Tradename": { + "type": "string", + "description": "The tradename of the organisation" + }, + "SbiCode": { + "type": "string", + "description": "The SBICode of the organisation" + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The email address of the organisation" + }, + "Website": { + "type": "string", + "format": "uri", + "description": "The website of the organisation" + }, + "PhoneNumber": { + "type": "string", + "description": "The phone number of the organisation" + }, + "Addresses": { + "type": "array", + "default": [], + "title": "The address Schema", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for an organisation", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "AccountHolderName" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "AccountHolderName": { + "type": "string", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen", + "Jan Zandbergen" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "Name": "Cremin Group", + "CocNumber": "38012622", + "VatNumber": "NL003276211B01", + "Tradename": "Quitzon, Schinner and Jakubowski", + "EmailAddress": "Kirsten_Bogisich27@example.org", + "Website": "http://antoinette.name", + "PhoneNumber": "758-646-8786", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "inspiratielaan", + "HouseNumber": 3, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL44DNIB0736664289", + "BankId": "DNIB", + "Bic": "DNIBNL2G", + "CountryCode": "NL", + "AccountHolderName": "Jan Zandbergen", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "organisation-3.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "title": "Organisation", + "description": "A JSON schema to represent an organization", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string", + "description": "The name of the organisation", + "minLength": 1 + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application." + }, + "CocNumber": { + "type": "string", + "description": "The Chamber of Commerce (CoC) number of the organisation", + "pattern": "^[0-9]+$" + }, + "VatNumber": { + "type": "string", + "description": "The Value-Added Tax (VAT) number of the organisation", + "pattern": "^[A-Z0-9]+$" + }, + "Tradename": { + "type": "string", + "description": "The tradename of the organisation" + }, + "SbiCode": { + "type": "string", + "description": "The SBICode of the organisation" + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The email address of the organisation" + }, + "Website": { + "type": "string", + "format": "uri", + "description": "The website of the organisation" + }, + "PhoneNumber": { + "type": "string", + "description": "The phone number of the organisation" + }, + "Addresses": { + "type": "array", + "default": [], + "title": "The address Schema", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for an organisation", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "AccountHolderName" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "AccountHolderName": { + "type": "string", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen", + "Jan Zandbergen" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "Name": "Cremin Group", + "CocNumber": "38012622", + "VatNumber": "NL003276211B01", + "Tradename": "Quitzon, Schinner and Jakubowski", + "EmailAddress": "Kirsten_Bogisich27@example.org", + "Website": "http://antoinette.name", + "PhoneNumber": "758-646-8786", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "inspiratielaan", + "HouseNumber": 3, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL44DNIB0736664289", + "BankId": "DNIB", + "Bic": "DNIBNL2G", + "CountryCode": "NL", + "AccountHolderName": "Jan Zandbergen", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "organisation-3.0-Update-JsonSchema": { + "type": "object", + "default": {}, + "title": "Organisation", + "description": "A JSON schema to represent an organization", + "required": [ + "RelationId" + ], + "properties": { + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "Name": { + "type": "string", + "description": "The name of the organisation" + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application." + }, + "CocNumber": { + "type": "string", + "description": "The Chamber of Commerce (CoC) number of the organisation", + "pattern": "^[0-9]+$" + }, + "VatNumber": { + "type": "string", + "description": "The Value-Added Tax (VAT) number of the organisation", + "pattern": "^[A-Z0-9]+$" + }, + "Tradename": { + "type": "string", + "description": "The tradename of the organisation" + }, + "SbiCode": { + "type": "string", + "description": "The SBICode of the organisation" + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The email address of the organisation" + }, + "Website": { + "type": "string", + "format": "uri", + "description": "The website of the organisation" + }, + "PhoneNumber": { + "type": "string", + "description": "The phone number of the organisation" + }, + "Addresses": { + "type": "array", + "default": [], + "title": "The address Schema", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for an organisation", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "AccountHolderName" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "AccountHolderName": { + "type": "string", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen", + "Jan Zandbergen" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "Name": "Cremin Group", + "CocNumber": "38012622", + "VatNumber": "NL003276211B01", + "Tradename": "Quitzon, Schinner and Jakubowski", + "EmailAddress": "Kirsten_Bogisich27@example.org", + "Website": "http://antoinette.name", + "PhoneNumber": "758-646-8786", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "inspiratielaan", + "HouseNumber": 3, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL44DNIB0736664289", + "BankId": "DNIB", + "Bic": "DNIBNL2G", + "CountryCode": "NL", + "AccountHolderName": "Jan Zandbergen", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "organisation-4.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "title": "Organisation", + "description": "A JSON schema to represent an organization", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string", + "description": "The name of the organisation", + "minLength": 1 + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application." + }, + "CocNumber": { + "type": "string", + "description": "The Chamber of Commerce (CoC) number of the organisation", + "pattern": "^[0-9]+$" + }, + "VatNumber": { + "type": "string", + "description": "The Value-Added Tax (VAT) number of the organisation", + "pattern": "^[A-Z0-9]+$" + }, + "Tradename": { + "type": "string", + "description": "The tradename of the organisation" + }, + "SbiCode": { + "type": "string", + "description": "The SBICode of the organisation" + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The email address of the organisation" + }, + "Website": { + "type": "string", + "description": "The website of the organisation" + }, + "PhoneNumber": { + "type": "string", + "description": "The phone number of the organisation" + }, + "Addresses": { + "type": "array", + "default": [], + "title": "The address Schema", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for an organisation", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "AccountHolderName" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "AccountHolderName": { + "type": "string", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen", + "Jan Zandbergen" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "Name": "Cremin Group", + "CocNumber": "38012622", + "VatNumber": "NL003276211B01", + "Tradename": "Quitzon, Schinner and Jakubowski", + "EmailAddress": "Kirsten_Bogisich27@example.org", + "Website": "http://antoinette.name", + "PhoneNumber": "758-646-8786", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "inspiratielaan", + "HouseNumber": 3, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL44DNIB0736664289", + "BankId": "DNIB", + "Bic": "DNIBNL2G", + "CountryCode": "NL", + "AccountHolderName": "Jan Zandbergen", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "organisation-4.0-Update-JsonSchema": { + "type": "object", + "default": {}, + "title": "Organisation", + "description": "A JSON schema to represent an organization", + "required": [ + "RelationId" + ], + "properties": { + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "Name": { + "type": "string", + "description": "The name of the organisation" + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application." + }, + "CocNumber": { + "type": "string", + "description": "The Chamber of Commerce (CoC) number of the organisation", + "pattern": "^[0-9]+$" + }, + "VatNumber": { + "type": "string", + "description": "The Value-Added Tax (VAT) number of the organisation", + "pattern": "^[A-Z0-9]+$" + }, + "Tradename": { + "type": "string", + "description": "The tradename of the organisation" + }, + "SbiCode": { + "type": "string", + "description": "The SBICode of the organisation" + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The email address of the organisation" + }, + "Website": { + "type": "string", + "description": "The website of the organisation" + }, + "PhoneNumber": { + "type": "string", + "description": "The phone number of the organisation" + }, + "Addresses": { + "type": "array", + "default": [], + "title": "The address Schema", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for an organisation", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "AccountHolderName" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "AccountHolderName": { + "type": "string", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen", + "Jan Zandbergen" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "Name": "Cremin Group", + "CocNumber": "38012622", + "VatNumber": "NL003276211B01", + "Tradename": "Quitzon, Schinner and Jakubowski", + "EmailAddress": "Kirsten_Bogisich27@example.org", + "Website": "http://antoinette.name", + "PhoneNumber": "758-646-8786", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "inspiratielaan", + "HouseNumber": 3, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL44DNIB0736664289", + "BankId": "DNIB", + "Bic": "DNIBNL2G", + "CountryCode": "NL", + "AccountHolderName": "Jan Zandbergen", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "payrolljournalentry-1.0-Create-JsonSchema": { + "type": "object", + "title": "PayrollJournalEntry", + "description": "Create a Payroll entry.", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Use GET ../Administration" + }, + "Description": { + "type": "string" + }, + "Date": { + "type": "string", + "format": "date", + "example": "2023-01-31" + }, + "PayrollJournalEntryLine": { + "type": "array", + "items": { + "type": "object", + "properties": { + "LedgerAccountNumber": { + "type": "string", + "description": "Number of the ledger account GET ../LegderAccount" + }, + "AmountDebit": { + "type": "number", + "minimum": 0, + "multipleOf": 0.01, + "example": 1403.65 + }, + "AmountCredit": { + "type": "number", + "minimum": 0, + "multipleOf": 0.01, + "example": 2650.33 + } + }, + "required": [ + "LedgerAccountNumber" + ] + } + } + }, + "required": [ + "AdministrationId", + "Description", + "Date", + "PayrollJournalEntryLine" + ] + }, + "person-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "title": "Person", + "type": "object", + "required": [ + "lastName" + ], + "properties": { + "firstName": { + "type": "string", + "description": "The first name of the person.", + "examples": [ + "John" + ] + }, + "lastName": { + "type": "string", + "description": "The last name of the person.", + "examples": [ + "Doe" + ] + }, + "Initials": { + "type": "string", + "description": "The initials of the person.", + "examples": [ + "J.D." + ] + }, + "Prefix": { + "type": "string", + "description": "The prefix of the lastname.", + "examples": [ + "van." + ] + }, + "emailaddress": { + "type": "string", + "format": "email", + "description": "The emailaddress of the person", + "examples": [ + "johndoe@gmail.com" + ] + }, + "phonenumber": { + "type": "string", + "description": "The phonenumber of the person", + "examples": [ + "1-555-123-4567" + ] + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the person to use for a client application.", + "examples": [ + "987654321" + ] + }, + "address": { + "type": "array", + "default": [], + "description": "Create 1 or more addresses for a person", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "preferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "preferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "preferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "bankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for a person", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "CountryCode" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "preferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "preferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "Firstname": "John", + "Initials": "J", + "Prefix": "Mr", + "lastName": "Doe", + "emailaddress": "johndoe@gmail.com", + "phonenumber": "1-555-123-4567", + "address": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "preferredSupplierAddress": true, + "preferredShippingAddress": false, + "preferredBillingAddress": true + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "preferredSupplierAddress": false, + "preferredShippingAddress": true, + "preferredBillingAddress": false + } + ], + "bankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "preferredOutgoingPayments": true, + "preferredIncommingPayments": true + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "preferredOutgoingPayments": false, + "preferredIncommingPayments": false + } + ] + } + ] + }, + "person-2.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "title": "Person", + "type": "object", + "required": [ + "LastName" + ], + "properties": { + "FirstName": { + "type": "string", + "description": "The first name of the person.", + "examples": [ + "John" + ] + }, + "LastName": { + "type": "string", + "description": "The last name of the person.", + "examples": [ + "Doe" + ] + }, + "Initials": { + "type": "string", + "description": "The initials of the person.", + "examples": [ + "J.D." + ] + }, + "Prefix": { + "type": "string", + "description": "The prefix of the lastname.", + "examples": [ + "van." + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The emailaddress of the person", + "examples": [ + "johndoe@gmail.com" + ] + }, + "PhoneNumber": { + "type": "string", + "description": "The phonenumber of the person", + "examples": [ + "1-555-123-4567" + ] + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the person to use for a client application.", + "examples": [ + "987654321" + ] + }, + "Addresses": { + "type": "array", + "default": [], + "description": "Create 1 or more addresses for a person", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for a person", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "CountryCode" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "FirstName": "John", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Doe", + "EmailAddress": "johndoe@gmail.com", + "PhoneNumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "person-3.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "title": "Person", + "type": "object", + "required": [ + "LastName" + ], + "properties": { + "FirstName": { + "type": "string", + "description": "The first name of the person.", + "examples": [ + "John" + ] + }, + "LastName": { + "type": "string", + "description": "The last name of the person.", + "examples": [ + "Doe" + ] + }, + "Initials": { + "type": "string", + "description": "The initials of the person.", + "examples": [ + "J.D." + ] + }, + "Prefix": { + "type": "string", + "description": "The prefix of the lastname.", + "examples": [ + "van." + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The emailaddress of the person", + "examples": [ + "johndoe@gmail.com" + ] + }, + "PhoneNumber": { + "type": "string", + "description": "The phonenumber of the person", + "examples": [ + "1-555-123-4567" + ] + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the person to use for a client application.", + "examples": [ + "987654321" + ] + }, + "Addresses": { + "type": "array", + "default": [], + "description": "Create 1 or more addresses for a person", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for a person", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "CountryCode", + "BankId" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "FirstName": "John", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Doe", + "EmailAddress": "johndoe@gmail.com", + "PhoneNumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "person-3.0-Update-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "title": "Person", + "type": "object", + "required": [ + "RelationId" + ], + "properties": { + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the person.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "FirstName": { + "type": "string", + "description": "The first name of the person.", + "examples": [ + "John" + ] + }, + "LastName": { + "type": "string", + "description": "The last name of the person.", + "examples": [ + "Doe" + ] + }, + "Initials": { + "type": "string", + "description": "The initials of the person.", + "examples": [ + "J.D." + ] + }, + "Prefix": { + "type": "string", + "description": "The prefix of the lastname.", + "examples": [ + "van." + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The emailaddress of the person", + "examples": [ + "johndoe@gmail.com" + ] + }, + "PhoneNumber": { + "type": "string", + "description": "The phonenumber of the person", + "examples": [ + "1-555-123-4567" + ] + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the person to use for a client application.", + "examples": [ + "987654321" + ] + }, + "Addresses": { + "type": "array", + "default": [], + "description": "Create 1 or more addresses for a person", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for a person", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "CountryCode" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "FirstName": "John", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Doe", + "EmailAddress": "johndoe@gmail.com", + "PhoneNumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "person-4.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "title": "Person", + "type": "object", + "required": [ + "LastName" + ], + "properties": { + "FirstName": { + "type": "string", + "description": "The first name of the person.", + "examples": [ + "John" + ] + }, + "LastName": { + "type": "string", + "description": "The last name of the person.", + "examples": [ + "Doe" + ] + }, + "Initials": { + "type": "string", + "description": "The initials of the person.", + "examples": [ + "J.D." + ] + }, + "Prefix": { + "type": "string", + "description": "The prefix of the lastname.", + "examples": [ + "van." + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The emailaddress of the person", + "examples": [ + "johndoe@gmail.com" + ] + }, + "PhoneNumber": { + "type": "string", + "description": "The phonenumber of the person", + "examples": [ + "1-555-123-4567" + ] + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the person to use for a client application.", + "examples": [ + "987654321" + ] + }, + "Addresses": { + "type": "array", + "default": [], + "description": "Create 1 or more addresses for a person", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for a person", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "CountryCode", + "BankId" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "FirstName": "John", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Doe", + "EmailAddress": "johndoe@gmail.com", + "PhoneNumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "person-4.0-Update-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "title": "Person", + "type": "object", + "required": [ + "RelationId" + ], + "properties": { + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the person.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "FirstName": { + "type": "string", + "description": "The first name of the person.", + "examples": [ + "John" + ] + }, + "LastName": { + "type": "string", + "description": "The last name of the person.", + "examples": [ + "Doe" + ] + }, + "Initials": { + "type": "string", + "description": "The initials of the person.", + "examples": [ + "J.D." + ] + }, + "Prefix": { + "type": "string", + "description": "The prefix of the lastname.", + "examples": [ + "van." + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The emailaddress of the person", + "examples": [ + "johndoe@gmail.com" + ] + }, + "PhoneNumber": { + "type": "string", + "description": "The phonenumber of the person", + "examples": [ + "1-555-123-4567" + ] + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the person to use for a client application.", + "examples": [ + "987654321" + ] + }, + "Addresses": { + "type": "array", + "default": [], + "description": "Create 1 or more addresses for a person", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for a person", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "CountryCode" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "FirstName": "John", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Doe", + "EmailAddress": "johndoe@gmail.com", + "PhoneNumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "phonenumber-1.0-Create-JsonSchema": { + "type": "object", + "x-stoplight": { + "id": "vfjbed9j7fve7" + }, + "x-examples": { + "Example 1": { + "OrganisationId": "8f03496b-1f42-5ac3-a770-91f9da4e6e12", + "EmailAddress": "j.zandbergen@afasSbPlus.nl" + } + }, + "title": "PhoneNumber", + "examples": [ + { + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "PhoneNumber": "112346546546" + }, + { + "OrganisationId": "32abaca0-b4c6-4dce-af80-9de42a830e62", + "PhoneNumber": "65465454" + }, + { + "RelationType": "person", + "RelationId": "963578e8-7831-4aa4-83c4-e7c3262f0572", + "PhoneNumber": "6546545" + } + ], + "description": "Create a PhoneNumber for an organisation or person.", + "properties": { + "RelationType": { + "type": "string", + "description": "Must contain one of the enums. Will be required in a future version.", + "enum": [ + "organisation", + "person" + ], + "x-stoplight": { + "id": "uqd7z1nx8fqye" + } + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation or person. Will be required in a future version.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ], + "x-stoplight": { + "id": "iwy8izvm2ahpb" + } + }, + "OrganisationId": { + "type": "string", + "format": "uuid", + "example": "32abaca0-b4c6-4dce-af80-9de42a830e62", + "x-stoplight": { + "id": "n7l99rqkoa197" + } + }, + "PhoneNumber": { + "type": "string", + "description": " All characters of the phonenumber that are not a diget will be removed.", + "x-stoplight": { + "id": "8gusb7enrefaq" + } + } + }, + "required": [ + "PhoneNumber" + ] + }, + "purchaseinvoice-1.0-Create-JsonSchema": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string" + }, + "SupplierInvoiceId": { + "type": "string" + }, + "OrderReference": { + "type": "string" + }, + "SupplierOrganisationId": { + "type": "string" + }, + "IssueDate": { + "type": "string" + }, + "DueDate": { + "type": "string" + }, + "PlannedPaymentDate": { + "type": "string" + }, + "PaymentMethodId": { + "type": "string" + }, + "Attachments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AttachmentId": { + "type": "string" + } + } + } + }, + "InvoiceLine": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Description": { + "type": "string" + }, + "LedgerAccountNumberId": { + "type": "string" + }, + "LineExtensionAmount": { + "type": "string" + }, + "TaxAmount": { + "type": "string" + }, + "VatTypeId": { + "type": "string" + }, + "VatRateId": { + "type": "string" + }, + "PerformanceDateTypeId": { + "type": "string" + }, + "OtherPerformanceDate": { + "type": "string" + }, + "PerformanceStartDate": { + "type": "string" + }, + "PerformanceEndDate": { + "type": "string" + }, + "LineNumber": { + "type": "integer" + } + } + } + } + }, + "x-examples": { + "Example 1": { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "SupplierInvoiceId": "Pur002", + "OrderReference": "stringstringstring", + "SupplierOrganisationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "IssueDate": "2022-10-10", + "DueDate": "2022-10-31", + "PlannedPaymentDate": "2022-10-15", + "PaymentMethodId": "afa50000-0000-0102-b0d1-f91a25e6c442", + "Attachments": [ + { + "AttachmentId": "46db28a3-ad46-43aa-a8da-226ead20010a" + } + ], + "InvoiceLine": [ + { + "Description": "test inkoop", + "LedgerAccountNumberId": "6099", + "LineExtensionAmount": "100", + "TaxAmount": "21", + "VatTypeId": "afa50000-0000-0b71-8790-807f97e85c54", + "VatRateId": "afa50000-0000-0465-aa85-e1a761ca3a33", + "PerformanceDateTypeId": "", + "OtherPerformanceDate": "", + "PerformanceStartDate": "", + "PerformanceEndDate": "", + "LineNumber": 0 + } + ] + } + }, + "title": "PurchaseInvoice", + "description": "", + "examples": [ + { + "AdministrationId": "string", + "SupplierInvoiceId": "string", + "OrderReference": "string", + "SupplierOrganisationId": "string", + "IssueDate": "string", + "DueDate": "string", + "PlannedPaymentDate": "string", + "PaymentMethodId": "string", + "Attachments": [ + { + "AttachmentId": "string" + } + ], + "InvoiceLine": [ + { + "Description": "string", + "LedgerAccountNumberId": "string", + "LineExtensionAmount": "string", + "TaxAmount": "string", + "VatTypeId": "string", + "VatRateId": "string", + "PerformanceDateTypeId": "string", + "OtherPerformanceDate": "string", + "PerformanceStartDate": "string", + "PerformanceEndDate": "string", + "LineNumber": 0 + } + ] + } + ] + }, + "purchasejournalentry-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a purchase journal entry.", + "required": [ + "AdministrationId", + "InvoiceNumber", + "RelationType", + "RelationId", + "InvoiceDate", + "InvoiceLine", + "DueDate" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "InvoiceNumber": { + "type": "string", + "description": "Must contain the InvoiceNumber", + "examples": [ + "PUR00001" + ] + }, + "Reference": { + "type": "string", + "description": "Can contain a reference id to the origin app.", + "examples": [ + "ExternalAppId001" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "InvoiceDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "DueDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-12-31" + ] + }, + "PlannedPaymentDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-12-15" + ] + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to customer default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "InvoiceLine": { + "type": "array", + "items": { + "type": "object", + "required": [ + "LedgerAccountId", + "AmountExcludingVat", + "VatType" + ], + "properties": { + "Description": { + "type": "string", + "examples": [ + "Dell Custom keyboard" + ] + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "AmountExcludingVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 100 + ] + }, + "AmountVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 21 + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Only include if vat is reverse-charge or exemption.", + "enum": [ + "reversecharged", + "exempt", + "", + "null" + ] + } + } + } + } + } + }, + "purchasejournalentry-1.1-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a purchase journal entry.", + "required": [ + "AdministrationId", + "InvoiceNumber", + "RelationType", + "RelationId", + "InvoiceDate", + "InvoiceLine", + "DueDate" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "InvoiceNumber": { + "type": "string", + "description": "Must contain the InvoiceNumber", + "examples": [ + "PUR00001" + ] + }, + "Reference": { + "type": "string", + "description": "Can contain a reference id to the origin app.", + "examples": [ + "ExternalAppId001" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "InvoiceDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "DueDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-12-31" + ] + }, + "PlannedPaymentDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-12-15" + ] + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to supplier default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "InvoiceLine": { + "type": "array", + "items": { + "type": "object", + "required": [ + "LedgerAccountId", + "AmountExcludingVat", + "VatType" + ], + "properties": { + "Description": { + "type": "string", + "examples": [ + "Dell Custom keyboard" + ] + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "AmountExcludingVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 100 + ] + }, + "AmountVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 21 + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Only include if vat is reverse-charge or exemption.", + "enum": [ + "reversecharged", + "exempt", + "", + "null" + ] + } + } + } + } + } + }, + "purchasejournalentry-2.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a purchase journal entry", + "required": [ + "AdministrationId", + "InvoiceNumber", + "RelationType", + "RelationId", + "InvoiceDate", + "InvoiceLine", + "DueDate" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "InvoiceNumber": { + "type": "string", + "description": "Must contain the InvoiceNumber", + "examples": [ + "PUR00001" + ] + }, + "Reference": { + "type": "string", + "description": "Can contain a reference id to the origin app.", + "examples": [ + "ExternalAppId001" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "InvoiceDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "DueDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-12-31" + ] + }, + "PlannedPaymentDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-12-15" + ] + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to supplier default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "InvoiceLine": { + "type": "array", + "items": { + "type": "object", + "required": [ + "LedgerAccountId", + "AmountExcludingVat", + "VatType" + ], + "properties": { + "Description": { + "type": "string", + "examples": [ + "Dell Custom keyboard" + ] + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "AmountExcludingVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 100 + ] + }, + "AmountVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 21 + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Only include if vat is reverse-charge or exemption.", + "enum": [ + "reversecharged", + "exempt", + "", + "null" + ] + }, + "AlternativeAllocationDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + }, + "PeriodAllocation": { + "type": "boolean", + "description": "Apportion over a period", + "default": false + }, + "PeriodAllocationBeginDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-01-01" + ] + }, + "PeriodAllocationEndDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + } + } + } + } + } + }, + "salesinvoice-1.0-Create-JsonSchema": { + "type": "object", + "description": "Create a sales invoice.", + "properties": { + "AdministrationId": { + "type": "string", + "description": "Must contain the Administration guid of the target Administration", + "format": "uuid" + }, + "IssueDate": { + "type": "string", + "format": "date" + }, + "Reference": { + "type": "string" + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "format": "uuid" + }, + "AddressId": { + "type": "string", + "format": "uuid" + }, + "SentInvoiceEmail": { + "type": "boolean", + "description": "Sent the invoice as an email to the relation.", + "default": true + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid" + } + }, + "required": [ + "AttachmentId" + ] + } + }, + "InvoiceLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "properties": { + "ItemId": { + "type": "string", + "description": "Must contain Product guid. This can be retrieved through the products endpoint.", + "format": "uuid" + }, + "Price": { + "type": "number", + "description": "Price per product excluding VAT.", + "minimum": 0, + "multipleOf": 0.01 + }, + "Quantity": { + "type": "integer", + "description": "Quantity of products of this type" + }, + "ExtraDescription": { + "type": "string", + "description": "Optional field for extra information about the invoiceline" + } + }, + "required": [ + "ItemId", + "Price", + "Quantity" + ] + } + } + }, + "required": [ + "AdministrationId", + "IssueDate", + "RelationType", + "RelationId", + "InvoiceLine" + ] + }, + "salesinvoice-1.1-Create-JsonSchema": { + "type": "object", + "description": "Create a sales invoice.", + "properties": { + "AdministrationId": { + "type": "string", + "description": "Must contain the Administration guid of the target Administration", + "format": "uuid" + }, + "IssueDate": { + "type": "string", + "format": "date" + }, + "Reference": { + "type": "string" + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "format": "uuid" + }, + "AddressId": { + "type": "string", + "format": "uuid" + }, + "SentInvoiceEmail": { + "type": "boolean", + "description": "Sent the invoice as an email to the relation.", + "default": true + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid" + } + }, + "required": [ + "AttachmentId" + ] + } + }, + "InvoiceLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "properties": { + "ItemId": { + "type": "string", + "description": "Must contain Product guid. This can be retrieved through the products endpoint.", + "format": "uuid" + }, + "Price": { + "type": "number", + "multipleOf": 0.01, + "description": "Price per product excluding VAT." + }, + "Quantity": { + "type": "number", + "description": "Quantity of products of this type", + "multipleOf": 0.01 + }, + "ExtraDescription": { + "type": "string", + "description": "Optional field for extra information about the invoiceline" + } + }, + "required": [ + "ItemId", + "Quantity" + ] + } + } + }, + "required": [ + "AdministrationId", + "IssueDate", + "RelationType", + "RelationId", + "InvoiceLine" + ] + }, + "salesinvoice-2.0-Create-JsonSchema": { + "type": "object", + "description": "Create a sales invoice.", + "properties": { + "AdministrationId": { + "type": "string", + "description": "Must contain the Administration guid of the target Administration", + "format": "uuid" + }, + "IssueDate": { + "type": "string", + "format": "date" + }, + "Reference": { + "type": "string" + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "format": "uuid" + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to customer default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "AddressId": { + "type": "string", + "format": "uuid" + }, + "SentInvoiceEmail": { + "type": "boolean", + "description": "Sent the invoice as an email to the relation." + }, + "ToBeInvoiced": { + "type": "boolean", + "description": "Make a invoice that is not yet completed or sent to the relation." + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid" + } + }, + "required": [ + "AttachmentId" + ] + } + }, + "InvoiceLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "properties": { + "ItemId": { + "type": "string", + "description": "Must contain Product guid. This can be retrieved through the products endpoint.", + "format": "uuid" + }, + "Price": { + "type": "number", + "description": "Price per product excluding VAT. Falls back to product default when empty." + }, + "Quantity": { + "type": "number", + "description": "Quantity of products of this type", + "multipleOf": 0.01 + }, + "VatType": { + "type": "string", + "description": "Vat tarive. Falls back to product default when empty.", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "ExtraDescription": { + "type": "string", + "description": "Optional field for extra information about the invoiceline" + }, + "AlternativeAllocationDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + }, + "PeriodAllocation": { + "type": "boolean", + "description": "Apportion over a period", + "default": false + }, + "PeriodAllocationBeginDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-01-01" + ] + }, + "PeriodAllocationEndDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + } + }, + "required": [ + "ItemId", + "Quantity" + ] + } + } + }, + "required": [ + "AdministrationId", + "IssueDate", + "RelationType", + "RelationId", + "InvoiceLine", + "SentInvoiceEmail" + ] + }, + "salesinvoice-2.0-Delete-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Delete a salesinvoice", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of salesinvoice.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + } + ] + }, + "salesjournalentry-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a sales journal entry.", + "required": [ + "AdministrationId", + "InvoiceDate", + "InvoiceNumber", + "RelationType", + "RelationId", + "InvoiceLine" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "InvoiceDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "InvoiceNumber": { + "type": "string", + "description": "Must contain the InvoiceNumber", + "examples": [ + "VK004917" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "Reference": { + "type": "string", + "description": "Can contain a reference id to the origin app.", + "examples": [ + "ExternalAppId001" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntry.", + "examples": [ + "Example Invoice 001" + ] + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to customer default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "PaymentConditionId": { + "type": "string", + "format": "uuid", + "description": "Payment condition guids can be requested with the PaymentCondition Get endpoint. Falls back to default when empty.", + "examples": [ + "986d98be-e74d-58f2-95f7-e641769ac64f" + ] + }, + "Attachments": { + "type": "array", + "default": [], + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "default": {}, + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "InvoiceLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "default": {}, + "required": [ + "LedgerAccountId", + "AmountExcludingVat", + "VatType" + ], + "allOf": [ + { + "if": { + "properties": { + "VatType": { + "enum": [ + "high", + "low" + ] + } + }, + "required": [ + "VatType" + ] + }, + "then": { + "required": [ + "AmountVat" + ] + } + } + ], + "properties": { + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntryLine.", + "examples": [ + "Sales with high vat type" + ] + }, + "AmountExcludingVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 100 + ] + }, + "AmountVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 21 + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "IntraCommunityType": { + "type": "string", + "description": "Only include if sale is B2B and inside EU (ICP purposes). Falls back to setting (default 'supplies') when empty.", + "enum": [ + "supplies", + "services", + "", + "null" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Only include if vat is reverse-charge or exemption.", + "enum": [ + "reversecharged", + "exempt", + "", + "null" + ] + } + } + }, + "examples": [ + [ + { + "LedgerAccountId": "93b4b2cb-2174-56ff-b6f6-0031527e01e1", + "AmountExcludingVat": 116.52, + "AmountVat": 24.47, + "VatType": "high", + "VatCalculation": "exempt" + } + ] + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "InvoiceDate": "2022-10-12", + "InvoiceNumber": "VK004917", + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "Reference": "ExternalAppId001", + "Description": "Example Invoice 001", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "986d98be-e74d-58f2-95f7-e641769ac64f", + "Attachments": [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ], + "InvoiceLine": [ + { + "LedgerAccountId": "93b4b2cb-2174-56ff-b6f6-0031527e01e1", + "AmountExcludingVat": 116.52, + "AmountVat": 24.47, + "VatType": "high", + "VatCalculation": "exempt" + } + ] + } + ] + }, + "salesjournalentry-2.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a sales journal entry.", + "required": [ + "AdministrationId", + "InvoiceDate", + "InvoiceNumber", + "RelationType", + "RelationId", + "InvoiceLine" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "InvoiceDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "InvoiceNumber": { + "type": "string", + "description": "Must contain the InvoiceNumber", + "examples": [ + "VK004917" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "Reference": { + "type": "string", + "description": "Can contain a reference id to the origin app.", + "examples": [ + "ExternalAppId001" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntry.", + "examples": [ + "Example Invoice 001" + ] + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to customer default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "PaymentConditionId": { + "type": "string", + "format": "uuid", + "description": "Payment condition guids can be requested with the PaymentCondition Get endpoint. Falls back to default when empty.", + "examples": [ + "986d98be-e74d-58f2-95f7-e641769ac64f" + ] + }, + "PaymentReference": { + "type": "string", + "description": "Can contain the PaymentReference", + "examples": [ + "tr_FLtHQ7oSDG" + ] + }, + "Attachments": { + "type": "array", + "default": [], + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "default": {}, + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "InvoiceLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "default": {}, + "required": [ + "LedgerAccountId", + "AmountExcludingVat", + "VatType" + ], + "allOf": [ + { + "if": { + "properties": { + "VatType": { + "enum": [ + "high", + "low" + ] + } + }, + "required": [ + "VatType" + ] + }, + "then": { + "required": [ + "AmountVat" + ] + } + } + ], + "properties": { + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntryLine.", + "examples": [ + "Sales with high vat type" + ] + }, + "AmountExcludingVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 100 + ] + }, + "AmountVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 21 + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "IntraCommunityType": { + "type": "string", + "description": "Only include if sale is B2B and inside EU (ICP purposes). Falls back to default 'supplies' when empty.", + "enum": [ + "supplies", + "services", + "", + "null" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Only include if vat is reverse-charge or exemption.", + "enum": [ + "reversecharged", + "exempt", + "", + "null" + ] + } + } + }, + "examples": [ + [ + { + "LedgerAccountId": "93b4b2cb-2174-56ff-b6f6-0031527e01e1", + "AmountExcludingVat": 116.52, + "AmountVat": 24.47, + "VatType": "high", + "VatCalculation": "exempt" + } + ] + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "InvoiceDate": "2022-10-12", + "InvoiceNumber": "VK004917", + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "Reference": "ExternalAppId001", + "Description": "Example Invoice 001", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "986d98be-e74d-58f2-95f7-e641769ac64f", + "Attachments": [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ], + "InvoiceLine": [ + { + "LedgerAccountId": "93b4b2cb-2174-56ff-b6f6-0031527e01e1", + "AmountExcludingVat": 116.52, + "AmountVat": 24.47, + "VatType": "high", + "VatCalculation": "exempt" + } + ] + } + ] + }, + "salesjournalentry-2.0-Delete-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Delete a salesjournalentry", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of salesjournal.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + } + ] + }, + "salesjournalentry-2.0-Update-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Update a sales journal entry.", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the salesjournalentry.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "PaymentReference": { + "type": "string", + "description": "Can contain the PaymentReference", + "examples": [ + "tr_FLtHQ7oSDG" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "PaymentReference": "tr_FLtHQ7oSDG" + } + ] + }, + "salesjournalentry-2.1-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a sales journal entry.", + "required": [ + "AdministrationId", + "InvoiceDate", + "InvoiceNumber", + "RelationType", + "RelationId", + "InvoiceLine" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "InvoiceDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "InvoiceNumber": { + "type": "string", + "description": "Must contain the InvoiceNumber", + "examples": [ + "VK004917" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "Reference": { + "type": "string", + "description": "Can contain a reference id to the origin app.", + "examples": [ + "ExternalAppId001" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntry.", + "examples": [ + "Example Invoice 001" + ] + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to customer default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "PaymentConditionId": { + "type": "string", + "format": "uuid", + "description": "Payment condition guids can be requested with the PaymentCondition Get endpoint. Falls back to default when empty.", + "examples": [ + "986d98be-e74d-58f2-95f7-e641769ac64f" + ] + }, + "PaymentReference": { + "type": "string", + "description": "Can contain the PaymentReference", + "examples": [ + "tr_FLtHQ7oSDG" + ] + }, + "Attachments": { + "type": "array", + "default": [], + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "default": {}, + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "InvoiceLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "default": {}, + "required": [ + "LedgerAccountId", + "AmountExcludingVat" + ], + "allOf": [ + { + "if": { + "properties": { + "VatType": { + "enum": [ + "high", + "low" + ] + } + }, + "required": [ + "VatType" + ] + }, + "then": { + "required": [ + "AmountVat" + ] + } + }, + { + "if": { + "not": { + "properties": { + "VatCalculation": { + "const": "novat" + } + } + } + }, + "then": { + "required": [ + "VatType" + ] + } + } + ], + "properties": { + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntryLine.", + "examples": [ + "Sales with high vat type" + ] + }, + "AmountExcludingVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 100 + ] + }, + "AmountVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 21 + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "IntraCommunityType": { + "type": "string", + "description": "Only include if sale is B2B and inside EU (ICP purposes). Falls back to default 'supplies' when empty.", + "enum": [ + "supplies", + "services", + "", + "null" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Only include if vat is reverse-charge or exemption.", + "enum": [ + "reversecharged", + "exempt", + "novat", + "", + "null" + ] + }, + "AlternativeAllocationDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + }, + "PeriodAllocation": { + "type": "boolean", + "description": "Apportion over a period", + "default": false + }, + "PeriodAllocationBeginDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-01-01" + ] + }, + "PeriodAllocationEndDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + } + } + }, + "examples": [ + [ + { + "LedgerAccountId": "93b4b2cb-2174-56ff-b6f6-0031527e01e1", + "AmountExcludingVat": 116.52, + "AmountVat": 24.47, + "VatType": "high", + "VatCalculation": "exempt" + } + ] + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "InvoiceDate": "2022-10-12", + "InvoiceNumber": "VK004917", + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "Reference": "ExternalAppId001", + "Description": "Example Invoice 001", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "986d98be-e74d-58f2-95f7-e641769ac64f", + "Attachments": [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ], + "InvoiceLine": [ + { + "LedgerAccountId": "93b4b2cb-2174-56ff-b6f6-0031527e01e1", + "AmountExcludingVat": 116.52, + "AmountVat": 24.47, + "VatType": "high", + "VatCalculation": "exempt" + } + ] + } + ] + }, + "salesjournalentry-2.1-Delete-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Delete a salesjournalentry", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of salesjournal.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + } + ] + }, + "salesjournalentry-2.1-Update-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Update a sales journal entry.", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the salesjournalentry.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "PaymentReference": { + "type": "string", + "description": "Can contain the PaymentReference", + "examples": [ + "tr_FLtHQ7oSDG" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "PaymentReference": "tr_FLtHQ7oSDG" + } + ] + }, + "supplier-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "description": "Create a supplier.", + "required": [ + "AdministrationId" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "examples": [ + "leverancier@afas.nl" + ] + }, + "PhoneNumber": { + "type": "string", + "examples": [ + "+31655887744" + ] + }, + "BankAccountNumber": { + "type": "string", + "description": "Must be in IBAN format. Creates a bankaccount record for the supplier", + "examples": [ + "NL03BOFA0011792833" + ] + }, + "BIC": { + "type": "string", + "description": "If the Bic code is not available the BIC code will be looked up. If its not found an error will be raised", + "examples": [ + "BOFANLNX" + ] + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Set default value for supplier.", + "examples": [ + "c0441b65-1ca8-534c-8e45-acab8d30b325" + ] + }, + "PaymentMethod": { + "type": "string", + "default": "banktransfer", + "description": "Set default value for supplier. Falls back to supplier default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "PaymentConditionId": { + "type": "string", + "format": "uuid", + "description": "Set default value for supplier. Payment condition guids can be requested with the PaymentCondition Get endpoint. Falls back to default when empty.", + "examples": [ + "986d98be-e74d-58f2-95f7-e641769ac64f" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Set de value for supplier.", + "enum": [ + "charged", + "novat", + "reversecharged", + "exempt", + "", + "null" + ] + }, + "Person": { + "type": "object", + "default": {}, + "title": "The Person Schema", + "required": [ + "Lastname" + ], + "properties": { + "Firstname": { + "type": "string", + "title": "The Firstname Schema", + "examples": [ + "Jan" + ] + }, + "Initials": { + "type": "string", + "title": "The Initials Schema", + "examples": [ + "JH" + ] + }, + "Prefix": { + "type": "string", + "title": "The Prefix Schema", + "examples": [ + "van" + ] + }, + "Lastname": { + "type": "string", + "title": "The Lastname Schema", + "examples": [ + "Pinksteren" + ] + } + }, + "examples": [ + { + "Firstname": "Jan", + "Initials": "JH", + "Prefix": "van", + "Lastname": "Pinksteren" + } + ] + }, + "Organisation": { + "type": "object", + "default": {}, + "title": "The Organisation Schema", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string", + "default": "", + "title": "The Name Schema", + "examples": [ + "Jansen IJzerwaren" + ] + }, + "CompanyIdCoc": { + "type": "string", + "description": "Contains the CompanyCode also known in dutch as KVK nummer", + "examples": [ + "04019167" + ] + }, + "CompanyIdVat": { + "type": "string", + "description": "Contains the VAT code of the supplier", + "examples": [ + "NL818785639B01" + ] + }, + "TradeName": { + "type": "string", + "description": "The formal trade name of the organisation. If empty will be filled with the field Name", + "examples": [ + "Jansen Holding B.V." + ] + } + }, + "examples": [ + { + "Name": "Jansen Haarden", + "CompanyIdCoc": "80446353", + "CompanyIdVat": "NL861674881B01", + "TradeName": "Jansen Holding B.V." + } + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "EmailAddress": "leverancier@afas.nl", + "PhoneNumber": "0645789865", + "BankAccountNumber": "NL29TRIO0110845005", + "Bic": "TRIONL2U", + "VatType": "high", + "PaymentMethod": "banktransfer", + "IncludeInBankFile": "true", + "LedgerAccountId": "7f9a01a1-0352-5726-9111-03214874de74", + "Person": { + "Firstname": "Jan", + "Initials": "JH", + "Prefix": "van", + "Lastname": "Pinksteren" + }, + "Organisation": { + "Name": "Jansen IJzerwaren", + "CompanyIdCoc": "80446353", + "CompanyIdVat": "NL861674881B01", + "TradeName": "Jansen IJzerwaren B.V." + } + } + ] + } + }, + "responses": { + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "object", + "x-examples": { + "Example 1": { + "result": "PartiallySucceeded", + "traceId": "b06e41e4-4ff1-4b40-9331-5f2145b2a9a2", + "instances": [ + { + "Code": "Organisatie", + "Id": "1bfbc287-5fb4-59b5-9782-376fa601e4ad", + "Relatienummer": "000025" + }, + { + "Code": "Instelling", + "Id": "32a8c5d4-2227-512f-9f45-495192933809" + }, + { + "Code": "Leverancier", + "Id": "0afea90d-4ecb-5791-8e4b-787c70656f75" + }, + { + "Code": "Begunstigde", + "Id": "32a8c5d4-2227-512f-9f45-495192933809" + } + ], + "errors": [ + { + "Instelling": "'identificatie' bevat een verwijzing naar een ongeldige waarde." + } + ] + } + }, + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string" + }, + "instances": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Code": { + "type": "string" + }, + "Id": { + "type": "string" + } + } + } + }, + "errors": { + "type": "array", + "items": { + "type": "object" + } + } + } + }, + "examples": { + "PartiallySucceeded": { + "value": { + "result": "PartiallySucceeded", + "traceId": "b06e41e4-4ff1-4b40-9331-5f2145b2a9a2", + "instances": [ + { + "Code": "Organisatie", + "Id": "1bfbc287-5fb4-59b5-9782-376fa601e4ad", + "Relatienummer": "000025" + }, + { + "Code": "Instelling", + "Id": "32a8c5d4-2227-512f-9f45-495192933809" + }, + { + "Code": "Leverancier", + "Id": "0afea90d-4ecb-5791-8e4b-787c70656f75" + }, + { + "Code": "Begunstigde", + "Id": "32a8c5d4-2227-512f-9f45-495192933809" + } + ], + "errors": [ + { + "Instelling": "'identificatie' bevat een verwijzing naar een ongeldige waarde." + } + ] + } + }, + "Bad Request - Invalid JSON": { + "value": { + "StatusCode": 400, + "Message": "Invalid JSON request String", + "ExceptionCode": "DS3100", + "TraceId": "802033b876ed48bbb83a01a717ccb960", + "AdditionalInfo": { + "ExceptionType": "DeserializationException", + "DefinitionName": "salesinvoice.UpdateConnectorHandler", + "PropertyNames": "" + } + } + }, + "Bad request - Invalid UUID": { + "value": { + "StatusCode": 400, + "Message": "Invalid JSON request String '' does not validate against format 'uuid'. Path 'RelationId', line 3, position 18.", + "ExceptionCode": "DS3100", + "TraceId": "57887d8213dd4327ae1429e860250b24", + "AdditionalInfo": { + "ExceptionType": "DeserializationException", + "DefinitionName": "address.UpdateConnectorHandler", + "PropertyNames": "" + } + } + }, + "Ongeldig gebruikersfilter": { + "value": { + "StatusCode": 400, + "Message": "Ongeldig gebruikersfilter.", + "TraceId": "3b022f499ab040dea4ef992d90901963", + "AdditionalInfo": { + "ExceptionType": "AntaUserException" + } + } + } + } + } + }, + "headers": { + "Server": { + "schema": { + "type": "string", + "example": "nginx" + } + }, + "Date": { + "schema": { + "type": "string", + "example": "Wed, 19 Oct 2022 12:05:20 GMT" + } + }, + "Content-Type": { + "schema": { + "type": "string", + "example": "application/json" + } + }, + "Transfer-Encoding": { + "schema": { + "type": "string", + "example": "chunked" + } + }, + "Connection": { + "schema": { + "type": "string", + "example": "keep-alive" + } + }, + "Content-Version": { + "schema": { + "type": "number", + "example": 1 + } + }, + "X-Content-Type-Options": { + "schema": { + "type": "string", + "example": "nosniff" + } + }, + "X-XSS-Protection": { + "schema": { + "type": "string", + "example": "1; mode=block" + } + }, + "X-Frame-Options": { + "schema": { + "type": "string", + "example": "SAMEORIGIN" + } + }, + "Strict-Transport-Security": { + "schema": { + "type": "string", + "example": "max-age=300" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "StatusCode": { + "type": "integer" + }, + "Message": { + "type": "string" + }, + "TraceId": { + "type": "string" + }, + "AdditionalInfo": { + "type": "object", + "properties": { + "ExceptionType": { + "type": "string" + } + } + } + } + }, + "examples": { + "Unauthorized": { + "value": { + "StatusCode": 401, + "Message": "Er is geen ingelogde gebruiker.", + "TraceId": "b41c2c8219494f40bef50bc24ea6844d", + "AdditionalInfo": { + "ExceptionType": "NotAuthenticatedException" + } + } + } + } + } + }, + "headers": { + "Server": { + "schema": { + "type": "string", + "example": "nginx" + } + }, + "Date": { + "schema": { + "type": "string", + "example": "Wed, 19 Oct 2024 12:05:20 GMT" + } + }, + "Transfer-Encoding": { + "schema": { + "type": "string", + "example": "chunked" + } + }, + "Connection": { + "schema": { + "type": "string", + "example": "keep-alive" + } + }, + "Content-Version": { + "schema": { + "type": "number", + "example": 1 + } + }, + "X-Content-Type-Options": { + "schema": { + "type": "string", + "example": "nosniff" + } + }, + "X-XSS-Protection": { + "schema": { + "type": "string", + "example": "1; mode=block" + } + }, + "X-Frame-Options": { + "schema": { + "type": "string", + "example": "SAMEORIGIN" + } + }, + "Strict-Transport-Security": { + "schema": { + "type": "string", + "example": "max-age=300" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "StatusCode": { + "type": "integer" + }, + "Message": { + "type": "string" + }, + "TraceId": { + "type": "string" + }, + "AdditionalInfo": { + "type": "object", + "properties": { + "ExceptionType": { + "type": "string" + } + } + } + } + }, + "examples": { + "Unauthorized": { + "value": { + "StatusCode": 403, + "Message": "De ingelogde gebruiker heeft niet voldoende rechten.", + "TraceId": "7c4cdf827b824c5384a3b9b22966c3c3", + "AdditionalInfo": { + "ExceptionType": "NotAuthorizedException" + } + } + } + } + } + } + }, + "404": { + "description": "Item Not Found", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "StatusCode": { + "type": "string" + }, + "Message": { + "type": "string" + }, + "TraceId": { + "type": "string" + }, + "AdditionalInfo": { + "type": "object", + "properties": { + "ExceptionType": { + "type": "string" + } + } + } + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/OpenApiSpecs/sb/nl/release-spec.json b/OpenApiSpecs/sb/nl/release-spec.json new file mode 100644 index 0000000..33fbe73 --- /dev/null +++ b/OpenApiSpecs/sb/nl/release-spec.json @@ -0,0 +1,13616 @@ +{ + "openapi": "3.0.2", + "info": { + "version": "7.1", + "title": "AFAS SB API", + "description": "AFAS SB API for integrating with the accounting software for accountants and entrepreneurs." + }, + "servers": [ + { + "url": "https://{domain}.afasfocus.nl/{customerenvironment}", + "description": "Customer environment URL", + "variables": { + "domain": { + "description": "Identifier for the accountancy environment", + "default": "app-center-demo" + }, + "customerenvironment": { + "description": "Identifier for the customer environment", + "default": "scope" + } + } + }, + { + "url": "https://{subdomein}.afasfocus.nl/admin", + "description": "Accounting center URL", + "variables": { + "subdomein": { + "description": "URL unique for the accounting office.", + "default": "app-center-demo" + } + } + } + ], + "paths": { + "/api/blob/{uuid}": { + "get": { + "description": "Retrieve a specific blob by UUI.", + "summary": "/api/blob/{uuid}", + "operationId": "getBlob", + "parameters": [ + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1" + } + }, + { + "in": "header", + "name": "Authorization", + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "uuid", + "schema": { + "type": "string", + "format": "uuid", + "example": "00000000-0000-0000-0000-000000000000" + }, + "required": true, + "description": "UUID of the blob" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "tags": [ + "Bijlagen", + "Inkoopjournaalpost", + "Verkoopfactuur", + "Verkoopjournaalpost", + "Publiek: Externe facturatie" + ], + "deprecated": false + }, + "put": { + "description": "This operation consists of two requests. First call this endpoint with the Blob-* headers, without body to prepare the blob. Then call this endpoint without the Blob-* headers with a body to upload the file. The blob UUID must be generated client side.", + "summary": "/api/blob/{uuid}", + "operationId": "reserveBlobSpace", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "path", + "name": "uuid", + "schema": { + "type": "string", + "format": "uuid", + "example": "00000000-0000-0000-0000-000000000000" + }, + "required": true, + "description": "UUID of the blob. This should be generated client side." + }, + { + "in": "header", + "name": "Blob-Content-Length", + "schema": { + "type": "integer", + "example": "100" + } + }, + { + "in": "header", + "name": "Blob-Content-Type", + "schema": { + "type": "string", + "example": "image/jpeg" + } + }, + { + "in": "header", + "name": "Blob-Content-FileName", + "schema": { + "type": "string", + "example": "attachment.jpg" + } + }, + { + "in": "header", + "name": "Blob-Upload-Type", + "schema": { + "type": "string", + "example": "Blob/Image" + }, + "required": true + }, + { + "in": "header", + "name": "Blob-Format", + "schema": { + "type": "string", + "example": "Default/Thumb/Small/Medium" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + } + ], + "requestBody": { + "description": "Binary content of the blob", + "required": true + }, + "responses": { + "200": { + "description": "OK" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "tags": [ + "Bijlagen", + "Inkoopjournaalpost", + "Verkoopfactuur", + "Verkoopjournaalpost", + "Publiek: Externe facturatie" + ], + "deprecated": false + } + }, + "/authentication/getaccesstoken": { + "post": { + "description": "Get AccessToken: Provide an application token created in the current application. An access token is returned which can be used for the \"AccessToken\" header to execute connector requests. The 'scope' property is required in accountancy environments. When scope is not provided in accountancy environments, an identity token is returned which can be used in the 'ScopeSelection' api.", + "summary": "/authentication/getaccesstoken", + "operationId": "updateconnector-getaccesstoken", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/json" + } + } + ], + "requestBody": { + "description": "Application token", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "apptoken": { + "type": "string", + "example": "APPTOKEN" + }, + "scope": { + "type": "string", + "example": "demo" + } + }, + "required": [ + "apptoken" + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "tags": [ + "Autorisatie" + ], + "deprecated": false + } + }, + "/authentication/getscopes": { + "post": { + "description": "Get scopes: Provide an identity token returned by the 'AccessToken' api.", + "summary": "/authentication/getscopes", + "operationId": "updateconnector-getscopes", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/json" + } + }, + { + "in": "header", + "name": "IdentityToken", + "schema": { + "type": "string", + "example": "IDENTITYTOKEN" + } + } + ], + "requestBody": { + "description": "Scopes", + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Name": { + "type": "string", + "example": "Beheer" + }, + "Path": { + "type": "string", + "example": "admin" + } + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "tags": [ + "Autorisatie" + ], + "deprecated": false + } + }, + "/app/token": { + "post": { + "description": "Get an access token for a scope.", + "summary": "app/token", + "operationId": "updateconnector-token", + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "grant_type": { + "type": "string", + "example": "refresh_token" + }, + "refresh_token": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "client_secret": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "multipart/form-data": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "access_token": { + "type": "string" + }, + "expires_in": { + "type": "integer" + }, + "token_type": { + "type": "string" + } + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "tags": [ + "Autorisatie" + ], + "deprecated": false + } + }, + "/api/adminlicenseinformation": { + "get": { + "description": "Retrieve license information for all scopes in the environment. This endpoint requires admin rights, and should be called from the 'admin' scope (e.g. yourdomain.afasfocus.nl/admin/api/adminlicenseinformation).", + "summary": "/api/adminlicenseinformation", + "operationId": "getconnector-adminlicenseinformation-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/json" + } + }, + { + "in": "header", + "name": "IdentityToken", + "schema": { + "type": "string", + "example": "IDENTITYTOKEN" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Name": { + "type": "string", + "example": "Beheer" + }, + "Url": { + "type": "string", + "example": "beheer" + }, + "ScopeId": { + "type": "integer", + "example": "1" + }, + "License": { + "type": "string", + "example": "Ondernemen" + }, + "AdministrationCount": { + "type": "integer", + "example": "5" + }, + "ExtraAdministrationCount": { + "type": "integer", + "example": "2" + }, + "UserCount": { + "type": "integer", + "example": "2" + }, + "ExtraUserCount": { + "type": "integer", + "example": "0" + } + } + } + } + } + } + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "tags": [ + "Admin center data", + "Publiek: Admin center data" + ], + "deprecated": false + } + }, + "/api/accountingperiod": { + "get": { + "description": "Retrieve accounting periods for a specific administration", + "summary": "accountingperiod 2.0", + "operationId": "getconnector-accountingperiod-get-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "AccountingYear": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "StartDate": { + "type": "string", + "format": "date-time" + }, + "EndDate": { + "type": "string", + "format": "date-time" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "PeriodNumber": { + "type": "number" + } + } + } + }, + "examples": "{\r\n \"OrganisationId\": \"8afb1a9a-1613-5e2b-ab19-20c0f4f3e216\",\r\n \"Firstname\": \"Rosella\",\r\n \"Initials\": \"III\",\r\n \"Prefix\": \"Mr.\",\r\n \"Lastname\": \"Predovic\",\r\n \"EmailAddress\": \"Karli61@example.com\",\r\n \"PhoneNumber\": \"223-385-8892\"\r\n}" + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële dashboarding", + "Publiek: Financiële rapportage", + "Financiele rapportage" + ] + } + }, + "/api/accountingyear": { + "get": { + "description": "Retrieve accounting years for financial reporting periods", + "summary": "accountingyear 2.0", + "operationId": "getconnector-accountingyear-get-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + }, + "StartDate": { + "type": "string", + "format": "date-time" + }, + "EndDate": { + "type": "string", + "format": "date-time" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële dashboarding", + "Publiek: Financiële rapportage", + "Financiele rapportage" + ] + } + }, + "/api/addresses": { + "get": { + "description": "Retrieve multiple addresses with detailed contact information", + "summary": "addresses 1.0", + "operationId": "getconnector-addresses-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "StreetName": { + "type": "string" + }, + "HouseNumber": { + "type": "string" + }, + "HouseNumberAddition": { + "type": "string" + }, + "PostalZone": { + "type": "string" + }, + "CityName": { + "type": "string" + }, + "CountryName": { + "type": "string" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "IsPreferedInvoiceAddress": { + "type": "boolean" + }, + "IsPreferedSupplierAddress": { + "type": "boolean" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost", + "Publiek: Relatiemanagement", + "Relaties", + "Publiek: Facturatie", + "Verkoopfactuur" + ] + } + }, + "/api/administration": { + "get": { + "description": "ListAdministration", + "summary": "administration 1.0", + "operationId": "getconnector-administration-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Description Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Description": { + "type": "string" + }, + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "Id": { + "type": "string", + "format": "uuid" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Loonjournaalpost", + "POS Transacties", + "Inkoopjournaalpost", + "Verkoopfactuur", + "Verkoopjournaalpost" + ] + } + }, + "/api/administrations": { + "get": { + "description": "Retrieve all available administrations and their details", + "summary": "administrations 1.0", + "operationId": "getconnector-administrations-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Description Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Description": { + "type": "string" + }, + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "Id": { + "type": "string", + "format": "uuid" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële dashboarding", + "Publiek: Financiële journaalpost", + "Financiële journaalpost", + "Publiek: Financiële rapportage", + "Financiele rapportage", + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Loonjournaalpost", + "Publiek: POS Transacties", + "POS Transacties", + "Inkoopjournaalpost", + "Publiek: Relatiemanagement", + "Publiek: Facturatie", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/bankaccounts": { + "get": { + "description": "Get bankaccount for organisation or person.", + "summary": "bankaccounts 1.0", + "operationId": "getconnector-bankaccounts-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "AccountNumber": { + "type": "string" + }, + "RelationIsOrganisationOrAdministration": { + "type": "boolean" + }, + "PreferredIncommingPayments": { + "type": "boolean" + }, + "PreferredOutgoingPayments": { + "type": "boolean" + }, + "RelationId": { + "type": "string", + "format": "uuid" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost", + "Publiek: Relatiemanagement", + "Relaties", + "Publiek: Facturatie", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/cashregisters": { + "get": { + "description": "Retrieve cash register configurations and settings", + "summary": "cashregisters 1.0", + "operationId": "getconnector-cashregisters-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "InstanceId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: POS Transacties", + "POS Transacties" + ] + } + }, + "/api/contacts": { + "get": { + "description": "Retrieve contact information for persons and organizations", + "summary": "contacts 1.0", + "operationId": "getconnector-contacts-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "OrganisationId": { + "type": "string", + "format": "uuid" + }, + "PersonId": { + "type": "string", + "format": "uuid" + }, + "Name": { + "type": "string" + }, + "Firstname": { + "type": "string" + }, + "Initials": { + "type": "string" + }, + "Prefix": { + "type": "string" + }, + "Lastname": { + "type": "string" + }, + "PhoneNumber": { + "type": "string" + }, + "Emailaddress": { + "type": "string" + }, + "ExternalId": { + "type": "string" + }, + "IsArchived": { + "type": "boolean" + }, + "PersonIsArchived": { + "type": "boolean" + }, + "OrganisationIsArchived": { + "type": "boolean" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Relatiemanagement", + "Relaties" + ] + } + }, + "/api/countries": { + "get": { + "description": "Retrieve country information with ISO codes and descriptions", + "summary": "countries 1.0", + "operationId": "getconnector-countries-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + }, + "CodeISOAlpha2": { + "type": "string" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost", + "Publiek: Relatiemanagement", + "Relaties" + ] + } + }, + "/api/creditorbalance": { + "get": { + "description": "Retrieve creditor balance information for suppliers", + "summary": "creditorbalance 1.0", + "operationId": "getconnector-creditorbalance-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationName": { + "type": "string" + }, + "LastCompleted": { + "type": "string", + "format": "date-time" + }, + "OutstandingAmount": { + "type": "number" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Crediteuren" + ] + } + }, + "/api/creditorinvoicebalance": { + "get": { + "description": "Retrieve creditor invoice balance details for payable transactions", + "summary": "creditorinvoicebalance 1.0", + "operationId": "getconnector-creditorinvoicebalance-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "InvoiceNumber Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "InvoiceNumber": { + "type": "string" + }, + "InvoiceDate": { + "type": "string", + "format": "date-time" + }, + "CustomerReference": { + "type": "string" + }, + "DueDate": { + "type": "string", + "format": "date-time" + }, + "InternalInvoiceNumber": { + "type": "string" + }, + "InvoiceId": { + "type": "string", + "format": "uuid" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationName": { + "type": "string" + }, + "LastCompleted": { + "type": "string", + "format": "date-time" + }, + "OutstandingAmount": { + "type": "number" + }, + "PaidAmount": { + "type": "number" + }, + "ProcessingAmount": { + "type": "number" + }, + "TotalAmount": { + "type": "number" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Crediteuren" + ] + } + }, + "/api/debtorbalance": { + "get": { + "description": "Retrieve debtor balance information for customers", + "summary": "debtorbalance 2.0", + "operationId": "getconnector-debtorbalance-get-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "RelationName": { + "type": "string" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "LastCompleted": { + "type": "string", + "format": "date-time" + }, + "OutstandingAmount": { + "type": "number" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Debiteuren" + ] + } + }, + "/api/debtorinvoicebalance": { + "get": { + "description": "Retrieve debtor invoice balance details for receivable transactions", + "summary": "debtorinvoicebalance 3.0", + "operationId": "getconnector-debtorinvoicebalance-get-3.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "3.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "InvoiceDate": { + "type": "string", + "format": "date-time" + }, + "DueDate": { + "type": "string", + "format": "date-time" + }, + "InvoiceNumber": { + "type": "string" + }, + "CustomerReference": { + "type": "string" + }, + "RelationName": { + "type": "string" + }, + "InvoiceId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "LastCompleted": { + "type": "string", + "format": "date-time" + }, + "OutstandingAmount": { + "type": "number" + }, + "TotalAmount": { + "type": "number" + }, + "PaidAmount": { + "type": "number" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "3.0", + "deprecated": false, + "tags": [ + "Debiteuren", + "Publiek: Externe facturatie" + ] + } + }, + "/api/debtorpaymentterms": { + "get": { + "description": "Retrieve payment terms configured for debtor relationships", + "summary": "debtorpaymentterms 1.0", + "operationId": "getconnector-debtorpaymentterms-get-1.0", + "parameters": [ + { + "in": "query", + "name": "BusinessActivityVersion", + "schema": { + "type": "integer" + } + }, + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministationId": { + "type": "string", + "format": "uuid" + }, + "OrganisationId": { + "type": "string", + "format": "uuid" + }, + "PersonId": { + "type": "string", + "format": "uuid" + }, + "UnknownRelationId": { + "type": "string", + "format": "uuid" + }, + "InvoiceDate": { + "type": "string", + "format": "date-time" + }, + "InvoiceId": { + "type": "string" + }, + "Address": { + "type": "string" + }, + "AddressId": { + "type": "string", + "format": "uuid" + }, + "DueDate": { + "type": "string", + "format": "date-time" + }, + "RelationId": { + "type": "string" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Debiteuren" + ] + } + }, + "/api/featuretoggles": { + "get": { + "description": "Retrieve feature toggle settings and configurations", + "summary": "featuretoggles 1.0", + "operationId": "getconnector-featuretoggles-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "SalesInvoices": { + "type": "boolean" + }, + "SalesJournalEntries": { + "type": "boolean" + }, + "LinesToBeInvoiced": { + "type": "boolean" + }, + "Projects": { + "type": "boolean" + }, + "Supplies": { + "type": "boolean" + }, + "Services": { + "type": "boolean" + }, + "FixedAssets": { + "type": "boolean" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "TechnischeInfo" + ] + } + }, + "/api/journalentries": { + "get": { + "description": "Retrieve journal entries for financial bookkeeping", + "summary": "journalentries 1.1", + "operationId": "getconnector-journalentries-get-1.1", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.1" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "HeaderId": { + "type": "string", + "format": "uuid" + }, + "LineId": { + "type": "string", + "format": "uuid" + }, + "AccountingPeriodId": { + "type": "string", + "format": "uuid" + }, + "AccountingYearId": { + "type": "string", + "format": "uuid" + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid" + }, + "AmountDebit": { + "type": "number" + }, + "AmountCredit": { + "type": "number" + }, + "AmountTotal": { + "type": "number" + }, + "Number": { + "type": "string" + }, + "PostingDate": { + "type": "string", + "format": "date-time" + }, + "Description": { + "type": "string" + }, + "DocumentIdentification": { + "type": "string" + }, + "DocumentDate": { + "type": "string", + "format": "date-time" + }, + "VatPercentage": { + "type": "number" + }, + "VatSection": { + "oneOf": [ + { + "const": "Rubriek1a", + "title": "1a verkopen hoog" + }, + { + "const": "Rubriek1b", + "title": "1b verkopen laag" + }, + { + "const": "Rubriek1c", + "title": "1c verkopen overige tarieven" + }, + { + "const": "Rubriek1d", + "title": "1d btw privé" + }, + { + "const": "Rubriek2a", + "title": "2a/5b inkopen verlegd" + }, + { + "const": "Rubriek3a", + "title": "3a verkopen buiten de EU" + }, + { + "const": "Rubriek3b", + "title": "3b verkopen binnen de EU" + }, + { + "const": "Rubriek3c", + "title": "3c afstandsverkopen" + }, + { + "const": "Rubriek4a", + "title": "4a/5b inkopen buiten de EU" + }, + { + "const": "Rubriek4b", + "title": "4b/5b inkopen binnen de EU" + }, + { + "const": "Rubriek5b", + "title": "5b voorbelasting" + }, + { + "const": "Rubriek1e", + "title": "1e verkopen 0%" + } + ] + }, + "VatAmount": { + "type": "number" + }, + "AuditCreatedOnDate": { + "type": "string", + "format": "date-time" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.1", + "deprecated": false, + "tags": [ + "Financiele rapportage" + ] + } + }, + "/api/ledgeraccounts": { + "get": { + "description": "Retrieve all ledger accounts", + "summary": "ledgeraccounts 1.0", + "operationId": "getconnector-ledgeraccounts-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + }, + "LedgerAccountNumber": { + "type": "string" + }, + "TypeId": { + "oneOf": [ + { + "const": "Activa", + "title": "activa" + }, + { + "const": "Kosten", + "title": "kosten" + }, + { + "const": "Opbrengsten", + "title": "opbrengsten" + }, + { + "const": "Passiva", + "title": "passiva" + } + ] + }, + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "InvestInAsset": { + "type": "boolean" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële dashboarding", + "Publiek: Financiële journaalpost", + "Financiële journaalpost", + "Publiek: Financiële rapportage", + "Financiele rapportage", + "Loonjournaalpost", + "Publiek: POS Transacties", + "POS Transacties", + "Inkoopjournaalpost", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/ledgerperiodtotals": { + "get": { + "description": "Retrieve ledger account totals grouped by period for reporting", + "summary": "ledgerperiodtotals 1.0", + "operationId": "getconnector-ledgerperiodtotals-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "AccountingYear": { + "type": "string" + }, + "AccountingYearId": { + "type": "string", + "format": "uuid" + }, + "AccountingYearStartDate": { + "type": "string", + "format": "date-time" + }, + "AccountingYearEndDate": { + "type": "string", + "format": "date-time" + }, + "AccountingPeriod": { + "type": "string" + }, + "AccountingPeriodId": { + "type": "string", + "format": "uuid" + }, + "AccountingPeriodStartDate": { + "type": "string", + "format": "date-time" + }, + "AccountingPeriodEndDate": { + "type": "string", + "format": "date-time" + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid" + }, + "LedgerAccount": { + "type": "string" + }, + "IsOpeningBalance": { + "type": "boolean" + }, + "RgsCode": { + "type": "string" + }, + "RgsDescription": { + "type": "string" + }, + "LedgerAccountNumber": { + "type": "string" + }, + "Total": { + "type": "number" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële dashboarding", + "Publiek: Financiële rapportage", + "Financiele rapportage" + ] + } + }, + "/api/linestobeinvoiced": { + "get": { + "description": "Retrieve lines that are pending to be invoiced", + "summary": "linestobeinvoiced 1.0", + "operationId": "getconnector-linestobeinvoiced-get-1.0", + "parameters": [ + { + "in": "query", + "name": "BusinessActivityVersion", + "schema": { + "type": "integer" + } + }, + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "InstanceId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationNumber": { + "type": "string" + }, + "RelationDescription": { + "type": "string" + }, + "ProductId": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + }, + "Quantity": { + "type": "number" + }, + "Price": { + "type": "number" + }, + "TotalAmount": { + "type": "number" + }, + "ProjectId": { + "type": "string", + "format": "uuid" + }, + "ProjectDescription": { + "type": "string" + }, + "Status": { + "oneOf": [ + { + "const": "TODO", + "title": "te factureren" + }, + { + "const": "BUSY", + "title": "onderweg" + }, + { + "const": "DONE", + "title": "gefactureerd" + }, + { + "const": "DONEEDIT", + "title": "bezig met wijzigen van gefactureerd" + }, + { + "const": "DONEERROR", + "title": "in fout staat" + }, + { + "const": "REDO", + "title": "opnieuw te factureren" + }, + { + "const": "CANNOTBEDONE", + "title": "niet te factureren" + }, + { + "const": "CANNOTBEREDONE", + "title": "niet opnieuw te factureren" + }, + { + "const": "TOCREDIT", + "title": "te crediteren" + }, + { + "const": "CREDITED", + "title": "gecrediteerd" + }, + { + "const": "DELETED", + "title": "verwijderd" + }, + { + "const": "TODOERROR", + "title": "in fout staat" + }, + { + "const": "TODOEDIT", + "title": "bezig met wijzigen van te factureren" + }, + { + "const": "TODOPENDING", + "title": "bezig met wachten" + }, + { + "const": "REPLACED", + "title": "gespecificeerd" + }, + { + "const": "TOSPECIFY", + "title": "af te letteren" + }, + { + "const": "SPECIFIED", + "title": "afgeletterd" + }, + { + "const": "ALTERNATIVELYSPECIFIED", + "title": "alternatief gespecificeerd" + }, + { + "const": "INITIALIZED", + "title": "geïnitialiseerd" + }, + { + "const": "INITIALIZEDEDIT", + "title": "geïnitialiseerd" + }, + { + "const": "PENDINGAPPROVAL", + "title": "te accorderen" + }, + { + "const": "PENDINGCOMPLETION", + "title": "te factureren" + }, + { + "const": "COMPLETED", + "title": "gefactureerd" + }, + { + "const": "DECLINED", + "title": "afgewezen" + }, + { + "const": "TEMPLATE", + "title": "sjabloon" + }, + { + "const": "TEMPLATEEDIT", + "title": "bezig met wijzigen van factureren" + }, + { + "const": "TEMPLATEERROR", + "title": "in fout staat" + } + ] + }, + "SalesInvoiceNumber": { + "type": "string" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels" + ] + }, + "post": { + "description": "Create lines to be invoiced for billing processes", + "summary": "linestobeinvoiced 1.0", + "operationId": "updateconnector-linestobeinvoiced-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "linestobeinvoiced 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/linestobeinvoiced-1.0-Create-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels" + ] + }, + "delete": { + "description": "Delete lines to be invoiced from billing processes", + "summary": "linestobeinvoiced 1.0", + "operationId": "updateconnector-linestobeinvoiced-Delete-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "linestobeinvoiced 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/linestobeinvoiced-1.0-Delete-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels" + ] + }, + "put": { + "description": "Update lines to be invoiced for billing processes", + "summary": "linestobeinvoiced 1.0", + "operationId": "updateconnector-linestobeinvoiced-Put-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "linestobeinvoiced 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/linestobeinvoiced-1.0-Update-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels" + ] + } + }, + "/api/organisations": { + "get": { + "description": "Retrieve organization information and business details", + "summary": "organisations 2.0", + "operationId": "getconnector-organisations-get-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Name": { + "type": "string" + }, + "CocNumber": { + "type": "string" + }, + "VatNumber": { + "type": "string" + }, + "PhoneNumber": { + "type": "string" + }, + "EmailAddress": { + "type": "string" + }, + "SbiCode": { + "type": "string" + }, + "RelationId": { + "type": "string" + }, + "ExternalId": { + "type": "string" + }, + "IsArchived": { + "type": "boolean" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Inkoopjournaalpost", + "Publiek: Relatiemanagement", + "Relaties", + "Publiek: Facturatie", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/paymentconditions": { + "get": { + "description": "Retrieve payment conditions and terms settings", + "summary": "paymentconditions 1.0", + "operationId": "getconnector-paymentconditions-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Inkoopjournaalpost", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/persons": { + "get": { + "description": "Retrieve person information and personal details", + "summary": "persons 2.0", + "operationId": "getconnector-persons-get-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Name": { + "type": "string" + }, + "FirstName": { + "type": "string" + }, + "Initials": { + "type": "string" + }, + "Prefix": { + "type": "string" + }, + "Lastname": { + "type": "string" + }, + "PhoneNumber": { + "type": "string" + }, + "EmailAddress": { + "type": "string" + }, + "ExternalId": { + "type": "string" + }, + "IsArchived": { + "type": "boolean" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Inkoopjournaalpost", + "Publiek: Relatiemanagement", + "Relaties", + "Publiek: Facturatie", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/products": { + "get": { + "description": "Retrieve product catalog with pricing and inventory information", + "summary": "products 3.0", + "operationId": "getconnector-products-get-3.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "3.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "Id": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + }, + "Code": { + "type": "string" + }, + "InternalId": { + "type": "string" + }, + "PriceExcludingVAT": { + "type": "number" + }, + "PriceIncludingVAT": { + "type": "number" + }, + "ProductGroup": { + "type": "string" + }, + "Barcode": { + "type": "string" + }, + "Category": { + "type": "string" + }, + "ExtraDescription": { + "type": "string" + }, + "ProductStyle": { + "oneOf": [ + { + "const": "AantalVanSoort", + "title": "aantal van soort" + }, + { + "const": "Afdeling", + "title": "afdeling" + }, + { + "const": "Bankrekening", + "title": "bankrekening" + }, + { + "const": "Contactpersoon", + "title": "contactpersoon" + }, + { + "const": "Deelname", + "title": "deelname" + }, + { + "const": "Gegeven", + "title": "gegeven" + }, + { + "const": "Goed", + "title": "goed" + }, + { + "const": "Kas", + "title": "kas" + }, + { + "const": "Kosten", + "title": "kosten" + }, + { + "const": "Land", + "title": "land" + }, + { + "const": "Onbekend", + "title": "onbekend" + }, + { + "const": "Organisatie", + "title": "organisatie" + }, + { + "const": "Persoon", + "title": "persoon" + }, + { + "const": "Ruimte", + "title": "ruimte" + }, + { + "const": "Tijd", + "title": "tijd" + } + ] + }, + "IsArchived": { + "type": "boolean" + }, + "IsBlocked": { + "type": "boolean" + }, + "IsDisabled": { + "type": "boolean" + }, + "Blob": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "ReadKey": { + "type": "string" + }, + "FileName": { + "type": "string" + }, + "ContentType": { + "type": "string" + }, + "ContentLength": { + "type": "number" + } + } + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "3.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Publiek: Facturatie", + "Verkoopfactuur" + ] + } + }, + "/api/projects": { + "get": { + "description": "Retrieve project information for time tracking and billing", + "summary": "projects 1.0", + "operationId": "getconnector-projects-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "Omschrijving": { + "type": "string" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels" + ] + } + }, + "/api/salesinvoices": { + "get": { + "description": "Retrieve sales invoices and billing information", + "summary": "salesinvoices 1.1", + "operationId": "getconnector-salesinvoices-get-1.1", + "parameters": [ + { + "in": "query", + "name": "BusinessActivityVersion", + "schema": { + "type": "integer" + } + }, + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.1" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "InstanceId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "InstanceId": { + "type": "string", + "format": "uuid" + }, + "SalesInvoiceNumber": { + "type": "string" + }, + "IssueDate": { + "type": "string", + "format": "date-time" + }, + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationNumber": { + "type": "string" + }, + "RelationDescription": { + "type": "string" + }, + "Status": { + "oneOf": [ + { + "const": "TODO", + "title": "te verzenden" + }, + { + "const": "BUSY", + "title": "onderweg" + }, + { + "const": "DONE", + "title": "verzonden" + }, + { + "const": "DONEEDIT", + "title": "bezig met wijzigen van verzonden" + }, + { + "const": "DONEERROR", + "title": "in fout staat" + }, + { + "const": "REDO", + "title": "opnieuw te verzenden" + }, + { + "const": "CANNOTBEDONE", + "title": "niet te verzenden" + }, + { + "const": "CANNOTBEREDONE", + "title": "niet opnieuw te verzenden" + }, + { + "const": "TOCREDIT", + "title": "te crediteren" + }, + { + "const": "CREDITED", + "title": "gecrediteerd" + }, + { + "const": "DELETED", + "title": "verwijderd" + }, + { + "const": "TODOERROR", + "title": "in fout staat" + }, + { + "const": "TODOEDIT", + "title": "bezig met wijzigen van te verzenden" + }, + { + "const": "TODOPENDING", + "title": "bezig met wachten" + }, + { + "const": "REPLACED", + "title": "gespecificeerd" + }, + { + "const": "TOSPECIFY", + "title": "af te letteren" + }, + { + "const": "SPECIFIED", + "title": "afgeletterd" + }, + { + "const": "ALTERNATIVELYSPECIFIED", + "title": "alternatief gespecificeerd" + }, + { + "const": "INITIALIZED", + "title": "geïnitialiseerd" + }, + { + "const": "INITIALIZEDEDIT", + "title": "geïnitialiseerd" + }, + { + "const": "PENDINGAPPROVAL", + "title": "te accorderen" + }, + { + "const": "PENDINGCOMPLETION", + "title": "te factureren" + }, + { + "const": "COMPLETED", + "title": "gefactureerd" + }, + { + "const": "DECLINED", + "title": "afgewezen" + }, + { + "const": "TEMPLATE", + "title": "sjabloon" + }, + { + "const": "TEMPLATEEDIT", + "title": "bezig met wijzigen van verzenden" + }, + { + "const": "TEMPLATEERROR", + "title": "in fout staat" + }, + { + "const": "MESSAGEPENDING", + "title": "Bezig met verzenden" + }, + { + "const": "MESSAGESEND", + "title": "Verzonden" + }, + { + "const": "MESSAGEFAILED", + "title": "Fout bij verzenden" + } + ] + }, + "Blob": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "ReadKey": { + "type": "string" + }, + "FileName": { + "type": "string" + }, + "ContentType": { + "type": "string" + }, + "ContentLength": { + "type": "number" + } + } + } + }, + "AmountExcludingVat": { + "type": "number" + }, + "AmountVat": { + "type": "number" + }, + "AmountInvoiced": { + "type": "number" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.1", + "deprecated": false, + "tags": [ + "Publiek: Facturatie", + "Verkoopfactuur" + ] + } + }, + "/api/salespricesperrelation": { + "get": { + "description": "Retrieve sales prices configured per customer relation", + "summary": "salespricesperrelation 1.0", + "operationId": "getconnector-salespricesperrelation-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "ProductDescription": { + "type": "string" + }, + "PriceExcludingVAT": { + "type": "number" + }, + "StartDate": { + "type": "string", + "format": "date-time" + }, + "EndDate": { + "type": "string", + "format": "date-time" + }, + "RelationDescription": { + "type": "string" + }, + "ProductId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Publiek: Facturatie", + "Verkoopfactuur" + ] + } + }, + "/api/salesrelations": { + "get": { + "description": "Retrieve sales relations and customer account information", + "summary": "salesrelations 1.0", + "operationId": "getconnector-salesrelations-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "AdministrationId Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid" + }, + "RelationTypeId": { + "type": "string", + "format": "uuid" + }, + "RelationId": { + "type": "string", + "format": "uuid" + }, + "RelationNumber": { + "type": "string" + }, + "RelationDescription": { + "type": "string" + }, + "VatNumber": { + "type": "string" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels" + ] + } + }, + "/api/unknownrelation": { + "get": { + "description": "Retrieve unknown relation for invoicing without known name or address", + "summary": "unknownrelation 1.0", + "operationId": "getconnector-unknownrelation-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Name": { + "type": "string" + }, + "SalesRelation": { + "type": "boolean" + }, + "PurchaseRelation": { + "type": "boolean" + }, + "IsBlocked": { + "type": "boolean" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Verkoopregels", + "Inkoopjournaalpost", + "Publiek: Facturatie", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/vatrate": { + "get": { + "description": "Retrieve VAT rates and tax calculation settings", + "summary": "vatrate 1.0", + "operationId": "getconnector-vatrate-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost" + ] + } + }, + "/api/vattype": { + "get": { + "description": "Retrieve VAT types and tax category classifications", + "summary": "vattype 1.0", + "operationId": "getconnector-vattype-get-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "AccessToken", + "schema": { + "type": "string" + }, + "required": false + }, + { + "in": "query", + "name": "Skip", + "schema": { + "type": "integer", + "example": "0" + } + }, + { + "in": "query", + "name": "Take", + "schema": { + "type": "integer", + "example": "50" + } + }, + { + "in": "query", + "name": "Sort", + "schema": { + "type": "string", + "format": "sort", + "example": "Id Ascending" + }, + "description": "FieldName Ascending|Descending" + }, + { + "in": "query", + "name": "Filter", + "schema": { + "type": "string", + "format": "filter" + }, + "required": false, + "description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "format": "uuid" + }, + "Description": { + "type": "string" + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost" + ] + } + }, + "/api/address": { + "post": { + "description": "Create new address information for organizations and persons", + "summary": "address 1.0", + "operationId": "updateconnector-address-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "address 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/address-1.0-Create-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Relaties" + ] + } + }, + "/api/bankaccount": { + "post": { + "description": "Create new bank account information for financial transactions", + "summary": "bankaccount 1.0", + "operationId": "updateconnector-bankaccount-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "bankaccount 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/bankaccount-1.0-Create-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Relaties" + ] + } + }, + "/api/cashmutation": { + "post": { + "description": "Create cash mutations for cash register transactions", + "summary": "cashmutation 3.0", + "operationId": "updateconnector-cashmutation-Post-3.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "3.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "cashmutation 3.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/cashmutation-3.0-Create-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "3.0", + "deprecated": false, + "tags": [ + "Publiek: POS Transacties", + "POS Transacties" + ] + } + }, + "/api/contact": { + "post": { + "description": "Contact", + "summary": "contact 2.0", + "operationId": "updateconnector-contact-Post-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "contact 2.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/contact-2.0-Create-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Relaties" + ] + } + }, + "/api/emailaddress": { + "post": { + "description": "CreateEmailAddress", + "summary": "emailaddress 2.0", + "operationId": "updateconnector-emailaddress-Post-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "emailaddress 2.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/emailaddress-2.0-Create-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Relaties" + ] + } + }, + "/api/financialjournalentry": { + "post": { + "description": "Create financial journal entries for bookkeeping", + "summary": "financialjournalentry 1.0", + "operationId": "updateconnector-financialjournalentry-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "financialjournalentry 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/financialjournalentry-1.0-Create-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële journaalpost", + "Financiële journaalpost" + ] + }, + "delete": { + "description": "Delete financial journal entries from bookkeeping", + "summary": "financialjournalentry 1.0", + "operationId": "updateconnector-financialjournalentry-Delete-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "financialjournalentry 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/financialjournalentry-1.0-Delete-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Financiële journaalpost", + "Financiële journaalpost" + ] + } + }, + "/api/mandates": { + "post": { + "description": "Create SEPA direct debit mandates for automated payments", + "summary": "mandates 1.0", + "operationId": "updateconnector-mandates-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "mandates 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/mandates-1.0-Create-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Publiek: Facturatie", + "Verkoopfactuur", + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/organisation": { + "post": { + "description": "Create new organization records and business relationships", + "summary": "organisation 4.0", + "operationId": "updateconnector-organisation-Post-4.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "4.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "organisation 4.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/organisation-4.0-Create-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "4.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Inkoopjournaalpost", + "Relaties", + "Publiek: Externe facturatie" + ] + }, + "put": { + "description": "Update existing organization records and business relationships", + "summary": "organisation 4.0", + "operationId": "updateconnector-organisation-Put-4.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "4.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "organisation 4.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/organisation-4.0-Update-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "4.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Inkoopjournaalpost", + "Relaties", + "Publiek: Externe facturatie" + ] + } + }, + "/api/payrolljournalentry": { + "post": { + "description": "Create payroll journal entries for salary processing", + "summary": "payrolljournalentry 1.0", + "operationId": "updateconnector-payrolljournalentry-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "payrolljournalentry 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/payrolljournalentry-1.0-Create-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Loonjournaalpost" + ] + } + }, + "/api/person": { + "post": { + "description": "Create new person records and personal relationships", + "summary": "person 4.0", + "operationId": "updateconnector-person-Post-4.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "4.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "person 4.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/person-4.0-Create-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "4.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Inkoopjournaalpost", + "Relaties", + "Publiek: Externe facturatie" + ] + }, + "put": { + "description": "Update existing person records and personal relationships", + "summary": "person 4.0", + "operationId": "updateconnector-person-Put-4.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "4.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "person 4.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/person-4.0-Update-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "4.0", + "deprecated": false, + "tags": [ + "Publiek: Externe verkoopregels", + "Inkoopjournaalpost", + "Relaties", + "Publiek: Externe facturatie" + ] + } + }, + "/api/phonenumber": { + "post": { + "description": "CreatePhoneNumber", + "summary": "phonenumber 1.0", + "operationId": "updateconnector-phonenumber-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "phonenumber 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/phonenumber-1.0-Create-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Relaties" + ] + } + }, + "/api/purchasejournalentry": { + "post": { + "description": "Create purchase journal entries for supplier transactions (C# script version)", + "summary": "purchasejournalentry 2.0", + "operationId": "updateconnector-purchasejournalentry-Post-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "purchasejournalentry 2.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/purchasejournalentry-2.0-Create-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost" + ] + } + }, + "/api/salesinvoice": { + "post": { + "description": "Create sales invoices for customer billing", + "summary": "salesinvoice 2.0", + "operationId": "updateconnector-salesinvoice-Post-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "salesinvoice 2.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/salesinvoice-2.0-Create-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Publiek: Facturatie", + "Verkoopfactuur" + ] + }, + "delete": { + "description": "Delete sales invoices from customer billing", + "summary": "salesinvoice 2.0", + "operationId": "updateconnector-salesinvoice-Delete-2.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "salesinvoice 2.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/salesinvoice-2.0-Delete-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.0", + "deprecated": false, + "tags": [ + "Publiek: Facturatie", + "Verkoopfactuur" + ] + } + }, + "/api/salesjournalentry": { + "post": { + "description": "Create sales journal entries for customer transactions", + "summary": "salesjournalentry 2.1", + "operationId": "updateconnector-salesjournalentry-Post-2.1", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.1" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "salesjournalentry 2.1", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/salesjournalentry-2.1-Create-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.1", + "deprecated": false, + "tags": [ + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + }, + "delete": { + "description": "Delete sales journal entries from customer transactions", + "summary": "salesjournalentry 2.1", + "operationId": "updateconnector-salesjournalentry-Delete-2.1", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.1" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "salesjournalentry 2.1", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/salesjournalentry-2.1-Delete-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.1", + "deprecated": false, + "tags": [ + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + }, + "put": { + "description": "Update sales journal entries for customer transactions", + "summary": "salesjournalentry 2.1", + "operationId": "updateconnector-salesjournalentry-Put-2.1", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "2.1" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "salesjournalentry 2.1", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/salesjournalentry-2.1-Update-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "2.1", + "deprecated": false, + "tags": [ + "Publiek: Externe facturatie", + "Verkoopjournaalpost" + ] + } + }, + "/api/supplier": { + "post": { + "description": "Create new supplier relationships and vendor setup", + "summary": "supplier 1.0", + "operationId": "updateconnector-supplier-Post-1.0", + "parameters": [ + { + "in": "header", + "name": "Accept", + "schema": { + "type": "string", + "example": "application/xml" + } + }, + { + "in": "header", + "name": "Accept-Version", + "schema": { + "type": "string", + "example": "1.0" + } + }, + { + "in": "header", + "name": "Tracking-Identifier", + "schema": { + "type": "uuid", + "example": "8522fea1-a067-4851-9b8e-a7b7080ac3af" + }, + "required": false, + "description": "Add your own uuid to the request and ensure that the request only gets processed once. The uuid must be unique for each request. The response will be the same as the first response." + } + ], + "requestBody": { + "description": "supplier 1.0", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/requestBodies/supplier-1.0-Create-JsonSchema" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + }, + "5XX": { + "description": "Internal Server Error" + } + }, + "version": "1.0", + "deprecated": false, + "tags": [ + "Inkoopjournaalpost" + ] + } + } + }, + "tags": [ + { + "name": "Autorisatie", + "description": "Endpoints voor autorisatie" + }, + { + "name": "Bijlagen", + "description": "Endpoints voor bijlagen" + }, + { + "name": "Publiek: Admin center data", + "description": "Admin center data connectoren" + }, + { + "name": "Crediteuren", + "description": "Crediteuren connectoren" + }, + { + "name": "Debiteuren", + "description": "Debiteuren connectoren" + }, + { + "name": "Publiek: Financiële dashboarding", + "description": "Financiële dashboarding voor publieke api" + }, + { + "name": "Publiek: Financiële journaalpost", + "description": "Financiële journaalpost voor publieke api" + }, + { + "name": "Financiële journaalpost", + "description": "Financiële journaalpost connectors" + }, + { + "name": "Publiek: Financiële rapportage", + "description": "Financiële rapportage voor publieke api" + }, + { + "name": "Financiele rapportage", + "description": "Financiele rapportage connectoren" + }, + { + "name": "Publiek: Externe verkoopregels", + "description": "Verkoopregels voor publieke api" + }, + { + "name": "Verkoopregels", + "description": "Verkoopregels connectors" + }, + { + "name": "Loonjournaalpost", + "description": "Loonjournaalpost connectors" + }, + { + "name": "Publiek: POS Transacties", + "description": "POS transacties voor publieke api" + }, + { + "name": "POS Transacties", + "description": "POS transacties" + }, + { + "name": "Inkoopjournaalpost", + "description": "Inkoopjournaalpost connectors" + }, + { + "name": "Publiek: Relatiemanagement", + "description": "Relatiemanagement voor publieke api" + }, + { + "name": "Relaties", + "description": "Relatie connectors" + }, + { + "name": "Publiek: Facturatie", + "description": "Facturatie voor publieke api" + }, + { + "name": "Verkoopfactuur", + "description": "Verkoopfactuur connectors" + }, + { + "name": "Publiek: Externe facturatie", + "description": "Externe facturatie voor publieke api" + }, + { + "name": "Verkoopjournaalpost", + "description": "Verkoopjournaalpost connectors" + }, + { + "name": "TechnischeInfo", + "description": "Technische informatie" + } + ], + "components": { + "securitySchemes": { + "oAuth2": { + "type": "oauth2", + "flows": { + "authorizationCode": { + "authorizationUrl": "https://{{domain}}.afasfocus.nl/{{customerenvironment}}/app/auth", + "tokenUrl": "https://{{domain}}.afasfocus.nl/{{customerenvironment}}/app/token", + "scopes": {} + } + } + } + }, + "requestBodies": { + "address-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "description": "Use this endpoint to create a new address for a person or organisation.", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "RelationType": { + "type": "string", + "description": "Must contain one of the enums. Will be required in a future version.", + "enum": [ + "organisation", + "person" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation or person. Will be required in a future version.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + } + }, + "examples": [ + { + "RelationType": "organisation", + "RelationId": "c8a288c1-3dbb-483d-840d-9cc601368a92", + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "a", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL" + } + ] + }, + "bankaccount-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "description": "Use this endpoint to create a new bankaccount data for a person or organisation.", + "required": [ + "AccountNumber", + "AccountHolderName", + "CountryCode", + "RelationType", + "RelationId" + ], + "properties": { + "RelationType": { + "type": "string", + "description": "Must contain one of the enums. Will be required in a future version.", + "enum": [ + "organisation", + "person" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation or person. Will be required in a future version.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL01RABO0123456789" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "RABO" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "RABONL2U" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "DE" + ] + }, + "AccountHolderName": { + "type": "string", + "default": "", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen" + ] + } + }, + "examples": [ + { + "RelationType": "organisation", + "RelationId": "c8a288c1-3dbb-483d-840d-9cc601368a92", + "AccountNumber": "NL01RABO0123456789", + "BankId": "RABO", + "Bic": "RABONL2U", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen" + } + ] + }, + "cashmutation-1.0-Create-JsonSchema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "description": "This endpoint allows you to add cash mutations directly from Point of Sale (POS) applications to the accounting software, streamlining the process of recording and managing cash transactions for businesses. For each cashmutation an request must be done.", + "properties": { + "administrationId": { + "type": "string", + "format": "uuid", + "description": "The Administration ID uniquely identifying an administration. Retrieve it from the endpoint: api/administration" + }, + "description": { + "type": "string", + "description": "The description providing information about the cash mutation and other bookings" + }, + "date": { + "type": "string", + "format": "date", + "description": "The date when the cash mutation and other bookings occurred" + }, + "ledgerAccountId": { + "type": "string", + "format": "uuid", + "description": "The Ledger Account ID uniquely identifying a ledger account. Retrieve it from the endpoint: api/ledgeraccounts" + }, + "amountIncludingVat": { + "type": "number", + "multipleOf": 0.01, + "description": "The amount including VAT for the cash mutation and other bookings" + }, + "vatPercentage": { + "type": "integer", + "description": "The percentage of VAT applied to the cash mutation and other bookings" + }, + "vatTarive": { + "type": "string", + "enum": [ + "high", + "low", + "zero" + ], + "description": "The VAT tarive/category - 'high', 'low', or 'zero'" + }, + "vatType": { + "type": "string", + "enum": [ + "purchase", + "sales" + ], + "description": "The type of VAT operation - 'purchase' or 'sales'" + }, + "attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "required": [ + "attachmentId" + ], + "properties": { + "attachmentId": { + "type": "string", + "format": "uuid" + } + } + } + } + }, + "required": [ + "administrationId", + "description", + "date", + "amountIncludingVat" + ] + }, + "cashmutation-2.0-Create-JsonSchema": { + "$schema": "http://json-schema.org/draft-07/schema", + "type": "object", + "description": "This endpoint allows you to add cash mutations directly from Point of Sale (POS) applications to the accounting software, streamlining the process of recording and managing cash transactions for businesses. For each cashmutation an request must be done.", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "The Administration ID uniquely identifying an administration. Retrieve it from the endpoint: api/administration" + }, + "Description": { + "type": "string", + "description": "The description providing information about the cash mutation and other bookings" + }, + "Date": { + "type": "string", + "format": "date", + "description": "The date when the cash mutation and other bookings occurred" + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "The Ledger Account ID uniquely identifying a ledger account. Retrieve it from the endpoint: api/ledgeraccounts" + }, + "AmountIncludingVat": { + "type": "number", + "multipleOf": 0.01, + "description": "The amount including VAT for the cash mutation and other bookings" + }, + "VatPercentage": { + "type": "integer", + "description": "The percentage of VAT applied to the cash mutation and other bookings" + }, + "VatTarive": { + "type": "string", + "enum": [ + "high", + "low", + "zero" + ], + "description": "The VAT tarive/category - 'high', 'low', or 'zero'" + }, + "VatType": { + "type": "string", + "enum": [ + "purchase", + "sales" + ], + "description": "The type of VAT operation - 'purchase' or 'sales'" + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid" + } + } + } + } + }, + "required": [ + "AdministrationId", + "Description", + "Date", + "AmountIncludingVat" + ] + }, + "cashmutation-3.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "This endpoint allows you to add cash mutations directly from Point of Sale (POS) applications to the accounting software, streamlining the process of recording and managing cash transactions for businesses. For each cashmutation an request must be done. Only the default cash location is supported.", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "The Administration ID uniquely identifying an administration. Retrieve it from the endpoint: api/administrations" + }, + "CashRegisterId": { + "type": "string", + "format": "uuid", + "description": "The CashRegister ID uniquely identifying an cash register. Retrieve it from the endpoint: api/cashregisters. Falls back to default when empty." + }, + "Description": { + "type": "string", + "description": "The description providing information about the cash mutation and other bookings" + }, + "Date": { + "type": "string", + "format": "date", + "description": "The date when the cash mutation and other bookings occurred" + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "The Ledger Account ID uniquely identifying a ledger account. Retrieve it from the endpoint: api/ledgeraccounts" + }, + "AmountIncludingVat": { + "type": "number", + "multipleOf": 0.01, + "description": "The amount including VAT for the cash mutation and other bookings" + }, + "VatTarive": { + "type": "string", + "enum": [ + "high", + "low", + "zero" + ], + "description": "The VAT tarive/category - 'high', 'low', or 'zero'" + }, + "VatType": { + "type": "string", + "enum": [ + "purchase", + "sales" + ], + "description": "The type of VAT operation - 'purchase' or 'sales'" + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid" + } + } + } + } + }, + "required": [ + "AdministrationId", + "Description", + "Date", + "AmountIncludingVat" + ] + }, + "contact-1.0-Create-JsonSchema": { + "type": "object", + "description": "Create a contact by organisation.", + "required": [ + "OrganisationId", + "Lastname" + ], + "properties": { + "OrganisationId": { + "type": "string", + "format": "uuid", + "examples": [ + "c3bf8c80-08ed-44ea-a842-661a9085d6bf" + ] + }, + "ContactId": { + "type": "string", + "format": "uuid", + "examples": [ + "880ed307-af2e-447d-8440-e26fed53ecc5" + ] + }, + "Firstname": { + "type": "string", + "examples": [ + "Maarten" + ] + }, + "Initials": { + "type": "string", + "examples": [ + "M.H." + ] + }, + "Prefix": { + "type": "string", + "examples": [ + "van" + ] + }, + "Lastname": { + "type": "string", + "examples": [ + "Zandbergen" + ] + }, + "emailaddress": { + "type": "string", + "format": "email", + "examples": [ + "Maarten@vanZandbergen.nl" + ] + }, + "phonenumber": { + "type": "string", + "examples": [ + "+31655887744" + ] + } + }, + "examples": [ + { + "OrganisationId": "c3bf8c80-08ed-44ea-a842-661a9085d6bf", + "Firstname": "Maarten", + "Initials": "M.H.", + "Prefix": "van", + "Lastname": "Zandbergen", + "emailaddress": "Maarten@vanZandbergen.nl", + "phonenumber": "+31655887744" + } + ] + }, + "contact-2.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a contact by organisation.", + "required": [ + "OrganisationId", + "LastName" + ], + "properties": { + "OrganisationId": { + "type": "string", + "format": "uuid", + "examples": [ + "c3bf8c80-08ed-44ea-a842-661a9085d6bf" + ] + }, + "ContactId": { + "type": "string", + "format": "uuid", + "examples": [ + "880ed307-af2e-447d-8440-e26fed53ecc5" + ] + }, + "FirstName": { + "type": "string", + "examples": [ + "Maarten" + ] + }, + "Initials": { + "type": "string", + "examples": [ + "M.H." + ] + }, + "Prefix": { + "type": "string", + "examples": [ + "van" + ] + }, + "LastName": { + "type": "string", + "examples": [ + "Zandbergen" + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "examples": [ + "Maarten@vanZandbergen.nl" + ] + }, + "PhoneNumber": { + "type": "string", + "examples": [ + "+31655887744" + ] + } + }, + "examples": [ + { + "OrganisationId": "c3bf8c80-08ed-44ea-a842-661a9085d6bf", + "FirstName": "Maarten", + "Initials": "M.H.", + "Prefix": "van", + "LastName": "Zandbergen", + "EmailAddress": "Maarten@vanZandbergen.nl", + "PhoneNumber": "+31655887744" + } + ] + }, + "emailaddress-1.0-Create-JsonSchema": { + "type": "object", + "x-examples": { + "Example 1": { + "OrganisationId": "8f03496b-1f42-5ac3-a770-91f9da4e6e12", + "EmailAddress": "j.zandbergen@afasSbPlus.nl" + } + }, + "title": "EmailAddress", + "examples": [ + { + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "EmailAddress": "user@example.com" + } + ], + "properties": { + "OrganisationId": { + "type": "string", + "format": "uuid", + "example": "32abaca0-b4c6-4dce-af80-9de42a830e62" + }, + "EmailAddress": { + "type": "string", + "format": "email" + } + }, + "required": [ + "EmailAddress", + "OrganisationId" + ], + "description": "Create an emailaddress for an organisation." + }, + "emailaddress-2.0-Create-JsonSchema": { + "type": "object", + "x-examples": { + "Organiation": { + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "EmailAddress": "user@example.com" + }, + "Person": { + "RelationType": "person", + "RelationId": "963578e8-7831-4aa4-83c4-e7c3262f0572", + "EmailAddress": "user@example.com" + } + }, + "title": "EmailAddress", + "properties": { + "RelationType": { + "type": "string", + "description": "Must contain one of the enums. Will be required in a future version.", + "enum": [ + "organisation", + "person" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation or person. Will be required in a future version.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "EmailAddress": { + "type": "string", + "format": "email" + } + }, + "required": [ + "EmailAddress", + "RelationType", + "RelationId" + ], + "description": "Create an emailaddress for an organisation or person." + }, + "financialjournalentry-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a financial journal entry.", + "required": [ + "AdministrationId", + "EntryDate", + "Description", + "EntryLine" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "EntryDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-10-12" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntry.", + "examples": [ + "Example Journal 001" + ] + }, + "Attachments": { + "type": "array", + "default": [], + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "default": {}, + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + } + }, + "EntryLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "default": {}, + "required": [ + "LedgerAccountId" + ], + "properties": { + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntryLine.", + "examples": [ + "Sales with high vat type" + ] + }, + "AmountDebit": { + "type": "number", + "multipleOf": 0.01, + "examples": [ + 100.26 + ] + }, + "AmountCredit": { + "type": "number", + "multipleOf": 0.01, + "examples": [ + 100.64 + ] + }, + "VatDirection": { + "type": "string", + "enum": [ + "sales", + "purchases", + "", + "null" + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "special", + "zero", + "", + "null" + ] + }, + "PeriodAllocation": { + "type": "boolean", + "description": "Apportion over a period", + "default": false + }, + "PeriodAllocationBeginDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-01-01" + ] + }, + "PeriodAllocationEndDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + } + }, + "allOf": [ + { + "if": { + "properties": { + "PeriodAllocation": { + "const": true + } + }, + "required": [ + "PeriodAllocation" + ] + }, + "then": { + "required": [ + "PeriodAllocationBeginDate", + "PeriodAllocationEndDate" + ] + } + }, + { + "anyOf": [ + { + "required": [ + "AmountDebit" + ], + "not": { + "required": [ + "AmountCredit" + ] + } + }, + { + "required": [ + "AmountCredit" + ], + "not": { + "required": [ + "AmountDebit" + ] + } + } + ] + } + ] + } + } + } + }, + "financialjournalentry-1.0-Delete-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Delete a financialjournalentry", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of financialjournalentry.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + } + ] + }, + "linestobeinvoiced-1.0-Create-JsonSchema": { + "type": "object", + "description": "Create a line to be invoiced", + "required": [ + "AdministrationId", + "Date", + "Description", + "RelationType", + "RelationId", + "Quantity" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Date": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "Description": { + "type": "string", + "description": "Must contain a description for the Line to be invoiced.", + "examples": [ + "Productomschrijving" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "format": "uuid" + }, + "ItemId": { + "type": "string", + "description": "Must contain Product guid. This can be retrieved through the products endpoint.", + "format": "uuid" + }, + "Quantity": { + "type": "number", + "description": "Quantity of products of this type", + "multipleOf": 0.01 + }, + "Price": { + "type": [ + "number", + "null" + ], + "description": "Price per product, may be left empty if product with price is provided", + "minimum": 0, + "multipleOf": 0.01 + }, + "ProjectId": { + "type": "string", + "description": "Must contain the guid of the project.", + "format": "uuid" + } + } + }, + "linestobeinvoiced-1.0-Delete-JsonSchema": { + "type": "object", + "description": "Delete a line to be invoiced", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of line to be invoiced.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + } + ] + }, + "linestobeinvoiced-1.0-Update-JsonSchema": { + "type": "object", + "description": "Update a line to be invoiced", + "required": [ + "AdministrationId", + "LineToBeInvoicedId", + "Date", + "Description", + "RelationType", + "RelationId", + "Quantity" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "LineToBeInvoicedId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the line to be invoiced", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Date": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the Line to be invoiced.", + "examples": [ + "Example Journal 001" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "format": "uuid" + }, + "ItemId": { + "type": "string", + "description": "Must contain Product guid. This can be retrieved through the products endpoint.", + "format": "uuid" + }, + "Quantity": { + "type": "number", + "description": "Quantity of products of this type", + "multipleOf": 0.01 + }, + "Price": { + "type": [ + "number", + "null" + ], + "description": "Price per product, may be left empty if product with price is provided", + "minimum": 0, + "multipleOf": 0.01 + }, + "ProjectId": { + "type": "string", + "description": "Must contain the guid of the project.", + "format": "uuid" + } + } + }, + "mandates-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create mandate for direct debit payments.", + "required": [ + "AdministrationId", + "RelationType", + "RelationId", + "RelationBankAccountId", + "DateOfSignature" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "RelationBankAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the bankaccount id of the organisation or person.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "AdministrationBankAccountId": { + "type": "string", + "format": "uuid", + "description": "Can contain the guid bankaccount of administration. If none provided de default bankaccount is used.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "MandateReference": { + "type": "string", + "description": "Can contain a reference of the mandates.If none provided an autonumber is used.", + "examples": [ + "Contractnr.FL-23904/P" + ] + }, + "DateOfSignature": { + "type": "string", + "description": "Must contain a date of signature/ approval.", + "format": "date", + "examples": [ + "2025-12-31" + ] + }, + "Attachments": { + "type": "array", + "default": [], + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "default": {}, + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "PeriodOfValidity": { + "type": "boolean", + "description": "Valid over a period", + "default": false + }, + "PeriodOfValidityBeginDate": { + "type": "string", + "format": "date", + "examples": [ + "2025-01-01" + ] + }, + "PeriodOfValidityEndDate": { + "type": "string", + "format": "date", + "examples": [ + "2025-12-31" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "RelationBankAccountId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "AdministrationBankAccountId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "MandateReference": "Contractnr.FL-23904/P", + "DateOfSignature": "2024-12-31", + "Attachments": [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ], + "PeriodOfValidity": true, + "PeriodOfValidityBeginDate": "2025-01-01", + "PeriodOfValidityEndDate": "2025-12-31" + } + ] + }, + "organisation-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "title": "Organisation", + "description": "A JSON schema to represent an organization", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the organisation", + "minLength": 1 + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application." + }, + "cocNumber": { + "type": "string", + "description": "The Chamber of Commerce (CoC) number of the organisation", + "pattern": "^[0-9]+$" + }, + "vatNumber": { + "type": "string", + "description": "The Value-Added Tax (VAT) number of the organisation", + "pattern": "^[A-Z0-9]+$" + }, + "tradename": { + "type": "string", + "description": "The tradename of the organisation" + }, + "sbiCode": { + "type": "string", + "description": "The SBICode of the organisation" + }, + "emailAddress": { + "type": "string", + "format": "email", + "description": "The email address of the organisation" + }, + "website": { + "type": "string", + "format": "uri", + "description": "The website of the organisation" + }, + "phoneNumber": { + "type": "string", + "description": "The phone number of the organisation" + }, + "address": { + "type": "array", + "default": [], + "title": "The address Schema", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "preferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "preferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "preferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "bankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for an organisation", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "AccountHolderName" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "AccountHolderName": { + "type": "string", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen", + "Jan Zandbergen" + ] + }, + "preferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "preferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "name": "Cremin Group", + "cocNumber": "38012622", + "vatNumber": "NL003276211B01", + "tradename": "Quitzon, Schinner and Jakubowski", + "emailAddress": "Kirsten_Bogisich27@example.org", + "website": "http://antoinette.name", + "phoneNumber": "758-646-8786", + "address": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "preferredSupplierAddress": true, + "preferredShippingAddress": false, + "preferredBillingAddress": true + }, + { + "StreetName": "inspiratielaan", + "HouseNumber": 3, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "preferredSupplierAddress": false, + "preferredShippingAddress": true, + "preferredBillingAddress": false + } + ], + "bankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen", + "preferredOutgoingPayments": true, + "preferredIncommingPayments": true + }, + { + "AccountNumber": "NL44DNIB0736664289", + "BankId": "DNIB", + "Bic": "DNIBNL2G", + "CountryCode": "NL", + "AccountHolderName": "Jan Zandbergen", + "preferredOutgoingPayments": false, + "preferredIncommingPayments": false + } + ] + } + ] + }, + "organisation-1.0-Update-JsonSchema": { + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "https://example.com/organization-update-schema", + "type": "object", + "title": "Organization Update Schema", + "description": "A schema for updating the information of an organization, including its name, external identifier, Chamber of Commerce number, and Value-Added Tax number.", + "properties": { + "name": { + "type": "string", + "description": "The name of the organisation", + "minLength": 1, + "maxLength": 100 + }, + "externalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application" + }, + "cocNumber": { + "type": "string", + "pattern": "^[0-9]{8}$", + "description": "The Chamber of Commerce (CoC) number of the organisation" + }, + "vatNumber": { + "type": "string", + "pattern": "^[A-Z0-9]+$", + "description": "The Value-Added Tax (VAT) number of the organisation" + } + } + }, + "organisation-2.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "title": "Organisation", + "description": "A JSON schema to represent an organization", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string", + "description": "The name of the organisation", + "minLength": 1 + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application." + }, + "CocNumber": { + "type": "string", + "description": "The Chamber of Commerce (CoC) number of the organisation", + "pattern": "^[0-9]+$" + }, + "VatNumber": { + "type": "string", + "description": "The Value-Added Tax (VAT) number of the organisation", + "pattern": "^[A-Z0-9]+$" + }, + "Tradename": { + "type": "string", + "description": "The tradename of the organisation" + }, + "SbiCode": { + "type": "string", + "description": "The SBICode of the organisation" + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The email address of the organisation" + }, + "Website": { + "type": "string", + "format": "uri", + "description": "The website of the organisation" + }, + "PhoneNumber": { + "type": "string", + "description": "The phone number of the organisation" + }, + "Addresses": { + "type": "array", + "default": [], + "title": "The address Schema", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for an organisation", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "AccountHolderName" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "AccountHolderName": { + "type": "string", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen", + "Jan Zandbergen" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "Name": "Cremin Group", + "CocNumber": "38012622", + "VatNumber": "NL003276211B01", + "Tradename": "Quitzon, Schinner and Jakubowski", + "EmailAddress": "Kirsten_Bogisich27@example.org", + "Website": "http://antoinette.name", + "PhoneNumber": "758-646-8786", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "inspiratielaan", + "HouseNumber": 3, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL44DNIB0736664289", + "BankId": "DNIB", + "Bic": "DNIBNL2G", + "CountryCode": "NL", + "AccountHolderName": "Jan Zandbergen", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "organisation-3.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "title": "Organisation", + "description": "A JSON schema to represent an organization", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string", + "description": "The name of the organisation", + "minLength": 1 + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application." + }, + "CocNumber": { + "type": "string", + "description": "The Chamber of Commerce (CoC) number of the organisation", + "pattern": "^[0-9]+$" + }, + "VatNumber": { + "type": "string", + "description": "The Value-Added Tax (VAT) number of the organisation", + "pattern": "^[A-Z0-9]+$" + }, + "Tradename": { + "type": "string", + "description": "The tradename of the organisation" + }, + "SbiCode": { + "type": "string", + "description": "The SBICode of the organisation" + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The email address of the organisation" + }, + "Website": { + "type": "string", + "format": "uri", + "description": "The website of the organisation" + }, + "PhoneNumber": { + "type": "string", + "description": "The phone number of the organisation" + }, + "Addresses": { + "type": "array", + "default": [], + "title": "The address Schema", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for an organisation", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "AccountHolderName" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "AccountHolderName": { + "type": "string", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen", + "Jan Zandbergen" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "Name": "Cremin Group", + "CocNumber": "38012622", + "VatNumber": "NL003276211B01", + "Tradename": "Quitzon, Schinner and Jakubowski", + "EmailAddress": "Kirsten_Bogisich27@example.org", + "Website": "http://antoinette.name", + "PhoneNumber": "758-646-8786", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "inspiratielaan", + "HouseNumber": 3, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL44DNIB0736664289", + "BankId": "DNIB", + "Bic": "DNIBNL2G", + "CountryCode": "NL", + "AccountHolderName": "Jan Zandbergen", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "organisation-3.0-Update-JsonSchema": { + "type": "object", + "default": {}, + "title": "Organisation", + "description": "A JSON schema to represent an organization", + "required": [ + "RelationId" + ], + "properties": { + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "Name": { + "type": "string", + "description": "The name of the organisation" + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application." + }, + "CocNumber": { + "type": "string", + "description": "The Chamber of Commerce (CoC) number of the organisation", + "pattern": "^[0-9]+$" + }, + "VatNumber": { + "type": "string", + "description": "The Value-Added Tax (VAT) number of the organisation", + "pattern": "^[A-Z0-9]+$" + }, + "Tradename": { + "type": "string", + "description": "The tradename of the organisation" + }, + "SbiCode": { + "type": "string", + "description": "The SBICode of the organisation" + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The email address of the organisation" + }, + "Website": { + "type": "string", + "format": "uri", + "description": "The website of the organisation" + }, + "PhoneNumber": { + "type": "string", + "description": "The phone number of the organisation" + }, + "Addresses": { + "type": "array", + "default": [], + "title": "The address Schema", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for an organisation", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "AccountHolderName" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "AccountHolderName": { + "type": "string", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen", + "Jan Zandbergen" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "Name": "Cremin Group", + "CocNumber": "38012622", + "VatNumber": "NL003276211B01", + "Tradename": "Quitzon, Schinner and Jakubowski", + "EmailAddress": "Kirsten_Bogisich27@example.org", + "Website": "http://antoinette.name", + "PhoneNumber": "758-646-8786", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "inspiratielaan", + "HouseNumber": 3, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL44DNIB0736664289", + "BankId": "DNIB", + "Bic": "DNIBNL2G", + "CountryCode": "NL", + "AccountHolderName": "Jan Zandbergen", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "organisation-4.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "title": "Organisation", + "description": "A JSON schema to represent an organization", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string", + "description": "The name of the organisation", + "minLength": 1 + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application." + }, + "CocNumber": { + "type": "string", + "description": "The Chamber of Commerce (CoC) number of the organisation", + "pattern": "^[0-9]+$" + }, + "VatNumber": { + "type": "string", + "description": "The Value-Added Tax (VAT) number of the organisation", + "pattern": "^[A-Z0-9]+$" + }, + "Tradename": { + "type": "string", + "description": "The tradename of the organisation" + }, + "SbiCode": { + "type": "string", + "description": "The SBICode of the organisation" + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The email address of the organisation" + }, + "Website": { + "type": "string", + "description": "The website of the organisation" + }, + "PhoneNumber": { + "type": "string", + "description": "The phone number of the organisation" + }, + "Addresses": { + "type": "array", + "default": [], + "title": "The address Schema", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for an organisation", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "AccountHolderName" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "AccountHolderName": { + "type": "string", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen", + "Jan Zandbergen" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "Name": "Cremin Group", + "CocNumber": "38012622", + "VatNumber": "NL003276211B01", + "Tradename": "Quitzon, Schinner and Jakubowski", + "EmailAddress": "Kirsten_Bogisich27@example.org", + "Website": "http://antoinette.name", + "PhoneNumber": "758-646-8786", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "inspiratielaan", + "HouseNumber": 3, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL44DNIB0736664289", + "BankId": "DNIB", + "Bic": "DNIBNL2G", + "CountryCode": "NL", + "AccountHolderName": "Jan Zandbergen", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "organisation-4.0-Update-JsonSchema": { + "type": "object", + "default": {}, + "title": "Organisation", + "description": "A JSON schema to represent an organization", + "required": [ + "RelationId" + ], + "properties": { + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "Name": { + "type": "string", + "description": "The name of the organisation" + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the Organisation to use for a client application." + }, + "CocNumber": { + "type": "string", + "description": "The Chamber of Commerce (CoC) number of the organisation", + "pattern": "^[0-9]+$" + }, + "VatNumber": { + "type": "string", + "description": "The Value-Added Tax (VAT) number of the organisation", + "pattern": "^[A-Z0-9]+$" + }, + "Tradename": { + "type": "string", + "description": "The tradename of the organisation" + }, + "SbiCode": { + "type": "string", + "description": "The SBICode of the organisation" + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The email address of the organisation" + }, + "Website": { + "type": "string", + "description": "The website of the organisation" + }, + "PhoneNumber": { + "type": "string", + "description": "The phone number of the organisation" + }, + "Addresses": { + "type": "array", + "default": [], + "title": "The address Schema", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for an organisation", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "AccountHolderName" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "AccountHolderName": { + "type": "string", + "description": "Must contain the name of the account holder.", + "examples": [ + "Kees Zandbergen", + "Jan Zandbergen" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "Name": "Cremin Group", + "CocNumber": "38012622", + "VatNumber": "NL003276211B01", + "Tradename": "Quitzon, Schinner and Jakubowski", + "EmailAddress": "Kirsten_Bogisich27@example.org", + "Website": "http://antoinette.name", + "PhoneNumber": "758-646-8786", + "Addresses": [ + { + "StreetName": "inspiratielaan", + "HouseNumber": 1, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "inspiratielaan", + "HouseNumber": 3, + "HouseNumberAddition": "b", + "Explanation": "Headquarters", + "PostalZone": "3833AV", + "State": "Utrecht", + "CityName": "Leusden", + "CountryCode": "NL", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL85CHAS0874238307", + "BankId": "CHAS", + "Bic": "CHASNL2X", + "CountryCode": "NL", + "AccountHolderName": "Kees Zandbergen", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL44DNIB0736664289", + "BankId": "DNIB", + "Bic": "DNIBNL2G", + "CountryCode": "NL", + "AccountHolderName": "Jan Zandbergen", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "payrolljournalentry-1.0-Create-JsonSchema": { + "type": "object", + "title": "PayrollJournalEntry", + "description": "Create a Payroll entry.", + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Use GET ../Administration" + }, + "Description": { + "type": "string" + }, + "Date": { + "type": "string", + "format": "date", + "example": "2023-01-31" + }, + "PayrollJournalEntryLine": { + "type": "array", + "items": { + "type": "object", + "properties": { + "LedgerAccountNumber": { + "type": "string", + "description": "Number of the ledger account GET ../LegderAccount" + }, + "AmountDebit": { + "type": "number", + "minimum": 0, + "multipleOf": 0.01, + "example": 1403.65 + }, + "AmountCredit": { + "type": "number", + "minimum": 0, + "multipleOf": 0.01, + "example": 2650.33 + } + }, + "required": [ + "LedgerAccountNumber" + ] + } + } + }, + "required": [ + "AdministrationId", + "Description", + "Date", + "PayrollJournalEntryLine" + ] + }, + "person-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "title": "Person", + "type": "object", + "required": [ + "lastName" + ], + "properties": { + "firstName": { + "type": "string", + "description": "The first name of the person.", + "examples": [ + "John" + ] + }, + "lastName": { + "type": "string", + "description": "The last name of the person.", + "examples": [ + "Doe" + ] + }, + "Initials": { + "type": "string", + "description": "The initials of the person.", + "examples": [ + "J.D." + ] + }, + "Prefix": { + "type": "string", + "description": "The prefix of the lastname.", + "examples": [ + "van." + ] + }, + "emailaddress": { + "type": "string", + "format": "email", + "description": "The emailaddress of the person", + "examples": [ + "johndoe@gmail.com" + ] + }, + "phonenumber": { + "type": "string", + "description": "The phonenumber of the person", + "examples": [ + "1-555-123-4567" + ] + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the person to use for a client application.", + "examples": [ + "987654321" + ] + }, + "address": { + "type": "array", + "default": [], + "description": "Create 1 or more addresses for a person", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "preferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "preferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "preferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "bankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for a person", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "CountryCode" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "preferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "preferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "Firstname": "John", + "Initials": "J", + "Prefix": "Mr", + "lastName": "Doe", + "emailaddress": "johndoe@gmail.com", + "phonenumber": "1-555-123-4567", + "address": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "preferredSupplierAddress": true, + "preferredShippingAddress": false, + "preferredBillingAddress": true + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "preferredSupplierAddress": false, + "preferredShippingAddress": true, + "preferredBillingAddress": false + } + ], + "bankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "preferredOutgoingPayments": true, + "preferredIncommingPayments": true + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "preferredOutgoingPayments": false, + "preferredIncommingPayments": false + } + ] + } + ] + }, + "person-2.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "title": "Person", + "type": "object", + "required": [ + "LastName" + ], + "properties": { + "FirstName": { + "type": "string", + "description": "The first name of the person.", + "examples": [ + "John" + ] + }, + "LastName": { + "type": "string", + "description": "The last name of the person.", + "examples": [ + "Doe" + ] + }, + "Initials": { + "type": "string", + "description": "The initials of the person.", + "examples": [ + "J.D." + ] + }, + "Prefix": { + "type": "string", + "description": "The prefix of the lastname.", + "examples": [ + "van." + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The emailaddress of the person", + "examples": [ + "johndoe@gmail.com" + ] + }, + "PhoneNumber": { + "type": "string", + "description": "The phonenumber of the person", + "examples": [ + "1-555-123-4567" + ] + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the person to use for a client application.", + "examples": [ + "987654321" + ] + }, + "Addresses": { + "type": "array", + "default": [], + "description": "Create 1 or more addresses for a person", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for a person", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "CountryCode" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "FirstName": "John", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Doe", + "EmailAddress": "johndoe@gmail.com", + "PhoneNumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "person-3.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "title": "Person", + "type": "object", + "required": [ + "LastName" + ], + "properties": { + "FirstName": { + "type": "string", + "description": "The first name of the person.", + "examples": [ + "John" + ] + }, + "LastName": { + "type": "string", + "description": "The last name of the person.", + "examples": [ + "Doe" + ] + }, + "Initials": { + "type": "string", + "description": "The initials of the person.", + "examples": [ + "J.D." + ] + }, + "Prefix": { + "type": "string", + "description": "The prefix of the lastname.", + "examples": [ + "van." + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The emailaddress of the person", + "examples": [ + "johndoe@gmail.com" + ] + }, + "PhoneNumber": { + "type": "string", + "description": "The phonenumber of the person", + "examples": [ + "1-555-123-4567" + ] + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the person to use for a client application.", + "examples": [ + "987654321" + ] + }, + "Addresses": { + "type": "array", + "default": [], + "description": "Create 1 or more addresses for a person", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for a person", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "CountryCode", + "BankId" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "FirstName": "John", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Doe", + "EmailAddress": "johndoe@gmail.com", + "PhoneNumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "person-3.0-Update-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "title": "Person", + "type": "object", + "required": [ + "RelationId" + ], + "properties": { + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the person.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "FirstName": { + "type": "string", + "description": "The first name of the person.", + "examples": [ + "John" + ] + }, + "LastName": { + "type": "string", + "description": "The last name of the person.", + "examples": [ + "Doe" + ] + }, + "Initials": { + "type": "string", + "description": "The initials of the person.", + "examples": [ + "J.D." + ] + }, + "Prefix": { + "type": "string", + "description": "The prefix of the lastname.", + "examples": [ + "van." + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The emailaddress of the person", + "examples": [ + "johndoe@gmail.com" + ] + }, + "PhoneNumber": { + "type": "string", + "description": "The phonenumber of the person", + "examples": [ + "1-555-123-4567" + ] + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the person to use for a client application.", + "examples": [ + "987654321" + ] + }, + "Addresses": { + "type": "array", + "default": [], + "description": "Create 1 or more addresses for a person", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for a person", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "CountryCode" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "FirstName": "John", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Doe", + "EmailAddress": "johndoe@gmail.com", + "PhoneNumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "person-4.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "title": "Person", + "type": "object", + "required": [ + "LastName" + ], + "properties": { + "FirstName": { + "type": "string", + "description": "The first name of the person.", + "examples": [ + "John" + ] + }, + "LastName": { + "type": "string", + "description": "The last name of the person.", + "examples": [ + "Doe" + ] + }, + "Initials": { + "type": "string", + "description": "The initials of the person.", + "examples": [ + "J.D." + ] + }, + "Prefix": { + "type": "string", + "description": "The prefix of the lastname.", + "examples": [ + "van." + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The emailaddress of the person", + "examples": [ + "johndoe@gmail.com" + ] + }, + "PhoneNumber": { + "type": "string", + "description": "The phonenumber of the person", + "examples": [ + "1-555-123-4567" + ] + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the person to use for a client application.", + "examples": [ + "987654321" + ] + }, + "Addresses": { + "type": "array", + "default": [], + "description": "Create 1 or more addresses for a person", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for a person", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "CountryCode", + "BankId" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "FirstName": "John", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Doe", + "EmailAddress": "johndoe@gmail.com", + "PhoneNumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "person-4.0-Update-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "title": "Person", + "type": "object", + "required": [ + "RelationId" + ], + "properties": { + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the person.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "FirstName": { + "type": "string", + "description": "The first name of the person.", + "examples": [ + "John" + ] + }, + "LastName": { + "type": "string", + "description": "The last name of the person.", + "examples": [ + "Doe" + ] + }, + "Initials": { + "type": "string", + "description": "The initials of the person.", + "examples": [ + "J.D." + ] + }, + "Prefix": { + "type": "string", + "description": "The prefix of the lastname.", + "examples": [ + "van." + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "description": "The emailaddress of the person", + "examples": [ + "johndoe@gmail.com" + ] + }, + "PhoneNumber": { + "type": "string", + "description": "The phonenumber of the person", + "examples": [ + "1-555-123-4567" + ] + }, + "ExternalId": { + "type": "string", + "description": "ExternalId of the person to use for a client application.", + "examples": [ + "987654321" + ] + }, + "Addresses": { + "type": "array", + "default": [], + "description": "Create 1 or more addresses for a person", + "items": { + "type": "object", + "title": "A Schema", + "required": [ + "StreetName", + "CityName", + "CountryCode" + ], + "properties": { + "StreetName": { + "type": "string", + "examples": [ + "inspiratielaan" + ] + }, + "HouseNumber": { + "type": "integer", + "default": 0, + "examples": [ + 1 + ] + }, + "HouseNumberAddition": { + "type": "string", + "default": "", + "examples": [ + "a", + "HS-01" + ] + }, + "Explanation": { + "type": "string", + "default": "", + "examples": [ + "Headquarters" + ] + }, + "PostalZone": { + "type": "string", + "default": "", + "examples": [ + "3833AV" + ] + }, + "State": { + "type": "string", + "default": "", + "description": "Could contain the state or province.", + "examples": [ + "Utrecht", + "Florida" + ] + }, + "CityName": { + "type": "string", + "default": "", + "description": "Dutch CityNames are verfied based on a list of CityNames.", + "examples": [ + "Leusden" + ] + }, + "CountryCode": { + "type": "string", + "default": "", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL", + "De" + ] + }, + "PreferredSupplierAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredShippingAddress": { + "type": "boolean", + "default": true, + "examples": [ + false, + true + ] + }, + "PreferredBillingAddress": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + }, + "BankAccounts": { + "type": "array", + "default": [], + "description": "Create 1 or more bankAccounts for a person", + "items": { + "type": "object", + "required": [ + "AccountNumber", + "CountryCode" + ], + "properties": { + "AccountNumber": { + "type": "string", + "description": "Fill the IBAN code or AccountNumber", + "examples": [ + "NL85CHAS0874238307", + "NL44DNIB0736664289" + ] + }, + "BankId": { + "type": "string", + "description": "Fill the bankid. Also known as Bankcode of bank identifier.", + "examples": [ + "CHAS", + "DNIB" + ] + }, + "Bic": { + "type": "string", + "description": "Fill the bic code.", + "examples": [ + "CHASNL2X", + "DNIBNL2G" + ] + }, + "CountryCode": { + "type": "string", + "description": "ISO alpha 2 country code.", + "examples": [ + "NL" + ] + }, + "PreferredOutgoingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + }, + "PreferredIncommingPayments": { + "type": "boolean", + "default": true, + "examples": [ + true, + false + ] + } + } + } + } + }, + "examples": [ + { + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "FirstName": "John", + "Initials": "J", + "Prefix": "Mr", + "LastName": "Doe", + "EmailAddress": "johndoe@gmail.com", + "PhoneNumber": "1-555-123-4567", + "Addresses": [ + { + "StreetName": "Main Street", + "HouseNumber": 1234, + "HouseNumberAddition": "", + "Explanation": "", + "PostalZone": "90210", + "State": "California", + "CityName": "Beverly Hills", + "CountryCode": "US", + "PreferredSupplierAddress": true, + "PreferredShippingAddress": false, + "PreferredBillingAddress": true + }, + { + "StreetName": "Park Avenue", + "HouseNumber": 567, + "HouseNumberAddition": "Apt 3B", + "Explanation": "", + "PostalZone": "10022", + "State": "New York", + "CityName": "New York", + "CountryCode": "US", + "PreferredSupplierAddress": false, + "PreferredShippingAddress": true, + "PreferredBillingAddress": false + } + ], + "BankAccounts": [ + { + "AccountNumber": "NL93LOYD0175300941", + "BankId": "LOYD", + "Bic": "LOYDNL2A", + "CountryCode": "NL", + "PreferredOutgoingPayments": true, + "PreferredIncommingPayments": true + }, + { + "AccountNumber": "NL67VOWA0136875262", + "BankId": "VOWA", + "Bic": "VOWANL21", + "CountryCode": "NL", + "PreferredOutgoingPayments": false, + "PreferredIncommingPayments": false + } + ] + } + ] + }, + "phonenumber-1.0-Create-JsonSchema": { + "type": "object", + "x-stoplight": { + "id": "vfjbed9j7fve7" + }, + "x-examples": { + "Example 1": { + "OrganisationId": "8f03496b-1f42-5ac3-a770-91f9da4e6e12", + "EmailAddress": "j.zandbergen@afasSbPlus.nl" + } + }, + "title": "PhoneNumber", + "examples": [ + { + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "PhoneNumber": "112346546546" + }, + { + "OrganisationId": "32abaca0-b4c6-4dce-af80-9de42a830e62", + "PhoneNumber": "65465454" + }, + { + "RelationType": "person", + "RelationId": "963578e8-7831-4aa4-83c4-e7c3262f0572", + "PhoneNumber": "6546545" + } + ], + "description": "Create a PhoneNumber for an organisation or person.", + "properties": { + "RelationType": { + "type": "string", + "description": "Must contain one of the enums. Will be required in a future version.", + "enum": [ + "organisation", + "person" + ], + "x-stoplight": { + "id": "uqd7z1nx8fqye" + } + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation or person. Will be required in a future version.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ], + "x-stoplight": { + "id": "iwy8izvm2ahpb" + } + }, + "OrganisationId": { + "type": "string", + "format": "uuid", + "example": "32abaca0-b4c6-4dce-af80-9de42a830e62", + "x-stoplight": { + "id": "n7l99rqkoa197" + } + }, + "PhoneNumber": { + "type": "string", + "description": " All characters of the phonenumber that are not a diget will be removed.", + "x-stoplight": { + "id": "8gusb7enrefaq" + } + } + }, + "required": [ + "PhoneNumber" + ] + }, + "purchaseinvoice-1.0-Create-JsonSchema": { + "type": "object", + "properties": { + "AdministrationId": { + "type": "string" + }, + "SupplierInvoiceId": { + "type": "string" + }, + "OrderReference": { + "type": "string" + }, + "SupplierOrganisationId": { + "type": "string" + }, + "IssueDate": { + "type": "string" + }, + "DueDate": { + "type": "string" + }, + "PlannedPaymentDate": { + "type": "string" + }, + "PaymentMethodId": { + "type": "string" + }, + "Attachments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AttachmentId": { + "type": "string" + } + } + } + }, + "InvoiceLine": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Description": { + "type": "string" + }, + "LedgerAccountNumberId": { + "type": "string" + }, + "LineExtensionAmount": { + "type": "string" + }, + "TaxAmount": { + "type": "string" + }, + "VatTypeId": { + "type": "string" + }, + "VatRateId": { + "type": "string" + }, + "PerformanceDateTypeId": { + "type": "string" + }, + "OtherPerformanceDate": { + "type": "string" + }, + "PerformanceStartDate": { + "type": "string" + }, + "PerformanceEndDate": { + "type": "string" + }, + "LineNumber": { + "type": "integer" + } + } + } + } + }, + "x-examples": { + "Example 1": { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "SupplierInvoiceId": "Pur002", + "OrderReference": "stringstringstring", + "SupplierOrganisationId": "7b8e279b-b551-556e-a00a-a815392d0d38", + "IssueDate": "2022-10-10", + "DueDate": "2022-10-31", + "PlannedPaymentDate": "2022-10-15", + "PaymentMethodId": "afa50000-0000-0102-b0d1-f91a25e6c442", + "Attachments": [ + { + "AttachmentId": "46db28a3-ad46-43aa-a8da-226ead20010a" + } + ], + "InvoiceLine": [ + { + "Description": "test inkoop", + "LedgerAccountNumberId": "6099", + "LineExtensionAmount": "100", + "TaxAmount": "21", + "VatTypeId": "afa50000-0000-0b71-8790-807f97e85c54", + "VatRateId": "afa50000-0000-0465-aa85-e1a761ca3a33", + "PerformanceDateTypeId": "", + "OtherPerformanceDate": "", + "PerformanceStartDate": "", + "PerformanceEndDate": "", + "LineNumber": 0 + } + ] + } + }, + "title": "PurchaseInvoice", + "description": "", + "examples": [ + { + "AdministrationId": "string", + "SupplierInvoiceId": "string", + "OrderReference": "string", + "SupplierOrganisationId": "string", + "IssueDate": "string", + "DueDate": "string", + "PlannedPaymentDate": "string", + "PaymentMethodId": "string", + "Attachments": [ + { + "AttachmentId": "string" + } + ], + "InvoiceLine": [ + { + "Description": "string", + "LedgerAccountNumberId": "string", + "LineExtensionAmount": "string", + "TaxAmount": "string", + "VatTypeId": "string", + "VatRateId": "string", + "PerformanceDateTypeId": "string", + "OtherPerformanceDate": "string", + "PerformanceStartDate": "string", + "PerformanceEndDate": "string", + "LineNumber": 0 + } + ] + } + ] + }, + "purchasejournalentry-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a purchase journal entry.", + "required": [ + "AdministrationId", + "InvoiceNumber", + "RelationType", + "RelationId", + "InvoiceDate", + "InvoiceLine", + "DueDate" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "InvoiceNumber": { + "type": "string", + "description": "Must contain the InvoiceNumber", + "examples": [ + "PUR00001" + ] + }, + "Reference": { + "type": "string", + "description": "Can contain a reference id to the origin app.", + "examples": [ + "ExternalAppId001" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "InvoiceDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "DueDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-12-31" + ] + }, + "PlannedPaymentDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-12-15" + ] + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to customer default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "InvoiceLine": { + "type": "array", + "items": { + "type": "object", + "required": [ + "LedgerAccountId", + "AmountExcludingVat", + "VatType" + ], + "properties": { + "Description": { + "type": "string", + "examples": [ + "Dell Custom keyboard" + ] + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "AmountExcludingVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 100 + ] + }, + "AmountVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 21 + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Only include if vat is reverse-charge or exemption.", + "enum": [ + "reversecharged", + "exempt", + "", + "null" + ] + } + } + } + } + } + }, + "purchasejournalentry-1.1-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a purchase journal entry.", + "required": [ + "AdministrationId", + "InvoiceNumber", + "RelationType", + "RelationId", + "InvoiceDate", + "InvoiceLine", + "DueDate" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "InvoiceNumber": { + "type": "string", + "description": "Must contain the InvoiceNumber", + "examples": [ + "PUR00001" + ] + }, + "Reference": { + "type": "string", + "description": "Can contain a reference id to the origin app.", + "examples": [ + "ExternalAppId001" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "InvoiceDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "DueDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-12-31" + ] + }, + "PlannedPaymentDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-12-15" + ] + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to supplier default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "InvoiceLine": { + "type": "array", + "items": { + "type": "object", + "required": [ + "LedgerAccountId", + "AmountExcludingVat", + "VatType" + ], + "properties": { + "Description": { + "type": "string", + "examples": [ + "Dell Custom keyboard" + ] + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "AmountExcludingVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 100 + ] + }, + "AmountVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 21 + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Only include if vat is reverse-charge or exemption.", + "enum": [ + "reversecharged", + "exempt", + "", + "null" + ] + } + } + } + } + } + }, + "purchasejournalentry-2.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a purchase journal entry", + "required": [ + "AdministrationId", + "InvoiceNumber", + "RelationType", + "RelationId", + "InvoiceDate", + "InvoiceLine", + "DueDate" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "InvoiceNumber": { + "type": "string", + "description": "Must contain the InvoiceNumber", + "examples": [ + "PUR00001" + ] + }, + "Reference": { + "type": "string", + "description": "Can contain a reference id to the origin app.", + "examples": [ + "ExternalAppId001" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "InvoiceDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "DueDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-12-31" + ] + }, + "PlannedPaymentDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-12-15" + ] + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to supplier default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "InvoiceLine": { + "type": "array", + "items": { + "type": "object", + "required": [ + "LedgerAccountId", + "AmountExcludingVat", + "VatType" + ], + "properties": { + "Description": { + "type": "string", + "examples": [ + "Dell Custom keyboard" + ] + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "AmountExcludingVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 100 + ] + }, + "AmountVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 21 + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Only include if vat is reverse-charge or exemption.", + "enum": [ + "reversecharged", + "exempt", + "", + "null" + ] + }, + "AlternativeAllocationDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + }, + "PeriodAllocation": { + "type": "boolean", + "description": "Apportion over a period", + "default": false + }, + "PeriodAllocationBeginDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-01-01" + ] + }, + "PeriodAllocationEndDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + } + } + } + } + } + }, + "salesinvoice-1.0-Create-JsonSchema": { + "type": "object", + "description": "Create a sales invoice.", + "properties": { + "AdministrationId": { + "type": "string", + "description": "Must contain the Administration guid of the target Administration", + "format": "uuid" + }, + "IssueDate": { + "type": "string", + "format": "date" + }, + "Reference": { + "type": "string" + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "format": "uuid" + }, + "AddressId": { + "type": "string", + "format": "uuid" + }, + "SentInvoiceEmail": { + "type": "boolean", + "description": "Sent the invoice as an email to the relation.", + "default": true + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid" + } + }, + "required": [ + "AttachmentId" + ] + } + }, + "InvoiceLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "properties": { + "ItemId": { + "type": "string", + "description": "Must contain Product guid. This can be retrieved through the products endpoint.", + "format": "uuid" + }, + "Price": { + "type": "number", + "description": "Price per product excluding VAT.", + "minimum": 0, + "multipleOf": 0.01 + }, + "Quantity": { + "type": "integer", + "description": "Quantity of products of this type" + }, + "ExtraDescription": { + "type": "string", + "description": "Optional field for extra information about the invoiceline" + } + }, + "required": [ + "ItemId", + "Price", + "Quantity" + ] + } + } + }, + "required": [ + "AdministrationId", + "IssueDate", + "RelationType", + "RelationId", + "InvoiceLine" + ] + }, + "salesinvoice-1.1-Create-JsonSchema": { + "type": "object", + "description": "Create a sales invoice.", + "properties": { + "AdministrationId": { + "type": "string", + "description": "Must contain the Administration guid of the target Administration", + "format": "uuid" + }, + "IssueDate": { + "type": "string", + "format": "date" + }, + "Reference": { + "type": "string" + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "format": "uuid" + }, + "AddressId": { + "type": "string", + "format": "uuid" + }, + "SentInvoiceEmail": { + "type": "boolean", + "description": "Sent the invoice as an email to the relation.", + "default": true + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid" + } + }, + "required": [ + "AttachmentId" + ] + } + }, + "InvoiceLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "properties": { + "ItemId": { + "type": "string", + "description": "Must contain Product guid. This can be retrieved through the products endpoint.", + "format": "uuid" + }, + "Price": { + "type": "number", + "multipleOf": 0.01, + "description": "Price per product excluding VAT." + }, + "Quantity": { + "type": "number", + "description": "Quantity of products of this type", + "multipleOf": 0.01 + }, + "ExtraDescription": { + "type": "string", + "description": "Optional field for extra information about the invoiceline" + } + }, + "required": [ + "ItemId", + "Quantity" + ] + } + } + }, + "required": [ + "AdministrationId", + "IssueDate", + "RelationType", + "RelationId", + "InvoiceLine" + ] + }, + "salesinvoice-2.0-Create-JsonSchema": { + "type": "object", + "description": "Create a sales invoice.", + "properties": { + "AdministrationId": { + "type": "string", + "description": "Must contain the Administration guid of the target Administration", + "format": "uuid" + }, + "IssueDate": { + "type": "string", + "format": "date" + }, + "Reference": { + "type": "string" + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "format": "uuid" + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to customer default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "AddressId": { + "type": "string", + "format": "uuid" + }, + "SentInvoiceEmail": { + "type": "boolean", + "description": "Sent the invoice as an email to the relation." + }, + "ToBeInvoiced": { + "type": "boolean", + "description": "Make a invoice that is not yet completed or sent to the relation." + }, + "Attachments": { + "type": "array", + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid" + } + }, + "required": [ + "AttachmentId" + ] + } + }, + "InvoiceLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "properties": { + "ItemId": { + "type": "string", + "description": "Must contain Product guid. This can be retrieved through the products endpoint.", + "format": "uuid" + }, + "Price": { + "type": "number", + "description": "Price per product excluding VAT. Falls back to product default when empty." + }, + "Quantity": { + "type": "number", + "description": "Quantity of products of this type", + "multipleOf": 0.01 + }, + "VatType": { + "type": "string", + "description": "Vat tarive. Falls back to product default when empty.", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "ExtraDescription": { + "type": "string", + "description": "Optional field for extra information about the invoiceline" + }, + "AlternativeAllocationDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + }, + "PeriodAllocation": { + "type": "boolean", + "description": "Apportion over a period", + "default": false + }, + "PeriodAllocationBeginDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-01-01" + ] + }, + "PeriodAllocationEndDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + } + }, + "required": [ + "ItemId", + "Quantity" + ] + } + } + }, + "required": [ + "AdministrationId", + "IssueDate", + "RelationType", + "RelationId", + "InvoiceLine", + "SentInvoiceEmail" + ] + }, + "salesinvoice-2.0-Delete-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Delete a salesinvoice", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of salesinvoice.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + } + ] + }, + "salesjournalentry-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a sales journal entry.", + "required": [ + "AdministrationId", + "InvoiceDate", + "InvoiceNumber", + "RelationType", + "RelationId", + "InvoiceLine" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "InvoiceDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "InvoiceNumber": { + "type": "string", + "description": "Must contain the InvoiceNumber", + "examples": [ + "VK004917" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "Reference": { + "type": "string", + "description": "Can contain a reference id to the origin app.", + "examples": [ + "ExternalAppId001" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntry.", + "examples": [ + "Example Invoice 001" + ] + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to customer default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "PaymentConditionId": { + "type": "string", + "format": "uuid", + "description": "Payment condition guids can be requested with the PaymentCondition Get endpoint. Falls back to default when empty.", + "examples": [ + "986d98be-e74d-58f2-95f7-e641769ac64f" + ] + }, + "Attachments": { + "type": "array", + "default": [], + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "default": {}, + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "InvoiceLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "default": {}, + "required": [ + "LedgerAccountId", + "AmountExcludingVat", + "VatType" + ], + "allOf": [ + { + "if": { + "properties": { + "VatType": { + "enum": [ + "high", + "low" + ] + } + }, + "required": [ + "VatType" + ] + }, + "then": { + "required": [ + "AmountVat" + ] + } + } + ], + "properties": { + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntryLine.", + "examples": [ + "Sales with high vat type" + ] + }, + "AmountExcludingVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 100 + ] + }, + "AmountVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 21 + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "IntraCommunityType": { + "type": "string", + "description": "Only include if sale is B2B and inside EU (ICP purposes). Falls back to setting (default 'supplies') when empty.", + "enum": [ + "supplies", + "services", + "", + "null" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Only include if vat is reverse-charge or exemption.", + "enum": [ + "reversecharged", + "exempt", + "", + "null" + ] + } + } + }, + "examples": [ + [ + { + "LedgerAccountId": "93b4b2cb-2174-56ff-b6f6-0031527e01e1", + "AmountExcludingVat": 116.52, + "AmountVat": 24.47, + "VatType": "high", + "VatCalculation": "exempt" + } + ] + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "InvoiceDate": "2022-10-12", + "InvoiceNumber": "VK004917", + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "Reference": "ExternalAppId001", + "Description": "Example Invoice 001", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "986d98be-e74d-58f2-95f7-e641769ac64f", + "Attachments": [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ], + "InvoiceLine": [ + { + "LedgerAccountId": "93b4b2cb-2174-56ff-b6f6-0031527e01e1", + "AmountExcludingVat": 116.52, + "AmountVat": 24.47, + "VatType": "high", + "VatCalculation": "exempt" + } + ] + } + ] + }, + "salesjournalentry-2.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a sales journal entry.", + "required": [ + "AdministrationId", + "InvoiceDate", + "InvoiceNumber", + "RelationType", + "RelationId", + "InvoiceLine" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "InvoiceDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "InvoiceNumber": { + "type": "string", + "description": "Must contain the InvoiceNumber", + "examples": [ + "VK004917" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "Reference": { + "type": "string", + "description": "Can contain a reference id to the origin app.", + "examples": [ + "ExternalAppId001" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntry.", + "examples": [ + "Example Invoice 001" + ] + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to customer default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "PaymentConditionId": { + "type": "string", + "format": "uuid", + "description": "Payment condition guids can be requested with the PaymentCondition Get endpoint. Falls back to default when empty.", + "examples": [ + "986d98be-e74d-58f2-95f7-e641769ac64f" + ] + }, + "PaymentReference": { + "type": "string", + "description": "Can contain the PaymentReference", + "examples": [ + "tr_FLtHQ7oSDG" + ] + }, + "Attachments": { + "type": "array", + "default": [], + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "default": {}, + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "InvoiceLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "default": {}, + "required": [ + "LedgerAccountId", + "AmountExcludingVat", + "VatType" + ], + "allOf": [ + { + "if": { + "properties": { + "VatType": { + "enum": [ + "high", + "low" + ] + } + }, + "required": [ + "VatType" + ] + }, + "then": { + "required": [ + "AmountVat" + ] + } + } + ], + "properties": { + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntryLine.", + "examples": [ + "Sales with high vat type" + ] + }, + "AmountExcludingVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 100 + ] + }, + "AmountVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 21 + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "IntraCommunityType": { + "type": "string", + "description": "Only include if sale is B2B and inside EU (ICP purposes). Falls back to default 'supplies' when empty.", + "enum": [ + "supplies", + "services", + "", + "null" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Only include if vat is reverse-charge or exemption.", + "enum": [ + "reversecharged", + "exempt", + "", + "null" + ] + } + } + }, + "examples": [ + [ + { + "LedgerAccountId": "93b4b2cb-2174-56ff-b6f6-0031527e01e1", + "AmountExcludingVat": 116.52, + "AmountVat": 24.47, + "VatType": "high", + "VatCalculation": "exempt" + } + ] + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "InvoiceDate": "2022-10-12", + "InvoiceNumber": "VK004917", + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "Reference": "ExternalAppId001", + "Description": "Example Invoice 001", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "986d98be-e74d-58f2-95f7-e641769ac64f", + "Attachments": [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ], + "InvoiceLine": [ + { + "LedgerAccountId": "93b4b2cb-2174-56ff-b6f6-0031527e01e1", + "AmountExcludingVat": 116.52, + "AmountVat": 24.47, + "VatType": "high", + "VatCalculation": "exempt" + } + ] + } + ] + }, + "salesjournalentry-2.0-Delete-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Delete a salesjournalentry", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of salesjournal.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + } + ] + }, + "salesjournalentry-2.0-Update-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Update a sales journal entry.", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the salesjournalentry.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "PaymentReference": { + "type": "string", + "description": "Can contain the PaymentReference", + "examples": [ + "tr_FLtHQ7oSDG" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "PaymentReference": "tr_FLtHQ7oSDG" + } + ] + }, + "salesjournalentry-2.1-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Create a sales journal entry.", + "required": [ + "AdministrationId", + "InvoiceDate", + "InvoiceNumber", + "RelationType", + "RelationId", + "InvoiceLine" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "InvoiceDate": { + "type": "string", + "format": "date", + "examples": [ + "2022-10-12" + ] + }, + "InvoiceNumber": { + "type": "string", + "description": "Must contain the InvoiceNumber", + "examples": [ + "VK004917" + ] + }, + "RelationType": { + "type": "string", + "description": "Must contain one of the enums.", + "enum": [ + "organisation", + "person", + "unknown" + ] + }, + "RelationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the organisation, person or unknown relation.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "Reference": { + "type": "string", + "description": "Can contain a reference id to the origin app.", + "examples": [ + "ExternalAppId001" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntry.", + "examples": [ + "Example Invoice 001" + ] + }, + "PaymentMethod": { + "type": "string", + "description": "Payment method enum. Falls back to customer default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "PaymentConditionId": { + "type": "string", + "format": "uuid", + "description": "Payment condition guids can be requested with the PaymentCondition Get endpoint. Falls back to default when empty.", + "examples": [ + "986d98be-e74d-58f2-95f7-e641769ac64f" + ] + }, + "PaymentReference": { + "type": "string", + "description": "Can contain the PaymentReference", + "examples": [ + "tr_FLtHQ7oSDG" + ] + }, + "Attachments": { + "type": "array", + "default": [], + "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment.", + "items": { + "type": "object", + "default": {}, + "required": [ + "AttachmentId" + ], + "properties": { + "AttachmentId": { + "type": "string", + "format": "uuid", + "examples": [ + "72b17471-140e-413d-b4ff-f11c37fefccb" + ] + } + } + }, + "examples": [ + [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ] + ] + }, + "InvoiceLine": { + "type": "array", + "default": [], + "items": { + "type": "object", + "default": {}, + "required": [ + "LedgerAccountId", + "AmountExcludingVat" + ], + "allOf": [ + { + "if": { + "properties": { + "VatType": { + "enum": [ + "high", + "low" + ] + } + }, + "required": [ + "VatType" + ] + }, + "then": { + "required": [ + "AmountVat" + ] + } + }, + { + "if": { + "not": { + "properties": { + "VatCalculation": { + "const": "novat" + } + } + } + }, + "then": { + "required": [ + "VatType" + ] + } + } + ], + "properties": { + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", + "examples": [ + "93b4b2cb-2174-56ff-b6f6-0031527e01e1" + ] + }, + "Description": { + "type": "string", + "description": "Can contain a description for the JournalEntryLine.", + "examples": [ + "Sales with high vat type" + ] + }, + "AmountExcludingVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 100 + ] + }, + "AmountVat": { + "type": "number", + "default": 0.0, + "multipleOf": 0.01, + "examples": [ + 21 + ] + }, + "VatType": { + "type": "string", + "enum": [ + "high", + "low", + "zero", + "", + "null" + ] + }, + "IntraCommunityType": { + "type": "string", + "description": "Only include if sale is B2B and inside EU (ICP purposes). Falls back to default 'supplies' when empty.", + "enum": [ + "supplies", + "services", + "", + "null" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Only include if vat is reverse-charge or exemption.", + "enum": [ + "reversecharged", + "exempt", + "novat", + "", + "null" + ] + }, + "AlternativeAllocationDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + }, + "PeriodAllocation": { + "type": "boolean", + "description": "Apportion over a period", + "default": false + }, + "PeriodAllocationBeginDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-01-01" + ] + }, + "PeriodAllocationEndDate": { + "type": "string", + "format": "date", + "examples": [ + "2024-12-31" + ] + } + } + }, + "examples": [ + [ + { + "LedgerAccountId": "93b4b2cb-2174-56ff-b6f6-0031527e01e1", + "AmountExcludingVat": 116.52, + "AmountVat": 24.47, + "VatType": "high", + "VatCalculation": "exempt" + } + ] + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "InvoiceDate": "2022-10-12", + "InvoiceNumber": "VK004917", + "RelationType": "organisation", + "RelationId": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "Reference": "ExternalAppId001", + "Description": "Example Invoice 001", + "PaymentMethod": "banktransfer", + "PaymentConditionId": "986d98be-e74d-58f2-95f7-e641769ac64f", + "Attachments": [ + { + "AttachmentId": "72b17471-140e-413d-b4ff-f11c37fefccb" + } + ], + "InvoiceLine": [ + { + "LedgerAccountId": "93b4b2cb-2174-56ff-b6f6-0031527e01e1", + "AmountExcludingVat": 116.52, + "AmountVat": 24.47, + "VatType": "high", + "VatCalculation": "exempt" + } + ] + } + ] + }, + "salesjournalentry-2.1-Delete-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Delete a salesjournalentry", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of salesjournal.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + } + ] + }, + "salesjournalentry-2.1-Update-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "description": "Update a sales journal entry.", + "required": [ + "AdministrationId", + "Id" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "Id": { + "type": "string", + "format": "uuid", + "description": "Must contain the guid of the salesjournalentry.", + "examples": [ + "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52" + ] + }, + "PaymentReference": { + "type": "string", + "description": "Can contain the PaymentReference", + "examples": [ + "tr_FLtHQ7oSDG" + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "Id": "a7b566cf-e03b-45f0-a294-d8ba1f1c8a52", + "PaymentReference": "tr_FLtHQ7oSDG" + } + ] + }, + "supplier-1.0-Create-JsonSchema": { + "$schema": "https://json-schema.org/draft/2019-09/schema", + "type": "object", + "default": {}, + "description": "Create a supplier.", + "required": [ + "AdministrationId" + ], + "properties": { + "AdministrationId": { + "type": "string", + "format": "uuid", + "description": "Must contain the Administration guid of the target Administration", + "examples": [ + "63fff54b-a110-53fe-92ed-44de73f0fb61" + ] + }, + "EmailAddress": { + "type": "string", + "format": "email", + "examples": [ + "leverancier@afas.nl" + ] + }, + "PhoneNumber": { + "type": "string", + "examples": [ + "+31655887744" + ] + }, + "BankAccountNumber": { + "type": "string", + "description": "Must be in IBAN format. Creates a bankaccount record for the supplier", + "examples": [ + "NL03BOFA0011792833" + ] + }, + "BIC": { + "type": "string", + "description": "If the Bic code is not available the BIC code will be looked up. If its not found an error will be raised", + "examples": [ + "BOFANLNX" + ] + }, + "LedgerAccountId": { + "type": "string", + "format": "uuid", + "description": "Set default value for supplier.", + "examples": [ + "c0441b65-1ca8-534c-8e45-acab8d30b325" + ] + }, + "PaymentMethod": { + "type": "string", + "default": "banktransfer", + "description": "Set default value for supplier. Falls back to supplier default when empty.", + "enum": [ + "creditcard", + "directdebit", + "debetcard", + "unknown", + "cash", + "ideal", + "banktransfer", + "", + "null" + ] + }, + "PaymentConditionId": { + "type": "string", + "format": "uuid", + "description": "Set default value for supplier. Payment condition guids can be requested with the PaymentCondition Get endpoint. Falls back to default when empty.", + "examples": [ + "986d98be-e74d-58f2-95f7-e641769ac64f" + ] + }, + "VatCalculation": { + "type": "string", + "description": "Set de value for supplier.", + "enum": [ + "charged", + "novat", + "reversecharged", + "exempt", + "", + "null" + ] + }, + "Person": { + "type": "object", + "default": {}, + "title": "The Person Schema", + "required": [ + "Lastname" + ], + "properties": { + "Firstname": { + "type": "string", + "title": "The Firstname Schema", + "examples": [ + "Jan" + ] + }, + "Initials": { + "type": "string", + "title": "The Initials Schema", + "examples": [ + "JH" + ] + }, + "Prefix": { + "type": "string", + "title": "The Prefix Schema", + "examples": [ + "van" + ] + }, + "Lastname": { + "type": "string", + "title": "The Lastname Schema", + "examples": [ + "Pinksteren" + ] + } + }, + "examples": [ + { + "Firstname": "Jan", + "Initials": "JH", + "Prefix": "van", + "Lastname": "Pinksteren" + } + ] + }, + "Organisation": { + "type": "object", + "default": {}, + "title": "The Organisation Schema", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string", + "default": "", + "title": "The Name Schema", + "examples": [ + "Jansen IJzerwaren" + ] + }, + "CompanyIdCoc": { + "type": "string", + "description": "Contains the CompanyCode also known in dutch as KVK nummer", + "examples": [ + "04019167" + ] + }, + "CompanyIdVat": { + "type": "string", + "description": "Contains the VAT code of the supplier", + "examples": [ + "NL818785639B01" + ] + }, + "TradeName": { + "type": "string", + "description": "The formal trade name of the organisation. If empty will be filled with the field Name", + "examples": [ + "Jansen Holding B.V." + ] + } + }, + "examples": [ + { + "Name": "Jansen Haarden", + "CompanyIdCoc": "80446353", + "CompanyIdVat": "NL861674881B01", + "TradeName": "Jansen Holding B.V." + } + ] + } + }, + "examples": [ + { + "AdministrationId": "63fff54b-a110-53fe-92ed-44de73f0fb61", + "EmailAddress": "leverancier@afas.nl", + "PhoneNumber": "0645789865", + "BankAccountNumber": "NL29TRIO0110845005", + "Bic": "TRIONL2U", + "VatType": "high", + "PaymentMethod": "banktransfer", + "IncludeInBankFile": "true", + "LedgerAccountId": "7f9a01a1-0352-5726-9111-03214874de74", + "Person": { + "Firstname": "Jan", + "Initials": "JH", + "Prefix": "van", + "Lastname": "Pinksteren" + }, + "Organisation": { + "Name": "Jansen IJzerwaren", + "CompanyIdCoc": "80446353", + "CompanyIdVat": "NL861674881B01", + "TradeName": "Jansen IJzerwaren B.V." + } + } + ] + } + }, + "responses": { + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "object", + "x-examples": { + "Example 1": { + "result": "PartiallySucceeded", + "traceId": "b06e41e4-4ff1-4b40-9331-5f2145b2a9a2", + "instances": [ + { + "Code": "Organisatie", + "Id": "1bfbc287-5fb4-59b5-9782-376fa601e4ad", + "Relatienummer": "000025" + }, + { + "Code": "Instelling", + "Id": "32a8c5d4-2227-512f-9f45-495192933809" + }, + { + "Code": "Leverancier", + "Id": "0afea90d-4ecb-5791-8e4b-787c70656f75" + }, + { + "Code": "Begunstigde", + "Id": "32a8c5d4-2227-512f-9f45-495192933809" + } + ], + "errors": [ + { + "Instelling": "'identificatie' bevat een verwijzing naar een ongeldige waarde." + } + ] + } + }, + "properties": { + "result": { + "type": "string" + }, + "traceId": { + "type": "string" + }, + "instances": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Code": { + "type": "string" + }, + "Id": { + "type": "string" + } + } + } + }, + "errors": { + "type": "array", + "items": { + "type": "object" + } + } + } + }, + "examples": { + "PartiallySucceeded": { + "value": { + "result": "PartiallySucceeded", + "traceId": "b06e41e4-4ff1-4b40-9331-5f2145b2a9a2", + "instances": [ + { + "Code": "Organisatie", + "Id": "1bfbc287-5fb4-59b5-9782-376fa601e4ad", + "Relatienummer": "000025" + }, + { + "Code": "Instelling", + "Id": "32a8c5d4-2227-512f-9f45-495192933809" + }, + { + "Code": "Leverancier", + "Id": "0afea90d-4ecb-5791-8e4b-787c70656f75" + }, + { + "Code": "Begunstigde", + "Id": "32a8c5d4-2227-512f-9f45-495192933809" + } + ], + "errors": [ + { + "Instelling": "'identificatie' bevat een verwijzing naar een ongeldige waarde." + } + ] + } + }, + "Bad Request - Invalid JSON": { + "value": { + "StatusCode": 400, + "Message": "Invalid JSON request String", + "ExceptionCode": "DS3100", + "TraceId": "802033b876ed48bbb83a01a717ccb960", + "AdditionalInfo": { + "ExceptionType": "DeserializationException", + "DefinitionName": "salesinvoice.UpdateConnectorHandler", + "PropertyNames": "" + } + } + }, + "Bad request - Invalid UUID": { + "value": { + "StatusCode": 400, + "Message": "Invalid JSON request String '' does not validate against format 'uuid'. Path 'RelationId', line 3, position 18.", + "ExceptionCode": "DS3100", + "TraceId": "57887d8213dd4327ae1429e860250b24", + "AdditionalInfo": { + "ExceptionType": "DeserializationException", + "DefinitionName": "address.UpdateConnectorHandler", + "PropertyNames": "" + } + } + }, + "Ongeldig gebruikersfilter": { + "value": { + "StatusCode": 400, + "Message": "Ongeldig gebruikersfilter.", + "TraceId": "3b022f499ab040dea4ef992d90901963", + "AdditionalInfo": { + "ExceptionType": "AntaUserException" + } + } + } + } + } + }, + "headers": { + "Server": { + "schema": { + "type": "string", + "example": "nginx" + } + }, + "Date": { + "schema": { + "type": "string", + "example": "Wed, 19 Oct 2022 12:05:20 GMT" + } + }, + "Content-Type": { + "schema": { + "type": "string", + "example": "application/json" + } + }, + "Transfer-Encoding": { + "schema": { + "type": "string", + "example": "chunked" + } + }, + "Connection": { + "schema": { + "type": "string", + "example": "keep-alive" + } + }, + "Content-Version": { + "schema": { + "type": "number", + "example": 1 + } + }, + "X-Content-Type-Options": { + "schema": { + "type": "string", + "example": "nosniff" + } + }, + "X-XSS-Protection": { + "schema": { + "type": "string", + "example": "1; mode=block" + } + }, + "X-Frame-Options": { + "schema": { + "type": "string", + "example": "SAMEORIGIN" + } + }, + "Strict-Transport-Security": { + "schema": { + "type": "string", + "example": "max-age=300" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "StatusCode": { + "type": "integer" + }, + "Message": { + "type": "string" + }, + "TraceId": { + "type": "string" + }, + "AdditionalInfo": { + "type": "object", + "properties": { + "ExceptionType": { + "type": "string" + } + } + } + } + }, + "examples": { + "Unauthorized": { + "value": { + "StatusCode": 401, + "Message": "Er is geen ingelogde gebruiker.", + "TraceId": "b41c2c8219494f40bef50bc24ea6844d", + "AdditionalInfo": { + "ExceptionType": "NotAuthenticatedException" + } + } + } + } + } + }, + "headers": { + "Server": { + "schema": { + "type": "string", + "example": "nginx" + } + }, + "Date": { + "schema": { + "type": "string", + "example": "Wed, 19 Oct 2024 12:05:20 GMT" + } + }, + "Transfer-Encoding": { + "schema": { + "type": "string", + "example": "chunked" + } + }, + "Connection": { + "schema": { + "type": "string", + "example": "keep-alive" + } + }, + "Content-Version": { + "schema": { + "type": "number", + "example": 1 + } + }, + "X-Content-Type-Options": { + "schema": { + "type": "string", + "example": "nosniff" + } + }, + "X-XSS-Protection": { + "schema": { + "type": "string", + "example": "1; mode=block" + } + }, + "X-Frame-Options": { + "schema": { + "type": "string", + "example": "SAMEORIGIN" + } + }, + "Strict-Transport-Security": { + "schema": { + "type": "string", + "example": "max-age=300" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "StatusCode": { + "type": "integer" + }, + "Message": { + "type": "string" + }, + "TraceId": { + "type": "string" + }, + "AdditionalInfo": { + "type": "object", + "properties": { + "ExceptionType": { + "type": "string" + } + } + } + } + }, + "examples": { + "Unauthorized": { + "value": { + "StatusCode": 403, + "Message": "De ingelogde gebruiker heeft niet voldoende rechten.", + "TraceId": "7c4cdf827b824c5384a3b9b22966c3c3", + "AdditionalInfo": { + "ExceptionType": "NotAuthorizedException" + } + } + } + } + } + } + }, + "404": { + "description": "Item Not Found", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "StatusCode": { + "type": "string" + }, + "Message": { + "type": "string" + }, + "TraceId": { + "type": "string" + }, + "AdditionalInfo": { + "type": "object", + "properties": { + "ExceptionType": { + "type": "string" + } + } + } + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/scripts/merge_openapi_examples.py b/scripts/merge_openapi_examples.py index 38b3584..492a766 100644 --- a/scripts/merge_openapi_examples.py +++ b/scripts/merge_openapi_examples.py @@ -296,8 +296,13 @@ def main(): parser.add_argument("--inplace", action="store_true", help="Overwrite the input spec file (a backup .bak is created).") parser.add_argument("--content-types", nargs="+", default=["application/json"], help="Content types to target for examples.") parser.add_argument("--default-status", default="200", help="Default status code for response files placed directly in 'responses' (no subfolder).") + parser.add_argument("--check", action="store_true", help="Check mode: report all missing folders without stopping at the first error.") args = parser.parse_args() + # Track errors in check mode + missing_folders = [] + missing_responses = [] + spec = load_spec(args.spec_path) if not isinstance(spec, dict): print("ERROR: Spec root must be an object.", file=sys.stderr) @@ -330,8 +335,12 @@ def main(): if op_id in exceptions: continue # Foutmelding als er geen folder aanwezig is voor een connector (geen responses mogelijk) - print(f"ERROR: Geen response aanwezig voor connector '{op_id}' ({method})", file=sys.stderr) - sys.exit(1) + if args.check: + missing_folders.append((op_id, method)) + continue + else: + print(f"ERROR: Geen response aanwezig voor connector '{op_id}' ({method})", file=sys.stderr) + sys.exit(1) # 1) Request examples examples_dir = op_dir / "examples" @@ -390,8 +399,36 @@ def main(): entry["op"] = opobj else: # Foutmelding als er geen response aanwezig is voor een connector - print(f"ERROR: Geen response aanwezig voor connector '{op_id}' ({method})", file=sys.stderr) + if args.check: + missing_responses.append((op_id, method)) + else: + print(f"ERROR: Geen response aanwezig voor connector '{op_id}' ({method})", file=sys.stderr) + sys.exit(1) + + # In check mode, report all errors and exit + if args.check: + if missing_folders or missing_responses: + print(f"\n{'='*60}") + print("CHECK RESULTS - Missing folders/responses") + print(f"{'='*60}\n") + + if missing_folders: + print(f"Missing operation folders ({len(missing_folders)}):") + for op_id, method in sorted(missing_folders): + print(f" - {op_id} ({method})") + print() + + if missing_responses: + print(f"Missing responses folders ({len(missing_responses)}):") + for op_id, method in sorted(missing_responses): + print(f" - {op_id}/responses/ ({method})") + print() + + print(f"Total issues: {len(missing_folders) + len(missing_responses)}") sys.exit(1) + else: + print("\nCheck passed: All operations have matching folders and responses.") + sys.exit(0) # Write output if args.inplace: From 47196b6aa5d0618949b76bcbaa973aab4423dfa7 Mon Sep 17 00:00:00 2001 From: Rein de Jager Date: Mon, 19 Jan 2026 09:03:05 +0100 Subject: [PATCH 5/8] Update version numbers in sb_openapi_specs_menu.json for 7.1.0 release --- menustructures/sb_openapi_specs_menu.json | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/menustructures/sb_openapi_specs_menu.json b/menustructures/sb_openapi_specs_menu.json index ef32794..9423242 100644 --- a/menustructures/sb_openapi_specs_menu.json +++ b/menustructures/sb_openapi_specs_menu.json @@ -2,14 +2,18 @@ "sb": { "nl": [ { - "name": "Versie 7.0.0", + "name": "Versie 7.1.0", "path": "OpenApiSpecs/sb/nl/7-0-0.json", "description": "Huidige productieversie" + }, { + "name": "Versie 7.0.0", + "path": "OpenApiSpecs/sb/nl/7-0-0.json", + "description": "Vorige versie" }, { "name": "Versie 6.2.0", "path": "OpenApiSpecs/sb/nl/6-2-0.json", - "description": "Vorige versie" + "description": "Oudere versie" }, { "name": "Versie 6.1.0", From d842ce584bbd0284d3395bef33d428817ace9b98 Mon Sep 17 00:00:00 2001 From: Rein de Jager Date: Tue, 20 Jan 2026 09:50:38 +0100 Subject: [PATCH 6/8] Update path for Versie 7.1.0 in sb_openapi_specs_menu.json so that it links to correct version --- menustructures/sb_openapi_specs_menu.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/menustructures/sb_openapi_specs_menu.json b/menustructures/sb_openapi_specs_menu.json index 9423242..061c603 100644 --- a/menustructures/sb_openapi_specs_menu.json +++ b/menustructures/sb_openapi_specs_menu.json @@ -3,7 +3,7 @@ "nl": [ { "name": "Versie 7.1.0", - "path": "OpenApiSpecs/sb/nl/7-0-0.json", + "path": "OpenApiSpecs/sb/nl/7-1-0.json", "description": "Huidige productieversie" }, { "name": "Versie 7.0.0", From 87971c6d7ea5809451000185359f0d0e5a1035e6 Mon Sep 17 00:00:00 2001 From: Tom Klute Date: Thu, 22 Jan 2026 10:51:48 +0100 Subject: [PATCH 7/8] Extra taak voor datastroomdiagram --- markdownpages/profit/en/partner-certification-steps.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/markdownpages/profit/en/partner-certification-steps.md b/markdownpages/profit/en/partner-certification-steps.md index 78ccd11..8c51cf2 100644 --- a/markdownpages/profit/en/partner-certification-steps.md +++ b/markdownpages/profit/en/partner-certification-steps.md @@ -119,6 +119,11 @@ An integration without customers is not an integration. To give our mutual custo Proud of your customers? Then submit references from customers where the integration runs to their satisfaction. You can do this at https://partner.afas.nl/aanmaken-aanvraag-partnerportal/referentie. +### Datastroomdiagram van de API-integratie +Een datastroomdiagram van een API‑integratie laat zien hoe gegevens tussen systemen bewegen. Het richt zich niet op de interne werking van de systemen, maar op welke data wordt uitgewisseld (bijvoorbeeld medewerkergegevens of verlofboekingen), in welke richting, via welke API‑aanroepen en door welke gebeurtenis of planning dit wordt gestart. Zo wordt helder welke endpoints gebruikt worden, wie de bron is, wie de ontvanger is en onder welke omstandigheden de uitwisseling plaatsvindt. + +Dit is belangrijk omdat het misverstanden voorkomt over wie welke data levert en ontvangt, en omdat het ontwikkelaars en beheerders helpt de integratie goed te ontwerpen, bouwen en beheren. Het diagram maakt impactanalyses bij wijzigingen eenvoudiger, omdat je direct ziet welke stromen geraakt worden, en het fungeert als duidelijke, blijvende documentatie voor beheer en toekomstige uitbreidingen. Bovendien biedt het een concreet hulpmiddel om de koppeling te optimaliseren, bijvoorbeeld door overbodige datastromen te schrappen of efficiëntere uitwisselmomenten te kiezen. + ## Contact We are ready to ensure your integration runs smoothly and retrieves the right data. We are also happy to help with other questions. Do not send an email, but submit a request via the portal! That's easy: From f6839dbde9a0eb0be7d95ce7275d93eb1ca77866 Mon Sep 17 00:00:00 2001 From: Tom Klute Date: Thu, 22 Jan 2026 17:02:31 +0100 Subject: [PATCH 8/8] added dataflow task --- markdownpages/profit/en/partner-certification-steps.md | 6 ++++++ markdownpages/profit/nl/partner-certification-steps.md | 7 +++++++ 2 files changed, 13 insertions(+) diff --git a/markdownpages/profit/en/partner-certification-steps.md b/markdownpages/profit/en/partner-certification-steps.md index 8c51cf2..81b4129 100644 --- a/markdownpages/profit/en/partner-certification-steps.md +++ b/markdownpages/profit/en/partner-certification-steps.md @@ -124,6 +124,12 @@ Een datastroomdiagram van een API‑integratie laat zien hoe gegevens tussen sys Dit is belangrijk omdat het misverstanden voorkomt over wie welke data levert en ontvangt, en omdat het ontwikkelaars en beheerders helpt de integratie goed te ontwerpen, bouwen en beheren. Het diagram maakt impactanalyses bij wijzigingen eenvoudiger, omdat je direct ziet welke stromen geraakt worden, en het fungeert als duidelijke, blijvende documentatie voor beheer en toekomstige uitbreidingen. Bovendien biedt het een concreet hulpmiddel om de koppeling te optimaliseren, bijvoorbeeld door overbodige datastromen te schrappen of efficiëntere uitwisselmomenten te kiezen. +### Data flow diagram of the API integration + +A data flow diagram of an API integration shows how data moves between systems. It does not focus on the internal workings of the systems, but rather on what data is exchanged (for example, employee data or leave bookings), in which direction, via which API calls, and what event or schedule triggers this exchange. This makes it clear which endpoints are used, who the source is, who the recipient is, and under what circumstances the exchange takes place. + +This is important because it prevents misunderstandings about who supplies and receives what data, and because it helps developers and administrators design, build, and maintain the integration properly. The diagram makes impact analyses of changes easier, as you can directly see which flows are affected, and it serves as clear, lasting documentation for management and future expansions. Additionally, it provides a concrete tool to optimize the integration, for example by removing redundant data flows or choosing more efficient exchange moments. + ## Contact We are ready to ensure your integration runs smoothly and retrieves the right data. We are also happy to help with other questions. Do not send an email, but submit a request via the portal! That's easy: diff --git a/markdownpages/profit/nl/partner-certification-steps.md b/markdownpages/profit/nl/partner-certification-steps.md index 8be21fe..7e61f68 100644 --- a/markdownpages/profit/nl/partner-certification-steps.md +++ b/markdownpages/profit/nl/partner-certification-steps.md @@ -138,6 +138,13 @@ Een koppeling zonder klanten is geen koppeling. Om onze gezamenlijke klanten zek Ben je trots op je klanten? Stuur dan referenties in van de klanten waar de koppeling naar tevredenheid loopt. Dat doe je op https://partner.afas.nl/aanmaken-aanvraag-partnerportal/referentie. +### Datastroomdiagram van de API-integratie + +Een datastroomdiagram van een API‑integratie laat zien hoe gegevens tussen systemen bewegen. Het richt zich niet op de interne werking van de systemen, maar op welke data wordt uitgewisseld (bijvoorbeeld medewerkergegevens of verlofboekingen), in welke richting, via welke API‑aanroepen en door welke gebeurtenis of planning dit wordt gestart. Zo wordt helder welke endpoints gebruikt worden, wie de bron is, wie de ontvanger is en onder welke omstandigheden de uitwisseling plaatsvindt. + +Dit is belangrijk omdat het misverstanden voorkomt over wie welke data levert en ontvangt, en omdat het ontwikkelaars en beheerders helpt de integratie goed te ontwerpen, bouwen en beheren. Het diagram maakt impactanalyses bij wijzigingen eenvoudiger, omdat je direct ziet welke stromen geraakt worden, en het fungeert als duidelijke, blijvende documentatie voor beheer en toekomstige uitbreidingen. Bovendien biedt het een concreet hulpmiddel om de koppeling te optimaliseren, bijvoorbeeld door overbodige datastromen te schrappen of efficiëntere uitwisselmomenten te kiezen. + + ## Contact Wij staan voor je klaar om ervoor te zorgen dat jouw koppeling soepel loopt en de juiste gegevens ophaalt. Ook bij andere vragen helpen we je graag. Stuur geen mail, maar maak een aanvraag via de portal! Dat werkt eenvoudig: