{ "openapi": "3.0.2", "info": { "version": "7.3", "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", "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/balancetotalscurrentyear": { "get": { "description": "Retrieve cumulative ledger account totals for balance sheet reporting of the current year", "summary": "balancetotalscurrentyear 1.0", "operationId": "getconnector-balancetotalscurrentyear-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" }, "LedgerAccountId": { "type": "string", "format": "uuid" }, "LedgerAccount": { "type": "string" }, "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/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" }, "PreferredIncomingPayments": { "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/profitlosstotalscurrentyear": { "get": { "description": "Retrieve cumulative ledger account totals for profit & loss reporting of the current year", "summary": "profitlosstotalscurrentyear 1.0", "operationId": "getconnector-profitlosstotalscurrentyear-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" }, "LedgerAccountId": { "type": "string", "format": "uuid" }, "LedgerAccount": { "type": "string" }, "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/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.2", "operationId": "getconnector-salesinvoices-get-1.2", "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.2" } }, { "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" } } } }, "SalesInvoiceId": { "type": "string", "format": "uuid" }, "AmountExcludingVat": { "type": "number" }, "AmountVat": { "type": "number" }, "AmountInvoiced": { "type": "number" } } } } } } }, "404": { "$ref": "#/components/responses/404" }, "5XX": { "description": "Internal Server Error" } }, "version": "1.2", "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", "maxLength": 255 }, "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", "maxLength": 255, "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.", "maxLength": 255, "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.", "maxLength": 255, "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" } } } } } } } } } } }