{ "openapi": "3.0.0", "info": { "version": "5.0.0", "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": { "/app/token": { "post": { "summary": "Get an access token for a scope.", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "grant_type": { "type": "string" }, "refresh_token": { "type": "string" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" } } } } } }, "responses": { "200": { "description": "Access token successfully retrieved", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "expires_in": { "type": "integer" }, "token_type": { "type": "string" } } } } } } }, "tags": [ "Autorisatie" ] } }, "/authentication/getaccesstoken": { "post": { "summary": "Provide a manual created app token to get an access token.", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/no-cors" } ], "requestBody": { "description": "Application token", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "apptoken": { "type": "string", "examples": [ "APPTOKEN" ] }, "scope": { "type": "string", "examples": [ "demo" ] } }, "required": [ "apptoken" ] } } } }, "responses": { "200": { "description": "OK" }, "5XX": { "description": "Internal Server Error" } }, "security": [ { "Applicationtoken": [] } ], "tags": [ "Autorisatie" ] } }, "/authentication/getscopes": { "post": { "summary": "Get scopes: Provide an identity token returned by the \u0027AccessToken\u0027 api.", "parameters": [ { "in": "header", "name": "Accept", "schema": { "type": "string", "examples": [ "application/json" ] } }, { "in": "header", "name": "IdentityToken", "schema": { "type": "string", "examples": [ "IDENTITYTOKEN" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Name": { "type": "string", "examples": [ "Beheer" ] }, "Path": { "type": "string", "examples": [ "admin" ] } } } } } } }, "5XX": { "description": "Internal Server Error" } }, "security": [ { "OAuth2AdminCenter": [] } ], "tags": [ "Autorisatie" ] } }, "/api/blob/{uuid}": { "get": { "summary": "Retrieve a specific blob by UUID", "description": "Retrieve a specific blob by UUID", "operationId": "getBlob", "parameters": [ { "name": "uuid", "in": "path", "description": "UUID of the blob", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/authorization" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "description": "Blob retrieved successfully", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "description": "An unexpected error occurred" } }, "security": [ { "OAuth2klantomgeving": [] } ], "tags": [ "Attachments", "Inkoopjournaalpost", "Verkoopfactuur", "Verkoopjournaalpost", "Publiek: Externe facturatie" ] }, "put": { "summary": "Reserve Blob Space \u0026 Upload Blob", "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.\n\nThe blob UUID must be generated client side.", "parameters": [ { "$ref": "#/components/parameters/authorization" }, { "$ref": "#/components/parameters/accept-version" }, { "name": "Blob-Content-Length", "in": "header", "schema": { "type": "integer", "examples": [ 423536 ], "format": "int64" }, "required": true, "description": "Length in bytes" }, { "name": "Blob-Content-Type", "in": "header", "schema": { "type": "string", "examples": [ "image/jpeg", "application/pdf" ] }, "required": true, "description": "File type" }, { "name": "Blob-Content-FileName", "in": "header", "schema": { "type": "string", "examples": [ "attachment.jpg", "invoice.pdf" ] }, "required": true, "description": "ExampleBlobFile.pdf" }, { "name": "Blob-Upload-Type", "in": "header", "description": "blob", "schema": { "type": "string", "default": "blob" }, "required": true }, { "schema": { "type": "string", "format": "uuid", "examples": [ "3b642fed-f4ec-4463-986a-745531ccbbb8" ] }, "in": "path", "name": "uuid", "required": true, "description": "UUID of the blob. This should be generated client side." } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "BlobAccepted": { "type": "boolean" }, "ChunkSize": { "type": "integer" } } }, "examples": { "OK": { "value": { "BlobAccepted": true, "ChunkSize": 5242880 } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" } }, "operationId": "reserveBlobSpace", "security": [ { "OAuth2klantomgeving": [] } ], "tags": [ "Attachments", "Inkoopjournaalpost", "Verkoopfactuur", "Verkoopjournaalpost", "Publiek: Externe facturatie" ] } }, "/api/accountingperiod": { "get": { "tags": [ "Publiek: Financi\u00EBle dashboarding", "Publiek: Financi\u00EBle rapportage", "Financiele rapportage" ], "description": "accountingperiod 1.0", "operationId": "get_accountingperiod_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id", "format": "uuid" }, "AccountingYear": { "type": "string", "description": "AccountingYear", "format": "uuid" }, "Description": { "type": "string", "description": "Description", "format": "string" }, "StartDate": { "type": "string", "description": "StartDate", "format": "DateTime?" }, "EndDate": { "type": "string", "description": "EndDate", "format": "DateTime?" } } } }, "examples": { "example": { "value": [ { "Id": "a8efbf98-a825-43bb-adce-006a4817de74", "Description": "Juli 2037", "StartDate": "2037-07-01T00:00:00Z", "EndDate": "2037-07-31T00:00:00Z", "AccountingYear": "e35f93f1-ccbb-4687-be5f-16b75c8d10db" }, { "Id": "ac308a83-0de4-4396-bc48-028e0eb27fb0", "Description": "Juli 2051", "StartDate": "2051-07-01T00:00:00Z", "EndDate": "2051-07-31T00:00:00Z", "AccountingYear": "b7517955-2179-4d21-aa10-ed9a57858f79" }, { "Id": "0d06fd00-ab71-4fdd-8064-02e062a6b8b9", "Description": "Mei 2047", "StartDate": "2047-05-01T00:00:00Z", "EndDate": "2047-05-31T00:00:00Z", "AccountingYear": "450f0f1f-998a-4e22-89d9-78c310f02158" }, { "Id": "0da61200-855e-4e19-a9c8-03801ba05e58", "Description": "Maart 2023", "StartDate": "2023-03-01T00:00:00Z", "EndDate": "2023-03-31T00:00:00Z", "AccountingYear": "0f0c88f6-81e9-49bb-98da-996054aedcb2" }, { "Id": "d84e67a0-e69f-44d8-b44d-038ca22aed9d", "Description": "Januari 2021", "StartDate": "2021-01-01T00:00:00Z", "EndDate": "2021-01-31T00:00:00Z", "AccountingYear": "b07043c5-9e20-4884-92f9-8da9deeae84f" }, { "Id": "8dbdf892-bf68-48a8-ae76-03f617a232db", "Description": "Juni 2025", "StartDate": "2025-06-01T00:00:00Z", "EndDate": "2025-06-30T00:00:00Z", "AccountingYear": "0b80213d-5aa9-4d4f-88a3-b286cb3d9642" }, { "Id": "cc85b76f-03df-4fef-88d6-03f6e5cf1d6c", "Description": "Juli 2048", "StartDate": "2048-07-01T00:00:00Z", "EndDate": "2048-07-31T00:00:00Z", "AccountingYear": "08723b52-f16f-4400-828b-7b8b5e1607dc" }, { "Id": "6af7d56c-c0ea-487c-9d59-045e7ece543f", "Description": "Februari 2042", "StartDate": "2042-02-01T00:00:00Z", "EndDate": "2042-02-28T00:00:00Z", "AccountingYear": "8737c613-8b1e-485f-8266-13b255f34d81" }, { "Id": "e6b6c5ff-f032-4eaa-9bb9-05d4cb0f3ed4", "Description": "Oktober 2022", "StartDate": "2022-10-01T00:00:00Z", "EndDate": "2022-10-31T00:00:00Z", "AccountingYear": "6317474b-c5b4-4bac-8c51-5f28dbc6c9bb" }, { "Id": "5ee13ba7-b57f-4646-b066-068f26700f40", "Description": "April 2050", "StartDate": "2050-04-01T00:00:00Z", "EndDate": "2050-04-30T00:00:00Z", "AccountingYear": "f38bc252-f698-49e4-a202-ca27c7780afc" } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/accountingyear": { "get": { "tags": [ "Publiek: Financi\u00EBle dashboarding", "Publiek: Financi\u00EBle rapportage", "Financiele rapportage" ], "description": "accountingyear 1.0", "operationId": "get_accountingyear_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id", "format": "uuid" }, "Description": { "type": "string", "description": "Description", "format": "string" }, "StartDate": { "type": "string", "description": "StartDate", "format": "DateTime?" }, "EndDate": { "type": "string", "description": "EndDate", "format": "DateTime?" } } } }, "examples": { "example": { "value": [ { "Id": "ce568aca-a5d3-4a64-82b9-0189212f4d9e", "Description": "2036", "StartDate": "2036-01-01T00:00:00Z", "EndDate": "2036-12-31T00:00:00Z" }, { "Id": "8737c613-8b1e-485f-8266-13b255f34d81", "Description": "2042", "StartDate": "2042-01-01T00:00:00Z", "EndDate": "2042-12-31T00:00:00Z" }, { "Id": "2ce12ab3-f97e-4110-b96e-15f7cd7ce621", "Description": "2029", "StartDate": "2029-01-01T00:00:00Z", "EndDate": "2029-12-31T00:00:00Z" }, { "Id": "e35f93f1-ccbb-4687-be5f-16b75c8d10db", "Description": "2037", "StartDate": "2037-01-01T00:00:00Z", "EndDate": "2037-12-31T00:00:00Z" }, { "Id": "38949d86-13f7-42fd-8a7f-19fcfd6352c3", "Description": "2040", "StartDate": "2040-01-01T00:00:00Z", "EndDate": "2040-12-31T00:00:00Z" }, { "Id": "6c954c1a-394d-4fa1-9e08-25518a0d277c", "Description": "2038", "StartDate": "2038-01-01T00:00:00Z", "EndDate": "2038-12-31T00:00:00Z" }, { "Id": "63fb5feb-7b1e-4126-9ac2-34567579eb52", "Description": "2030", "StartDate": "2030-01-01T00:00:00Z", "EndDate": "2030-12-31T00:00:00Z" }, { "Id": "1aa5bf8c-4e27-4876-9a6b-391aacffc9ca", "Description": "2049", "StartDate": "2049-01-01T00:00:00Z", "EndDate": "2049-12-31T00:00:00Z" }, { "Id": "0e5440a7-6ec9-4637-9d4b-44382ca65fd3", "Description": "2044", "StartDate": "2044-01-01T00:00:00Z", "EndDate": "2044-12-31T00:00:00Z" }, { "Id": "bfa6c680-46a4-49d3-8b03-5195c9f85e19", "Description": "2046", "StartDate": "2046-01-01T00:00:00Z", "EndDate": "2046-12-31T00:00:00Z" } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/address": { "get": { "tags": [ "Relaties" ], "description": "address 1.0", "operationId": "get_address_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id", "format": "uuid" }, "StreetName": { "type": "string", "description": "StreetName", "format": "string" }, "HouseNumber": { "type": "string", "description": "HouseNumber", "format": "string" }, "HouseNumberAddition": { "type": "string", "description": "HouseNumberAddition" }, "PostalZone": { "type": "string", "description": "PostalZone", "format": "string" }, "City": { "type": "string", "description": "City", "format": "string" }, "Country": { "type": "string", "description": "Country", "format": "string" }, "RelationId": { "type": "string", "description": "RelationId" }, "IsPreferedInvoiceAddress": { "type": "string", "description": "IsPreferedInvoiceAddress" }, "IsPreferedSupplierAddress": { "type": "string", "description": "IsPreferedSupplierAddress" }, "RelationTypeId": { "type": "string", "description": "RelationTypeId" }, "IsOrganisation": { "type": "string", "description": "IsOrganisation" }, "IsPerson": { "type": "string", "description": "IsPerson" }, "Organisation": { "type": "string", "description": "Organisation" }, "Person": { "type": "string", "description": "Person" }, "RelationType": { "type": "string", "description": "RelationType" } } } }, "examples": { "example": { "value": { "TrackingToken": "202409230720571", "Result": [ { "Id": "56528a1b-4bea-5699-abb8-f66155e9c497", "StreetName": "Reactorweg", "HouseNumber": "47", "HouseNumberAddition": null, "PostalZone": "3542 AD", "RelationId": "4fa13b8e-44dc-5cf7-b2ef-35e14be401e8", "IsPreferedInvoiceAddress": true, "IsPreferedSupplierAddress": true, "CityName": "Utrecht", "CountryName": "Nederland", "RelationType": "organisation" } ] } } } } } } }, "security": [ { "access_token": [] } ], "deprecated": true }, "post": { "tags": [ "Relaties" ], "description": "address 1.0", "operationId": "post_address_1.0_create", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "success": { "value": { "result": "Succeeded", "instances": [ { "Code": "Adres", "Id": "bea5e01e-e1a0-4b04-819a-3347ebca2ba4" } ], "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-address-1.0-create_request" }, "examples": { "New addres for organisation": { "value": { "RelationType": "organisation", "RelationId": "8afb1a9a-1613-5e2b-ab19-20c0f4f3e216", "StreetName": "Voorthuizerstraat", "HouseNumber": 16, "HouseNumberAddition": "A", "PostalZone": "3881SH", "CityName": "Putten", "CountryCode": "NL" } }, "New addres for person": { "value": { "RelationType": "person", "RelationId": "8afb1a9a-1613-5e2b-ab19-20c0f4f3e216", "StreetName": "Voorthuizerstraat", "HouseNumber": 16, "HouseNumberAddition": "A", "PostalZone": "3881SH", "CityName": "Putten", "CountryCode": "NL" } }, "New address DE": { "value": { "RelationType": "organisation", "RelationId": "8afb1a9a-1613-5e2b-ab19-20c0f4f3e216", "StreetName": "Berliner Stra\u00DFe", "HouseNumber": 10, "HouseNumberAddition": "", "PostalZone": "10115", "CityName": "Berlijn", "CountryCode": "DE" } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/addresses": { "get": { "tags": [ "Inkoopjournaalpost", "Publiek: Relatiemanagement", "Relaties", "Verkoopfactuur" ], "description": "addresses 1.0", "operationId": "get_addresses_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id", "format": "uuid" }, "StreetName": { "type": "string", "description": "StreetName", "format": "string" }, "HouseNumber": { "type": "string", "description": "HouseNumber", "format": "string" }, "HouseNumberAddition": { "type": "string", "description": "HouseNumberAddition" }, "PostalZone": { "type": "string", "description": "PostalZone", "format": "string" }, "CityName": { "type": "string", "description": "CityName", "format": "string" }, "CountryName": { "type": "string", "description": "CountryName", "format": "string" }, "RelationId": { "type": "string", "description": "RelationId" }, "IsPreferedInvoiceAddress": { "type": "string", "description": "IsPreferedInvoiceAddress" }, "IsPreferedSupplierAddress": { "type": "string", "description": "IsPreferedSupplierAddress" }, "RelationTypeId": { "type": "string", "description": "RelationTypeId" }, "IsOrganisation": { "type": "string", "description": "IsOrganisation" }, "IsPerson": { "type": "string", "description": "IsPerson" }, "Organisation": { "type": "string", "description": "Organisation" }, "Person": { "type": "string", "description": "Person" }, "RelationType": { "type": "string", "description": "RelationType" } } } }, "examples": { "example": { "value": { "TrackingToken": "202409230720571", "Result": [ { "Id": "56528a1b-4bea-5699-abb8-f66155e9c497", "StreetName": "Reactorweg", "HouseNumber": "47", "HouseNumberAddition": null, "PostalZone": "3542 AD", "RelationId": "4fa13b8e-44dc-5cf7-b2ef-35e14be401e8", "IsPreferedInvoiceAddress": true, "IsPreferedSupplierAddress": true, "CityName": "Utrecht", "CountryName": "Nederland", "RelationType": "organisation" } ] } } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/administration": { "get": { "tags": [ "Loonjournaalpost", "POS Transacties", "Inkoopjournaalpost", "Verkoopfactuur", "Verkoopjournaalpost" ], "description": "administration 1.0", "operationId": "get_administration_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Description": { "type": "string", "description": "Description" }, "InstanceId": { "type": "string", "description": "InstanceId" }, "Id": { "type": "string", "description": "Id" } } } }, "examples": { "example": { "value": [ { "Id": "701b747b-eea2-5ed1-8518-973e5c670252", "Description": "EnYoi Holding B.V.", "InstanceId": "701b747b-eea2-5ed1-8518-973e5c670252" }, { "Id": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "Description": "EnYoi ICT Services B.V.", "InstanceId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911" } ] } } } } } }, "security": [ { "access_token": [] } ], "deprecated": true } }, "/api/administrations": { "get": { "tags": [ "Financi\u00EBle journaalpost", "Financiele rapportage", "Publiek: Externe verkoopregels", "Verkoopregels", "Loonjournaalpost", "POS Transacties", "Inkoopjournaalpost", "Verkoopfactuur", "Publiek: Externe facturatie", "Verkoopjournaalpost" ], "description": "administrations 1.0", "operationId": "get_administrations_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Description": { "type": "string", "description": "Description" }, "InstanceId": { "type": "string", "description": "InstanceId" }, "Id": { "type": "string", "description": "Id" } } } }, "examples": { "example": { "value": [ { "Id": "701b747b-eea2-5ed1-8518-973e5c670252", "Description": "EnYoi Holding B.V.", "InstanceId": "701b747b-eea2-5ed1-8518-973e5c670252" }, { "Id": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "Description": "EnYoi ICT Services B.V.", "InstanceId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911" } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/bankaccount": { "get": { "tags": [ "Inkoopjournaalpost", "Relaties" ], "description": "bankaccount 1.0", "operationId": "get_bankaccount_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id", "format": "uuid" }, "Bankrekening": { "type": "string", "description": "Bankrekening", "format": "string" }, "RelationId": { "type": "string", "description": "RelationId" } } } }, "examples": { "example": { "value": [ { "Id": "0d83610b-e1fc-53a2-a951-00f9098e0154", "Bankrekening": "NL10INGB0675488052", "RelationId": "b323458f-5bae-542b-8294-9040c9801805" }, { "Id": "dd6cbc4b-6ec6-59c0-95ca-020b5977b39a", "Bankrekening": "NL16RABO0300417497", "RelationId": "b24405d6-fee2-52f5-8f24-c1a0180e46f2" } ] } } } } } }, "security": [ { "access_token": [] } ], "deprecated": true }, "post": { "tags": [ "Relaties" ], "description": "bankaccount 1.0", "operationId": "post_bankaccount_1.0_create", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "Success": { "value": { "result": "Succeeded", "instances": [ { "Code": "Bankrekening", "Id": "4738e143-e582-4b38-a8af-9d1f1e12bfca" } ], "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-bankaccount-1.0-create_request" }, "examples": { "New bankaccount organisation": { "value": { "RelationType": "organisation", "RelationId": "8afb1a9a-1613-5e2b-ab19-20c0f4f3e216", "AccountNumber": "NL82BKCH0618141243", "BIC": "BKCHNL2R", "CountryCode": "NL", "AccountHolderName": "Balistreri" } }, "New bankaccount person": { "value": { "RelationType": "person", "RelationId": "8afb1a9a-1613-5e2b-ab19-20c0f4f3e216", "AccountNumber": "NL82BKCH0618141243", "BIC": "BKCHNL2R", "CountryCode": "NL", "AccountHolderName": "Balistreri" } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/bankaccounts": { "get": { "tags": [ "Inkoopjournaalpost", "Publiek: Relatiemanagement", "Relaties" ], "description": "bankaccounts 1.0", "operationId": "get_bankaccounts_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id", "format": "uuid" }, "AccountNumber": { "type": "string", "description": "AccountNumber", "format": "string" }, "RelationIsOrganisationOrAdministration": { "type": "string", "description": "RelationIsOrganisationOrAdministration" }, "RelationType": { "type": "string", "description": "RelationType" }, "RelationId": { "type": "string", "description": "RelationId" } } } }, "examples": { "bankaccounts": { "value": { "TrackingToken": "202406211216501", "Result": [ { "Id": "0d83610b-e1fc-53a2-a951-00f9098e0154", "AccountNumber": "NL10INGB0675488052", "RelationId": "b323458f-5bae-542b-8294-9040c9801805" }, { "Id": "dd6cbc4b-6ec6-59c0-95ca-020b5977b39a", "AccountNumber": "NL16RABO0300417497", "RelationId": "b24405d6-fee2-52f5-8f24-c1a0180e46f2" } ] } } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/contacts": { "get": { "tags": [ "Publiek: Relatiemanagement", "Relaties" ], "description": "contacts 1.0", "operationId": "get_contacts_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" }, { "$ref": "#/components/parameters/trackingtoken" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "TrackingToken": { "type": "string", "description": "Tracking token", "format": "string" }, "Result": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id" }, "OrganisationId": { "type": "string", "description": "OrganisationId", "format": "uuid" }, "PersonId": { "type": "string", "description": "PersonId" }, "Name": { "type": "string", "description": "Name", "format": "string" }, "Firstname": { "type": "string", "description": "Firstname", "format": "string" }, "Initials": { "type": "string", "description": "Initials", "format": "string" }, "Prefix": { "type": "string", "description": "Prefix", "format": "string" }, "Lastname": { "type": "string", "description": "Lastname", "format": "string" }, "PhoneNumber": { "type": "string", "description": "PhoneNumber", "format": "string" }, "Emailaddress": { "type": "string", "description": "Emailaddress", "format": "string" }, "ExternalId": { "type": "string", "description": "ExternalId", "format": "string" }, "IsArchived": { "type": "boolean", "description": "IsArchived", "format": "bool" }, "PersonIsArchived": { "type": "boolean", "description": "PersonIsArchived", "format": "bool" }, "OrganisationIsArchived": { "type": "boolean", "description": "OrganisationIsArchived", "format": "bool" } } } } } }, "examples": { "example": { "value": { "TrackingToken": "202403280856491", "Result": [ { "Id": "0236d0dc-b5be-5b6e-b191-17f6b767aa5b", "IsArchived": false, "OrganisationId": "e97ecfe3-8bcb-5baf-82e4-4e46b2b02126", "OrganisatieIsArchived": false, "Name": "Peter de Jager", "FirstName": "Peter", "Initials": "P.", "Prefix": "de", "Lastname": "Jager", "ExternalId": null, "PersoonIsArchived": false }, { "Id": "2c5b3f1d-1689-5257-9ab2-2ba634203b2c", "IsArchived": false, "OrganisationId": "c589e4b3-d131-5a1b-9eca-44dd2fc17600", "OrganisatieIsArchived": false, "Name": "Trudie Feenstra", "FirstName": "Trudie", "Initials": "T.", "Prefix": null, "Lastname": "Feenstra", "ExternalId": null, "PersoonIsArchived": false }, { "Id": "416b5ea9-93bd-5cfc-af07-37f1681da00b", "IsArchived": false, "OrganisationId": "bb3fd8ef-5a0e-5919-8e67-77b396abf212", "OrganisatieIsArchived": false, "Name": "Yousef Martiqui", "FirstName": "Yousef", "Initials": "Y.", "Prefix": null, "Lastname": "Martiqui", "ExternalId": null, "PersoonIsArchived": false } ] } } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/countries": { "get": { "tags": [ "Inkoopjournaalpost", "Publiek: Relatiemanagement", "Relaties" ], "description": "countries 1.0", "operationId": "get_countries_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id", "format": "uuid" }, "Description": { "type": "string", "description": "Description", "format": "string" }, "CodeISOAlpha2": { "type": "string", "description": "CodeISOAlpha2", "format": "string" } } } }, "examples": { "countries": { "value": { "TrackingToken": "202406211218251", "Result": [ { "Id": "afa50000-0000-0ab9-bf40-00958bc94cc8", "Description": "Tadzjikistan", "CodeISOAlpha2": "TJ" }, { "Id": "afa50000-0000-0be2-8a70-01f36103d3cd", "Description": "Heard Eiland en McDonald Eilanden", "CodeISOAlpha2": "HM" } ] } } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/country": { "get": { "tags": [ "Inkoopjournaalpost", "Relaties" ], "description": "country 1.0", "operationId": "get_country_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id", "format": "uuid" }, "Description": { "type": "string", "description": "Description", "format": "string" }, "CodeISOAlpha2": { "type": "string", "description": "CodeISOAlpha2", "format": "string" } } } }, "examples": { "example": { "value": [ { "Id": "afa50000-0000-0ab9-bf40-00958bc94cc8", "Description": "Tadzjikistan", "CodeISOAlpha2": "TJ" }, { "Id": "afa50000-0000-0be2-8a70-01f36103d3cd", "Description": "Heard Eiland en McDonald Eilanden", "CodeISOAlpha2": "HM" } ] } } } } } }, "security": [ { "access_token": [] } ], "deprecated": true } }, "/api/creditorbalance": { "get": { "tags": [ "Crediteuren" ], "description": "creditorbalance 1.0", "operationId": "get_creditorbalance_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "AdministrationId": { "type": "string", "description": "AdministrationId" }, "RelationTypeId": { "type": "string", "description": "RelationTypeId" }, "IsOrganisation": { "type": "string", "description": "IsOrganisation" }, "IsPerson": { "type": "string", "description": "IsPerson" }, "IsUnknown": { "type": "string", "description": "IsUnknown" }, "Organisation": { "type": "string", "description": "Organisation" }, "Person": { "type": "string", "description": "Person" }, "Unknown": { "type": "string", "description": "Unknown" }, "RelationType": { "type": "string", "description": "RelationType" }, "RelationId": { "type": "string", "description": "RelationId" }, "RelationName": { "type": "string", "description": "RelationName" }, "OutstandingAmount": { "type": "string", "description": "OutstandingAmount", "format": "decimal?" } } } }, "examples": { "example": { "value": [ { "OutstandingAmount": 1586.3100000000, "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", "RelationId": "296a5ec3-0efb-528d-9afd-7ab3b3c914c1", "RelationName": "Stichting Mollie Payments", "InstanceId": "8b0ecc00-2b87-4eaa-bd19-3b9db7f297c4", "RelationType": "organisation" }, { "OutstandingAmount": 28597.1400000000, "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", "RelationName": "AFAS Software B.V.", "InstanceId": "072672c2-c859-4eef-a0be-7e760b57af6f", "RelationType": "organisation" } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/creditorinvoicebalance": { "get": { "tags": [ "Crediteuren" ], "description": "creditorinvoicebalance 1.0", "operationId": "get_creditorinvoicebalance_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "AdministrationId": { "type": "string", "description": "AdministrationId" }, "RelationTypeId": { "type": "string", "description": "RelationTypeId" }, "IsOrganisation": { "type": "string", "description": "IsOrganisation" }, "IsPerson": { "type": "string", "description": "IsPerson" }, "IsUnknown": { "type": "string", "description": "IsUnknown" }, "Organisation": { "type": "string", "description": "Organisation" }, "Person": { "type": "string", "description": "Person" }, "Unknown": { "type": "string", "description": "Unknown" }, "RelationType": { "type": "string", "description": "RelationType" }, "RelationId": { "type": "string", "description": "RelationId" }, "RelationName": { "type": "string", "description": "RelationName" }, "OutstandingAmount": { "type": "string", "description": "OutstandingAmount", "format": "decimal?" }, "InvoiceNumber": { "type": "string", "description": "InvoiceNumber", "format": "string" }, "InvoiceDate": { "type": "string", "description": "InvoiceDate", "format": "DateTime?" }, "CustomerReference": { "type": "string", "description": "CustomerReference", "format": "string" }, "PaidAmount": { "type": "string", "description": "PaidAmount", "format": "decimal?" }, "ProcessingAmount": { "type": "string", "description": "ProcessingAmount", "format": "decimal?" }, "TotalAmount": { "type": "string", "description": "TotalAmount", "format": "decimal?" }, "DueDate": { "type": "string", "description": "DueDate", "format": "DateTime?" }, "InternalInvoiceNumber": { "type": "string", "description": "InternalInvoiceNumber", "format": "string" }, "InvoiceId": { "type": "string", "description": "InvoiceId", "format": "uuid" } } } }, "examples": { "example": { "value": [ { "OutstandingAmount": 1586.3100000000, "PaidAmount": 0.0000000000, "ProcessingAmount": 0.0000000000, "TotalAmount": 1586.3100000000, "DueDate": "2024-12-13T00:00:00Z", "InvoiceId": "1ae8da84-9dd1-427a-a636-25aa53162dbf", "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", "InvoiceNumber": "123", "InvoiceDate": "2024-12-13T00:00:00Z", "CustomerReference": null, "InternalInvoiceNumber": "IF240003", "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", "RelationId": "296a5ec3-0efb-528d-9afd-7ab3b3c914c1", "RelationName": "Stichting Mollie Payments", "InstanceId": "9ea0e72a-b424-485d-82b1-09363aefcdce", "RelationType": "organisation" }, { "OutstandingAmount": 28341.8300000000, "PaidAmount": 0.0000000000, "ProcessingAmount": 0.0000000000, "TotalAmount": 28341.8300000000, "DueDate": "2024-12-27T00:00:00Z", "InvoiceId": "b3823933-d138-468a-a071-4e517feca9b9", "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", "InvoiceNumber": "20241231", "InvoiceDate": "2024-12-13T00:00:00Z", "CustomerReference": null, "InternalInvoiceNumber": "IF240001", "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", "RelationName": "AFAS Software B.V.", "InstanceId": "b7e76bdf-1152-4d54-8224-ad6a421fc84f", "RelationType": "organisation" }, { "OutstandingAmount": 255.3100000000, "PaidAmount": 0.0000000000, "ProcessingAmount": 0.0000000000, "TotalAmount": 255.3100000000, "DueDate": "2025-01-14T00:00:00Z", "InvoiceId": "6a25941f-2c35-4736-b963-6c63be0e82b4", "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", "InvoiceNumber": "20241232", "InvoiceDate": "2024-12-31T00:00:00Z", "CustomerReference": null, "InternalInvoiceNumber": "IF240002", "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", "RelationName": "AFAS Software B.V.", "InstanceId": "ac5f3b30-6296-4864-86c6-cecede47984d", "RelationType": "organisation" } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/debtorbalance": { "get": { "tags": [ "Debiteuren" ], "description": "debtorbalance 2.0", "operationId": "get_debtorbalance_2.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "name": "Accept-Version", "in": "header", "example": "2.0", "required": true, "schema": { "type": "string" }, "description": "Use the sequence number of the endpoint." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "AdministrationId": { "type": "string", "description": "AdministrationId", "format": "uuid" }, "OutstandingAmount": { "type": "string", "description": "OutstandingAmount", "format": "decimal?" }, "RelationId": { "type": "string", "description": "RelationId" }, "RelationTypeId": { "type": "string", "description": "RelationTypeId" }, "IsOrganisation": { "type": "string", "description": "IsOrganisation" }, "IsPerson": { "type": "string", "description": "IsPerson" }, "IsUnknown": { "type": "string", "description": "IsUnknown" }, "Organisation": { "type": "string", "description": "Organisation" }, "Person": { "type": "string", "description": "Person" }, "Unknown": { "type": "string", "description": "Unknown" }, "RelationType": { "type": "string", "description": "RelationType" }, "RelationName": { "type": "string", "description": "RelationName", "format": "string" } } } }, "examples": { "example": { "value": [ { "OutstandingAmount": 684.8600000000, "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", "RelationName": "AFAS Software B.V.", "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", "InstanceId": "9b9c7f38-d059-4a9c-b3a0-3e0562bd0115", "RelationType": "organisation" }, { "OutstandingAmount": 640.0900000000, "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", "RelationName": "Mollie B.V.", "RelationId": "3709fb45-c646-5cca-8de7-e6433404316a", "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", "InstanceId": "d33f3c36-d120-448c-92bd-0dbdeb2985bd", "RelationType": "organisation" } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/debtorinvoicebalance": { "get": { "tags": [ "Debiteuren", "Publiek: Externe facturatie" ], "description": "debtorinvoicebalance 3.0", "operationId": "get_debtorinvoicebalance_3.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "name": "Accept-Version", "in": "header", "example": "3.0", "required": true, "schema": { "type": "string" }, "description": "Use the sequence number of the endpoint." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "AdministrationId": { "type": "string", "description": "AdministrationId", "format": "uuid" }, "InvoiceDate": { "type": "string", "description": "InvoiceDate", "format": "DateTime?" }, "DueDate": { "type": "string", "description": "DueDate", "format": "DateTime?" }, "InvoiceNumber": { "type": "string", "description": "InvoiceNumber", "format": "string" }, "CustomerReference": { "type": "string", "description": "CustomerReference", "format": "string" }, "OutstandingAmount": { "type": "string", "description": "OutstandingAmount", "format": "decimal?" }, "TotalAmount": { "type": "string", "description": "TotalAmount", "format": "decimal?" }, "PaidAmount": { "type": "string", "description": "PaidAmount", "format": "decimal?" }, "RelationId": { "type": "string", "description": "RelationId" }, "RelationTypeId": { "type": "string", "description": "RelationTypeId" }, "IsOrganisation": { "type": "string", "description": "IsOrganisation" }, "IsPerson": { "type": "string", "description": "IsPerson" }, "IsUnknown": { "type": "string", "description": "IsUnknown" }, "Organisation": { "type": "string", "description": "Organisation" }, "Person": { "type": "string", "description": "Person" }, "Unknown": { "type": "string", "description": "Unknown" }, "RelationType": { "type": "string", "description": "RelationType" }, "RelationName": { "type": "string", "description": "RelationName", "format": "string" }, "InvoiceId": { "type": "string", "description": "InvoiceId", "format": "uuid" } } } }, "examples": { "example": { "value": [ { "OutstandingAmount": 123.4200000000, "TotalAmount": 123.4200000000, "PaidAmount": 0.0000000000, "DueDate": "2024-12-27T00:00:00Z", "InvoiceId": "a9095b6f-990d-4f5a-bda3-737939ab5fda", "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", "InvoiceDate": "2024-12-13T00:00:00Z", "InvoiceNumber": "VF240002", "CustomerReference": null, "RelationName": "AFAS Software B.V.", "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", "InstanceId": "206b831d-d5b1-43cd-a6d3-949bab3f45ee", "RelationType": "organisation" }, { "OutstandingAmount": 561.4400000000, "TotalAmount": 561.4400000000, "PaidAmount": 0.0000000000, "DueDate": "2024-12-27T00:00:00Z", "InvoiceId": "157f441e-530d-4571-b6f7-e6681dc0ddac", "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", "InvoiceDate": "2024-12-13T00:00:00Z", "InvoiceNumber": "VF240001", "CustomerReference": null, "RelationName": "AFAS Software B.V.", "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", "InstanceId": "3f5ac81a-89d5-423d-ad2c-dea22585dc36", "RelationType": "organisation" }, { "OutstandingAmount": 640.0900000000, "TotalAmount": 640.0900000000, "PaidAmount": 0.0000000000, "DueDate": "2024-12-27T00:00:00Z", "InvoiceId": "5fa9bfee-7a07-4ea9-b438-f19b3cdda6ca", "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", "InvoiceDate": "2024-12-13T00:00:00Z", "InvoiceNumber": "VF240003", "CustomerReference": null, "RelationName": "Mollie B.V.", "RelationId": "3709fb45-c646-5cca-8de7-e6433404316a", "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", "InstanceId": "961616ec-27db-436c-bd86-eb95a46bb141", "RelationType": "organisation" } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/debtorpaymentterms": { "get": { "tags": [ "Debiteuren" ], "description": "debtorpaymentterms 1.0", "operationId": "get_debtorpaymentterms_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "AdministationId": { "type": "string", "description": "AdministationId", "format": "uuid" }, "OrganisationId": { "type": "string", "description": "OrganisationId", "format": "uuid" }, "PersonId": { "type": "string", "description": "PersonId", "format": "uuid" }, "UnknownRelationId": { "type": "string", "description": "UnknownRelationId", "format": "uuid" }, "InvoiceDate": { "type": "string", "description": "InvoiceDate", "format": "DateTime?" }, "InvoiceId": { "type": "string", "description": "InvoiceId", "format": "string" }, "Address": { "type": "string", "description": "Address", "format": "string" }, "AddressId": { "type": "string", "description": "AddressId", "format": "uuid" }, "DueDate": { "type": "string", "description": "DueDate", "format": "DateTime?" }, "RelationId": { "type": "string", "description": "RelationId" }, "RelationTypeId": { "type": "string", "description": "RelationTypeId" }, "IsOrganisation": { "type": "string", "description": "IsOrganisation" }, "IsPerson": { "type": "string", "description": "IsPerson" }, "IsUnknown": { "type": "string", "description": "IsUnknown" }, "Organisation": { "type": "string", "description": "Organisation" }, "Person": { "type": "string", "description": "Person" }, "Unknown": { "type": "string", "description": "Unknown" }, "RelationType": { "type": "string", "description": "RelationType" } } } }, "examples": { "example": { "value": [ { "DueDate": "2024-02-16T00:00:00Z", "AdministationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "InvoiceDate": "2024-02-02T00:00:00Z", "InvoiceId": "V01240018", "CustomerId": "c9e0fced-a61e-544e-b7ca-3e0428579f9f", "CustomerName": "Administratiekantoor Beers", "OrganisationId": "bb3fd8ef-5a0e-5919-8e67-77b396abf212", "AddressId": "9e009e67-42d5-508c-9939-eb09cadb8f81", "Address": "Postbus 779, 2700 AT, Zoetermeer, Nederland" }, { "DueDate": "2024-02-02T00:00:00Z", "AdministationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "InvoiceDate": "2024-01-19T00:00:00Z", "InvoiceId": "V01240012", "CustomerId": "c6734a65-7205-59e7-9777-ed5aef340c68", "CustomerName": "Bus Grondstoffen B.V.", "OrganisationId": "1ac6ea9d-9a7f-54f4-b9ef-fe161a55d9f6", "AddressId": "b6fc9651-1785-53f9-9862-d7a2c84d664b", "Address": "Eerste Tochtweg 2, 2913 LP, Capelle aan den IJssel, Nederland" } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/invoicevatpercentage": { "get": { "tags": [ "Inkoopjournaalpost" ], "description": "invoicevatpercentage 1.0", "operationId": "get_invoicevatpercentage_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "AdministrationCountryId": { "type": "string", "description": "AdministrationCountryId", "format": "uuid" }, "VatRateId": { "type": "string", "description": "VatRateId", "format": "uuid" }, "VatPercentage": { "type": "number", "description": "VatPercentage", "format": "decimal?" } } } }, "examples": { "example": { "value": [ { "VatPercentage": 0.0000000000, "AdministrationCountryId": "afa50000-0000-0e86-9865-0403053be617", "VatRateId": "afa50000-0000-0b1e-8a4b-309cd658b570", "InstanceId": "e82c44c0-1463-492e-ad57-d247df1544c4" }, { "VatPercentage": 0.0000000000, "AdministrationCountryId": "afa50000-0000-04a5-9968-121a87793c72", "VatRateId": "afa50000-0000-0b1e-8a4b-309cd658b570", "InstanceId": "95011019-40cd-48ca-b2ec-432f0223c15c" } ] } } } } } }, "security": [ { "access_token": [] } ], "deprecated": true } }, "/api/invoicevatrate": { "get": { "tags": [ "Inkoopjournaalpost" ], "description": "invoicevatrate 1.0", "operationId": "get_invoicevatrate_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "AdministrationCountryId": { "type": "string", "description": "AdministrationCountryId", "format": "uuid" }, "LedgerAccountId": { "type": "string", "description": "LedgerAccountId", "format": "uuid" }, "VatRateId": { "type": "string", "description": "VatRateId", "format": "uuid" } } } }, "examples": { "example": { "value": [ { "AdministrationCountryId": "afa50000-0000-0f5e-93b9-4fc1abc0cb22", "LedgerAccountId": "cfb59b79-b3ec-55ef-8cde-000499c3179e", "VatRateId": "afa50000-0000-0b41-9465-e9f88bcaef86", "InstanceId": "d98ba9ca-a053-44aa-ac84-f075d317a595" }, { "AdministrationCountryId": "afa50000-0000-0f5e-93b9-4fc1abc0cb22", "LedgerAccountId": "3c0e6b01-8b34-53ff-80dc-002152014f45", "VatRateId": "afa50000-0000-0b41-9465-e9f88bcaef86", "InstanceId": "c892bc98-27e0-4171-9228-a95ebb8fbac9" } ] } } } } } }, "security": [ { "access_token": [] } ], "deprecated": true } }, "/api/journalentries": { "get": { "tags": [ "Financiele rapportage" ], "description": "journalentries 1.0", "operationId": "get_journalentries_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "AdministrationId": { "type": "string", "description": "AdministrationId", "format": "uuid" }, "HeaderId": { "type": "string", "description": "HeaderId" }, "LineId": { "type": "string", "description": "LineId", "format": "uuid" }, "AccountingPeriodId": { "type": "string", "description": "AccountingPeriodId", "format": "uuid" }, "AccountingYearId": { "type": "string", "description": "AccountingYearId", "format": "uuid" }, "LedgerAccountId": { "type": "string", "description": "LedgerAccountId", "format": "uuid" }, "AmountDebit": { "type": "string", "description": "AmountDebit", "format": "number" }, "AmountCredit": { "type": "string", "description": "AmountCredit", "format": "number" }, "AmountTotal": { "type": "string", "description": "AmountTotal", "format": "decimal?" }, "Number": { "type": "string", "description": "Number", "format": "string" }, "PostingDate": { "type": "string", "description": "PostingDate", "format": "DateTime" }, "Description": { "type": "string", "description": "Description", "format": "string" }, "DocumentIdentification": { "type": "string", "description": "DocumentIdentification", "format": "string" }, "DocumentDate": { "type": "string", "description": "DocumentDate", "format": "DateTime?" }, "VatPercentage": { "type": "number", "description": "VatPercentage", "format": "decimal?" }, "VatSection": { "type": "string", "description": "VatSection", "format": "Guid?" }, "VatAmount": { "type": "string", "description": "VatAmount", "format": "decimal?" } } } }, "examples": { "journalentries": { "value": [ { "LineId": "20a899d9-7a95-56f7-a54b-000b17fb8d24", "AmountDebit": 3932.1700000000, "AmountCredit": 0.0000000000, "AmountTotal": 3932.1700000000, "VatPercentage": null, "VatSection": null, "VatAmount": null, "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", "HeaderId": "938afbd9-f317-53af-bcde-b1c8e5d28472", "Number": "2477", "PostingDate": "2022-10-31T00:00:00Z", "DocumentDate": "2022-10-31T00:00:00Z", "AccountingPeriodId": "59aaf644-e6da-45eb-962f-bc37555d4262", "AccountingYearId": "f37fc13c-870f-45ae-96e1-a5fa70c861c1", "LedgerAccountId": "349016af-3fa7-5b11-b77d-454cc05a17ee", "Description": "Overige uitgave - NL77ABNA0441631347 - Salarisbetaling", "DocumentIdentification": null }, { "LineId": "a34bf47d-ecab-5185-b4ac-002cdb062855", "AmountDebit": 88.9400000000, "AmountCredit": 0.0000000000, "AmountTotal": 88.9400000000, "VatPercentage": null, "VatSection": null, "VatAmount": null, "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "HeaderId": "c0c3b86b-a023-5838-9353-ceb1ab7198fa", "Number": "2112", "PostingDate": "2024-04-02T00:00:00Z", "DocumentDate": "2024-03-15T00:00:00Z", "AccountingPeriodId": "49a93c26-2f8c-44c3-9be2-552f3b6a8fce", "AccountingYearId": "cc0b784f-a591-4e37-8cb4-ba06374d18df", "LedgerAccountId": "78685f08-fb5c-593f-a7d8-b4ed2886ef9d", "Description": "Verkoopfactuur - Erbi Lara B.V.", "DocumentIdentification": "V01240034" } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/ledgeraccount": { "get": { "tags": [ "Loonjournaalpost", "POS Transacties", "Inkoopjournaalpost", "Verkoopjournaalpost" ], "description": "ledgeraccount 1.0", "operationId": "get_ledgeraccount_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id", "format": "uuid" }, "Description": { "type": "string", "description": "Description", "format": "string" }, "LedgerAccountNumber": { "type": "string", "description": "LedgerAccountNumber", "format": "string" }, "TypeId": { "type": "string", "description": "TypeId", "format": "Guid?" }, "InstanceId": { "type": "string", "description": "InstanceId", "format": "uuid" }, "AdministrationId": { "type": "string", "description": "AdministrationId", "format": "uuid" }, "InvestInAsset": { "type": "boolean", "description": "InvestInAsset", "format": "bool?" } } } }, "examples": { "example": { "value": [ { "Id": "cfb59b79-b3ec-55ef-8cde-000499c3179e", "Description": "Omzet Algemeen", "LedgerAccountNumber": "8000", "TypeId": "aae9334f-0fa8-43cb-ad52-cff973b4c863", "InstanceId": "cfb59b79-b3ec-55ef-8cde-000499c3179e", "InvestInAsset": false, "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911" }, { "Id": "68730415-2a59-50ce-9968-00303319780d", "Description": "Schepen", "LedgerAccountNumber": "0247", "TypeId": "980eb36a-8bec-45d9-97f6-06dd2c551818", "InstanceId": "68730415-2a59-50ce-9968-00303319780d", "InvestInAsset": true, "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911" } ] } } } } } }, "security": [ { "access_token": [] } ], "deprecated": true } }, "/api/ledgeraccounts": { "get": { "tags": [ "Publiek: Financi\u00EBle dashboarding", "Financi\u00EBle journaalpost", "Publiek: Financi\u00EBle rapportage", "Financiele rapportage", "Loonjournaalpost", "POS Transacties", "Inkoopjournaalpost", "Publiek: Externe facturatie", "Verkoopjournaalpost" ], "description": "ledgeraccounts 1.0", "operationId": "get_ledgeraccounts_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id", "format": "uuid" }, "Description": { "type": "string", "description": "Description", "format": "string" }, "LedgerAccountNumber": { "type": "string", "description": "LedgerAccountNumber", "format": "string" }, "TypeId": { "type": "string", "description": "TypeId", "format": "Guid?" }, "InstanceId": { "type": "string", "description": "InstanceId", "format": "uuid" }, "AdministrationId": { "type": "string", "description": "AdministrationId", "format": "uuid" }, "InvestInAsset": { "type": "boolean", "description": "InvestInAsset", "format": "bool?" } } } }, "examples": { "ledgeraccounts": { "value": [ { "Id": "cfb59b79-b3ec-55ef-8cde-000499c3179e", "Description": "Omzet Algemeen", "LedgerAccountNumber": "8000", "TypeId": "aae9334f-0fa8-43cb-ad52-cff973b4c863", "InstanceId": "cfb59b79-b3ec-55ef-8cde-000499c3179e", "InvestInAsset": false, "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911" }, { "Id": "68730415-2a59-50ce-9968-00303319780d", "Description": "Schepen", "LedgerAccountNumber": "0247", "TypeId": "980eb36a-8bec-45d9-97f6-06dd2c551818", "InstanceId": "68730415-2a59-50ce-9968-00303319780d", "InvestInAsset": true, "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911" } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/ledgerperiodtotals": { "get": { "tags": [ "Publiek: Financi\u00EBle dashboarding", "Publiek: Financi\u00EBle rapportage", "Financiele rapportage" ], "description": "ledgerperiodtotals 1.0", "operationId": "get_ledgerperiodtotals_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "AdministrationId": { "type": "string", "description": "AdministrationId", "format": "uuid" }, "AccountingYear": { "type": "string", "description": "AccountingYear", "format": "string" }, "AccountingYearId": { "type": "string", "description": "AccountingYearId", "format": "uuid" }, "AccountingYearStartDate": { "type": "string", "description": "AccountingYearStartDate", "format": "DateTime?" }, "AccountingYearEndDate": { "type": "string", "description": "AccountingYearEndDate", "format": "DateTime?" }, "AccountingPeriod": { "type": "string", "description": "AccountingPeriod", "format": "string" }, "AccountingPeriodId": { "type": "string", "description": "AccountingPeriodId", "format": "uuid" }, "AccountingPeriodStartDate": { "type": "string", "description": "AccountingPeriodStartDate", "format": "DateTime?" }, "AccountingPeriodEndDate": { "type": "string", "description": "AccountingPeriodEndDate", "format": "DateTime?" }, "LedgerAccountId": { "type": "string", "description": "LedgerAccountId", "format": "uuid" }, "LedgerAccountNumber": { "type": "string", "description": "LedgerAccountNumber" }, "LedgerAccount": { "type": "string", "description": "LedgerAccount", "format": "string" }, "IsOpeningBalance": { "type": "boolean", "description": "IsOpeningBalance", "format": "bool" }, "RgsCode": { "type": "string", "description": "RgsCode", "format": "string" }, "RgsDescription": { "type": "string", "description": "RgsDescription", "format": "string" }, "Total": { "type": "string", "description": "Total", "format": "decimal?" } } } }, "examples": { "example": { "value": [ { "Total": -210.0000000000, "IsOpeningBalance": false, "AdministrationId": "4fef7d35-e93c-4cb2-b367-0deb692e5647", "AccountingYearId": "2ebff944-f3d0-4335-a3b7-ff637df54ca4", "AccountingYear": "2024", "AccountingYearStartDate": "2024-01-01T00:00:00Z", "AccountingYearEndDate": "2024-12-31T00:00:00Z", "AccountingPeriodId": "c2ebc6d5-c5af-4bb5-8fea-2e8a7e91399c", "AccountingPeriod": "Januari 2024", "AccountingPeriodStartDate": "2024-01-01T00:00:00Z", "AccountingPeriodEndDate": "2024-01-31T00:00:00Z", "LedgerAccountId": "90aee254-9eeb-56af-abe2-064fffbd1c00", "LedgerAccount": "Te betalen btw (1800)", "LedgerAccountNumber": "90aee254-9eeb-56af-abe2-064fffbd1c00", "RgsCode": "BSchBepBtw", "RgsDescription": "Te betalen Omzetbelasting", "InstanceId": "b0c63c7b-5b65-469a-bbdf-319579d649b4" }, { "Total": -1000.0000000000, "IsOpeningBalance": false, "AdministrationId": "4fef7d35-e93c-4cb2-b367-0deb692e5647", "AccountingYearId": "2ebff944-f3d0-4335-a3b7-ff637df54ca4", "AccountingYear": "2024", "AccountingYearStartDate": "2024-01-01T00:00:00Z", "AccountingYearEndDate": "2024-12-31T00:00:00Z", "AccountingPeriodId": "c2ebc6d5-c5af-4bb5-8fea-2e8a7e91399c", "AccountingPeriod": "Januari 2024", "AccountingPeriodStartDate": "2024-01-01T00:00:00Z", "AccountingPeriodEndDate": "2024-01-31T00:00:00Z", "LedgerAccountId": "8aa84f79-4892-5cae-b6d1-2e4f9365b892", "LedgerAccount": "Omzet groep 1 (8000)", "LedgerAccountNumber": "8aa84f79-4892-5cae-b6d1-2e4f9365b892", "RgsCode": "WOmzGrpGr1", "RgsDescription": "Netto-omzet groep 1", "InstanceId": "89bd2a01-d2e0-418d-9585-5c25f5b471e4" }, { "Total": 1210.0000000000, "IsOpeningBalance": false, "AdministrationId": "4fef7d35-e93c-4cb2-b367-0deb692e5647", "AccountingYearId": "2ebff944-f3d0-4335-a3b7-ff637df54ca4", "AccountingYear": "2024", "AccountingYearStartDate": "2024-01-01T00:00:00Z", "AccountingYearEndDate": "2024-12-31T00:00:00Z", "AccountingPeriodId": "c2ebc6d5-c5af-4bb5-8fea-2e8a7e91399c", "AccountingPeriod": "Januari 2024", "AccountingPeriodStartDate": "2024-01-01T00:00:00Z", "AccountingPeriodEndDate": "2024-01-31T00:00:00Z", "LedgerAccountId": "2fc1ada7-a66a-5b4b-9644-af29d46865c5", "LedgerAccount": "Debiteuren (1300)", "LedgerAccountNumber": "2fc1ada7-a66a-5b4b-9644-af29d46865c5", "RgsCode": "BVorDebHad", "RgsDescription": "Handelsdebiteuren nominaal", "InstanceId": "cf9671f4-96c3-40f6-8048-ebc86c1f2dc4" }, { "Total": -1000.0000000000, "IsOpeningBalance": false, "AdministrationId": "4fef7d35-e93c-4cb2-b367-0deb692e5647", "AccountingYearId": "2ebff944-f3d0-4335-a3b7-ff637df54ca4", "AccountingYear": "2024", "AccountingYearStartDate": "2024-01-01T00:00:00Z", "AccountingYearEndDate": "2024-12-31T00:00:00Z", "AccountingPeriodId": "c2ebc6d5-c5af-4bb5-8fea-2e8a7e91399c", "AccountingPeriod": "Januari 2024", "AccountingPeriodStartDate": "2024-01-01T00:00:00Z", "AccountingPeriodEndDate": "2024-01-31T00:00:00Z", "LedgerAccountId": "38b36a37-32a8-5775-8d3a-b118dd32f77a", "LedgerAccount": "Onverdeeld resultaat (0900)", "LedgerAccountNumber": "38b36a37-32a8-5775-8d3a-b118dd32f77a", "RgsCode": "BEivOreOvw", "RgsDescription": "Niet verdeelde winst", "InstanceId": "36bc8088-7d06-42b5-9ea1-06d47d4a4fd1" }, { "Total": 1000.0000000000, "IsOpeningBalance": false, "AdministrationId": "4fef7d35-e93c-4cb2-b367-0deb692e5647", "AccountingYearId": "2ebff944-f3d0-4335-a3b7-ff637df54ca4", "AccountingYear": "2024", "AccountingYearStartDate": "2024-01-01T00:00:00Z", "AccountingYearEndDate": "2024-12-31T00:00:00Z", "AccountingPeriodId": "c2ebc6d5-c5af-4bb5-8fea-2e8a7e91399c", "AccountingPeriod": "Januari 2024", "AccountingPeriodStartDate": "2024-01-01T00:00:00Z", "AccountingPeriodEndDate": "2024-01-31T00:00:00Z", "LedgerAccountId": "e8485631-976a-55f6-8c16-c031723460b1", "LedgerAccount": "Overboeking van het resultaat (9999)", "LedgerAccountNumber": "e8485631-976a-55f6-8c16-c031723460b1", "RgsCode": "ResultaatNiveau2", "RgsDescription": "Resultaat", "InstanceId": "4e7b8b7d-d577-4cdd-9748-20e4742b8880" } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/linestobeinvoiced": { "get": { "tags": [ "Publiek: Externe verkoopregels", "Verkoopregels" ], "description": "linestobeinvoiced 1.0", "operationId": "get_linestobeinvoiced_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "InstanceId": { "type": "string", "description": "InstanceId" }, "Ownorganization": { "type": "string", "description": "Ownorganization" }, "DatumGepland": { "type": "string", "description": "DatumGepland" }, "Klant": { "type": "string", "description": "Klant" }, "ProjectKoppelen": { "type": "string", "description": "ProjectKoppelen" }, "Project": { "type": "string", "description": "Project" }, "Verkoopproduct": { "type": "string", "description": "Verkoopproduct" }, "Description": { "type": "string", "description": "Description" }, "Aantal": { "type": "string", "description": "Aantal" }, "Prijs": { "type": "string", "description": "Prijs" }, "Bedrag": { "type": "string", "description": "Bedrag" }, "MethodeBepalenPrijs": { "type": "string", "description": "MethodeBepalenPrijs" }, "Status": { "type": "string", "description": "Status" } } } }, "examples": { "example": { "value": [ { "InstanceId": "fcb31b25-8da1-4a90-ae33-a93d932184f0", "Ownorganization": { "Id": "73109da3-0fcf-4fbe-bd2c-209a399ae502", "ComponentId": "cbb9b7ef-ef04-4c84-9e80-4989bd526865" }, "DatumGepland": "2024-12-04T00:00:00Z", "Klant": { "Id": "509e24de-67fb-4e02-b149-f8c615fef64c", "ComponentId": "8e352e23-04af-45b7-952a-0afc7575ea7a" }, "ProjectKoppelen": true, "Project": { "Id": "e03c053d-3e72-400b-821d-c3398edf1ccc", "ComponentId": "497fc9c2-340d-4d18-b097-c6bbd06bbab7" }, "Verkoopproduct": { "Id": "aaf04330-151c-44d9-9700-8793b1c0d4b4", "ComponentId": "230b4172-613e-4e1b-9ed5-93496c4eed6b" }, "Description": "AFAS Software B.V. (000003) - 04-12-2024", "Aantal": 32.0000000000, "Prijs": 539.7000000000, "Bedrag": 17270.4000000000, "MethodeBepalenPrijs": "52085b0b-a85a-418e-8e33-a00e48666512", "Status": "692a0b09-b83b-44cb-b75a-e431eb66302f", "KlantDescription": "AFAS Software B.V. (000003)", "ProjectDescription": "Implementation Exceptional", "VerkoopproductDescription": "Acer Laptop (3320, 000001)" } ] } } } } } }, "security": [ { "access_token": [] } ] }, "post": { "tags": [ "Publiek: Externe verkoopregels", "Verkoopregels" ], "description": "linestobeinvoiced 1.0", "operationId": "post_linestobeinvoiced_1.0_create", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "not enabled": { "value": { "result": "Failed", "traceId": "339ee3cf-e6bb-4201-9fd0-577906f9f96a", "instances": [], "errors": [ "FeatureToggle not enabled" ] } }, "succes": { "value": { "result": "Succeeded", "traceId": "3614178a-f801-47b7-bae1-dad6439f2c54", "data": { "LinesToBeInvoiced": "fcb31b25-8da1-4a90-ae33-a93d932184f0" }, "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-linestobeinvoiced-1.0-create_request" }, "examples": { "new linestobeinvoiced": { "value": { "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", "Date": "2024-12-04", "Description": "Dell Laptop", "RelationType": "organisation", "RelationId": "7b8e279b-b551-556e-a00a-a815392d0d38", "ItemId": "aaf04330-151c-44d9-9700-8793b1c0d4b4", "Quantity": 32, "ProjectId": "e03c053d-3e72-400b-821d-c3398edf1ccc" } } } } } }, "security": [ { "access_token": [] } ] }, "delete": { "tags": [ "Publiek: Externe verkoopregels", "Verkoopregels" ], "description": "linestobeinvoiced 1.0", "operationId": "put_linestobeinvoiced_1.0_delete", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "$ref": "#/components/parameters/id" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "success": { "value": { "result": "Succeeded", "traceId": "3614178a-f801-47b7-bae1-dad6439f2c54", "data": { "LinesToBeInvoiced": "fcb31b25-8da1-4a90-ae33-a93d932184f0" }, "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-linestobeinvoiced-1.0-delete_request" }, "examples": { "minimal": { "value": { "AdministrationId": "e877fb82-b546-4d20-94cf-05c72765fc47", "Id": "e877fb82-b546-4d20-94cf-05c72765fc47" } } } } } }, "security": [ { "access_token": [] } ] }, "put": { "tags": [ "Publiek: Externe verkoopregels", "Verkoopregels" ], "description": "linestobeinvoiced 1.0", "operationId": "put_linestobeinvoiced_1.0_update", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "$ref": "#/components/parameters/id" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "succes": { "value": { "result": "Succeeded", "traceId": "3614178a-f801-47b7-bae1-dad6439f2c54", "data": { "LinesToBeInvoiced": "fcb31b25-8da1-4a90-ae33-a93d932184f0" }, "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-linestobeinvoiced-1.0-update_request" }, "examples": { "example": { "value": { "LineToBeInvoicedId": "547a03a2-19c9-4058-bc77-452063b25d6d", "AdministrationId": "5c86c621-14fc-5d09-a387-772c599caa5d", "Date": "2024-11-04", "Description": "Dell Laptop", "RelationType": "organisation", "RelationId": "30bf2fcc-306d-5680-9e03-d99fbfe46bc2", "ItemId": "4689e028-02c7-5324-885a-556701bd1a9f", "Quantity": 50 } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/organisations": { "get": { "tags": [ "Publiek: Externe verkoopregels", "Verkoopregels", "Inkoopjournaalpost", "Publiek: Relatiemanagement", "Relaties", "Verkoopfactuur", "Publiek: Externe facturatie", "Verkoopjournaalpost" ], "description": "organisations 2.0", "operationId": "get_organisations_2.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "name": "Accept-Version", "in": "header", "example": "2.0", "required": true, "schema": { "type": "string" }, "description": "Use the sequence number of the endpoint." }, { "$ref": "#/components/parameters/trackingtoken" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "TrackingToken": { "type": "string", "description": "Tracking token", "format": "string" }, "Result": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id", "format": "uuid" }, "Name": { "type": "string", "description": "Name", "format": "string" }, "CocNumber": { "type": "string", "description": "CocNumber", "format": "string" }, "VatNumber": { "type": "string", "description": "VatNumber", "format": "string" }, "PhoneNumber": { "type": "string", "description": "PhoneNumber", "format": "string" }, "EmailAddress": { "type": "string", "description": "EmailAddress", "format": "string" }, "SbiCode": { "type": "string", "description": "SbiCode", "format": "string" }, "RelationId": { "type": "string", "description": "RelationId", "format": "string" }, "ExternalId": { "type": "string", "description": "ExternalId", "format": "string" }, "IsArchived": { "type": "boolean", "description": "IsArchived", "format": "bool" } } } } } }, "examples": { "example": { "value": { "TrackingToken": "202401291319301", "Result": [ { "Id": "e36e77f0-9a1c-50d0-a3f3-004f1fee8720", "Name": "Erbi Lara B.V. (000019)", "CocNumber": null, "VatNumber": null, "RelationId": "000019", "ExternalId": null, "IsArchived": false, "EmailAddress": "info@erbilara.afas" }, { "Id": "45aafd00-a21b-5440-bf57-0aa5fa6c2294", "Name": "Alsach Musik GmbH (000037)", "CocNumber": null, "VatNumber": "DE184475234", "RelationId": "000037", "ExternalId": null, "IsArchived": false, "EmailAddress": "info@alsachmusic.afasde" } ] } } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/paymentconditions": { "get": { "tags": [ "Publiek: Externe verkoopregels", "Verkoopregels", "Inkoopjournaalpost", "Verkoopfactuur", "Publiek: Externe facturatie", "Verkoopjournaalpost" ], "description": "GetConnector \u0022paymentconditions\u0022 (1.0)", "operationId": "get_paymentconditions_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id" }, "AdministrationId": { "type": "string", "description": "AdministrationId" }, "Description": { "type": "string", "description": "Description" } } } }, "examples": { "example": { "value": [ { "Id": "9b5d768a-c71b-583e-b6ee-09d64aa935d4", "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", "Description": "21 dagen" }, { "Id": "b8ca9e8d-6fef-5ef6-95ba-0bd221aebc6f", "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", "Description": "60 dagen" }, { "Id": "a59bab3a-36bb-5974-bdad-276f6395d6b6", "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", "Description": "14 dagen" }, { "Id": "b98e24e9-a611-5a98-8cf9-40fed321dc6c", "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "Description": "60 dagen" }, { "Id": "c06d2eb9-1332-5e78-a8b3-58dd62dcee45", "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "Description": "7 dagen" }, { "Id": "0066f624-c140-5262-9fbb-5e3141d32876", "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "Description": "14 dagen" }, { "Id": "eb44c60d-06e4-564b-a90c-7715c78788a5", "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", "Description": "45 dagen" }, { "Id": "a629b70b-6a91-5906-9f9d-97f83dfd0c58", "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "Description": "90 dagen" }, { "Id": "ab8b0914-74a2-5db5-a948-ae34ea6b7f7e", "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "Description": "30 dagen" }, { "Id": "2d8304eb-1472-5fad-8fed-b1c30b2a1749", "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "Description": "21 dagen" }, { "Id": "3bed98d9-94d0-5147-9cb8-cad047a0b9bd", "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "Description": "45 dagen" }, { "Id": "6372c28d-7468-5c58-8826-cea9bf70758a", "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", "Description": "90 dagen" }, { "Id": "4a09121c-4f48-5a29-9cef-ecfb5bb74dcf", "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", "Description": "7 dagen" }, { "Id": "596a0343-fd85-597a-8918-ed3198de119d", "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", "Description": "30 dagen" } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/paymentmethod": { "get": { "tags": [ "Inkoopjournaalpost" ], "description": "paymentmethod 1.0", "operationId": "get_paymentmethod_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id", "format": "uuid" }, "Description": { "type": "string", "description": "Description", "format": "string" } } } }, "examples": { "example": { "value": [ { "Id": "afa50000-0000-0181-a66a-0eee1b383d80", "Description": "Creditcard" }, { "Id": "afa50000-0000-00c8-9eec-375e35359e5f", "Description": "Incasso" }, { "Id": "afa50000-0000-0dfe-8783-89ff34e106ec", "Description": "Rekening-courant aandeelhouder" }, { "Id": "afa50000-0000-0cde-bc05-905891515287", "Description": "Pin" }, { "Id": "afa50000-0000-0f93-a3ff-98c91e8a5d66", "Description": "Priv\u00E9" }, { "Id": "afa50000-0000-0969-925a-a5077ccd2c36", "Description": "Onbekend" }, { "Id": "afa50000-0000-0f79-87ed-e26c431bb44e", "Description": "Contant" }, { "Id": "afa50000-0000-015f-89ac-f4a839ef5d7f", "Description": "iDEAL" }, { "Id": "afa50000-0000-0102-b0d1-f91a25e6c442", "Description": "Op rekening" } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/persons": { "get": { "tags": [ "Publiek: Externe verkoopregels", "Verkoopregels", "Inkoopjournaalpost", "Publiek: Relatiemanagement", "Relaties", "Verkoopfactuur", "Publiek: Externe facturatie", "Verkoopjournaalpost" ], "description": "persons 2.0", "operationId": "get_persons_2.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "name": "Accept-Version", "in": "header", "example": "2.0", "required": true, "schema": { "type": "string" }, "description": "Use the sequence number of the endpoint." }, { "$ref": "#/components/parameters/trackingtoken" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "TrackingToken": { "type": "string", "description": "Tracking token", "format": "string" }, "Result": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id", "format": "uuid" }, "Name": { "type": "string", "description": "Name", "format": "string" }, "FirstName": { "type": "string", "description": "FirstName", "format": "string" }, "Initials": { "type": "string", "description": "Initials", "format": "string" }, "Prefix": { "type": "string", "description": "Prefix", "format": "string" }, "Lastname": { "type": "string", "description": "Lastname", "format": "string" }, "PhoneNumber": { "type": "string", "description": "PhoneNumber", "format": "string" }, "EmailAddress": { "type": "string", "description": "EmailAddress", "format": "string" }, "ExternalId": { "type": "string", "description": "ExternalId", "format": "string" }, "IsArchived": { "type": "boolean", "description": "IsArchived", "format": "bool" } } } } } }, "examples": { "example": { "value": { "TrackingToken": "202401291327471", "Result": [ { "Id": "2aacc092-9c6c-5020-b1cf-0d8ecd6485dc", "Name": "Cas de Graaf", "FirstName": "Cas", "Initials": "C.", "Prefix": "de", "Lastname": "Graaf", "ExternalId": null, "IsArchived": false }, { "Id": "1242493d-bd93-53b3-9852-1c82c83316aa", "Name": "Tarik el Erdol", "FirstName": "Tarik", "Initials": "T.", "Prefix": "el", "Lastname": "Erdol", "ExternalId": null, "IsArchived": false } ] } } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/products": { "get": { "tags": [ "Publiek: Externe verkoopregels", "Verkoopregels", "Verkoopfactuur" ], "description": "products 2.2", "operationId": "get_products_2.2", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "name": "Accept-Version", "in": "header", "example": "2.2", "required": true, "schema": { "type": "string" }, "description": "Use the sequence number of the endpoint." }, { "$ref": "#/components/parameters/trackingtoken" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "TrackingToken": { "type": "string", "description": "Tracking token", "format": "string" }, "Result": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id", "format": "uuid" }, "Description": { "type": "string", "description": "Description", "format": "string" }, "InternalId": { "type": "string", "description": "InternalId", "format": "string" }, "PriceExcludingVAT": { "type": "string", "description": "PriceExcludingVAT", "format": "decimal?" }, "PriceIncludingVAT": { "type": "string", "description": "PriceIncludingVAT", "format": "decimal?" }, "ProductGroup": { "type": "string", "description": "ProductGroup", "format": "string" }, "Barcode": { "type": "string", "description": "Barcode" }, "Category": { "type": "string", "description": "Category" }, "ExtraDescription": { "type": "string", "description": "ExtraDescription", "format": "string" }, "IsArchived": { "type": "boolean", "description": "IsArchived", "format": "bool" }, "IsBlocked": { "type": "boolean", "description": "IsBlocked", "format": "bool" }, "IsDisabled": { "type": "boolean", "description": "IsDisabled", "format": "bool" }, "Blob": { "type": "string", "description": "Blob" } } } } } }, "examples": { "example": { "value": { "TrackingToken": "202412131015320", "Result": [ { "Id": "fb5d4fd5-ade6-58b6-ba5e-37f81dc1afaa", "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", "Description": "Vast actief (btw nul)", "InternalId": null, "Barcode": null, "Category": null, "ProductStyle": "d55d181a-4ab5-4d68-9296-4fbd534cc998", "IsArchived": false, "IsBlocked": false, "IsDisabled": false, "Blob": null, "PriceExcludingVAT": 0.0000000000, "ProductGroup": "Vaste activa", "ProductType": "unknown" }, { "Id": "53e9c46e-ee07-4d4b-acd7-58f5cc39eac5", "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", "Description": "Dell Laptop (3310, 000002)", "InternalId": "000002", "Barcode": null, "Category": null, "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", "IsArchived": false, "IsBlocked": false, "IsDisabled": false, "Blob": null, "PriceExcludingVAT": 205.2800000000, "ProductGroup": "Standaard", "ProductType": "supplies" }, { "Id": "aaf04330-151c-44d9-9700-8793b1c0d4b4", "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", "Description": "Acer Laptop (3320, 000001)", "InternalId": "000001", "Barcode": "0799439112766", "Category": "Laptops", "ProductStyle": "99e4ea3b-9c45-4154-a7e0-84f9e4355b74", "IsArchived": false, "IsBlocked": false, "IsDisabled": false, "Blob": null, "PriceExcludingVAT": 539.7000000000, "ProductGroup": "Standaard", "ExtraDescription": "Extra info about the product", "ProductType": "supplies" }, { "Id": "5c5868af-fd11-5157-af72-9453a812ac20", "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", "Description": "Vast actief (btw hoog)", "InternalId": null, "Barcode": null, "Category": null, "ProductStyle": "d55d181a-4ab5-4d68-9296-4fbd534cc998", "IsArchived": false, "IsBlocked": false, "IsDisabled": false, "Blob": null, "PriceExcludingVAT": 0.0000000000, "ProductGroup": "Vaste activa", "ProductType": "unknown" }, { "Id": "48bd7646-6fa3-5fba-b665-990670e38d98", "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", "Description": "Vast actief (btw laag)", "InternalId": null, "Barcode": null, "Category": null, "ProductStyle": "d55d181a-4ab5-4d68-9296-4fbd534cc998", "IsArchived": false, "IsBlocked": false, "IsDisabled": false, "Blob": null, "PriceExcludingVAT": 0.0000000000, "ProductGroup": "Vaste activa", "ProductType": "unknown" }, { "Id": "89efed8e-06b7-4a84-b5ef-b99c57988405", "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", "Description": "Consultancy", "InternalId": null, "Barcode": null, "Category": null, "ProductStyle": "446d814f-898b-40c4-8e7b-874c1732dd8d", "IsArchived": false, "IsBlocked": false, "IsDisabled": false, "Blob": null, "PriceExcludingVAT": 500.0000000000, "ProductGroup": "Standaard", "ProductType": "services" }, { "Id": "3916e4f3-b7cd-5af0-ba91-f412066bdb10", "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", "Description": "Diverse producten", "InternalId": null, "Barcode": null, "Category": null, "ProductStyle": "d55d181a-4ab5-4d68-9296-4fbd534cc998", "IsArchived": false, "IsBlocked": false, "IsDisabled": false, "Blob": null, "ProductGroup": "Diverse producten", "ProductType": "unknown" } ] } } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/projects": { "get": { "tags": [ "Publiek: Externe verkoopregels", "Verkoopregels" ], "description": "projects 1.0", "operationId": "get_projects_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" }, { "$ref": "#/components/parameters/trackingtoken" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "TrackingToken": { "type": "string", "description": "Tracking token", "format": "string" }, "Result": { "type": "array", "items": { "type": "object", "properties": { "AdministrationId": { "type": "string", "description": "AdministrationId" }, "InstanceId": { "type": "string", "description": "InstanceId", "format": "uuid" }, "Omschrijving": { "type": "string", "description": "Omschrijving", "format": "string" } } } } } }, "examples": { "example": { "value": { "TrackingToken": "202412131017330", "Result": [ { "InstanceId": "96d5ef01-0d3f-4a60-b5ee-8a915693f5c2", "Omschrijving": "Implementation Greenshop", "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502" }, { "InstanceId": "e03c053d-3e72-400b-821d-c3398edf1ccc", "Omschrijving": "Implementation Exceptional", "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502" } ] } } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/salespricesperrelation": { "get": { "tags": [ "Publiek: Externe verkoopregels", "Verkoopregels", "Verkoopfactuur" ], "description": "salespricesperrelation 1.0", "operationId": "get_salespricesperrelation_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" }, { "$ref": "#/components/parameters/trackingtoken" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "TrackingToken": { "type": "string", "description": "Tracking token", "format": "string" }, "Result": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id", "format": "uuid" }, "ProductId": { "type": "string", "description": "ProductId" }, "ProductDescription": { "type": "string", "description": "ProductDescription", "format": "string" }, "PriceExcludingVAT": { "type": "string", "description": "PriceExcludingVAT", "format": "decimal?" }, "StartDate": { "type": "string", "description": "StartDate", "format": "DateTime?" }, "EndDate": { "type": "string", "description": "EndDate", "format": "DateTime?" }, "RelationTypeId": { "type": "string", "description": "RelationTypeId" }, "IsOrganisation": { "type": "string", "description": "IsOrganisation" }, "IsPerson": { "type": "string", "description": "IsPerson" }, "IsUnknown": { "type": "string", "description": "IsUnknown" }, "Organisation": { "type": "string", "description": "Organisation" }, "Person": { "type": "string", "description": "Person" }, "Unknown": { "type": "string", "description": "Unknown" }, "RelationType": { "type": "string", "description": "RelationType" }, "RelationId": { "type": "string", "description": "RelationId" }, "RelationDescription": { "type": "string", "description": "RelationDescription", "format": "string" } } } } } }, "examples": { "example": { "value": { "TrackingToken": "202410211314120", "Result": [ { "Id": "b4632ca6-2298-4139-8d67-2f5ca122d039", "PriceExcludingVAT": 1512.1500000000, "StartDate": null, "EndDate": null, "ProductId": "4eb7c821-7e37-4132-b27d-95563f93687a", "ProductDescription": "Acer Laptop", "RelationDescription": "Architectenbureau Brauw B.V.", "RelationTypeId": "1f0fbbf3-bb59-4ff1-8712-1e7087e09895", "RelationId": "3eff9a76-45d7-4595-a372-09e1e076c540", "InstanceId": "bcd2883b-0559-4337-aa87-9583d1860a51", "RelationType": "organisation" } ] } } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/supplier": { "get": { "tags": [ "Inkoopjournaalpost" ], "description": "supplier 1.0", "operationId": "get_supplier_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id", "format": "uuid" }, "Description": { "type": "string", "description": "Description", "format": "string" }, "AdministrationId": { "type": "string", "description": "AdministrationId", "format": "uuid" }, "SupplierId": { "type": "string", "description": "SupplierId", "format": "uuid" }, "Code": { "type": "string", "description": "Code", "format": "string" }, "CompanyIdVat": { "type": "string", "description": "CompanyIdVat", "format": "string" }, "CompanyIdCoc": { "type": "string", "description": "CompanyIdCoc", "format": "string" }, "VatTypeId": { "type": "string", "description": "VatTypeId", "format": "uuid" }, "LedgerAccountId": { "type": "string", "description": "LedgerAccountId", "format": "uuid" }, "PhoneNumber": { "type": "string", "description": "PhoneNumber", "format": "string" }, "PhoneNumberId": { "type": "string", "description": "PhoneNumberId", "format": "uuid" }, "Emailaddress": { "type": "string", "description": "Emailaddress", "format": "string" }, "EmailaddressId": { "type": "string", "description": "EmailaddressId", "format": "uuid" }, "AddressId": { "type": "string", "description": "AddressId", "format": "uuid" }, "Street": { "type": "string", "description": "Street", "format": "string" }, "HouseNumber": { "type": "number", "description": "HouseNumber", "format": "decimal?" }, "HouseNumberAddition": { "type": "string", "description": "HouseNumberAddition", "format": "string" }, "Comments": { "type": "string", "description": "Comments", "format": "string" }, "PostalCode": { "type": "string", "description": "PostalCode", "format": "string" }, "CityName": { "type": "string", "description": "CityName", "format": "string" }, "State": { "type": "string", "description": "State", "format": "string" }, "CountryCode": { "type": "string", "description": "CountryCode", "format": "string" }, "CountryName": { "type": "string", "description": "CountryName", "format": "string" }, "BankAccountId": { "type": "string", "description": "BankAccountId", "format": "uuid" }, "AccountNumber": { "type": "string", "description": "AccountNumber", "format": "string" }, "AccountHolder": { "type": "string", "description": "AccountHolder", "format": "string" }, "BankId": { "type": "string", "description": "BankId", "format": "uuid" }, "BIC": { "type": "string", "description": "BIC", "format": "string" }, "IncludeInBankFile": { "type": "boolean", "description": "IncludeInBankFile", "format": "bool?" }, "PaymentMethodId": { "type": "string", "description": "PaymentMethodId", "format": "uuid" }, "IsBlocked": { "type": "boolean", "description": "IsBlocked", "format": "bool" }, "IsArchived": { "type": "boolean", "description": "IsArchived", "format": "bool" }, "GescandeFacturenAutomatischBoeken": { "type": "string", "description": "GescandeFacturenAutomatischBoeken" }, "MaximumBedragVoorAutomatischBoeken": { "type": "string", "description": "MaximumBedragVoorAutomatischBoeken" } } } }, "examples": { "example": { "value": [ { "SupplierId": "9c914aa4-dc44-519f-8f0f-0aec0b83b745", "Description": "Vitens", "AccountHolder": "Vitens", "IsBlocked": false, "IsArchived": false, "Id": "4fa13b8e-44dc-5cf7-b2ef-35e14be401e8", "Code": "000016", "CompanyIdVat": null, "CompanyIdCoc": null, "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "VatTypeId": "afa50000-0000-0b71-8790-807f97e85c54", "Emailaddress": "contact@vitens.afas", "EmailaddressId": "c6f22aee-a163-5a99-b653-4416f07b8249", "AddressId": "56528a1b-4bea-5699-abb8-f66155e9c497", "Street": "Reactorweg", "HouseNumber": 47.0000000000, "HouseNumberAddition": null, "Comments": null, "PostalCode": "3542 AD", "State": null, "CityName": "Utrecht", "CountryCode": "NL", "CountryName": "Nederland", "BankAccountId": "b9628839-9df2-5a87-8f4c-231a88a5d5dc", "AccountNumber": "NL49RABO0300001258", "BankId": "afa50000-0000-0165-b16d-0ead61be0ae2", "BIC": "RABONL2U", "IncludeInBankFile": true, "PaymentMethodId": "afa50000-0000-0102-b0d1-f91a25e6c442" }, { "SupplierId": "5f8d15e5-d3bd-53fc-ac94-1043faeacc6b", "Description": "Acer Computer B.V. (Benelux)", "AccountHolder": "Acer Computer B.V. (Benelux)", "IsBlocked": false, "IsArchived": false, "Id": "06514178-b4f8-5670-9702-41e8cdb7d6e9", "Code": "000008", "CompanyIdVat": null, "CompanyIdCoc": null, "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "VatTypeId": "afa50000-0000-0b71-8790-807f97e85c54", "LedgerAccountId": "6378a73c-7fd9-56e2-b372-a7c6e50aac69", "Emailaddress": "benelux@acer.afas", "EmailaddressId": "ed65ea4b-3540-5cc3-b1ab-c32b944ada2d", "AddressId": "03adb1d9-aa33-5bf6-b93a-42b4c39d8577", "Street": "Kerkstraat", "HouseNumber": 73.0000000000, "HouseNumberAddition": null, "Comments": null, "PostalCode": "5211 KE", "State": null, "CityName": "\u0027s-Hertogenbosch", "CountryCode": "NL", "CountryName": "Nederland", "BankAccountId": "087ba458-b2fa-5cf1-880a-ce9004c36c81", "AccountNumber": "NL28RBOS0569988888", "BankId": "afa50000-0000-010d-8e67-88c19a730bf9", "BIC": "RBOSNL2A", "IncludeInBankFile": true, "PaymentMethodId": "afa50000-0000-0102-b0d1-f91a25e6c442" } ] } } } } } }, "security": [ { "access_token": [] } ], "deprecated": true }, "post": { "tags": [ "Inkoopjournaalpost" ], "description": "supplier 1.0", "operationId": "post_supplier_1.0_create", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "success": { "value": { "result": "Succeeded", "instances": [ { "Code": "Persoon", "Id": "e55f5d3b-780b-576b-9370-760b58e937ec" }, { "Code": "Instelling", "Id": "20eb199e-c652-5513-b7eb-c39f927d1ef3" }, { "Code": "Leverancier", "Id": "20eb199e-c652-5513-b7eb-c39f927d1ef3" }, { "Code": "Begunstigde", "Id": "7afec8a8-c9f4-4ec7-aa68-8d9bc995468d" }, { "Code": "Emailadres", "Id": "4fc10096-8bb4-4be8-8039-5239b4125757" }, { "Code": "Telefoonnummer", "Id": "5e553026-0ad2-4f4c-bd2e-5dbdd6c0096f" }, { "Code": "Bankrekening", "Id": "d18e1122-e014-4468-aa65-585b333359c1" } ], "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-supplier-1.0-create_request" }, "examples": { "New supplier organisation": { "value": { "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "EmailAddress": "klant@afas.nl", "PhoneNumber": "0696856831", "BankAccountNumber": "NL29TRIO0110845005", "Bic": "TRIONL2U", "LedgerAccountId": "4a2014b0-dcdc-500d-add2-fcf73ac8f88d", "PaymentMethod": "banktransfer", "PaymentConditionId": "ee64c81b-56ff-506f-9dac-855d64bf193a", "Organisation": { "Name": "Jansen Haarden", "CompanyIdCoc": "80446353", "CompanyIdVat": "NL861674881B01", "TradeName": "Jansen Holding B.V." } } }, "New supplier person": { "value": { "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "EmailAddress": "Delfina2@example.net", "PhoneNumber": "30-702-386-4989", "BankAccountNumber": "NL29TRIO0110845005", "Bic": "TRIONL2U", "Person": { "Firstname": "Lacy", "Initials": "MD", "Prefix": "Ms.", "Lastname": "Harber" }, "PaymentMethod": "null", "LedgerAccountId": "cfb59b79-b3ec-55ef-8cde-000499c3179e", "PaymentCondition": "b98e24e9-a611-5a98-8cf9-40fed321dc6c", "VatCalculation": "null" } } } } } }, "security": [ { "access_token": [] } ], "deprecated": true } }, "/api/unknownrelation": { "get": { "tags": [ "Publiek: Externe verkoopregels", "Verkoopregels", "Inkoopjournaalpost", "Verkoopfactuur", "Publiek: Externe facturatie", "Verkoopjournaalpost" ], "description": "unknownrelation 1.0", "operationId": "get_unknownrelation_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" }, { "$ref": "#/components/parameters/trackingtoken" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "TrackingToken": { "type": "string", "description": "Tracking token", "format": "string" }, "Result": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id", "format": "uuid" }, "Name": { "type": "string", "description": "Name", "format": "string" }, "SalesRelation": { "type": "boolean", "description": "SalesRelation", "format": "bool" }, "PurchaseRelation": { "type": "boolean", "description": "PurchaseRelation", "format": "bool" }, "IsBlocked": { "type": "boolean", "description": "IsBlocked", "format": "bool?" } } } } } }, "examples": { "example response": { "value": { "TrackingToken": "202405021144501", "Result": [ { "Id": "adef5ea1-c4ec-557d-93a5-0ac82709ad8a", "Name": "Diverse debiteuren", "IsBlocked": false, "SalesRelation": true }, { "Id": "2438541d-5088-5d1d-8caa-94a87cb14dc2", "Name": "Diverse crediteuren", "IsBlocked": false, "PurchaseRelation": true } ] } } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/vatrate": { "get": { "tags": [ "Inkoopjournaalpost" ], "description": "vatrate 1.0", "operationId": "get_vatrate_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id", "format": "uuid" }, "Description": { "type": "string", "description": "Description", "format": "string" } } } }, "examples": { "example": { "value": [ { "Id": "afa50000-0000-0b1e-8a4b-309cd658b570", "Description": "Nul" }, { "Id": "afa50000-0000-07cf-8b24-5ef474ab1b2a", "Description": "Extra laag" }, { "Id": "afa50000-0000-0246-9965-b18e164c600e", "Description": "Speciaal" }, { "Id": "afa50000-0000-0465-aa85-e1a761ca3a33", "Description": "Laag" }, { "Id": "afa50000-0000-0b41-9465-e9f88bcaef86", "Description": "Hoog" } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/vattype": { "get": { "tags": [ "Inkoopjournaalpost" ], "description": "vattype 1.0", "operationId": "get_vattype_1.0", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/take" }, { "$ref": "#/components/parameters/sortField" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "Id", "format": "uuid" }, "Description": { "type": "string", "description": "Description", "format": "string" } } } }, "examples": { "example": { "value": [ { "Id": "afa50000-0000-02bb-9338-0a6629f07fce", "Description": "Verlegd" }, { "Id": "afa50000-0000-0d9c-9502-4fc953f3e012", "Description": "Vrijgesteld" }, { "Id": "afa50000-0000-0b71-8790-807f97e85c54", "Description": "Belast" }, { "Id": "afa50000-0000-0a2d-9cec-bd890979929c", "Description": "Geen btw" } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/cashmutation": { "post": { "tags": [ "POS Transacties" ], "description": "cashmutation 2.0", "operationId": "post_cashmutation_2.0_create", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "name": "Accept-Version", "in": "header", "example": "2", "required": true, "schema": { "type": "string" }, "description": "Use the sequence number of the endpoint." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "normal response": { "value": { "result": "Succeeded", "instances": [ { "Code": "Kasmutatie", "Id": "4d4f06ba-e2ff-4531-94b4-f6f0961144bc" }, { "Code": "OverigeBoeking", "Id": "4227593b-e9ad-43b4-a2e4-3e173e11f5c6" } ], "errors": [] } }, "Only cashmutation": { "value": { "result": "Succeeded", "instances": [ { "Code": "Kasmutatie", "Id": "9ef32c38-7f7c-4640-9b2c-eb9cc3fd0490" } ], "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-cashmutation-2.0-create_request" }, "examples": { "Minimum cash mutuation": { "value": { "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "Description": "Creates only a cashmutation without a reconciliation mutation.", "Date": "2024-03-15", "AmountIncludingVat": 400 } }, "purchase": { "value": { "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "Description": "Aanschaf kleine machines en gereedschap", "Date": "2024-03-15", "LedgerAccountId": "c031b2e8-f8ac-5ab2-a428-93bf9789fc5e", "VatPercentage": 21, "VatTarive": "high", "AmountIncludingVat": -200 } }, "sales": { "value": { "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "Description": "Omzet algemeen", "Date": "2024-03-15", "LedgerAccountId": "cfb59b79-b3ec-55ef-8cde-000499c3179e", "VatPercentage": 21, "VatTarive": "high", "AmountIncludingVat": 400 } }, "with attachments": { "value": { "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "Description": "Aanschaf kleine machines en gereedschap_387", "Date": "2024-03-15", "LedgerAccountId": "c031b2e8-f8ac-5ab2-a428-93bf9789fc5e", "VatPercentage": 21, "VatTarive": "high", "AmountIncludingVat": -200, "Attachments": [ { "AttachmentId": "bcbee6a4-f3de-44c3-91c8-e8921bf15107" }, { "AttachmentId": "6676ad1f-9fc3-4a4f-8a44-d88d8284c598" } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/contact": { "post": { "tags": [ "Relaties" ], "description": "contact 2.0", "operationId": "post_contact_2.0_create", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "name": "Accept-Version", "in": "header", "example": "2", "required": true, "schema": { "type": "string" }, "description": "Use the sequence number of the endpoint." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "success": { "value": { "result": "Succeeded", "instances": [ { "Code": "Persoon", "Id": "3375a0f0-1cf0-5408-98f9-cd3599d96721" }, { "Code": "Emailadres", "Id": "3f669df2-b5d2-41fd-bb7e-7d7030e9d8be" }, { "Code": "Telefoonnummer", "Id": "2349ac50-64eb-4d05-b440-f8372dbd850f" }, { "Code": "Contactpersoon", "Id": "ba9a935d-32ac-447d-9749-105a02079372" } ], "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-contact-2.0-create_request" }, "examples": { "new contact": { "value": { "OrganisationId": "8afb1a9a-1613-5e2b-ab19-20c0f4f3e216", "Firstname": "Rosella", "Initials": "III", "Prefix": "Mr.", "Lastname": "Predovic", "EmailAddress": "Karli61@example.com", "PhoneNumber": "223-385-8892" } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/emailaddress": { "post": { "tags": [ "Relaties" ], "description": "emailaddress 2.0", "operationId": "post_emailaddress_2.0_create", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "name": "Accept-Version", "in": "header", "example": "2", "required": true, "schema": { "type": "string" }, "description": "Use the sequence number of the endpoint." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "success": { "value": { "result": "Succeeded", "instances": [ { "Code": "Emailadres", "Id": "cb052971-6312-42cf-b3fd-de274f248a88" } ], "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-emailaddress-2.0-create_request" }, "examples": { "new email for organisation": { "value": { "RelationType": "organisation", "RelationId": "dde06573-1190-5b31-a400-064588aa62e0", "EmailAddress": "user@example.com" } }, "new email for person": { "value": { "RelationType": "person", "RelationId": "2aacc092-9c6c-5020-b1cf-0d8ecd6485dc", "EmailAddress": "user@example.com" } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/financialjournalentry": { "post": { "tags": [ "Financi\u00EBle journaalpost" ], "description": "financialjournalentry 1.0", "operationId": "post_financialjournalentry_1.0_create", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "success": { "value": { "result": "Succeeded", "traceId": "39f2f0fc-58cc-4f7b-a26b-5aa93d77ba88", "data": { "FinancialJournalEntryId": "6f30c816-3a77-4c2b-9484-9a09cc5edd7f" }, "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-financialjournalentry-1.0-create_request" }, "examples": { "new financialjournalentry periodallocation copy": { "value": { "AdministrationId": "95c0de1b-e269-4c74-ab6a-ece7fb15a4ff", "Description": "journaalpost_001", "EntryDate": "2024-01-22", "EntryLine": [ { "Description": "Regel1", "LedgerAccountId": "5a663714-2c36-5d94-a009-3a210bc2ce52", "AmountDebit": 4000.65, "VatDirection": "Sales", "VatType": "High", "AmountCredit": 0, "PeriodAllocation": true, "PeriodAllocationBeginDate": "2024-01-01", "PeriodAllocationEndDate": "2024-12-31" }, { "Description": "Regel2", "LedgerAccountId": "5a663714-2c36-5d94-a009-3a210bc2ce52", "AmountCredit": 4000.65, "AmountDebit": 0 } ] } }, "new financialjournalentry": { "value": { "AdministrationId": "73109da3-0fcf-4fbe-bd2c-209a399ae502", "Description": "journaalpost_002", "EntryDate": "2024-01-22", "EntryLine": [ { "Description": "Regel1", "LedgerAccountId": "5a663714-2c36-5d94-a009-3a210bc2ce52", "AmountDebit": 4000.65, "VatDirection": "sales", "VatType": "high" }, { "Description": "Regel2", "LedgerAccountId": "5a663714-2c36-5d94-a009-3a210bc2ce52", "AmountCredit": 4000.65 } ] } } } } } }, "security": [ { "access_token": [] } ] }, "delete": { "tags": [ "Financi\u00EBle journaalpost" ], "description": "financialjournalentry 1.0", "operationId": "put_financialjournalentry_1.0_delete", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "$ref": "#/components/parameters/id" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "success": { "value": { "result": "Succeeded", "traceId": "9b99528e-3bf0-4485-91f9-b9bba34550e0", "data": { "FinancialJournalEntryId": "6f30c816-3a77-4c2b-9484-9a09cc5edd7f" }, "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-financialjournalentry-1.0-delete_request" }, "examples": { "delete financialjournalentry": { "value": { "AdministrationId": "e877fb82-b546-4d20-94cf-05c72765fc47", "Id": "e877fb82-b546-4d20-94cf-05c72765fc47" } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/organisation": { "post": { "tags": [ "Publiek: Externe verkoopregels", "Inkoopjournaalpost", "Relaties", "Publiek: Externe facturatie" ], "description": "organisation 3.0", "operationId": "post_organisation_3.0_create", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "name": "Accept-Version", "in": "header", "example": "3", "required": true, "schema": { "type": "string" }, "description": "Use the sequence number of the endpoint." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "minimum": { "value": { "result": "Succeeded", "traceId": "84afadc1-1bbe-4567-aa46-a4e1cb959db2", "data": { "RelationId": "978638a5-394f-4ecc-a31f-21332f9f79e5" }, "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-organisation-3.0-create_request" }, "examples": { "new organisation maximal": { "value": { "Name": "Nitzsche, Dickinson and Predovic", "CocNumber": "38012622", "VatNumber": "NL003276211B01", "Tradename": "Johns - Swaniawski", "EmailAddress": "Damion94@example.org", "Website": "https://astrid.info", "PhoneNumber": "738-407-2156", "ExternalId": "123456789", "Addresses": [ { "StreetName": "inspiratielaan", "HouseNumber": 1, "HouseNumberAddition": "b", "Explanation": "Headquarters", "PostalZone": "3833AV", "State": "Utrecht", "CityName": "Leusden", "CountryCode": "NL", "PreferredSupplierAddress": true, "PreferredShippingAddress": false, "PreferredBillingAddress": true }, { "StreetName": "inspiratielaan", "HouseNumber": 3, "HouseNumberAddition": "b", "Explanation": "Headquarters", "PostalZone": "3833AV", "State": "Utrecht", "CityName": "Leusden", "CountryCode": "NL", "PreferredSupplierAddress": false, "PreferredShippingAddress": true, "PreferredBillingAddress": false } ], "BankAccounts": [ { "AccountNumber": "NL85CHAS0874238307", "BankId": "CHAS", "Bic": "CHASNL2X", "CountryCode": "NL", "AccountHolderName": "Kees Zandbergen", "PreferredOutgoingPayments": true, "PreferredIncommingPayments": true }, { "AccountNumber": "NL44DNIB0736664289", "BankId": "DNIB", "Bic": "DNIBNL2G", "CountryCode": "NL", "AccountHolderName": "Jan Zandbergen", "PreferredOutgoingPayments": false, "PreferredIncommingPayments": false } ] } }, "new organisation minimal": { "value": { "Name": "Larkin Inc" } }, "new organisation": { "value": { "Name": "Terry - Powlowski", "CocNumber": "38012622", "VatNumber": "NL003276211B01", "EmailAddress": "Amelie_Bogisich@example.com", "PhoneNumber": "738-407-2156", "ExternalId": "801-331-6473", "Addresses": [ { "StreetName": "Tillman Glen", "HouseNumber": 1, "HouseNumberAddition": "b", "Explanation": "Headquarters", "PostalZone": "3833AV", "State": "Utrecht", "CityName": "Leusden", "CountryCode": "NL" } ], "BankAccounts": [ { "AccountNumber": "NL85CHAS0874238307", "BankId": "CHAS", "Bic": "CHASNL2X", "CountryCode": "NL", "AccountHolderName": "Kees Zandbergen" } ] } } } } } }, "security": [ { "access_token": [] } ] }, "put": { "tags": [ "Publiek: Externe verkoopregels", "Inkoopjournaalpost", "Relaties", "Publiek: Externe facturatie" ], "description": "organisation 3.0", "operationId": "put_organisation_3.0_update", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "$ref": "#/components/parameters/id" }, { "name": "Accept-Version", "in": "header", "example": "3.0", "required": true, "schema": { "type": "string" }, "description": "Use the sequence number of the endpoint." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "response": { "value": { "result": "Succeeded", "traceId": "d8b6d497-cd52-46b1-a4c3-78dd7f9fb957", "data": { "RelationId": "978638a5-394f-4ecc-a31f-21332f9f79e5" }, "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-organisation-3.0-update_request" }, "examples": { "update organisation": { "value": { "RelationId": "978638a5-394f-4ecc-a31f-21332f9f79e5", "Name": "AFAS Software", "CocNumber": "54041813", "ExternalId": "SWR23244", "Tradename": "AFAS Software BV", "EmailAddress": "info@afas.NL", "WebSite": "www.afas.nl", "phoneNumber": "\u002B31334341800", "Addresses": [ { "StreetName": "inspiratielaan", "HouseNumber": 5, "HouseNumberAddition": "b", "Explanation": "Headquarters", "PostalZone": "3833AV", "State": "Utrecht", "CityName": "Leusden", "CountryCode": "NL", "preferredSupplierAddress": true, "preferredShippingAddress": false, "preferredBillingAddress": true } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/payrolljournalentry": { "post": { "tags": [ "Loonjournaalpost" ], "description": "payrolljournalentry 1.0", "operationId": "post_payrolljournalentry_1.0_create", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "Success": { "value": { "result": "Succeeded", "instances": [ { "Code": "Memoriaalboeking2", "Id": "a70c4e79-a04f-57cf-875b-150434c56e17" } ], "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-payrolljournalentry-1.0-create_request" }, "examples": { "Loonjournaalpost": { "value": { "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", "Description": "Loonjournaalpost_001", "Date": "2024-01-22", "PayrollJournalEntryLine": [ { "LedgerAccountNumber": "1700", "AmountDebit": 4000 }, { "LedgerAccountNumber": "1710", "AmountCredit": 1300 }, { "LedgerAccountNumber": "2300", "AmountCredit": 2700 } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/person": { "post": { "tags": [ "Publiek: Externe verkoopregels", "Inkoopjournaalpost", "Relaties", "Publiek: Externe facturatie" ], "description": "person 3.0", "operationId": "post_person_3.0_create", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "name": "Accept-Version", "in": "header", "example": "3", "required": true, "schema": { "type": "string" }, "description": "Use the sequence number of the endpoint." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "200 response multiple objects": { "value": { "result": "Succeeded", "traceId": "ab9591eb-5c09-4ffc-aa56-12a5516dc469", "data": { "RelationId": "7b97c9cc-d0ef-48bf-a896-657dfb494059" }, "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-person-3.0-create_request" }, "examples": { "create person with 2 addresses and 2 backaccounts": { "value": { "Firstname": "John", "Initials": "J", "Prefix": "Mr", "LastName": "Doe", "Emailaddress": "johndoe@gmail.com", "Phonenumber": "1-555-123-4567", "Addresses": [ { "StreetName": "Main Street", "HouseNumber": 1234, "HouseNumberAddition": "", "Explanation": "", "PostalZone": "90210", "State": "California", "CityName": "Beverly Hills", "CountryCode": "US", "PreferredSupplierAddress": false, "PreferredShippingAddress": true, "PreferredBillingAddress": false }, { "StreetName": "Park Avenue", "HouseNumber": 567, "HouseNumberAddition": "Apt 3B", "Explanation": "", "PostalZone": "10022", "State": "New York", "CityName": "New York", "CountryCode": "US", "PreferredSupplierAddress": true, "PreferredShippingAddress": false, "PreferredBillingAddress": true } ], "BankAccounts": [ { "AccountNumber": "NL93LOYD0175300941", "BankId": "LOYD", "Bic": "LOYDNL2A", "CountryCode": "NL", "PreferredOutgoingPayments": true, "PreferredIncommingPayments": false }, { "AccountNumber": "NL67VOWA0136875262", "BankId": "VOWA", "Bic": "VOWANL21", "CountryCode": "NL", "PreferredOutgoingPayments": false, "PreferredIncommingPayments": true } ] } }, "create person with address and bankaccount": { "value": { "Firstname": "Julianne", "Initials": "J", "Prefix": "Mr", "LastName": "Pouros", "Emailaddress": "Alyce58@gmail.com", "Phonenumber": "1-555-123-4567", "Addresses": [ { "StreetName": "Krommeweg", "HouseNumber": 18, "HouseNumberAddition": "", "Explanation": "", "PostalZone": "8071TE", "CityName": "Nunspeet", "CountryCode": "NL", "PreferredSupplierAddress": true, "PreferredShippingAddress": true, "PreferredBillingAddress": true } ], "BankAccounts": [ { "AccountNumber": "NL93LOYD0175300941", "BankId": "LOYD", "Bic": "LOYDNL2A", "CountryCode": "NL", "PreferredOutgoingPayments": true, "PreferredIncommingPayments": true } ] } }, "create person": { "value": { "Firstname": "John", "Initials": "J", "Prefix": "Mr", "LastName": "Doe", "Emailaddress": "johndoe@gmail.com", "Phonenumber": "1-555-123-4567", "Addresses": [ { "StreetName": "Main Street", "HouseNumber": 1234, "HouseNumberAddition": "", "Explanation": "", "PostalZone": "90210", "State": "California", "CityName": "Beverly Hills", "CountryCode": "US", "PreferredSupplierAddress": false, "PreferredShippingAddress": true, "PreferredBillingAddress": false }, { "StreetName": "Park Avenue", "HouseNumber": 567, "HouseNumberAddition": "Apt 3B", "Explanation": "", "PostalZone": "10022", "State": "New York", "CityName": "New York", "CountryCode": "US", "PreferredSupplierAddress": true, "PreferredShippingAddress": false, "PreferredBillingAddress": true } ], "BankAccounts": [ { "AccountNumber": "NL93LOYD0175300941", "BankId": "LOYD", "Bic": "LOYDNL2A", "CountryCode": "NL", "PreferredOutgoingPayments": true, "PreferredIncommingPayments": false }, { "AccountNumber": "NL67VOWA0136875262", "BankId": "VOWA", "Bic": "VOWANL21", "CountryCode": "NL", "PreferredOutgoingPayments": false, "PreferredIncommingPayments": true } ] } } } } } }, "security": [ { "access_token": [] } ] }, "put": { "tags": [ "Publiek: Externe verkoopregels", "Inkoopjournaalpost", "Relaties", "Publiek: Externe facturatie" ], "description": "person 3.0", "operationId": "put_person_3.0_update", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "$ref": "#/components/parameters/id" }, { "name": "Accept-Version", "in": "header", "example": "3.0", "required": true, "schema": { "type": "string" }, "description": "Use the sequence number of the endpoint." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "response": { "value": { "result": "Succeeded", "traceId": "f0dddf19-12a8-4bf2-b782-359d32679491", "data": { "RelationId": "7b97c9cc-d0ef-48bf-a896-657dfb494059" }, "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-person-3.0-update_request" }, "examples": { "update person": { "value": { "RelationId": "69a7cab4-3a34-4fdf-8017-c6df8a9375df", "FirstName": "John", "LastName": "Doe", "Addresses": [ { "StreetName": "inspiratielaan", "HouseNumber": 5, "HouseNumberAddition": "b", "Explanation": "Headquarters", "PostalZone": "3833AV", "State": "Utrecht", "CityName": "Leusden", "CountryCode": "NL", "preferredSupplierAddress": true, "preferredShippingAddress": true, "preferredBillingAddress": true } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/phonenumber": { "post": { "tags": [ "Relaties" ], "description": "phonenumber 1.0", "operationId": "post_phonenumber_1.0_create", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "response": { "value": { "result": "Succeeded", "instances": [ { "Code": "Telefoonnummer", "Id": "0127112f-48ed-4e09-b981-914913cc1807" } ], "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-phonenumber-1.0-create_request" }, "examples": { "Nieuw telefoonnummer voor organisatie": { "value": { "RelationType": "organisation", "RelationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "PhoneNumber": "033546786" } }, "Nieuw telefoonnummer voor persoon": { "value": { "RelationType": "person", "RelationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "PhoneNumber": "033546786" } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/purchaseinvoice": { "post": { "tags": [ "Inkoopjournaalpost" ], "description": "purchaseinvoice 1.0", "operationId": "post_purchaseinvoice_1.0_create", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "success": { "value": { "result": "Succeeded", "instances": [ { "Code": "UitgaandeBetaling", "Id": "12fa6582-1684-58ba-a7e4-554056ea9651" }, { "Code": "Inkoopfactuur", "Id": "12fa6582-1684-58ba-a7e4-554056ea9651", "Nummer": "IF230002" } ], "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-purchaseinvoice-1.0-create_request" }, "examples": { "inkoopfactuur": { "value": { "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", "SupplierInvoiceId": "2023-0345", "OrderReference": "VF45765", "SupplierOrganisationId": "863d895a-3782-5500-b933-dd487d736138", "IssueDate": "2023-10-03", "DueDate": "2023-10-25", "PaymentMethodId": "afa50000-0000-0102-b0d1-f91a25e6c442", "InvoiceLine": [ { "Description": "Administratiekosten", "LedgerAccountNumberId": "0cee16b9-c2ef-5bb3-a69e-ce6765dbe93b", "LineExtensionAmount": "500.10", "TaxAmount": "105.10", "VatTypeId": "afa50000-0000-0b71-8790-807f97e85c54", "VatRateId": "afa50000-0000-0465-aa85-e1a761ca3a33", "PerformanceDateTypeId": "1f913260-fa35-4d3c-aab6-d04219b025f6", "OtherPerformanceDate": "2023-10-03", "LineNumber": 0 }, { "Description": "Marketingkosten", "LedgerAccountNumberId": "22edee70-753a-5f8c-a613-39fe661fffbe", "LineExtensionAmount": "100.00", "TaxAmount": "21.00", "VatTypeId": "afa50000-0000-0b71-8790-807f97e85c54", "VatRateId": "afa50000-0000-0b41-9465-e9f88bcaef86", "PerformanceDateTypeId": "654b73f6-9bec-4588-97c7-0c080fbe564a", "PerformanceStartDate": "2023-10-03", "PerformanceEndDate": "2023-11-03", "LineNumber": 1 } ] } } } } } }, "security": [ { "access_token": [] } ], "deprecated": true } }, "/api/purchasejournalentry": { "post": { "tags": [ "Inkoopjournaalpost" ], "description": "purchasejournalentry 1.0", "operationId": "post_purchasejournalentry_1.0_create", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "$ref": "#/components/parameters/accept-version" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "response": { "value": { "result": "Succeeded", "instances": [ { "Code": "Leverancier", "Id": "40d42397-61b2-4a09-a595-24a9e48b3524" }, { "Code": "Begunstigde", "Id": "48921982-05ad-4796-b78c-f80e545748fe" }, { "Code": "UitgaandeBetaling", "Id": "d8183b65-8400-5c58-8085-3ef9de6b4428" }, { "Code": "Inkoopfactuur", "Id": "d8183b65-8400-5c58-8085-3ef9de6b4428", "Nummer": "IF240002" } ], "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-purchasejournalentry-1.0-create_request" }, "examples": { "Inkoopjournaalpost": { "value": { "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", "InvoiceNumber": "3gKm5gtrBcjWHNY3dwwjyza4AZYAyBW", "RelationType": "organisation", "RelationId": "863d895a-3782-5500-b933-dd487d736138", "InvoiceDate": "2024-01-22", "DueDate": "2024-02-28", "PaymentMethod": "creditcard", "Attachments": [ { "AttachmentId": "039e63a5-5761-4a6e-a58b-d0fcda003e0c" } ], "InvoiceLine": [ { "Description": "Inkopen btw hoog", "LedgerAccountId": "55eeb0a9-25d0-5c60-830b-07f515fc0c0c", "VatType": "high", "AmountExcludingVat": 22, "AmountVat": 4.62 }, { "Description": "Inkopen btw laag", "LedgerAccountId": "22edee70-753a-5f8c-a613-39fe661fffbe", "VatType": "low", "AmountExcludingVat": 100, "AmountVat": 9 } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/salesinvoice": { "post": { "tags": [ "Verkoopfactuur" ], "description": "salesinvoice 1.1", "operationId": "post_salesinvoice_1.1_create", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "name": "Accept-Version", "in": "header", "example": "1", "required": true, "schema": { "type": "string" }, "description": "Use the sequence number of the endpoint." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "Success with new customer": { "value": { "result": "Succeeded", "instances": [ { "Code": "Klant", "Id": "a8dcbe97-99b1-41bf-a45b-65fd997a415c" }, { "Code": "Betaler", "Id": "c36f6228-44f3-4aa1-94ac-460358cd0444" }, { "Code": "VrkpfctrInkmndBtlngChain", "Id": "c62e495e-02d7-4af4-be0f-c9caa6384fe6" } ], "data": [ { "BusinessActivityId": "c62e495e-02d7-4af4-be0f-c9caa6384fe6", "Factuurnummer": "VF230001", "RowCount": 2 }, { "BusinessActivityId": "c62e495e-02d7-4af4-be0f-c9caa6384fe6", "Factuurnummer": "VF230001", "RowCount": 2 } ], "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-salesinvoice-1.1-create_request" }, "examples": { "2 saleslines for person": { "value": { "AdministrationId": "c59efe34-cb0e-5cb7-a1c7-b1286a699911", "IssueDate": "2023-05-16", "RelationType": "person", "RelationId": "8afb1a9a-1613-5e2b-ab19-20c0f4f3e216", "InvoiceLine": [ { "ItemId": "e33e2205-fd7e-5921-8262-0006aea0e891", "Price": 250, "Quantity": 1 }, { "ItemId": "ab4635de-3b28-5019-9a8a-25fa54362bdd", "Price": 2, "Quantity": 2 } ] } } } } } }, "security": [ { "access_token": [] } ] } }, "/api/salesjournalentry": { "post": { "tags": [ "Publiek: Externe facturatie", "Verkoopjournaalpost" ], "description": "salesjournalentry 2.0", "operationId": "post_salesjournalentry_2.0_create", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "name": "Accept-Version", "in": "header", "example": "2", "required": true, "schema": { "type": "string" }, "description": "Use the sequence number of the endpoint." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "already exists": { "value": { "result": "Failed", "traceId": "3ca43e3a-00b6-460d-8bf1-be2f391f3f4c", "instances": [], "errors": [ "SalesJournalEntry with invoicenumber SB_API_2204202410006 already exists" ] } }, "error on date": { "value": { "result": "Failed", "traceId": "57f10a49-6720-4bb8-8826-8ef92387560f", "instances": [], "errors": [ "Entity is made with one or more errors. Please correct this error in application or delete SalesJournalEntry with id: b32ee6e1-f807-4644-a6d5-d785d8bd7c61", "De factuurdatum ligt v\u00F3\u00F3r de beginbalansdatum. Dit is niet toegestaan." ] } }, "error on line": { "value": { "result": "Failed", "traceId": "010e0485-1e22-4f1a-8573-405090824d35", "instances": [], "errors": [ "Entity is made with one or more errors in the lines. Please correct this error in application or delete SalesJournalEntry with id: eee53305-8851-4859-a53e-b4b18f14040e.", "Field \u0027Grootboekrekening\u0027 contains an invalid reference (a18e0f9a-c73d-58c4-ae80-64c2e4228de4)", "Field \u0027Grootboekrekening\u0027 contains an invalid reference (a18e0f9a-c73d-58c4-ae80-64c2e4228de4)" ] } }, "error": { "value": { "result": "Failed", "traceId": "e193dbe5-8f65-4035-aa81-879bd9828f98", "instances": [], "errors": [ "FeatureToggle not enabled" ] } }, "success": { "value": { "result": "Succeeded", "traceId": "ab84df36-19aa-477c-9f71-c0c61cb542a1", "data": { "SalesJournalEntryId": "2fe9d143-52aa-4d9f-9eba-a97656f2741c" }, "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-salesjournalentry-2.0-create_request" }, "examples": { "BTW binnen en buiten EU": { "value": { "InvoiceNumber": "a", "InvoiceDate": "2024-01-30", "Description": "Unbranded Fresh Pizza", "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", "RelationType": "organisation", "RelationId": "c6f3b724-845c-5af2-8360-2fc751601115", "PaymentMethod": "banktransfer", "PaymentConditionId": "9b5d768a-c71b-583e-b6ee-09d64aa935d4", "InvoiceLine": [ { "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", "VatType": "zero", "AmountExcludingVat": 100 }, { "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", "VatType": "zero", "AmountExcludingVat": 211 } ] } }, "BTW Verlegd binnen Nederland": { "value": { "InvoiceNumber": "d", "InvoiceDate": "2024-01-30", "Description": "Practical Plastic Chips", "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", "RelationType": "organisation", "RelationId": "c6f3b724-845c-5af2-8360-2fc751601115", "PaymentMethod": "banktransfer", "PaymentConditionId": "9b5d768a-c71b-583e-b6ee-09d64aa935d4", "InvoiceLine": [ { "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", "VatType": "high", "VatCalculation": "reversecharged", "AmountExcludingVat": 100 }, { "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", "VatType": "high", "VatCalculation": "reversecharged", "AmountExcludingVat": 396 } ] } }, "Sales with attachment": { "value": { "InvoiceNumber": "1", "InvoiceDate": "2024-02-01", "Description": "Ergonomic Rubber Bacon", "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", "RelationType": "organisation", "RelationId": "a8cce7bd-ced8-5ca4-b3b8-f0584ffe5993", "PaymentMethod": "banktransfer", "PaymentConditionId": "9b5d768a-c71b-583e-b6ee-09d64aa935d4", "Attachments": [ { "AttachmentId": "b031446a-b98e-4378-b7ee-8543e05f34c0" } ], "InvoiceLine": [ { "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", "AmountVat": 21, "VatType": "high", "AmountExcludingVat": 100 }, { "LedgerAccountId": "1a8042a9-576d-5fab-9e5f-75e6f7d5ab63", "AmountExcludingVat": 427, "VatType": "zero", "VatCalculation": "exempt" } ] } }, "verkoop 1 regel": { "value": { "InvoiceNumber": "7", "InvoiceDate": "2024-01-24", "Description": "Unbranded Steel Sausages", "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", "RelationType": "organisation", "RelationId": "9bafbc7a-611b-5465-a584-5f0c88734b35", "PaymentMethod": "banktransfer", "PaymentConditionId": "eb44c60d-06e4-564b-a90c-7715c78788a5", "InvoiceLine": [ { "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", "AmountVat": 183.54, "VatType": "high", "AmountExcludingVat": 874 } ] } }, "verkoop aan persoon": { "value": { "InvoiceNumber": "SAL341434345403", "InvoiceDate": "2024-01-24", "Description": "null", "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", "RelationType": "person", "RelationId": "d36cb9bb-0e5f-5253-ab28-2331804d65ba", "PaymentMethod": "banktransfer", "PaymentConditionId": "eb44c60d-06e4-564b-a90c-7715c78788a5", "InvoiceLine": [ { "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", "AmountVat": 21, "VatType": "high", "AmountExcludingVat": 100 }, { "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", "AmountVat": 450.55, "VatType": "low", "AmountExcludingVat": 40.55, "VatCalculation": "exempt" } ] } }, "verkoop alle soorten btw": { "value": { "InvoiceNumber": "d", "InvoiceDate": "2024-01-23", "Description": "Sleek Metal Tuna", "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", "RelationType": "organisation", "RelationId": "9bafbc7a-611b-5465-a584-5f0c88734b35", "PaymentMethod": "banktransfer", "PaymentConditionId": "eb44c60d-06e4-564b-a90c-7715c78788a5", "InvoiceLine": [ { "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", "AmountVat": 21, "VatType": "high", "AmountExcludingVat": 100 }, { "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", "AmountVat": 40.55, "VatType": "low", "AmountExcludingVat": 40.55, "VatCalculation": "exempt" }, { "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", "AmountVat": 0, "VatType": "zero", "AmountExcludingVat": 40.55 }, { "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", "AmountVat": 18, "VatType": "low", "AmountExcludingVat": 200 }, { "LedgerAccountId": "ebf99e77-1d73-51f2-936d-b3185d8a84ad", "AmountVat": 18, "VatType": "high", "AmountExcludingVat": 200, "VatCalculation": "reversecharged" } ] } }, "verkoop meerdere btw soorten": { "value": { "InvoiceNumber": "t", "InvoiceDate": "2024-01-23", "Description": "Handmade Concrete Car", "AdministrationId": "701b747b-eea2-5ed1-8518-973e5c670252", "RelationType": "organisation", "RelationId": "863d895a-3782-5500-b933-dd487d736138", "PaymentMethod": "banktransfer", "PaymentConditionId": "b98e24e9-a611-5a98-8cf9-40fed321dc6c", "InvoiceLine": [ { "LedgerAccountId": "de3184b9-23f0-55e6-9bd0-ccb5c2b5b5ce", "AmountVat": 21, "VatType": "high", "AmountExcludingVat": 100 }, { "LedgerAccountId": "de3184b9-23f0-55e6-9bd0-ccb5c2b5b5ce", "AmountVat": 40.55, "VatType": "low", "AmountExcludingVat": 40.55, "VatCalculation": "exempt" }, { "LedgerAccountId": "de3184b9-23f0-55e6-9bd0-ccb5c2b5b5ce", "AmountVat": 0, "VatType": "zero", "AmountExcludingVat": 40.55 }, { "LedgerAccountId": "de3184b9-23f0-55e6-9bd0-ccb5c2b5b5ce", "AmountVat": 18, "VatType": "low", "AmountExcludingVat": 200 } ] } } } } } }, "security": [ { "access_token": [] } ] }, "delete": { "tags": [ "Publiek: Externe facturatie", "Verkoopjournaalpost" ], "description": "salesjournalentry 2.0", "operationId": "put_salesjournalentry_2.0_delete", "parameters": [ { "$ref": "#/components/parameters/accept" }, { "$ref": "#/components/parameters/tracking-identifier" }, { "$ref": "#/components/parameters/id" }, { "name": "Accept-Version", "in": "header", "example": "2.0", "required": true, "schema": { "type": "string" }, "description": "Use the sequence number of the endpoint." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "Result status" }, "instances": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Code" }, "Id": { "type": "string", "description": "UUID", "format": "uuid" } } }, "description": "List of instances" }, "errors": { "type": "array", "description": "List of errors" } } }, "examples": { "success": { "value": { "result": "Succeeded", "traceId": "ab84df36-19aa-477c-9f71-c0c61cb542a1", "data": { "SalesJournalEntryId": "2fe9d143-52aa-4d9f-9eba-a97656f2741c" }, "errors": [] } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateconnector-salesjournalentry-2.0-delete_request" }, "examples": { "example": { "value": { "AdministrationId": "a15620b1-90bf-46d8-a155-15f59a3ed460", "Id": "8f8d5e92-bd85-4deb-8184-6abf57a5b24d" } } } } } }, "security": [ { "access_token": [] } ] } } }, "tags": [ { "name": "Crediteuren", "description": "Crediteuren connectoren" }, { "name": "Debiteuren", "description": "Debiteuren connectoren" }, { "name": "Financi\u00EBle journaalpost", "description": "Financi\u00EBle journaalpost connectors" }, { "name": "Financiele rapportage", "description": "Financiele rapportage connectoren" }, { "name": "Inkoopjournaalpost", "description": "Inkoopjournaalpost connectors" }, { "name": "Loonjournaalpost", "description": "Loonjournaalpost connectors" }, { "name": "POS Transacties", "description": "POS transacties" }, { "name": "Publiek: Externe facturatie", "description": "Externe facturatie voor publieke api" }, { "name": "Publiek: Externe verkoopregels", "description": "Verkoopregels voor publieke api" }, { "name": "Publiek: Financi\u00EBle dashboarding", "description": "Financi\u00EBle dashboarding voor publieke api" }, { "name": "Publiek: Financi\u00EBle rapportage", "description": "Financi\u00EBle rapportage voor publieke api" }, { "name": "Publiek: Relatiemanagement", "description": "Relatiemanagement voor publieke api" }, { "name": "Relaties", "description": "Relatie connectors" }, { "name": "Verkoopfactuur", "description": "Verkoopfactuur connectors" }, { "name": "Verkoopjournaalpost", "description": "Verkoopjournaalpost connectors" }, { "name": "Verkoopregels", "description": "Verkoopregels connectors" } ], "components": { "schemas": { "updateconnector-address-1.0-create_request": { "type": "object", "properties": { "RelationType": { "type": "string", "enum": [ "organisation", "person" ], "description": "Must contain one of the enums. Will be required in a future version." }, "RelationId": { "type": "string", "description": "Must contain the guid of the organisation or person. Will be required in a future version.", "format": "uuid" }, "StreetName": { "type": "string" }, "HouseNumber": { "type": "integer" }, "HouseNumberAddition": { "type": "string" }, "Explanation": { "type": "string" }, "PostalZone": { "type": "string" }, "State": { "type": "string", "description": "Could contain the state or province." }, "CityName": { "type": "string", "description": "Dutch CityNames are verfied based on a list of CityNames." }, "CountryCode": { "type": "string", "description": "ISO alpha 2 country code." } }, "required": [ "StreetName", "CityName", "CountryCode" ], "description": "Use this endpoint to create a new address for a person or organisation." }, "updateconnector-authtoken-1.0-create_request": { "type": "object", "properties": { "Properties": { "type": "" } }, "required": [ "instanceId", "ownOrganizationId", "code", "authToken" ] }, "updateconnector-bankaccount-1.0-create_request": { "type": "object", "properties": { "RelationType": { "type": "string", "enum": [ "organisation", "person" ], "description": "Must contain one of the enums. Will be required in a future version." }, "RelationId": { "type": "string", "description": "Must contain the guid of the organisation or person. Will be required in a future version.", "format": "uuid" }, "AccountNumber": { "type": "string", "description": "Fill the IBAN code or AccountNumber" }, "BankId": { "type": "string", "description": "Fill the bankid. Also known as Bankcode of bank identifier." }, "Bic": { "type": "string", "description": "Fill the bic code." }, "CountryCode": { "type": "string", "description": "ISO alpha 2 country code." }, "AccountHolderName": { "type": "string", "description": "Must contain the name of the account holder." } }, "required": [ "AccountNumber", "AccountHolderName", "CountryCode", "RelationType", "RelationId" ], "description": "Use this endpoint to create a new bankaccount data for a person or organisation." }, "updateconnector-cashmutation-2.0-create_request": { "type": "object", "properties": { "AdministrationId": { "type": "string", "description": "The Administration ID uniquely identifying an administration. Retrieve it from the endpoint: api/administration", "format": "uuid" }, "Description": { "type": "string", "description": "The description providing information about the cash mutation and other bookings" }, "Date": { "type": "string", "description": "The date when the cash mutation and other bookings occurred", "format": "date" }, "LedgerAccountId": { "type": "string", "description": "The Ledger Account ID uniquely identifying a ledger account. Retrieve it from the endpoint: api/ledgeraccounts", "format": "uuid" }, "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 - \u0027high\u0027, \u0027low\u0027, or \u0027zero\u0027" }, "VatType": { "type": "string", "enum": [ "purchase", "sales" ], "description": "The type of VAT operation - \u0027purchase\u0027 or \u0027sales\u0027" }, "Attachments": { "type": "array", "items": { "type": "object", "properties": { "AttachmentId": { "type": "string", "format": "uuid" } }, "required": [ "AttachmentId" ] }, "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment." } }, "required": [ "AdministrationId", "Description", "Date", "AmountIncludingVat" ], "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." }, "updateconnector-contact-2.0-create_request": { "type": "object", "properties": { "OrganisationId": { "type": "string", "format": "uuid" }, "ContactId": { "type": "string", "format": "uuid" }, "FirstName": { "type": "string" }, "Initials": { "type": "string" }, "Prefix": { "type": "string" }, "LastName": { "type": "string" }, "EmailAddress": { "type": "string", "format": "email" }, "PhoneNumber": { "type": "string" } }, "required": [ "OrganisationId", "LastName" ], "description": "Create a contact by organisation." }, "updateconnector-customer-1.0-create_request": { "type": "object", "properties": { "AdministrationId": { "type": "string", "description": "Required field containing the guid of the administation. This value can be received through a Get Administration request", "format": "uuid" }, "EmailAddress": { "type": "string", "description": "The emailaddress is set to default communication emailaddress for sending invoices", "format": "email" }, "PhoneNumber": { "type": "string" }, "BankAccountNumber": { "type": "string", "description": "Must be in IBAN format. Creates a bankaccount record for the customer" }, "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" }, "LedgerAccountId": { "type": "string", "description": "Set default value for customer.", "format": "uuid" }, "PaymentMethod": { "type": "string", "enum": [ "creditcard", "directdebit", "debetcard", "unknown", "cash", "ideal", "banktransfer", "", "null" ], "description": "Set default value for customer. Falls back to customer default when empty." }, "PaymentConditionId": { "type": "string", "description": "Set default value for customer. Payment condition guids can be requested with the PaymentCondition Get endpoint. Falls back to default when empty.", "format": "uuid" }, "Person": { "type": "object", "properties": { "Firstname": { "type": "string" }, "Initials": { "type": "string" }, "Prefix": { "type": "string" }, "Lastname": { "type": "string" } }, "required": [ "Lastname" ] }, "Organisation": { "type": "object", "properties": { "Name": { "type": "string" }, "CompanyIdCoc": { "type": "string", "description": "Contains the CompanyCode also known in dutch as KVK nummer" }, "CompanyIdVat": { "type": "string", "description": "Contains the VAT code of the customer" }, "TradeName": { "type": "string", "description": "The formal trade name of the organisation. If empty will be filled with the field Name" } }, "required": [ "Name" ] } }, "required": [ "AdministrationId" ], "description": "Create a customer." }, "updateconnector-emailaddress-2.0-create_request": { "type": "object", "properties": { "RelationType": { "type": "string", "enum": [ "organisation", "person" ], "description": "Must contain one of the enums. Will be required in a future version." }, "RelationId": { "type": "string", "description": "Must contain the guid of the organisation or person. Will be required in a future version.", "format": "uuid" }, "EmailAddress": { "type": "string", "format": "email" } }, "required": [ "EmailAddress", "RelationType", "RelationId" ], "description": "Create an emailaddress for an organisation or person." }, "updateconnector-financialjournalentry-1.0-create_request": { "type": "object", "properties": { "AdministrationId": { "type": "string", "description": "Must contain the Administration guid of the target Administration", "format": "uuid" }, "EntryDate": { "type": "string", "format": "date" }, "Description": { "type": "string", "description": "Can contain a description for the JournalEntry." }, "Attachments": { "type": "array", "items": { "type": "object", "properties": { "AttachmentId": { "type": "string", "format": "uuid" } }, "required": [ "AttachmentId" ] }, "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment." }, "EntryLine": { "type": "array", "items": { "type": "object", "properties": { "LedgerAccountId": { "type": "string", "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", "format": "uuid" }, "Description": { "type": "string", "description": "Can contain a description for the JournalEntryLine." }, "AmountDebit": { "type": "number" }, "AmountCredit": { "type": "number" }, "VatDirection": { "type": "string", "enum": [ "sales", "purchases", "", "null" ] }, "VatType": { "type": "string", "enum": [ "high", "low", "special", "zero", "", "null" ] }, "PeriodAllocation": { "type": "boolean", "description": "Apportion over a period" }, "PeriodAllocationBeginDate": { "type": "string", "format": "date" }, "PeriodAllocationEndDate": { "type": "string", "format": "date" } }, "required": [ "LedgerAccountId" ] } } }, "required": [ "AdministrationId", "EntryDate", "Description", "EntryLine" ], "description": "Create a financial journal entry." }, "updateconnector-financialjournalentry-1.0-delete_request": { "type": "object", "properties": { "AdministrationId": { "type": "string", "description": "Must contain the Administration guid of the target Administration", "format": "uuid" }, "Id": { "type": "string", "description": "Must contain the guid of financialjournalentry.", "format": "uuid" } }, "required": [ "AdministrationId", "Id" ], "description": "Delete a financialjournalentry" }, "updateconnector-linestobeinvoiced-1.0-create_request": { "type": "object", "properties": { "AdministrationId": { "type": "string", "description": "Must contain the Administration guid of the target Administration", "format": "uuid" }, "Date": { "type": "string", "format": "date" }, "Description": { "type": "string", "description": "Must contain a description for the Line to be invoiced." }, "RelationType": { "type": "string", "enum": [ "organisation", "person", "unknown" ], "description": "Must contain one of the enums." }, "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": "integer", "description": "Quantity of products of this type" }, "Price": { "type": "number", "description": "Price per product, may be left empty" }, "ProjectId": { "type": "string", "description": "Must contain the guid of the project.", "format": "uuid" } }, "required": [ "AdministrationId", "Date", "Description", "RelationType", "RelationId", "ItemId", "Quantity" ], "description": "Create a line to be invoiced" }, "updateconnector-linestobeinvoiced-1.0-delete_request": { "type": "object", "properties": { "AdministrationId": { "type": "string", "description": "Must contain the Administration guid of the target Administration", "format": "uuid" }, "Id": { "type": "string", "description": "Must contain the guid of line to be invoiced.", "format": "uuid" } }, "required": [ "AdministrationId", "Id" ], "description": "Delete a line to be invoiced" }, "updateconnector-linestobeinvoiced-1.0-update_request": { "type": "object", "properties": { "AdministrationId": { "type": "string", "description": "Must contain the Administration guid of the target Administration", "format": "uuid" }, "LineToBeInvoicedId": { "type": "string", "description": "Must contain the guid of the line to be invoiced", "format": "uuid" }, "Date": { "type": "string", "format": "date" }, "Description": { "type": "string", "description": "Can contain a description for the Line to be invoiced." }, "RelationType": { "type": "string", "enum": [ "organisation", "person", "unknown" ], "description": "Must contain one of the enums." }, "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": "integer", "description": "Quantity of products of this type" }, "Price": { "type": "number", "description": "Price per product, may be left empty" }, "ProjectId": { "type": "string", "description": "Must contain the guid of the project.", "format": "uuid" } }, "required": [ "AdministrationId", "LineToBeInvoicedId", "Date", "Description", "RelationType", "RelationId", "ItemId", "Quantity" ], "description": "Update a line to be invoiced" }, "updateconnector-organisation-3.0-create_request": { "type": "object", "properties": { "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", "pattern": "^[0-9]\u002B$", "description": "The Chamber of Commerce (CoC) number of the organisation" }, "VatNumber": { "type": "string", "pattern": "^[A-Z]{2}[0-9]\u002B[A-Z]{1}[0-9]\u002B$", "description": "The Value-Added Tax (VAT) number of the organisation" }, "Tradename": { "type": "string", "description": "The tradename of the organisation" }, "SbiCode": { "type": "string", "description": "The SBICode of the organisation" }, "EmailAddress": { "type": "string", "description": "The email address of the organisation", "format": "email" }, "Website": { "type": "string", "description": "The website of the organisation", "format": "uri" }, "PhoneNumber": { "type": "string", "description": "The phone number of the organisation" }, "Addresses": { "type": "array", "items": { "type": "object", "properties": { "StreetName": { "type": "string" }, "HouseNumber": { "type": "integer" }, "HouseNumberAddition": { "type": "string" }, "Explanation": { "type": "string" }, "PostalZone": { "type": "string" }, "State": { "type": "string", "description": "Could contain the state or province." }, "CityName": { "type": "string", "description": "Dutch CityNames are verfied based on a list of CityNames." }, "CountryCode": { "type": "string", "description": "ISO alpha 2 country code." }, "PreferredSupplierAddress": { "type": "boolean" }, "PreferredShippingAddress": { "type": "boolean" }, "PreferredBillingAddress": { "type": "boolean" } }, "required": [ "StreetName", "CityName", "CountryCode" ] } }, "BankAccounts": { "type": "array", "items": { "type": "object", "properties": { "AccountNumber": { "type": "string", "description": "Fill the IBAN code or AccountNumber" }, "BankId": { "type": "string", "description": "Fill the bankid. Also known as Bankcode of bank identifier." }, "Bic": { "type": "string", "description": "Fill the bic code." }, "CountryCode": { "type": "string", "description": "ISO alpha 2 country code." }, "AccountHolderName": { "type": "string", "description": "Must contain the name of the account holder." }, "PreferredOutgoingPayments": { "type": "boolean" }, "PreferredIncommingPayments": { "type": "boolean" } }, "required": [ "AccountNumber", "AccountHolderName" ] }, "description": "Create 1 or more bankAccounts for an organisation" } }, "required": [ "Name" ], "description": "A JSON schema to represent an organization" }, "updateconnector-organisation-3.0-update_request": { "type": "object", "properties": { "RelationId": { "type": "string", "description": "Must contain the guid of the organisation.", "format": "uuid" }, "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", "pattern": "^[0-9]\u002B$", "description": "The Chamber of Commerce (CoC) number of the organisation" }, "VatNumber": { "type": "string", "pattern": "^[A-Z]{2}[0-9]\u002B[A-Z]{1}[0-9]\u002B$", "description": "The Value-Added Tax (VAT) number of the organisation" }, "Tradename": { "type": "string", "description": "The tradename of the organisation" }, "SbiCode": { "type": "string", "description": "The SBICode of the organisation" }, "EmailAddress": { "type": "string", "description": "The email address of the organisation", "format": "email" }, "Website": { "type": "string", "description": "The website of the organisation", "format": "uri" }, "PhoneNumber": { "type": "string", "description": "The phone number of the organisation" }, "Addresses": { "type": "array", "items": { "type": "object", "properties": { "StreetName": { "type": "string" }, "HouseNumber": { "type": "integer" }, "HouseNumberAddition": { "type": "string" }, "Explanation": { "type": "string" }, "PostalZone": { "type": "string" }, "State": { "type": "string", "description": "Could contain the state or province." }, "CityName": { "type": "string", "description": "Dutch CityNames are verfied based on a list of CityNames." }, "CountryCode": { "type": "string", "description": "ISO alpha 2 country code." }, "PreferredSupplierAddress": { "type": "boolean" }, "PreferredShippingAddress": { "type": "boolean" }, "PreferredBillingAddress": { "type": "boolean" } }, "required": [ "StreetName", "CityName", "CountryCode" ] } }, "BankAccounts": { "type": "array", "items": { "type": "object", "properties": { "AccountNumber": { "type": "string", "description": "Fill the IBAN code or AccountNumber" }, "BankId": { "type": "string", "description": "Fill the bankid. Also known as Bankcode of bank identifier." }, "Bic": { "type": "string", "description": "Fill the bic code." }, "CountryCode": { "type": "string", "description": "ISO alpha 2 country code." }, "AccountHolderName": { "type": "string", "description": "Must contain the name of the account holder." }, "PreferredOutgoingPayments": { "type": "boolean" }, "PreferredIncommingPayments": { "type": "boolean" } }, "required": [ "AccountNumber", "AccountHolderName" ] }, "description": "Create 1 or more bankAccounts for an organisation" } }, "required": [ "RelationId" ], "description": "A JSON schema to represent an organization" }, "updateconnector-payrolljournalentry-1.0-create_request": { "type": "object", "properties": { "AdministrationId": { "type": "string", "description": "Use GET ../Administration", "format": "uuid" }, "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", "example": 1403.65 }, "AmountCredit": { "type": "number", "example": 2650.33 } }, "required": [ "LedgerAccountNumber" ] } } }, "required": [ "AdministrationId", "Description", "Date", "PayrollJournalEntryLine" ], "description": "Create a Payroll entry." }, "updateconnector-person-3.0-create_request": { "type": "object", "properties": { "FirstName": { "type": "string", "description": "The first name of the person." }, "LastName": { "type": "string", "description": "The last name of the person." }, "Initials": { "type": "string", "description": "The initials of the person." }, "Prefix": { "type": "string", "description": "The prefix of the lastname." }, "EmailAddress": { "type": "string", "description": "The emailaddress of the person", "format": "email" }, "PhoneNumber": { "type": "string", "description": "The phonenumber of the person" }, "ExternalId": { "type": "string", "description": "ExternalId of the person to use for a client application." }, "Addresses": { "type": "array", "items": { "type": "object", "properties": { "StreetName": { "type": "string" }, "HouseNumber": { "type": "integer" }, "HouseNumberAddition": { "type": "string" }, "Explanation": { "type": "string" }, "PostalZone": { "type": "string" }, "State": { "type": "string", "description": "Could contain the state or province." }, "CityName": { "type": "string", "description": "Dutch CityNames are verfied based on a list of CityNames." }, "CountryCode": { "type": "string", "description": "ISO alpha 2 country code." }, "PreferredSupplierAddress": { "type": "boolean" }, "PreferredShippingAddress": { "type": "boolean" }, "PreferredBillingAddress": { "type": "boolean" } }, "required": [ "StreetName", "CityName", "CountryCode" ] }, "description": "Create 1 or more addresses for a person" }, "BankAccounts": { "type": "array", "items": { "type": "object", "properties": { "AccountNumber": { "type": "string", "description": "Fill the IBAN code or AccountNumber" }, "BankId": { "type": "string", "description": "Fill the bankid. Also known as Bankcode of bank identifier." }, "Bic": { "type": "string", "description": "Fill the bic code." }, "CountryCode": { "type": "string", "description": "ISO alpha 2 country code." }, "PreferredOutgoingPayments": { "type": "boolean" }, "PreferredIncommingPayments": { "type": "boolean" } }, "required": [ "AccountNumber", "CountryCode" ] }, "description": "Create 1 or more bankAccounts for a person" } }, "required": [ "LastName" ] }, "updateconnector-person-3.0-update_request": { "type": "object", "properties": { "RelationId": { "type": "string", "description": "Must contain the guid of the person.", "format": "uuid" }, "FirstName": { "type": "string", "description": "The first name of the person." }, "LastName": { "type": "string", "description": "The last name of the person." }, "Initials": { "type": "string", "description": "The initials of the person." }, "Prefix": { "type": "string", "description": "The prefix of the lastname." }, "EmailAddress": { "type": "string", "description": "The emailaddress of the person", "format": "email" }, "PhoneNumber": { "type": "string", "description": "The phonenumber of the person" }, "ExternalId": { "type": "string", "description": "ExternalId of the person to use for a client application." }, "Addresses": { "type": "array", "items": { "type": "object", "properties": { "StreetName": { "type": "string" }, "HouseNumber": { "type": "integer" }, "HouseNumberAddition": { "type": "string" }, "Explanation": { "type": "string" }, "PostalZone": { "type": "string" }, "State": { "type": "string", "description": "Could contain the state or province." }, "CityName": { "type": "string", "description": "Dutch CityNames are verfied based on a list of CityNames." }, "CountryCode": { "type": "string", "description": "ISO alpha 2 country code." }, "PreferredSupplierAddress": { "type": "boolean" }, "PreferredShippingAddress": { "type": "boolean" }, "PreferredBillingAddress": { "type": "boolean" } }, "required": [ "StreetName", "CityName", "CountryCode" ] }, "description": "Create 1 or more addresses for a person" }, "BankAccounts": { "type": "array", "items": { "type": "object", "properties": { "AccountNumber": { "type": "string", "description": "Fill the IBAN code or AccountNumber" }, "BankId": { "type": "string", "description": "Fill the bankid. Also known as Bankcode of bank identifier." }, "Bic": { "type": "string", "description": "Fill the bic code." }, "CountryCode": { "type": "string", "description": "ISO alpha 2 country code." }, "PreferredOutgoingPayments": { "type": "boolean" }, "PreferredIncommingPayments": { "type": "boolean" } }, "required": [ "AccountNumber", "CountryCode" ] }, "description": "Create 1 or more bankAccounts for a person" } }, "required": [ "RelationId" ] }, "updateconnector-phonenumber-1.0-create_request": { "type": "object", "properties": { "RelationType": { "type": "string", "enum": [ "organisation", "person" ], "description": "Must contain one of the enums. Will be required in a future version." }, "RelationId": { "type": "string", "description": "Must contain the guid of the organisation or person. Will be required in a future version.", "format": "uuid" }, "OrganisationId": { "type": "string", "format": "uuid", "example": "32abaca0-b4c6-4dce-af80-9de42a830e62" }, "PhoneNumber": { "type": "string", "description": " All characters of the phonenumber that are not a diget will be removed." } }, "required": [ "PhoneNumber" ], "description": "Create a PhoneNumber for an organisation or person." }, "updateconnector-purchaseinvoice-1.0-create_request": { "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" } } } } }, "description": "" }, "updateconnector-purchasejournalentry-1.0-create_request": { "type": "object", "properties": { "AdministrationId": { "type": "string", "description": "Must contain the Administration guid of the target Administration", "format": "uuid" }, "InvoiceNumber": { "type": "string", "description": "Must contain the InvoiceNumber" }, "Reference": { "type": "string", "description": "Can contain a reference id to the origin app." }, "RelationType": { "type": "string", "enum": [ "organisation", "person", "unknown" ], "description": "Must contain one of the enums." }, "RelationId": { "type": "string", "description": "Must contain the guid of the organisation, person or unknown relation.", "format": "uuid" }, "InvoiceDate": { "type": "string", "format": "date" }, "DueDate": { "type": "string", "format": "date" }, "PlannedPaymentDate": { "type": "string", "format": "date" }, "PaymentMethod": { "type": "string", "enum": [ "creditcard", "directdebit", "debetcard", "unknown", "cash", "ideal", "banktransfer", "", "null" ], "description": "Payment method enum. Falls back to customer default when empty." }, "Attachments": { "type": "array", "items": { "type": "object", "properties": { "AttachmentId": { "type": "string", "format": "uuid" } }, "required": [ "AttachmentId" ] }, "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment." }, "InvoiceLine": { "type": "array", "items": { "type": "object", "properties": { "Description": { "type": "string" }, "LedgerAccountId": { "type": "string", "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", "format": "uuid" }, "AmountExcludingVat": { "type": "number" }, "AmountVat": { "type": "number" }, "VatType": { "type": "string", "enum": [ "high", "low", "zero", "", "null" ] }, "VatCalculation": { "type": "string", "enum": [ "reversecharged", "exempt", "", "null" ], "description": "Only include if vat is reverse-charge or exemption." } }, "required": [ "LedgerAccountId", "AmountExcludingVat", "VatType" ] } } }, "required": [ "AdministrationId", "InvoiceNumber", "RelationType", "RelationId", "InvoiceDate", "InvoiceLine", "DueDate" ], "description": "Create a purchase journal entry." }, "updateconnector-refreshtoken-1.0-create_request": { "type": "object", "properties": { "Properties": { "type": "" } }, "required": [ "instanceId", "ownOrganizationId", "code", "refreshToken" ] }, "updateconnector-salesinvoice-1.1-create_request": { "type": "object", "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", "enum": [ "organisation", "person", "unknown" ], "description": "Must contain one of the enums." }, "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." }, "Attachments": { "type": "array", "items": { "type": "object", "properties": { "AttachmentId": { "type": "string", "format": "uuid" } }, "required": [ "AttachmentId" ] }, "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment." }, "InvoiceLine": { "type": "array", "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." }, "Quantity": { "type": "integer", "description": "Quantity of products of this type" }, "ExtraDescription": { "type": "string", "description": "Optional field for extra information about the invoiceline" } }, "required": [ "ItemId", "Quantity" ] } } }, "required": [ "AdministrationId", "IssueDate", "RelationType", "RelationId", "InvoiceLine" ], "description": "Create a sales invoice." }, "updateconnector-salesjournalentry-2.0-create_request": { "type": "object", "properties": { "AdministrationId": { "type": "string", "description": "Must contain the Administration guid of the target Administration", "format": "uuid" }, "InvoiceDate": { "type": "string", "format": "date" }, "InvoiceNumber": { "type": "string", "description": "Must contain the InvoiceNumber" }, "RelationType": { "type": "string", "enum": [ "organisation", "person", "unknown" ], "description": "Must contain one of the enums." }, "RelationId": { "type": "string", "description": "Must contain the guid of the organisation, person or unknown relation.", "format": "uuid" }, "Reference": { "type": "string", "description": "Can contain a reference id to the origin app." }, "Description": { "type": "string", "description": "Can contain a description for the JournalEntry." }, "PaymentMethod": { "type": "string", "enum": [ "creditcard", "directdebit", "debetcard", "unknown", "cash", "ideal", "banktransfer", "", "null" ], "description": "Payment method enum. Falls back to customer default when empty." }, "PaymentConditionId": { "type": "string", "description": "Payment condition guids can be requested with the PaymentCondition Get endpoint. Falls back to default when empty.", "format": "uuid" }, "Attachments": { "type": "array", "items": { "type": "object", "properties": { "AttachmentId": { "type": "string", "format": "uuid" } }, "required": [ "AttachmentId" ] }, "description": "Use the blob endpoint to create a Attachment. Fill the guid of the attachment." }, "InvoiceLine": { "type": "array", "items": { "type": "object", "properties": { "LedgerAccountId": { "type": "string", "description": "Must contain the LedgerAccountId. LedgerAccountIds can be requested through the LedgerAccount endpoint.", "format": "uuid" }, "Description": { "type": "string", "description": "Can contain a description for the JournalEntryLine." }, "AmountExcludingVat": { "type": "number" }, "AmountVat": { "type": "number" }, "VatType": { "type": "string", "enum": [ "high", "low", "zero", "", "null" ] }, "IntraCommunityType": { "type": "string", "enum": [ "supplies", "services", "", "null" ], "description": "Only include if sale is B2B and inside EU (ICP purposes). Falls back to default \u0027supplies\u0027 when empty." }, "VatCalculation": { "type": "string", "enum": [ "reversecharged", "exempt", "", "null" ], "description": "Only include if vat is reverse-charge or exemption." } }, "required": [ "LedgerAccountId", "AmountExcludingVat", "VatType" ] } } }, "required": [ "AdministrationId", "InvoiceDate", "InvoiceNumber", "RelationType", "RelationId", "InvoiceLine" ], "description": "Create a sales journal entry." }, "updateconnector-salesjournalentry-2.0-delete_request": { "type": "object", "properties": { "AdministrationId": { "type": "string", "description": "Must contain the Administration guid of the target Administration", "format": "uuid" }, "Id": { "type": "string", "description": "Must contain the guid of salesjournal.", "format": "uuid" } }, "required": [ "AdministrationId", "Id" ], "description": "Delete a salesjournalentry" }, "updateconnector-scanbox-1.0-create_request": { "type": "object", "properties": { "Scan": { "type": "object", "properties": { "AdministrationId": { "type": "string", "description": "De administratie waarin de factuur wordt toegevoegd.\r\n", "format": "uuid", "example": "449be14f-ccb7-41a4-81fd-e4fe7a2f7247" }, "DocumentId": { "type": "string", "description": "Identificatie van een scan. Scans kunnen toegevoegd worden met de Blob updateconnector.", "format": "uuid", "example": "732cc4dc-dc39-4e47-824b-e54dd2749f25" }, "Description": { "type": "string", "maxLength": 256, "description": "Omschrijving van de te boeken factuur." } }, "required": [ "AdministrationId" ] } }, "required": [ "Scan" ] }, "updateconnector-supplier-1.0-create_request": { "type": "object", "properties": { "AdministrationId": { "type": "string", "description": "Must contain the Administration guid of the target Administration", "format": "uuid" }, "EmailAddress": { "type": "string", "format": "email" }, "PhoneNumber": { "type": "string" }, "BankAccountNumber": { "type": "string", "description": "Must be in IBAN format. Creates a bankaccount record for the supplier" }, "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" }, "LedgerAccountId": { "type": "string", "description": "Set default value for supplier.", "format": "uuid" }, "PaymentMethod": { "type": "string", "enum": [ "creditcard", "directdebit", "debetcard", "unknown", "cash", "ideal", "banktransfer", "", "null" ], "description": "Set default value for supplier. Falls back to supplier default when empty." }, "PaymentConditionId": { "type": "string", "description": "Set default value for supplier. Payment condition guids can be requested with the PaymentCondition Get endpoint. Falls back to default when empty.", "format": "uuid" }, "VatCalculation": { "type": "string", "enum": [ "charged", "novat", "reversecharged", "exempt", "", "null" ], "description": "Set de value for supplier." }, "Person": { "type": "object", "properties": { "Firstname": { "type": "string" }, "Initials": { "type": "string" }, "Prefix": { "type": "string" }, "Lastname": { "type": "string" } }, "required": [ "Lastname" ] }, "Organisation": { "type": "object", "properties": { "Name": { "type": "string" }, "CompanyIdCoc": { "type": "string", "description": "Contains the CompanyCode also known in dutch as KVK nummer" }, "CompanyIdVat": { "type": "string", "description": "Contains the VAT code of the supplier" }, "TradeName": { "type": "string", "description": "The formal trade name of the organisation. If empty will be filled with the field Name" } }, "required": [ "Name" ] } }, "required": [ "AdministrationId" ], "description": "Create a supplier." } }, "securitySchemes": { "OAuth2AdminCenter": { "name": null, "type": "oauth2", "in": null, "description": "OAuth 2.0 Authorization Code Grant with PKCE (S256 challenge algorithm) for admin center." }, "OAuth2klantomgeving": { "name": null, "type": "oauth2", "in": null, "description": "OAuth 2.0 Authorization Code Grant with PKCE (S256 challenge algorithm)" }, "access_token": { "name": null, "type": "http", "in": null, "description": null } }, "parameters": { "accept": { "in": "header", "name": "Accept", "schema": { "type": "string", "examples": [ "*/*" ] } }, "skip": { "name": "skip", "in": "query", "required": false, "schema": { "type": "integer", "examples": [ "0" ] }, "description": "Amount of results to skip" }, "take": { "name": "take", "in": "query", "required": false, "schema": { "type": "integer", "examples": [ 100 ] }, "description": "Amount of results to retrieve" }, "sortField": { "name": "sortField", "in": "query", "description": "The field by which you want to sort the results, along with the optional sort direction (ascending or descending). The format should be \u0027fieldId [direction]\u0027, where \u0027fieldId\u0027 is the ID of the field and \u0027direction\u0027 is either \u0027ascending\u0027 or \u0027descending\u0027. If the direction is not specified, the default is \u0027ascending\u0027.", "required": false, "schema": { "type": "string", "example": "InternalId ascending" } }, "trackingtoken": { "name": "TrackingToken", "in": "query", "required": false, "schema": { "type": "string", "examples": [ "202312040745010" ] }, "description": "Get all changed items after this token." }, "tracking-identifier": { "name": "Tracking-Identifier", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid", "examples": [ "8522fea1-a067-4851-9b8e-a7b7080ac3af" ] }, "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." }, "filter": { "name": "filter", "in": "query", "schema": { "type": "string" }, "description": "Get specific item with filter" }, "accept-version": { "name": "Accept-Version", "in": "header", "example": "1", "required": true, "schema": { "type": "string" }, "description": "Use the sequence number of the endpoint." }, "authorization": { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Bearer {access_token}" }, "no-cors": { "name": "no-cors", "in": "header", "required": false, "schema": { "type": "boolean", "default": false } }, "id": { "name": "id", "in": "path", "description": "id of the object", "required": true, "schema": { "type": "string", "format": "uuid" } } }, "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": "\u0027identificatie\u0027 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": "\u0027identificatie\u0027 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 \u0027\u0027 does not validate against format \u0027uuid\u0027. Path \u0027RelationId\u0027, 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" } } } } } } } } }, "security": [ { "OAuth2AdminCenter": [] }, { "OAuth2klantomgeving": [] }, { "access_token": [] }, { "Applicationtoken": [] } ] }