{ "openapi": "3.0.0", "paths": { "/tenants/submission-page-style": { "post": { "operationId": "updateSubmissionPageStyle", "summary": "Set submission page style", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "backgroundColor": { "type": "string", "example": "#ffffff", "description": "Page background color." }, "titleColor": { "type": "string", "example": "#202224", "description": "Header text color." }, "textColor": { "type": "string", "example": "#202224", "description": "Dropdown/input text color." }, "inputBackgroundColor": { "type": "string", "example": "#f0f0f0", "description": "Input and dropdown background color." }, "submitButtonColor": { "type": "string", "example": "#27A691", "description": "Submit button background color." }, "submitButtonTextColor": { "type": "string", "example": "#ffffff", "description": "Submit button text color." }, "cancelButtonColor": { "type": "string", "example": "#cccccc", "description": "Cancel button background color." }, "cancelButtonTextColor": { "type": "string", "example": "#202224", "description": "Cancel button text color." }, "errorTextColor": { "type": "string", "example": "#cc0000", "description": "Validation error text color." }, "logoSvg": { "type": "string", "example": "PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxMjAiIGhlaWdodD0iNDAiIHZpZXdCb3g9IjAgMCAxMjAgNDAiPjxyZWN0IHdpZHRoPSIxMjAiIGhlaWdodD0iNDAiIHJ4PSI4IiBmaWxsPSIjMjdBNjkxIi8+PHRleHQgeD0iNjAiIHk9IjI2IiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTYiIGZpbGw9IndoaXRlIiB0ZXh0LWFuY2hvcj0ibWlkZGxlIj5Mb2dvPC90ZXh0Pjwvc3ZnPgo=", "description": "Base64-encoded SVG logo. Takes priority over logoPng if both are set." }, "logoPng": { "type": "string", "example": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==", "description": "Base64-encoded PNG logo. Used if logoSvg is not set." }, "pageLocalizations": { "type": "array", "description": "Page copy, one entry per locale. The entry without a locale is the default and is used whenever the requested locale has no entry. Entries are merged by locale: sending one language leaves the others untouched, and an entry with no texts removes that locale.", "items": { "type": "object", "properties": { "locale": { "type": "string", "example": "de", "description": "BCP-47 language tag (de, de-DE). Leave it out to set the default texts." }, "titleText": { "type": "string", "example": "Verbinde dein Konto", "description": "Page headline. Defaults to \"Connect Account\" on the API key page and \"Select your environment for :\" on the company selection page." }, "freeText": { "type": "string", "example": "Lorem ipsum dolor sit amet.", "description": "Free text rendered between the input fields and the buttons. No default \u2014 the element is omitted when unset." }, "submitButtonText": { "type": "string", "example": "Verbinden", "description": "Submit button label. Defaults to \"Connect\" on the API key page and \"Submit\" on the company selection page." }, "cancelButtonText": { "type": "string", "example": "Abbrechen", "description": "Cancel button label. Defaults to \"Cancel\" on both pages." } } } } } } } } }, "responses": { "201": { "description": "Submission page style updated successfully.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "tags": ["tenants"] } }, "/tenants/register-system": { "post": { "operationId": "systemRegistration", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemRegistrationDto" } } } }, "responses": { "201": { "description": "" } }, "tags": [ "tenants" ] } }, "/tenants/add-callback-url": { "post": { "operationId": "addCallbackUrl", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallbackUrlRegistrationDto" } } } }, "responses": { "201": { "description": "" } }, "tags": [ "tenants" ] } }, "/tenants/get-end-user-list": { "get": { "operationId": "getEndUserList", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EndUserResponseDto" } } } } } }, "tags": [ "tenants" ] } }, "/tenants/delete-end-user": { "delete": { "operationId": "deleteEndUser", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key for the end user that needs to be deleted", "in": "header", "schema": { "type": "string" } } ], "responses": { "204": { "description": "" } }, "tags": [ "tenants" ] } }, "/tenants/signing-secret": { "post": { "operationId": "createSigningSecret", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": false, "description": "No request body required", "content": {} }, "responses": { "201": { "description": "Signing secret created", "content": { "application/json": { "schema": { "type": "object", "properties": { "secret": { "type": "string", "example": "a3f8c2e1d4b7a9f0e2c5d8b1a4f7c0e3d6b9a2f5c8e1d4b7a0f3c6e9d2b5a8f1" } } } } } } }, "tags": [ "tenants" ] } }, "/auth/{TARGET_SYSTEM}": { "get": { "operationId": "systemLoginUrl", "parameters": [ { "name": "TARGET_SYSTEM", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "callbackUrl", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "cancelCallbackUrl", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "tenantId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentSelection", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "include_signature", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "locale", "description": "BCP-47 language tag (for example de or de-DE) the authentication pages should be shown in. Falls back to the texts configured without a locale. The locale travels with the flow, so the company selection page is shown in the same language.", "required": false, "in": "query", "schema": { "type": "string", "example": "de" } } ], "responses": { "200": { "description": "Successful response", "content": { "text/html": { "schema": { "type": "string", "example": "https://login-url.com" } } } } }, "tags": [ "auth" ] }, "post": { "operationId": "systemLoginUrl", "parameters": [ { "name": "TARGET_SYSTEM", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostAuthRequestDto" } } } }, "responses": { "201": { "description": "Successful response", "content": { "text/html": { "schema": { "type": "string", "example": "https://login-url.com" } } } } }, "tags": [ "auth" ] } }, "/auth/accounts/{TARGET_SYSTEM}": { "post": { "operationId": "createEndUserAccount", "parameters": [ { "name": "TARGET_SYSTEM", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEndUserRequestDto" } } } }, "responses": { "201": { "description": "" } }, "tags": [ "auth" ] } }, "/auth/environments": { "get": { "operationId": "getEnvironments", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/EnvironmentResponseDto" } } } ] } } } } }, "tags": [ "auth" ] } }, "/auth/companies": { "get": { "operationId": "getCompanies", "parameters": [ { "name": "environmentName", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref" :"#/components/schemas/CompanyResponseDto" } } } } ] } } } } }, "tags": [ "auth" ] } }, "/accounting/journals": { "get": { "operationId": "getJournals", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [ 5, 10, 20, 50, 100 ], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/JournalResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/journalEntries/{journalEntryId}": { "get": { "operationId": "get JournalEntry", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "journalCode", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "version", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "journalEntryId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/JournalentryResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "put": { "operationId": "update JournalEntry", "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "environmentName", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "journalEntryId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "files": { "type": "array", "items": { "format": "binary" }, "description": "Array of files to upload" }, "filesPos": { "type": "array", "items": { "type": "number" }, "description": "Array of file positions" }, "journal_entry": { "$ref": "#/components/schemas/JournalentryRequestDto" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/JournalentryResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "patch": { "operationId": "patch JournalEntry", "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "environmentName", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "journalEntryId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "files": { "type": "array", "items": { "format": "binary" }, "description": "Array of files to upload" }, "filesPos": { "type": "array", "items": { "type": "number" }, "description": "Array of file positions" }, "journal_entry": { "$ref": "#/components/schemas/JournalentryRequestDto" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/JournalentryResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/journalEntries": { "get": { "operationId": "get JournalEntries", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [5, 10, 20, 50, 100], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "fiscalYearStartDate", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/JournalentryResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "create JournalEntry", "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "environmentName", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "idempotency-key", "description": "Unique key to ensure idempotent requests. If provided, duplicate requests with the same key will return the cached response instead of creating duplicate resources.", "in": "header", "schema": { "type": "string", "example": "order-12345-invoice-001" }, "required": false } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "files": { "type": "array", "items": { "format": "binary" }, "description": "Array of files to upload" }, "filesPos": { "type": "array", "items": { "type": "number" }, "description": "Array of file positions" }, "journal_entry": { "$ref": "#/components/schemas/JournalentryRequestDto" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/JournalentryResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/journalEntries/async": { "get": { "operationId": "getJournalEntriesAsync", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/TaskIdResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/journalEntries/bulk": { "post": { "operationId": "create JournalEntries", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "idempotency-key", "description": "Unique key to ensure idempotent requests. If provided, duplicate requests with the same key will return the cached response instead of creating duplicate resources.", "in": "header", "schema": { "type": "string", "example": "order-12345-invoice-001" }, "required": false } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateJournalEntriesByBatchMetaDataDto" }, "example": { "accountNumberLength": "4", "chartOfAccount": "SKR03", "entries": [ { "additionalInformation": "invoice reference-d1bfd2", "advancePayment": { "orderNumber": "Order-21900030", "type": "FINAL_INVOICE" }, "currency": "EUR", "debitCreditIndicator": "CREDIT", "deliveryDate": "2025-06-04T00:00:00Z", "description": "Bill-3486 for services", "documentId": "b5e624e5-fb9e-4836-a443-87a3820f5b48", "dueDate": "2025-06-05T00:00:00Z", "exchangeRate": "1,2045", "journalLineItems": [ { "accountNumber": "70001", "dimensions": [ { "name": "Material/Waren" } ], "discountAmount" : 12.12, "taxRate": { "code": "03" }, "totalGrossAmount": 1190 }, { "accountNumber": "4900", "dimensions": [ { "name": "Material/Waren" } ], "discountAmount" : 12.12, "taxRate": { "code": "03" }, "totalGrossAmount": -1190 } ], "number ": "21900030", "taxAssignmentDate": "2025-06-04T00:00:00Z", "transactionDate": "2025-06-01T00:00:00Z" } ], "fiscalYearStartDate": "2025-01-01" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/JournalEntriesByBatchMetaDataResponseDto" } } } ] }, "example": { "accountNumberLength": "4", "chartOfAccount": "SKR03", "createdDate": "2025-06-01T00:00:00Z", "entries": [ { "additionalInformation": "invoice reference-d1bfd2", "advancePayment": { "orderNumber": "Order-21900030", "type": "FINAL_INVOICE" }, "currency": "EUR", "createdDate": "2025-06-01T00:00:00Z", "debitCreditIndicator": "CREDIT", "deliveryDate": "2025-06-04T00:00:00Z", "description": "Bill-3486 for services", "documentId": "b5e624e5-fb9e-4836-a443-87a3820f5b48", "dueDate": "2025-06-05T00:00:00Z", "exchangeRate": "1,2045", "journalLineItems": [ { "accountNumber": "70001", "createdDate": "2025-06-01T00:00:00Z", "dimensions": [ { "name": "Material/Waren" } ], "discountAmount" : 12.12, "taxRate": { "code": "03" }, "totalGrossAmount": 1190 }, { "accountNumber": "4900", "currency": "EUR", "createdDate": "2025-06-01T00:00:00Z", "dimensions": [ { "name": "Material/Waren" } ], "discountAmount" : 12.12, "taxRate": { "code": "03" }, "totalGrossAmount": -1190, "updatedDate": "2025-06-01T00:00:00Z" } ], "number ": "21900030", "taxAssignmentDate": "2025-06-04T00:00:00Z", "transactionDate": "2025-06-01T00:00:00Z" } ], "fiscalYearStartDate": "2025-01-01", "taskId": "ABBDU8834993NND" } } } } }, "tags": [ "accounting" ] } }, "/accounting/journalEntries/{journalEntryId}/Attachments": { "get": { "operationId": "get JournalEntry Attachments", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "journalEntryId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "create JournalEntry Attachment", "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "environmentName", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "journalEntryId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreateAttachmentRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/journalEntries/{journalEntryId}/Attachments/{attachmentId}": { "get": { "operationId": "get JournalEntry Attachment", "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "environmentName", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "journalEntryId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "attachmentId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "example": "file content" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/accounts/{accountId}": { "get": { "operationId": "getAccount", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "accountId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/AccountResponseDto", "example": { "id": "5570042", "balance": 100, "class": "ASSET", "code": "91", "createdDate": "2025-05-01T00:00:00Z", "currency": "EUR", "debitCreditIndicator": "DEBIT", "description": "Business Savings Account", "name": "Business Bank", "number": "0150", "parentAccountId": "46", "status": "ACTIVE", "taxRate": { "id": "1895b05b-38a6-4a6a-9653-166389894350", "code": "03", "name": "TAX19", "percentage": 19 }, "type": "BANK", "updatedDate": "2021-06-01T00:00:00Z" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/accounts": { "get": { "operationId": "getAccounts", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [5, 10, 20, 50, 100], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "fiscalYearStartDate", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "types", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "isActive", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AccountResponseDto" }, "example": [ { "id": "5570042", "balance": 100, "class": "ASSET", "code": "91", "createdDate": "2025-05-01T00:00:00Z", "currency": "EUR", "debitCreditIndicator": "DEBIT", "description": "Business Savings Account", "name": "Business Bank", "number": "0150", "parentAccountId": "46", "status": "ACTIVE", "taxRate": { "id": "15534na-38a6-4a6a-3353-1663553394350", "code": "04", "name": "TAX21", "percentage": 21 }, "type": "BANK", "updatedDate": "2021-06-01T00:00:00Z" }, { "id": "5942390", "balance": 5000, "class": "REVENUE", "code": "92", "createdDate": "2021-05-01T00:00:00Z", "currency": "EUR", "debitCreditIndicator": "CREDIT", "description": "Income from business activity", "name": "Revenue account", "number": "1820", "parentAccountId": "47", "status": "ACTIVE", "taxRate": { "id": "1895b05b-38a6-4a6a-9653-166389894350", "code": "03", "name": "TAX19", "percentage": 19 }, "type": "REVENUE", "updatedDate": "2021-06-01T00:00:00Z" } ] } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "createAccount", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/AccountResponseDto", "example": { "id": "5570042", "balance": 100, "class": "ASSET", "code": "91", "createdDate": "2025-05-01T00:00:00Z", "currency": "EUR", "debitCreditIndicator": "DEBIT", "description": "Business Savings Account", "name": "Business Bank", "number": "0150", "parentAccountId": "46", "status": "ACTIVE", "taxRate": { "id": "1895b05b-38a6-4a6a-9653-166389894350", "code": "03", "name": "TAX19", "percentage": 19 }, "type": "BANK", "updatedDate": "2021-06-01T00:00:00Z" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/bankAccounts/{bankAccountId}": { "get": { "operationId": "getBankAccount", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "bankAccountId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/BankAccountResponseDto", "example": { "id": "5570042", "balance": 100, "bankName": "F. van Lanschot Bankiers", "bic": "SNSBNL2A", "createdDate": "2025-01-01T00:00:00Z", "currency": "EUR", "description": "Business Savings Account", "fileType": "CSV", "iban": "NL46INGB3591831883", "name": "Business Bank", "number": "0150", "system": "Internal", "status": "ACTIVE", "type": "GIRO", "updatedDate": "2025-02-01T00:00:00Z" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/bankAccounts": { "get": { "operationId": "getBankAccounts", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [5, 10, 20, 50, 100], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BankAccountResponseDto" }, "example": [{ "id": "5570042", "balance": 100, "bankName": "F. van Lanschot Bankiers", "bic": "SNSBNL2A", "createdDate": "2025-01-01T00:00:00Z", "currency": "EUR", "description": "Business Savings Account", "fileType": "CSV", "iban": "NL46INGB3591831883", "name": "Business Bank", "number": "0150", "system": "Internal", "status": "ACTIVE", "type": "GIRO", "updatedDate": "2025-02-01T00:00:00Z" }] } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "createBankAccount", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBankAccountRequestDto", "example": { "balance": 100, "bankName": "F. van Lanschot Bankiers", "bic": "SNSBNL2A", "currency": "EUR", "description": "Business Savings Account", "fileType": "CSV", "iban": "NL46INGB3591831883", "name": "Business Bank", "number": "0150", "system": "Internal", "status": "ACTIVE", "type": "GIRO" } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/BankAccountResponseDto", "example": { "id": "5570042", "balance": 100, "bankName": "F. van Lanschot Bankiers", "bic": "SNSBNL2A", "createdDate": "2025-01-01T00:00:00Z", "currency": "EUR", "description": "Business Savings Account", "fileType": "CSV", "iban": "NL46INGB3591831883", "name": "Business Bank", "number": "0150", "system": "Internal", "status": "ACTIVE", "type": "GIRO", "updatedDate": "2025-02-01T00:00:00Z" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/dimensions": { "get": { "operationId": "getDimensions", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DimensionMetaResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/dimensions/{dimension}": { "get": { "operationId": "getDimensionsByDimension", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [5, 10, 20, 50, 100], "type": "number" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DimensionResponseDtoV2" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/expenses": { "get": { "operationId": "getExpenses", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [5, 10, 20, 50, 100], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "createExpense", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "files": { "type": "array", "items": { "format": "binary" }, "description": "Array of files to upload" }, "expense": { "$ref": "#/components/schemas/ExpenseRequestDto" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/ExpenseResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/expenses/{expenseId}": { "get": { "operationId": "getExpenses", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "expenseId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/expenses/async": { "post": { "operationId": "createExpenseAsync", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "files": { "type": "array", "items": { "format": "binary" }, "description": "Array of files to upload" }, "expense": { "$ref": "#/components/schemas/ExpenseRequestAsyncDto" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/TaskIdResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/transactions": { "post": { "operationId": "createTransaction", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "journalCode", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "files": { "type": "array", "items": { "format": "binary" }, "description": "Array of files to upload" }, "transaction": { "$ref": "#/components/schemas/CreateTransactionRequestDto" } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/TransactionResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/customers": { "get": { "operationId": "getCustomers", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [ 5, 10, 20, 50, 100 ], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "email", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "name", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "number", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "createCustomer", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateContactRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/ContactResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/customers/{contactId}": { "get": { "operationId": "getCustomer", "parameters": [ { "name": "contactId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/ContactResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] }, "put": { "operationId": "updateCustomer", "parameters": [ { "name": "contactId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateContactRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/ContactResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] }, "patch": { "operationId": "patchCustomers", "parameters": [ { "name": "contactId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateContactRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/ContactResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/suppliers": { "get": { "operationId": "getSuppliers", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [ 5, 10, 20, 50, 100 ], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "email", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "name", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "number", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "createSupplier", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateContactRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/ContactResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/suppliers/{contactId}": { "get": { "operationId": "getSupplier", "parameters": [ { "name": "contactId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/ContactResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] }, "put": { "operationId": "updateSupplier", "parameters": [ { "name": "contactId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateContactRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/ContactResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] }, "patch": { "operationId": "patchSupplier", "parameters": [ { "name": "contactId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateContactRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/ContactResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/contacts": { "get": { "operationId": "getContacts", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [ 5, 10, 20, 50, 100 ], "type": "number" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "required": true, "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "required": true, "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactResponseDtoV2" } } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "createContact", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactRequestDtoV2" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/ContactResponseDtoV2" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/contacts/{contactId}": { "get": { "operationId": "getContact", "parameters": [ { "name": "contactId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/ContactResponseDtoV2" } } } ] } } } } }, "tags": [ "accounting" ] }, "put": { "operationId": "putContact", "parameters": [ { "name": "contactId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "required": true, "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "required": true, "in": "header", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactRequestDtoV2" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/ContactResponseDtoV2" } } } ] } } } } }, "tags": [ "accounting" ] }, "patch": { "operationId": "patchContact", "parameters": [ { "name": "contactId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "required": true, "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "required": true, "in": "header", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactRequestDtoV2" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/ContactResponseDtoV2" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/contacts/async": { "get": { "operationId": "getContactsAsync", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "required": true, "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "required": true, "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/TaskIdResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/invoices": { "get": { "operationId": "getInvoices", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [ 5, 10, 20, 50, 100 ], "type": "number" } }, { "name": "orderDir", "required": false, "in": "query", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "name": "orderField", "required": false, "in": "query", "schema": { "enum": [ "invoiceDate", "invoiceNumber", "createdDate", "updatedDate" ], "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "paymentStatus", "description": "Filter by best-effort payment status. Rows where `paymentStatus` is `null` (most source systems do not populate it) are excluded from results — filter on `status` instead for reliable lifecycle filtering. See [Document status fields](/standardization#document-status-fields).", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "status", "description": "Filter by document lifecycle status, e.g. `status=OPEN`. See [Document status fields](/standardization#document-status-fields).", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "dueDateFrom", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "createInvoice", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/InvoiceResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/invoices/{invoiceId}": { "get": { "operationId": "getInvoice", "parameters": [ { "name": "invoiceId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/InvoiceResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] }, "patch": { "operationId": "patchInvoice", "parameters": [ { "name": "invoiceId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchInvoiceRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/InvoiceResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/batch/invoices": { "post": { "operationId": "createInvoices", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" } }, { "name": "companyId", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "jobId", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "fiscalYear", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "postingMonth", "required": true, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateInvoiceRequestDto" } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/InvoiceResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/bills": { "get": { "operationId": "getBills", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [ 5, 10, 20, 50, 100 ], "type": "number" } }, { "name": "orderDir", "required": false, "in": "query", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "name": "orderField", "required": false, "in": "query", "schema": { "enum": [ "billlDate", "billNumber", "createdDate", "updatedDate" ], "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "billDateFrom", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "status", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BillResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "createBill", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBillRequestDto" }, "example": { "accountId": "6733a433-9662-4a40-8e36-e38ebda94fe1", "addresses": [ { "addressLine1": "Main street 45", "addressLine2": "2nd floor", "city": "Berlin", "countryCode": "DE", "postalCode": "10243", "type": "BILLING" } ], "billDate": "2021-01-01T00:00:00Z", "billNumber": "1020", "contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc", "currency": "EUR", "deliveryDate": "2021-01-01T00:00:00Z", "dueDate": "2021-07-01T00:00:00Z", "fileId": "93c6b8e0-80a4-4c22-a46c-18beebab82d6", "journalCode": "30", "lineItems": [ { "accountId": "6733a433-9662-4a40-8e36-e38ebda94fe1", "accountNumber": "200", "deferredEndDate": "2021-06-01T00:00:00Z", "deferredStartDate": "2021-01-01T00:00:00Z", "description": "SEOUL Guest Chair, red", "dimensions": [ { "name": "C1", "categoryName": "CostCenter" } ], "itemId": "4f3a2hf4-5b8e-4d1b-8a0c-9f6e7d2f3e4b", "itemName": "RED CHAIR", "quantity": 1, "taxCode": "03", "taxRatePercentage": 19, "totalDiscountAmount": 10, "totalDiscountPercentage": 10, "totalGrossAmount": 109, "totalNetAmount": 100, "totalTaxAmount": 19, "unitAmount": 100, "unitDiscountAmount": 10, "unitDiscountPercentage": 10, "unitName": "PIECE" } ], "name": "Office Supplies", "oneLineAddress": "Main street 45, Berlin", "paidDate": "2021-01-25T00:00:00Z", "paymentDays": 30, "paymentReference": "Edefad142e764894", "paymentStatus": "PENDING", "paymentTermCode": "21", "reference": "026 / 245", "shippingDate": "2021-01-01T00:00:00Z", "shippingType": "DELIVERY", "status": "DRAFT", "taxRule": "NET", "taxText": "Tax 19 percent", "totalDiscountAmount": 10, "totalDiscountPercentage": 10, "totalGrossAmount": 109, "totalNetAmount": 100, "totalTaxAmount": 19 } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/BillResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/bills/{billId}": { "get": { "operationId": "getBill", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "billId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BillResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "put": { "operationId": "updateBill", "parameters": [ { "name": "billId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBillRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/BillResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] }, "delete": { "operationId": "deleteBill", "parameters": [ { "name": "billId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "accounting" ] } }, "/accounting/bills/{billId}/document": { "get": { "operationId": "getBillDocument", "parameters": [ { "name": "billId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/DocumentResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/bills/{billId}/lineItems": { "get": { "operationId": "getBillLineItems", "parameters": [ { "name": "billId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BillLineItem" } } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "createBillLine", "parameters": [ { "name": "billId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBillLineItem" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/BillLineItem" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/bills/{billId}/lineItems/{lineItemId}": { "put": { "operationId": "createBillLine", "parameters": [ { "name": "billId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "lineItemId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBillLineItem" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/BillLineItem" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/vendorCredits": { "get": { "operationId": "getVendorCredits", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [ 5, 10, 20, 50, 100 ], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/VendorCreditResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "createVendorCredit", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVendorCreditRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/VendorCreditResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/vendorCredits/{vendorCreditId}": { "put": { "operationId": "updateVendorCredit", "parameters": [ { "name": "vendorCreditId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVendorCreditRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/VendorCreditResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] }, "delete": { "operationId": "deleteVendorCredit", "parameters": [ { "name": "vendorCreditId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "accounting" ] } }, "/accounting/batch/permissions/check-client-permissions": { "get": { "operationId": "checkClientPermissions", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" } }, { "name": "companyId", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "fiscalYear", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "postingMonth", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "documentType", "required": true, "in": "query", "schema": { "enum": [ "BILL", "INVOICE" ], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/CheckClientPermissionsResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/batch/status/data-transfer-status": { "get": { "operationId": "getDataTransferStatus", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" } }, { "name": "companyId", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "jobId", "required": true, "in": "query", "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/DataTransferStatusResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/batch/status/data-transfer-protocol-entries": { "get": { "operationId": "getDataTransferProtocolEntries", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" } }, { "name": "companyId", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "jobId", "required": true, "in": "query", "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/DataTransfersProcotolEntriesResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/invoices/{invoiceId}/document": { "get": { "operationId": "getInvoiceDocument", "parameters": [ { "name": "invoiceId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/DocumentResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/files": { "post": { "operationId": "uploadFile", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreateFileRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/DocumentResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/files/async": { "post": { "operationId": "uploadFileAsync", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "documentDate": { "type": "string", "example": "2025-03-26T08:25:54.060Z" }, "documentId": { "type": "string", "example": "b5e624e5-fb9e-4836-a443-87a3820f5b48" }, "documentType": { "type": "string", "example": "Rechnungsausgang" }, "integrationSource": { "type": "string", "example": "3rd party app" }, "note": { "type": "string", "example": "note for the document" }, "folderName": { "type": "string", "example": "Invoice" } }, "required": [ "file", "documentType" ] } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/TaskIdResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/files/documentTypes": { "get": { "operationId": "getDocumentTypes", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentTypesResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/files/documentExtensions": { "get": { "operationId": "getDocumentExtensions", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/DocumentExtensionsResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/invoices/{invoiceId}/lineItems": { "get": { "operationId": "getLineItems", "parameters": [ { "name": "invoiceId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [5, 10, 20, 50, 100], "type": "number" } }, { "name": "companyId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "environmentName", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLineItemResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "createLineItem", "parameters": [ { "name": "invoiceId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "environmentName", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceLineItemRequestDto" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/InvoiceLineItemResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/invoices/{invoiceId}/lineItems/{lineItemId}": { "get": { "operationId": "getLineItem", "parameters": [ { "name": "invoiceId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "lineItemId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "environmentName", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/InvoiceLineItemResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] }, "patch": { "operationId": "patchLineItem", "parameters": [ { "name": "invoiceId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "lineItemId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "environmentName", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceLineItemRequestDto" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/InvoiceLineItemResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/items": { "get": { "operationId": "getItems", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [ 5, 10, 20, 50, 100 ], "type": "number" } }, { "name": "companyId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "environmentName", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "itemNumber", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "type", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ItemResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "createItem", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "environmentName", "in": "query", "schema": { "type": "string" }, "required": false } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateItemRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/ItemResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/items/{itemId}": { "get": { "operationId": "getItem", "parameters": [ { "name": "itemId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "environmentName", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ItemResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "patch": { "operationId": "patchItem", "parameters": [ { "name": "itemId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "environmentName", "in": "query", "schema": { "type": "string" }, "required": false } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateItemRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/ItemResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] }, "put": { "operationId": "updateItem", "parameters": [ { "name": "itemId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "environmentName", "in": "query", "schema": { "type": "string" }, "required": false } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateItemRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/ItemResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] }, "delete": { "operationId": "deleteItem", "parameters": [ { "name": "itemId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "environmentName", "in": "query", "schema": { "type": "string" }, "required": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" } } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/offers": { "get": { "operationId": "getOffers", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [ 5, 10, 20, 50, 100 ], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "status", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OfferResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "createOffer", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOfferRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/OfferResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/offers/{offerId}": { "get": { "operationId": "getOffer", "parameters": [ { "name": "offerId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/OfferResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/offers/{offerId}/lineItems": { "get": { "operationId": "getOfferLineItems", "parameters": [ { "name": "offerId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [5, 10, 20, 50, 100], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OfferLineItemResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/offers/{offerId}/lineItems/{lineItemId}": { "get": { "operationId": "getOfferLineItem", "parameters": [ { "name": "offerId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "lineItemId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/OfferLineItemResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/offers/{offerId}/document": { "get": { "operationId": "getOfferDocument", "parameters": [ { "name": "offerId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/DocumentResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/projects": { "get": { "operationId": "getProjects", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [5, 10, 20, 50, 100], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "createProject", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/ProjectResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/projects/{projectId}": { "get": { "operationId": "getProject", "parameters": [ { "name": "projectId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/ProjectResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/projects/async": { "get": { "operationId": "getProjectsAsync", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "required": true, "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "required": true, "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/TaskIdResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/purchaseOrders": { "get": { "operationId": "purchaseOrders", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [5, 10, 20, 50, 100], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/purchaseOrders/{purchaseOrderId}": { "get": { "operationId": "getPurchaseOrder", "parameters": [ { "name": "purchaseOrderId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/PurchaseOrderResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/purchaseOrders/{purchaseOrderId}/lineItems": { "get": { "operationId": "getPurchaseOrderLineItems", "parameters": [ { "name": "purchaseOrderId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderLineItemResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/purchaseOrders/{purchaseOrderId}/lineItems/{lineItemId}": { "get": { "operationId": "getPurchaseOrderLineItem", "parameters": [ { "name": "purchaseOrderId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "lineItemId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "environmentName", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/PurchaseOrderLineItemResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/goodsReceipts": { "get": { "operationId": "getGoodsReceipts", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [5, 10, 20, 50, 100], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GoodsReceiptResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/goodsReceipts/{goodsReceiptId}": { "get": { "operationId": "getGoodsReceipt", "parameters": [ { "name": "goodsReceiptId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/GoodsReceiptResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/goodsReceipts/{goodsReceiptId}/lineItems": { "get": { "operationId": "getGoodsReceiptLineItems", "parameters": [ { "name": "goodsReceiptId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GoodsReceiptLineItemResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/goodsReceipts/{goodsReceiptId}/lineItems/{lineItemId}": { "get": { "operationId": "getGoodsReceiptLineItem", "parameters": [ { "name": "goodsReceiptId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "lineItemId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "environmentName", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/GoodsReceiptLineItemResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/salesOrders": { "get": { "operationId": "getsalesOrders", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [5, 10, 20, 50, 100], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "status", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "createSalesOrder", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSalesOrderRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/SalesOrderResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/salesOrders/{salesOrderId}": { "get": { "operationId": "getSalesOrder", "parameters": [ { "name": "salesOrderId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/SalesOrderResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/salesOrders/{salesOrderId}/lineItems": { "get": { "operationId": "getSalesOrder", "parameters": [ { "name": "salesOrderId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderLineItemResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/creditNotes": { "get": { "operationId": "getCreditNotes", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [5, 10, 20, 50, 100], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNoteResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "createCreditNote", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCreditNoteRequestDto" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/CreditNoteResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/creditNotes/{creditNoteId}": { "get": { "operationId": "getCreditNote", "parameters": [ { "name": "creditNoteId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/CreditNoteResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/creditNotes/{creditNoteId}/documents": { "get": { "operationId": "getCreditNoteDocuments", "parameters": [ { "name": "creditNoteId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/paymentTerms/{paymentTermId}": { "get": { "operationId": "getPaymentTerm", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "paymentTermId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/PaymentTermResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/paymentTerms": { "get": { "operationId": "getPaymentTerms", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [5, 10, 20, 50, 100], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "fiscalYearStartDate", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentTermResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "createPaymentTerm", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentTermRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/PaymentTermResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/taxRates/{taxRateId}": { "get": { "operationId": "getTaxRate", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "taxRateId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/TaxRateResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/taxRates": { "get": { "operationId": "getTaxRates", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [5, 10, 20, 50, 100], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "isActive", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRateResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/payments": { "get": { "operationId": "getPayments", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [5, 10, 20, 50, 100], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "createPayment", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/PaymentResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/payments/{paymentId}": { "get": { "operationId": "getPayment", "parameters": [ { "name": "paymentId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/PaymentResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] }, "delete": { "operationId": "deletePayment", "parameters": [ { "name": "paymentId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "accounting" ] } }, "/accounting/asyncTask/{taskId}": { "get": { "operationId": "getAsyncTaskInfo", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "taskId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/AsyncTaskResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/bookingProposals": { "get": { "operationId": "getBookingProposals", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [ 5, 10, 20, 50, 100 ], "type": "number" } }, { "name": "orderDir", "required": false, "in": "query", "schema": { "enum": [ "ASC", "DESC" ], "type": "string" } }, { "name": "orderField", "required": false, "in": "query", "schema": { "enum": [ "bookingProposalDate", "number", "createdDate", "updatedDate" ], "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "bookingType", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "status", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BookingProposalResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] }, "post": { "operationId": "create BookingProposal", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "idempotency-key", "description": "Unique key to ensure idempotent requests. If provided, duplicate requests with the same key will return the cached response instead of creating duplicate resources.", "in": "header", "schema": { "type": "string", "example": "order-12345-invoice-001" }, "required": false } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "bookingProposal": { "$ref": "#/components/schemas/CreateBookingProposalRequestDto" }, "bookingType": { "type": "string", "enum": [ "INVOICE", "BILL", "INVOICE_CREDIT_NOTE" ] }, "files": { "type": "array", "items": { "format": "binary" }, "description": "Array of files to upload" }, "folderManagement": { "$ref": "#/components/schemas/FolderManagementDto" } } }, "example": { "bookingProposal": { "addresses": [ { "city": "city" } ], "bankAccountId": "5a6b7f5dw45c1c-403e-ad56-202fbc312414", "bankAccountNumber": 5407324931, "bankCode": "50010517", "bic": "DEUTDEFF", "bookingProposalDate": "2025-07-14T00:00:00Z", "contactAccountNumber": 70000, "contactId": "eaa28f49-6028-4b6e-bb12-d8f6278073fc", "contactName": "John Doe", "currency": "EUR", "deliveryDate": "2025-07-26T00:00:00Z", "discountPaymentDate": "2025-07-16T00:00:00Z", "discountPaymentDate2": "2025-07-18T00:00:00Z", "dueDate": "2025-07-24T00:00:00Z", "journalCode": "60", "iban": "DE43100500000920018963", "isPaymentOrder": true, "ledgerName": "Payroll", "lineItems": [ { "accountCode": "200", "accountId": "db32-4f56-8a9b-1234567890ab", "accountName": "EXPENSE", "accountNumber": 4900, "bookingTaxCode": "9", "description": "Item A", "dimension1": "Marketing", "dimension2": "Service and Maintenance", "dimensions": [ { "id": "eaa28f49-6028-4b6e-bb12-d8f6278073fc", "code": "CS1", "dimension": "CostCenter", "name": "Jerde, Greenfelder and Jacobi" } ], "discountAmount": 100, "discountAmount2": 50, "discountPercentage": 20, "discountPercentage2": 10, "taxCode": "02", "taxRatePercentage": 19, "totalGrossAmount": 500, "totalNetAmount": 450, "type": "SERVICES" } ], "notes": "Bill for maintenance services", "number": "1233330", "orderId": "3344566", "paidDate": "2021-01-01T00:00:00Z", "paymentTermsId": "03", "status": "DRAFT", "totalGrossAmount": 500, "vatId": "DE987654321" }, "bookingType": "INVOICE", "folderManagement": { "category": "Accounting", "folder": "Invoices", "register": "2025 January" } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/BookingProposalResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/bookingProposals/async": { "post": { "operationId": "createBookingProposalAsync", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "idempotency-key", "description": "Unique key to ensure idempotent requests. If provided, duplicate requests with the same key will return the cached response instead of creating duplicate resources.", "in": "header", "schema": { "type": "string", "example": "order-12345-invoice-001" }, "required": false }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "bookingProposal": { "$ref": "#/components/schemas/BookingProposalRequestAsyncDto" }, "bookingType": { "type": "string", "enum": [ "BILL", "CREDIT_NOTE", "INVOICE", "VENDOR_CREDIT" ] }, "files": { "type": "array", "items": { "format": "binary" }, "description": "Array of files to upload" }, "folderManagement": { "$ref": "#/components/schemas/FolderManagementDto" } } } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/TaskIdResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/bookingProposals/{bookingProposalId}": { "get": { "operationId": "getBookingProposal", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "bookingProposalId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BookingProposalResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/bookingProposals/{bookingProposalId}/document": { "get": { "operationId": "getBookingProposalDocument", "parameters": [ { "name": "bookingProposalId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/DocumentResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/bookings": { "post": { "operationId": "create Bookings", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookingsRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/BookingsResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/contacts/bulk": { "post": { "operationId": "create Contacts", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string", "example": "example value" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateContactByBatchMetaDataDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/ContactByBatchMetaDataResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/units": { "get": { "operationId": "getUnits", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [5, 10, 20, 50, 100], "type": "number" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UnitResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/openItems": { "get": { "operationId": "getOpenItems", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [ 5, 10, 20, 50, 100 ], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "fiscalYear", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "accountNumber", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "documentNumber", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "type", "required": false, "in": "query", "schema": { "type": "string", "enum": [ "BILL", "INVOICE" ] } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OpenItemResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/openItems/async": { "get": { "operationId": "getOpenItems", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [ 5, 10, 20, 50, 100 ], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaskIdResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/trialBalance": { "get": { "operationId": "getTrialBalance", "parameters": [ { "name": "page", "required": false, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "schema": { "enum": [ 5, 10, 20, 50, 100 ], "type": "number" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "fiscalYearStartDate", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "accountCode", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "accountNumber", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TrialBalanceResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/fiscalYears": { "get": { "operationId": "getFiscalYears", "parameters": [ { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedAt", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FiscalYearResponseDto" } } } } ] } } } } }, "tags": [ "accounting" ] } }, "/accounting/fiscalYears/{fiscalYearId}": { "get": { "operationId": "getFiscalYear", "parameters": [ { "name": "fiscalYearId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "object", "$ref": "#/components/schemas/FiscalYearResponseDto" } } } ] } } } } }, "tags": [ "accounting" ] } }, "/user/user-info": { "get": { "operationId": "getUserInfo", "parameters": [ { "name": "X-API-KEY", "description": "API key", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "in": "header", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserInfoDto" } } } } ] } } } } }, "tags": [ "user" ] } }, "/webhooks": { "get": { "operationId": "getWebhooks", "parameters": [ { "name": "X-API-KEY", "description": "API key", "required": true, "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "required": true, "in": "header", "schema": { "type": "string" } }, { "name": "rawData", "required": false, "in": "query", "schema": { "type": "boolean" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/WebhookResponseDto" } } } ] } } } } }, "tags": [ "webhook" ] }, "post": { "operationId": "createWebhook", "parameters": [ { "name": "X-API-KEY", "description": "API key", "required": true, "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "required": true, "in": "header", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseDto" }, { "properties": { "data": { "$ref": "#/components/schemas/WebhookResponseDtoWithSecret" } } } ] } } } } }, "tags": [ "webhook" ] } }, "/webhooks/{webhookId}": { "delete": { "operationId": "deleteWebhook", "parameters": [ { "name": "X-API-KEY", "description": "API key", "required": true, "in": "header", "schema": { "type": "string" } }, { "name": "X-ACCOUNT-KEY", "description": "Account key", "required": true, "in": "header", "schema": { "type": "string" } }, { "name": "webhookId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "companyId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "environmentName", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Webhook deleted" } }, "tags": [ "webhook" ] } } }, "info": { "title": "Maesn unified API", "description": "The Maesn unified API description", "version": "1.0", "contact": {} }, "tags": [ { "name": "maesn", "description": "" } ], "servers": [ { "url": "https://api.maesn.dev" } ], "components": { "schemas": { "PaginationResponse": { "type": "object", "properties": { "total": { "type": "number", "example": 125 }, "perPage": { "type": "number", "example": 50 }, "currentPage": { "type": "number", "example": 1 }, "totalPages": { "type": "number", "example": 3 } } }, "MetaResponse": { "type": "object", "properties": { "warnings": { "type": "array", "items": { "type": "string", "example": "Field not used by target system" } }, "pagination": { "$ref": "#/components/schemas/PaginationResponse" } } }, "BaseResponseDto": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/MetaResponse" }, "data": { "oneOf": [ { "type": "object" }, { "type": "array" } ] } } }, "SystemRegistrationDto": { "type": "object", "properties": { "targetSystem": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" } }, "required": [ "targetSystem", "clientId", "clientSecret" ] }, "CallbackUrlRegistrationDto": { "type": "object", "properties": { "callbackUrl": { "type": "string", "example": "https://callback-url.com" }, "cancelCallbackUrl": { "type": "string", "example": "https://cancel.callback-url.com" } } }, "LoginDto": { "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" } }, "required": [ "email", "password" ] }, "AuthEntity": { "type": "object", "properties": { "accessToken": { "type": "string" }, "refreshToken": { "type": "string" } }, "required": [ "accessToken", "refreshToken" ] }, "DocumentResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "document id" }, "base64Encoded": { "type": "boolean", "example": true }, "content": { "type": "string", "example": "content" }, "contentType": { "type": "string", "example": "application/pdf" }, "fileName": { "type": "string", "example": "invoice.pdf" } } }, "DocumentTypesResponseDto": { "type": "object", "properties": { "name": { "type": "string", "example": "Rechnungseingang" }, "category": { "type": "string", "example": "invoices_received" } }, "required": [ "name", "category" ] }, "DocumentExtensionsResponseDto": { "type": "object", "properties": { "allowed_file_extensions": { "type": "array", "example": "['pdf', 'jpg']" } }, "required": [ "allowed_file_extensions" ] }, "ItemResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "02c74e8a-b95b-ef11-bfe2-002248e5aac5" }, "assetAccountId": { "type": "string", "example": "80" }, "expenseAccountId": { "type": "string", "example": "81" }, "incomeAccountId": { "type": "string", "example": "79" }, "inventoryStartDate": { "type": "string", "example": "2021-01-01" }, "itemNumber": { "type": "string", "example": "12345-A" }, "lastModifiedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "name": { "type": "string", "example": "Handmade Plastic Chair" }, "priceIncludesTax": { "type": "boolean", "example": true }, "stockCount": { "type": "number", "example": 11 }, "taxCode": { "type": "string", "example": "TAX19" }, "taxRatePercentage": { "type": "number", "example": 19 }, "type": { "type": "string", "enum": [ "PRODUCT", "SERVICE" ], "example": "PRODUCT" }, "unitName": { "anyOf": [ { "type": "string", "enum": [ "PIECE", "STÜCK", "NOT_UNIT", "CUBIC_METRE", "DAY", "GRAM", "HOUR", "KILOGRAM", "KILOMETRE", "LITRE", "METRE", "MILLIGRAM", "MILLILITRE", "MONTH", "NIGHT", "PACK", "PERCENTAGE", "SQUARE_METRE", "TONNE", "UNIT" ] }, { "type": "string" } ], "example": "PIECE" }, "unitPurchasePrice": { "type": "number", "example": 10 }, "unitSalesPrice": { "type": "number", "example": 20.5 } } }, "CreateItemRequestDto": { "type": "object", "properties": { "assetAccountId": { "type": "string", "example": "80" }, "expenseAccountId": { "type": "string", "example": "81" }, "incomeAccountId": { "type": "string", "example": "79" }, "inventoryStartDate": { "type": "string", "example": "2021-01-01" }, "itemNumber": { "type": "string", "example": "12345-A" }, "name": { "type": "string", "example": "Handmade Plastic Chair" }, "priceIncludesTax": { "type": "boolean", "example": true }, "stockCount": { "type": "number", "example": 11 }, "taxCode": { "type": "string", "example": "TAX19" }, "taxRatePercentage": { "type": "number", "example": 19 }, "type": { "type": "string", "enum": [ "PRODUCT", "SERVICE" ], "example": "PRODUCT" }, "unitName": { "anyOf": [ { "type": "string", "enum": [ "PIECE", "STÜCK", "NOT_UNIT", "CUBIC_METRE", "DAY", "GRAM", "HOUR", "KILOGRAM", "KILOMETRE", "LITRE", "METRE", "MILLIGRAM", "MILLILITRE", "MONTH", "NIGHT", "PACK", "PERCENTAGE", "SQUARE_METRE", "TONNE", "UNIT" ], "example": "PIECE" }, { "type": "string" } ] }, "unitPurchasePrice": { "type": "number", "example": 10 }, "unitSalesPrice": { "type": "number", "example": 20.5 } } }, "PaymentLine": { "type": "object", "properties": { "accountId": { "type": "string", "example": "4a6b5e92-a261-4be9-814d-84dec9636c16" }, "amount": { "description": "Amount of the payment line, in the document currency.", "type": "number", "example": 100 }, "contactName": { "type": "string", "example": "John Doe" }, "contactId": { "type": "string", "example": "6532708-12e3-4ff5-bf39-02698e959963" }, "customerId": { "type": "string", "example": "6532708-12e3-4ff5-bf39-02698e959963" }, "description": { "type": "string", "example": "payment of bill" }, "invoiceId": { "type": "string", "example": "a44f5af1-8310-4f97-b945-26e35288b35f" }, "paymentDate": { "type": "string", "example": "2025-01-01" }, "supplierId": { "type": "string", "example": "6532708-12e3-4ff5-bf39-02698e959963" } } }, "PaymentResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "94a5ab44-3218-4492-8b5d-a31bc0288c0b" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "description": { "type": "string", "example": "Payment of bill" }, "documentType": { "type": "string", "enum": [ "INVOICE", "BILL", "BOOKING_PROPOSAL", "INVOICE_BOOKING_PROPOSAL", "BILL_BOOKING_PROPOSAL" ], "example": "BILL_BOOKING_PROPOSAL" }, "exchangeRate": { "type": "number", "example": 1.0 }, "fiscalYear": { "type": "string", "example": "2025" }, "journalCode": { "type": "string", "example": "30" }, "journalId": { "type": "string", "example": "8df2df10-0fae-40ad-9d22-f25e5ab0ba23" }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "paymentDate": { "type": "string", "example": "2025-01-01" }, "paymentLines": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentLine" } }, "paymentType": { "type": "string", "example": "CREDITOR" } } }, "PaymentRequestDto": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "description": { "type": "string", "example": "Payment of bill" }, "documentType": { "type": "string", "enum": [ "INVOICE", "BILL", "BOOKING_PROPOSAL", "INVOICE_BOOKING_PROPOSAL", "BILL_BOOKING_PROPOSAL" ], "example": "BILL_BOOKING_PROPOSAL" }, "exchangeRate": { "type": "number", "example": 1.0 }, "fiscalYear": { "type": "string", "example": "2025" }, "journalCode": { "type": "string", "example": "30" }, "journalId": { "type": "string", "example": "8df2df10-0fae-40ad-9d22-f25e5ab0ba23" }, "paymentDate": { "type": "string", "example": "2025-01-01" }, "paymentLines": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentLine" } }, "paymentType": { "type": "string", "example": "CREDITOR" } } }, "CreateAccountRequestDto": { "type": "object", "properties": { "balance": { "type": "number", "example": 100 }, "class": { "type": "string", "enum": [ "ASSET", "EQUITY", "EXPENSE", "LIABILITY", "REVENUE" ], "example": "ASSET" }, "code": { "type": "string", "example": "91" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "debitCreditIndicator": { "type": "string", "enum": [ "DEBIT", "CREDIT" ], "example": "DEBIT" }, "description": { "type": "string", "example": "Business Savings Account" }, "journalCode": { "type": "string", "example": "30" }, "name": { "type": "string", "example": "Business Bank" }, "number": { "type": "string", "example": "0150" }, "parentAccountId": { "type": "string", "example": "46" }, "status": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED" ], "example": "ACTIVE" }, "taxRate": { "$ref": "#/components/schemas/taxRateCommonDto" }, "type": { "type": "string", "enum": [ "PAYMENT_PROVIDER", "BANK", "CURRENT", "CURRLIAB", "DEPRECIATN", "DIRECTCOSTS", "EQUITY", "EXPENSE", "FIXED", "INVENTORY", "LIABILITY", "NONCURRENT", "OTHERINCOME", "OVERHEADS", "PREPAYMENT", "REVENUE", "SALES", "TERMLIAB" ], "example": "BANK" } } }, "DimensionMetaResponseDto": { "type": "object", "properties": { "description": { "type": "string", "example": "Cost center" }, "dimension": { "type": "string", "example": "CostCenter" } } }, "DimensionResponseDtoV2": { "type": "object", "properties": { "id": { "type": "string", "example": "08c99551-49ae-4418-9e76-c618d9b21c81" }, "code": { "type": "string", "example": "CS1" }, "createdDate": { "type": "string", "example": "2025-06-01T11:09:11.533Z" }, "description": { "type": "string", "example": "Cost center 1" }, "dimension": { "type": "string", "example": "CostCenter" }, "name": { "type": "string", "example": "Jerde, Greenfelder and Jacobi" }, "status": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED" ], "example": "ACTIVE" }, "updatedDate": { "type": "string", "example": "2025-06-01T11:09:11.533Z" } } }, "CreateTransactionRequestDto": { "type": "object", "properties": { "accountId": { "type": "string", "example": "14a6b5e92-a261-4be9-814d-84dec9636c16" }, "accountNumber": { "type": "number", "example": 4900 }, "amount": { "type": "number", "example": 100 }, "bookingDate": { "type": "string", "example": "2025-07-15T00:00:00Z" }, "contact": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "description": { "type": "string", "example": "Hotel for dreamforce" }, "journalCode": { "type": "string", "example": "31" }, "ledgerName": { "type": "string", "example": "Payroll" }, "reference": { "type": "string", "example": "RCXF197253F" }, "status": { "type": "string", "enum": [ "CREATED", "LINKED", "PRIVATE", "BOOKED", "AUTHORISED", "DELETED" ] }, "taxRatePercentage": { "type": "number", "example": 19 }, "type": { "type": "string", "enum": [ "RECEIVE", "RECEIVE-OVERPAYMENT", "RECEIVE-PREPAYMENT", "SPEND", "SPEND-OVERPAYMENT", "SPEND-PREPAYMENT", "RECEIVE-TRANSFER", "SPEND-TRANSFER" ], "example": "SPEND" }, "valueDate": { "type": "string", "example": "2025-07-15T00:00:00Z" } } }, "TransactionResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "f733a433-9662-4a40-8e36-e38ebda94fe1" }, "accountId": { "type": "string", "example": "14a6b5e92-a261-4be9-814d-84dec9636c16" }, "accountNumber": { "type": "number", "example": 4900 }, "amount": { "type": "number", "example": 100 }, "bookingDate": { "type": "string", "example": "2025-07-15T00:00:00Z" }, "contact": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "description": { "type": "string", "example": "Hotel for dreamforce" }, "files": { "type": "array", "items": { "type": "string", "example": "file1.pdf" } }, "journalCode": { "type": "string", "example": "31" }, "ledgerName": { "type": "string", "example": "Payroll" }, "reference": { "type": "string", "example": "RCXF197253F" }, "status": { "type": "string", "enum": [ "CREATED", "LINKED", "PRIVATE", "BOOKED", "AUTHORISED", "DELETED" ], "example": "CREATED" }, "taskId": { "type": "string", "example": "ADB4457839PXTC2220" }, "taxRatePercentage": { "type": "number", "example": 19 }, "type": { "type": "string", "enum": [ "RECEIVE", "RECEIVE-OVERPAYMENT", "RECEIVE-PREPAYMENT", "SPEND", "SPEND-OVERPAYMENT", "SPEND-PREPAYMENT", "RECEIVE-TRANSFER", "SPEND-TRANSFER" ], "example": "SPEND" }, "valueDate": { "type": "string", "example": "2025-07-15T00:00:00Z" } } }, "PostAuthRequestDto": { "type": "object", "properties": { "baseUrl": { "type": "string", "example": "https://entity-api1-4.abacus.ch" }, "callBackUrl": { "type": "string", "example": "https://your-app.com/callback" }, "cancelCallbackUrl": { "type": "string", "example": "https://your-app.com/cancel" }, "includeSignature": { "type": "boolean", "example": false }, "tenantId": { "type": "string", "example": "tenant_abc123" }, "webhookCallbackUrl": { "type": "string", "example": "https://your-app.com/webhooks/account-key" }, "locale": { "type": "string", "description": "BCP-47 language tag (for example de or de-DE) the authentication pages should be shown in. Falls back to the texts configured without a locale.", "example": "de" } }, "required": [ "webhookCallbackUrl" ] }, "CreateEndUserRequestDto": { "type": "object", "properties": { "apiKey": { "type": "string", "example": "api key" }, "baseUrl": { "type": "string", "example": "https://entity-api1-4.demo.abacus.ch" }, "clientName": { "type": "string", "example": "client name" }, "clientSecret": { "type": "string", "example": "client secret" }, "mandant": { "type": "string", "example": "7777" }, "password": { "type": "string", "example": "ServiceUserPassword123" }, "tenantId": { "type": "string", "example": "tenant id" }, "username": { "type": "string", "example": "Rob_Smith" } } }, "CreateEndUserResponseDto": { "type": "object", "properties": { "accountKey": { "type": "string", "example": "account key" } } }, "AccountResponseDto": { "type": "object", "properties": { "id": { "type": "string" }, "balance": { "type": "number" }, "class": { "type": "string", "enum": [ "ASSET", "EQUITY", "EXPENSE", "LIABILITY", "REVENUE" ] }, "code": { "type": "string" }, "createdDate": { "type": "string" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ] }, "debitCreditIndicator": { "type": "string", "enum": [ "DEBIT", "CREDIT" ] }, "description": { "type": "string" }, "name": { "type": "string" }, "number": { "type": "string" }, "parentAccountId": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED" ] }, "taxRate": { "$ref": "#/components/schemas/taxRateCommonDto" }, "type": { "type": "string", "enum": [ "ACCOUNTS_PAYABLE", "ACCOUNTS_RECEIVABLE", "BANK", "CREDIT_CARD", "CURRENT_ASSET", "CURRENT_LIABILITY", "DEPRECIATION", "DIRECT_COSTS", "COST_OF_GOODS_SOLD", "EQUITY", "EXPENSE", "FIXED_ASSET", "INVENTORY", "LIABILITY", "LONG_TERM_LIABILITY", "NON_CURRENT_ASSET", "NON_CURRENT_LIABILITY", "OTHER_INCOME", "OTHER_EXPENSE", "OVERHEADS", "PAYMENT_PROVIDER", "PRE_PAYMENT", "REVENUE", "SALES", "OTHER" ] }, "updatedDate": { "type": "string" } } }, "taxRateCommonDto": { "type": "object", "properties": { "id": { "type": "string", "example": "1895b05b-38a6-4a6a-9653-166389894350" }, "code": { "type": "string", "example": "03" }, "name": { "type": "string", "example": "Tax19" }, "percentage": { "type": "number", "example": 19 } } }, "taxRate": { "type": "object", "properties": { "id": { "type": "string", "example": "1895b05b-38a6-4a6a-9653-166389894350" }, "code": { "type": "string", "example": "03" }, "name": { "type": "string", "example": "Tax19" }, "taxRatePercentage": { "type": "string", "example": "19" } } }, "trackingCategory": { "type": "object", "properties": { "id": { "type": "string", "example": "efa82f42-fd85-11e1-a21f-0800200c9a33" }, "name": { "type": "string", "example": "Material/Waren" } } }, "dimension": { "type": "object", "properties": { "id": { "type": "string", "example": "efa82f42-fd85-11e1-a21f-0800200c9a33" }, "categoryName": { "type": "string", "example": "CostCenter" }, "name": { "type": "string", "example": "Material/Waren" } } }, "journalDimension": { "type": "object", "properties": { "id": { "type": "string", "example": "efa82f42-fd85-11e1-a21f-0800200c9a33" }, "categoryName": { "type": "string", "example": "CostCenter" }, "code": { "type": "string", "example": "KD1" }, "name": { "type": "string", "example": "Material/Waren" } } }, "journalLineItem": { "type": "object", "properties": { "id": { "type": "string", "example": "123f57fd-13ae-47a6-8a2a-000e6ddc60d9" }, "accountCode": { "type": "string", "example": "4034" }, "accountId": { "type": "string", "example": "da33b47c-98ca-4410-9c59-5db485ecaeb0" }, "accountNumber": { "type": "number", "example": 8200 }, "createdDate ": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "customerId": { "type": "string", "example": "782d89b56-13ae-47a6-8a2a-45e6ddc50d9" }, "debitCreditIndicator": { "type": "string", "enum": [ "DEBIT", "CREDIT" ], "example": "DEBIT" }, "description": { "type": "string", "example": "Uitgesteld 21600001 Kantoor 01-01-2021-31-12-2021" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/journalDimension" } }, "documentId": { "type": "string", "example": "b5e624e5-fb9e-4836-a443-87a3820f5b48" }, "documentNumber": { "type": "string", "example": "123456789" }, "exchangeRate": { "type": "number", "example": 1 }, "supplierId": { "type": "string", "example": "998933b56-13ae-47a6-8a32a-45e6ddc50d9" }, "taxRate": { "type": "object", "$ref": "#/components/schemas/taxRate" }, "thirdPartyCode": { "type": "string", "example": "112233" }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 1190 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 1000 }, "totalTaxAmount": { "description": "Tax (VAT) amount of the line item.", "type": "number", "example": 190 }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" } } }, "JournalResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "8df2df10-0fae-40ad-9d22-f25e5ab0ba23" }, "accountId": { "type": "string", "example": "94fdb7fd-13ae-47a6-8a2a-000e6ddc60d9" }, "code": { "type": "string", "example": "10" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "description ": { "type": "string", "example": "Purchase Journal" }, "type ": { "type": "string", "example": "Purchase" }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" } } }, "JournalentryResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "8df2df10-0fae-40ad-9d22-f25e5ab0ba23" }, "accountId": { "type": "string", "example": "94fdb7fd-13ae-47a6-8a2a-000e6ddc60d9" }, "accountingPeriodId": { "type": "string", "example": "2021-06" }, "accountingReason": { "type": "string", "enum": [ "COMMERCIAL", "TAX", "IFRS", "CALCULATION", "INDEPENDENT", "OTHER" ], "example": "COMMERCIAL" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "description": { "type": "string", "example": "Hotel for dreamforce" }, "documentId": { "type": "string", "example": "b5e624e5-fb9e-4836-a443-87a3820f5b48" }, "files": { "type": "array", "items": { "type": "string", "example": "file1.pdf" } }, "exchangeRate": { "type": "string", "example": "1,2045" }, "isProvisional": { "type": "boolean", "example": "false" }, "isReversal": { "type": "boolean", "example": false }, "journalLineItems": { "type": "array", "items": { "$ref": "#/components/schemas/journalLineItem" } }, "journalCode": { "type": "string", "example": "60" }, "journalType": { "type": "string", "example": "FIN" }, "number ": { "type": "string", "example": "21900030" }, "recordType": { "type": "string", "enum": [ "STANDARD", "CLOSING", "OPENING" ], "example": "STANDARD" }, "transactionDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "version": { "type": "string", "example": "AAAAACnY3os1" } } }, "createJournalLineItem": { "type": "object", "properties": { "id": { "type": "string", "example": "123f57fd-13ae-47a6-8a2a-000e6ddc60d9" }, "accountCode": { "type": "string", "example": "4034" }, "accountId": { "type": "string", "example": "94fdb7fd-13ae-47a6-8a2a-000e6ddc60d9" }, "accountNumber": { "type": "string", "example": "1200" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "customerId": { "type": "string", "example": "782d89b56-13ae-47a6-8a2a-45e6ddc50d9" }, "debitCreditIndicator": { "type": "string", "enum": [ "DEBIT", "CREDIT" ], "example": "DEBIT" }, "description": { "type": "string", "example": "Uitgesteld 21600001 Kantoor 01-01-2021-31-12-2021" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/journalDimension" } }, "documentId": { "type": "string", "example": "b5e624e5-fb9e-4836-a443-87a3820f5b48" }, "documentNumber": { "type": "string", "example": "123456789" }, "exchangeRate": { "type": "number", "example": 1 }, "supplierId": { "type": "string", "example": "998933b56-13ae-47a6-8a32a-45e6ddc50d9" }, "taxRate": { "type": "object", "$ref": "#/components/schemas/taxRate" }, "thirdPartyCode": { "type": "string", "example": "112233" }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 1190 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 1000 }, "totalTaxAmount": { "description": "Tax (VAT) amount of the line item.", "type": "number", "example": 190 } } }, "JournalentryRequestDto": { "type": "object", "properties": { "accountId": { "type": "string", "example": "d1bfd23-517d-4ec6-b7d4-56f86c7cf246" }, "accountingPeriodId": { "type": "string", "example": "2021-06" }, "accountingReason": { "type": "string", "enum": [ "COMMERCIAL", "TAX", "IFRS", "CALCULATION", "INDEPENDENT", "OTHER" ], "example": "COMMERCIAL" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "description": { "type": "string", "example": "Hotel for dreamforce" }, "documentId": { "type": "string", "example": "b5e624e5-fb9e-4836-a443-87a3820f5b48" }, "exchangeRate": { "type": "string", "example": "1,2045" }, "isProvisional": { "type": "boolean", "example": "false" }, "isReversal": { "type": "boolean", "example": false }, "journalLineItems": { "type": "array", "items": { "$ref": "#/components/schemas/createJournalLineItem" } }, "journalCode": { "type": "string", "example": "60" }, "journalType": { "type": "string", "example": "FIN" }, "number ": { "type": "string", "example": "21900030" }, "recordType": { "type": "string", "enum": [ "STANDARD", "CLOSING", "OPENING" ], "example": "STANDARD" }, "transactionDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "version": { "type": "string", "example": "AAAAACnY3os1" } } }, "CreateContactRequestDto": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/ContactAddress" } }, "bankAccount": { "$ref": "#/components/schemas/BankAccount" }, "companyName": { "type": "string", "example": "maesn" }, "contactType": { "type": "string", "enum": [ "CONTACT_PERSON", "COMPANY", "UNDEFINED" ], "example": "CONTACT_PERSON" }, "contactPersons": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPersonRequest" } }, "documentId": { "type": "string", "example": "Z1248601M" }, "emailAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/ContactEmail" } }, "number": { "type": "string", "example": "1042" }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPhone" } }, "projectId": { "type": "string", "example": "3" }, "vatId": { "type": "string", "example": "DE123456789" } } }, "ContactPersonRequest": { "type": "object", "properties": { "emailAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/ContactEmail" } }, "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Doe" }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPhone" } }, "salutation": { "type": "string", "example": "Mr" } } }, "ContactPerson": { "type": "object", "properties": { "emailAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/ContactEmail" } }, "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Doe" }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPhone" } }, "salutation": { "type": "string", "example": "Mr" } } }, "ContactEmail": { "type": "object", "properties": { "email": { "type": "string", "example": "john.doe@company.com" }, "type": { "type": "string", "enum": [ "BUSINESS", "PRIVATE", "OFFICE", "INVOICE", "PAYMENT", "OTHER" ], "example": "BUSINESS" } } }, "ContactPhone": { "type": "object", "properties": { "number": { "type": "string", "example": "+49 7163307056" }, "type": { "type": "string", "enum": [ "BUSINESS", "MOBILE", "FAX", "LANDLINE", "OFFICE", "OTHER", "PRIVATE", "SKYPE", "WHATSAPP" ], "example": "MOBILE" } } }, "BankAccount": { "type": "object", "properties": { "bic": { "type": "string", "example": "COBADEFFXXX" }, "holder": { "type": "string", "example": "John Doe" }, "iban": { "type": "string", "example": "DE89370400440532013000" }, "isMainAccount": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "Sparkasse" }, "sepa": { "type": "boolean", "example": true } }, "required": [ "iban", "bic", "holder", "sepa" ] }, "ContactAddress": { "type": "object", "properties": { "addressLine1": { "type": "string", "example": "Lucky street 1" }, "addressLine2": { "type": "string", "example": "2nd floor" }, "city": { "type": "string", "example": "Berlin" }, "countryCode": { "type": "string", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "example": "DE" }, "postalCode": { "type": "string", "example": "10243" }, "type": { "type": "string", "enum": [ "BILLING", "DELIVERY", "EMPTY", "PRIVATE", "WORK", "PICKUP" ], "example": "BILLING" } } }, "ContactResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "92c4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/ContactAddress" } }, "companyName": { "type": "string", "example": "maesn" }, "contactType": { "type": "string", "enum": [ "CONTACT_PERSON", "COMPANY" ], "example": "CONTACT_PERSON" }, "contactPersons": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPerson" } }, "documentId": { "type": "string", "example": "Z1248601M" }, "emailAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/ContactEmail" } }, "number": { "type": "string", "example": "1042" }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPhone" } }, "projectId": { "type": "string", "example": "3" }, "updatedDate": { "type": "string", "example": "2018-01-01T13:00:00.000Z" }, "vatId": { "type": "string", "example": "DE123456789" } } }, "EndUserResponseDto": { "type": "object", "properties": { "accessToken": { "type": "string", "example": "accessToken" }, "createdAt": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "targetSystem": { "type": "string", "example": "targetSystem" }, "updatedAt": { "type": "string", "example": "2021-01-01T00:00:00Z" } } }, "EnvironmentResponseDto": { "type": "object", "properties": { "applicationFamily": { "type": "string", "example": "BusinessCentral" }, "countryCode": { "type": "string", "example": "DE" }, "name": { "type": "string", "example": "string" }, "tenantId": { "type": "string", "example": "string" }, "type": { "type": "string", "example": "Production" } } }, "CompanyResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "string" }, "client_number": { "type": "number", "example": "1" }, "consultant_number": { "type": "number", "example": "223344" }, "environmentId": { "type": "string", "example": "string" }, "name": { "type": "string", "example": "string" }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionDto" } } } }, "SubscriptionDto": { "type": "object", "properties": { "id": { "type": "string", "example": "ACCOUNTING" }, "active": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "Accounting" }, "status": { "type": "string", "example": "paying" } } }, "InvoiceLineItemResponseDto": { "type": "object", "properties": { "lineItemId": { "type": "string", "example": "987a2b3c-4d5e-6f7g-8h9i-0j1k2l3m4n5o" }, "accountId": { "type": "string", "example": "6733a433-9662-4a40-8e36-e38ebda94fe1" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "description": { "type": "string", "example": "SEOUL Guest Chair, red" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLineItemDimension" } }, "discountItemAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 10 }, "discountItemPercentage": { "description": "Discount applied to the line item, as a percentage.", "type": "number", "example": 10 }, "grossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 109 }, "itemsAmount": { "description": "Line subtotal — unit price multiplied by quantity, before discount and tax.", "type": "number", "example": 100 }, "itemId": { "type": "string", "example": "9fc4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "name": { "type": "string", "example": "RED CHAIR" }, "quantity": { "type": "number", "example": 1 }, "taxCode": { "type": "string", "example": "03" }, "taxRatePercentage": { "type": "number", "example": 19 }, "unitAmount": { "description": "Price per unit, in the document currency.", "type": "number", "example": 100 }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" } } }, "CreateInvoiceLineItemRequestDto": { "type": "object", "properties": { "accountId": { "type": "string", "example": "6733a433-9662-4a40-8e36-e38ebda94fe1" }, "description": { "type": "string", "example": "SEOUL Guest Chair, red" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLineItemDimension" } }, "discountItemAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 10 }, "discountItemPercentage": { "description": "Discount applied to the line item, as a percentage.", "type": "number", "example": 10 }, "grossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 109 }, "itemsAmount": { "description": "Line subtotal — unit price multiplied by quantity, before discount and tax.", "type": "number", "example": 100 }, "itemId": { "type": "string", "example": "9fc4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "name": { "type": "string", "example": "RED CHAIR" }, "quantity": { "type": "number", "example": 1 }, "taxCode": { "type": "string", "example": "03" }, "taxRatePercentage": { "type": "number", "example": 19 }, "unitAmount": { "description": "Price per unit, in the document currency.", "type": "number", "example": 100 } } }, "InvoiceLineItemDimension": { "type": "object", "properties": { "id": { "type": "string", "example": "c1d2e3f4-5678-9abc-def0-1234567890ab" }, "categoryName": { "type": "string", "example": "CostCenter" }, "name": { "type": "string", "example": "C1" } } }, "LineItemDimension": { "type": "object", "properties": { "name": { "type": "string", "example": "C1" }, "categoryName": { "type": "string", "example": "CostCenter" } } }, "BillLineItem": { "type": "object", "properties": { "id": { "type": "string", "example": "987a2b3c-4d5e-6f7g-8h9i-0j1k2l3m4n5o" }, "accountId": { "type": "string", "example": "6733a433-9662-4a40-8e36-e38ebda94fe1" }, "accountNumber": { "type": "string", "example": "200" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "deferredEndDate": { "type": "string", "example": "2021-06-01T00:00:00Z" }, "deferredStartDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "description": { "type": "string", "example": "SEOUL Guest Chair, red" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/LineItemDimension" } }, "itemId": { "type": "string", "example": "4f3a2hf4-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "itemName": { "type": "string", "example": "RED CHAIR" }, "quantity": { "type": "number", "example": 1 }, "taxCode": { "type": "string", "example": "03" }, "taxRatePercentage": { "type": "number", "example": 19 }, "totalDiscountAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Discount applied to the line item, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) amount of the line item.", "type": "number", "example": 19 }, "unitAmount": { "description": "Price per unit, in the document currency.", "type": "number", "example": 100 }, "unitDiscountAmount": { "description": "Discount applied per unit, in the document currency.", "type": "number", "example": 10 }, "unitDiscountPercentage": { "description": "Discount applied per unit, as a percentage.", "type": "number", "example": 10 }, "unitName": { "type": "string", "example": "PIECE" }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" } } }, "VendorCreditLineItem": { "type": "object", "properties": { "id": { "type": "string", "example": "987a2b3c-4d5e-6f7g-8h9i-0j1k2l3m4n5o" }, "accountId": { "type": "string", "example": "6733a433-9662-4a40-8e36-e38ebda94fe1" }, "accountNumber": { "type": "string", "example": "200" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "deferredEndDate": { "type": "string", "example": "2021-06-01T00:00:00Z" }, "deferredStartDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "description": { "type": "string", "example": "SEOUL Guest Chair, red" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/LineItemDimension" } }, "itemId": { "type": "string", "example": "4f3a2hf4-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "itemName": { "type": "string", "example": "RED CHAIR" }, "quantity": { "type": "number", "example": 1 }, "taxCode": { "type": "string", "example": "03" }, "taxRatePercentage": { "type": "number", "example": 19 }, "totalDiscountAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Discount applied to the line item, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) amount of the line item.", "type": "number", "example": 19 }, "unitAmount": { "description": "Price per unit, in the document currency.", "type": "number", "example": 100 }, "unitDiscountAmount": { "description": "Discount applied per unit, in the document currency.", "type": "number", "example": 10 }, "unitDiscountPercentage": { "description": "Discount applied per unit, as a percentage.", "type": "number", "example": 10 }, "unitName": { "type": "string", "example": "PIECE" }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" } } }, "CreateBillLineItem": { "type": "object", "properties": { "accountId": { "type": "string", "example": "6733a433-9662-4a40-8e36-e38ebda94fe1" }, "accountNumber": { "type": "string", "example": "200" }, "deferredEndDate": { "type": "string", "example": "2021-06-01T00:00:00Z" }, "deferredStartDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "description": { "type": "string", "example": "SEOUL Guest Chair, red" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/LineItemDimension" } }, "itemId": { "type": "string", "example": "4f3a2hf4-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "itemName": { "type": "string", "example": "RED CHAIR" }, "quantity": { "type": "number", "example": 1 }, "taxCode": { "type": "string", "example": "03" }, "taxRatePercentage": { "type": "number", "example": 19 }, "totalDiscountAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Discount applied to the line item, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) amount of the line item.", "type": "number", "example": 19 }, "unitAmount": { "description": "Price per unit, in the document currency.", "type": "number", "example": 100 }, "unitDiscountAmount": { "description": "Discount applied per unit, in the document currency.", "type": "number", "example": 10 }, "unitDiscountPercentage": { "description": "Discount applied per unit, as a percentage.", "type": "number", "example": 10 }, "unitName": { "type": "string", "example": "PIECE" } } }, "UpdateBillLineItem": { "type": "object", "properties": { "id": { "type": "string", "example": "987a2b3c-4d5e-6f7g-8h9i-0j1k2l3m4n5o" }, "accountId": { "type": "string", "example": "6733a433-9662-4a40-8e36-e38ebda94fe1" }, "accountNumber": { "type": "string", "example": "200" }, "deferredEndDate": { "type": "string", "example": "2021-06-01T00:00:00Z" }, "deferredStartDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "description": { "type": "string", "example": "SEOUL Guest Chair, red" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/LineItemDimension" } }, "itemId": { "type": "string", "example": "4f3a2hf4-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "itemName": { "type": "string", "example": "RED CHAIR" }, "quantity": { "type": "number", "example": 1 }, "taxCode": { "type": "string", "example": "03" }, "taxRatePercentage": { "type": "number", "example": 19 }, "totalDiscountAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Discount applied to the line item, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) amount of the line item.", "type": "number", "example": 19 }, "unitAmount": { "description": "Price per unit, in the document currency.", "type": "number", "example": 100 }, "unitDiscountAmount": { "description": "Discount applied per unit, in the document currency.", "type": "number", "example": 10 }, "unitDiscountPercentage": { "description": "Discount applied per unit, as a percentage.", "type": "number", "example": 10 }, "unitName": { "type": "string", "example": "PIECE" } } }, "UnitResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "4f3a2hf4-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "code": { "type": "string", "example": "PIECE" }, "description": { "type": "string", "example": "Piece" }, "type": { "type": "string", "example": "W" } } }, "CreateVendorCreditLineItem": { "type": "object", "properties": { "accountId": { "type": "string", "example": "6733a433-9662-4a40-8e36-e38ebda94fe1" }, "accountNumber": { "type": "string", "example": "200" }, "deferredEndDate": { "type": "string", "example": "2021-06-01T00:00:00Z" }, "deferredStartDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "description": { "type": "string", "example": "SEOUL Guest Chair, red" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/LineItemDimension" } }, "itemId": { "type": "string", "example": "4f3a2hf4-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "itemName": { "type": "string", "example": "RED CHAIR" }, "quantity": { "type": "number", "example": 1 }, "taxCode": { "type": "string", "example": "03" }, "taxRatePercentage": { "type": "number", "example": 19 }, "totalDiscountAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Discount applied to the line item, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) amount of the line item.", "type": "number", "example": 19 }, "unitAmount": { "description": "Price per unit, in the document currency.", "type": "number", "example": 100 }, "unitDiscountAmount": { "description": "Discount applied per unit, in the document currency.", "type": "number", "example": 10 }, "unitDiscountPercentage": { "description": "Discount applied per unit, as a percentage.", "type": "number", "example": 10 }, "unitName": { "type": "string", "example": "PIECE" } } }, "UpdateVendorCreditLineItem": { "type": "object", "properties": { "id": { "type": "string", "example": "987a2b3c-4d5e-6f7g-8h9i-0j1k2l3m4n5o" }, "accountId": { "type": "string", "example": "6733a433-9662-4a40-8e36-e38ebda94fe1" }, "accountNumber": { "type": "string", "example": "200" }, "deferredEndDate": { "type": "string", "example": "2021-06-01T00:00:00Z" }, "deferredStartDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "description": { "type": "string", "example": "SEOUL Guest Chair, red" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/LineItemDimension" } }, "itemId": { "type": "string", "example": "4f3a2hf4-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "itemName": { "type": "string", "example": "RED CHAIR" }, "quantity": { "type": "number", "example": 1 }, "taxCode": { "type": "string", "example": "03" }, "taxRatePercentage": { "type": "number", "example": 19 }, "totalDiscountAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Discount applied to the line item, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) amount of the line item.", "type": "number", "example": 19 }, "unitAmount": { "description": "Price per unit, in the document currency.", "type": "number", "example": 100 }, "unitDiscountAmount": { "description": "Discount applied per unit, in the document currency.", "type": "number", "example": 10 }, "unitDiscountPercentage": { "description": "Discount applied per unit, as a percentage.", "type": "number", "example": 10 }, "unitName": { "type": "string", "example": "PIECE" } } }, "InvoiceLineItemRequest": { "type": "object", "properties": { "accountCode": { "type": "string", "example": "1890" }, "accountId": { "type": "string", "example": "6733a433-9662-4a40-8e36-e38ebda94fe1" }, "description": { "type": "string", "example": "SEOUL Guest Chair, red" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLineItemDimension" } }, "discountItemPercentage": { "type": "number", "example": 10 }, "grossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 109 }, "itemId": { "type": "string", "example": "9fc4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "name": { "type": "string", "example": "RED CHAIR" }, "quantity": { "type": "number", "example": 1 }, "taxCode": { "type": "string", "example": "03" }, "taxRatePercentage": { "type": "number", "example": 19 }, "taxType": { "type": "string", "example": "Tax 19 percent" }, "type": { "type": "string", "example": "SERVICE", "enum": [ "SERVICE_ITEM", "MATERIAL", "CUSTOM", "TEXT" ] }, "unitAmount": { "description": "Price per unit, in the document currency.", "type": "number", "example": 100 }, "unitName": { "type": "string", "example": "PIECE" } } }, "Address": { "type": "object", "properties": { "addressLine1": { "type": "string", "example": "Main street 45" }, "addressLine2": { "type": "string", "example": "2nd floor" }, "city": { "type": "string", "example": "Berlin" }, "countryCode": { "type": "string", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "example": "DE" }, "postalCode": { "type": "string", "example": "10243" }, "type": { "type": "string", "enum": [ "BILLING", "DELIVERY", "SELLING" ], "example": "BILLING" } } }, "InvoiceResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "9714f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "invoiceId": { "type": "string", "example": "9714f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "contactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "discountAmount": { "description": "Total discount applied to the invoice, in the document currency.", "type": "number", "example": 10 }, "dueDate": { "type": "string", "example": "2021-02-01T00:00:00Z" }, "fileId": { "type": "string", "example": "93c6b8e0-80a4-4c22-a46c-18beebab82d6" }, "invoiceDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "invoiceNumber": { "type": "string", "example": "1020" }, "invoiceType": { "type": "string", "example": "STANDARD", "enum": [ "STANDARD" ] }, "journalCode": { "type": "string", "example": "50" }, "lineAmountType": { "type": "string", "example": "EXCLUSIVE", "enum": [ "EXCLUSIVE", "INCLUSIVE", "NOTAX" ] }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLineItemResponseDto" } }, "name": { "type": "string", "example": "Office Supplies" }, "oneLineAddress": { "type": "string", "example": "Main street 45, Berlin" }, "paidDate": { "type": "string", "example": "2021-01-25T00:00:00Z" }, "paymentStatus": { "description": "Best-effort payment/open-item status. Only populated by some source systems; `null` for all others. Prefer `status` for reliable lifecycle logic, and always handle the `null` case. See [Document status fields](/standardization#document-status-fields).", "type": "string", "example": "PENDING", "enum": [ "PENDING", "PAID", "PARTLY_PAID", "CANCELED", "PARTIAL_CANCELLATION", "BAD_DEBT", "DEBITED" ] }, "paymentTermDuration": { "type": "number", "example": 30 }, "paymentTermId": { "type": "string", "example": "1" }, "reference": { "type": "string", "example": "RCXF197253F" }, "salesOrderId": { "type": "string", "example": "30911" }, "shippingDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "status": { "description": "The document's lifecycle status, populated across all source systems. Use this as the authoritative state for lifecycle and paid/unpaid logic; prefer it over the best-effort `paymentStatus`. See [Document status fields](/standardization#document-status-fields).", "type": "string", "example": "DRAFT", "enum": [ "DRAFT", "CORRECTIVE", "SUBMITTED", "DOCUMENT_CREATED", "OPEN", "PARTIALLY_PAID", "PAID", "PARTIALLY_OVERDUE", "OVERDUE", "VOIDED" ] }, "sumNetAmount": { "description": "Net amount of the invoice — the total before tax (excluding VAT).", "type": "number", "example": 100 }, "taxRule": { "type": "string", "example": "NET", "enum": [ "NET", "TAXFREE", "INTRACOMMUNITY_GOODS", "INTRACOMMUNITY_SERVICE", "EXPORT_SERVICE", "EXPORT_GOODS", "REVERSE_CHARGE", "GROSS", "CONSTRUCTION_SERVICE", "PHOTOVOLTAIC_EQUIPMENT", "SMALL_BUSINESS_VAT_EXEMPTION", "NON_DOMESTIC_SERVICE", "OSS_GOODS", "OSS_ELECTRONIC_SERVICES", "OSS_SERVICES" ] }, "totalAmount": { "description": "Gross amount of the invoice — the net amount plus tax (the total payable, including VAT).", "type": "number", "example": 109 }, "totalTaxAmount": { "description": "Tax (VAT) amount of the invoice — the difference between the gross (`totalAmount`) and net (`sumNetAmount`) totals.", "type": "number", "example": 19 }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" } } }, "BillResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "9714f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "accountId": { "type": "string", "example": "6733a433-9662-4a40-8e36-e38ebda94fe1" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "billDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "billNumber": { "type": "string", "example": "1020" }, "contactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "deliveryDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "dueDate": { "type": "string", "example": "2021-07-01T00:00:00Z" }, "fileId": { "type": "string", "example": "93c6b8e0-80a4-4c22-a46c-18beebab82d6" }, "journalCode": { "type": "string", "example": "30" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/BillLineItem" } }, "name": { "type": "string", "example": "Office Supplies" }, "oneLineAddress": { "type": "string", "example": "Main street 45, Berlin" }, "paidDate": { "type": "string", "example": "2021-01-25T00:00:00Z" }, "paymentDays": { "type": "number", "example": 30 }, "paymentReference": { "type": "string", "example": "Edefad142e764894" }, "paymentStatus": { "description": "Best-effort payment/open-item status. Only populated by some source systems; `null` for all others. Prefer `status` for reliable lifecycle logic, and always handle the `null` case. See [Document status fields](/standardization#document-status-fields).", "type": "string", "example": "PENDING", "enum": [ "NO_OPEN_ITEM", "PENDING", "PAID", "PARTLY_PAID", "CANCELED", "PARTIAL_CANCELLATION", "BAD_DEBT", "DEBITED", "CREDIT_NOTE_CLEARED", "CLEARED_WITH_CREDIT_NOTE", "UNKNOWN" ] }, "paymentTermCode": { "type": "string", "example": "21" }, "reference": { "type": "string", "example": "026 / 245" }, "shippingDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "shippingType": { "type": "string", "example": "DELIVERY", "enum": [ "SERVICE", "SERVICE_PERIOD", "DELIVERY", "DELIVERY_PERIOD" ] }, "status": { "description": "The document's lifecycle status, populated across all source systems. Use this as the authoritative state for lifecycle and paid/unpaid logic; prefer it over the best-effort `paymentStatus`. See [Document status fields](/standardization#document-status-fields).", "type": "string", "example": "DRAFT", "enum": [ "DRAFT", "CORRECTIVE", "SUBMITTED", "DOCUMENT_CREATED", "OPEN", "PARTIALLY_PAID", "PAID", "PARTIALLY_OVERDUE", "OVERDUE", "VOIDED" ] }, "taxRule": { "type": "string", "example": "NET", "enum": [ "NET", "TAXFREE", "INTRACOMMUNITY_GOODS", "INTRACOMMUNITY_SERVICE", "EXPORT_SERVICE", "EXPORT_GOODS", "REVERSE_CHARGE", "GROSS", "CONSTRUCTION_SERVICE", "PHOTOVOLTAIC_EQUIPMENT", "SMALL_BUSINESS_VAT_EXEMPTION", "NON_DOMESTIC_SERVICE", "OSS_GOODS", "OSS_ELECTRONIC_SERVICES", "OSS_SERVICES" ] }, "taxText": { "type": "string", "example": "Tax 19 percent" }, "totalDiscountAmount": { "description": "Total discount applied, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Total discount applied, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross total — the net amount plus tax (the total payable, including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net total — the sum of all line amounts before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) total — the difference between the gross and net totals.", "type": "number", "example": 19 }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" } } }, "VendorCreditResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "9714f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "accountId": { "type": "string", "example": "6733a433-9662-4a40-8e36-e38ebda94fe1" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "contactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "deliveryDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "dueDate": { "type": "string", "example": "2021-07-01T00:00:00Z" }, "fileId": { "type": "string", "example": "93c6b8e0-80a4-4c22-a46c-18beebab82d6" }, "journalCode": { "type": "string", "example": "30" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/VendorCreditLineItem" } }, "name": { "type": "string", "example": "Office Supplies" }, "oneLineAddress": { "type": "string", "example": "Main street 45, Berlin" }, "paidDate": { "type": "string", "example": "2021-01-25T00:00:00Z" }, "paymentDays": { "type": "number", "example": 30 }, "paymentReference": { "type": "string", "example": "a123ad142e743294" }, "paymentStatus": { "description": "Best-effort payment/open-item status. Only populated by some source systems; `null` for all others. Prefer `status` for reliable lifecycle logic, and always handle the `null` case. See [Document status fields](/standardization#document-status-fields).", "type": "string", "example": "PENDING", "enum": [ "NO_OPEN_ITEM", "PENDING", "PAID", "PARTLY_PAID", "CANCELED", "PARTIAL_CANCELLATION", "BAD_DEBT", "DEBITED", "CREDIT_NOTE_CLEARED", "CLEARED_WITH_CREDIT_NOTE", "UNKNOWN" ] }, "paymentTermCode": { "type": "string", "example": "d2f3e4b5-6a7b-8c9d-0e1f-2g3h4i5j6k7l" }, "reference": { "type": "string", "example": "RCXF197253F" }, "shippingDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "shippingType": { "type": "string", "example": "DELIVERY", "enum": [ "SERVICE", "SERVICE_PERIOD", "DELIVERY", "DELIVERY_PERIOD" ] }, "status": { "description": "The document's lifecycle status, populated across all source systems. Use this as the authoritative state for lifecycle and paid/unpaid logic; prefer it over the best-effort `paymentStatus`. See [Document status fields](/standardization#document-status-fields).", "type": "string", "example": "DRAFT", "enum": [ "DRAFT", "CORRECTIVE", "SUBMITTED", "DOCUMENT_CREATED", "OPEN", "PARTIALLY_PAID", "PAID", "PARTIALLY_OVERDUE", "OVERDUE", "VOIDED" ] }, "taxRule": { "type": "string", "example": "NET", "enum": [ "NET", "TAXFREE", "INTRACOMMUNITY_GOODS", "INTRACOMMUNITY_SERVICE", "EXPORT_SERVICE", "EXPORT_GOODS", "REVERSE_CHARGE", "GROSS", "CONSTRUCTION_SERVICE", "PHOTOVOLTAIC_EQUIPMENT", "SMALL_BUSINESS_VAT_EXEMPTION", "NON_DOMESTIC_SERVICE", "OSS_GOODS", "OSS_ELECTRONIC_SERVICES", "OSS_SERVICES" ] }, "taxText": { "type": "string", "example": "Tax 19 percent" }, "totalDiscountAmount": { "description": "Total discount applied, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Total discount applied, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross total — the net amount plus tax (the total payable, including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net total — the sum of all line amounts before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) total — the difference between the gross and net totals.", "type": "number", "example": 19 }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "vendorCreditDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "vendorCreditNumber": { "type": "string", "example": "1020" } } }, "CreateInvoiceRequestDto": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "contactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "discountPercentage": { "type": "number", "example": 10 }, "dueDate": { "type": "string", "example": "2021-02-01T00:00:00Z" }, "fileId": { "type": "string", "example": "93c6b8e0-80a4-4c22-a46c-18beebab82d6" }, "grossTotalAmount": { "description": "Gross amount of the invoice — the net amount plus tax (total, including VAT).", "type": "number", "example": 119 }, "invoiceDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "invoiceNumber": { "type": "string", "example": "1020" }, "invoiceType": { "type": "string", "example": "STANDARD", "enum": [ "STANDARD" ] }, "journalCode": { "type": "string", "example": "50" }, "lineAmountTypes": { "type": "string", "example": "EXCLUSIVE", "enum": [ "EXCLUSIVE", "INCLUSIVE", "NOTAX" ] }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLineItemRequest" } }, "name": { "type": "string", "example": "Office Supplies" }, "oneLineAddress": { "type": "string", "example": "Main street 45, Berlin" }, "paidDate": { "type": "string", "example": "2021-01-25T00:00:00Z" }, "paymentTermDuration": { "type": "number", "example": 30 }, "paymentTermId": { "type": "string", "example": "1" }, "reference": { "type": "string", "example": "RCXF197253F" }, "salesOrderId": { "type": "string", "example": "30911" }, "shippingDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "shippingEndDate": { "type": "string", "example": "2021-01-10T00:00:00Z" }, "shippingType": { "type": "string", "example": "DELIVERYPERIOD", "enum": [ "SERVICE", "SERVICEPERIOD", "DELIVERY", "DELIVERYPERIOD", "NONE" ] }, "status": { "type": "string", "example": "DRAFT", "enum": [ "DRAFT", "CORRECTIVE", "SUBMITTED", "DOCUMENT_CREATED", "OPEN", "PARTIALLY_PAID", "PAID", "PARTIALLY_OVERDUE", "OVERDUE", "VOIDED" ] }, "taxRule": { "type": "string", "example": "NET", "enum": [ "NET", "TAXFREE", "INTRACOMMUNITY_GOODS", "INTRACOMMUNITY_SERVICE", "EXPORT_SERVICE", "EXPORT_GOODS", "REVERSE_CHARGE", "GROSS", "CONSTRUCTION_SERVICE", "PHOTOVOLTAIC_EQUIPMENT", "SMALL_BUSINESS_VAT_EXEMPTION", "NON_DOMESTIC_SERVICE", "OSS_GOODS", "OSS_ELECTRONIC_SERVICES", "OSS_SERVICES" ] }, "taxText": { "type": "string", "example": "Tax 19 percent" } } }, "CreateBillRequestDto": { "type": "object", "properties": { "accountId": { "type": "string", "example": "6733a433-9662-4a40-8e36-e38ebda94fe1" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "billDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "billNumber": { "type": "string", "example": "1020" }, "contactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "deliveryDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "dueDate": { "type": "string", "example": "2021-07-01T00:00:00Z" }, "fileId": { "type": "string", "example": "93c6b8e0-80a4-4c22-a46c-18beebab82d6" }, "journalCode": { "type": "string", "example": "30" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/CreateBillLineItem" } }, "name": { "type": "string", "example": "Office Supplies" }, "oneLineAddress": { "type": "string", "example": "Main street 45, Berlin" }, "paidDate": { "type": "string", "example": "2021-01-25T00:00:00Z" }, "paymentDays": { "type": "number", "example": 30 }, "paymentReference": { "type": "string", "example": "Edefad142e764894" }, "paymentStatus": { "type": "string", "example": "PENDING", "enum": [ "NO_OPEN_ITEM", "PENDING", "PAID", "PARTLY_PAID", "CANCELED", "PARTIAL_CANCELLATION", "BAD_DEBT", "DEBITED", "CREDIT_NOTE_CLEARED", "CLEARED_WITH_CREDIT_NOTE", "UNKNOWN" ] }, "paymentTermCode": { "type": "string", "example": "21" }, "reference": { "type": "string", "example": "026 / 245" }, "shippingDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "shippingType": { "type": "string", "example": "DELIVERY", "enum": [ "SERVICE", "SERVICEPERIOD", "DELIVERY", "DELIVERYPERIOD", "NONE" ] }, "status": { "type": "string", "example": "DRAFT", "enum": [ "DRAFT", "CORRECTIVE", "SUBMITTED", "DOCUMENT_CREATED", "OPEN", "PARTIALLY_PAID", "PAID", "PARTIALLY_OVERDUE", "OVERDUE", "VOIDED" ] }, "taxRule": { "type": "string", "example": "NET", "enum": [ "NET", "TAXFREE", "INTRACOMMUNITY_GOODS", "INTRACOMMUNITY_SERVICE", "EXPORT_SERVICE", "EXPORT_GOODS", "REVERSE_CHARGE", "GROSS", "CONSTRUCTION_SERVICE", "PHOTOVOLTAIC_EQUIPMENT", "SMALL_BUSINESS_VAT_EXEMPTION", "NON_DOMESTIC_SERVICE", "OSS_GOODS", "OSS_ELECTRONIC_SERVICES", "OSS_SERVICES" ] }, "taxText": { "type": "string", "example": "Tax 19 percent" }, "totalDiscountAmount": { "description": "Total discount applied, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Total discount applied, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross total — the net amount plus tax (the total payable, including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net total — the sum of all line amounts before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) total — the difference between the gross and net totals.", "type": "number", "example": 19 } } }, "UpdateBillRequestDto": { "type": "object", "properties": { "accountId": { "type": "string", "example": "6733a433-9662-4a40-8e36-e38ebda94fe1" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "billDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "billNumber": { "type": "string", "example": "1020" }, "contactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "deliveryDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "dueDate": { "type": "string", "example": "2021-07-01T00:00:00Z" }, "fileId": { "type": "string", "example": "93c6b8e0-80a4-4c22-a46c-18beebab82d6" }, "journalCode": { "type": "string", "example": "30" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateBillLineItem" } }, "name": { "type": "string", "example": "Office Supplies" }, "oneLineAddress": { "type": "string", "example": "Main street 45, Berlin" }, "paidDate": { "type": "string", "example": "2021-01-25T00:00:00Z" }, "paymentDays": { "type": "number", "example": 30 }, "paymentReference ": { "type": "string", "example": "Edefad142e764894" }, "paymentStatus": { "type": "string", "example": "PENDING", "enum": [ "NO_OPEN_ITEM", "PENDING", "PAID", "PARTLY_PAID", "CANCELED", "PARTIAL_CANCELLATION", "BAD_DEBT", "DEBITED", "CREDIT_NOTE_CLEARED", "CLEARED_WITH_CREDIT_NOTE", "UNKNOWN" ] }, "paymentTermCode": { "type": "string", "example": "21" }, "reference": { "type": "string", "example": "RCXF197253F" }, "shippingDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "shippingType": { "type": "string", "example": "DELIVERY", "enum": [ "SERVICE", "SERVICEPERIOD", "DELIVERY", "DELIVERYPERIOD", "NONE" ] }, "status": { "type": "string", "example": "DRAFT", "enum": [ "DRAFT", "CORRECTIVE", "SUBMITTED", "DOCUMENT_CREATED", "OPEN", "PARTIALLY_PAID", "PAID", "PARTIALLY_OVERDUE", "OVERDUE", "VOIDED" ] }, "taxRule": { "type": "string", "example": "NET", "enum": [ "NET", "TAXFREE", "INTRACOMMUNITY_GOODS", "INTRACOMMUNITY_SERVICE", "EXPORT_SERVICE", "EXPORT_GOODS", "REVERSE_CHARGE", "GROSS", "CONSTRUCTION_SERVICE", "PHOTOVOLTAIC_EQUIPMENT", "SMALL_BUSINESS_VAT_EXEMPTION", "NON_DOMESTIC_SERVICE", "OSS_GOODS", "OSS_ELECTRONIC_SERVICES", "OSS_SERVICES" ] }, "taxText": { "type": "string", "example": "Tax 19 percent" }, "totalDiscountAmount": { "description": "Total discount applied, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Total discount applied, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross total — the net amount plus tax (the total payable, including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net total — the sum of all line amounts before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) total — the difference between the gross and net totals.", "type": "number", "example": 19 } } }, "CreateVendorCreditRequestDto": { "type": "object", "properties": { "accountId": { "type": "string", "example": "6733a433-9662-4a40-8e36-e38ebda94fe1" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "contactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "deliveryDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "dueDate": { "type": "string", "example": "2021-07-01T00:00:00Z" }, "fileId": { "type": "string", "example": "93c6b8e0-80a4-4c22-a46c-18beebab82d6" }, "journalCode": { "type": "string", "example": "30" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/CreateVendorCreditLineItem" } }, "name": { "type": "string", "example": "Office Supplies" }, "oneLineAddress": { "type": "string", "example": "Main street 45, Berlin" }, "paidDate": { "type": "string", "example": "2021-01-25T00:00:00Z" }, "paymentDays": { "type": "number", "example": 30 }, "paymentReference": { "type": "string", "example": "a123ad142e743294" }, "paymentStatus": { "type": "string", "example": "PENDING", "enum": [ "NO_OPEN_ITEM", "PENDING", "PAID", "PARTLY_PAID", "CANCELED", "PARTIAL_CANCELLATION", "BAD_DEBT", "DEBITED", "CREDIT_NOTE_CLEARED", "CLEARED_WITH_CREDIT_NOTE", "UNKNOWN" ] }, "paymentTermCode": { "type": "string", "example": "d2f3e4b5-6a7b-8c9d-0e1f-2g3h4i5j6k7l" }, "reference": { "type": "string", "example": "RCXF197253F" }, "shippingDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "shippingType": { "type": "string", "example": "DELIVERY", "enum": [ "SERVICE", "SERVICEPERIOD", "DELIVERY", "DELIVERYPERIOD", "NONE" ] }, "status": { "type": "string", "example": "DRAFT", "enum": [ "DRAFT", "CORRECTIVE", "SUBMITTED", "DOCUMENT_CREATED", "OPEN", "PARTIALLY_PAID", "PAID", "PARTIALLY_OVERDUE", "OVERDUE", "VOIDED" ] }, "taxRule": { "type": "string", "example": "NET", "enum": [ "NET", "TAXFREE", "INTRACOMMUNITY_GOODS", "INTRACOMMUNITY_SERVICE", "EXPORT_SERVICE", "EXPORT_GOODS", "REVERSE_CHARGE", "GROSS", "CONSTRUCTION_SERVICE", "PHOTOVOLTAIC_EQUIPMENT", "SMALL_BUSINESS_VAT_EXEMPTION", "NON_DOMESTIC_SERVICE", "OSS_GOODS", "OSS_ELECTRONIC_SERVICES", "OSS_SERVICES" ] }, "taxText": { "type": "string", "example": "Tax 19 percent" }, "totalDiscountAmount": { "description": "Total discount applied, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Total discount applied, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross total — the net amount plus tax (the total payable, including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net total — the sum of all line amounts before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) total — the difference between the gross and net totals.", "type": "number", "example": 19 }, "vendorCreditDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "vendorCreditNumber": { "type": "string", "example": "1020" } } }, "UpdateVendorCreditRequestDto": { "type": "object", "properties": { "accountId": { "type": "string", "example": "6733a433-9662-4a40-8e36-e38ebda94fe1" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "contactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "deliveryDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "dueDate": { "type": "string", "example": "2021-07-01T00:00:00Z" }, "journalCode": { "type": "string", "example": "30" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateVendorCreditLineItem" } }, "name": { "type": "string", "example": "Office Supplies" }, "oneLineAddress": { "type": "string", "example": "Main street 45, Berlin" }, "paidDate": { "type": "string", "example": "2021-01-25T00:00:00Z" }, "paymentDays": { "type": "number", "example": 30 }, "paymentReference": { "type": "string", "example": "a123ad142e743294" }, "paymentStatus": { "type": "string", "example": "PENDING", "enum": [ "NO_OPEN_ITEM", "PENDING", "PAID", "PARTLY_PAID", "CANCELED", "PARTIAL_CANCELLATION", "BAD_DEBT", "DEBITED", "CREDIT_NOTE_CLEARED", "CLEARED_WITH_CREDIT_NOTE", "UNKNOWN" ] }, "paymentTermId": { "type": "string", "example": "d2f3e4b5-6a7b-8c9d-0e1f-2g3h4i5j6k7l" }, "reference": { "type": "string", "example": "RCXF197253F" }, "shippingDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "shippingType": { "type": "string", "example": "DELIVERY", "enum": [ "SERVICE", "SERVICEPERIOD", "DELIVERY", "DELIVERYPERIOD", "NONE" ] }, "status": { "type": "string", "example": "DRAFT", "enum": [ "DRAFT", "CORRECTIVE", "SUBMITTED", "DOCUMENT_CREATED", "OPEN", "PARTIALLY_PAID", "PAID", "PARTIALLY_OVERDUE", "OVERDUE", "VOIDED" ] }, "taxRule": { "type": "string", "example": "NET", "enum": [ "NET", "TAXFREE", "INTRACOMMUNITY_GOODS", "INTRACOMMUNITY_SERVICE", "EXPORT_SERVICE", "EXPORT_GOODS", "REVERSE_CHARGE", "GROSS", "CONSTRUCTION_SERVICE", "PHOTOVOLTAIC_EQUIPMENT", "SMALL_BUSINESS_VAT_EXEMPTION", "NON_DOMESTIC_SERVICE", "OSS_GOODS", "OSS_ELECTRONIC_SERVICES", "OSS_SERVICES" ] }, "taxText": { "type": "string", "example": "Tax 19 percent" }, "totalDiscountAmount": { "description": "Total discount applied, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Total discount applied, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross total — the net amount plus tax (the total payable, including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net total — the sum of all line amounts before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) total — the difference between the gross and net totals.", "type": "number", "example": 19 }, "vendorCreditDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "vendorCreditNumber": { "type": "string", "example": "1020" } } }, "CreateFileRequestDto": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "contactId": { "type": "string", "example": "287a382-s35e624e5-fb9e-483" }, "documentDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "documentId": { "type": "string", "example": "b5e624e5-fb9e-4836-a443-87a3820f5b48" }, "documentType": { "type": "string", "example": "Rechnungseingang" }, "integrationSource": { "type": "string", "example": "Third party app" }, "note": { "type": "string", "example": "Invoice 02-03-2023" }, "resourceId": { "type": "string", "example": "771cb8f9-c0e9-4010-bf85-6675af290e37" }, "folderName": { "type": "string", "example": "Invoice" } }, "required": [ "file", "documentType" ] }, "CreateAttachmentRequestDto": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "required": [ "file" ] }, "CheckClientPermissionsResponseDto": { "type": "object", "properties": { "accountLength": { "type": "number", "example": 4 }, "fiscalYear": { "type": "string", "example": "2021" }, "hasPermission": { "type": "boolean", "example": true }, "jobId": { "type": "number", "example": "ASD5456783GG2EFUJ5Y" }, "message": { "type": "string", "example": "Permission granted" }, "postingMonth": { "type": "string", "example": "02" } } }, "DataTransferStatusResponseDto": { "type": "object", "properties": { "jobId": { "type": "string", "example": "ASD5456783GG2EFUJ5Y" }, "status": { "type": "number", "example": "4" } } }, "DataTransfersProcotolEntriesResponseDto": { "type": "object", "properties": { "text": { "type": "string", "example": "" }, "type": { "type": "string", "example": "information" }, "filename": { "type": "string", "example": "filename" }, "timestamp": { "type": "string", "example": "2021-01-01T00:00:00Z" } } }, "PatchInvoiceRequestDto": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "contactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "discountPercentage": { "type": "number", "example": 10 }, "dueDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "fileId": { "type": "string", "example": "93c6b8e0-80a4-4c22-a46c-18beebab82d6" }, "invoiceDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "invoiceType": { "type": "string", "example": "STANDARD", "enum": [ "STANDARD" ] }, "journalCode": { "type": "string", "example": "50" }, "lineAmountTypes": { "type": "string", "example": "EXCLUSIVE", "enum": [ "EXCLUSIVE", "INCLUSIVE", "NOTAX" ] }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLineItemRequest" } }, "name": { "type": "string", "example": "Invoice name" }, "oneLineAddress": { "type": "string", "example": "Main street 45, Berlin" }, "paidDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "paymentTermDuration": { "type": "number", "example": 30 }, "paymentTermId": { "type": "string", "example": "1" }, "reference": { "type": "string", "example": "RCXF197253F" }, "shippingDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "shippingEndDate": { "type": "string", "example": "2021-01-10T00:00:00Z" }, "shippingType": { "type": "string", "example": "SERVICE", "enum": [ "SERVICE", "SERVICEPERIOD", "DELIVERY", "DELIVERYPERIOD", "NONE" ] }, "status": { "type": "string", "example": "DRAFT", "enum": [ "DRAFT", "SUBMITTED", "AUTHORISED", "PAID", "CANCELED" ] }, "taxRule": { "type": "string", "example": "NET", "enum": [ "NET", "TAXFREE", "INTRACOMMUNITY_GOODS", "INTRACOMMUNITY_SERVICE", "EXPORT_SERVICE", "EXPORT_GOODS", "REVERSE_CHARGE", "GROSS", "CONSTRUCTION_SERVICE", "PHOTOVOLTAIC_EQUIPMENT", "SMALL_BUSINESS_VAT_EXEMPTION", "NON_DOMESTIC_SERVICE", "OSS_GOODS", "OSS_ELECTRONIC_SERVICES", "OSS_SERVICES" ] }, "taxText": { "type": "string", "example": "Tax 19 percent" } } }, "UserInfoDto": { "properties": { "id": { "type": "string", "example": "9341455527236333" }, "account_id": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "family_name": { "type": "string", "example": "Doe" }, "name": { "type": "string", "example": "John" } } }, "expenseLineItem": { "type": "object", "properties": { "id": { "type": "string", "example": "b9dade6b-2b69-42c9-bcd4-841960f6cd9f" }, "accountCode": { "type": "string", "example": "200" }, "accountId": { "type": "string", "example": "56dec6c2-b14c-43ea-87bb-cc67b0ba2545" }, "accountNumber": { "type": "number", "example": 4900 }, "createdDate ": { "type": "string", "example": "2025-07-15T00:00:00Z" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "description": { "type": "string", "example": "Gasoline for business trip" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/dimension" } }, "documentNumber": { "type": "string", "example": "EXP-12345" }, "exchangeRate": { "type": "number", "example": 1 }, "itemId": { "type": "string", "example": "9fc4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "taxRate": { "type": "object", "$ref": "#/components/schemas/taxRate" }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 119 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 100 }, "updatedDate": { "type": "string", "example": "2025-07-15T00:00:00Z" } } }, "expenseLineItemRequest": { "type": "object", "properties": { "accountCode": { "type": "string", "example": "200" }, "accountId": { "type": "string", "example": "56dec6c2-b14c-43ea-87bb-cc67b0ba2545" }, "accountNumber": { "type": "number", "example": 4900 }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "description": { "type": "string", "example": "Gasoline for business trip" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/dimension" } }, "documentNumber": { "type": "string", "example": "EXP-12345" }, "exchangeRate": { "type": "number", "example": 1 }, "itemId": { "type": "string", "example": "9fc4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "taxRate": { "type": "object", "$ref": "#/components/schemas/taxRate" }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 119 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 100 } } }, "ExpenseResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "9dea18d2-748e-4bda-9f4c-02b08a9622cd" }, "accountCode ": { "type": "string", "example": "200" }, "accountId ": { "type": "string", "example": "6527a18d2-748e-4bda-9f4c-02b08a9622cd" }, "accountNumber ": { "type": "number", "example": 70000 }, "createdDate": { "type": "string", "example": "2025-07-15T00:00:00Z" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "customerId": { "type": "string", "example": "8a32de4f-55cc-4962-b000-a2a20662b821" }, "description": { "type": "string", "example": "Expense_07/25 for business trip" }, "documentId": { "type": "string", "example": "c77fbedb-1ff3-4fed-8716-4d3e3fc85ccf" }, "exchangeRate": { "type": "string", "example": "1" }, "expenseLines": { "type": "array", "items": { "$ref": "#/components/schemas/expenseLineItem" } }, "files": { "type": "array", "items": { "type": "string", "example": "file1.pdf" } }, "journalCode": { "type": "string", "example": "60" }, "ledgerName": { "type": "string", "example": "Payroll" }, "note": { "type": "string", "example": "Gasoline for business trip" }, "paymentTermId": { "type": "string", "example": "d2f3e4b5-6a7b-8c9d-0e1f-2g3h4i5j6k7l" }, "paymentType": { "type": "string", "enum": [ "CASH", "CHECK", "CREDIT_CARD", "CREDIT", "COLLECTION" ], "example": "CASH" }, "supplierId": { "type": "string", "example": "52c049b9-91b7-4828-b346-e1eeadfa31dd" }, "taskId ": { "type": "string", "example": "ADB4457839PXTC2220" }, "type": { "type": "string", "enum": [ "EXPENSE", "REFUND" ], "example": "EXPENSE" }, "totalGrossAmount": { "description": "Gross total — the net amount plus tax (the total payable, including VAT).", "type": "number", "example": 119 }, "totalNetAmount": { "description": "Net total — the sum of all line amounts before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) total — the difference between the gross and net totals.", "type": "number", "example": 19 }, "transactionDate": { "type": "string", "example": "2025-07-15T00:00:00Z" }, "updatedDate": { "type": "string", "example": "2025-07-15T00:00:00Z" } } }, "ExpenseRequestDto": { "type": "object", "properties": { "accountCode": { "type": "string", "example": "200" }, "accountId": { "type": "string", "example": "6527a18d2-748e-4bda-9f4c-02b08a9622cd" }, "accountNumber": { "type": "number", "example": 70000 }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "customerId": { "type": "string", "example": "8a32de4f-55cc-4962-b000-a2a20662b821" }, "description": { "type": "string", "example": "Expense_07/25 for business trip" }, "documentId": { "type": "string", "example": "c77fbedb-1ff3-4fed-8716-4d3e3fc85ccf" }, "exchangeRate": { "type": "string", "example": "1" }, "expenseLines": { "type": "array", "items": { "$ref": "#/components/schemas/expenseLineItemRequest" } }, "journalCode": { "type": "string", "example": "60" }, "ledgerName": { "type": "string", "example": "Payroll" }, "note": { "type": "string", "example": "Gasoline for business trip" }, "paymentTermId": { "type": "string", "example": "d2f3e4b5-6a7b-8c9d-0e1f-2g3h4i5j6k7l" }, "paymentType": { "type": "string", "enum": [ "CASH", "CHECK", "CREDIT_CARD", "CREDIT", "COLLECTION" ], "example": "CASH" }, "supplierId": { "type": "string", "example": "52c049b9-91b7-4828-b346-e1eeadfa31dd" }, "type": { "type": "string", "enum": [ "EXPENSE", "REFUND" ] }, "totalGrossAmount": { "description": "Gross total — the net amount plus tax (the total payable, including VAT).", "type": "number", "example": 119 }, "totalNetAmount": { "description": "Net total — the sum of all line amounts before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) total — the difference between the gross and net totals.", "type": "number", "example": 5 }, "transactionDate": { "type": "string", "example": "2025-07-15T00:00:00Z" } } }, "AccountCommonDto": { "type": "object", "properties": { "id": { "type": "string", "example": "db32-4f56-8a9b-1234567890ab" }, "code": { "type": "string", "example": "200" }, "name": { "type": "string", "example": "EXPENSE" }, "number": { "type": "number", "example": 4900 } } }, "DimensionCommonDto": { "type": "object", "properties": { "id": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "code": { "type": "string", "example": "CS1" }, "dimension": { "type": "string", "example": "CostCenter" }, "name": { "type": "string", "example": "Jerde, Greenfelder and Jacobi" } } }, "taxRateV2": { "type": "object", "properties": { "id": { "type": "string", "example": "1895b05b-38a6-4a6a-9653-166389894350" }, "code": { "type": "string", "example": "03" }, "description": { "type": "string", "example": "Tax19" }, "taxRatePercentage": { "type": "number", "example": "19" } } }, "expenseLineItemAsyncRequest": { "type": "object", "properties": { "account ": { "$ref": "#/components/schemas/AccountCommonDto" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "description": { "type": "string", "example": "Gasoline for business trip" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/dimension" } }, "documentNumber": { "type": "string", "example": "EXP-12345" }, "exchangeRate": { "type": "number", "example": 1 }, "itemId": { "type": "string", "example": "9fc4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "taxRate": { "type": "object", "$ref": "#/components/schemas/taxRateV2" }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 119 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 100 } } }, "ExpenseRequestAsyncDto": { "type": "object", "properties": { "account ": { "$ref": "#/components/schemas/AccountCommonDto" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "customerId": { "type": "string", "example": "8a32de4f-55cc-4962-b000-a2a20662b821" }, "description": { "type": "string", "example": "Expense_07/25 for business trip" }, "documentId": { "type": "string", "example": "c77fbedb-1ff3-4fed-8716-4d3e3fc85ccf" }, "expenseLines": { "type": "array", "items": { "$ref": "#/components/schemas/expenseLineItemAsyncRequest" } }, "generatorName": { "type": "string", "example": "Maesn GmbH" }, "journalCode": { "type": "string", "example": "60" }, "note": { "type": "string", "example": "Gasoline for business trip" }, "paymentTermId": { "type": "string", "example": "d2f3e4b5-6a7b-8c9d-0e1f-2g3h4i5j6k7l" }, "paymentType": { "type": "string", "enum": [ "CASH", "CHECK", "CREDIT_CARD", "CREDIT", "COLLECTION" ], "example": "CASH" }, "supplierId": { "type": "string", "example": "52c049b9-91b7-4828-b346-e1eeadfa31dd" }, "type": { "type": "string", "enum": [ "EXPENSE", "REFUND" ] }, "totalGrossAmount": { "description": "Gross total — the net amount plus tax (the total payable, including VAT).", "type": "number", "example": 119 }, "totalNetAmount": { "description": "Net total — the sum of all line amounts before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) total — the difference between the gross and net totals.", "type": "number", "example": 5 }, "transactionDate": { "type": "string", "example": "2025-07-15T00:00:00Z" } } }, "TaskIdResponseDto": { "type": "object", "properties": { "taskId": { "type": "string", "example": "02cc5849-b23c-48fe-8a9b-96f74bfc9571" } } }, "OfferResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "9dea18d2-748e-4bda-9f4c-02b08a9622cd" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "contactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/OfferLineItemResponseDto" } }, "name": { "type": "string", "example": "Trey Research" }, "offerDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "offerNumber": { "type": "string", "example": "1001" }, "reference": { "type": "string", "example": "RCXF197253F" }, "status": { "description": "The document's lifecycle status, populated across all source systems. See [Document status fields](/standardization#document-status-fields).", "type": "string", "enum": [ "DRAFT", "SENT", "ACCEPTED", "VOIDED", "DECLINED", "EXPIRED" ], "example": "DRAFT" }, "taxText": { "type": "string", "example": "Tax 19 percent" }, "totalDiscountAmount": { "description": "Total discount applied, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Total discount applied, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross total — the net amount plus tax (the total payable, including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net total — the sum of all line amounts before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) total — the difference between the gross and net totals.", "type": "number", "example": 19 }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" } } }, "CreateOfferRequestDto": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "contactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/CreateOfferLineItemRequestDto" } }, "name": { "type": "string", "example": "Trey Research" }, "offerDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "offerNumber": { "type": "string", "example": "1001" }, "reference": { "type": "string", "example": "RCXF197253F" }, "status": { "type": "string", "enum": [ "DRAFT", "SENT", "ACCEPTED", "VOIDED", "DECLINED", "EXPIRED" ], "example": "DRAFT" }, "taxText": { "type": "string", "example": "Tax 19 percent" }, "totalDiscountAmount": { "description": "Total discount applied, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Total discount applied, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross total — the net amount plus tax (the total payable, including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net total — the sum of all line amounts before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) total — the difference between the gross and net totals.", "type": "number", "example": 19 } } }, "CreateOfferLineItemRequestDto": { "type": "object", "properties": { "accountCode": { "type": "string", "example": "8400" }, "accountId": { "type": "string", "example": "a23cc-334rn-finsd-438m" }, "description": { "type": "string", "example": "SYDNEY Schreibtischstuhl, grün" }, "itemId": { "type": "string", "example": "f9f6653e-5be6-ee11-a201-6045bde98d28" }, "name": { "type": "string", "example": "GREEN CHAIR" }, "quantity": { "type": "number", "example": 1 }, "taxCode": { "type": "string", "example": "CODE.19" }, "taxRatePercentage": { "type": "number", "example": "19" }, "taxType": { "type": "string", "example": "type-19" }, "type": { "type": "string", "enum": [ "COMMENT", "ACCOUNT", "ITEM", "RESOURCE", "VALUE", "FIXED_ASSET", "CHARGE" ], "example": "ITEM" }, "totalDiscountAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Discount applied to the line item, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) amount of the line item.", "type": "number", "example": 19 }, "unitAmount": { "description": "Price per unit, in the document currency.", "type": "number", "example": 100 }, "unitDiscountAmount": { "description": "Discount applied per unit, in the document currency.", "type": "number", "example": 10 }, "unitDiscountPercentage": { "description": "Discount applied per unit, as a percentage.", "type": "number", "example": 10 }, "unitName": { "type": "string", "example": "PIECE" } } }, "OfferLineItemResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "c1f85763-5be6-ee11-a201-6045bde98d28" }, "accountCode": { "type": "string", "example": "8400" }, "accountId": { "type": "string", "example": "a23cc-334rn-finsd-438m" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "description": { "type": "string", "example": "SYDNEY Schreibtischstuhl, grün" }, "itemId": { "type": "string", "example": "f9f6653e-5be6-ee11-a201-6045bde98d28" }, "name": { "type": "string", "example": "GREEN CHAIR" }, "quantity": { "type": "number", "example": 1 }, "taxCode": { "type": "string", "example": "CODE.19" }, "taxRatePercentage": { "type": "number", "example": "19" }, "taxType": { "type": "string", "example": "type-19" }, "type": { "type": "string", "enum": [ "COMMENT", "ACCOUNT", "ITEM", "RESOURCE", "VALUE", "FIXED_ASSET", "CHARGE" ], "example": "ITEM" }, "totalDiscountAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Discount applied to the line item, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) amount of the line item.", "type": "number", "example": 19 }, "unitAmount": { "description": "Price per unit, in the document currency.", "type": "number", "example": 100 }, "unitDiscountAmount": { "description": "Discount applied per unit, in the document currency.", "type": "number", "example": 10 }, "unitDiscountPercentage": { "description": "Discount applied per unit, as a percentage.", "type": "number", "example": 10 }, "unitName": { "type": "string", "example": "STÜCK" }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" } } }, "OfferAddress": { "type": "object", "properties": { "addressLine1": { "type": "string", "example": "Street" }, "addressLine2": { "type": "string", "example": "Building" }, "city": { "type": "string", "example": "City" }, "countryCode": { "type": "string", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "example": "DE" }, "postalCode": { "type": "string", "example": "12345" }, "type": { "type": "string", "enum": [ "BILLING", "DELIVERY" ], "example": "BILLING" } } }, "InformationResponseDto": { "type": "object", "properties": { "filename": { "type": "string", "example": "Invoice_V30" }, "message": { "type": "string", "example": "The document has been received." }, "timestamp": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "type": { "type": "string", "example": "information" } } }, "AsyncTaskResponseDto": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "OPEN", "IN_PROGRESS", "FINISHED", "SUCCESS", "FAILED", "PARTIAL_SUCCESS", "CANCELLED_SUCCESSFULLY", "CANCEL_FAILED", "DELETED" ], "example": "SUCCESS" }, "information": { "type": "array", "items": { "$ref": "#/components/schemas/InformationResponseDto" } }, "responseData": { "type": "object", "$ref": "#/components/schemas/ProjectResponseDto" } } }, "ProjectResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "c1f85763-5be6-ee11-a201-6045bde98d28" }, "code": { "type": "string", "example": "9012" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "contactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "description": { "type": "string", "example": "Service and Maintenance Project" }, "endDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "name": { "type": "string", "example": "Service und Unterhalt" }, "parentProjectId": { "type": "string", "example": "e587bs49-5be6-ee11-a201-6045bde98d28" }, "status": { "type": "string", "enum": [ "ACTIVE", "CLOSED" ], "example": "ACTIVE" }, "startDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" } } }, "CreateProjectRequestDto": { "type": "object", "properties": { "code": { "type": "string", "example": "9012" }, "contactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "description": { "type": "string", "example": "Service and Maintenance Project" }, "endDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "name": { "type": "string", "example": "Service und Unterhalt" }, "parentProjectId": { "type": "string", "example": "e587bs49-5be6-ee11-a201-6045bde98d28" }, "status": { "type": "string", "enum": [ "ACTIVE", "CLOSED" ], "example": "ACTIVE" }, "startDate": { "type": "string", "example": "2021-01-01T00:00:00Z" } } }, "PurchaseOrderLineItemResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "9fc4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "itemId": { "type": "string", "example": "efa82f42-fd85-11e1-a21f-0800200c9a33" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "description": { "type": "string", "example": "SEOUL Guest Chair, red" }, "itemName": { "type": "string", "example": "RED CHAIR" }, "quantity": { "type": "number", "example": 1 }, "taxCode": { "type": "string", "example": "CODE.19" }, "taxRatePercentage": { "type": "number", "example": 19 }, "totalDiscountAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Discount applied to the line item, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) amount of the line item.", "type": "number", "example": 19 }, "unitAmount": { "description": "Price per unit, in the document currency.", "type": "number", "example": 100 }, "unitDiscountAmount": { "description": "Discount applied per unit, in the document currency.", "type": "number", "example": 10 }, "unitDiscountPercentage": { "description": "Discount applied per unit, as a percentage.", "type": "number", "example": 10 }, "unitName": { "type": "string", "example": "PIECE" }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" } } }, "PurchaseOrderResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "f302303e-4365-4779-8685-872b713aeab1" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "approvalDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "comment": { "type": "string", "example": "due today" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "description": { "type": "string", "example": "Red chair order" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderLineItemResponseDto" } }, "orderDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "paymentTermId": { "type": "string", "example": "21" }, "reference": { "type": "string", "example": "RCXF197253F" }, "status": { "description": "The document's lifecycle status, populated across all source systems. See [Document status fields](/standardization#document-status-fields).", "type": "string", "enum": [ "OPEN", "PARTIALLY_FULFILLED", "CLOSED", "CANCELED" ], "example": "OPEN" }, "supplierId": { "type": "string", "example": "8346e541-0a0c-4b45-a2d4-8fba44a99f6c" }, "totalDiscountAmount": { "description": "Total discount applied, in the document currency.", "type": "string", "example": 10 }, "totalDiscountPercentage": { "description": "Total discount applied, as a percentage.", "type": "string", "example": 10 }, "totalGrossAmount": { "description": "Gross total — the net amount plus tax (the total payable, including VAT).", "type": "string", "example": 109 }, "totalNetAmount": { "description": "Net total — the sum of all line amounts before tax (excluding VAT).", "type": "string", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) total — the difference between the gross and net totals.", "type": "string", "example": 19 }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" } } }, "GoodsReceiptLineItemResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "9fc4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "itemId": { "type": "string", "example": "efa82f42-fd85-11e1-a21f-0800200c9a33" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "description": { "type": "string", "example": "SEOUL Guest Chair, red" }, "itemName": { "type": "string", "example": "RED CHAIR" }, "projectId": { "type": "number", "example": "3" }, "purchaseOrderId": { "type": "string", "example": "f302303e-4365-4779-8685-872b713aeab1" }, "quantityOrdered": { "type": "number", "example": 2 }, "quantityReceived": { "type": "number", "example": 2 }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" } } }, "GoodsReceiptResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "f302303e-4365-4779-8685-872b713aeab1" }, "comment": { "type": "string", "example": "due today" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "description": { "type": "string", "example": "Red chair order" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/GoodsReceiptLineItemResponseDto" } }, "reference": { "type": "string", "example": "RCXF197253F" }, "status": { "description": "The document's lifecycle status, populated across all source systems. See [Document status fields](/standardization#document-status-fields).", "type": "string", "enum": [ "OPEN", "PARTIALLY_FULFILLED", "CLOSED", "CANCELED" ], "example": "OPEN" }, "supplierId": { "type": "string", "example": "8346e541-0a0c-4b45-a2d4-8fba44a99f6c" }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" } } }, "SalesOrderLineItemResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "9fc4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "itemId": { "type": "string", "example": "efa82f42-fd85-11e1-a21f-0800200c9a33" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "description": { "type": "string", "example": "SEOUL Guest Chair, red" }, "itemName": { "type": "string", "example": "RED CHAIR" }, "quantity": { "type": "number", "example": 1 }, "taxCode": { "type": "string", "example": "CODE.19" }, "taxRatePercentage": { "type": "number", "example": 19 }, "totalDiscountAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Discount applied to the line item, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) amount of the line item.", "type": "number", "example": 19 }, "unitAmount": { "description": "Price per unit, in the document currency.", "type": "number", "example": 100 }, "unitDiscountAmount": { "description": "Discount applied per unit, in the document currency.", "type": "number", "example": 10 }, "unitDiscountPercentage": { "description": "Discount applied per unit, as a percentage.", "type": "number", "example": 10 }, "unitName": { "type": "string", "example": "PIECE" }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" } } }, "SalesOrderResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "987a2b3c-4d5e-6f7g-8h9i-0j1k2l3m4n5o" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "billingContactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "comment": { "type": "string", "example": "Due today" }, "contactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "deliveryDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderLineItemResponseDto" } }, "oneLineAddress": { "type": "string", "example": "Main street 45, Berlin" }, "orderDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "projectId": { "type": "string", "example": "1" }, "shippingContactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "status": { "description": "The document's lifecycle status, populated across all source systems. See [Document status fields](/standardization#document-status-fields).", "type": "string", "enum": [ "OPEN", "CLOSED", "IN_REVIEW" ], "example": "OPEN" }, "totalDiscountAmount": { "description": "Total discount applied, in the document currency.", "type": "string", "example": 10 }, "totalDiscountPercentage": { "description": "Total discount applied, as a percentage.", "type": "string", "example": 10 }, "totalGrossAmount": { "description": "Gross total — the net amount plus tax (the total payable, including VAT).", "type": "string", "example": 109 }, "totalNetAmount": { "description": "Net total — the sum of all line amounts before tax (excluding VAT).", "type": "string", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) total — the difference between the gross and net totals.", "type": "string", "example": 19 }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "version": { "type": "string", "example": "1" } } }, "CreateSalesOrderLineItemRequestDto": { "type": "object", "properties": { "itemId": { "type": "string", "example": "efa82f42-fd85-11e1-a21f-0800200c9a33" }, "description": { "type": "string", "example": "SEOUL Guest Chair, red" }, "itemName": { "type": "string", "example": "RED CHAIR" }, "lineNumber": { "type": "string", "example": "2" }, "optional": { "type": "boolean", "example": true }, "parentLineNumber": { "type": "string", "example": "1" }, "quantity": { "type": "number", "example": 1 }, "taxCode": { "type": "string", "example": "CODE.19" }, "taxRatePercentage": { "type": "number", "example": 19 }, "totalDiscountAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Discount applied to the line item, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) amount of the line item.", "type": "number", "example": 19 }, "unitAmount": { "description": "Price per unit, in the document currency.", "type": "number", "example": 100 }, "unitDiscountAmount": { "description": "Discount applied per unit, in the document currency.", "type": "number", "example": 10 }, "unitDiscountPercentage": { "description": "Discount applied per unit, as a percentage.", "type": "number", "example": 10 }, "unitName": { "type": "string", "example": "PIECE" } } }, "CreateSalesOrderRequestDto": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "billingContactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "comment": { "type": "string", "example": "Due today" }, "contactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "deliveryDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/CreateSalesOrderLineItemRequestDto" } }, "oneLineAddress": { "type": "string", "example": "Main street 45, Berlin" }, "orderDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "projectId": { "type": "string", "example": "1" }, "shippingContactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "status": { "type": "string", "enum": [ "OPEN", "CLOSED" ], "example": "OPEN" }, "totalDiscountAmount": { "description": "Total discount applied, in the document currency.", "type": "string", "example": 10 }, "totalDiscountPercentage": { "description": "Total discount applied, as a percentage.", "type": "string", "example": 10 }, "totalGrossAmount": { "description": "Gross total — the net amount plus tax (the total payable, including VAT).", "type": "string", "example": 109 }, "totalNetAmount": { "description": "Net total — the sum of all line amounts before tax (excluding VAT).", "type": "string", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) total — the difference between the gross and net totals.", "type": "string", "example": 19 }, "version": { "type": "string", "example": "1" } } }, "CreateCreditNoteLineItemRequestDto": { "type": "object", "properties": { "id": { "type": "string", "example": "9fc4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "description": { "type": "string", "example": "SEOUL Guest Chair, red" }, "itemId": { "type": "string", "example": "4271" }, "itemName": { "type": "string", "example": "RED CHAIR" }, "quantity": { "type": "number", "example": 1 }, "taxCode": { "type": "string", "example": "TAX19" }, "taxRatePercentage": { "type": "number", "example": 19 }, "totalDiscountAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Discount applied to the line item, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) amount of the line item.", "type": "number", "example": 19 }, "type": { "type": "string", "enum": [ "SERVICE_ITEM", "MATERIAL", "CUSTOM", "TEXT" ] }, "unitAmount": { "description": "Price per unit, in the document currency.", "type": "number", "example": 100 }, "unitDiscountAmount": { "description": "Discount applied per unit, in the document currency.", "type": "number", "example": 10 }, "unitDiscountPercentage": { "description": "Discount applied per unit, as a percentage.", "type": "number", "example": 10 }, "unitName": { "type": "string", "example": "PIECE" } } }, "CreateCreditNoteRequestDto": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "contactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "creditNoteDate": { "type": "string", "example": "2025-01-01T00:00:00Z" }, "creditNoteLines": { "type": "array", "items": { "$ref": "#/components/schemas/CreateCreditNoteLineItemRequestDto" } }, "creditNoteNumber": { "type": "string", "example": "PRES1000" }, "currency": { "type": "string", "example": "EUR" }, "paymentStatus": { "type": "string", "example": "PENDING", "enum": [ "NO_OPEN_ITEM", "PENDING", "PAID", "PARTLY_PAID", "CANCELED", "PARTIAL_CANCELLATION", "BAD_DEBT", "DEBITED", "CREDIT_NOTE_CLEARED", "UNKNOWN" ] }, "paymentTermId": { "type": "string", "example": "21" }, "reference": { "type": "string", "example": "RCXF197253F" }, "status": { "type": "string", "example": "DRAFT", "enum": [ "DRAFT", "CORRECTIVE", "SUBMITTED", "DOCUMENT_CREATED", "OPEN", "PARTIALLY_PAID", "PAID", "PARTIALLY_OVERDUE", "OVERDUE", "VOIDED" ] }, "taxRule": { "type": "string", "example": "NET", "enum": [ "NET", "TAXFREE", "INTRACOMMUNITY_GOODS", "INTRACOMMUNITY_SERVICE", "EXPORT_SERVICE", "EXPORT_GOODS", "REVERSE_CHARGE", "GROSS", "CONSTRUCTION_SERVICE", "PHOTOVOLTAIC_EQUIPMENT", "SMALL_BUSINESS_EXEMPTION", "NON_DOMESTIC_SERVICE", "OSS_GOODS", "OSS_ELECTRONIC_SERVICES", "OSS_SERVICES" ] }, "totalDiscountAmount": { "description": "Total discount applied, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Total discount applied, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross total — the net amount plus tax (the total payable, including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net total — the sum of all line amounts before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) total — the difference between the gross and net totals.", "type": "number", "example": 19 } } }, "CreditNoteLineItemResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "9fc4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "createdDate": { "type": "string", "example": "2025-01-01T00:00:00Z" }, "description": { "type": "string", "example": "SEOUL Guest Chair, red" }, "itemId": { "type": "string", "example": "4271" }, "itemName": { "type": "string", "example": "RED CHAIR" }, "quantity": { "type": "number", "example": 1 }, "taxCode": { "type": "string", "example": "TAX19" }, "taxRatePercentage": { "type": "number", "example": 19 }, "totalDiscountAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 10 }, "totalDiscountPercentage": { "description": "Discount applied to the line item, as a percentage.", "type": "number", "example": 10 }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 109 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) amount of the line item.", "type": "number", "example": 19 }, "type": { "type": "string", "enum": [ "SERVICE_ITEM", "MATERIAL", "CUSTOM", "TEXT" ], "example": "SERVICE_ITEM" }, "unitAmount": { "description": "Price per unit, in the document currency.", "type": "number", "example": 100 }, "unitDiscountAmount": { "description": "Discount applied per unit, in the document currency.", "type": "number", "example": 10 }, "unitDiscountPercentage": { "description": "Discount applied per unit, as a percentage.", "type": "number", "example": 10 }, "unitName": { "type": "string", "example": "PIECE" }, "updatedDate": { "type": "string", "example": "2025-01-01T00:00:00Z" } } }, "CreditNoteResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "987a2b3c-4d5e-6f7g-8h9i-0j1k2l3m4n5o" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "contactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "createdDate": { "type": "string", "example": "2025-01-01T00:00:00Z" }, "creditNoteDate": { "type": "string", "example": "2025-01-01T00:00:00Z" }, "creditNoteLines": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNoteLineItemResponseDto" } }, "creditNoteNumber": { "type": "string", "example": "PRES1000" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "paymentStatus": { "description": "Best-effort payment/open-item status. Only populated by some source systems; `null` for all others. Prefer `status` for reliable lifecycle logic, and always handle the `null` case. See [Document status fields](/standardization#document-status-fields).", "type": "string", "example": "PENDING", "enum": [ "NO_OPEN_ITEM", "PENDING", "PAID", "PARTLY_PAID", "CANCELED", "PARTIAL_CANCELLATION", "BAD_DEBT", "DEBITED", "CREDIT_NOTE_CLEARED", "UNKNOWN" ] }, "paymentTermId": { "type": "string", "example": "21" }, "reference": { "type": "string", "example": "RCXF197253F" }, "status": { "description": "The document's lifecycle status, populated across all source systems. Use this as the authoritative state for lifecycle and paid/unpaid logic; prefer it over the best-effort `paymentStatus`. See [Document status fields](/standardization#document-status-fields).", "type": "string", "example": "DRAFT", "enum": [ "DRAFT", "CORRECTIVE", "SUBMITTED", "DOCUMENT_CREATED", "OPEN", "PARTIALLY_PAID", "PAID", "PARTIALLY_OVERDUE", "OVERDUE", "VOIDED" ] }, "taxRatePercentage": { "type": "number", "example": 19 }, "taxRule": { "type": "string", "enum": [ "NET", "TAXFREE", "INTRACOMMUNITY_GOODS", "INTRACOMMUNITY_SERVICE", "EXPORT_SERVICE", "EXPORT_GOODS", "REVERSE_CHARGE", "GROSS", "CONSTRUCTION_SERVICE", "PHOTOVOLTAIC_EQUIPMENT", "SMALL_BUSINESS_EXEMPTION", "NON_DOMESTIC_SERVICE", "OSS_GOODS", "OSS_ELECTRONIC_SERVICES", "OSS_SERVICES" ], "example": "NET" }, "totalDiscountAmount": { "description": "Total discount applied, in the document currency.", "type": "string", "example": 10 }, "totalDiscountPercentage": { "description": "Total discount applied, as a percentage.", "type": "string", "example": 10 }, "totalGrossAmount": { "description": "Gross total — the net amount plus tax (the total payable, including VAT).", "type": "string", "example": 109 }, "totalNetAmount": { "description": "Net total — the sum of all line amounts before tax (excluding VAT).", "type": "string", "example": 100 }, "totalTaxAmount": { "description": "Tax (VAT) total — the difference between the gross and net totals.", "type": "string", "example": 19 }, "updatedDate": { "type": "string", "example": "2025-01-01T00:00:00Z" } } }, "PaymentTermResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "08d52c49-b90c-4328-b1ec-623df74f904a" }, "code": { "type": "string", "example": "1" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "description": { "type": "string", "example": "31 dagen" }, "discountDays": { "type": "number", "example": 10 }, "discountDays2": { "type": "number", "example": 14 }, "discountPercentage": { "type": "number", "example": 5 }, "discountPercentage2": { "type": "number", "example": 3 }, "discountPeriods": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountPeriod" } }, "dueType": { "type": "string", "enum": [ "DUE_IN_DAYS", "DUE_AS_PERIOD" ] }, "name": { "type": "string", "example": "31 DAYS" }, "paymentDays": { "type": "number", "example": 31 }, "paymentMethod": { "type": "string", "enum": [ "CASH", "BANK_TRANSFER", "PAYMENT_SERVICE_PROVIDER", "AUTOMATIC_BANK_WITHDRAWAL" ], "example": "BANK_TRANSFER" }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" } } }, "PaymentTermRequestDto": { "type": "object", "properties": { "code": { "type": "string", "example": "1" }, "description": { "type": "string", "example": "31 dagen" }, "discountDays": { "type": "number", "example": 10 }, "discountDays2": { "type": "number", "example": 14 }, "discountPercentage": { "type": "number", "example": 5 }, "discountPercentage2": { "type": "number", "example": 3 }, "discountPeriods": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountPeriod" } }, "dueType": { "type": "string", "enum": [ "DUE_IN_DAYS", "DUE_AS_PERIOD" ] }, "name": { "type": "string", "example": "31 DAYS" }, "paymentDays": { "type": "number", "example": 31 }, "paymentMethod": { "type": "string", "enum": [ "CASH", "BANK_TRANSFER", "PAYMENT_SERVICE_PROVIDER", "AUTOMATIC_BANK_WITHDRAWAL" ], "example": "BANK_TRANSFER" } } }, "DiscountPeriod": { "type": "object", "properties": { "invoiceRange": { "type": "string", "example": "Invoice issuance range up to day 5 of the month" }, "discountDeadline": { "type": "string", "example": "Day 15 of the current month" }, "discountDeadline2": { "type": "string", "example": "Day 25 of the current month" }, "paymentDeadline": { "type": "string", "example": "Day 30 of the current month" } } }, "TaxRateResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "b0450a0a-4164-4b5a-b006-1f3e835c32ff" }, "code": { "type": "string", "example": "02" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "description": { "type": "string", "example": "BTW hoog tarief, exclusief" }, "name": { "type": "string", "example": "21 PERCENT" }, "percentage": { "type": "number", "example": 21 }, "type": { "type": "string", "enum": [ "INCLUSIVE", "EXCLUSIVE", "ZERO_TAX", "NO_TAX" ] }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "usage": { "type": "string", "enum": [ "INVOICE", "BILL", "JOURNAL_ENTRY", "ALL" ] } } }, "CreateBookingProposalRequestDto": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/AddressBookingProposal" } }, "bankAccountId": { "type": "string", "example": "5a6b7f5dw45c1c-403e-ad56-202fbc312414" }, "bankAccountNumber": { "type": "number", "example": 5407324931 }, "bankCode": { "type": "string", "example": "50010517" }, "bic": { "type": "string", "example": "DEUTDEFF" }, "bookingProposalDate": { "type": "string", "example": "2025-07-14T00:00:00Z" }, "contactAccountNumber": { "type": "number", "example": 70000 }, "contactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "contactName": { "type": "string", "example": "John Doe" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "deliveryDate": { "type": "string", "example": "2025-07-26T00:00:00Z" }, "discountPaymentDate": { "type": "string", "example": "2025-07-16T00:00:00Z" }, "discountPaymentDate2": { "type": "string", "example": "2025-07-18T00:00:00Z" }, "dueDate": { "type": "string", "example": "2025-07-24T00:00:00Z" }, "journalCode": { "type": "string", "example": "60" }, "iban": { "type": "string", "example": "DE43100500000920018963" }, "isPaymentOrder": { "type": "boolean", "example": "true" }, "ledgerName": { "type": "string", "example": "Payroll" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/BookingProposalLineItemRequest" } }, "notes":{ "type": "string", "example": "Bill for maintenance services" }, "number": { "type": "string", "example": "1233330" }, "orderId": { "type": "string", "example": "3344566" }, "paidDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "paymentTermsId":{ "type": "string", "example": "03" }, "status": { "type": "string", "enum": [ "DRAFT", "OPEN" ], "example": "DRAFT" }, "totalGrossAmount": { "description": "Gross total — the net amount plus tax (the total payable, including VAT).", "type": "number", "example": 500 }, "useCollectiveContact": { "type": "boolean", "example": true }, "vatId": { "type": "string", "example": "DE987654321" } } }, "FolderManagementDto": { "type": "object", "properties": { "category": { "type": "string", "example": "Accounting" }, "folder": { "type": "string", "example": "Invoices" }, "register": { "type": "string", "example": "2025 January" } } }, "AddressBookingProposal": { "type": "object", "properties": { "city": { "type": "string", "example": "city" } } }, "BookingProposalLineItemRequest": { "type": "object", "properties": { "accountCode": { "type": "string", "example": "200" }, "accountId": { "type": "string", "example": "db32-4f56-8a9b-1234567890ab" }, "accountName": { "type": "string", "example": "EXPENSE" }, "accountNumber": { "type": "number", "example": 4900 }, "bookingTaxCode": { "type": "string", "example": "9" }, "description": { "type": "string", "example": "Item A" }, "dimension1": { "type": "string", "example": "Marketing" }, "dimension2": { "type": "string", "example": "Service and Maintenance" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/DimensionCommonDto" } }, "discountAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 100 }, "discountAmount2": { "type": "number", "example": 50 }, "discountPercentage": { "type": "number", "example": 20 }, "discountPercentage2": { "type": "number", "example": 10 }, "taxCode": { "type": "string", "example": "02" }, "taxRatePercentage": { "type": "number", "example": 19 }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 500 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 450 }, "type": { "type": "string", "enum": [ "GOODS", "SERVICES" ], "example": "SERVICES" } } }, "BookingProposalResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "BP-12345" }, "addresses ": { "type": "array", "items": { "$ref": "#/components/schemas/AddressBookingProposal" } }, "bankAccountId": { "type": "string", "example": "5a6b7f5dw45c1c-403e-ad56-202fbc312414" }, "bankAccountNumber": { "type": "number", "example": 5407324931 }, "bankCode": { "type": "string", "example": "50010517" }, "bic": { "type": "string", "example": "DEUTDEFF" }, "bookingProposalDate": { "type": "string", "example": "2025-07-14T00:00:00Z" }, "bookingType": { "type": "string", "enum": [ "INVOICE", "BILL", "CREDIT_CARD", "EXPENSE", "CREDIT_NOTE", "BILL_CREDIT_NOTE", "INVOICE_CREDIT_NOTE", "DOWN_PAYMENT", "OTHER" ], "example": "INVOICE" }, "contactAccountNumber": { "type": "number", "example": 70000 }, "contactId": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "contactName ": { "type": "string", "example": "John Doe" }, "createdDate": { "type": "string", "example": "2025-07-16T00:00:00Z" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "deliveryDate": { "type": "string", "example": "2025-07-26T00:00:00Z" }, "discountPaymentDate": { "type": "string", "example": "2025-07-16T00:00:00Z" }, "discountPaymentDate2": { "type": "string", "example": "2025-07-18T00:00:00Z" }, "dueDate": { "type": "string", "example": "2025-07-24T00:00:00Z" }, "files": { "type": "array", "items": { "type": "string", "example": "file1.pdf" } }, "journalCode": { "type": "string", "example": "60" }, "iban": { "type": "string", "example": "DE43100500000920018963" }, "isPaymentOrder": { "type": "boolean", "example": "true" }, "ledgerName": { "type": "string", "example": "Payroll" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/BookingProposalLineItemResponse" } }, "notes":{ "type": "string", "example": "Bill for maintenance services" }, "number": { "type": "string", "example": "1233330" }, "orderId": { "type": "string", "example": "3344566" }, "paidDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "paymentTermsId": { "type": "string", "example": "03" }, "status": { "type": "string", "enum": [ "DRAFT", "SUBMITTED", "OPEN", "PAID", "PARTIALLY_PAID", "VOIDED", "CANCELLED", "OVERDUE", "DISPUTED" ], "example": "DRAFT" }, "taskId": { "type": "string", "example": "ADHUR74BCBSW8399DCN" }, "totalGrossAmount": { "description": "Gross total — the net amount plus tax (the total payable, including VAT).", "type": "number", "example": 500 }, "updatedDate": { "type": "string", "example": "2025-07-16T00:00:00Z" }, "vatId": { "type": "string", "example": "DE987654321" } } }, "BookingProposalLineItemResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "Item-112233" }, "accountCode": { "type": "string", "example": "200" }, "accountId": { "type": "string", "example": "db32-4f56-8a9b-1234567890ab" }, "accountName": { "type": "string", "example": "EXPENSE" }, "accountNumber": { "type": "number", "example": 4900 }, "bookingTaxCode": { "type": "string", "example": "9" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "description": { "type": "string", "example": "Item A" }, "dimension1": { "type": "string", "example": "Marketing" }, "dimension2": { "type": "string", "example": "Service and Maintenance" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/DimensionCommonDto" } }, "discountAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 100 }, "discountAmount2": { "type": "number", "example": 50 }, "discountPercentage": { "type": "number", "example": 20 }, "discountPercentage2": { "type": "number", "example": 10 }, "taxCode": { "type": "string", "example": "02" }, "taxRatePercentage": { "type": "number", "example": 19 }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 500 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 450 }, "type": { "type": "string", "enum": [ "GOODS", "SERVICES" ], "example": "SERVICES" }, "updatedDate": { "type": "string", "example": "2021-01-01T00:00:00Z" } } }, "BookingsRequestDto": { "type": "object", "properties": { "accounNumbertLength": { "type": "number", "example": "4" }, "chartOfAccount": { "type": "string", "enum": [ "SKR03", "SKR04", "SKR42", "SKR51", "SKR14" ], "example": "SKR03" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/BookingEntriesRequestDto" } }, "fiscalYearStartDate": { "type": "string", "example": "2025-01-01" } } }, "BookingEntriesRequestDto": { "type": "object", "properties": { "accountNumber": { "type": "number", "example": "70000" }, "amount": { "type": "number", "example": "1500" }, "bookingDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "bookingTaxCode": { "type": "string", "example": "9" }, "bookingType": { "type": "string", "enum": [ "PARTIAL_INVOICE", "ADVANCED_PAYMENT_RECEIVED", "FINAL_INVOICE", "OTHER" ], "example": "PARTIAL_INVOICE" }, "contraAccountNumber": { "type": "number", "example": "4900" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "debitCreditIndicator": { "type": "string", "enum": [ "CREDIT", "DEBIT" ] }, "description": { "type": "string", "example": "payment" }, "dimension1": { "type": "string", "example": "Marketing" }, "dimension2": { "type": "string", "example": "Service and Maintenance" }, "documentNumber": { "type": "string", "example": "Rg32029/2024" }, "dueDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "fileId": { "type": "string", "example": "AA7N4ICJ0SJIU38" } } }, "BookingsResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "433445" }, "accountNumberLength": { "type": "number", "example": "4" }, "chartOfAccount": { "type": "string", "enum": [ "SKR03", "SKR04", "SKR42", "SKR51", "SKR14" ], "example": "SKR03" }, "createdDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/BookingEntriesResponseDto" } }, "fiscalYearStartDate": { "type": "string", "example": "2025-01-01" }, "taskId": { "type": "string", "example": "ABBDU8834993NND" } } }, "BookingEntriesResponseDto": { "type": "object", "properties": { "accountNumber": { "type": "number", "example": "70000" }, "amount": { "type": "number", "example": "1500" }, "bookingDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "bookingTaxCode": { "type": "string", "example": "9" }, "bookingType": { "type": "string", "enum": [ "PARTIAL_INVOICE", "ADVANCED_PAYMENT_RECEIVED", "FINAL_INVOICE", "OTHER" ], "example": "PARTIAL_INVOICE" }, "contraAccountNumber": { "type": "number", "example": "4900" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "debitCreditIndicator": { "type": "string", "enum": [ "CREDIT", "DEBIT" ] }, "description": { "type": "string", "example": "payment" }, "dimension1": { "type": "string", "example": "Marketing" }, "dimension2": { "type": "string", "example": "Service and Maintenance" }, "documentNumber": { "type": "string", "example": "Rg32029/2024" }, "dueDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "fileId": { "type": "string", "example": "AA7N4ICJ0SJIU38" } } }, "CreateJournalEntriesByBatchMetaDataDto": { "type": "object", "properties": { "accountNumberLength": { "type": "number", "example": "4" }, "chartOfAccount": { "type": "string", "enum": [ "SKR03", "SKR04", "SKR07", "SKR42", "SKR51", "SKR14" ], "example": "SKR03" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntryBatchRequestDto" } }, "fiscalYearStartDate": { "type": "string", "example": "2025-01-01" } } }, "JournalEntryBatchRequestDto": { "type": "object", "properties": { "accountId": { "type": "string", "example": "d1bfd23-517d-4ec6-b7d4-56f86c7cf246" }, "accountingPeriodId": { "type": "string", "example": "2025-06" }, "accountingReason": { "type": "string", "enum": [ "COMMERCIAL", "TAX", "IFRS", "CALCULATION", "INDEPENDENT", "OTHER" ], "example": "COMMERCIAL" }, "additionalInformation": { "type": "string", "example": "invoice reference-d1bfd2" }, "advancePayment": { "$ref": "#/components/schemas/AdvancePayment" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "debitCreditIndicator": { "type": "string", "enum": [ "DEBIT", "CREDIT" ], "example": "DEBIT" }, "deliveryDate": { "type": "string", "example": "2025-06-04T00:00:00Z" }, "description": { "type": "string", "example": "Invoice-3486 for services" }, "documentId": { "type": "string", "example": "b5e624e5-fb9e-4836-a443-87a3820f5b48" }, "dueDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "exchangeRate": { "type": "string", "example": "1,2045" }, "isProvisional": { "type": "boolean", "example": "false" }, "isReversal": { "type": "boolean", "example": false }, "journalLineItems": { "type": "array", "items": { "$ref": "#/components/schemas/JournalLineItemBatchRequestDto" } }, "journalCode": { "type": "string", "example": "60" }, "journalType": { "type": "string", "example": "FIN" }, "number ": { "type": "string", "example": "21900030" }, "recordType": { "type": "string", "enum": [ "STANDARD", "CLOSING", "OPENING" ], "example": "STANDARD" }, "taxAssignmentDate": { "type": "string", "example": "2025-06-04T00:00:00Z" }, "transactionDate": { "type": "string", "example": "2025-06-01T00:00:00Z" }, "version": { "type": "string", "example": "AAAAACnY3os1" } } }, "JournalLineItemBatchRequestDto": { "type": "object", "properties": { "id": { "type": "string", "example": "123f57fd-13ae-47a6-8a2a-000e6ddc60d9" }, "accountId": { "type": "string", "example": "94fdb7fd-13ae-47a6-8a2a-000e6ddc60d9" }, "accountCode": { "type": "string", "example": "4034" }, "accountNumber": { "type": "string", "example": "70001" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "customerId": { "type": "string", "example": "782d89b56-13ae-47a6-8a2a-45e6ddc50d9" }, "debitCreditIndicator": { "type": "string", "enum": [ "DEBIT", "CREDIT" ], "example": "DEBIT" }, "description": { "type": "string", "example": "Uitgesteld 21600001 Kantoor 06-2025" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/dimension" } }, "discountAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 12.12 }, "documentId": { "type": "string", "example": "b5e624e5-fb9e-4836-a443-87a3820f5b48" }, "documentNumber": { "type": "string", "example": "123456789" }, "exchangeRate": { "type": "number", "example": 1 }, "supplierId": { "type": "string", "example": "998933b56-13ae-47a6-8a32a-45e6ddc50d9" }, "taxRate": { "type": "object", "$ref": "#/components/schemas/taxRate" }, "thirdPartyCode": { "type": "string", "example": "112233" }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 1190 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 1000 }, "totalTaxAmount": { "description": "Tax (VAT) amount of the line item.", "type": "number", "example": 190 } } }, "JournalEntriesByBatchMetaDataResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "433445" }, "accountNumberLength": { "type": "number", "example": "4" }, "chartOfAccount": { "type": "string", "enum": [ "SKR03", "SKR04", "SKR07", "SKR42", "SKR51", "SKR14" ], "example": "SKR03" }, "createdDate": { "type": "string", "example": "2025-06-01T00:00:00Z" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntryBatchResponseDto" } }, "fiscalYearStartDate": { "type": "string", "example": "2025-01-01" }, "taskId": { "type": "string", "example": "ABBDU8834993NND" } } }, "JournalEntryBatchResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "8df2df10-0fae-40ad-9d22-f25e5ab0ba23" }, "accountId": { "type": "string", "example": "94fdb7fd-13ae-47a6-8a2a-000e6ddc60d9" }, "accountingPeriodId": { "type": "string", "example": "2025-06" }, "accountingReason": { "type": "string", "enum": [ "COMMERCIAL", "TAX", "IFRS", "CALCULATION", "INDEPENDENT", "OTHER" ], "example": "COMMERCIAL" }, "additionalInformation": { "type": "string", "example": "invoice reference-d1bfd2" }, "advancePayment": { "$ref": "#/components/schemas/AdvancePayment" }, "createdDate": { "type": "string", "example": "2025-06-01T00:00:00Z" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "debitCreditIndicator": { "type": "string", "enum": [ "DEBIT", "CREDIT" ], "example": "DEBIT" }, "deliveryDate": { "type": "string", "example": "2025-06-04T00:00:00Z" }, "description": { "type": "string", "example": "Invoice-3486 for services" }, "documentId": { "type": "string", "example": "b5e624e5-fb9e-4836-a443-87a3820f5b48" }, "dueDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "exchangeRate": { "type": "string", "example": "1,2045" }, "files": { "type": "array", "items": { "type": "string", "example": "file1.pdf" } }, "isProvisional": { "type": "boolean", "example": "false" }, "isReversal": { "type": "boolean", "example": false }, "journalLineItems": { "type": "array", "items": { "$ref": "#/components/schemas/journalLineItemBatchResponseDto" } }, "journalCode": { "type": "string", "example": "60" }, "journalType": { "type": "string", "example": "FIN" }, "number ": { "type": "string", "example": "21900030" }, "recordType": { "type": "string", "enum": [ "STANDARD", "CLOSING", "OPENING" ], "example": "STANDARD" }, "taxAssignmentDate": { "type": "string", "example": "2025-06-04T00:00:00Z" }, "transactionDate": { "type": "string", "example": "2025-06-01T00:00:00Z" }, "updatedDate": { "type": "string", "example": "2025-06-01T00:00:00Z" }, "version": { "type": "string", "example": "AAAAACnY3os1" } } }, "journalLineItemBatchResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "94fdb7fd-13ae-47a6-8a2a-000e6ddc60d9" }, "accountId": { "type": "string", "example": "da33b47c-98ca-4410-9c59-5db485ecaeb0" }, "accountCode": { "type": "string", "example": "4034" }, "accountNumber": { "type": "number", "example": 70001 }, "createdDate ": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "customerId": { "type": "string", "example": "782d89b56-13ae-47a6-8a2a-45e6ddc50d9" }, "debitCreditIndicator": { "type": "string", "enum": [ "DEBIT", "CREDIT" ], "example": "DEBIT" }, "description": { "type": "string", "example": "Uitgesteld 21600001 Kantoor 06-2025" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/dimension" } }, "discountAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 12.12 }, "documentId": { "type": "string", "example": "b5e624e5-fb9e-4836-a443-87a3820f5b48" }, "documentNumber": { "type": "string", "example": "123456789" }, "exchangeRate": { "type": "number", "example": 1 }, "supplierId": { "type": "string", "example": "998933b56-13ae-47a6-8a32a-45e6ddc50d9" }, "taxRate": { "type": "object", "$ref": "#/components/schemas/taxRate" }, "thirdPartyCode": { "type": "string", "example": "112233" }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 1190 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 1000 }, "totalTaxAmount": { "description": "Tax (VAT) amount of the line item.", "type": "number", "example": 190 }, "updatedDate": { "type": "string", "example": "2025-06-01T00:00:00Z" } } }, "AdvancePayment": { "type": "object", "properties": { "orderNumber": { "type": "string", "example": "Order-21900030" }, "type": { "type": "string", "enum": [ "ADVANCE_INVOICE_REQUESTED", "ADVANCE_PAYMENT_RECEIVED", "ADVANCE_LIABILITY_TRANSFER", "FINAL_INVOICE", "FINAL_INVOICE_CLEARING", "FINAL_PAYMENT_RECEIVED", "OTHER" ], "example": "FINAL_INVOICE" } } }, "CreateContactByBatchMetaDataDto": { "type": "object", "properties": { "accountNumberLength": { "type": "number", "example": 4 }, "chartOfAccount": { "type": "string", "enum": [ "SKR03", "SKR04", "SKR07", "SKR42", "SKR51", "SKR14" ], "example": "SKR03" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/ContactEntriesRequestDto" } }, "fiscalYearStartDate": { "type": "string", "example": "2025-01-01" } } }, "ContactEntriesRequestDto" : { "type": "object", "properties": { "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/ContactAddress" } }, "accountNumber": { "type": "number", "example": 70000 }, "bankAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/BankAccount" } }, "companyName": { "type": "string", "example": "maesn" }, "contactPersons": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPersonRequest" }, "example": "[]" }, "contactType": { "type": "string", "enum": [ "CONTACT_PERSON", "COMPANY" ], "example": "COMPANY" }, "emailAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/ContactEmail" } }, "number": { "type": "string", "example": "1042" }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPhone" } }, "projectId": { "type": "string", "example": "3" }, "vatId": { "type": "string", "example": "DE33445672452" } } }, "ContactByBatchMetaDataResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "433445" }, "accountNumberLength": { "type": "number", "example": 4 }, "chartOfAccount": { "type": "string", "enum": [ "SKR03", "SKR04", "SKR07", "SKR42", "SKR51", "SKR14" ], "example": "SKR03" }, "createdDate": { "type": "string", "example": "2025-04-06T00:00:00Z" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/ContactEntriesResponseDto" } }, "fiscalYearStartDate": { "type": "string", "example": "2025-01-01" }, "taskId": { "type": "string", "example": "ABBDU8834993NND" } } }, "ContactEntriesResponseDto" : { "type": "object", "properties": { "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/ContactAddress" } }, "accountNumber": { "type": "number", "example": 70000 }, "bankAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/BankAccount" } }, "companyName": { "type": "string", "example": "maesn" }, "contactPersons": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPersonRequest" }, "example": "[]" }, "contactType": { "type": "string", "enum": [ "CONTACT_PERSON", "COMPANY" ], "example": "COMPANY" }, "emailAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/ContactEmail" } }, "number": { "type": "string", "example": "1042" }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPhone" } }, "projectId": { "type": "string", "example": "3" }, "vatId": { "type": "string", "example": "DE33445672452" } } }, "BankAccountResponseDto": { "type": "object", "properties": { "id": { "type": "string" }, "balance": { "type": "number" }, "bankName": { "type": "string" }, "bic": { "type": "string" }, "createdDate": { "type": "string" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ] }, "description": { "type": "string" }, "fileType": { "type": "string", "enum": [ "CSV", "MT940" ] }, "iban": { "type": "string" }, "name": { "type": "string" }, "number": { "type": "string" }, "system": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED" ] }, "type": { "type": "string", "enum": [ "CREDIT_CARD", "GIRO", "PAYMENT_PROVIDER", "CURRENT_ASSET", "OTHER" ] }, "updatedDate": { "type": "string" } } }, "CreateBankAccountRequestDto": { "type": "object", "properties": { "balance": { "type": "number" }, "bankName": { "type": "string" }, "bic": { "type": "string" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ] }, "description": { "type": "string" }, "fileType": { "type": "string", "enum": [ "CSV", "MT940" ] }, "iban": { "type": "string" }, "name": { "type": "string" }, "number": { "type": "string" }, "system": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED" ] }, "type": { "type": "string", "enum": [ "CREDIT_CARD", "GIRO", "PAYMENT_PROVIDER", "CURRENT_ASSET", "OTHER" ] } } }, "OpenItemResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "8df2df10-0fae-40ad-9d22-f25e5ab0ba23" }, "accountId": { "type": "string", "example": "10fae-40ad-9d2df2df10-9d22-f44f5ab3eu" }, "accountName": { "type": "string", "example": "Vendor ABC" }, "accountNumber": { "type": "string", "example": "100100000" }, "createdDate": { "type": "string", "example": "2025-06-01T00:00:00Z" }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "documentNumber": { "type": "string", "example": "INV-1" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/OpenItemEntryResponseDto" } }, "openBalance": { "$ref": "#/components/schemas/Balance" }, "postingDate": { "type": "string", "example": "2025-06-01T00:00:00Z" }, "totalCreditAmount": { "type": "number", "example": 0 }, "totalDebitAmount": { "type": "number", "example": 1000 }, "type": { "type": "string", "enum": [ "BILL", "INVOICE" ] }, "updatedDate": { "type": "string", "example": "2025-06-12T00:00:00Z" } } }, "OpenItemEntryResponseDto": { "type": "object", "properties": { "amount": { "type": "number", "example": 1000 }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GQE", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZM", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEB", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZWR" ], "example": "EUR" }, "debitCreditIndicator": { "type": "string", "enum": [ "DEBIT", "CREDIT" ], "example": "DEBIT" }, "description": { "type": "string", "example": "Hotel stay" }, "dueDate": { "type": "string", "example": "2025-06-21T00:00:00Z" }, "postingDate": { "type": "string", "example": "2025-06-01T00:00:00Z" } } }, "Balance": { "type": "object", "properties": { "amount": { "type": "number", "example": 1000 }, "debitCreditIndicator": { "type": "string", "enum": [ "DEBIT", "CREDIT" ], "example": "DEBIT" } } }, "TrialBalanceResponseDto": { "type": "object", "properties": { "accountCode": { "type": "string" }, "accountName": { "type": "string" }, "accountNumber": { "type": "string" }, "balance": { "$ref": "#/components/schemas/Balance" }, "createdDate": { "type": "string" }, "monthlyValues": { "type": "array", "items": { "$ref": "#/components/schemas/MonthlyValue" } }, "openingBalance": { "$ref": "#/components/schemas/Balance" }, "totalCreditAmount": { "type": "number" }, "totalDebitAmount": { "type": "number" }, "updatedDate": { "type": "string" } }, "example": { "accountCode": "0005", "accountName": "Cash", "accountNumber": "120000", "balance": { "amount": 1000, "debitCreditIndicator": "DEBIT" }, "createdDate": "2025-06-12T00:00:00Z", "monthlyValues": [ { "month": 1, "balance": { "amount": 200, "debitCreditIndicator": "DEBIT" } }, { "month": 2, "balance": { "amount": 300, "debitCreditIndicator": "DEBIT" } } ], "openingBalance": { "amount": 500, "debitCreditIndicator": "DEBIT" }, "totalCreditAmount": 0, "totalDebitAmount": 500, "updatedDate": "2025-06-12T00:00:00Z" } }, "MonthlyValue": { "type": "object", "properties": { "month": { "type": "number" }, "balance": { "$ref": "#/components/schemas/Balance" } } }, "CreateWebhookRequestDto": { "type": "object", "properties": { "callbackUrl": { "type": "string", "example": "https://example.com/webhook-endpoint/12345" }, "eventType": { "type": "string", "enum": [ "ACCOUNT", "BANK_ACCOUNT", "BILL", "CONTACT", "CREDIT_NOTE", "CUSTOMER", "DIMENSION", "EXPENSE", "INVOICE", "ITEM", "JOURNAL_ENTRY", "OFFER", "PAYMENT", "SALES_ORDER", "SUPPLIER", "TAX_RATE", "TOKEN" ] }, "resource": { "type": "string", "enum": [ "CREATED", "DELETED", "REVOKED", "UPDATED" ] } } }, "WebhookResponseDtoWithSecret": { "type": "object", "properties": { "id": { "type": "string", "example": "94fdb7fd-13ae-47a6-8a2a-000e6ddc60d9" }, "callbackUrl": { "type": "string", "example": "https://example.com/webhook-endpoint/12345" }, "createdDate": { "type": "string", "example": "2025-06-01T00:00:00Z" }, "expiresDate": { "type": "string", "example": "2026-06-01T00:00:00Z" }, "secret": { "type": "string", "example": "0f9cfb7fe655d00547fa0720ed4fa1777d6ad1a8e3f94c3b16991e7ceaa5a59c" }, "updatedDate": { "type": "string", "example": "2025-06-01T00:00:00Z" } } }, "WebhookResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "94fdb7fd-13ae-47a6-8a2a-000e6ddc60d9" }, "callbackUrl": { "type": "string", "example": "https://example.com/webhook-endpoint/12345" }, "createdDate": { "type": "string", "example": "2025-06-01T00:00:00Z" }, "expiresDate": { "type": "string", "example": "2026-06-01T00:00:00Z" }, "updatedDate": { "type": "string", "example": "2025-06-01T00:00:00Z" } } }, "ContactResponseDtoV2": { "type": "object", "properties": { "id": { "type": "string", "example": "92c4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/ContactAddressV2" } }, "bankAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/BankAccountCommonDto" } }, "businessRegistrationNumber": { "type": "string", "example": "12345678" }, "companyName": { "type": "string", "example": "maesn" }, "contactPersons": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPersonV2" } }, "contactType": { "type": "string", "enum": [ "CONTACT_PERSON", "COMPANY" ], "example": "CONTACT_PERSON" }, "createdDate": { "type": "string", "example": "2025-06-01T11:09:11.533Z" }, "emailAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/ContactEmailV2" } }, "isCustomer": { "type": "boolean", "example": true }, "isSupplier": { "type": "boolean", "example": false }, "number": { "type": "string", "example": "1042" }, "parentId": { "type": "string", "example": "3b1e4c72-9d8a-42f5-9c6b-1a7f0e5d8c34" }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPhoneV2" } }, "projectId": { "type": "string", "example": "3" }, "updatedDate": { "type": "string", "example": "2025-06-01T11:09:11.533Z" }, "vatId": { "type": "string", "example": "DE123456789" }, "website": { "type": "string", "example": "https://www.maesn.com" } } }, "ContactRequestDtoV2": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/ContactAddressV2" } }, "bankAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/BankAccountCommonDto" } }, "businessRegistrationNumber": { "type": "string", "example": "12345678" }, "companyName": { "type": "string", "example": "maesn" }, "contactPersons": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPersonV2Request" } }, "contactType": { "type": "string", "enum": [ "CONTACT_PERSON", "COMPANY" ], "example": "CONTACT_PERSON" }, "emailAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/ContactEmailV2" } }, "isCustomer": { "type": "boolean", "example": true }, "isSupplier": { "type": "boolean", "example": false }, "number": { "type": "string", "example": "1042" }, "parentId": { "type": "string", "example": "3b1e4c72-9d8a-42f5-9c6b-1a7f0e5d8c34" }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPhoneV2" } }, "projectId": { "type": "string", "example": "3" }, "vatId": { "type": "string", "example": "DE123456789" }, "website": { "type": "string", "example": "https://www.maesn.com" } }, "required": [ "contactType" ] }, "ContactAddressV2": { "type": "object", "properties": { "addressLine1": { "type": "string", "example": "Lucky street 1" }, "addressLine2": { "type": "string", "example": "2nd floor" }, "city": { "type": "string", "example": "Berlin" }, "countryCode": { "type": "string", "example": "DE" }, "postalCode": { "type": "string", "example": "10243" }, "type": { "type": "string", "enum": [ "BILLING", "DELIVERY", "PRIVATE", "WORK", "PICKUP" ], "example": "BILLING" } } }, "ContactPersonV2": { "type": "object", "properties": { "id": { "type": "string", "example": "967188f6-8248-4765-b1e8-0f13a3ddb616" }, "birthDate": { "type": "string", "example": "1990-05-12T00:00:00.000Z" }, "emailAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/ContactEmailV2" } }, "firstName": { "type": "string", "example": "John" }, "jobTitle": { "type": "string", "example": "Managing Director" }, "lastName": { "type": "string", "example": "Doe" }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPhoneV2" } }, "salutation": { "type": "string", "example": "Mr" } } }, "ContactPersonV2Request": { "type": "object", "properties": { "birthDate": { "type": "string", "example": "1990-05-12T00:00:00.000Z" }, "emailAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/ContactEmailV2" } }, "firstName": { "type": "string", "example": "John" }, "jobTitle": { "type": "string", "example": "Managing Director" }, "lastName": { "type": "string", "example": "Doe" }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPhoneV2" } }, "salutation": { "type": "string", "example": "Mr" } } }, "ContactEmailV2": { "type": "object", "properties": { "email": { "type": "string", "example": "john.doe@company.com" }, "type": { "type": "string", "enum": [ "BUSINESS", "PRIVATE", "OFFICE", "INVOICE", "PAYMENT", "OTHER" ], "example": "BUSINESS" } } }, "ContactPhoneV2": { "type": "object", "properties": { "number": { "type": "string", "example": "+49 7163307056" }, "type": { "type": "string", "enum": [ "BUSINESS", "MOBILE", "OFFICE", "FAX", "PRIVATE", "OTHER" ], "example": "MOBILE" } } }, "FiscalYearResponseDto": { "type": "object", "properties": { "id": { "type": "string", "example": "20250101" }, "accountNumberLength": { "type": "number", "example": 4 }, "availableLedgers": { "type": "array", "items": { "type": "string", "enum": [ "ACCOUNT_PAYABLE", "ACCOUNT_RECEIVABLE", "CASH_LEDGER" ] } }, "chartOfAccount": { "type": "string", "enum": [ "SKR03", "SKR04", "SKR07", "SKR51", "SKR14", "SKR42" ] }, "createdDate": { "type": "string", "example": "2025-01-01T00:00:00Z" }, "description": { "type": "string", "example": "Fiscal Year 2025" }, "endDate": { "type": "string", "example": "2025-31-12T00:00:00Z" }, "startDate": { "type": "string", "example": "2025-01-01T00:00:00Z" }, "status": { "type": "string", "enum" : [ "OPEN", "CLOSED" ] }, "updatedDate": { "type": "string", "example": "2025-01-01T00:00:00Z" } } }, "BookingProposalRequestAsyncDto": { "type": "object", "properties": { "id": { "type": "string", "example": "23a24449-6v28-446e-bb12-3f428073fc" }, "addresses ": { "type": "array", "items": { "$ref": "#/components/schemas/AddressBookingProposal" } }, "bankAccount": { "$ref": "#/components/schemas/BankAccountCommonDto" }, "bookingProposalDate": { "type": "string", "example": "2025-07-14T00:00:00Z" }, "contact": { "$ref": "#/components/schemas/ContactCommonDto" }, "currency": { "type": "string", "example": "EUR" }, "deliveryDate": { "type": "string", "example": "2025-07-26T00:00:00Z" }, "discountPaymentDate": { "type": "string", "example": "2025-07-16T00:00:00Z" }, "discountPaymentDate2": { "type": "string", "example": "2025-07-18T00:00:00Z" }, "dueDate": { "type": "string", "example": "2025-07-24T00:00:00Z" }, "generatorName": { "type": "string", "example": "Maesn GmbH" }, "journalCode": { "type": "string", "example": "60" }, "isPaymentOrder": { "type": "boolean", "example": "true" }, "ledgerName": { "type": "string", "example": "Eingangsrechnungen" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/BookingProposalLineItemRequestAsyncDto" } }, "notes":{ "type": "string", "example": "Bill for maintenance services" }, "number": { "type": "string", "example": "1233330" }, "orderId": { "type": "string", "example": "3344566" }, "paidDate": { "type": "string", "example": "2025-07-20T00:00:00Z" }, "paymentTermId":{ "type": "string", "example": "03" }, "status": { "type": "string", "enum": [ "DRAFT", "SUBMITTED", "OPEN", "PAID", "PARTIALLY_PAID", "VOIDED", "CANCELLED", "OVERDUE", "DISPUTED" ], "example": "DRAFT" }, "totalGrossAmount": { "description": "Gross total — the net amount plus tax (the total payable, including VAT).", "type": "number", "example": 500 }, "useCollectiveContact": { "type": "boolean", "example": true }, "vatId": { "type": "string", "example": "DE987654321" } } }, "BookingProposalResponseAsyncDto": { "type": "object", "properties": { "id": { "type": "string", "example": "23a24449-6v28-446e-bb12-3f428073fc" }, "addresses ": { "type": "array", "items": { "$ref": "#/components/schemas/AddressBookingProposal" } }, "bankAccount": { "$ref": "#/components/schemas/BankAccountCommonDto" }, "bookingProposalDate": { "type": "string", "example": "2025-07-14T00:00:00Z" }, "contact": { "$ref": "#/components/schemas/ContactCommonDto" }, "createdDate": { "type": "string", "example": "2025-07-14T00:00:00Z" }, "currency": { "type": "string", "example": "EUR" }, "deliveryDate": { "type": "string", "example": "2025-07-26T00:00:00Z" }, "discountPaymentDate": { "type": "string", "example": "2025-07-16T00:00:00Z" }, "discountPaymentDate2": { "type": "string", "example": "2025-07-18T00:00:00Z" }, "dueDate": { "type": "string", "example": "2025-07-24T00:00:00Z" }, "files": { "type": "array", "items": { "type": "string", "example": "file1.pdf" } }, "journalCode": { "type": "string", "example": "60" }, "isPaymentOrder": { "type": "boolean", "example": "true" }, "ledgerName": { "type": "string", "example": "Ausgangsrechnungen" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/BookingProposalLineItemResponseAsyncDto" } }, "notes":{ "type": "string", "example": "Bill for maintenance services" }, "number": { "type": "string", "example": "1233330" }, "orderId": { "type": "string", "example": "3344566" }, "paidDate": { "type": "string", "example": "2021-01-01T00:00:00Z" }, "paymentTermId":{ "type": "string", "example": "03" }, "status": { "type": "string", "enum": [ "DRAFT", "SUBMITTED", "OPEN", "PAID", "PARTIALLY_PAID", "VOIDED", "CANCELLED", "OVERDUE", "DISPUTED" ], "example": "DRAFT" }, "totalGrossAmount": { "description": "Gross total — the net amount plus tax (the total payable, including VAT).", "type": "number", "example": 500 }, "updatedDate": { "type": "string", "example": "2025-07-16T00:00:00Z" }, "vatId": { "type": "string", "example": "DE987654321" } } }, "BookingProposalLineItemRequestAsyncDto": { "type": "object", "properties": { "id": { "type": "string", "example": "Item-112233" }, "account": { "$ref": "#/components/schemas/AccountCommonDto" }, "description": { "type": "string", "example": "Item A" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/DimensionCommonDto" } }, "discountAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 100 }, "discountAmount2": { "type": "number", "example": 50 }, "discountPercentage": { "type": "number", "example": 20 }, "discountPercentage2": { "type": "number", "example": 10 }, "taxCode": { "type": "string", "example": "9" }, "taxRatePercentage": { "type": "number", "example": 19 }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 500 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 450 }, "type": { "type": "string", "enum": [ "PRODUCT", "SERVICE" ], "example": "SERVICE" } } }, "BookingProposalLineItemResponseAsyncDto": { "type": "object", "properties": { "id": { "type": "string", "example": "Item-112233" }, "account": { "$ref": "#/components/schemas/AccountCommonDto" }, "createdDate": { "type": "string", "example": "2025-07-14T00:00:00Z" }, "description": { "type": "string", "example": "Item A" }, "dimensions": { "$ref": "#/components/schemas/DimensionCommonDto" }, "discountAmount": { "description": "Discount applied to the line item, in the document currency.", "type": "number", "example": 100 }, "discountAmount2": { "type": "number", "example": 50 }, "discountPercentage": { "type": "number", "example": 20 }, "discountPercentage2": { "type": "number", "example": 10 }, "taxCode": { "type": "string", "example": "9" }, "taxRatePercentage": { "type": "number", "example": 19 }, "totalGrossAmount": { "description": "Gross amount of the line item — net plus tax (including VAT).", "type": "number", "example": 500 }, "totalNetAmount": { "description": "Net amount of the line item — before tax (excluding VAT).", "type": "number", "example": 450 }, "type": { "type": "string", "enum": [ "PRODUCT", "SERVICE" ], "example": "SERVICE" }, "updatedDate": { "type": "string", "example": "2025-07-16T00:00:00Z" } } }, "BankAccountCommonDto": { "type": "object", "properties": { "id": { "type": "string", "example": "5a6b7f5dw45c1c-403e-ad56-202fbc312414" }, "bankName": { "type": "string", "example": "Sparkasse" }, "bic": { "type": "string", "example": "DEUTDEFF" }, "code": { "type": "string", "example": "50010517" }, "iban": { "type": "string", "example": "DE89370400440532013000" }, "number": { "type": "number", "example": 5407324931 } } }, "ContactCommonDto": { "type": "object", "properties": { "id": { "type": "string", "example": "eaa28f49-6028-4b6e-bb12-d8f6278073fc" }, "accountNumber": { "type": "number", "example": 70000 }, "name": { "type": "string", "example": "John Doe" } } } } } }