{ "openapi": "3.1.1", "info": { "title": "SLink DEV API", "description": "SLink e-invoicing DEV API — API Key Authentication", "version": "v1" }, "servers": [ { "url": "https://api-dev.slinkhub.net/" } ], "paths": { "/api/v1/avalara/status-webhook": { "post": { "tags": [ "AvalaraWebhook" ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/avalara/poll-status": { "post": { "tags": [ "AvalaraWebhook" ], "parameters": [ { "name": "batchSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/avalara/poll-ereport-status": { "post": { "tags": [ "AvalaraWebhook" ], "parameters": [ { "name": "batchSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/avalara/mandate-contract/{countryMandate}": { "get": { "tags": [ "AvalaraWebhook" ], "parameters": [ { "name": "countryMandate", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/coda/convert": { "post": { "tags": [ "Coda" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodaConvertRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CodaConvertRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CodaConvertRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/company": { "get": { "tags": [ "Company" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDTO" } } } } } }, "put": { "tags": [ "Company" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMyCompanyCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateMyCompanyCommand" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDTO" } } } } } } }, "/api/v1/company/bank-accounts/reconcile": { "post": { "tags": [ "Company" ], "parameters": [ { "name": "dryRun", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "makeMostUsedDefault", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountReconciliationResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/company/dgfip/activate": { "post": { "tags": [ "Company" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivateDgfipCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActivateDgfipCommand" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } }, "/api/v1/company/coa": { "post": { "tags": [ "Company" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { } } } } } }, "/api/v1/company/gle": { "post": { "tags": [ "Company" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { } } } } } }, "/api/v1/contact/list": { "get": { "tags": [ "Contact" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactListDTO" } } } } } } } }, "/api/v1/contact/all": { "get": { "tags": [ "Contact" ], "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "externalid", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDTO" } } } } } } } }, "/api/v1/contact/{id}": { "get": { "tags": [ "Contact" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactDTO" } } } } } }, "delete": { "tags": [ "Contact" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } }, "/api/v1/contact": { "post": { "tags": [ "Contact" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateContactCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateContactCommand" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactDTO" } } } } } }, "put": { "tags": [ "Contact" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateContactCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateContactCommand" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactDTO" } } } } } } }, "/api/v1/contact/merge": { "post": { "tags": [ "Contact" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MergeContactsCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MergeContactsCommand" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } }, "/api/v1/contact/{id}/has-invoices": { "get": { "tags": [ "Contact" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } }, "/api/v1/contact/{contactId}/identifiers": { "post": { "tags": [ "Contact" ], "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactIdentifierCommand" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactIdentifierCommand" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactIdentifierDTO" } } } } } } } }, "/api/v1/contact/{contactId}/contact-point": { "put": { "tags": [ "Contact" ], "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertContactPointByNameCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertContactPointByNameCommand" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactDTO" } } } } } } }, "/api/v1/contact/batch-delete": { "put": { "tags": [ "Contact" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } }, "/api/v1/ereporting/b2c-transactions": { "post": { "tags": [ "EReporting" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2CTransactionBatchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/B2CTransactionBatchRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2CTransactionBatchResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/inbound-mail/ingest": { "post": { "tags": [ "InboundMail" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InboundMailIngestRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InboundMailIngestRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InboundMailIngestRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/invoiceattachment/{invoiceId}": { "get": { "tags": [ "InvoiceAttachment" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceAttachmentDTO" } } } } } } }, "post": { "tags": [ "InvoiceAttachment" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/invoiceattachment/{attachmentId}/download": { "get": { "tags": [ "InvoiceAttachment" ], "parameters": [ { "name": "attachmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/invoiceattachment/merge": { "post": { "tags": [ "InvoiceAttachment" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "files": { "type": "array", "items": { "$ref": "#/components/schemas/IFormFile" } } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/invoiceattachment/attachment/{attachmentId}": { "delete": { "tags": [ "InvoiceAttachment" ], "parameters": [ { "name": "attachmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } }, "/api/v1/invoice/all": { "get": { "tags": [ "Invoice" ], "parameters": [ { "name": "fromIssueDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "toIssueDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceDTO" } } } } } } } }, "/api/v1/invoice/id-map": { "get": { "tags": [ "Invoice" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceIdMapItem" } } } } } } } }, "/api/v1/invoice/by-number": { "get": { "tags": [ "Invoice" ], "parameters": [ { "name": "number", "in": "query", "schema": { "type": "string" } }, { "name": "documentType", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceSnapshotDto" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/invoice/{id}": { "get": { "tags": [ "Invoice" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDTO" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Invoice" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } }, "/api/v1/invoice": { "post": { "tags": [ "Invoice" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceCommand" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDTO" } } } } } }, "put": { "tags": [ "Invoice" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInvoiceCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateInvoiceCommand" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDTO" } } } } } } }, "/api/v1/invoice/batch-delete": { "put": { "tags": [ "Invoice" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } }, "/api/v1/invoice/{id}/send-to-peppol": { "post": { "tags": [ "Invoice" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } }, "/api/v1/invoice/internal/{id}/send-to-peppol": { "post": { "tags": [ "Invoice" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/invoice/{id}/validate-peppol": { "post": { "tags": [ "Invoice" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeppolValidationResult" } } } } } } }, "/api/v1/invoice/purchases/pending": { "get": { "tags": [ "Invoice" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceDTO" } } } } } } } }, "/api/v1/invoice/purchases/pending/xml": { "get": { "tags": [ "Invoice" ], "responses": { "200": { "description": "OK", "content": { "application/xml": { "schema": { "type": "string" } } } } } } }, "/api/v1/invoice/sales/pending": { "get": { "tags": [ "Invoice" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceDTO" } } } } } } } }, "/api/v1/invoice/{id}/status": { "patch": { "tags": [ "Invoice" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchInvoiceStatusCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PatchInvoiceStatusCommand" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } }, "/api/v1/invoice/{id}/document-type": { "patch": { "tags": [ "Invoice" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchInvoiceDocumentTypeCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PatchInvoiceDocumentTypeCommand" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } }, "/api/v1/invoice/{id}/b2b-fields": { "patch": { "tags": [ "Invoice" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchInvoiceB2BFieldsCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PatchInvoiceB2BFieldsCommand" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } }, "/api/v1/invoice/{id}/reset-to-draft": { "put": { "tags": [ "Invoice" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } }, "/api/v1/invoice/{id}/fr-status": { "patch": { "tags": [ "Invoice" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitFrStatusCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SubmitFrStatusCommand" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrStatusAcceptedResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/invoice/{id}/fr-timeline": { "get": { "tags": [ "Invoice" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrTimelineResponse" } } } } } } }, "/api/v1/invoice/{id}/mark-downloaded": { "put": { "tags": [ "Invoice" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } }, "/api/v1/invoice/{id}/reset-download": { "post": { "tags": [ "Invoice" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } }, "/api/v1/invoice/trigger-export": { "post": { "tags": [ "Invoice" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerExportResult" } } } } } } }, "/api/v1/invoice/delivery-audit": { "get": { "tags": [ "Invoice" ], "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryAuditListItemDTO" } } } } } } } }, "/api/v1/invoice/{id}/generate-ubl": { "get": { "tags": [ "Invoice" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/invoice/generate-ubl": { "post": { "tags": [ "Invoice" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateUblFromPayloadQuery" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GenerateUblFromPayloadQuery" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/invoice/batch-upload": { "post": { "tags": [ "Invoice" ], "parameters": [ { "name": "type", "in": "query", "schema": { "$ref": "#/components/schemas/InvoiceType" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/invoice/b2b-status-webhook": { "post": { "tags": [ "Invoice" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2BStatusWebhookAcknowledgement" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/invoice/{id}/external-document-no": { "patch": { "tags": [ "Invoice" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchExternalDocumentNoRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PatchExternalDocumentNoRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PatchExternalDocumentNoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/invoicedelivery/methods": { "get": { "tags": [ "InvoiceDelivery" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryMethodItem" } } } } } } } }, "/api/v1/invoicedelivery/{invoiceId}": { "get": { "tags": [ "InvoiceDelivery" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceDeliveryDTO" } } } } } } } }, "/api/v1/invoicedelivery/{deliveryId}/audit": { "post": { "tags": [ "InvoiceDelivery" ], "parameters": [ { "name": "deliveryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceDeliveryAuditItem" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceDeliveryAuditItem" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { } } } } } }, "/api/v1/invoicedelivery": { "post": { "tags": [ "InvoiceDelivery" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceDeliveryCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceDeliveryCommand" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDeliveryDTO" } } } } } } }, "/api/v1/invoicedelivery/{id}/status": { "patch": { "tags": [ "InvoiceDelivery" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchInvoiceDeliveryStatusCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PatchInvoiceDeliveryStatusCommand" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } }, "/api/v1/invoicedelivery/{id}/audit/remap-status": { "patch": { "tags": [ "InvoiceDelivery" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemapDeliveryAuditStatusCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RemapDeliveryAuditStatusCommand" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } }, "/api/v1/self-billing-mandate": { "get": { "tags": [ "SelfBillingMandate" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SelfBillingMandateDto" } } } } } } }, "post": { "tags": [ "SelfBillingMandate" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelfBillingMandateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SelfBillingMandateDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SelfBillingMandateDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelfBillingMandateDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/self-billing-mandate/{id}": { "put": { "tags": [ "SelfBillingMandate" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelfBillingMandateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SelfBillingMandateDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SelfBillingMandateDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelfBillingMandateDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/vies": { "get": { "tags": [ "Vies" ], "parameters": [ { "name": "country", "in": "query", "schema": { "type": "string" } }, { "name": "vatNumber", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VATCheckerResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/vies/peppol-check": { "get": { "tags": [ "Vies" ], "parameters": [ { "name": "scheme", "in": "query", "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectoryCompanyResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/webhook/subscriptions": { "get": { "tags": [ "Webhook" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookSubscriptionDTO" } } } } } } }, "post": { "tags": [ "Webhook" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookSubscriptionCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateWebhookSubscriptionCommand" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscriptionDTO" } } } } } } }, "/api/v1/webhook/subscriptions/{id}": { "get": { "tags": [ "Webhook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscriptionDTO" } } } } } }, "put": { "tags": [ "Webhook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookSubscriptionCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookSubscriptionCommand" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscriptionDTO" } } } } } }, "delete": { "tags": [ "Webhook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } }, "/api/v1/webhook/subscriptions/{id}/enable": { "put": { "tags": [ "Webhook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscriptionDTO" } } } } } } }, "/api/v1/webhook/subscriptions/{id}/disable": { "put": { "tags": [ "Webhook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscriptionDTO" } } } } } } }, "/api/v1/webhook/subscriptions/{id}/test": { "post": { "tags": [ "Webhook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } }, "/api/v1/webhook/events": { "get": { "tags": [ "Webhook" ], "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "subscriptionId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEventDTO" } } } } } } } }, "/api/v1/webhook/events/{eventId}/replay": { "post": { "tags": [ "Webhook" ], "parameters": [ { "name": "eventId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } }, "/api/v1/webhook/events/{eventId}/redispatch": { "post": { "tags": [ "Webhook" ], "parameters": [ { "name": "eventId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanResult" } } } } } } } }, "components": { "schemas": { "Account": { "type": "object", "properties": { "id": { "format": "int32" }, "country": { "type": [ "null", "string" ] }, "rounding_method": { "type": [ "null", "string" ] }, "tin_scheme": { "format": "int32" }, "transport_type_code": { "type": [ "null", "string" ] }, "tin_value": { "type": [ "null", "string" ] }, "parent_id": { "format": "int32" }, "cin_scheme": { }, "cin_value": { }, "name": { "type": [ "null", "string" ] }, "address": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "postalcode": { "type": [ "null", "string" ] }, "province": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] } } }, "ActivateDgfipCommand": { "required": [ "nafCode", "enterpriseSize", "typeOperation", "startDate" ], "type": "object", "properties": { "companyId": { "type": "string", "format": "uuid" }, "nafCode": { "maxLength": 20, "type": [ "null", "string" ] }, "enterpriseSize": { "maxLength": 10, "type": [ "null", "string" ] }, "typeOperation": { "maxLength": 20, "type": [ "null", "string" ] }, "vatRegime": { "maxLength": 40, "type": [ "null", "string" ] }, "startDate": { "type": "string", "format": "date-time" }, "autoApproveFrInvoices": { "type": [ "null", "boolean" ] }, "defaultBillingFrame": { "maxLength": 3, "type": [ "null", "string" ] } } }, "AllowanceCharge": { "type": "object", "properties": { "allowance_charge_indicator": { "type": [ "null", "string" ] }, "amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "description": { "type": [ "null", "string" ] } } }, "B2BStatusWebhookAcknowledgement": { "type": "object", "properties": { "status": { "type": [ "null", "string" ] } } }, "B2CTransactionBatchRequest": { "type": "object", "properties": { "transactions": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/B2CTransactionDto" } } } }, "B2CTransactionBatchResponse": { "type": "object", "properties": { "totalReceived": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "created": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "duplicates": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "failed": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "declared": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "results": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/B2CTransactionIngestResult" } } } }, "B2CTransactionDto": { "type": "object", "properties": { "externalReference": { "type": [ "null", "string" ] }, "transactionDate": { "type": "string", "format": "date" }, "category": { "type": [ "null", "string" ] }, "currencyCode": { "type": [ "null", "string" ] }, "amountHt": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "amountVat": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vatRate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "optionDebits": { "type": "boolean" }, "type": { "type": [ "null", "string" ] }, "linkedExternalReference": { "type": [ "null", "string" ] }, "isAccessory": { "type": "boolean" } } }, "B2CTransactionIngestResult": { "type": "object", "properties": { "externalReference": { "type": [ "null", "string" ] }, "outcome": { "type": [ "null", "string" ] }, "error": { "type": [ "null", "string" ] } } }, "BankAccount": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "iban": { "type": [ "null", "string" ] }, "number": { "type": [ "null", "string" ] }, "bic": { "type": [ "null", "string" ] } } }, "BankAccountReconciliationEntry": { "type": "object", "properties": { "iban": { "type": [ "null", "string" ] }, "bic": { "type": [ "null", "string" ] }, "invoiceCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "firstSeen": { "type": [ "null", "string" ], "format": "date-time" }, "lastSeen": { "type": [ "null", "string" ], "format": "date-time" }, "outcome": { "type": [ "null", "string" ] }, "reason": { "type": [ "null", "string" ] }, "becameDefault": { "type": "boolean" } } }, "BankAccountReconciliationResult": { "type": "object", "properties": { "companyId": { "type": "string", "format": "uuid" }, "companyName": { "type": [ "null", "string" ] }, "dryRun": { "type": "boolean" }, "invoicesScanned": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "added": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "alreadyPresent": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "rejected": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "entries": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BankAccountReconciliationEntry" } }, "unusedExistingAccounts": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "BooleanResult": { "type": "object", "properties": { "result": { "type": "boolean" }, "message": { "type": [ "null", "string" ] } } }, "Client": { "type": "object", "properties": { "id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "language": { "type": [ "null", "string" ] }, "is_client": { "type": [ "null", "boolean" ] }, "is_provider": { "type": [ "null", "boolean" ] }, "public_sector": { "type": [ "null", "boolean" ] }, "name": { "type": [ "null", "string" ] }, "tin_value": { "type": [ "null", "string" ] }, "tin_scheme": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "pin_value": { "type": [ "null", "string" ] }, "pin_scheme": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "cin_value": { "type": [ "null", "string" ] }, "cin_scheme": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "country": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "address": { "type": [ "null", "string" ] }, "postalcode": { "type": [ "null", "string" ] }, "province": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "transport_type_code": { "type": [ "null", "string" ] }, "document_type_code": { "type": [ "null", "string" ] }, "payment_method": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "parent_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" } } }, "CodaConvertRequest": { "type": "object", "properties": { "document": { "type": [ "null", "string" ] }, "fileName": { "type": [ "null", "string" ] }, "fileSize": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "CompanyDTO": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string", "format": "uuid" }, "countryId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "groupId": { "type": [ "null", "string" ], "format": "uuid" }, "currencyId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "languageId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "logo": { "type": [ "null", "string" ], "format": "byte" }, "name": { "type": [ "null", "string" ] }, "address": { "type": [ "null", "string" ] }, "address2": { "type": [ "null", "string" ] }, "zipCode": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "phoneNumber": { "type": [ "null", "string" ] }, "vatNumber": { "type": [ "null", "string" ] }, "website": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "codeTP": { "type": [ "null", "string" ] }, "startInvoiceNbr": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "contactId": { "type": [ "null", "string" ], "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "modifiedBy": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": "string", "format": "date-time" }, "productId": { "type": [ "null", "string" ], "format": "uuid" }, "products": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "autoApproveFrInvoices": { "type": "boolean" } } }, "ContactAddressCommand": { "required": [ "addressType" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "countryId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "addressType": { "maxLength": 30, "type": [ "null", "string" ] }, "streetName": { "maxLength": 255, "type": [ "null", "string" ] }, "buildingNumber": { "maxLength": 50, "type": [ "null", "string" ] }, "additionalStreetName": { "maxLength": 255, "type": [ "null", "string" ] }, "cityName": { "maxLength": 255, "type": [ "null", "string" ] }, "postalZone": { "maxLength": 20, "type": [ "null", "string" ] }, "countrySubentity": { "maxLength": 255, "type": [ "null", "string" ] }, "countryCode": { "type": [ "null", "string" ] } } }, "ContactAddressDTO": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "contactId": { "type": "string", "format": "uuid" }, "countryId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "addressType": { "type": [ "null", "string" ] }, "streetName": { "type": [ "null", "string" ] }, "buildingNumber": { "type": [ "null", "string" ] }, "additionalStreetName": { "type": [ "null", "string" ] }, "cityName": { "type": [ "null", "string" ] }, "postalZone": { "type": [ "null", "string" ] }, "countrySubentity": { "type": [ "null", "string" ] } } }, "ContactBankAccountCommand": { "required": [ "accountId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountId": { "maxLength": 100, "type": [ "null", "string" ] }, "accountName": { "maxLength": 255, "type": [ "null", "string" ] }, "bankId": { "maxLength": 100, "type": [ "null", "string" ] }, "bankName": { "maxLength": 255, "type": [ "null", "string" ] }, "isDefault": { "type": "boolean" } } }, "ContactBankAccountDTO": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "contactId": { "type": "string", "format": "uuid" }, "accountId": { "type": [ "null", "string" ] }, "accountName": { "type": [ "null", "string" ] }, "bankId": { "type": [ "null", "string" ] }, "bankName": { "type": [ "null", "string" ] }, "isDefault": { "type": "boolean" }, "contact": { "$ref": "#/components/schemas/ContactDTO" } } }, "ContactDTO": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "invoiceDeliveryMethodId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "name": { "type": [ "null", "string" ] }, "legalName": { "type": [ "null", "string" ] }, "endpointId": { "type": [ "null", "string" ] }, "endpointSchemeId": { "type": [ "null", "string" ] }, "vatId": { "type": [ "null", "string" ] }, "companyRegistrationId": { "type": [ "null", "string" ] }, "b2BContactId": { "type": [ "null", "string" ] }, "isVendor": { "type": "boolean" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "externalId": { "type": [ "null", "string" ] }, "preferredSendMethod": { "type": [ "null", "string" ] }, "autoApproveFrInvoices": { "type": [ "null", "boolean" ] }, "addresses": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ContactAddressDTO" } }, "identifiers": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ContactIdentifierDTO" } }, "bankAccounts": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ContactBankAccountDTO" } }, "contactPoints": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ContactPointDTO" } } } }, "ContactIdentifierCommand": { "required": [ "identifier" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "identifier": { "maxLength": 100, "type": [ "null", "string" ] }, "schemeId": { "maxLength": 50, "type": [ "null", "string" ] }, "isVat": { "type": "boolean" }, "isCompanyRegistration": { "type": "boolean" } } }, "ContactIdentifierDTO": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "contactId": { "type": "string", "format": "uuid" }, "identifier": { "type": [ "null", "string" ] }, "schemeId": { "type": [ "null", "string" ] }, "isVat": { "type": "boolean" }, "isCompanyRegistration": { "type": "boolean" }, "contact": { "$ref": "#/components/schemas/ContactDTO" } } }, "ContactListDTO": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "name": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "regNumber": { "type": [ "null", "string" ] }, "vatNumber": { "type": [ "null", "string" ] }, "countryCode": { "type": [ "null", "string" ] } } }, "ContactPointCommand": { "required": [ "department" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "department": { "maxLength": 255, "type": [ "null", "string" ] }, "contactName": { "maxLength": 255, "type": [ "null", "string" ] }, "telephone": { "maxLength": 50, "type": [ "null", "string" ] }, "email": { "maxLength": 255, "type": [ "null", "string" ] }, "endpointId": { "maxLength": 100, "type": [ "null", "string" ] }, "endpointSchemeId": { "maxLength": 50, "type": [ "null", "string" ] }, "isDefault": { "type": "boolean" }, "countryId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "streetName": { "maxLength": 255, "type": [ "null", "string" ] }, "buildingNumber": { "maxLength": 50, "type": [ "null", "string" ] }, "additionalStreetName": { "maxLength": 255, "type": [ "null", "string" ] }, "cityName": { "maxLength": 255, "type": [ "null", "string" ] }, "postalZone": { "maxLength": 50, "type": [ "null", "string" ] }, "countrySubentity": { "maxLength": 100, "type": [ "null", "string" ] } } }, "ContactPointDTO": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "contactId": { "type": "string", "format": "uuid" }, "department": { "type": [ "null", "string" ] }, "contactName": { "type": [ "null", "string" ] }, "telephone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "endpointId": { "type": [ "null", "string" ] }, "endpointSchemeId": { "type": [ "null", "string" ] }, "isDefault": { "type": "boolean" }, "b2BContactId": { "type": [ "null", "string" ] }, "countryId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "streetName": { "type": [ "null", "string" ] }, "buildingNumber": { "type": [ "null", "string" ] }, "additionalStreetName": { "type": [ "null", "string" ] }, "cityName": { "type": [ "null", "string" ] }, "postalZone": { "type": [ "null", "string" ] }, "countrySubentity": { "type": [ "null", "string" ] }, "contact": { "$ref": "#/components/schemas/ContactDTO" } } }, "CreateContactCommand": { "required": [ "companyId", "invoiceDeliveryMethodId", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "invoiceDeliveryMethodId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "name": { "maxLength": 255, "type": [ "null", "string" ] }, "legalName": { "maxLength": 255, "type": [ "null", "string" ] }, "endpointId": { "maxLength": 100, "type": [ "null", "string" ] }, "endpointSchemeId": { "maxLength": 50, "type": [ "null", "string" ] }, "vatId": { "maxLength": 50, "type": [ "null", "string" ] }, "companyRegistrationId": { "maxLength": 100, "type": [ "null", "string" ] }, "isVendor": { "type": "boolean" }, "isConsumer": { "type": "boolean" }, "email": { "maxLength": 255, "type": [ "null", "string" ] }, "countryCode": { "maxLength": 10, "type": [ "null", "string" ] }, "addToPeppol": { "type": [ "null", "boolean" ] }, "externalId": { "maxLength": 100, "type": [ "null", "string" ] }, "relationContactName": { "maxLength": 255, "type": [ "null", "string" ] }, "preferredSendMethod": { "maxLength": 20, "type": [ "null", "string" ] }, "frenchBillingFrame": { "type": [ "null", "string" ] }, "autoApproveFrInvoices": { "type": [ "null", "boolean" ] }, "addresses": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ContactAddressCommand" } }, "identifiers": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ContactIdentifierCommand" } }, "bankAccounts": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ContactBankAccountCommand" } }, "contactPoints": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ContactPointCommand" } } } }, "CreateInvoiceCommand": { "required": [ "companyId", "contactId", "customizationId", "profileId", "documentType", "issueDate", "currencyCode" ], "type": "object", "properties": { "companyId": { "type": "string", "format": "uuid" }, "contactId": { "type": "string", "format": "uuid" }, "customizationId": { "type": [ "null", "string" ] }, "profileId": { "type": [ "null", "string" ] }, "invoiceNumber": { "type": [ "null", "string" ] }, "externalDocumentNo": { "type": [ "null", "string" ] }, "documentType": { "$ref": "#/components/schemas/DocumentType" }, "issueDate": { "type": "string", "format": "date-time" }, "currencyCode": { "maxLength": 3, "minLength": 3, "type": [ "null", "string" ] }, "taxPointDate": { "type": [ "null", "string" ], "format": "date-time" }, "taxPointDateCode": { "maxLength": 3, "minLength": 0, "type": [ "null", "string" ] }, "taxCurrencyCode": { "maxLength": 3, "minLength": 3, "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "note": { "type": [ "null", "string" ] }, "buyerReference": { "type": [ "null", "string" ] }, "orderReference": { "type": [ "null", "string" ] }, "contractReference": { "type": [ "null", "string" ] }, "projectReference": { "type": [ "null", "string" ] }, "costCentre": { "type": [ "null", "string" ] }, "orderReferenceDate": { "type": [ "null", "string" ], "format": "date-time" }, "contractReferenceDate": { "type": [ "null", "string" ], "format": "date-time" }, "despatchReference": { "type": [ "null", "string" ] }, "despatchReferenceDate": { "type": [ "null", "string" ], "format": "date-time" }, "dueDate": { "type": [ "null", "string" ], "format": "date-time" }, "paymentMeansCode": { "type": [ "null", "string" ] }, "paymentTerms": { "type": [ "null", "string" ] }, "paymentAccountId": { "type": [ "null", "string" ] }, "paymentAccountBic": { "type": [ "null", "string" ] }, "lineExtensionAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "taxExclusiveAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "taxInclusiveAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "allowanceTotalAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "chargeTotalAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "payableRoundingAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "payableAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "taxTotalAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "isCreditNote": { "type": "boolean" }, "precedingInvoiceNumber": { "type": [ "null", "string" ] }, "precedingInvoiceDate": { "type": [ "null", "string" ], "format": "date-time" }, "isReadOnly": { "type": "boolean" }, "isHistoricalImport": { "type": "boolean" }, "conflictOnDuplicate": { "type": "boolean" }, "sourceSystem": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "b2BStatus": { "type": [ "null", "string" ] }, "sendMethod": { "type": [ "null", "string" ] }, "frenchBillingFrame": { "type": [ "null", "string" ] }, "factoringContractId": { "type": [ "null", "string" ], "format": "uuid" }, "factorIdentifier": { "type": [ "null", "string" ] }, "isSelfBilled": { "type": "boolean" }, "selfBillingMandateId": { "type": [ "null", "string" ], "format": "uuid" }, "selfBillingMandateIdentifier": { "type": [ "null", "string" ] }, "isAlreadyPaid": { "type": "boolean" }, "paidAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "b2BInvoiceId": { "type": [ "null", "string" ] }, "createdDate": { "type": [ "null", "string" ], "format": "date-time" }, "receiverContactPointId": { "type": [ "null", "string" ], "format": "uuid" }, "lines": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/InvoiceLineDTO" } }, "source": { "type": [ "null", "string" ] } } }, "CreateInvoiceDeliveryCommand": { "required": [ "invoiceId", "invoiceSendMethodId" ], "type": "object", "properties": { "invoiceId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "invoiceSendMethodId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "status": { "$ref": "#/components/schemas/InvoiceDeliveryStatus" }, "dateTimeSent": { "type": [ "null", "string" ], "format": "date-time" }, "dateTimeProcessed": { "type": [ "null", "string" ], "format": "date-time" }, "dateTimeConfirmed": { "type": [ "null", "string" ], "format": "date-time" }, "payloadSent": { "type": [ "null", "string" ] }, "errorMode": { "type": [ "null", "string" ] }, "transportType": { "type": [ "null", "string" ] }, "documentType": { "type": [ "null", "string" ] }, "endpointId": { "type": [ "null", "string" ] }, "endpointSchemeId": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] } } }, "CreateWebhookSubscriptionCommand": { "required": [ "callbackUrl", "secret", "subscribedEvents" ], "type": "object", "properties": { "companyId": { "type": "string", "format": "uuid" }, "apiKeyId": { "type": [ "null", "string" ], "format": "uuid" }, "callbackUrl": { "type": [ "null", "string" ] }, "secret": { "minLength": 16, "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "subscribedEvents": { "minItems": 1, "type": [ "null", "array" ], "items": { "type": "string" } }, "customHeaders": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" } }, "allowedIps": { "type": [ "null", "array" ], "items": { "type": "string" } }, "rateLimitPerMinute": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "DeliveryAuditListItemDTO": { "type": "object", "properties": { "id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "invoiceDeliveryId": { "type": "string", "format": "uuid" }, "eventType": { "type": [ "null", "string" ] }, "oldStatus": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "newStatus": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "oldStatusLabel": { "type": [ "null", "string" ] }, "newStatusLabel": { "type": [ "null", "string" ] }, "changedAtUtc": { "type": "string", "format": "date-time" }, "changedByType": { "type": [ "null", "string" ] }, "changedById": { "type": [ "null", "string" ] }, "sourceApp": { "type": [ "null", "string" ] }, "correlationId": { "type": [ "null", "string" ] }, "requestPathOrJob": { "type": [ "null", "string" ] }, "changesJson": { "type": [ "null", "string" ] }, "errorMessage": { "type": [ "null", "string" ] }, "exceptionType": { "type": [ "null", "string" ] }, "companyName": { "type": [ "null", "string" ] }, "invoiceNumber": { "type": [ "null", "string" ] }, "invoiceId": { "type": "string", "format": "uuid" } } }, "DeliveryMethodItem": { "type": "object", "properties": { "id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "methodName": { "type": [ "null", "string" ] }, "transportTypeCode": { "type": [ "null", "string" ] } } }, "DirectoryCompanyResponse": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "website": { "type": [ "null", "string" ] }, "address": { "type": [ "null", "string" ] }, "address2": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "postalcode": { "type": [ "null", "string" ] }, "province": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "pin_scheme": { "type": [ "null", "string" ] }, "pin_value": { "type": [ "null", "string" ] }, "invoice": { "$ref": "#/components/schemas/DocumentCapability" } } }, "DocumentCapability": { "type": "object", "properties": { "transport_type_code": { "type": [ "null", "string" ] }, "document_type_code": { "type": [ "null", "string" ] }, "other_document_type_codes": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "DocumentType": { "type": "integer" }, "EncaissementBreakdown": { "type": "object", "properties": { "typeCode": { "type": [ "null", "string" ] }, "amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "currency": { "type": [ "null", "string" ] }, "vatRate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "date": { "type": [ "null", "string" ], "format": "date-time" }, "vatExemptionCode": { "type": [ "null", "string" ] } } }, "FrStatusAcceptedResponse": { "type": "object", "properties": { "invoiceId": { "type": "string", "format": "uuid" }, "lifecycleStatusId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "code": { "type": [ "null", "string" ] }, "phase": { "type": [ "null", "string" ] }, "createdAtUtc": { "type": "string", "format": "date-time" }, "lifecycleMessageId": { "type": "string", "format": "uuid" }, "willForwardToCdarPpf": { "type": "boolean" } } }, "FrTimelineCurrent": { "type": "object", "properties": { "code": { "type": [ "null", "string" ] }, "phase": { "type": [ "null", "string" ] }, "atUtc": { "type": "string", "format": "date-time" } } }, "FrTimelineEvent": { "type": "object", "properties": { "id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "code": { "type": [ "null", "string" ] }, "codeNumeric": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "phase": { "type": [ "null", "string" ] }, "motifCode": { "type": [ "null", "string" ] }, "motifText": { "type": [ "null", "string" ] }, "actionAttendue": { "type": [ "null", "string" ] }, "source": { "type": [ "null", "string" ] }, "forwardedToCdarPpf": { "type": "boolean" }, "externalEventId": { "type": [ "null", "string" ] }, "atUtc": { "type": "string", "format": "date-time" }, "encaissement": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/EncaissementBreakdown" } }, "b2BRouterConfirmedAtUtc": { "type": [ "null", "string" ], "format": "date-time" }, "b2BRouterState": { "type": [ "null", "string" ] } } }, "FrTimelineResponse": { "type": "object", "properties": { "invoiceId": { "type": "string", "format": "uuid" }, "current": { "$ref": "#/components/schemas/FrTimelineCurrent" }, "events": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/FrTimelineEvent" } } } }, "GenerateUblFromPayloadQuery": { "type": "object", "properties": { "invoice": { "$ref": "#/components/schemas/InvoiceCreateRequest" }, "supplier": { "$ref": "#/components/schemas/Account" }, "currencyCode": { "type": [ "null", "string" ] }, "ublProfile": { "type": [ "null", "string" ] }, "pdfBase64": { "type": [ "null", "string" ] }, "pdfFilename": { "type": [ "null", "string" ] }, "additionalAttachments": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/UblAttachmentPayload" } }, "frenchBillingFrame": { "type": [ "null", "string" ] } } }, "IFormFile": { "type": "string", "format": "binary" }, "InboundMailAttachmentRequest": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "contentBase64": { "type": [ "null", "string" ] } } }, "InboundMailIngestRequest": { "type": "object", "properties": { "recipient": { "type": [ "null", "string" ] }, "senderAddress": { "type": [ "null", "string" ] }, "messageId": { "type": [ "null", "string" ] }, "senderAuthenticated": { "type": "boolean" }, "receivedUtc": { "type": [ "null", "string" ], "format": "date-time" }, "attachments": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/InboundMailAttachmentRequest" } } } }, "InvoiceApprovalDTO": { "type": "object", "properties": { "approvalDocumentId": { "type": "string", "format": "uuid" }, "status": { "type": [ "null", "string" ] }, "flowName": { "type": [ "null", "string" ] }, "submittedBy": { "type": [ "null", "string" ] }, "completedAtUtc": { "type": [ "null", "string" ], "format": "date-time" }, "wasForceApproved": { "type": "boolean" }, "steps": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/InvoiceApprovalStepDTO" } } } }, "InvoiceApprovalStepDTO": { "type": "object", "properties": { "stepIndex": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "approverName": { "type": [ "null", "string" ] }, "decision": { "type": [ "null", "string" ] }, "decisionAtUtc": { "type": [ "null", "string" ], "format": "date-time" }, "comment": { "type": [ "null", "string" ] }, "isForceApproved": { "type": "boolean" } } }, "InvoiceAttachmentDTO": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "string", "format": "uuid" }, "originalFileName": { "type": [ "null", "string" ] }, "contentType": { "type": [ "null", "string" ] }, "blobName": { "type": [ "null", "string" ] }, "containerName": { "type": [ "null", "string" ] }, "fileSizeBytes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "createdUtc": { "type": "string", "format": "date-time" }, "downloadUrl": { "type": [ "null", "string" ] }, "base64Content": { "type": [ "null", "string" ] } } }, "InvoiceContactAddressDTO": { "type": "object", "properties": { "addressType": { "type": [ "null", "string" ] }, "streetName": { "type": [ "null", "string" ] }, "cityName": { "type": [ "null", "string" ] }, "postalZone": { "type": [ "null", "string" ] }, "countryId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "InvoiceContactDTO": { "type": "object", "properties": { "id": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "vatNumber": { "type": [ "null", "string" ] }, "companyRegistrationId": { "type": [ "null", "string" ] }, "countryCode": { "type": [ "null", "string" ] }, "addresses": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/InvoiceContactAddressDTO" } }, "contactPoints": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/InvoiceContactPointDTO" } }, "email": { "type": [ "null", "string" ] } } }, "InvoiceContactPointDTO": { "type": "object", "properties": { "telephone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] } } }, "InvoiceCreateRequest": { "type": "object", "properties": { "send_after_import": { "type": "boolean" }, "ack": { "type": "boolean" }, "invoice": { "$ref": "#/components/schemas/InvoiceCreateRequestModel" }, "pdf_content": { "type": [ "null", "string" ] } } }, "InvoiceCreateRequestModel": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "bank_account": { "$ref": "#/components/schemas/BankAccount" }, "terms": { "type": [ "null", "string" ] }, "payment_method": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "payment_method_text": { "type": [ "null", "string" ] }, "payment_terms": { "type": [ "null", "string" ] }, "is_credit_note": { "type": [ "null", "boolean" ] }, "is_acompte": { "type": [ "null", "boolean" ] }, "amount_paid_on_acompte": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "preceding_invoice_number": { "type": [ "null", "string" ] }, "preceding_invoice_date": { "type": [ "null", "string" ], "format": "date-time" }, "is_already_paid": { "type": [ "null", "boolean" ] }, "paid_amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "invoice_lines_attributes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/InvoiceLine" } }, "apply_taxes_to_charge": { "type": "boolean" }, "charge_is_reimbursable_expense": { "type": "boolean" }, "number": { "type": [ "null", "string" ] }, "ponumber": { "type": [ "null", "string" ] }, "buyer_reference": { "type": [ "null", "string" ] }, "contract_reference": { "type": [ "null", "string" ] }, "order_reference_date": { "type": [ "null", "string" ], "format": "date-time" }, "contract_reference_date": { "type": [ "null", "string" ], "format": "date-time" }, "despatch_reference": { "type": [ "null", "string" ] }, "despatch_reference_date": { "type": [ "null", "string" ], "format": "date-time" }, "project_reference": { "type": [ "null", "string" ] }, "buyer_accounting_reference": { "type": [ "null", "string" ] }, "contact_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "contact": { "$ref": "#/components/schemas/Client" }, "date": { "type": "string", "format": "date-time" }, "due_date": { "type": "string", "format": "date-time" }, "tax_point_date": { "type": [ "null", "string" ], "format": "date-time" }, "discount_amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "InvoiceDeliveryAuditItem": { "type": "object", "properties": { "oldStatus": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "newStatus": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "changedAtUtc": { "type": "string", "format": "date-time" }, "errorMessage": { "type": [ "null", "string" ] }, "eventType": { "type": [ "null", "string" ] }, "changedByType": { "type": [ "null", "string" ] }, "changedById": { "type": [ "null", "string" ] }, "sourceApp": { "type": [ "null", "string" ] } } }, "InvoiceDeliveryDTO": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "string", "format": "uuid" }, "invoiceSendMethodId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dateTimeSent": { "type": [ "null", "string" ], "format": "date-time" }, "dateTimeProcessed": { "type": [ "null", "string" ], "format": "date-time" }, "dateTimeConfirmed": { "type": [ "null", "string" ], "format": "date-time" }, "payloadSent": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/InvoiceDeliveryStatus" }, "lastStatusCheckDateTime": { "type": [ "null", "string" ], "format": "date-time" }, "errorMode": { "type": [ "null", "string" ] }, "modifiedBy": { "type": [ "null", "string" ], "format": "uuid" }, "modifiedDate": { "type": [ "null", "string" ], "format": "date-time" }, "invoice": { "$ref": "#/components/schemas/InvoiceDTO" } } }, "InvoiceDeliveryStatus": { "type": "integer" }, "InvoiceDTO": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "contactId": { "type": "string", "format": "uuid" }, "customizationId": { "type": [ "null", "string" ] }, "profileId": { "type": [ "null", "string" ] }, "invoiceType": { "$ref": "#/components/schemas/DocumentType" }, "invoiceNumber": { "type": [ "null", "string" ] }, "externalDocumentNo": { "type": [ "null", "string" ] }, "typeOfDocument": { "type": [ "null", "string" ] }, "issueDate": { "type": "string", "format": "date-time" }, "currencyCode": { "type": [ "null", "string" ] }, "taxPointDate": { "type": [ "null", "string" ], "format": "date-time" }, "taxCurrencyCode": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "note": { "type": [ "null", "string" ] }, "noteHtml": { "type": [ "null", "string" ] }, "buyerReference": { "type": [ "null", "string" ] }, "orderReference": { "type": [ "null", "string" ] }, "contractReference": { "type": [ "null", "string" ] }, "projectReference": { "type": [ "null", "string" ] }, "costCentre": { "type": [ "null", "string" ] }, "dueDate": { "type": [ "null", "string" ], "format": "date-time" }, "paymentMeansCode": { "type": [ "null", "string" ] }, "paymentTerms": { "type": [ "null", "string" ] }, "lineExtensionAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "taxExclusiveAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "taxInclusiveAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "allowanceTotalAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "chargeTotalAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "payableRoundingAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "payableAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "taxTotalAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "isCreditNote": { "type": "boolean" }, "sendMethod": { "type": [ "null", "string" ] }, "frenchBillingFrame": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isReadOnly": { "type": "boolean" }, "isAutoBooked": { "type": "boolean" }, "sourceSystem": { "type": [ "null", "string" ] }, "b2BStatus": { "type": [ "null", "string" ] }, "b2BInvoiceId": { "type": [ "null", "string" ] }, "b2BContactId": { "type": [ "null", "string" ] }, "createdDate": { "type": "string", "format": "date-time" }, "downloadedDate": { "type": [ "null", "string" ], "format": "date-time" }, "lines": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/InvoiceLineDTO" } }, "attachments": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/InvoiceAttachmentDTO" } }, "contact": { "$ref": "#/components/schemas/InvoiceContactDTO" }, "exchangeRate": { "$ref": "#/components/schemas/InvoiceExchangeRateDTO" }, "approval": { "$ref": "#/components/schemas/InvoiceApprovalDTO" } } }, "InvoiceExchangeRateDTO": { "type": "object", "properties": { "fromCurrency": { "type": [ "null", "string" ] }, "toCurrency": { "type": [ "null", "string" ] }, "rateDate": { "type": "string", "format": "date-time" }, "rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "source": { "type": [ "null", "string" ] } } }, "InvoiceIdMapItem": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "invoiceNumber": { "type": [ "null", "string" ] } } }, "InvoiceLine": { "type": "object", "properties": { "unit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "quantity": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "description": { "type": [ "null", "string" ] }, "price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "taxes_attributes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/Tax" } }, "taxPercentage": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "discount_amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "allowance_charges_attributes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/AllowanceCharge" } }, "accountingCost": { "type": [ "null", "string" ] }, "cpv_code": { "type": [ "null", "string" ] }, "line_id": { "type": [ "null", "string" ] }, "line_type": { "type": [ "null", "string" ] }, "parent_line_id": { "type": [ "null", "string" ] }, "quantity_per_parent_unit": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "secondary_vendeur_scheme": { "type": [ "null", "string" ] }, "secondary_vendeur_identifier": { "type": [ "null", "string" ] }, "secondary_vendeur_legal_name": { "type": [ "null", "string" ] }, "secondary_vendeur_vat_number": { "type": [ "null", "string" ] }, "secondary_vendeur_country": { "type": [ "null", "string" ] }, "secondary_vendeur_invoice_number": { "type": [ "null", "string" ] } } }, "InvoiceLineDTO": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "string", "format": "uuid" }, "lineId": { "type": [ "null", "string" ] }, "sequenceNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "itemCode": { "type": [ "null", "string" ] }, "itemDescription": { "type": [ "null", "string" ] }, "quantity": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "unitCode": { "type": [ "null", "string" ] }, "priceAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "lineExtensionAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "allowanceAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "chargeAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "taxCategoryId": { "type": [ "null", "string" ] }, "taxPercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "taxSchemeId": { "type": [ "null", "string" ] }, "buyerItemIdentification": { "type": [ "null", "string" ] }, "sellerItemIdentification": { "type": [ "null", "string" ] }, "standardItemIdentification": { "type": [ "null", "string" ] }, "orderLineReference": { "type": [ "null", "string" ] }, "cpvCode": { "type": [ "null", "string" ] }, "ledgerAccountCode": { "type": [ "null", "string" ] }, "ledgerAccountDescription": { "type": [ "null", "string" ] }, "invoicePeriodStart": { "type": [ "null", "string" ], "format": "date-time" }, "invoicePeriodEnd": { "type": [ "null", "string" ], "format": "date-time" }, "parentLineId": { "type": [ "null", "string" ] }, "lineType": { "type": [ "null", "string" ] }, "quantityPerParentUnit": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "secondaryVendeurScheme": { "type": [ "null", "string" ] }, "secondaryVendeurIdentifier": { "type": [ "null", "string" ] }, "secondaryVendeurLegalName": { "type": [ "null", "string" ] }, "secondaryVendeurVatNumber": { "type": [ "null", "string" ] }, "secondaryVendeurCountry": { "type": [ "null", "string" ] }, "secondaryVendeurInvoiceNumber": { "type": [ "null", "string" ] } } }, "InvoiceSnapshotDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "invoiceNumber": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "buyerExternalId": { "type": [ "null", "string" ] }, "issueDate": { "type": [ "null", "string" ], "format": "date-time" }, "dueDate": { "type": [ "null", "string" ], "format": "date-time" }, "note": { "type": [ "null", "string" ] }, "orderReference": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "isCreditNote": { "type": "boolean" }, "taxExclusiveAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "taxInclusiveAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "taxTotalAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "payableAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "lines": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/InvoiceSnapshotLineDto" } } } }, "InvoiceSnapshotLineDto": { "type": "object", "properties": { "lineId": { "type": [ "null", "string" ] }, "quantity": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "priceAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "lineExtensionAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "taxPercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "itemDescription": { "type": [ "null", "string" ] }, "ledgerAccountCode": { "type": [ "null", "string" ] } } }, "InvoiceType": { "type": "integer" }, "MergeContactsCommand": { "required": [ "winnerId", "loserId" ], "type": "object", "properties": { "winnerId": { "type": "string", "format": "uuid" }, "loserId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" } } }, "PatchExternalDocumentNoRequest": { "type": "object", "properties": { "externalDocumentNo": { "type": [ "null", "string" ] } } }, "PatchInvoiceB2BFieldsCommand": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "b2BInvoiceId": { "type": [ "null", "string" ] }, "b2BContactId": { "type": [ "null", "string" ] }, "b2BStatus": { "type": [ "null", "string" ] }, "createdDate": { "type": [ "null", "string" ], "format": "date-time" } } }, "PatchInvoiceDeliveryStatusCommand": { "required": [ "id", "status" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PatchInvoiceDocumentTypeCommand": { "required": [ "id", "documentType" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "documentType": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PatchInvoiceStatusCommand": { "required": [ "id", "status" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PeppolValidationIssue": { "type": "object", "properties": { "code": { "type": [ "null", "string" ] }, "field": { "type": [ "null", "string" ] }, "message": { "type": [ "null", "string" ] } } }, "PeppolValidationResult": { "type": "object", "properties": { "isValid": { "type": "boolean" }, "recommendedTransport": { "type": [ "null", "string" ] }, "errors": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PeppolValidationIssue" } }, "warnings": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PeppolValidationIssue" } } } }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] } } }, "RemapDeliveryAuditStatusCommand": { "required": [ "deliveryId", "oldStatus", "newStatus" ], "type": "object", "properties": { "deliveryId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "oldStatus": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "newStatus": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ResponseDto": { "type": "object", "properties": { "returnValue": { "type": "string" }, "errorMessage": { "type": "string" } } }, "SelfBillingMandateDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "issuerCompanyId": { "type": "string", "format": "uuid" }, "direction": { "type": [ "null", "string" ] }, "counterpartyContactId": { "type": [ "null", "string" ], "format": "uuid" }, "counterpartyIdentifier": { "type": [ "null", "string" ] }, "depositedByUs": { "type": "boolean" }, "sellerScheme": { "type": [ "null", "string" ] }, "sellerIdentifier": { "type": [ "null", "string" ] }, "sellerLegalName": { "type": [ "null", "string" ] }, "sellerVatNumber": { "type": [ "null", "string" ] }, "sellerCountry": { "type": [ "null", "string" ] }, "sellerVatRegime": { "type": [ "null", "string" ] }, "mode": { "type": [ "null", "string" ] }, "effectiveFrom": { "type": "string", "format": "date" }, "effectiveTo": { "type": [ "null", "string" ], "format": "date" }, "mandateProofUrl": { "type": [ "null", "string" ] }, "invoiceSequencePrefix": { "type": [ "null", "string" ] }, "state": { "type": [ "null", "string" ] }, "revokedAtUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "SubmitFrStatusCommand": { "type": "object", "properties": { "invoiceId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "code": { "type": [ "null", "string" ] }, "motifCode": { "type": [ "null", "string" ] }, "motifText": { "type": [ "null", "string" ] }, "actionAttendue": { "type": [ "null", "string" ] }, "encaissement": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/EncaissementBreakdown" } } } }, "Tax": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "percent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "comment": { "type": [ "null", "string" ] } } }, "TriggerExportResult": { "type": "object", "properties": { "queued": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "skipped": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "UblAttachmentPayload": { "type": "object", "properties": { "base64": { "type": [ "null", "string" ] }, "filename": { "type": [ "null", "string" ] }, "mimeCode": { "type": [ "null", "string" ] } } }, "UpdateContactAddressCommand": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "countryId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "addressType": { "type": [ "null", "string" ] }, "streetName": { "type": [ "null", "string" ] }, "buildingNumber": { "type": [ "null", "string" ] }, "additionalStreetName": { "type": [ "null", "string" ] }, "cityName": { "type": [ "null", "string" ] }, "postalZone": { "type": [ "null", "string" ] }, "countrySubentity": { "type": [ "null", "string" ] } } }, "UpdateContactBankAccountCommand": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "accountId": { "type": [ "null", "string" ] }, "accountName": { "type": [ "null", "string" ] }, "bankId": { "type": [ "null", "string" ] }, "bankName": { "type": [ "null", "string" ] }, "isDefault": { "type": "boolean" } } }, "UpdateContactCommand": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "name": { "type": [ "null", "string" ] }, "legalName": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "endpointId": { "type": [ "null", "string" ] }, "endpointSchemeId": { "type": [ "null", "string" ] }, "vatId": { "type": [ "null", "string" ] }, "companyRegistrationId": { "type": [ "null", "string" ] }, "countryCode": { "type": [ "null", "string" ] }, "externalId": { "type": [ "null", "string" ] }, "frenchBillingFrame": { "type": [ "null", "string" ] }, "autoApproveFrInvoices": { "type": [ "null", "boolean" ] }, "isConsumer": { "type": [ "null", "boolean" ] }, "isIntegrationUpsert": { "type": "boolean" }, "addresses": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/UpdateContactAddressCommand" } }, "identifiers": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/UpdateContactIdentifierCommand" } }, "bankAccounts": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/UpdateContactBankAccountCommand" } }, "contactPoints": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/UpdateContactPointCommand" } } } }, "UpdateContactIdentifierCommand": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "identifier": { "type": [ "null", "string" ] }, "schemeId": { "type": [ "null", "string" ] }, "isVat": { "type": "boolean" }, "isCompanyRegistration": { "type": "boolean" } } }, "UpdateContactPointCommand": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "department": { "type": [ "null", "string" ] }, "contactName": { "type": [ "null", "string" ] }, "telephone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "endpointId": { "type": [ "null", "string" ] }, "endpointSchemeId": { "type": [ "null", "string" ] }, "isDefault": { "type": "boolean" }, "countryId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "streetName": { "type": [ "null", "string" ] }, "buildingNumber": { "type": [ "null", "string" ] }, "additionalStreetName": { "type": [ "null", "string" ] }, "cityName": { "type": [ "null", "string" ] }, "postalZone": { "type": [ "null", "string" ] }, "countrySubentity": { "type": [ "null", "string" ] } } }, "UpdateInvoiceCommand": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "contactId": { "type": "string", "format": "uuid" }, "receiverContactPointId": { "type": [ "null", "string" ], "format": "uuid" }, "customizationId": { "type": [ "null", "string" ] }, "profileId": { "type": [ "null", "string" ] }, "invoiceNumber": { "type": [ "null", "string" ] }, "externalDocumentNo": { "type": [ "null", "string" ] }, "documentType": { "$ref": "#/components/schemas/DocumentType" }, "issueDate": { "type": "string", "format": "date-time" }, "currencyCode": { "type": [ "null", "string" ] }, "taxPointDate": { "type": [ "null", "string" ], "format": "date-time" }, "taxPointDateCode": { "maxLength": 3, "minLength": 0, "type": [ "null", "string" ] }, "taxCurrencyCode": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "note": { "type": [ "null", "string" ] }, "buyerReference": { "type": [ "null", "string" ] }, "orderReference": { "type": [ "null", "string" ] }, "contractReference": { "type": [ "null", "string" ] }, "projectReference": { "type": [ "null", "string" ] }, "costCentre": { "type": [ "null", "string" ] }, "orderReferenceDate": { "type": [ "null", "string" ], "format": "date-time" }, "contractReferenceDate": { "type": [ "null", "string" ], "format": "date-time" }, "despatchReference": { "type": [ "null", "string" ] }, "despatchReferenceDate": { "type": [ "null", "string" ], "format": "date-time" }, "dueDate": { "type": [ "null", "string" ], "format": "date-time" }, "paymentMeansCode": { "type": [ "null", "string" ] }, "paymentTerms": { "type": [ "null", "string" ] }, "paymentAccountId": { "type": [ "null", "string" ] }, "paymentAccountBic": { "type": [ "null", "string" ] }, "lineExtensionAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "taxExclusiveAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "taxInclusiveAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "allowanceTotalAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "chargeTotalAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "payableRoundingAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "payableAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "taxTotalAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "isCreditNote": { "type": "boolean" }, "precedingInvoiceNumber": { "type": [ "null", "string" ] }, "precedingInvoiceDate": { "type": [ "null", "string" ], "format": "date-time" }, "isReadOnly": { "type": "boolean" }, "sourceSystem": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "b2BStatus": { "type": [ "null", "string" ] }, "sendMethod": { "type": [ "null", "string" ] }, "frenchBillingFrame": { "type": [ "null", "string" ] }, "factoringContractId": { "type": [ "null", "string" ], "format": "uuid" }, "factorIdentifier": { "type": [ "null", "string" ] }, "isSelfBilled": { "type": [ "null", "boolean" ] }, "selfBillingMandateId": { "type": [ "null", "string" ], "format": "uuid" }, "selfBillingMandateIdentifier": { "type": [ "null", "string" ] }, "isAlreadyPaid": { "type": "boolean" }, "paidAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "lines": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/InvoiceLineDTO" } } } }, "UpdateMyCompanyCommand": { "type": "object", "properties": { "companyId": { "type": "string", "format": "uuid" }, "name": { "type": [ "null", "string" ] }, "address": { "type": [ "null", "string" ] }, "address2": { "type": [ "null", "string" ] }, "zipCode": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "phoneNumber": { "type": [ "null", "string" ] }, "website": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "vatNumber": { "type": [ "null", "string" ] }, "countryId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "currencyId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "languageId": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "logo": { "type": [ "null", "string" ], "format": "byte" } } }, "UpdateWebhookSubscriptionCommand": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "callbackUrl": { "type": [ "null", "string" ] }, "secret": { "type": [ "null", "string" ] }, "isEnabled": { "type": [ "null", "boolean" ] }, "description": { "type": [ "null", "string" ] }, "subscribedEvents": { "type": [ "null", "array" ], "items": { "type": "string" } }, "customHeaders": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" } }, "allowedIps": { "type": [ "null", "array" ], "items": { "type": "string" } }, "rateLimitPerMinute": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "UpsertContactPointByNameCommand": { "type": "object", "properties": { "contactId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "department": { "type": [ "null", "string" ] }, "contactName": { "type": [ "null", "string" ] }, "telephone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "endpointId": { "type": [ "null", "string" ] }, "endpointSchemeId": { "type": [ "null", "string" ] }, "isDefault": { "type": "boolean" } } }, "VATCheckerResult": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "address": { "type": [ "null", "string" ] }, "zipcode": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "region": { "type": [ "null", "string" ] }, "countryCode": { "type": [ "null", "string" ] }, "vatNumber": { "type": [ "null", "string" ] }, "valid": { "type": "boolean" } } }, "WebhookEventDTO": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "eventType": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "createdAtUtc": { "type": "string", "format": "date-time" }, "processedAtUtc": { "type": [ "null", "string" ], "format": "date-time" }, "invoiceDeliveryId": { "type": [ "null", "string" ], "format": "uuid" }, "invoiceId": { "type": [ "null", "string" ], "format": "uuid" } } }, "WebhookSubscriptionDTO": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "callbackUrl": { "type": [ "null", "string" ] }, "isEnabled": { "type": "boolean" }, "description": { "type": [ "null", "string" ] }, "subscribedEvents": { "type": [ "null", "array" ], "items": { "type": "string" } }, "customHeaders": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" } }, "allowedIps": { "type": [ "null", "array" ], "items": { "type": "string" } }, "rateLimitPerMinute": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedDate": { "type": [ "null", "string" ], "format": "date-time" } } } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "description": "API key for authentication. Provide your GUID key.", "name": "X-Api-Key", "in": "header" } } }, "security": [ { "ApiKey": [ ] } ], "tags": [ { "name": "AvalaraWebhook" }, { "name": "Coda" }, { "name": "Company" }, { "name": "Contact" }, { "name": "EReporting" }, { "name": "InboundMail" }, { "name": "InvoiceAttachment" }, { "name": "Invoice" }, { "name": "InvoiceDelivery" }, { "name": "SelfBillingMandate" }, { "name": "Vies" }, { "name": "Webhook" } ] }