The Soluz.io API allows you to integrate the Soluz.io Services directly into your software solutions.
\nThe easiest way to get started with the API is to click the Run in Postman button present at the top of the documentation page and use the Postman App to send requests.
\nYou need a valid API Key to send request to the API endpoints. For more information on how to get your key, please view the Authentication section.
\nThe Soluz.io API will only respond to secured communication done over HTTPS.
HTTP requests will be sent a 301 redirect to corresponding HTTPS resources.
Response to every request is sent in JSON format. In case the API request results in an error, it is represented by an \"error\": {} key in the JSON response.
The request method (verb) determines the nature of action you intend to perform.
A request made using the GET method implies that you want to fetch something from our API, a PUT implies you want to update something existing and POST implies you want to save something new to our backend.
The API calls will respond with appropriate HTTP status codes for all requests. Within Postman Client, when a response is received, the status code is highlighted and is accompanied by a help text that indicates the possible meaning of the response code. A 200 OK indicates all went well, while 4XX or 5XX response codes indicate an error from the requesting client or our API servers respectively.
Individual resources in your Postman Account is accessible using its unique id (uid). The uid is a simple concatenation of the resource owner's user-id and the resource-id. For example, a collection's uid is {{owner_id}}-{{collection_id}}.
Create an environment with the variable baseUrl, or add the baseUrl variable to your existing environments.
Following environments exist for the Soluz.io API:
PRODUCTION https://api.soluz.io/
\nAn API Key is required to be sent as part of every request to the Soluz.io API, in the form of an API Key Authorization request header.
\n\nAn API Key tells our API server that the request it received came from you. Everything that you have access to in Postman is accessible with an API Key that is generated by you.
\n
For ease of use inside Postman, you could store your API key in an environment variable called apikey
This Collection will automatically use it to make API calls.
If you do not yet have an API Key, you can easily generate one by following these steps:
\nLogin to your Soluz.io environment
\nSelect your Solution
\nSelect the company you want to create the API Key for. Note: this API key will allow you to retrieve documents for this company and this company only.
\nClick on \"Connections\"
\nScroll to the bottom and under the section \"Generic connections\" click on \"Api\".
\nComplete the steps to create your API Key.
\nIf an API Key is missing, malformed, or invalid, you will receive a 401 Unauthorized response code and the following JSON response:
{\n \"message\": \"Authorization has been denied for this request.\"\n}\n\nFor help regarding accessing the Soluz.io API you can contact us at info@soluz.io.
\nFor information on API terms of use and privacy, refer to our policy document at https://www.soluz.io/privacy-policy
\nx-api-key
\n","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//outbound/companies","description":"Returns all companies in the current tenant that your API key has access to.
\nThe id of each company is its PartyId. Every other request in this API is made for one company and takes this value as {partyId} in the URL.
Usage
\nResponses
\n200 OK: the companies your API key has access to.401 Unauthorized: the API key is missing or not valid.x-api-key
\n","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//outbound/companies/:partyId","description":"Returns a single company of the current tenant.
\nUsage
\npartyId is the id returned by GET /outbound/companies.id in the response is the same PartyId: use it as {partyId} in all other requests.Responses
\n200 OK: the company.404 Not Found: there is no company with this PartyId that your API key has access to.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
x-api-key
\n","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//outbound/companies/:partyId/invoices/:id","description":"Returns all details of a sent invoice: header, customer, supplier, totals, detail lines, payment information (including the payment link) and references. For countries with clearance, the clearance reference and date are included once available.
\nUsage
\nid is the id returned when the invoice was uploaded, or the id from the invoice search or the inbox.Responses
\n200 OK: the invoice.404 Not Found: unknown PartyId or invoice.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
The id of the invoice, as returned by the upload, the search or the inbox.
x-api-key
\n","key":"Authorization","value":"string"},{"key":"Accept","value":"application/octet-stream"}],"url":"https://api.soluz.io//outbound/companies/:partyId/invoices/:id/:format","description":"Downloads one or more files of a sent invoice.
\nUsage\nformat selects the files:
ubl: the UBL invoice (XML).pdf or image: the PDF of the invoice.attachments: all additional attachments.ublandimage: the UBL and the PDF.all: the UBL, the PDF and all attachments.xml: the files in the XML package of the invoice.When one file matches, it is returned as is (for example a PDF or XML). When several files match, they are returned together in one ZIP file. Every download is recorded in the audit trail of the invoice.
\nResponses
\n200 OK: the file, or a ZIP file with the matching files.404 Not Found: unknown PartyId or invoice, or no file matches format.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
The id of the invoice.
Which files to download: ubl, pdf, image, attachments, ublandimage, all, xml or a file ID.
\n","type":"text/plain"},"type":"any","value":"string","key":"format"}]}},"response":[{"id":"8692c409-93bd-435e-a46b-7392427a96c9","name":"200","originalRequest":{"method":"GET","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/octet-stream"}],"url":{"raw":"https://api.soluz.io//outbound/companies/:partyId/invoices/:id/:format","host":["https://api.soluz.io/"],"path":["outbound","companies",":partyId","invoices",":id",":format"],"variable":[{"key":"partyId","value":"5539","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"5539","description":"The `id` of the invoice."},{"key":"format","value":"string","description":"Which files to download: ubl, pdf, image, attachments, ublandimage, all, xml or a file ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/octet-stream"}],"cookie":[],"responseTime":null,"body":"null"},{"id":"ea7494a6-7432-439d-9d41-48d2aabbf601","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//outbound/companies/:partyId/invoices/:id/:format","host":["https://api.soluz.io/"],"path":["outbound","companies",":partyId","invoices",":id",":format"],"variable":[{"key":"partyId","value":"5539","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"5539","description":"The `id` of the invoice."},{"key":"format","value":"string","description":"Which files to download: ubl, pdf, image, attachments, ublandimage, all, xml or a file ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"message\": \"string\"\n}"},{"id":"04974d6f-398e-46d6-88b3-f9964510a054","name":"NotFound","originalRequest":{"method":"GET","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//outbound/companies/:partyId/invoices/:id/:format","host":["https://api.soluz.io/"],"path":["outbound","companies",":partyId","invoices",":id",":format"],"variable":[{"key":"partyId","value":"5539","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"5539","description":"The `id` of the invoice."},{"key":"format","value":"string","description":"Which files to download: ubl, pdf, image, attachments, ublandimage, all, xml or a file ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"statusCode\": 1862,\n\t\"message\": \"string\"\n}"}],"_postman_id":"644ee7cc-a921-4f07-902c-b731dca62179"},{"name":"Get invoice audit","id":"791bc66b-18f9-43a8-bc5f-fc38abe5f738","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"x-api-key
\n","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//outbound/companies/:partyId/invoices/:id/audit","description":"Returns the audit trail of one invoice: every processing step, with a code, a text and a timestamp, for example when it was received, converted, sent or downloaded.
\nUsage
\nResponses
\n200 OK: the audit entries of the invoice.404 Not Found: unknown PartyId or invoice.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
The id of the invoice.
x-api-key
\n","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//outbound/companies/:partyId/invoices/:id/feedback","description":"Returns the feedback received for one invoice, such as errors, warnings and information about its delivery or validation. Each entry has a type, a code, a text and a timestamp.
\nUsage
\nResponses
\n200 OK: the feedback entries of the invoice.404 Not Found: unknown PartyId or invoice.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
The id of the invoice.
x-api-key
\n","key":"Authorization","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"invoicedate-from\": \"(string,date) The start date for the invoice date range. Example: 1951-09-07T18:14:00.209Z\",\n\t\"invoicedate-to\": \"(string,date) The end date for the invoice date range. Example: 2010-06-27T14:00:39.906Z\",\n\t\"invoiceNumber\": \"(string) The invoice number. Example: SOL-1200\",\n\t\"objectId\": \"(string) Object id of the document. Example: 4728\",\n\t\"uniqueId\": \"(string) Unique id of the document. Example: 1095953\",\n\t\"page\": {\n\t\t\"page-number\": \"(number) Page number. Example: 2\",\n\t\t\"records-per-page\": \"(number) Amount of records per page. Example: 25\"\n\t},\n\t\"status\": \"(string) Filter on status. Example: PENDING\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.soluz.io//outbound/companies/:partyId/invoices/search","description":"Searches the sent invoices of the company and returns one page of results.
\nUsage
\ninvoicedate-from and invoicedate-to are required. Only invoices with an invoice date in this range (both dates included) are returned. Format: YYYY-MM-DD.invoiceNumber (exact match), objectId and uniqueId. All filled-in filters must match.page: page-number starts at 1. records-per-page defaults to 20 and is capped at 100. Use totalPages in the response to fetch the next pages.id of a result for all details.Responses
\n200 OK: the current page, the number of totalPages and the matching invoices.400 Bad Request: the request body is missing or not valid, for example without the invoice date range.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
x-api-key
\n","key":"Authorization","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"transactionId\": \"(string) Filter on TransactionId. Example: 2AF410E4DEF234DB89918E6EEC7DF825\",\n\t\"page\": \"(number) The requested page (default = 1). Example: 1\",\n\t\"from\": \"(string, date, required) Start date of the audit period (YYYY-MM-DD). Example: 2023-11-01\",\n\t\"to\": \"(string, date) End date of the audit period (YYYY-MM-DD). Example: 2023-11-30\",\n\t\"objectId\": \"(number) ObjectId to search on. Example: 4728\",\n\t\"externalReference\": \"(string) External reference identifier. Example: EXT-2023-091\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.soluz.io//outbound/companies/:partyId/invoices/audit","description":"Searches the audit trail of the invoices of the company and returns one page of entries (50 per page).
\nUsage
\nobjectId (the invoice id) or transactionId. from is required; to is optional.from and to. The period can be at most 30 days.externalReference narrows the results further.page is the page number, starting at 1 (default 1). Use totalPages in the response to fetch the next pages.Responses
\n200 OK: the current page, the number of totalPages and the audit entries.400 Bad Request: the body is missing or not valid, the period is longer than 30 days, or only one of from and to is given for a search over all invoices.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
x-api-key
\n","key":"Authorization","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"from\": \"1987-08-18T00:43:51.543Z\",\n\t\"transactionId\": \"string\",\n\t\"page\": 2912,\n\t\"to\": \"1996-12-11T00:53:52.387Z\",\n\t\"objectId\": 212,\n\t\"externalReference\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.soluz.io//outbound/companies/:partyId/invoices/feedback","description":"Searches the feedback of the invoices of the company and returns one page of entries (50 per page).
\nUsage
\nobjectId (the invoice id) or transactionId. from is required; to is optional.from and to. The period can be at most 30 days.externalReference narrows the results further.page is the page number, starting at 1 (default 1). Use totalPages in the response to fetch the next pages.Responses
\n200 OK: the current page, the number of totalPages and the feedback entries.400 Bad Request: the body is missing or not valid, the period is longer than 30 days, or only one of from and to is given for a search over all invoices.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
x-api-key
\n","key":"Authorization","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"details\": {\n\t\t\"documentNumber\": \"(string) Unique invoice number in sender's system. Example: DEMO/00092\",\n\t\t\"invoiceNumber\": \"(string) Invoice number as shown on the document. Example: 23110000291\",\n\t\t\"currency\": \"(string, required) ISO 4217 currency code. Example: EUR\",\n\t\t\"date\": \"(string, required) Invoice issue date (YYYY-MM-DD). Example: 2022-12-02\",\n\t\t\"dueDate\": \"(string) Due date for payment (YYYY-MM-DD). In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present. Example: 2023-12-07\",\n\t\t\"note\": \"(string) Free text note printed on the invoice. Example: Note van de factuur\",\n\t\t\"structuredCommunication\": \"(string) A textual value used to establish a link between the payment and the Invoice, issued by the Seller. Used for creditor's critical reconciliation information. This information element helps the Seller to assign an incoming payment to the relevant payment process. Example: +++123/569858/336+++\",\n\t\t\"type\": \"(string, required) Document type: Invoice, CreditNote. Example: Invoice\",\n\t\t\"typeCode\": \"(string) Document type code (e.g. 380=Invoice, 381=CreditNote). Example: 380\",\n\t\t\"serviceBeginDate\": \"(string, date) Service period start (YYYY-MM-DD). Example: 2022-12-01\",\n\t\t\"serviceEndDate\": \"(string, date) Service period end (YYYY-MM-DD). Example: 2022-12-31\",\n\t\t\"taxPointDate\": \"(string, date) Tax point date (YYYY-MM-DD). Example: 2022-12-22\",\n\t\t\"placeOfIssue\": \"(string) Place where the invoice was issued\",\n\t\t\"fullyPaid\": \"(boolean) Indicates if an invoice has been paid\",\n\t\t\"dateOfFullPayment\": \"(string) date of payment\",\n\t\t\"simplifiedTriangularProcedure\": \"(string) Indication if invoice is issued under simplified procedure by the second taxpayer\",\n\t\t\"checkoutMethod\": \"(boolean) Cash accounting indicator\",\n\t\t\"selfBillingIndicator\": \"(boolean) Self-billing indicator\",\n\t\t\"warehouseDocumentNumbers\": \"(string) WZ (delivery note) document numbers\",\n\t\t\"typeName\": \"(string) Invoice type name\",\n\t\t\"restrictedInformation\": \"(string) Indicator if Invoice referred to in Art. 109 sec. 3d of the Act\",\n\t\t\"invoicePeriodDescriptionCode\": \"(string) Coded description of the invoice period. Max 50 characters. Example: 3\",\n\t\t\"deliveryTermsId\": \"(string) Delivery terms identifier. Max 200 characters. Example: CIF\",\n\t\t\"deliveryTermsDeliveryLocationName\": \"(string) Name of the location the delivery terms apply to. Max 200 characters. Example: Port of Antwerp\",\n\t\t\"contractDocReferenceTypeCode\": \"(string) Document type code of the referenced contract. Max 100 characters. Example: 130\",\n\t\t\"references\": {\n\t\t\t\"accountingCost\": \"(string) Buyer accounting reference Cost center or internal accounting code. A textual value that specifies where to book the relevant data into the Buyer's financial accounts. Example: 4217:2323:2323\",\n\t\t\t\"billingReferences\": [\n\t\t\t\t{\n\t\t\t\t\t\"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n\t\t\t\t\t\"invoiceDocumentReferenceIssueDate\": \"(DateTime) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n\t\t\t\t\t\"reasonForCorrection\": \"(string) Reason for correction\",\n\t\t\t\t\t\"externalReference\": \"(string) Number identifying the corrected invoice in the National System of e-Invoices\",\n\t\t\t\t\t\"typeOfCorrection\": \"(string) Type of correction\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"buyerReference\": \"(string) Buyer reference or procurement ID. An invoice must have buyer reference or purchase order reference (BT-13) Example: ABC/984/B2\",\n\t\t\t\"purchaseOrderReference\": \"(string) Purchase order number. An invoice must have buyer reference (BT-10) or purchase order reference Example: OR1256\",\n\t\t\t\"contractDocReference\": \"(string) Contract identifier by seller. Example: CT-2022-001\",\n\t\t\t\"contractDocIssueDate\": \"(string, date) Contract date by seller (YYYY-MM-DD). Example: 2022-01-15\",\n\t\t\t\"contractDocReferenceCustomer\": \"(string) Contract identifier by customer. Example: CUST-CT-88\",\n\t\t\t\"contractDocIssueDateCustomer\": \"(string, date) Contract date by customer (YYYY-MM-DD). Example: 2022-01-20\",\n\t\t\t\"despatchDocReference\": \"(string) Dispatch advice ID. Example: DESP-993\",\n\t\t\t\"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n\t\t\t\"invoiceDocumentReferenceIssueDate\": \"(DateTime) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n\t\t\t\"originatorDocReference\": \"(string) Tender or lot reference. Example: TND-2022-01\",\n\t\t\t\"projectReference\": \"(string) Project reference. Example: PROJ-Delta-01\",\n\t\t\t\"receiptDocReference\": \"(string) Receiving advice ID. Example: RCPT-331\",\n\t\t\t\"salesOrderReference\": \"(string) Seller’s sales order ID. Example: SO-10099\",\n\t\t\t\"salesOrderIssueDate\": \"(string, date) Sales order date (YYYY-MM-DD). Example: 2022-05-18\"\n\t\t},\n\t\t\"customer\": {\n\t\t\t\"id\": \"(string) Internal customer ID in sender’s system. Example: CUST1\",\n\t\t\t\"name\": \"(string, required) Customer name. Example: Soluz.io\",\n\t\t\t\"address\": {\n\t\t\t\t\"address1\": \"(string, required) Street and number. Example: Zwartzustersvest 24\",\n\t\t\t\t\"address2\": \"(string) Address line 2. Example: Unit 5\",\n\t\t\t\t\"address3\": \"(string) Address line 3. Example: c/o Accounts\",\n\t\t\t\t\"city\": \"(string, required) City. Example: Mechelen\",\n\t\t\t\t\"zip\": \"(string, required) Postal code. Example: 2810\",\n\t\t\t\t\"countryCode\": \"(string, required) ISO 3166-1 alpha-2 country code. Example: BE\",\n\t\t\t\t\"province\": \"(string) State/Province/Region. Example: Antwerpen\"\n\t\t\t},\n\t\t\t\"contact\": {\n\t\t\t\t\"name\": \"(string) Contact person. Example: Jan Peeters\",\n\t\t\t\t\"email\": \"(string) Contact email. Example: jan@soluz.io\",\n\t\t\t\t\"phone\": \"(string) Contact phone. Example: +3215999888\"\n\t\t\t},\n\t\t\t\"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n\t\t\t\"department\": \"(string) Department or branch. Example: DevelopmentDepartment\",\n\t\t\t\"vatNumber\": \"(string) Customer VAT number. Example: BE0123456749\",\n\t\t\t\"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n\t\t\t\"endpointId\": \"(string) Electronic endpoint identifier. Example: 0208:be2929035935\",\n\t\t\t\"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 0208\"\n\t\t},\n\t\t\"delivery\": {\n\t\t\t\"actualDeliveryDate\": \"(string, date) Delivery date (YYYY-MM-DD). Example: 2023-01-03\",\n\t\t\t\"address\": {\n\t\t\t\t\"address1\": \"(string)(required in case address is filled) Street and number. Example: Berendries 52\",\n\t\t\t\t\"address2\": \"(string) Example: Building A\",\n\t\t\t\t\"address3\": \"(string) Example: Floor 2\",\n\t\t\t\t\"city\": \"(string) City. Example: Lovendegem\",\n\t\t\t\t\"zip\": \"(string) Postal code. Example: 5400\",\n\t\t\t\t\"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n\t\t\t\t\"province\": \"(string) Province/region. Example: O-Vl\"\n\t\t\t},\n\t\t\t\"name\": \"(string) Receiver name or delivery contact. Example: Soluz.io afleveradres\",\n\t\t\t\"locationIdentifier\": {\n\t\t\t\t\"id\": \"(string) Location identifier (GLN or other). Example: 5412345000013\",\n\t\t\t\t\"schemeId\": \"(string) Scheme ID for location. Example: GLN\"\n\t\t\t}\n\t\t},\n\t\t\"paymentMeans\": {\n\t\t\t\"code\": \"(string) The means, expressed as code, for how a payment is expected to be or has been settled. (e.g., UN/CEFACT 4461). Example: ZZZ\",\n\t\t\t\"text\": \"(string) Description of payment means. Example: Bank transfer\",\n\t\t\t\"mandateId\": \"(string) Unique identifier assigned by the Payee for referencing the direct debit mandate. Used in order to pre-notify the Buyer of a SEPA direct debit. Example: MandateId\",\n\t\t\t\"mandateFinancialAccountId\": \"(string) The account to be debited by the direct debit. Example: MandateFinancialAccountId\",\n\t\t\t\"paymentId\": \"(string) Payment reference to be used by the payer. Example: PMT-2023-001\",\n\t\t\t\"payeeFinancialInstitutionId\": \"(string) Identifier of Payee's bank (BIC, etc.). Example: KREDBEBB\",\n\t\t\t\"payeeFinancialAccountId\": \"(string) Payee’s bank account (IBAN, etc.). Example: BE49000023121121\",\n\t\t\t\"payeeFinancialAccountSchemeId\": \"(string) Scheme ID of Payee’s bank account (e.g. IBAN). Example: IBAN\",\n\t\t\t\"payeeFinancialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\"\n\t\t},\n\t\t\"multiplePaymentMeans\": [\n\t\t\t{\n\t\t\t\t\"code\": \"(string) The means, expressed as code, for how a payment is expected to be or has been settled (e.g. UN/CEFACT 4461). Example: 30\",\n\t\t\t\t\"text\": \"(string) Description of payment means. Example: Bank transfer\",\n\t\t\t\t\"mandateId\": \"(string) Unique identifier assigned by the Payee for referencing the direct debit mandate. Example: MandateId\",\n\t\t\t\t\"mandateFinancialAccountId\": \"(string) The account to be debited by the direct debit. Example: MandateFinancialAccountId\",\n\t\t\t\t\"paymentId\": \"(string) Payment reference to be used by the payer. Example: PMT-2023-001\",\n\t\t\t\t\"payeeFinancialInstitutionId\": \"(string) Identifier of Payee's bank (BIC, etc.). Example: KREDBEBB\",\n\t\t\t\t\"payeeFinancialAccountId\": \"(string) Payee's bank account (IBAN, etc.). Example: BE49000023121121\",\n\t\t\t\t\"payeeFinancialAccountSchemeId\": \"(string) Scheme ID of Payee's bank account (e.g. IBAN). Example: IBAN\",\n\t\t\t\t\"payeeFinancialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\"\n\t\t\t}\n\t\t],\n\t\t\"payee\": {\n\t\t\t\"companyNumber\": \"(string) This element is used for both the identification of the Payee, or the unique banking reference identifier of Payee (assigned by the Payee bank.) For payee identification use ICD code list, for SEPA bank assigned creditor reference, use SEPA. Example: BE0123456749\",\n\t\t\t\"financialAccountId\": \"(string) Payee’s IBAN. Example: BE49000023121121\",\n\t\t\t\"financialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\",\n\t\t\t\"name\": \"(string) Name of payee. Example: PayeeName\"\n\t\t},\n\t\t\"paymentTerms\": {\n\t\t\t\"text\": \"(string) A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties). Example: Payment in 30 days\",\n\t\t\t\"settlementDiscountPercentage\": \"(number) Early payment discount percentage. If not filled in but SettlementDiscountPercentage is, this value will be calculated based on SettlementDiscountPercentage. Example: 2\",\n\t\t\t\"settlementDiscountAmount\": \"(number) Early payment discount absolute amount. If not filled in but SettlementDiscountAmount is, this value will be calculated based on SettlementDiscountAmount Example: 50.00\"\n\t\t},\n\t\t\"supplier\": {\n\t\t\t\"id\": \"(string) Internal supplier ID in sender’s system. Example: SUP1\",\n\t\t\t\"name\": \"(string, required) Supplier name. Example: Soluz.io\",\n\t\t\t\"address\": {\n\t\t\t\t\"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n\t\t\t\t\"address2\": \"(string) Example: Tax 1\",\n\t\t\t\t\"address3\": \"(string) Example: Tax 3\",\n\t\t\t\t\"city\": \"(string) City. Example: Tax Mechelen\",\n\t\t\t\t\"zip\": \"(string) Postal code. Example: Tax 2800\",\n\t\t\t\t\"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n\t\t\t\t\"province\": \"(string) Province. Example: Vl-Br\",\n\t\t\t\t\"taxpayersPrefix\": \"(string) VAT UE country prefix (e.g. PL) for intra-Community supplies, cross-border services, and triangular transactions.\"\n\t\t\t},\n\t\t\t\"contact\": {\n\t\t\t\t\"name\": \"(string) Contact person. Example: Jan Peeters\",\n\t\t\t\t\"email\": \"(string) Contact email. Example: jan@soluz.io\",\n\t\t\t\t\"phone\": \"(string) Contact phone. Example: +3215999888\"\n\t\t\t},\n\t\t\t\"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n\t\t\t\"department\": \"(string) Department or branch. Example: DevelopmentDepartment\",\n\t\t\t\"vatNumber\": \"(string) Customer VAT number. Example: BE0123456749\",\n\t\t\t\"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n\t\t\t\"endpointId\": \"(string) Electronic endpoint identifier. Example: 0208:be2929035935\",\n\t\t\t\"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 0208\"\n\t\t},\n\t\t\"buyer\": {\n\t\t\t\"name\": \"(string) Buyer name. Example: Soluz.io\",\n\t\t\t\"address\": {\n\t\t\t\t\"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n\t\t\t\t\"zip\": \"(string) Postal code. Example: Tax 2800\",\n\t\t\t\t\"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n\t\t\t\t\"province\": \"(string) Province. Example: Vl-Br\"\n\t\t\t},\n\t\t\t\"contact\": {\n\t\t\t\t\"name\": \"(string) Contact person. Example: Jan Peeters\",\n\t\t\t\t\"email\": \"(string) Contact email. Example: jan@soluz.io\",\n\t\t\t\t\"phone\": \"(string) Contact phone. Example: +3215999888\"\n\t\t\t},\n\t\t\t\"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n\t\t\t\"companyNumberType\": \"(string) Company number type\",\n\t\t\t\"vatNumber\": \"(string) Buyer VAT number. Example: BE0123456749\",\n\t\t\t\"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n\t\t\t\"RecipientType\": \"(string) Flag to indicate Subordinate Local Government Unit or GV member\"\n\t\t},\n\t\t\"taxRepresentative\": {\n\t\t\t\"address\": {\n\t\t\t\t\"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n\t\t\t\t\"address2\": \"(string) Example: Tax 1\",\n\t\t\t\t\"address3\": \"(string) Example: Tax 3\",\n\t\t\t\t\"city\": \"(string) City. Example: Tax Mechelen\",\n\t\t\t\t\"zip\": \"(string) Postal code. Example: Tax 2800\",\n\t\t\t\t\"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n\t\t\t\t\"province\": \"(string) Province. Example: Vl-Br\"\n\t\t\t},\n\t\t\t\"name\": \"(string) Tax representative name. Example: Tax Soluz.io\",\n\t\t\t\"vatNumber\": \"(string) VAT number. Example: BE000000097\"\n\t\t},\n\t\t\"discount\": {\n\t\t\t\"amount\": \"(number) The discount amount. If not filled in but Percentage is, this value will be calculated based on Percentage. Example: 50\",\n\t\t\t\"percentage\": \"(number) The discount percentage. If not filled in but Amount is, this value will be calculated based on Amount. Example: 10\",\n\t\t\t\"reason\": \"(string) Reason for discount. Example: extra korting van 10%\"\n\t\t},\n\t\t\"charge\": {\n\t\t\t\"amount\": \"(number) Additional charge excl. VAT. Example: 10\",\n\t\t\t\"vatRate\": \"(number) VAT rate on charge. Example: 21\",\n\t\t\t\"vatCode\": \"(string) VAT category code for charge. Example: S\",\n\t\t\t\"reason\": \"(string) Reason for charge. Example: Handling fee\"\n\t\t},\n\t\t\"totals\": {\n\t\t\t\"amountExclVat\": \"(number) The total amount of the Invoice without VAT. Must be rounded to maximum 2 decimals. Example: 297.00\",\n\t\t\t\"vatAmount\": \"(number) The total VAT amount for the Invoice or the VAT total amount expressed in the accounting currency accepted or required in the country of the Seller. Must be rounded to maximum 2 decimals. Example: 38.07\",\n\t\t\t\"amountInclVat\": \"(number) The total amount of the Invoice with VAT. Must be rounded to maximum 2 decimals. Example: 335.07\",\n\t\t\t\"lineExtensionAmount\": \"(number) Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals. If not supplied this is calculated as the sum of the LineExtensionAmount on the detail lines. Example: 297.00\",\n\t\t\t\"payableAmount\": \"(number) The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals. If not filled in the TaxInclusiveAmount will be used. Example: 335.07\",\n\t\t\t\"payableRoundingAmount\": \"(number) The amount to be added to the invoice total to round the amount to be paid. Must be rounded to maximum 2 decimals. Example: 0.00\",\n\t\t\t\"prepaidAmount\": \"(number) The sum of amounts which have been paid in advance. Must be rounded to maximum 2 decimals. Example: 0.00\"\n\t\t},\n\t\t\"vatSubTotals\": [\n\t\t\t{\n\t\t\t\t\"code\": \"(string) VAT category code. Example: S\",\n\t\t\t\t\"rate\": \"(number) VAT rate. Example: 21.00\",\n\t\t\t\t\"exemptionReason\": \"(string) Reason for VAT exemption. Example: Intra-community supply\",\n\t\t\t\t\"exemptionReasonCode\": \"(string) Code for VAT exemption reason. Example: K\",\n\t\t\t\t\"taxableAmount\": \"(number) Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable). Must be rounded to maximum 2 decimals. Example: 109.41\",\n\t\t\t\t\"taxAmount\": \"(number) The total VAT amount for a given VAT category. Must be rounded to maximum 2 decimals. Example: 22.98\",\n\t\t\t\t\"taxTypeIndicator\": \"(string) Additonal Tax Category for non-standard rate\",\n\t\t\t\t\"splitPaymentIndicator\": \"(string) Split payment indicator\"\n\t\t\t}\n\t\t],\n\t\t\"parties\": [\n\t\t\t{\n\t\t\t\t\"partyName\": \"(string) Name of the party. Example: PANDAVA nv/sa\",\n\t\t\t\t\"roleCode\": \"(string) Code identifying the role this party has on the invoice. Example: SU\",\n\t\t\t\t\"endpointID\": \"(string) Electronic endpoint identifier of the party. Note the key is endpointID, not endpointId as used on customer and supplier. Example: 0208:be2929035935\",\n\t\t\t\t\"endpointIDType\": \"(string) Endpoint type or scheme which relates to the endpointID. Example: 0208\",\n\t\t\t\t\"identifiers\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"id\": \"(string, required) Identifier value. Example: 5412345000013\",\n\t\t\t\t\t\t\"schemeId\": \"(string, required) Identifier scheme ID. Max 10 characters. Example: GLN\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"name\": \"(string) Name of the party. Example: PANDAVA nv/sa\",\n\t\t\t\t\"address1\": \"(string) Street and street number. Example: Zwartzustersvest 24\",\n\t\t\t\t\"address2\": \"(string) Address line 2. Example: Unit 5\",\n\t\t\t\t\"address3\": \"(string) Address line 3. Example: c/o Accounts\",\n\t\t\t\t\"city\": \"(string) City. Example: Mechelen\",\n\t\t\t\t\"zip\": \"(string) Postal code. Example: 2800\",\n\t\t\t\t\"countryCode\": \"(string) ISO 3166-1 alpha-2 country code. Example: BE\",\n\t\t\t\t\"countryName\": \"(string) Country name. Example: Belgium\",\n\t\t\t\t\"countrySubEntity\": \"(string) Province, state or region. Example: Antwerpen\",\n\t\t\t\t\"vatNumber\": \"(string) VAT number of the party. Example: BE0123456749\",\n\t\t\t\t\"contactID\": \"(string) Identifier of the contact. Example: CT-001\",\n\t\t\t\t\"contactName\": \"(string) Contact person. Example: Jan Peeters\",\n\t\t\t\t\"contactEmail\": \"(string) Contact email. Example: jan@soluz.io\",\n\t\t\t\t\"contactPhone\": \"(string) Contact phone. Example: +3215999888\",\n\t\t\t\t\"partyLERegistrationName\": \"(string) Registered legal entity name of the party. Example: PANDAVA nv/sa\",\n\t\t\t\t\"partyLECompanyID\": \"(string) Legal entity company identifier. Example: 0999001396\",\n\t\t\t\t\"partyLECompanyIDType\": \"(string) Scheme of the legal entity company identifier. Example: 0208\",\n\t\t\t\t\"partyLECompanyLegalForm\": \"(string) Legal form of the legal entity. Example: nv/sa\",\n\t\t\t\t\"recipientType\": \"(string) Flag to indicate Subordinate Local Government Unit or GV member\"\n\t\t\t}\n\t\t],\n\t\t\"detailLines\": [\n\t\t\t{\n\t\t\t\t\"id\": \"(string) Unique line ID. Example: 1\",\n\t\t\t\t\"quantity\": \"(number, required) Quantity invoiced. Example: 3\",\n\t\t\t\t\"articleName\": \"(string, required) Item name. Example: Agenda Timing 2024\",\n\t\t\t\t\"accountingCost\": \"(string) A textual value that specifies where to book the relevant data into the Buyer's financial accounts. Example: 700100\",\n\t\t\t\t\"additionalItemProperties\": \"(object) Additional properties of the goods/services. Example: { \\\"color\\\": \\\"blue\\\" }\",\n\t\t\t\t\"allowanceReason\": \"(string) Coded reason for allowance/charge. Example: 95\",\n\t\t\t\t\"allowanceAmount\": \"(number) The allowance amount, if there is an allowance. Example: 1.00\",\n\t\t\t\t\"chargeReason\": \"(string) Coded reason for allowance/charge. Example: 95\",\n\t\t\t\t\"chargeAmount\": \"(number) The charge amount, if there is a charge. Example: 1.00\",\n\t\t\t\t\"commodityClassificationCodes\": \"(object) Classification codes (e.g. UNSPSC, CPV, etc.). Example: { \\\"UNSPSC\\\": \\\"44121706\\\" }\",\n\t\t\t\t\"articleDescription\": \"(string) Item description. Example: Black hard cover\",\n\t\t\t\t\"articleNumberBuyer\": \"(string) Buyer’s item code. Example: ITM-001\",\n\t\t\t\t\"articleNumberSupplier\": \"(string) Supplier’s item code. Example: SUP-7788\",\n\t\t\t\t\"lineExtensionAmount\": \"(number, required) The total amount of the Invoice line. The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes. Must be rounded to maximum 2 decimals. If not supplied, the AmountExclVat will be used. Example: 150.00\",\n\t\t\t\t\"vatRate\": \"(number, required) VAT rate percentage. Example: 21\",\n\t\t\t\t\"vatCode\": \"(string) VAT category code. Example: S\",\n\t\t\t\t\"orderLineId\": \"(string) Reference to buyer’s order line. Example: 1000\",\n\t\t\t\t\"note\": \"(string) A textual note that gives unstructured information that is relevant to the Invoice line. Example: Delivered in January\",\n\t\t\t\t\"deliveryDate\": \"(string, date) Date of delivery for line (YYYY-MM-DD). Example: 2023-01-03\",\n\t\t\t\t\"deliveryNoteReference\": \"(string) Reference to delivery note. Example: DN-12345\",\n\t\t\t\t\"docRefDocType\": \"(string) Type of referenced document (code 130 = invoice object reference). Example: 130\",\n\t\t\t\t\"docRefId\": {\n\t\t\t\t\t\"id\": \"(string) Identifier of referenced object. Example: 998877\",\n\t\t\t\t\t\"schemeId\": \"(string) Scheme ID of reference. Example: PO\"\n\t\t\t\t},\n\t\t\t\t\"originCountryCode\": \"(string) Country of origin (ISO 3166-1 alpha-2). Example: BE\",\n\t\t\t\t\"standardItemIdentification\": {\n\t\t\t\t\t\"id\": \"(string) Standard item identifier. Example: 5412345678908\",\n\t\t\t\t\t\"schemeId\": \"(string) Identification scheme. Example: GTIN\"\n\t\t\t\t},\n\t\t\t\t\"price\": {\n\t\t\t\t\t\"articlePrice\": \"(number) The price of an item, exclusive of VAT, after subtracting item price discount. The Item net price has to be equal with the Item gross price less the Item price discount, if they are both provided. Item price can not be negative. Example: 50.00\",\n\t\t\t\t\t\"baseQuantity\": \"(number) Quantity basis for price. Example: 1\",\n\t\t\t\t\t\"unitOfMeasure\": \"(string) Unit of measure. Codes for unit of packaging from UNECE Recommendation No. 21 can be used in accordance with the descriptions in the Intro section of UN/ECE Recommendation 20, Revision 11 (2015): The 2 character alphanumeric code values in UNECE Recommendation 21 shall be used. o avoid duplication with existing code values in UNECE Recommendation No. 20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure. Example: H87\",\n\t\t\t\t\t\"allowanceAmount\": \"(number) The total discount subtracted from the Item gross price to calculate the Item net price. Example: 55.00\",\n\t\t\t\t\t\"allowanceBaseAmount\": \"(number) The unit price, exclusive of VAT, before subtracting Item price discount, can not be negative. Example: 60.00\"\n\t\t\t\t},\n\t\t\t\t\"vatExemptionReason\": \"(string) Reason for VAT exemption. Example: Intra-community supply\",\n\t\t\t\t\"vatExemptionReasonCode\": \"(string) Code for VAT exemption reason. Example: E\",\n\t\t\t\t\"uuLineNumber\": \"(string) Universal unique line number. Should be unique not only per invoice but per taxpayer or invoicing system\",\n\t\t\t\t\"lineGTU\": \"(string) Designation for the delivery of goods and the provision of services\",\n\t\t\t\t\"startDate\": \"(string, date) Invoice period start date for this line (YYYY-MM-DD). Example: 2023-11-01\",\n\t\t\t\t\"endDate\": \"(string, date) Invoice period end date for this line (YYYY-MM-DD). Example: 2023-11-30\",\n\t\t\t\t\"exemptFromDiscount\": \"(boolean) Set to true to exempt this line from the invoice level discount. Example: false\",\n\t\t\t\t\"lineDueDateTypeCode\": \"(string) Code specifying the type of due date that applies to this invoice line. Example: 3\",\n\t\t\t\t\"referencedDespatchDocId\": \"(string) Identifier of the despatch advice this line refers to. Example: DESP-993\",\n\t\t\t\t\"referencedDespatchDocLineId\": \"(string) Line identifier within the referenced despatch advice. Example: 2\",\n\t\t\t\t\"referencedInvoiceDocId\": \"(string) Identifier of the invoice this line refers to. Example: INV-2021-77\",\n\t\t\t\t\"referencedInvoiceDocLineId\": \"(string) Line identifier within the referenced invoice. Example: 4\",\n\t\t\t\t\"referencedInvoiceDocTypeCode\": \"(string) Document type code of the referenced invoice. Example: 380\",\n\t\t\t\t\"referencedInvoiceDocIssueDate\": \"(string, date) Issue date of the referenced invoice (YYYY-MM-DD). Example: 2021-11-30\",\n\t\t\t\t\"referencedReceiptDocId\": \"(string) Identifier of the receiving advice this line refers to. Example: RCPT-331\",\n\t\t\t\t\"referencedReceiptDocLineId\": \"(string) Line identifier within the referenced receiving advice. Example: 1\",\n\t\t\t\t\"referencedSalesOrderDocId\": \"(string) Identifier of the sales order this line refers to. Example: SO-10099\",\n\t\t\t\t\"referencedSalesOrderDocLineId\": \"(string) Line identifier within the referenced sales order. Example: 7\",\n\t\t\t\t\"deliveryActualDeliveryDate\": \"(string, date) Actual delivery date for this line (YYYY-MM-DD). Example: 2023-11-05\",\n\t\t\t\t\"deliveryPartyName\": \"(string) Name of the party this line was delivered to. Example: Soluz.io afleveradres\",\n\t\t\t\t\"deliveryLocationIDs\": \"(string) Identifier of the delivery location for this line. Example: 5412345000013\",\n\t\t\t\t\"deliveryLocationAddress1\": \"(string) Delivery location street and number. Example: Berendries 52\",\n\t\t\t\t\"deliveryLocationAddress2\": \"(string) Delivery location address line 2. Example: Building A\",\n\t\t\t\t\"deliveryLocationAddress3\": \"(string) Delivery location address line 3. Example: Floor 2\",\n\t\t\t\t\"deliveryLocationCity\": \"(string) Delivery location city. Example: Lovendegem\",\n\t\t\t\t\"deliveryLocationZIP\": \"(string) Delivery location postal code. Example: 5400\",\n\t\t\t\t\"deliveryLocationCountrySubEntity\": \"(string) Delivery location province, state or region. Example: O-Vl\",\n\t\t\t\t\"deliveryLocationCountryCode\": \"(string) Delivery location country (ISO 3166-1 alpha-2). Example: BE\"\n\t\t\t}\n\t\t]\n\t},\n\t\"processing\": {\n\t\t\"deliveryMethod\": \"(string) Outbound channel (e.g. PEPPOL, E-MAIL, POST). Example: PEPPOL\",\n\t\t\"extraCode1\": \"(string) Optional extra information that can be used in rules\",\n\t\t\"extraCode2\": \"(string) Optional extra information that can be used in rules\",\n\t\t\"extraCode3\": \"(string) Optional extra information that can be used in rules\",\n\t\t\"extraCode4\": \"(string) Optional extra information that can be used in rules\",\n\t\t\"extraCode5\": \"(string) Optional extra information that can be used in rules\",\n\t\t\"extraCode6\": \"(string) Optional extra information that can be used in rules\",\n\t\t\"extraCode7\": \"(string) Optional extra information that can be used in rules\",\n\t\t\"extraCode8\": \"(string) Optional extra information that can be used in rules\",\n\t\t\"extraCode9\": \"(string) Optional extra information that can be used in rules\",\n\t\t\"extraCode10\": \"(string) Optional extra information that can be used in rules\",\n\t\t\"extraInfo\": \"(string) Free-form text, up to 500 chars.\",\n\t\t\"senderPartyEntity\": \"(string) ComFin contract number if ComFin customer. Example: BE00001\",\n\t\t\"messageType\": \"(string) Message type for XML (default EFFF). Example: EFFF\"\n\t},\n\t\"image\": {\n\t\t\"embedded\": \"(boolean) Is it an embedded file? Example: true\",\n\t\t\"name\": \"(string) File name. Example: factuurImage.pdf\",\n\t\t\"mimeType\": \"(string) MIME type. Example: application/pdf\",\n\t\t\"value\": \"(string, base64) Base64 content of file. Example: BASE64 here\"\n\t},\n\t\"attachments\": [\n\t\t{\n\t\t\t\"embedded\": \"(boolean) Is it an embedded file? Example: true\",\n\t\t\t\"name\": \"(string) File name. Example: Attach.pdf\",\n\t\t\t\"mimeType\": \"(string) MIME type. Example: application/pdf\",\n\t\t\t\"value\": \"(string, base64) Base64 content\"\n\t\t}\n\t]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.soluz.io//outbound/companies/:partyId/invoices","description":"Uploads an invoice as JSON to send it to your customer.
\nUsage
\ndetails holds the invoice data and is required. An invoice can have at most 10,000 detail lines.xml (the UBL), image (the PDF) and attachments: set embedded to true, and fill in name, mimeType and value.processing.deliveryMethod is the channel used to send the invoice. When it is empty, RECIPIENT is used.Responses
\n201 Created: the invoice was uploaded. Use the returned id in GET /outbound/companies/{partyId}/invoices/{id} and GET /outbound/companies/{partyId}/invoices/{id}/audit.202 Accepted: invoices with more than 1,000 detail lines are queued and processed in the background, so no id is returned. Find them later with the invoice search.400 Bad Request: the request is not valid, or has more than 10,000 detail lines.404 Not Found: unknown PartyId.406 Not Acceptable: the content could not be accepted.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
x-api-key
\n","key":"Authorization","value":"string"},{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"description":"UBL as XML file
\n","key":"Xml","type":"file","value":null},{"description":"Invoice as PDF file
\n","key":"Image","type":"file","value":null},{"description":"Optional additional attachments
\n","key":"Attachments","value":"string,string","type":"text"}]},"url":"https://api.soluz.io//outbound/companies/:partyId/invoices/multipart?partyEntity=string&deliveryMethod=string","description":"Uploads an invoice with its files to send it to your customer.
\nUsage\nSend the request as multipart/form-data, with either:
application/xml, optionally a PDF (application/pdf) and any number of additional attachments. The invoice data is read from the UBL. In Postman, add the files in the Body tab as form-data fields of type File.UploadInvoiceRequest as a part with content type application/json, plus the files it references. For each referenced file, set embedded to false and use the multipart file name as name.The optional partyEntity and deliveryMethod query parameters override the matching processing values. When no delivery method is given, RECIPIENT is used.
Responses
\n201 Created: the invoice was uploaded. Use the returned id in GET /outbound/companies/{partyId}/invoices/{id} and GET /outbound/companies/{partyId}/invoices/{id}/audit.400 Bad Request: the request or one of its files is not valid.404 Not Found: unknown PartyId.406 Not Acceptable: the content could not be accepted.401 Unauthorized: the API key is missing or not valid.Optional. Sets processing.senderPartyEntity for this invoice.
Optional. Sets processing.deliveryMethod, the channel used to send the invoice.
The PartyId of the company: the id returned by GET companies.
x-api-key
\n","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//outbound/companies/:partyId/inbox/invoices","description":"Returns the first page of the inbox of the company: sent invoices that are ready to be downloaded and have not been marked as downloaded yet.
\nUsage
\ntotalPages is more than 1, use POST /outbound/companies/{partyId}/inbox/invoices/search with paging to get the rest.Typical flow
\nResponses
\n200 OK: the first page of the inbox.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
x-api-key
\n","key":"Authorization","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"invoicedate-from\": \"(string,date) The start date for the invoice date range. Example: 1951-09-07T18:14:00.209Z\",\n\t\"invoicedate-to\": \"(string,date) The end date for the invoice date range. Example: 2010-06-27T14:00:39.906Z\",\n\t\"invoiceNumber\": \"(string) The invoice number. Example: SOL-1200\",\n\t\"objectId\": \"(string) Object id of the document. Example: 4728\",\n\t\"uniqueId\": \"(string) Unique id of the document. Example: 1095953\",\n\t\"page\": {\n\t\t\"page-number\": \"(number) Page number. Example: 2\",\n\t\t\"records-per-page\": \"(number) Amount of records per page. Example: 25\"\n\t},\n\t\"status\": \"(string) Filter on status. Example: PENDING\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.soluz.io//outbound/companies/:partyId/inbox/invoices/search","description":"Searches the inbox of the company: sent invoices that are ready to be downloaded and have not been marked as downloaded yet.
\nUsage
\ninvoicedate-from and invoicedate-to are required. Only invoices with an invoice date in this range (both dates included) are returned. Format: YYYY-MM-DD.invoiceNumber (exact match), objectId and uniqueId.page: page-number starts at 1. records-per-page defaults to 20 and is capped at 100.Typical flow
\nResponses
\n200 OK: the current page, the number of totalPages and the matching invoices.400 Bad Request: the request body is missing or not valid.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
x-api-key
\n","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//outbound/companies/:partyId/inbox/invoices/:id/markdownloaded","description":"Marks an invoice as downloaded, which removes it from the inbox.
\nUsage
\nResponses
\n200 OK: a message confirming the invoice was marked as downloaded.404 Not Found: unknown PartyId, or the invoice is not in the inbox.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
The id of the invoice in the inbox.
x-api-key
\n","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//outbound/peppol/participants/:participantId","description":"Checks whether a company is registered on the Peppol network, and which document types it can receive. Use it to find out if a customer can receive invoices through Peppol.
\nUsage\nparticipantId can be:
scheme:identifier, for example 0208:0123456789 (Belgian company number). This is looked up on the Peppol network.BE0123456789.This endpoint does not use a PartyId.
\nResponses
\n200 OK: isOnPeppol, receivingInvoices (true when the participant accepts UBL invoices) and the services it supports. A participant that is not on Peppol returns isOnPeppol false.404 Not Found: the lookup failed.401 Unauthorized: the API key is missing or not valid.The Peppol ID (scheme:identifier, e.g. 0208:0123456789), a VAT number or a company number.
\n","type":"text/plain"},"type":"any","value":"string","key":"participantId"}]}},"response":[{"id":"11a964bb-d648-4414-af2e-899962f52977","name":"OK","originalRequest":{"method":"GET","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//outbound/peppol/participants/:participantId","host":["https://api.soluz.io/"],"path":["outbound","peppol","participants",":participantId"],"variable":[{"key":"participantId","value":"string","description":"The Peppol ID (scheme:identifier, e.g. 0208:0123456789), a VAT number or a company number."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"isOnPeppol\": \"(boolean) Indicates if the participant is registered on the Peppol network. Example: true\",\n\t\"receivingInvoices\": \"(boolean) Indicates if the participant can receive invoices via Peppol. Example: true\",\n\t\"services\": [\n\t\t{\n\t\t\t\"participantId\": \"(string) The Peppol participant identifier (schemeId + identifier). Example: 0208:be2929035935\",\n\t\t\t\"documentTypeId\": \"(string) The document type identifier supported. Example: urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##peppol-EN16931::2.1\",\n\t\t\t\"endpointAddress\": \"(string) The endpoint address (URL) where documents can be delivered. Example: https://peppol.codabox.com/peppol/as4\"\n\t\t},\n\t\t{\n\t\t\t\"participantId\": \"(string) Example: 0192:987654321\",\n\t\t\t\"documentTypeId\": \"(string) Example: urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##peppol-EN16931::2.1\",\n\t\t\t\"endpointAddress\": \"(string) Example: https://peppol.codabox.com/peppol/as4\"\n\t\t}\n\t]\n}"},{"id":"e8b9b312-3dd1-44c3-9374-af0dc4bddb09","name":"BadRequest","originalRequest":{"method":"GET","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//outbound/peppol/participants/:participantId","host":["https://api.soluz.io/"],"path":["outbound","peppol","participants",":participantId"],"variable":[{"key":"participantId","value":"string","description":"The Peppol ID (scheme:identifier, e.g. 0208:0123456789), a VAT number or a company number."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"Message\": \"The request is invalid.\",\n\t\"ModelState\": {\n\t\t\"model.name\": [\n\t\t\t\"The name field is required.\"\n\t\t]\n\t}\n}"},{"id":"38ca5693-4f52-4e72-aa57-779a4b070cb6","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//outbound/peppol/participants/:participantId","host":["https://api.soluz.io/"],"path":["outbound","peppol","participants",":participantId"],"variable":[{"key":"participantId","value":"string","description":"The Peppol ID (scheme:identifier, e.g. 0208:0123456789), a VAT number or a company number."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"message\": \"string\"\n}"},{"id":"b622871e-e47b-4e1f-9283-ebeeed833b1f","name":"NotFound","originalRequest":{"method":"GET","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//outbound/peppol/participants/:participantId","host":["https://api.soluz.io/"],"path":["outbound","peppol","participants",":participantId"],"variable":[{"key":"participantId","value":"string","description":"The Peppol ID (scheme:identifier, e.g. 0208:0123456789), a VAT number or a company number."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"statusCode\": 1862,\n\t\"message\": \"string\"\n}"}],"_postman_id":"46eabe67-72f7-42cd-a12d-2d56532d16eb"}],"id":"0790993b-c298-4d33-8718-4376067379b6","_postman_id":"0790993b-c298-4d33-8718-4376067379b6","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"apikeyvcvv"}]},"isInherited":true,"source":{"_postman_id":"f0547a7d-8dc8-49a4-a589-f16184ada54c","id":"f0547a7d-8dc8-49a4-a589-f16184ada54c","name":"Outbound API","type":"folder"}}}],"id":"f0547a7d-8dc8-49a4-a589-f16184ada54c","description":"\n\nScroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
\n
Base URLs:
\n\nGET /outbound/companies
Get companies
\nReturns all companies in the current tenant that your API key has access to.
\nThe id of each company is its PartyId. Every other request in this API is made for one company and takes this value as {partyId} in the URL.
Usage
\nResponses
\n200 OK: the companies your API key has access to.401 Unauthorized: the API key is missing or not valid.\n\nExample responses
\n
\n\n200 Response
\n
{\n \"companies\": [\n {\n \"id\": \"(number) PartyId of the company. Use it as {partyId} in all other requests, e.g. POST companies/101/invoices/search. Example: 101\",\n \"name\": \"(string) Name of the company. Example: Soluz.io\",\n \"vatNumber\": \"(string) VAT number of the company. Example: BE0123456749\",\n \"companyNumber\": \"(string) National company registry number. Example: 0123456749\"\n },\n {\n \"id\": \"(number) PartyId of the company. Use it as {partyId} in all other requests, e.g. POST companies/102/invoices/search. Example: 102\",\n \"name\": \"(string) Name of the company. Example: Pandava nv/sa\",\n \"vatNumber\": \"(string) VAT number of the company. Example: BE0999001396\",\n \"companyNumber\": \"(string) National company registry number. Example: 0999001396\"\n }\n ]\n}\nGET /outbound/companies/{partyId}
Get company
\nReturns a single company of the current tenant.
\nUsage
\npartyId is the id returned by GET /outbound/companies.id in the response is the same PartyId: use it as {partyId} in all other requests.Responses
\n200 OK: the company.404 Not Found: there is no company with this PartyId that your API key has access to.401 Unauthorized: the API key is missing or not valid.\n\nExample responses
\n
\n\n200 Response
\n
{\n \"id\": \"(number) PartyId of the company. Use it as {partyId} in all other requests, e.g. POST companies/101/invoices/search. Example: 101\",\n \"name\": \"(string) Name of the company. Example: Soluz.io\",\n \"vatNumber\": \"(string) VAT number of the company. Example: BE0123456749\",\n \"companyNumber\": \"(string) National company registry number. Example: 0123456749\"\n}\nPOST /outbound/companies/{partyId}/fr/ereport/multipart
Upload an eReport for France
\nUploads a French e-reporting file for the company.
\nUsage
\nmultipart/form-data.application/xml. In Postman, add it in the Body tab as a form-data field of type File; Postman sets the content type from the .xml extension.application/xml part is used as the eReport. Any other parts are kept as attachments.Responses
\n202 Accepted: the eReport was received.400 Bad Request: the uploaded content is not valid.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.\n\nBody parameter
\n
type: object\nproperties:\n Xml:\n type: string\n description: eReport as XML file\n format: binary\n Attachments:\n type: array\n description: Optional additional attachments\n items:\n type: string\n format: binary\n\n\n\nExample responses
\n
\n\n201 Response
\n
{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n }\n }\n}\nGET /outbound/companies/{partyId}/invoices/{id}
Get invoice
\nReturns all details of a sent invoice: header, customer, supplier, totals, detail lines, payment information (including the payment link) and references. For countries with clearance, the clearance reference and date are included once available.
\nUsage
\nid is the id returned when the invoice was uploaded, or the id from the invoice search or the inbox.Responses
\n200 OK: the invoice.404 Not Found: unknown PartyId or invoice.401 Unauthorized: the API key is missing or not valid.\n\nExample responses
\n
\n\n200 Response
\n
{\n \"id\": \"(number) Internal system ID. Example: 99993544\",\n \"uniqueId\": \"(string) Unique identifier. Example: 0000365474010053973333\",\n \"transactionId\": \"(string) Transaction identifier. Example: 2AF410E4DEF234DB89918E6EEC7DF825\",\n \"invoiceNumber\": \"(string) Invoice number. Example: 23110000291\",\n \"currency\": \"(string) ISO 4217 currency code. Example: EUR\",\n \"type\": \"(string) Invoice type (INVOICE or CREDITNOTE). Example: INVOICE\",\n \"date\": \"(string, date) Issue date (YYYY-MM-DD). Example: 2023-11-07\",\n \"dueDate\": \"(string, date) Due date for payment (YYYY-MM-DD). In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present. Example: 2023-12-07\",\n \"paymentLink\": \"(string) A link to a payment website, QR code or similar. Example: http://exsite.qr.com/AEU9ZR843J\",\n \"paymentLinkPaidAt\": \"(string, date) The date when the payment link was paid (YYYY-MM-DD). Example: 2023-12-07\",\n \"placeOfIssue\": \"(string) Place where the invoice was issued\",\n \"fullyPaid\": \"(boolean) Indicates if an invoice has been paid\",\n \"dateOfFullPayment\": \"(string) date of payment\",\n \"simplifiedTriangularProcedure\": \"(string) Indication if invoice is issued under simplified procedure by the second taxpayer\",\n \"checkoutMethod\": \"(boolean) Cash accounting indicator\",\n \"selfBillingIndicator\": \"(boolean) Selfbilling indicator\",\n \"warehouseDocumentNumbers\": \"(string) WZ (delivery note) document numbers\",\n \"typeName\": \"(string) Invoice Type\",\n \"restrictedInformation\": \"(string) Indicator if Invoice referred to in Art. 109 sec. 3d of the Act\",\n \"downloaded\": \"(boolean) Indicates whether one of the invoice files has already been retrieved through GetInvoiceFile. Example: false\",\n \"note\": \"(string) A textual note that gives unstructured information that is relevant to the Invoice as a whole. Such as the reason for any correction, or an assignment note in case the invoice has been factored. Max 2000 characters.\",\n \"invoicePeriodDescriptionCode\": \"(string) Coded description of the invoice period. Max 50 characters. Example: 3\",\n \"deliveryTermsId\": \"(string) Delivery terms identifier. Max 200 characters. Example: CIF\",\n \"deliveryTermsDeliveryLocationName\": \"(string) Name of the location the delivery terms apply to. Max 200 characters. Example: Port of Antwerp\",\n \"contractDocReferenceTypeCode\": \"(string) Document type code of the referenced contract. Max 100 characters. Example: 130\",\n \"clearanceReferenceId\": \"(string) Unique reference identifier assigned during the clearance process. Only returned for countries where clearance is required. Example: 4837291056-20240115-A1B2C3D4E5F6-7A\",\n \"clearanceReferenceDate\": \"(string) Date the invoice was cleared by the tax authority, in the format supplied by that authority. Only returned for countries where clearance is required. Example: 2024-01-15T10:15:30Z\",\n \"clearanceDetails\": \"(string) Additional details received during the clearance process. For KSeF this contains the QR metadata. Example: https://ksef.mf.gov.pl/\",\n \"totals\": {\n \"amountExclVat\": \"(number) The total amount of the Invoice without VAT. Must be rounded to maximum 2 decimals. Example: 297.00\",\n \"vatAmount\": \"(number) The total VAT amount for the Invoice or the VAT total amount expressed in the accounting currency accepted or required in the country of the Seller. Must be rounded to maximum 2 decimals. Example: 38.07\",\n \"amountInclVat\": \"(number) The total amount of the Invoice with VAT. Must be rounded to maximum 2 decimals. Example: 335.07\",\n \"lineExtensionAmount\": \"(number) Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals. If not supplied this is calculated as the sum of the LineExtensionAmount on the detail lines. Example: 297.00\",\n \"payableAmount\": \"(number) The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals. If not filled in the TaxInclusiveAmount will be used. Example: 335.07\",\n \"payableRoundingAmount\": \"(number) The amount to be added to the invoice total to round the amount to be paid. Must be rounded to maximum 2 decimals. Example: 0.00\",\n \"prepaidAmount\": \"(number) The sum of amounts which have been paid in advance. Must be rounded to maximum 2 decimals. Example: 0.00\",\n \"chargeAmount\": \"(number) Additional charge excl. VAT. Example: 10\",\n \"allowanceAmount\": \"(number) Total allowance/exemption excl. VAT. Example: 5.00\"\n },\n \"customer\": {\n \"id\": \"(string) Internal customer ID. Example: CUST1\",\n \"name\": \"(string) Buyer name. Example: GEMEENTE SOL\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0907537834\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"companyNumber\": \"(string) National registry ID (if applicable). Example: 0907537834\",\n \"address\": {\n \"address1\": \"(string) Street. Example: Laatstraat 99\",\n \"city\": \"(string) City. Example: STABROEK\",\n \"zip\": \"(string) Postal code. Example: 2940\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2 code. Example: BE\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"department\": \"(string) Department or branch. Example: DevelopmentDepartment\",\n \"endpointId\": \"(string) Electronic endpoint identifier. Example: BE2929035935\",\n \"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 9925\",\n \"identifications\": [\n {\n \"id\": \"(string, required) Identifier value. Max 200 characters. Example: 0123456749\",\n \"schemeId\": \"(string, required) Identifier scheme ID. Max 10 characters. Example: 0208\"\n }\n ]\n },\n \"supplier\": {\n \"id\": \"(string) Internal supplier ID. Example: SUP1\",\n \"name\": \"(string) Seller name. Example: INCREDIBLO nv/sa\",\n \"vatNumber\": \"(string) Seller VAT number. Example: BE0999001396\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"address\": {\n \"address1\": \"(string) Street. Example: Lage Weg 123 A\",\n \"city\": \"(string) City. Example: Hoevenen-Stabroek\",\n \"zip\": \"(string) Postal code. Example: 2940\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2 code. Example: BE\",\n \"taxpayersPrefix\": \"(string) VAT UE country prefix (e.g. PL) for intra-Community supplies, cross-border services, and triangular transactions.\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"department\": \"(string) Department or branch. Example: DevelopmentDepartment\",\n \"endpointId\": \"(string) Electronic endpoint identifier. Example: BE2929035935\",\n \"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 9925\",\n \"identifications\": [\n {\n \"id\": \"(string, required) Identifier value. Max 200 characters. Example: 0123456749\",\n \"schemeId\": \"(string, required) Identifier scheme ID. Max 10 characters. Example: 0208\"\n }\n ]\n },\n \"buyer\": {\n \"name\": \"(string) Buyer name. Example: Soluz.io\",\n \"address\": {\n \"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n \"zip\": \"(string) Postal code. Example: Tax 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province. Example: Vl-Br\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n \"companyNumberType\": \"(string) Company number type\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0123456749\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"RecipientType\": \"(string) Flag to indicate Subordinate Local Government Unit or GV member\"\n },\n \"references\": {\n \"accountingCost\": \"(string) Buyer accounting reference. Example: 4217:2323:2323\",\n \"billingReferences\": [\n {\n \"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n \"invoiceDocumentReferenceIssueDate\": \"(string, date) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"reasonForCorrection\": \"(string) Reason for correction\",\n \"externalReference\": \"(string) Number identifying the corrected invoice in the National System of e-Invoices\",\n \"typeOfCorrection\": \"(string) Type of correction\"\n }\n ],\n \"buyerReference\": \"(string) An identifier assigned by the Buyer used for internal routing purposes. An invoice must have buyer reference or purchase order reference (BT-13). Example: ABC/984/B2\",\n \"contractDocReference\": \"(string) Contract identifier by seller. Example: CT-2022-001\",\n \"contractDocIssueDate\": \"(string, date) Contract date by seller (YYYY-MM-DD). Example: 2022-01-15\",\n \"contractDocReferenceCustomer\": \"(string) Contract identifier by customer. Example: CUST-CT-88\",\n \"contractDocIssueDateCustomer\": \"(string, date) Contract date by customer (YYYY-MM-DD). Example: 2022-01-20\",\n \"despatchDocReference\": \"(string) Dispatch advice ID. Example: DESP-993\",\n \"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n \"invoiceDocumentReferenceIssueDate\": \"(string, date) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"originatorDocReference\": \"(string) Tender or lot reference. Example: TND-2022-01\",\n \"projectReference\": \"(string) Project reference. Example: PROJ-Delta-01\",\n \"receiptDocReference\": \"(string) Receiving advice ID. Example: RCPT-331\",\n \"purchaseOrderReference\": \"(string) Purchase order ID. Example: PA992430\",\n \"salesOrderReference\": \"(string) Sales order ID. Example: 11-145210\"\n },\n \"detailLines\": [\n {\n \"id\": \"(string) Unique identifier for this invoice line. Example: 1\",\n \"additionalItemProperties\": \"(object) Additional properties of the goods/services. Example: { \\\"color\\\": \\\"blue\\\" }\",\n \"articleName\": \"(string) Item name. Example: Agenda Timing 2024 genaaid Lima zwart\",\n \"articleDescription\": \"(string) Item description, more detail than name. Example: Hardcover planner with stitched binding\",\n \"articleNumberBuyer\": \"(string) Buyer-assigned item identifier. Example: B-98431\",\n \"articleNumberSupplier\": \"(string) Seller-assigned item identifier. Example: 56.1142.021/9\",\n \"lineExtensionAmount\": \"(number) Net line amount excl. VAT (inclusive of line-level allowances/charges). Example: 9.06\",\n \"commodityClassificationCodes\": \"(object) Classification codes (e.g. UNSPSC, CPV, etc.). Example: { \\\"UNSPSC\\\": \\\"44121706\\\" }\",\n \"deliveryDate\": \"(string, date) Delivery date (YYYY-MM-DD). Example: 2023-11-05\",\n \"deliveryNoteReference\": \"(string) Reference to a delivery note. Example: DN-2023-1115\",\n \"docRefDocType\": \"(string) Document type code for referenced object (use 130 for invoice object reference). Example: 130\",\n \"docRefId\": {\n \"id\": \"(string) Identifier value. Example: 123456789\",\n \"schemeId\": \"(string) Identifier scheme ID. Example: PO\"\n },\n \"note\": \"(string) Unstructured note relevant to this line. Example: Urgent delivery\",\n \"originCountryCode\": \"(string) Country of origin (ISO 3166-1 alpha-2). Example: BE\",\n \"accountingCost\": \"(string) Buyer’s accounting allocation reference. Example: 4217:2323:2323\",\n \"startDate\": \"(string, date) Invoice period start date (YYYY-MM-DD). Example: 2023-11-01\",\n \"endDate\": \"(string, date) Invoice period end date (YYYY-MM-DD). Example: 2023-11-30\",\n \"vatCode\": \"(string) VAT category code. Example: S\",\n \"vatRate\": \"(number) VAT rate (%) applied. Example: 21.00\",\n \"orderLineId\": \"(string) Buyer purchase order line reference. Example: 15\",\n \"quantity\": \"(number) Quantity of items invoiced. Example: 2.00\",\n \"standardItemIdentification\": {\n \"id\": \"(string) Standard identifier value. Example: 5412345123453\",\n \"schemeId\": \"(string) Standard identifier scheme (e.g. GTIN, EAN). Example: GTIN\"\n },\n \"price\": {\n \"articlePrice\": \"(number) The price of an item, exclusive of VAT, after subtracting item price discount. The Item net price has to be equal with the Item gross price less the Item price discount, if they are both provided. Item price can not be negative. Example: 50.00\",\n \"baseQuantity\": \"(number) Quantity basis for price. Example: 1\",\n \"unitOfMeasure\": \"(string) Unit of measure. Codes for unit of packaging from UNECE Recommendation No. 21 can be used in accordance with the descriptions in the Intro section of UN/ECE Recommendation 20, Revision 11 (2015): The 2 character alphanumeric code values in UNECE Recommendation 21 shall be used. o avoid duplication with existing code values in UNECE Recommendation No. 20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure. Example: H87\",\n \"allowanceAmount\": \"(number) The total discount subtracted from the Item gross price to calculate the Item net price. Example: 55.00\",\n \"allowanceBaseAmount\": \"(number) The unit price, exclusive of VAT, before subtracting Item price discount, can not be negative. Example: 60.00\"\n },\n \"allowanceCharge\": {\n \"reason\": \"(string) Reason for allowance/charge. Example: Promotion\",\n \"reasonCode\": \"(string) Coded reason for allowance/charge. Example: 95\",\n \"amount\": \"(decimal) Amount excl. VAT. Example: 1.00\",\n \"chargeIndicator\": \"(number) true=Charge, false=Allowance. Example: false\",\n \"taxCode\": \"(string) VAT category code. Example: S\",\n \"taxPercentage\": \"(number) VAT rate for allowance/charge. Example: 21.00\"\n },\n \"vatExemptionReason\": \"(string) Reason text if VAT-exempt. Example: Intra-community supply\",\n \"vatExemptionReasonCode\": \"(string) Reason code if VAT-exempt. Example: K\",\n \"uuLineNumber\": \"(string) Universal unique line number. Should be unique not only per invoice but per taxpayer or invoicing system\",\n \"lineGTU\": \"(string) Designation for the delivery of goods and the provision of services\",\n \"lineDueDateTypeCode\": \"(string) Code specifying the type of due date that applies to this invoice line. Example: 3\",\n \"referencedDespatchDocId\": \"(string) Identifier of the despatch advice this line refers to. Example: DESP-993\",\n \"referencedDespatchDocLineId\": \"(string) Line identifier within the referenced despatch advice. Example: 2\",\n \"referencedInvoiceDocId\": \"(string) Identifier of the invoice this line refers to. Example: INV-2021-77\",\n \"referencedInvoiceDocLineId\": \"(string) Line identifier within the referenced invoice. Example: 4\",\n \"referencedInvoiceDocTypeCode\": \"(string) Document type code of the referenced invoice. Example: 380\",\n \"referencedInvoiceDocIssueDate\": \"(string, date) Issue date of the referenced invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"referencedReceiptDocId\": \"(string) Identifier of the receiving advice this line refers to. Example: RCPT-331\",\n \"referencedReceiptDocLineId\": \"(string) Line identifier within the referenced receiving advice. Example: 1\",\n \"referencedSalesOrderDocId\": \"(string) Identifier of the sales order this line refers to. Example: SO-10099\",\n \"referencedSalesOrderDocLineId\": \"(string) Line identifier within the referenced sales order. Example: 7\",\n \"deliveryActualDeliveryDate\": \"(string, date) Actual delivery date for this line (YYYY-MM-DD). Example: 2023-11-05\",\n \"deliveryPartyName\": \"(string) Name of the party this line was delivered to. Example: Soluz.io afleveradres\",\n \"deliveryLocationIDs\": \"(string) Identifier of the delivery location for this line. Example: 5412345000013\",\n \"deliveryLocationAddress1\": \"(string) Delivery location street and number. Example: Berendries 52\",\n \"deliveryLocationAddress2\": \"(string) Delivery location address line 2. Example: Building A\",\n \"deliveryLocationAddress3\": \"(string) Delivery location address line 3. Example: Floor 2\",\n \"deliveryLocationCity\": \"(string) Delivery location city. Example: Lovendegem\",\n \"deliveryLocationZIP\": \"(string) Delivery location postal code. Example: 5400\",\n \"deliveryLocationCountrySubEntity\": \"(string) Delivery location province, state or region. Example: O-Vl\",\n \"deliveryLocationCountryCode\": \"(string) Delivery location country (ISO 3166-1 alpha-2). Example: BE\"\n }\n ],\n \"allowanceCharges\": [\n {\n \"reason\": \"(string) Textual reason for allowance/charge. Example: Early payment discount\",\n \"reasonCode\": \"(string) UNCL5189/UNCL7161 code. Example: 95\",\n \"amount\": \"(number) Amount excl. VAT. Example: 5.00\",\n \"chargeIndicator\": \"(boolean) true=Charge, false=Allowance. Example: false\",\n \"taxCode\": \"(string) VAT category code. Example: S\",\n \"taxPercentage\": \"(number) VAT rate for allowance/charge. Example: 21.00\"\n }\n ],\n \"vatSubTotals\": [\n {\n \"code\": \"(string) VAT category code. Example: S\",\n \"rate\": \"(number) VAT rate. Example: 21.00\",\n \"taxableAmount\": \"(number) Taxable amount. Example: 109.41\",\n \"taxAmount\": \"(number) VAT amount. Example: 22.98\",\n \"taxTypeIndicator\": \"(string) Additonal Tax Category for non-standard rate\",\n \"splitPaymentIndicator\": \"(string) Split payment indicator\"\n }\n ],\n \"paymentMeans\": [\n {\n \"code\": \"(string) The means, expressed as code, for how a payment is expected to be or has been settled (e.g. UN/CEFACT 4461). Example: ZZZ\",\n \"text\": \"(string) Description of payment means. Example: Bank transfer\",\n \"mandateId\": \"(string) Unique identifier assigned by the Payee for referencing the direct debit mandate. Example: MandateId\",\n \"mandateFinancialAccountId\": \"(string) The account to be debited by the direct debit. Example: MandateFinancialAccountId\",\n \"paymentId\": \"(string) Payment reference to be used by the payer. Example: PMT-2023-001\",\n \"payeeFinancialInstitutionId\": \"(string) Identifier of Payee's bank (BIC, etc.). Example: KREDBEBB\",\n \"payeeFinancialAccountId\": \"(string) Payee's bank account (IBAN, etc.). Example: BE49000023121121\",\n \"payeeFinancialAccountSchemeId\": \"(string) Scheme ID of Payee's bank account (e.g. IBAN). Example: IBAN\",\n \"payeeFinancialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\"\n }\n ],\n \"paymentTerms\": {\n \"text\": \"(string) A textual description of the payment terms that apply to the amount due for payment (including description of possible penalties). Example: Payment in 30 days\",\n \"settlementDiscountPercentage\": \"(number) Early payment discount percentage. Example: 2\",\n \"settlementDiscountAmount\": \"(number) Early payment discount absolute amount. Example: 50.00\"\n },\n \"parties\": [\n {\n \"partyName\": \"(string) Name of the party. Example: PANDAVA nv/sa\",\n \"roleCode\": \"(string) Code identifying the role this party has on the invoice. Example: SU\",\n \"endpointID\": \"(string) Electronic endpoint identifier of the party. Note the key is endpointID, not endpointId as used on customer and supplier. Example: 0208:be2929035935\",\n \"endpointIDType\": \"(string) Endpoint type or scheme which relates to the endpointID. Example: 0208\",\n \"identifiers\": [\n {\n \"id\": \"(string, required) Identifier value. Example: 5412345000013\",\n \"schemeId\": \"(string, required) Identifier scheme ID. Max 10 characters. Example: GLN\"\n }\n ],\n \"name\": \"(string) Name of the party. Example: PANDAVA nv/sa\",\n \"address1\": \"(string) Street and street number. Example: Zwartzustersvest 24\",\n \"address2\": \"(string) Address line 2. Example: Unit 5\",\n \"address3\": \"(string) Address line 3. Example: c/o Accounts\",\n \"city\": \"(string) City. Example: Mechelen\",\n \"zip\": \"(string) Postal code. Example: 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2 country code. Example: BE\",\n \"countryName\": \"(string) Country name. Example: Belgium\",\n \"countrySubEntity\": \"(string) Province, state or region. Example: Antwerpen\",\n \"vatNumber\": \"(string) VAT number of the party. Example: BE0123456749\",\n \"contactID\": \"(string) Identifier of the contact. Example: CT-001\",\n \"contactName\": \"(string) Contact person. Example: Jan Peeters\",\n \"contactEmail\": \"(string) Contact email. Example: jan@soluz.io\",\n \"contactPhone\": \"(string) Contact phone. Example: +3215999888\",\n \"partyLERegistrationName\": \"(string) Registered legal entity name of the party. Example: PANDAVA nv/sa\",\n \"partyLECompanyID\": \"(string) Legal entity company identifier. Example: 0999001396\",\n \"partyLECompanyIDType\": \"(string) Scheme of the legal entity company identifier. Example: 0208\",\n \"partyLECompanyLegalForm\": \"(string) Legal form of the legal entity. Example: nv/sa\",\n \"recipientType\": \"(string) Flag to indicate Subordinate Local Government Unit or GV member\"\n }\n ],\n \"files\": [\n {\n \"id\": \"(integer) File ID. Example: 53973545\",\n \"name\": \"(string) File name. Example: examplefilename.xml\",\n \"size\": \"(string) File size. Example: 13.98 KB\",\n \"pages\": \"(number) Page count. Example: 0\",\n \"package\": \"(string) File type (XML, PDF, UBL, etc.). Example: XML\"\n }\n ]\n}\nGET /outbound/companies/{partyId}/invoices/{id}/{format}
Get invoice file
\nDownloads one or more files of a sent invoice.
\nUsage\nformat selects the files:
ubl: the UBL invoice (XML).pdf or image: the PDF of the invoice.attachments: all additional attachments.ublandimage: the UBL and the PDF.all: the UBL, the PDF and all attachments.xml: the files in the XML package of the invoice.When one file matches, it is returned as is (for example a PDF or XML). When several files match, they are returned together in one ZIP file. Every download is recorded in the audit trail of the invoice.
\nResponses
\n200 OK: the file, or a ZIP file with the matching files.404 Not Found: unknown PartyId or invoice, or no file matches format.401 Unauthorized: the API key is missing or not valid.\n\nExample responses
\n
\n\n200 Response
\n
\n\n401 Response
\n
{\n \"type\": \"object\",\n \"description\": \"Object that represents an unauthorized error\",\n \"additionalProperties\": false,\n \"properties\": {\n \"message\": {\n \"type\": \"string\",\n \"description\": \"A message\",\n \"nullable\": true\n }\n }\n}\nGET /outbound/companies/{partyId}/invoices/{id}/audit
Get invoice audit
\nReturns the audit trail of one invoice: every processing step, with a code, a text and a timestamp, for example when it was received, converted, sent or downloaded.
\nUsage
\nResponses
\n200 OK: the audit entries of the invoice.404 Not Found: unknown PartyId or invoice.401 Unauthorized: the API key is missing or not valid.\n\nExample responses
\n
\n\n200 Response
\n
{\n \"page\": \"(number) Current page number. Example: 1\",\n \"totalPages\": \"(number) Total number of pages available. Example: 5\",\n \"entries\": [\n {\n \"code\": \"(string) Code associated with the audit entry. Example: SENT\",\n \"text\": \"(string) Description of the audit entry. Example: Invoice successfully sent via PEPPOL\",\n \"timestamp\": \"(string, date) Timestamp of the audit entry (YYYY-MM-DDTHH:mm:ssZ). Example: 2023-11-07T10:15:30Z\",\n \"transactionId\": \"(string) Transaction identifier. Example: 2AF410E4DEF234DB89918E6EEC7DF825\",\n \"objectId\": \"(number) Object ID related to the audit entry. Example: 4728\",\n \"externalReference\": \"(string) External reference for the audit entry. Example: EXT-2023-091\"\n }\n ]\n}\nGET /outbound/companies/{partyId}/invoices/{id}/feedback
Get invoice feedback
\nReturns the feedback received for one invoice, such as errors, warnings and information about its delivery or validation. Each entry has a type, a code, a text and a timestamp.
\nUsage
\nResponses
\n200 OK: the feedback entries of the invoice.404 Not Found: unknown PartyId or invoice.401 Unauthorized: the API key is missing or not valid.\n\nExample responses
\n
\n\n200 Response
\n
{\n \"type\": \"object\",\n \"description\": \"Represents a paginated response containing feedback entries.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"page\": {\n \"type\": \"integer\",\n \"description\": \" The current page number. \\n \",\n \"format\": \"int32\"\n },\n \"totalPages\": {\n \"type\": \"integer\",\n \"description\": \" The total number of pages. \\n \",\n \"format\": \"int32\"\n },\n \"entries\": {\n \"type\": \"array\",\n \"description\": \"The collection of feedback entries.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \" Represents the response for a feedback entry. \\n \",\n \"additionalProperties\": false,\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"description\": \" The type of the feedback. \\n \",\n \"nullable\": true\n },\n \"code\": {\n \"type\": \"string\",\n \"description\": \" The code associated with the feedback. \\n \",\n \"nullable\": true\n },\n \"text\": {\n \"type\": \"string\",\n \"description\": \" The text of the feedback. \\n \",\n \"nullable\": true\n },\n \"timestamp\": {\n \"type\": \"string\",\n \"description\": \" The timestamp of the feedback. \\n \",\n \"nullable\": true\n },\n \"transactionId\": {\n \"type\": \"string\",\n \"description\": \" The transaction ID associated with the feedback. \\n \",\n \"nullable\": true\n },\n \"objectId\": {\n \"type\": \"integer\",\n \"description\": \" The object ID related to the feedback, if applicable. \\n \",\n \"format\": \"int32\",\n \"nullable\": true\n },\n \"externalReference\": {\n \"type\": \"string\",\n \"description\": \" The external reference for the feedback. \\n \",\n \"nullable\": true\n },\n \"fileId\": {\n \"type\": \"integer\",\n \"description\": \" The file ID associated with the feedback, if applicable. \\n \",\n \"format\": \"int32\",\n \"nullable\": true\n },\n \"extraInfo\": {\n \"type\": \"string\",\n \"description\": \" Any additional information related to the feedback. \\n \",\n \"nullable\": true\n }\n }\n }\n }\n }\n}\nPOST /outbound/companies/{partyId}/invoices/search
Search invoices
\nSearches the sent invoices of the company and returns one page of results.
\nUsage
\ninvoicedate-from and invoicedate-to are required. Only invoices with an invoice date in this range (both dates included) are returned. Format: YYYY-MM-DD.invoiceNumber (exact match), objectId and uniqueId. All filled-in filters must match.page: page-number starts at 1. records-per-page defaults to 20 and is capped at 100. Use totalPages in the response to fetch the next pages.id of a result for all details.Responses
\n200 OK: the current page, the number of totalPages and the matching invoices.400 Bad Request: the request body is missing or not valid, for example without the invoice date range.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.\n\nBody parameter
\n
{\n \"invoicedate-from\": \"(string,date) The start date for the invoice date range. Example: 1951-09-07T18:14:00.209Z\",\n \"invoicedate-to\": \"(string,date) The end date for the invoice date range. Example: 2010-06-27T14:00:39.906Z\",\n \"invoiceNumber\": \"(string) The invoice number. Example: SOL-1200\",\n \"objectId\": \"(string) Object id of the document. Example: 4728\",\n \"uniqueId\": \"(string) Unique id of the document. Example: 1095953\",\n \"page\": {\n \"page-number\": \"(number) Page number. Example: 2\",\n \"records-per-page\": \"(number) Amount of records per page. Example: 25\"\n },\n \"status\": \"(string) Filter on status. Example: PENDING\"\n}\n\n\nExample responses
\n
\n\n200 Response
\n
{\n \"invoices\": [\n {\n \"id\": \"(number) Internal ID of the Invoice. Used in GetInvoice to get the details of this invoice. Example: 53973544\",\n \"uniqueId\": \"(string) Unique identifier. Example: 0000130974010053973544\",\n \"invoiceNumber\": \"(string) Invoice number. Example: 23110000291\",\n \"currency\": \"(string) ISO 4217 currency code. Example: EUR\",\n \"type\": \"(string) Invoice type (INVOICE or CREDITNOTE). Example: INVOICE\",\n \"date\": \"(string, date) Issue date (YYYY-MM-DD). Example: 2023-11-07\",\n \"dueDate\": \"(string, date) Due date for payment (YYYY-MM-DD). Example: 2023-12-07\",\n \"totals\": {\n \"amountExclVat\": \"(number) Invoice total excl. VAT. Example: 109.41\",\n \"vatAmount\": \"(number) Invoice VAT amount. Example: 22.98\",\n \"amountInclVat\": \"(number) Invoice total incl. VAT. Example: 132.39\"\n },\n \"customer\": {\n \"name\": \"(string) Buyer name. Example: GEMEENTE STABROEK\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0207537834\"\n },\n \"supplier\": {\n \"name\": \"(string) Seller name. Example: PANDAVA nv/sa\",\n \"vatNumber\": \"(string) Seller VAT number. Example: BE0419001396\"\n }\n }\n ]\n}\nPOST /outbound/companies/{partyId}/invoices/audit
Search invoice audit
\nSearches the audit trail of the invoices of the company and returns one page of entries (50 per page).
\nUsage
\nobjectId (the invoice id) or transactionId. from is required; to is optional.from and to. The period can be at most 30 days.externalReference narrows the results further.page is the page number, starting at 1 (default 1). Use totalPages in the response to fetch the next pages.Responses
\n200 OK: the current page, the number of totalPages and the audit entries.400 Bad Request: the body is missing or not valid, the period is longer than 30 days, or only one of from and to is given for a search over all invoices.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.\n\nBody parameter
\n
{\n \"transactionId\": \"(string) Filter on TransactionId. Example: 2AF410E4DEF234DB89918E6EEC7DF825\",\n \"page\": \"(number) The requested page (default = 1). Example: 1\",\n \"from\": \"(string, date, required) Start date of the audit period (YYYY-MM-DD). Example: 2023-11-01\",\n \"to\": \"(string, date) End date of the audit period (YYYY-MM-DD). Example: 2023-11-30\",\n \"objectId\": \"(number) ObjectId to search on. Example: 4728\",\n \"externalReference\": \"(string) External reference identifier. Example: EXT-2023-091\"\n}\n\n\nExample responses
\n
\n\n200 Response
\n
{\n \"page\": \"(number) Current page number. Example: 1\",\n \"totalPages\": \"(number) Total number of pages available. Example: 5\",\n \"entries\": [\n {\n \"code\": \"(string) Code associated with the audit entry. Example: SENT\",\n \"text\": \"(string) Description of the audit entry. Example: Invoice successfully sent via PEPPOL\",\n \"timestamp\": \"(string, date) Timestamp of the audit entry (YYYY-MM-DDTHH:mm:ssZ). Example: 2023-11-07T10:15:30Z\",\n \"transactionId\": \"(string) Transaction identifier. Example: 2AF410E4DEF234DB89918E6EEC7DF825\",\n \"objectId\": \"(number) Object ID related to the audit entry. Example: 4728\",\n \"externalReference\": \"(string) External reference for the audit entry. Example: EXT-2023-091\"\n }\n ]\n}\nPOST /outbound/companies/{partyId}/invoices/feedback
Search invoice feedback
\nSearches the feedback of the invoices of the company and returns one page of entries (50 per page).
\nUsage
\nobjectId (the invoice id) or transactionId. from is required; to is optional.from and to. The period can be at most 30 days.externalReference narrows the results further.page is the page number, starting at 1 (default 1). Use totalPages in the response to fetch the next pages.Responses
\n200 OK: the current page, the number of totalPages and the feedback entries.400 Bad Request: the body is missing or not valid, the period is longer than 30 days, or only one of from and to is given for a search over all invoices.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.\n\nBody parameter
\n
{\n \"type\": \"object\",\n \"description\": \"Request for feedback\",\n \"additionalProperties\": false,\n \"required\": [\n \"from\"\n ],\n \"properties\": {\n \"transactionId\": {\n \"type\": \"string\",\n \"description\": \"Filter on TransactionId\",\n \"nullable\": true\n },\n \"page\": {\n \"type\": \"integer\",\n \"description\": \"The requested page (default = 1)\",\n \"format\": \"int32\",\n \"nullable\": true\n },\n \"from\": {\n \"type\": \"string\",\n \"description\": \"Start date of the audit requested\",\n \"format\": \"date-time\"\n },\n \"to\": {\n \"type\": \"string\",\n \"description\": \"End date of the audit requested\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"objectId\": {\n \"type\": \"integer\",\n \"description\": \"ObjectId to search on\",\n \"format\": \"int32\",\n \"nullable\": true\n },\n \"externalReference\": {\n \"type\": \"string\",\n \"description\": \"External reference\",\n \"nullable\": true\n }\n }\n}\n\n\nExample responses
\n
\n\n200 Response
\n
{\n \"type\": \"object\",\n \"description\": \"Represents a paginated response containing feedback entries.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"page\": {\n \"type\": \"integer\",\n \"description\": \" The current page number. \\n \",\n \"format\": \"int32\"\n },\n \"totalPages\": {\n \"type\": \"integer\",\n \"description\": \" The total number of pages. \\n \",\n \"format\": \"int32\"\n },\n \"entries\": {\n \"type\": \"array\",\n \"description\": \"The collection of feedback entries.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \" Represents the response for a feedback entry. \\n \",\n \"additionalProperties\": false,\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"description\": \" The type of the feedback. \\n \",\n \"nullable\": true\n },\n \"code\": {\n \"type\": \"string\",\n \"description\": \" The code associated with the feedback. \\n \",\n \"nullable\": true\n },\n \"text\": {\n \"type\": \"string\",\n \"description\": \" The text of the feedback. \\n \",\n \"nullable\": true\n },\n \"timestamp\": {\n \"type\": \"string\",\n \"description\": \" The timestamp of the feedback. \\n \",\n \"nullable\": true\n },\n \"transactionId\": {\n \"type\": \"string\",\n \"description\": \" The transaction ID associated with the feedback. \\n \",\n \"nullable\": true\n },\n \"objectId\": {\n \"type\": \"integer\",\n \"description\": \" The object ID related to the feedback, if applicable. \\n \",\n \"format\": \"int32\",\n \"nullable\": true\n },\n \"externalReference\": {\n \"type\": \"string\",\n \"description\": \" The external reference for the feedback. \\n \",\n \"nullable\": true\n },\n \"fileId\": {\n \"type\": \"integer\",\n \"description\": \" The file ID associated with the feedback, if applicable. \\n \",\n \"format\": \"int32\",\n \"nullable\": true\n },\n \"extraInfo\": {\n \"type\": \"string\",\n \"description\": \" Any additional information related to the feedback. \\n \",\n \"nullable\": true\n }\n }\n }\n }\n }\n}\nPOST /outbound/companies/{partyId}/invoices
Upload invoice [JSON]
\nUploads an invoice as JSON to send it to your customer.
\nUsage
\ndetails holds the invoice data and is required. An invoice can have at most 10,000 detail lines.xml (the UBL), image (the PDF) and attachments: set embedded to true, and fill in name, mimeType and value.processing.deliveryMethod is the channel used to send the invoice. When it is empty, RECIPIENT is used.Responses
\n201 Created: the invoice was uploaded. Use the returned id in GET /outbound/companies/{partyId}/invoices/{id} and GET /outbound/companies/{partyId}/invoices/{id}/audit.202 Accepted: invoices with more than 1,000 detail lines are queued and processed in the background, so no id is returned. Find them later with the invoice search.400 Bad Request: the request is not valid, or has more than 10,000 detail lines.404 Not Found: unknown PartyId.406 Not Acceptable: the content could not be accepted.401 Unauthorized: the API key is missing or not valid.\n\nBody parameter
\n
{\n \"details\": {\n \"documentNumber\": \"(string) Unique invoice number in sender's system. Example: DEMO/00092\",\n \"invoiceNumber\": \"(string) Invoice number as shown on the document. Example: 23110000291\",\n \"currency\": \"(string, required) ISO 4217 currency code. Example: EUR\",\n \"date\": \"(string, required) Invoice issue date (YYYY-MM-DD). Example: 2022-12-02\",\n \"dueDate\": \"(string) Due date for payment (YYYY-MM-DD). In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present. Example: 2023-12-07\",\n \"note\": \"(string) Free text note printed on the invoice. Example: Note van de factuur\",\n \"structuredCommunication\": \"(string) A textual value used to establish a link between the payment and the Invoice, issued by the Seller. Used for creditor's critical reconciliation information. This information element helps the Seller to assign an incoming payment to the relevant payment process. Example: +++123/569858/336+++\",\n \"type\": \"(string, required) Document type: Invoice, CreditNote. Example: Invoice\",\n \"typeCode\": \"(string) Document type code (e.g. 380=Invoice, 381=CreditNote). Example: 380\",\n \"serviceBeginDate\": \"(string, date) Service period start (YYYY-MM-DD). Example: 2022-12-01\",\n \"serviceEndDate\": \"(string, date) Service period end (YYYY-MM-DD). Example: 2022-12-31\",\n \"taxPointDate\": \"(string, date) Tax point date (YYYY-MM-DD). Example: 2022-12-22\",\n \"placeOfIssue\": \"(string) Place where the invoice was issued\",\n \"fullyPaid\": \"(boolean) Indicates if an invoice has been paid\",\n \"dateOfFullPayment\": \"(string) date of payment\",\n \"simplifiedTriangularProcedure\": \"(string) Indication if invoice is issued under simplified procedure by the second taxpayer\",\n \"checkoutMethod\": \"(boolean) Cash accounting indicator\",\n \"selfBillingIndicator\": \"(boolean) Self-billing indicator\",\n \"warehouseDocumentNumbers\": \"(string) WZ (delivery note) document numbers\",\n \"typeName\": \"(string) Invoice type name\",\n \"restrictedInformation\": \"(string) Indicator if Invoice referred to in Art. 109 sec. 3d of the Act\",\n \"invoicePeriodDescriptionCode\": \"(string) Coded description of the invoice period. Max 50 characters. Example: 3\",\n \"deliveryTermsId\": \"(string) Delivery terms identifier. Max 200 characters. Example: CIF\",\n \"deliveryTermsDeliveryLocationName\": \"(string) Name of the location the delivery terms apply to. Max 200 characters. Example: Port of Antwerp\",\n \"contractDocReferenceTypeCode\": \"(string) Document type code of the referenced contract. Max 100 characters. Example: 130\",\n \"references\": {\n \"accountingCost\": \"(string) Buyer accounting reference Cost center or internal accounting code. A textual value that specifies where to book the relevant data into the Buyer's financial accounts. Example: 4217:2323:2323\",\n \"billingReferences\": [\n {\n \"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n \"invoiceDocumentReferenceIssueDate\": \"(DateTime) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"reasonForCorrection\": \"(string) Reason for correction\",\n \"externalReference\": \"(string) Number identifying the corrected invoice in the National System of e-Invoices\",\n \"typeOfCorrection\": \"(string) Type of correction\"\n }\n ],\n \"buyerReference\": \"(string) Buyer reference or procurement ID. An invoice must have buyer reference or purchase order reference (BT-13) Example: ABC/984/B2\",\n \"purchaseOrderReference\": \"(string) Purchase order number. An invoice must have buyer reference (BT-10) or purchase order reference Example: OR1256\",\n \"contractDocReference\": \"(string) Contract identifier by seller. Example: CT-2022-001\",\n \"contractDocIssueDate\": \"(string, date) Contract date by seller (YYYY-MM-DD). Example: 2022-01-15\",\n \"contractDocReferenceCustomer\": \"(string) Contract identifier by customer. Example: CUST-CT-88\",\n \"contractDocIssueDateCustomer\": \"(string, date) Contract date by customer (YYYY-MM-DD). Example: 2022-01-20\",\n \"despatchDocReference\": \"(string) Dispatch advice ID. Example: DESP-993\",\n \"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n \"invoiceDocumentReferenceIssueDate\": \"(DateTime) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"originatorDocReference\": \"(string) Tender or lot reference. Example: TND-2022-01\",\n \"projectReference\": \"(string) Project reference. Example: PROJ-Delta-01\",\n \"receiptDocReference\": \"(string) Receiving advice ID. Example: RCPT-331\",\n \"salesOrderReference\": \"(string) Seller’s sales order ID. Example: SO-10099\",\n \"salesOrderIssueDate\": \"(string, date) Sales order date (YYYY-MM-DD). Example: 2022-05-18\"\n },\n \"customer\": {\n \"id\": \"(string) Internal customer ID in sender’s system. Example: CUST1\",\n \"name\": \"(string, required) Customer name. Example: Soluz.io\",\n \"address\": {\n \"address1\": \"(string, required) Street and number. Example: Zwartzustersvest 24\",\n \"address2\": \"(string) Address line 2. Example: Unit 5\",\n \"address3\": \"(string) Address line 3. Example: c/o Accounts\",\n \"city\": \"(string, required) City. Example: Mechelen\",\n \"zip\": \"(string, required) Postal code. Example: 2810\",\n \"countryCode\": \"(string, required) ISO 3166-1 alpha-2 country code. Example: BE\",\n \"province\": \"(string) State/Province/Region. Example: Antwerpen\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n \"department\": \"(string) Department or branch. Example: DevelopmentDepartment\",\n \"vatNumber\": \"(string) Customer VAT number. Example: BE0123456749\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"endpointId\": \"(string) Electronic endpoint identifier. Example: 0208:be2929035935\",\n \"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 0208\"\n },\n \"delivery\": {\n \"actualDeliveryDate\": \"(string, date) Delivery date (YYYY-MM-DD). Example: 2023-01-03\",\n \"address\": {\n \"address1\": \"(string)(required in case address is filled) Street and number. Example: Berendries 52\",\n \"address2\": \"(string) Example: Building A\",\n \"address3\": \"(string) Example: Floor 2\",\n \"city\": \"(string) City. Example: Lovendegem\",\n \"zip\": \"(string) Postal code. Example: 5400\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province/region. Example: O-Vl\"\n },\n \"name\": \"(string) Receiver name or delivery contact. Example: Soluz.io afleveradres\",\n \"locationIdentifier\": {\n \"id\": \"(string) Location identifier (GLN or other). Example: 5412345000013\",\n \"schemeId\": \"(string) Scheme ID for location. Example: GLN\"\n }\n },\n \"paymentMeans\": {\n \"code\": \"(string) The means, expressed as code, for how a payment is expected to be or has been settled. (e.g., UN/CEFACT 4461). Example: ZZZ\",\n \"text\": \"(string) Description of payment means. Example: Bank transfer\",\n \"mandateId\": \"(string) Unique identifier assigned by the Payee for referencing the direct debit mandate. Used in order to pre-notify the Buyer of a SEPA direct debit. Example: MandateId\",\n \"mandateFinancialAccountId\": \"(string) The account to be debited by the direct debit. Example: MandateFinancialAccountId\",\n \"paymentId\": \"(string) Payment reference to be used by the payer. Example: PMT-2023-001\",\n \"payeeFinancialInstitutionId\": \"(string) Identifier of Payee's bank (BIC, etc.). Example: KREDBEBB\",\n \"payeeFinancialAccountId\": \"(string) Payee’s bank account (IBAN, etc.). Example: BE49000023121121\",\n \"payeeFinancialAccountSchemeId\": \"(string) Scheme ID of Payee’s bank account (e.g. IBAN). Example: IBAN\",\n \"payeeFinancialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\"\n },\n \"multiplePaymentMeans\": [\n {\n \"code\": \"(string) The means, expressed as code, for how a payment is expected to be or has been settled (e.g. UN/CEFACT 4461). Example: 30\",\n \"text\": \"(string) Description of payment means. Example: Bank transfer\",\n \"mandateId\": \"(string) Unique identifier assigned by the Payee for referencing the direct debit mandate. Example: MandateId\",\n \"mandateFinancialAccountId\": \"(string) The account to be debited by the direct debit. Example: MandateFinancialAccountId\",\n \"paymentId\": \"(string) Payment reference to be used by the payer. Example: PMT-2023-001\",\n \"payeeFinancialInstitutionId\": \"(string) Identifier of Payee's bank (BIC, etc.). Example: KREDBEBB\",\n \"payeeFinancialAccountId\": \"(string) Payee's bank account (IBAN, etc.). Example: BE49000023121121\",\n \"payeeFinancialAccountSchemeId\": \"(string) Scheme ID of Payee's bank account (e.g. IBAN). Example: IBAN\",\n \"payeeFinancialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\"\n }\n ],\n \"payee\": {\n \"companyNumber\": \"(string) This element is used for both the identification of the Payee, or the unique banking reference identifier of Payee (assigned by the Payee bank.) For payee identification use ICD code list, for SEPA bank assigned creditor reference, use SEPA. Example: BE0123456749\",\n \"financialAccountId\": \"(string) Payee’s IBAN. Example: BE49000023121121\",\n \"financialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\",\n \"name\": \"(string) Name of payee. Example: PayeeName\"\n },\n \"paymentTerms\": {\n \"text\": \"(string) A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties). Example: Payment in 30 days\",\n \"settlementDiscountPercentage\": \"(number) Early payment discount percentage. If not filled in but SettlementDiscountPercentage is, this value will be calculated based on SettlementDiscountPercentage. Example: 2\",\n \"settlementDiscountAmount\": \"(number) Early payment discount absolute amount. If not filled in but SettlementDiscountAmount is, this value will be calculated based on SettlementDiscountAmount Example: 50.00\"\n },\n \"supplier\": {\n \"id\": \"(string) Internal supplier ID in sender’s system. Example: SUP1\",\n \"name\": \"(string, required) Supplier name. Example: Soluz.io\",\n \"address\": {\n \"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n \"address2\": \"(string) Example: Tax 1\",\n \"address3\": \"(string) Example: Tax 3\",\n \"city\": \"(string) City. Example: Tax Mechelen\",\n \"zip\": \"(string) Postal code. Example: Tax 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province. Example: Vl-Br\",\n \"taxpayersPrefix\": \"(string) VAT UE country prefix (e.g. PL) for intra-Community supplies, cross-border services, and triangular transactions.\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n \"department\": \"(string) Department or branch. Example: DevelopmentDepartment\",\n \"vatNumber\": \"(string) Customer VAT number. Example: BE0123456749\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"endpointId\": \"(string) Electronic endpoint identifier. Example: 0208:be2929035935\",\n \"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 0208\"\n },\n \"buyer\": {\n \"name\": \"(string) Buyer name. Example: Soluz.io\",\n \"address\": {\n \"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n \"zip\": \"(string) Postal code. Example: Tax 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province. Example: Vl-Br\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n \"companyNumberType\": \"(string) Company number type\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0123456749\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"RecipientType\": \"(string) Flag to indicate Subordinate Local Government Unit or GV member\"\n },\n \"taxRepresentative\": {\n \"address\": {\n \"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n \"address2\": \"(string) Example: Tax 1\",\n \"address3\": \"(string) Example: Tax 3\",\n \"city\": \"(string) City. Example: Tax Mechelen\",\n \"zip\": \"(string) Postal code. Example: Tax 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province. Example: Vl-Br\"\n },\n \"name\": \"(string) Tax representative name. Example: Tax Soluz.io\",\n \"vatNumber\": \"(string) VAT number. Example: BE000000097\"\n },\n \"discount\": {\n \"amount\": \"(number) The discount amount. If not filled in but Percentage is, this value will be calculated based on Percentage. Example: 50\",\n \"percentage\": \"(number) The discount percentage. If not filled in but Amount is, this value will be calculated based on Amount. Example: 10\",\n \"reason\": \"(string) Reason for discount. Example: extra korting van 10%\"\n },\n \"charge\": {\n \"amount\": \"(number) Additional charge excl. VAT. Example: 10\",\n \"vatRate\": \"(number) VAT rate on charge. Example: 21\",\n \"vatCode\": \"(string) VAT category code for charge. Example: S\",\n \"reason\": \"(string) Reason for charge. Example: Handling fee\"\n },\n \"totals\": {\n \"amountExclVat\": \"(number) The total amount of the Invoice without VAT. Must be rounded to maximum 2 decimals. Example: 297.00\",\n \"vatAmount\": \"(number) The total VAT amount for the Invoice or the VAT total amount expressed in the accounting currency accepted or required in the country of the Seller. Must be rounded to maximum 2 decimals. Example: 38.07\",\n \"amountInclVat\": \"(number) The total amount of the Invoice with VAT. Must be rounded to maximum 2 decimals. Example: 335.07\",\n \"lineExtensionAmount\": \"(number) Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals. If not supplied this is calculated as the sum of the LineExtensionAmount on the detail lines. Example: 297.00\",\n \"payableAmount\": \"(number) The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals. If not filled in the TaxInclusiveAmount will be used. Example: 335.07\",\n \"payableRoundingAmount\": \"(number) The amount to be added to the invoice total to round the amount to be paid. Must be rounded to maximum 2 decimals. Example: 0.00\",\n \"prepaidAmount\": \"(number) The sum of amounts which have been paid in advance. Must be rounded to maximum 2 decimals. Example: 0.00\"\n },\n \"vatSubTotals\": [\n {\n \"code\": \"(string) VAT category code. Example: S\",\n \"rate\": \"(number) VAT rate. Example: 21.00\",\n \"exemptionReason\": \"(string) Reason for VAT exemption. Example: Intra-community supply\",\n \"exemptionReasonCode\": \"(string) Code for VAT exemption reason. Example: K\",\n \"taxableAmount\": \"(number) Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable). Must be rounded to maximum 2 decimals. Example: 109.41\",\n \"taxAmount\": \"(number) The total VAT amount for a given VAT category. Must be rounded to maximum 2 decimals. Example: 22.98\",\n \"taxTypeIndicator\": \"(string) Additonal Tax Category for non-standard rate\",\n \"splitPaymentIndicator\": \"(string) Split payment indicator\"\n }\n ],\n \"parties\": [\n {\n \"partyName\": \"(string) Name of the party. Example: PANDAVA nv/sa\",\n \"roleCode\": \"(string) Code identifying the role this party has on the invoice. Example: SU\",\n \"endpointID\": \"(string) Electronic endpoint identifier of the party. Note the key is endpointID, not endpointId as used on customer and supplier. Example: 0208:be2929035935\",\n \"endpointIDType\": \"(string) Endpoint type or scheme which relates to the endpointID. Example: 0208\",\n \"identifiers\": [\n {\n \"id\": \"(string, required) Identifier value. Example: 5412345000013\",\n \"schemeId\": \"(string, required) Identifier scheme ID. Max 10 characters. Example: GLN\"\n }\n ],\n \"name\": \"(string) Name of the party. Example: PANDAVA nv/sa\",\n \"address1\": \"(string) Street and street number. Example: Zwartzustersvest 24\",\n \"address2\": \"(string) Address line 2. Example: Unit 5\",\n \"address3\": \"(string) Address line 3. Example: c/o Accounts\",\n \"city\": \"(string) City. Example: Mechelen\",\n \"zip\": \"(string) Postal code. Example: 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2 country code. Example: BE\",\n \"countryName\": \"(string) Country name. Example: Belgium\",\n \"countrySubEntity\": \"(string) Province, state or region. Example: Antwerpen\",\n \"vatNumber\": \"(string) VAT number of the party. Example: BE0123456749\",\n \"contactID\": \"(string) Identifier of the contact. Example: CT-001\",\n \"contactName\": \"(string) Contact person. Example: Jan Peeters\",\n \"contactEmail\": \"(string) Contact email. Example: jan@soluz.io\",\n \"contactPhone\": \"(string) Contact phone. Example: +3215999888\",\n \"partyLERegistrationName\": \"(string) Registered legal entity name of the party. Example: PANDAVA nv/sa\",\n \"partyLECompanyID\": \"(string) Legal entity company identifier. Example: 0999001396\",\n \"partyLECompanyIDType\": \"(string) Scheme of the legal entity company identifier. Example: 0208\",\n \"partyLECompanyLegalForm\": \"(string) Legal form of the legal entity. Example: nv/sa\",\n \"recipientType\": \"(string) Flag to indicate Subordinate Local Government Unit or GV member\"\n }\n ],\n \"detailLines\": [\n {\n \"id\": \"(string) Unique line ID. Example: 1\",\n \"quantity\": \"(number, required) Quantity invoiced. Example: 3\",\n \"articleName\": \"(string, required) Item name. Example: Agenda Timing 2024\",\n \"accountingCost\": \"(string) A textual value that specifies where to book the relevant data into the Buyer's financial accounts. Example: 700100\",\n \"additionalItemProperties\": \"(object) Additional properties of the goods/services. Example: { \\\"color\\\": \\\"blue\\\" }\",\n \"allowanceReason\": \"(string) Coded reason for allowance/charge. Example: 95\",\n \"allowanceAmount\": \"(number) The allowance amount, if there is an allowance. Example: 1.00\",\n \"chargeReason\": \"(string) Coded reason for allowance/charge. Example: 95\",\n \"chargeAmount\": \"(number) The charge amount, if there is a charge. Example: 1.00\",\n \"commodityClassificationCodes\": \"(object) Classification codes (e.g. UNSPSC, CPV, etc.). Example: { \\\"UNSPSC\\\": \\\"44121706\\\" }\",\n \"articleDescription\": \"(string) Item description. Example: Black hard cover\",\n \"articleNumberBuyer\": \"(string) Buyer’s item code. Example: ITM-001\",\n \"articleNumberSupplier\": \"(string) Supplier’s item code. Example: SUP-7788\",\n \"lineExtensionAmount\": \"(number, required) The total amount of the Invoice line. The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes. Must be rounded to maximum 2 decimals. If not supplied, the AmountExclVat will be used. Example: 150.00\",\n \"vatRate\": \"(number, required) VAT rate percentage. Example: 21\",\n \"vatCode\": \"(string) VAT category code. Example: S\",\n \"orderLineId\": \"(string) Reference to buyer’s order line. Example: 1000\",\n \"note\": \"(string) A textual note that gives unstructured information that is relevant to the Invoice line. Example: Delivered in January\",\n \"deliveryDate\": \"(string, date) Date of delivery for line (YYYY-MM-DD). Example: 2023-01-03\",\n \"deliveryNoteReference\": \"(string) Reference to delivery note. Example: DN-12345\",\n \"docRefDocType\": \"(string) Type of referenced document (code 130 = invoice object reference). Example: 130\",\n \"docRefId\": {\n \"id\": \"(string) Identifier of referenced object. Example: 998877\",\n \"schemeId\": \"(string) Scheme ID of reference. Example: PO\"\n },\n \"originCountryCode\": \"(string) Country of origin (ISO 3166-1 alpha-2). Example: BE\",\n \"standardItemIdentification\": {\n \"id\": \"(string) Standard item identifier. Example: 5412345678908\",\n \"schemeId\": \"(string) Identification scheme. Example: GTIN\"\n },\n \"price\": {\n \"articlePrice\": \"(number) The price of an item, exclusive of VAT, after subtracting item price discount. The Item net price has to be equal with the Item gross price less the Item price discount, if they are both provided. Item price can not be negative. Example: 50.00\",\n \"baseQuantity\": \"(number) Quantity basis for price. Example: 1\",\n \"unitOfMeasure\": \"(string) Unit of measure. Codes for unit of packaging from UNECE Recommendation No. 21 can be used in accordance with the descriptions in the Intro section of UN/ECE Recommendation 20, Revision 11 (2015): The 2 character alphanumeric code values in UNECE Recommendation 21 shall be used. o avoid duplication with existing code values in UNECE Recommendation No. 20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure. Example: H87\",\n \"allowanceAmount\": \"(number) The total discount subtracted from the Item gross price to calculate the Item net price. Example: 55.00\",\n \"allowanceBaseAmount\": \"(number) The unit price, exclusive of VAT, before subtracting Item price discount, can not be negative. Example: 60.00\"\n },\n \"vatExemptionReason\": \"(string) Reason for VAT exemption. Example: Intra-community supply\",\n \"vatExemptionReasonCode\": \"(string) Code for VAT exemption reason. Example: E\",\n \"uuLineNumber\": \"(string) Universal unique line number. Should be unique not only per invoice but per taxpayer or invoicing system\",\n \"lineGTU\": \"(string) Designation for the delivery of goods and the provision of services\",\n \"startDate\": \"(string, date) Invoice period start date for this line (YYYY-MM-DD). Example: 2023-11-01\",\n \"endDate\": \"(string, date) Invoice period end date for this line (YYYY-MM-DD). Example: 2023-11-30\",\n \"exemptFromDiscount\": \"(boolean) Set to true to exempt this line from the invoice level discount. Example: false\",\n \"lineDueDateTypeCode\": \"(string) Code specifying the type of due date that applies to this invoice line. Example: 3\",\n \"referencedDespatchDocId\": \"(string) Identifier of the despatch advice this line refers to. Example: DESP-993\",\n \"referencedDespatchDocLineId\": \"(string) Line identifier within the referenced despatch advice. Example: 2\",\n \"referencedInvoiceDocId\": \"(string) Identifier of the invoice this line refers to. Example: INV-2021-77\",\n \"referencedInvoiceDocLineId\": \"(string) Line identifier within the referenced invoice. Example: 4\",\n \"referencedInvoiceDocTypeCode\": \"(string) Document type code of the referenced invoice. Example: 380\",\n \"referencedInvoiceDocIssueDate\": \"(string, date) Issue date of the referenced invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"referencedReceiptDocId\": \"(string) Identifier of the receiving advice this line refers to. Example: RCPT-331\",\n \"referencedReceiptDocLineId\": \"(string) Line identifier within the referenced receiving advice. Example: 1\",\n \"referencedSalesOrderDocId\": \"(string) Identifier of the sales order this line refers to. Example: SO-10099\",\n \"referencedSalesOrderDocLineId\": \"(string) Line identifier within the referenced sales order. Example: 7\",\n \"deliveryActualDeliveryDate\": \"(string, date) Actual delivery date for this line (YYYY-MM-DD). Example: 2023-11-05\",\n \"deliveryPartyName\": \"(string) Name of the party this line was delivered to. Example: Soluz.io afleveradres\",\n \"deliveryLocationIDs\": \"(string) Identifier of the delivery location for this line. Example: 5412345000013\",\n \"deliveryLocationAddress1\": \"(string) Delivery location street and number. Example: Berendries 52\",\n \"deliveryLocationAddress2\": \"(string) Delivery location address line 2. Example: Building A\",\n \"deliveryLocationAddress3\": \"(string) Delivery location address line 3. Example: Floor 2\",\n \"deliveryLocationCity\": \"(string) Delivery location city. Example: Lovendegem\",\n \"deliveryLocationZIP\": \"(string) Delivery location postal code. Example: 5400\",\n \"deliveryLocationCountrySubEntity\": \"(string) Delivery location province, state or region. Example: O-Vl\",\n \"deliveryLocationCountryCode\": \"(string) Delivery location country (ISO 3166-1 alpha-2). Example: BE\"\n }\n ]\n },\n \"processing\": {\n \"deliveryMethod\": \"(string) Outbound channel (e.g. PEPPOL, E-MAIL, POST). Example: PEPPOL\",\n \"extraCode1\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode2\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode3\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode4\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode5\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode6\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode7\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode8\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode9\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode10\": \"(string) Optional extra information that can be used in rules\",\n \"extraInfo\": \"(string) Free-form text, up to 500 chars.\",\n \"senderPartyEntity\": \"(string) ComFin contract number if ComFin customer. Example: BE00001\",\n \"messageType\": \"(string) Message type for XML (default EFFF). Example: EFFF\"\n },\n \"image\": {\n \"embedded\": \"(boolean) Is it an embedded file? Example: true\",\n \"name\": \"(string) File name. Example: factuurImage.pdf\",\n \"mimeType\": \"(string) MIME type. Example: application/pdf\",\n \"value\": \"(string, base64) Base64 content of file. Example: BASE64 here\"\n },\n \"attachments\": [\n {\n \"embedded\": \"(boolean) Is it an embedded file? Example: true\",\n \"name\": \"(string) File name. Example: Attach.pdf\",\n \"mimeType\": \"(string) MIME type. Example: application/pdf\",\n \"value\": \"(string, base64) Base64 content\"\n }\n ]\n}\n»» dueDate: The date when the payment is due.Format \"YYYY-MM-DD\".\nIn case the Amount due for payment (BT-115) is positive,\neither the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.
\n»» documentNumber: A unique identification of the Invoice,\nto uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller.
\n»» invoiceNumber: A unique identification of the Invoice,\nto uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller.
\n»» structuredCommunication: A textual value used to establish a link between the payment and the Invoice, issued by the Seller.\nUsed for creditor's critical reconciliation information.\nThis information element helps the Seller to assign an incoming payment to the relevant payment process.
\n»» taxPointDate: The date when the VAT becomes accountable for the Seller and for the Buyer in so far as that date can be determined and differs from the date of issue of the invoice, according to the VAT directive.\nThis element is required if the Value added tax point date is different from the Invoice issue date.
\n»»» accountingCost: Buyer accounting reference\nA textual value that specifies where to book the relevant data into the Buyer's financial accounts.\nExample value: 4217:2323:2323
\n»»» companyNumber: This element is used for both the identification of the Payee,\nor the unique banking reference identifier of Payee (assigned by the Payee bank.)\nFor payee identification use ICD code list, for SEPA bank assigned creditor reference, use SEPA.
\n»»» mandateId: Unique identifier assigned by the Payee for referencing the direct debit mandate.\nUsed in order to pre-notify the Buyer of a SEPA direct debit.
\n»»» text: The means, expressed as text, for how a payment is expected to be or has been settled.\nExample value: Credit transfer
\n»»» text: A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties).\nIn case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.
\n»»» lineExtensionAmount: Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals.\nIf not supplied this is calculated as the sum of the LineExtensionAmount on the detail lines
\n»»» payableAmount: The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals.\nIf not filled in the TaxInclusiveAmount will be used
\n»»» taxableAmount: Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable).\nMust be rounded to maximum 2 decimals.
\n»»» splitPaymentIndicator: Split payment indicator (\"mechanizm podzielonej płatności\").\nRequired when invoice total exceeds PLN 15,000 and covers Annex 15 goods/services.
\n»»» lineExtensionAmount: The total amount of the Invoice line. The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes.\nMust be rounded to maximum 2 decimals.\nIf not supplied, the AmountExclVat will be used
\n»»»» articlePrice: The price of an item, exclusive of VAT, after subtracting item price discount.\nThe Item net price has to be equal with the Item gross price less the Item price discount, if they are both provided.\nItem price can not be negative.
\n»»»» unitOfMeasure: The unit of measure that applies to the invoiced quantity.\nCodes for unit of packaging from UNECE Recommendation No.\n21 can be used in accordance with the descriptions in the \"Intro\" section of UN/ECE Recommendation 20, Revision 11 (2015):\nThe 2 character alphanumeric code values in UNECE Recommendation 21 shall be used.\nTo avoid duplication with existing code values in UNECE Recommendation No.\n20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure.
\n»»» uuLineNumber: Universal unique line number\nShould be unique not only per invoice but per taxpayer or invoicing system
\n»»» recipientType: Type of the buyer\nPossible values:\n12: JST Recipient\n21: GV Recipient
\n»» name: name of the file\nIf it isn't an embedded file, it should be included as multipart file-data. The name of the file should be identical.
\n\n\nExample responses
\n
\n\n201 Response
\n
{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n }\n }\n}\nPOST /outbound/companies/{partyId}/invoices/multipart
Upload invoice [UBL, PDF, Attachments]
\nUploads an invoice with its files to send it to your customer.
\nUsage\nSend the request as multipart/form-data, with either:
application/xml, optionally a PDF (application/pdf) and any number of additional attachments. The invoice data is read from the UBL. In Postman, add the files in the Body tab as form-data fields of type File.UploadInvoiceRequest as a part with content type application/json, plus the files it references. For each referenced file, set embedded to false and use the multipart file name as name.The optional partyEntity and deliveryMethod query parameters override the matching processing values. When no delivery method is given, RECIPIENT is used.
Responses
\n201 Created: the invoice was uploaded. Use the returned id in GET /outbound/companies/{partyId}/invoices/{id} and GET /outbound/companies/{partyId}/invoices/{id}/audit.400 Bad Request: the request or one of its files is not valid.404 Not Found: unknown PartyId.406 Not Acceptable: the content could not be accepted.401 Unauthorized: the API key is missing or not valid.\n\nBody parameter
\n
type: object\nproperties:\n Xml:\n type: string\n description: UBL as XML file\n format: binary\n Image:\n type: string\n description: Invoice as PDF file\n format: binary\n Attachments:\n type: array\n description: Optional additional attachments\n items:\n type: string\n format: binary\n\n\n\nExample responses
\n
\n\n201 Response
\n
{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n }\n }\n}\nPOST /outbound/companies/{partyId}/invoices/batch/multipart
Upload invoice batch
\nUploads a batch file with several invoices in one request.
\nUsage
\nmultipart/form-data with the batch file as the only file part. A request with more than one file is rejected.partyEntity query parameter sets the sender party entity for the batch.Responses
\n201 Created: the batch was uploaded. The response contains the id of the batch.400 Bad Request: no file was found in the request.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.\n\nBody parameter
\n
{\n \"details\": {\n \"documentNumber\": \"(string) Unique invoice number in sender's system. Example: DEMO/00092\",\n \"invoiceNumber\": \"(string) Invoice number as shown on the document. Example: 23110000291\",\n \"currency\": \"(string, required) ISO 4217 currency code. Example: EUR\",\n \"date\": \"(string, required) Invoice issue date (YYYY-MM-DD). Example: 2022-12-02\",\n \"dueDate\": \"(string) Due date for payment (YYYY-MM-DD). In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present. Example: 2023-12-07\",\n \"note\": \"(string) Free text note printed on the invoice. Example: Note van de factuur\",\n \"structuredCommunication\": \"(string) A textual value used to establish a link between the payment and the Invoice, issued by the Seller. Used for creditor's critical reconciliation information. This information element helps the Seller to assign an incoming payment to the relevant payment process. Example: +++123/569858/336+++\",\n \"type\": \"(string, required) Document type: Invoice, CreditNote. Example: Invoice\",\n \"typeCode\": \"(string) Document type code (e.g. 380=Invoice, 381=CreditNote). Example: 380\",\n \"serviceBeginDate\": \"(string, date) Service period start (YYYY-MM-DD). Example: 2022-12-01\",\n \"serviceEndDate\": \"(string, date) Service period end (YYYY-MM-DD). Example: 2022-12-31\",\n \"taxPointDate\": \"(string, date) Tax point date (YYYY-MM-DD). Example: 2022-12-22\",\n \"placeOfIssue\": \"(string) Place where the invoice was issued\",\n \"fullyPaid\": \"(boolean) Indicates if an invoice has been paid\",\n \"dateOfFullPayment\": \"(string) date of payment\",\n \"simplifiedTriangularProcedure\": \"(string) Indication if invoice is issued under simplified procedure by the second taxpayer\",\n \"checkoutMethod\": \"(boolean) Cash accounting indicator\",\n \"selfBillingIndicator\": \"(boolean) Self-billing indicator\",\n \"warehouseDocumentNumbers\": \"(string) WZ (delivery note) document numbers\",\n \"typeName\": \"(string) Invoice type name\",\n \"restrictedInformation\": \"(string) Indicator if Invoice referred to in Art. 109 sec. 3d of the Act\",\n \"invoicePeriodDescriptionCode\": \"(string) Coded description of the invoice period. Max 50 characters. Example: 3\",\n \"deliveryTermsId\": \"(string) Delivery terms identifier. Max 200 characters. Example: CIF\",\n \"deliveryTermsDeliveryLocationName\": \"(string) Name of the location the delivery terms apply to. Max 200 characters. Example: Port of Antwerp\",\n \"contractDocReferenceTypeCode\": \"(string) Document type code of the referenced contract. Max 100 characters. Example: 130\",\n \"references\": {\n \"accountingCost\": \"(string) Buyer accounting reference Cost center or internal accounting code. A textual value that specifies where to book the relevant data into the Buyer's financial accounts. Example: 4217:2323:2323\",\n \"billingReferences\": [\n {\n \"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n \"invoiceDocumentReferenceIssueDate\": \"(DateTime) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"reasonForCorrection\": \"(string) Reason for correction\",\n \"externalReference\": \"(string) Number identifying the corrected invoice in the National System of e-Invoices\",\n \"typeOfCorrection\": \"(string) Type of correction\"\n }\n ],\n \"buyerReference\": \"(string) Buyer reference or procurement ID. An invoice must have buyer reference or purchase order reference (BT-13) Example: ABC/984/B2\",\n \"purchaseOrderReference\": \"(string) Purchase order number. An invoice must have buyer reference (BT-10) or purchase order reference Example: OR1256\",\n \"contractDocReference\": \"(string) Contract identifier by seller. Example: CT-2022-001\",\n \"contractDocIssueDate\": \"(string, date) Contract date by seller (YYYY-MM-DD). Example: 2022-01-15\",\n \"contractDocReferenceCustomer\": \"(string) Contract identifier by customer. Example: CUST-CT-88\",\n \"contractDocIssueDateCustomer\": \"(string, date) Contract date by customer (YYYY-MM-DD). Example: 2022-01-20\",\n \"despatchDocReference\": \"(string) Dispatch advice ID. Example: DESP-993\",\n \"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n \"invoiceDocumentReferenceIssueDate\": \"(DateTime) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"originatorDocReference\": \"(string) Tender or lot reference. Example: TND-2022-01\",\n \"projectReference\": \"(string) Project reference. Example: PROJ-Delta-01\",\n \"receiptDocReference\": \"(string) Receiving advice ID. Example: RCPT-331\",\n \"salesOrderReference\": \"(string) Seller’s sales order ID. Example: SO-10099\",\n \"salesOrderIssueDate\": \"(string, date) Sales order date (YYYY-MM-DD). Example: 2022-05-18\"\n },\n \"customer\": {\n \"id\": \"(string) Internal customer ID in sender’s system. Example: CUST1\",\n \"name\": \"(string, required) Customer name. Example: Soluz.io\",\n \"address\": {\n \"address1\": \"(string, required) Street and number. Example: Zwartzustersvest 24\",\n \"address2\": \"(string) Address line 2. Example: Unit 5\",\n \"address3\": \"(string) Address line 3. Example: c/o Accounts\",\n \"city\": \"(string, required) City. Example: Mechelen\",\n \"zip\": \"(string, required) Postal code. Example: 2810\",\n \"countryCode\": \"(string, required) ISO 3166-1 alpha-2 country code. Example: BE\",\n \"province\": \"(string) State/Province/Region. Example: Antwerpen\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n \"department\": \"(string) Department or branch. Example: DevelopmentDepartment\",\n \"vatNumber\": \"(string) Customer VAT number. Example: BE0123456749\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"endpointId\": \"(string) Electronic endpoint identifier. Example: 0208:be2929035935\",\n \"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 0208\"\n },\n \"delivery\": {\n \"actualDeliveryDate\": \"(string, date) Delivery date (YYYY-MM-DD). Example: 2023-01-03\",\n \"address\": {\n \"address1\": \"(string)(required in case address is filled) Street and number. Example: Berendries 52\",\n \"address2\": \"(string) Example: Building A\",\n \"address3\": \"(string) Example: Floor 2\",\n \"city\": \"(string) City. Example: Lovendegem\",\n \"zip\": \"(string) Postal code. Example: 5400\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province/region. Example: O-Vl\"\n },\n \"name\": \"(string) Receiver name or delivery contact. Example: Soluz.io afleveradres\",\n \"locationIdentifier\": {\n \"id\": \"(string) Location identifier (GLN or other). Example: 5412345000013\",\n \"schemeId\": \"(string) Scheme ID for location. Example: GLN\"\n }\n },\n \"paymentMeans\": {\n \"code\": \"(string) The means, expressed as code, for how a payment is expected to be or has been settled. (e.g., UN/CEFACT 4461). Example: ZZZ\",\n \"text\": \"(string) Description of payment means. Example: Bank transfer\",\n \"mandateId\": \"(string) Unique identifier assigned by the Payee for referencing the direct debit mandate. Used in order to pre-notify the Buyer of a SEPA direct debit. Example: MandateId\",\n \"mandateFinancialAccountId\": \"(string) The account to be debited by the direct debit. Example: MandateFinancialAccountId\",\n \"paymentId\": \"(string) Payment reference to be used by the payer. Example: PMT-2023-001\",\n \"payeeFinancialInstitutionId\": \"(string) Identifier of Payee's bank (BIC, etc.). Example: KREDBEBB\",\n \"payeeFinancialAccountId\": \"(string) Payee’s bank account (IBAN, etc.). Example: BE49000023121121\",\n \"payeeFinancialAccountSchemeId\": \"(string) Scheme ID of Payee’s bank account (e.g. IBAN). Example: IBAN\",\n \"payeeFinancialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\"\n },\n \"multiplePaymentMeans\": [\n {\n \"code\": \"(string) The means, expressed as code, for how a payment is expected to be or has been settled (e.g. UN/CEFACT 4461). Example: 30\",\n \"text\": \"(string) Description of payment means. Example: Bank transfer\",\n \"mandateId\": \"(string) Unique identifier assigned by the Payee for referencing the direct debit mandate. Example: MandateId\",\n \"mandateFinancialAccountId\": \"(string) The account to be debited by the direct debit. Example: MandateFinancialAccountId\",\n \"paymentId\": \"(string) Payment reference to be used by the payer. Example: PMT-2023-001\",\n \"payeeFinancialInstitutionId\": \"(string) Identifier of Payee's bank (BIC, etc.). Example: KREDBEBB\",\n \"payeeFinancialAccountId\": \"(string) Payee's bank account (IBAN, etc.). Example: BE49000023121121\",\n \"payeeFinancialAccountSchemeId\": \"(string) Scheme ID of Payee's bank account (e.g. IBAN). Example: IBAN\",\n \"payeeFinancialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\"\n }\n ],\n \"payee\": {\n \"companyNumber\": \"(string) This element is used for both the identification of the Payee, or the unique banking reference identifier of Payee (assigned by the Payee bank.) For payee identification use ICD code list, for SEPA bank assigned creditor reference, use SEPA. Example: BE0123456749\",\n \"financialAccountId\": \"(string) Payee’s IBAN. Example: BE49000023121121\",\n \"financialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\",\n \"name\": \"(string) Name of payee. Example: PayeeName\"\n },\n \"paymentTerms\": {\n \"text\": \"(string) A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties). Example: Payment in 30 days\",\n \"settlementDiscountPercentage\": \"(number) Early payment discount percentage. If not filled in but SettlementDiscountPercentage is, this value will be calculated based on SettlementDiscountPercentage. Example: 2\",\n \"settlementDiscountAmount\": \"(number) Early payment discount absolute amount. If not filled in but SettlementDiscountAmount is, this value will be calculated based on SettlementDiscountAmount Example: 50.00\"\n },\n \"supplier\": {\n \"id\": \"(string) Internal supplier ID in sender’s system. Example: SUP1\",\n \"name\": \"(string, required) Supplier name. Example: Soluz.io\",\n \"address\": {\n \"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n \"address2\": \"(string) Example: Tax 1\",\n \"address3\": \"(string) Example: Tax 3\",\n \"city\": \"(string) City. Example: Tax Mechelen\",\n \"zip\": \"(string) Postal code. Example: Tax 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province. Example: Vl-Br\",\n \"taxpayersPrefix\": \"(string) VAT UE country prefix (e.g. PL) for intra-Community supplies, cross-border services, and triangular transactions.\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n \"department\": \"(string) Department or branch. Example: DevelopmentDepartment\",\n \"vatNumber\": \"(string) Customer VAT number. Example: BE0123456749\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"endpointId\": \"(string) Electronic endpoint identifier. Example: 0208:be2929035935\",\n \"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 0208\"\n },\n \"buyer\": {\n \"name\": \"(string) Buyer name. Example: Soluz.io\",\n \"address\": {\n \"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n \"zip\": \"(string) Postal code. Example: Tax 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province. Example: Vl-Br\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n \"companyNumberType\": \"(string) Company number type\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0123456749\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"RecipientType\": \"(string) Flag to indicate Subordinate Local Government Unit or GV member\"\n },\n \"taxRepresentative\": {\n \"address\": {\n \"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n \"address2\": \"(string) Example: Tax 1\",\n \"address3\": \"(string) Example: Tax 3\",\n \"city\": \"(string) City. Example: Tax Mechelen\",\n \"zip\": \"(string) Postal code. Example: Tax 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province. Example: Vl-Br\"\n },\n \"name\": \"(string) Tax representative name. Example: Tax Soluz.io\",\n \"vatNumber\": \"(string) VAT number. Example: BE000000097\"\n },\n \"discount\": {\n \"amount\": \"(number) The discount amount. If not filled in but Percentage is, this value will be calculated based on Percentage. Example: 50\",\n \"percentage\": \"(number) The discount percentage. If not filled in but Amount is, this value will be calculated based on Amount. Example: 10\",\n \"reason\": \"(string) Reason for discount. Example: extra korting van 10%\"\n },\n \"charge\": {\n \"amount\": \"(number) Additional charge excl. VAT. Example: 10\",\n \"vatRate\": \"(number) VAT rate on charge. Example: 21\",\n \"vatCode\": \"(string) VAT category code for charge. Example: S\",\n \"reason\": \"(string) Reason for charge. Example: Handling fee\"\n },\n \"totals\": {\n \"amountExclVat\": \"(number) The total amount of the Invoice without VAT. Must be rounded to maximum 2 decimals. Example: 297.00\",\n \"vatAmount\": \"(number) The total VAT amount for the Invoice or the VAT total amount expressed in the accounting currency accepted or required in the country of the Seller. Must be rounded to maximum 2 decimals. Example: 38.07\",\n \"amountInclVat\": \"(number) The total amount of the Invoice with VAT. Must be rounded to maximum 2 decimals. Example: 335.07\",\n \"lineExtensionAmount\": \"(number) Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals. If not supplied this is calculated as the sum of the LineExtensionAmount on the detail lines. Example: 297.00\",\n \"payableAmount\": \"(number) The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals. If not filled in the TaxInclusiveAmount will be used. Example: 335.07\",\n \"payableRoundingAmount\": \"(number) The amount to be added to the invoice total to round the amount to be paid. Must be rounded to maximum 2 decimals. Example: 0.00\",\n \"prepaidAmount\": \"(number) The sum of amounts which have been paid in advance. Must be rounded to maximum 2 decimals. Example: 0.00\"\n },\n \"vatSubTotals\": [\n {\n \"code\": \"(string) VAT category code. Example: S\",\n \"rate\": \"(number) VAT rate. Example: 21.00\",\n \"exemptionReason\": \"(string) Reason for VAT exemption. Example: Intra-community supply\",\n \"exemptionReasonCode\": \"(string) Code for VAT exemption reason. Example: K\",\n \"taxableAmount\": \"(number) Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable). Must be rounded to maximum 2 decimals. Example: 109.41\",\n \"taxAmount\": \"(number) The total VAT amount for a given VAT category. Must be rounded to maximum 2 decimals. Example: 22.98\",\n \"taxTypeIndicator\": \"(string) Additonal Tax Category for non-standard rate\",\n \"splitPaymentIndicator\": \"(string) Split payment indicator\"\n }\n ],\n \"parties\": [\n {\n \"partyName\": \"(string) Name of the party. Example: PANDAVA nv/sa\",\n \"roleCode\": \"(string) Code identifying the role this party has on the invoice. Example: SU\",\n \"endpointID\": \"(string) Electronic endpoint identifier of the party. Note the key is endpointID, not endpointId as used on customer and supplier. Example: 0208:be2929035935\",\n \"endpointIDType\": \"(string) Endpoint type or scheme which relates to the endpointID. Example: 0208\",\n \"identifiers\": [\n {\n \"id\": \"(string, required) Identifier value. Example: 5412345000013\",\n \"schemeId\": \"(string, required) Identifier scheme ID. Max 10 characters. Example: GLN\"\n }\n ],\n \"name\": \"(string) Name of the party. Example: PANDAVA nv/sa\",\n \"address1\": \"(string) Street and street number. Example: Zwartzustersvest 24\",\n \"address2\": \"(string) Address line 2. Example: Unit 5\",\n \"address3\": \"(string) Address line 3. Example: c/o Accounts\",\n \"city\": \"(string) City. Example: Mechelen\",\n \"zip\": \"(string) Postal code. Example: 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2 country code. Example: BE\",\n \"countryName\": \"(string) Country name. Example: Belgium\",\n \"countrySubEntity\": \"(string) Province, state or region. Example: Antwerpen\",\n \"vatNumber\": \"(string) VAT number of the party. Example: BE0123456749\",\n \"contactID\": \"(string) Identifier of the contact. Example: CT-001\",\n \"contactName\": \"(string) Contact person. Example: Jan Peeters\",\n \"contactEmail\": \"(string) Contact email. Example: jan@soluz.io\",\n \"contactPhone\": \"(string) Contact phone. Example: +3215999888\",\n \"partyLERegistrationName\": \"(string) Registered legal entity name of the party. Example: PANDAVA nv/sa\",\n \"partyLECompanyID\": \"(string) Legal entity company identifier. Example: 0999001396\",\n \"partyLECompanyIDType\": \"(string) Scheme of the legal entity company identifier. Example: 0208\",\n \"partyLECompanyLegalForm\": \"(string) Legal form of the legal entity. Example: nv/sa\",\n \"recipientType\": \"(string) Flag to indicate Subordinate Local Government Unit or GV member\"\n }\n ],\n \"detailLines\": [\n {\n \"id\": \"(string) Unique line ID. Example: 1\",\n \"quantity\": \"(number, required) Quantity invoiced. Example: 3\",\n \"articleName\": \"(string, required) Item name. Example: Agenda Timing 2024\",\n \"accountingCost\": \"(string) A textual value that specifies where to book the relevant data into the Buyer's financial accounts. Example: 700100\",\n \"additionalItemProperties\": \"(object) Additional properties of the goods/services. Example: { \\\"color\\\": \\\"blue\\\" }\",\n \"allowanceReason\": \"(string) Coded reason for allowance/charge. Example: 95\",\n \"allowanceAmount\": \"(number) The allowance amount, if there is an allowance. Example: 1.00\",\n \"chargeReason\": \"(string) Coded reason for allowance/charge. Example: 95\",\n \"chargeAmount\": \"(number) The charge amount, if there is a charge. Example: 1.00\",\n \"commodityClassificationCodes\": \"(object) Classification codes (e.g. UNSPSC, CPV, etc.). Example: { \\\"UNSPSC\\\": \\\"44121706\\\" }\",\n \"articleDescription\": \"(string) Item description. Example: Black hard cover\",\n \"articleNumberBuyer\": \"(string) Buyer’s item code. Example: ITM-001\",\n \"articleNumberSupplier\": \"(string) Supplier’s item code. Example: SUP-7788\",\n \"lineExtensionAmount\": \"(number, required) The total amount of the Invoice line. The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes. Must be rounded to maximum 2 decimals. If not supplied, the AmountExclVat will be used. Example: 150.00\",\n \"vatRate\": \"(number, required) VAT rate percentage. Example: 21\",\n \"vatCode\": \"(string) VAT category code. Example: S\",\n \"orderLineId\": \"(string) Reference to buyer’s order line. Example: 1000\",\n \"note\": \"(string) A textual note that gives unstructured information that is relevant to the Invoice line. Example: Delivered in January\",\n \"deliveryDate\": \"(string, date) Date of delivery for line (YYYY-MM-DD). Example: 2023-01-03\",\n \"deliveryNoteReference\": \"(string) Reference to delivery note. Example: DN-12345\",\n \"docRefDocType\": \"(string) Type of referenced document (code 130 = invoice object reference). Example: 130\",\n \"docRefId\": {\n \"id\": \"(string) Identifier of referenced object. Example: 998877\",\n \"schemeId\": \"(string) Scheme ID of reference. Example: PO\"\n },\n \"originCountryCode\": \"(string) Country of origin (ISO 3166-1 alpha-2). Example: BE\",\n \"standardItemIdentification\": {\n \"id\": \"(string) Standard item identifier. Example: 5412345678908\",\n \"schemeId\": \"(string) Identification scheme. Example: GTIN\"\n },\n \"price\": {\n \"articlePrice\": \"(number) The price of an item, exclusive of VAT, after subtracting item price discount. The Item net price has to be equal with the Item gross price less the Item price discount, if they are both provided. Item price can not be negative. Example: 50.00\",\n \"baseQuantity\": \"(number) Quantity basis for price. Example: 1\",\n \"unitOfMeasure\": \"(string) Unit of measure. Codes for unit of packaging from UNECE Recommendation No. 21 can be used in accordance with the descriptions in the Intro section of UN/ECE Recommendation 20, Revision 11 (2015): The 2 character alphanumeric code values in UNECE Recommendation 21 shall be used. o avoid duplication with existing code values in UNECE Recommendation No. 20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure. Example: H87\",\n \"allowanceAmount\": \"(number) The total discount subtracted from the Item gross price to calculate the Item net price. Example: 55.00\",\n \"allowanceBaseAmount\": \"(number) The unit price, exclusive of VAT, before subtracting Item price discount, can not be negative. Example: 60.00\"\n },\n \"vatExemptionReason\": \"(string) Reason for VAT exemption. Example: Intra-community supply\",\n \"vatExemptionReasonCode\": \"(string) Code for VAT exemption reason. Example: E\",\n \"uuLineNumber\": \"(string) Universal unique line number. Should be unique not only per invoice but per taxpayer or invoicing system\",\n \"lineGTU\": \"(string) Designation for the delivery of goods and the provision of services\",\n \"startDate\": \"(string, date) Invoice period start date for this line (YYYY-MM-DD). Example: 2023-11-01\",\n \"endDate\": \"(string, date) Invoice period end date for this line (YYYY-MM-DD). Example: 2023-11-30\",\n \"exemptFromDiscount\": \"(boolean) Set to true to exempt this line from the invoice level discount. Example: false\",\n \"lineDueDateTypeCode\": \"(string) Code specifying the type of due date that applies to this invoice line. Example: 3\",\n \"referencedDespatchDocId\": \"(string) Identifier of the despatch advice this line refers to. Example: DESP-993\",\n \"referencedDespatchDocLineId\": \"(string) Line identifier within the referenced despatch advice. Example: 2\",\n \"referencedInvoiceDocId\": \"(string) Identifier of the invoice this line refers to. Example: INV-2021-77\",\n \"referencedInvoiceDocLineId\": \"(string) Line identifier within the referenced invoice. Example: 4\",\n \"referencedInvoiceDocTypeCode\": \"(string) Document type code of the referenced invoice. Example: 380\",\n \"referencedInvoiceDocIssueDate\": \"(string, date) Issue date of the referenced invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"referencedReceiptDocId\": \"(string) Identifier of the receiving advice this line refers to. Example: RCPT-331\",\n \"referencedReceiptDocLineId\": \"(string) Line identifier within the referenced receiving advice. Example: 1\",\n \"referencedSalesOrderDocId\": \"(string) Identifier of the sales order this line refers to. Example: SO-10099\",\n \"referencedSalesOrderDocLineId\": \"(string) Line identifier within the referenced sales order. Example: 7\",\n \"deliveryActualDeliveryDate\": \"(string, date) Actual delivery date for this line (YYYY-MM-DD). Example: 2023-11-05\",\n \"deliveryPartyName\": \"(string) Name of the party this line was delivered to. Example: Soluz.io afleveradres\",\n \"deliveryLocationIDs\": \"(string) Identifier of the delivery location for this line. Example: 5412345000013\",\n \"deliveryLocationAddress1\": \"(string) Delivery location street and number. Example: Berendries 52\",\n \"deliveryLocationAddress2\": \"(string) Delivery location address line 2. Example: Building A\",\n \"deliveryLocationAddress3\": \"(string) Delivery location address line 3. Example: Floor 2\",\n \"deliveryLocationCity\": \"(string) Delivery location city. Example: Lovendegem\",\n \"deliveryLocationZIP\": \"(string) Delivery location postal code. Example: 5400\",\n \"deliveryLocationCountrySubEntity\": \"(string) Delivery location province, state or region. Example: O-Vl\",\n \"deliveryLocationCountryCode\": \"(string) Delivery location country (ISO 3166-1 alpha-2). Example: BE\"\n }\n ]\n },\n \"processing\": {\n \"deliveryMethod\": \"(string) Outbound channel (e.g. PEPPOL, E-MAIL, POST). Example: PEPPOL\",\n \"extraCode1\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode2\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode3\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode4\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode5\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode6\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode7\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode8\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode9\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode10\": \"(string) Optional extra information that can be used in rules\",\n \"extraInfo\": \"(string) Free-form text, up to 500 chars.\",\n \"senderPartyEntity\": \"(string) ComFin contract number if ComFin customer. Example: BE00001\",\n \"messageType\": \"(string) Message type for XML (default EFFF). Example: EFFF\"\n },\n \"image\": {\n \"embedded\": \"(boolean) Is it an embedded file? Example: true\",\n \"name\": \"(string) File name. Example: factuurImage.pdf\",\n \"mimeType\": \"(string) MIME type. Example: application/pdf\",\n \"value\": \"(string, base64) Base64 content of file. Example: BASE64 here\"\n },\n \"attachments\": [\n {\n \"embedded\": \"(boolean) Is it an embedded file? Example: true\",\n \"name\": \"(string) File name. Example: Attach.pdf\",\n \"mimeType\": \"(string) MIME type. Example: application/pdf\",\n \"value\": \"(string, base64) Base64 content\"\n }\n ]\n}\n»» dueDate: The date when the payment is due.Format \"YYYY-MM-DD\".\nIn case the Amount due for payment (BT-115) is positive,\neither the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.
\n»» documentNumber: A unique identification of the Invoice,\nto uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller.
\n»» invoiceNumber: A unique identification of the Invoice,\nto uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller.
\n»» structuredCommunication: A textual value used to establish a link between the payment and the Invoice, issued by the Seller.\nUsed for creditor's critical reconciliation information.\nThis information element helps the Seller to assign an incoming payment to the relevant payment process.
\n»» taxPointDate: The date when the VAT becomes accountable for the Seller and for the Buyer in so far as that date can be determined and differs from the date of issue of the invoice, according to the VAT directive.\nThis element is required if the Value added tax point date is different from the Invoice issue date.
\n»»» accountingCost: Buyer accounting reference\nA textual value that specifies where to book the relevant data into the Buyer's financial accounts.\nExample value: 4217:2323:2323
\n»»» companyNumber: This element is used for both the identification of the Payee,\nor the unique banking reference identifier of Payee (assigned by the Payee bank.)\nFor payee identification use ICD code list, for SEPA bank assigned creditor reference, use SEPA.
\n»»» mandateId: Unique identifier assigned by the Payee for referencing the direct debit mandate.\nUsed in order to pre-notify the Buyer of a SEPA direct debit.
\n»»» text: The means, expressed as text, for how a payment is expected to be or has been settled.\nExample value: Credit transfer
\n»»» text: A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties).\nIn case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.
\n»»» lineExtensionAmount: Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals.\nIf not supplied this is calculated as the sum of the LineExtensionAmount on the detail lines
\n»»» payableAmount: The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals.\nIf not filled in the TaxInclusiveAmount will be used
\n»»» taxableAmount: Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable).\nMust be rounded to maximum 2 decimals.
\n»»» splitPaymentIndicator: Split payment indicator (\"mechanizm podzielonej płatności\").\nRequired when invoice total exceeds PLN 15,000 and covers Annex 15 goods/services.
\n»»» lineExtensionAmount: The total amount of the Invoice line. The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes.\nMust be rounded to maximum 2 decimals.\nIf not supplied, the AmountExclVat will be used
\n»»»» articlePrice: The price of an item, exclusive of VAT, after subtracting item price discount.\nThe Item net price has to be equal with the Item gross price less the Item price discount, if they are both provided.\nItem price can not be negative.
\n»»»» unitOfMeasure: The unit of measure that applies to the invoiced quantity.\nCodes for unit of packaging from UNECE Recommendation No.\n21 can be used in accordance with the descriptions in the \"Intro\" section of UN/ECE Recommendation 20, Revision 11 (2015):\nThe 2 character alphanumeric code values in UNECE Recommendation 21 shall be used.\nTo avoid duplication with existing code values in UNECE Recommendation No.\n20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure.
\n»»» uuLineNumber: Universal unique line number\nShould be unique not only per invoice but per taxpayer or invoicing system
\n»»» recipientType: Type of the buyer\nPossible values:\n12: JST Recipient\n21: GV Recipient
\n»» name: name of the file\nIf it isn't an embedded file, it should be included as multipart file-data. The name of the file should be identical.
\n\n\nExample responses
\n
\n\n201 Response
\n
{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n }\n }\n}\nPOST /outbound/companies/{partyId}/inbox/invoices
Search invoices in the inbox
\nSearches the inbox of the company: sent invoices that are ready to be downloaded and have not been marked as downloaded yet.
\nUsage
\ninvoicedate-from and invoicedate-to are required. Only invoices with an invoice date in this range (both dates included) are returned. Format: YYYY-MM-DD.invoiceNumber (exact match), objectId and uniqueId.page: page-number starts at 1. records-per-page defaults to 20 and is capped at 100.Typical flow
\nResponses
\n200 OK: the current page, the number of totalPages and the matching invoices.400 Bad Request: the request body is missing or not valid.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.\n\nBody parameter
\n
{\n \"invoicedate-from\": \"(string,date) The start date for the invoice date range. Example: 1951-09-07T18:14:00.209Z\",\n \"invoicedate-to\": \"(string,date) The end date for the invoice date range. Example: 2010-06-27T14:00:39.906Z\",\n \"invoiceNumber\": \"(string) The invoice number. Example: SOL-1200\",\n \"objectId\": \"(string) Object id of the document. Example: 4728\",\n \"uniqueId\": \"(string) Unique id of the document. Example: 1095953\",\n \"page\": {\n \"page-number\": \"(number) Page number. Example: 2\",\n \"records-per-page\": \"(number) Amount of records per page. Example: 25\"\n },\n \"status\": \"(string) Filter on status. Example: PENDING\"\n}\n\n\nExample responses
\n
\n\n200 Response
\n
{\n \"invoices\": [\n {\n \"id\": \"(number) Internal ID of the Invoice. Used in GetInvoice to get the details of this invoice. Example: 53973544\",\n \"uniqueId\": \"(string) Unique identifier. Example: 0000130974010053973544\",\n \"invoiceNumber\": \"(string) Invoice number. Example: 23110000291\",\n \"currency\": \"(string) ISO 4217 currency code. Example: EUR\",\n \"type\": \"(string) Invoice type (INVOICE or CREDITNOTE). Example: INVOICE\",\n \"date\": \"(string, date) Issue date (YYYY-MM-DD). Example: 2023-11-07\",\n \"dueDate\": \"(string, date) Due date for payment (YYYY-MM-DD). Example: 2023-12-07\",\n \"totals\": {\n \"amountExclVat\": \"(number) Invoice total excl. VAT. Example: 109.41\",\n \"vatAmount\": \"(number) Invoice VAT amount. Example: 22.98\",\n \"amountInclVat\": \"(number) Invoice total incl. VAT. Example: 132.39\"\n },\n \"customer\": {\n \"name\": \"(string) Buyer name. Example: GEMEENTE STABROEK\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0207537834\"\n },\n \"supplier\": {\n \"name\": \"(string) Seller name. Example: PANDAVA nv/sa\",\n \"vatNumber\": \"(string) Seller VAT number. Example: BE0419001396\"\n }\n }\n ]\n}\nGET /outbound/companies/{partyId}/inbox/invoices
List invoices in the inbox
\nReturns the first page of the inbox of the company: sent invoices that are ready to be downloaded and have not been marked as downloaded yet.
\nUsage
\ntotalPages is more than 1, use POST /outbound/companies/{partyId}/inbox/invoices/search with paging to get the rest.Typical flow
\nResponses
\n200 OK: the first page of the inbox.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.\n\nExample responses
\n
\n\n200 Response
\n
{\n \"invoices\": [\n {\n \"id\": \"(number) Internal ID of the Invoice. Used in GetInvoice to get the details of this invoice. Example: 53973544\",\n \"uniqueId\": \"(string) Unique identifier. Example: 0000130974010053973544\",\n \"invoiceNumber\": \"(string) Invoice number. Example: 23110000291\",\n \"currency\": \"(string) ISO 4217 currency code. Example: EUR\",\n \"type\": \"(string) Invoice type (INVOICE or CREDITNOTE). Example: INVOICE\",\n \"date\": \"(string, date) Issue date (YYYY-MM-DD). Example: 2023-11-07\",\n \"dueDate\": \"(string, date) Due date for payment (YYYY-MM-DD). Example: 2023-12-07\",\n \"totals\": {\n \"amountExclVat\": \"(number) Invoice total excl. VAT. Example: 109.41\",\n \"vatAmount\": \"(number) Invoice VAT amount. Example: 22.98\",\n \"amountInclVat\": \"(number) Invoice total incl. VAT. Example: 132.39\"\n },\n \"customer\": {\n \"name\": \"(string) Buyer name. Example: GEMEENTE STABROEK\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0207537834\"\n },\n \"supplier\": {\n \"name\": \"(string) Seller name. Example: PANDAVA nv/sa\",\n \"vatNumber\": \"(string) Seller VAT number. Example: BE0419001396\"\n }\n }\n ]\n}\nPOST /outbound/companies/{partyId}/inbox/invoices/search
Search invoices in the inbox
\nSearches the inbox of the company: sent invoices that are ready to be downloaded and have not been marked as downloaded yet.
\nUsage
\ninvoicedate-from and invoicedate-to are required. Only invoices with an invoice date in this range (both dates included) are returned. Format: YYYY-MM-DD.invoiceNumber (exact match), objectId and uniqueId.page: page-number starts at 1. records-per-page defaults to 20 and is capped at 100.Typical flow
\nResponses
\n200 OK: the current page, the number of totalPages and the matching invoices.400 Bad Request: the request body is missing or not valid.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.\n\nBody parameter
\n
{\n \"invoicedate-from\": \"(string,date) The start date for the invoice date range. Example: 1951-09-07T18:14:00.209Z\",\n \"invoicedate-to\": \"(string,date) The end date for the invoice date range. Example: 2010-06-27T14:00:39.906Z\",\n \"invoiceNumber\": \"(string) The invoice number. Example: SOL-1200\",\n \"objectId\": \"(string) Object id of the document. Example: 4728\",\n \"uniqueId\": \"(string) Unique id of the document. Example: 1095953\",\n \"page\": {\n \"page-number\": \"(number) Page number. Example: 2\",\n \"records-per-page\": \"(number) Amount of records per page. Example: 25\"\n },\n \"status\": \"(string) Filter on status. Example: PENDING\"\n}\n\n\nExample responses
\n
\n\n200 Response
\n
{\n \"invoices\": [\n {\n \"id\": \"(number) Internal ID of the Invoice. Used in GetInvoice to get the details of this invoice. Example: 53973544\",\n \"uniqueId\": \"(string) Unique identifier. Example: 0000130974010053973544\",\n \"invoiceNumber\": \"(string) Invoice number. Example: 23110000291\",\n \"currency\": \"(string) ISO 4217 currency code. Example: EUR\",\n \"type\": \"(string) Invoice type (INVOICE or CREDITNOTE). Example: INVOICE\",\n \"date\": \"(string, date) Issue date (YYYY-MM-DD). Example: 2023-11-07\",\n \"dueDate\": \"(string, date) Due date for payment (YYYY-MM-DD). Example: 2023-12-07\",\n \"totals\": {\n \"amountExclVat\": \"(number) Invoice total excl. VAT. Example: 109.41\",\n \"vatAmount\": \"(number) Invoice VAT amount. Example: 22.98\",\n \"amountInclVat\": \"(number) Invoice total incl. VAT. Example: 132.39\"\n },\n \"customer\": {\n \"name\": \"(string) Buyer name. Example: GEMEENTE STABROEK\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0207537834\"\n },\n \"supplier\": {\n \"name\": \"(string) Seller name. Example: PANDAVA nv/sa\",\n \"vatNumber\": \"(string) Seller VAT number. Example: BE0419001396\"\n }\n }\n ]\n}\nPOST /outbound/companies/{partyId}/inbox/invoices/{id}/markdownloaded
Mark invoice as downloaded
\nMarks an invoice as downloaded, which removes it from the inbox.
\nUsage
\nResponses
\n200 OK: a message confirming the invoice was marked as downloaded.404 Not Found: unknown PartyId, or the invoice is not in the inbox.401 Unauthorized: the API key is missing or not valid.\n\nExample responses
\n
\n\n200 Response
\n
{\n \"type\": \"object\",\n \"description\": \"Response when an object is marked as downloaded\",\n \"additionalProperties\": false,\n \"properties\": {\n \"message\": {\n \"type\": \"string\",\n \"description\": \"Informational message\",\n \"nullable\": true\n }\n }\n}\nGET /outbound/peppol/participants/{participantId}
Get Peppol participant status
\nChecks whether a company is registered on the Peppol network, and which document types it can receive. Use it to find out if a customer can receive invoices through Peppol.
\nUsage\nparticipantId can be:
scheme:identifier, for example 0208:0123456789 (Belgian company number). This is looked up on the Peppol network.BE0123456789.This endpoint does not use a PartyId.
\nResponses
\n200 OK: isOnPeppol, receivingInvoices (true when the participant accepts UBL invoices) and the services it supports. A participant that is not on Peppol returns isOnPeppol false.404 Not Found: the lookup failed.401 Unauthorized: the API key is missing or not valid.\n\nExample responses
\n
\n\n200 Response
\n
{\n \"isOnPeppol\": \"(boolean) Indicates if the participant is registered on the Peppol network. Example: true\",\n \"receivingInvoices\": \"(boolean) Indicates if the participant can receive invoices via Peppol. Example: true\",\n \"services\": [\n {\n \"participantId\": \"(string) The Peppol participant identifier (schemeId + identifier). Example: 0208:be2929035935\",\n \"documentTypeId\": \"(string) The document type identifier supported. Example: urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##peppol-EN16931::2.1\",\n \"endpointAddress\": \"(string) The endpoint address (URL) where documents can be delivered. Example: https://peppol.codabox.com/peppol/as4\"\n },\n {\n \"participantId\": \"(string) Example: 0192:987654321\",\n \"documentTypeId\": \"(string) Example: urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##peppol-EN16931::2.1\",\n \"endpointAddress\": \"(string) Example: https://peppol.codabox.com/peppol/as4\"\n }\n ]\n}\n{\n \"companies\": [\n {\n \"id\": \"(number) PartyId of the company. Use it as {partyId} in all other requests, e.g. POST companies/101/invoices/search. Example: 101\",\n \"name\": \"(string) Name of the company. Example: Soluz.io\",\n \"vatNumber\": \"(string) VAT number of the company. Example: BE0123456749\",\n \"companyNumber\": \"(string) National company registry number. Example: 0123456749\"\n },\n {\n \"id\": \"(number) PartyId of the company. Use it as {partyId} in all other requests, e.g. POST companies/102/invoices/search. Example: 102\",\n \"name\": \"(string) Name of the company. Example: Pandava nv/sa\",\n \"vatNumber\": \"(string) VAT number of the company. Example: BE0999001396\",\n \"companyNumber\": \"(string) National company registry number. Example: 0999001396\"\n }\n ]\n}\n\nResponse of GET companies: the companies your API key has access to
\n{\n \"id\": \"(number) PartyId of the company. Use it as {partyId} in all other requests, e.g. POST companies/101/invoices/search. Example: 101\",\n \"name\": \"(string) Name of the company. Example: Soluz.io\",\n \"vatNumber\": \"(string) VAT number of the company. Example: BE0123456749\",\n \"companyNumber\": \"(string) National company registry number. Example: 0123456749\"\n}\n\nCompany
\n{\n \"type\": \"object\",\n \"description\": \"Object that represents an unauthorized error\",\n \"additionalProperties\": false,\n \"properties\": {\n \"message\": {\n \"type\": \"string\",\n \"description\": \"A message\",\n \"nullable\": true\n }\n }\n}\n\nObject that represents an unauthorized error
\n{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n }\n }\n}\n\n{\n \"type\": \"object\",\n \"additionalProperties\": false\n}\n\nNone
\n{\n \"type\": \"object\",\n \"description\": \"Object that represents a not found error\",\n \"additionalProperties\": false,\n \"properties\": {\n \"statusCode\": {\n \"type\": \"integer\",\n \"description\": \"A status code\",\n \"format\": \"int32\"\n },\n \"message\": {\n \"type\": \"string\",\n \"description\": \"A message\",\n \"nullable\": true\n }\n }\n}\n\nObject that represents a not found error
\n{\n \"type\": \"object\",\n \"description\": \"Object that represents a not acceptable error\",\n \"additionalProperties\": false,\n \"properties\": {\n \"message\": {\n \"type\": \"string\",\n \"description\": \"A message\",\n \"nullable\": true\n }\n }\n}\n\nObject that represents a not acceptable error
\n{\n \"Message\": \"The request is invalid.\",\n \"ModelState\": {\n \"model.name\": [\n \"The name field is required.\"\n ]\n }\n}\n\nObject that represents a bad request error
\n{\n \"id\": \"(number) Internal system ID. Example: 99993544\",\n \"uniqueId\": \"(string) Unique identifier. Example: 0000365474010053973333\",\n \"transactionId\": \"(string) Transaction identifier. Example: 2AF410E4DEF234DB89918E6EEC7DF825\",\n \"invoiceNumber\": \"(string) Invoice number. Example: 23110000291\",\n \"currency\": \"(string) ISO 4217 currency code. Example: EUR\",\n \"type\": \"(string) Invoice type (INVOICE or CREDITNOTE). Example: INVOICE\",\n \"date\": \"(string, date) Issue date (YYYY-MM-DD). Example: 2023-11-07\",\n \"dueDate\": \"(string, date) Due date for payment (YYYY-MM-DD). In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present. Example: 2023-12-07\",\n \"paymentLink\": \"(string) A link to a payment website, QR code or similar. Example: http://exsite.qr.com/AEU9ZR843J\",\n \"paymentLinkPaidAt\": \"(string, date) The date when the payment link was paid (YYYY-MM-DD). Example: 2023-12-07\",\n \"placeOfIssue\": \"(string) Place where the invoice was issued\",\n \"fullyPaid\": \"(boolean) Indicates if an invoice has been paid\",\n \"dateOfFullPayment\": \"(string) date of payment\",\n \"simplifiedTriangularProcedure\": \"(string) Indication if invoice is issued under simplified procedure by the second taxpayer\",\n \"checkoutMethod\": \"(boolean) Cash accounting indicator\",\n \"selfBillingIndicator\": \"(boolean) Selfbilling indicator\",\n \"warehouseDocumentNumbers\": \"(string) WZ (delivery note) document numbers\",\n \"typeName\": \"(string) Invoice Type\",\n \"restrictedInformation\": \"(string) Indicator if Invoice referred to in Art. 109 sec. 3d of the Act\",\n \"downloaded\": \"(boolean) Indicates whether one of the invoice files has already been retrieved through GetInvoiceFile. Example: false\",\n \"note\": \"(string) A textual note that gives unstructured information that is relevant to the Invoice as a whole. Such as the reason for any correction, or an assignment note in case the invoice has been factored. Max 2000 characters.\",\n \"invoicePeriodDescriptionCode\": \"(string) Coded description of the invoice period. Max 50 characters. Example: 3\",\n \"deliveryTermsId\": \"(string) Delivery terms identifier. Max 200 characters. Example: CIF\",\n \"deliveryTermsDeliveryLocationName\": \"(string) Name of the location the delivery terms apply to. Max 200 characters. Example: Port of Antwerp\",\n \"contractDocReferenceTypeCode\": \"(string) Document type code of the referenced contract. Max 100 characters. Example: 130\",\n \"clearanceReferenceId\": \"(string) Unique reference identifier assigned during the clearance process. Only returned for countries where clearance is required. Example: 4837291056-20240115-A1B2C3D4E5F6-7A\",\n \"clearanceReferenceDate\": \"(string) Date the invoice was cleared by the tax authority, in the format supplied by that authority. Only returned for countries where clearance is required. Example: 2024-01-15T10:15:30Z\",\n \"clearanceDetails\": \"(string) Additional details received during the clearance process. For KSeF this contains the QR metadata. Example: https://ksef.mf.gov.pl/\",\n \"totals\": {\n \"amountExclVat\": \"(number) The total amount of the Invoice without VAT. Must be rounded to maximum 2 decimals. Example: 297.00\",\n \"vatAmount\": \"(number) The total VAT amount for the Invoice or the VAT total amount expressed in the accounting currency accepted or required in the country of the Seller. Must be rounded to maximum 2 decimals. Example: 38.07\",\n \"amountInclVat\": \"(number) The total amount of the Invoice with VAT. Must be rounded to maximum 2 decimals. Example: 335.07\",\n \"lineExtensionAmount\": \"(number) Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals. If not supplied this is calculated as the sum of the LineExtensionAmount on the detail lines. Example: 297.00\",\n \"payableAmount\": \"(number) The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals. If not filled in the TaxInclusiveAmount will be used. Example: 335.07\",\n \"payableRoundingAmount\": \"(number) The amount to be added to the invoice total to round the amount to be paid. Must be rounded to maximum 2 decimals. Example: 0.00\",\n \"prepaidAmount\": \"(number) The sum of amounts which have been paid in advance. Must be rounded to maximum 2 decimals. Example: 0.00\",\n \"chargeAmount\": \"(number) Additional charge excl. VAT. Example: 10\",\n \"allowanceAmount\": \"(number) Total allowance/exemption excl. VAT. Example: 5.00\"\n },\n \"customer\": {\n \"id\": \"(string) Internal customer ID. Example: CUST1\",\n \"name\": \"(string) Buyer name. Example: GEMEENTE SOL\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0907537834\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"companyNumber\": \"(string) National registry ID (if applicable). Example: 0907537834\",\n \"address\": {\n \"address1\": \"(string) Street. Example: Laatstraat 99\",\n \"city\": \"(string) City. Example: STABROEK\",\n \"zip\": \"(string) Postal code. Example: 2940\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2 code. Example: BE\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"department\": \"(string) Department or branch. Example: DevelopmentDepartment\",\n \"endpointId\": \"(string) Electronic endpoint identifier. Example: BE2929035935\",\n \"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 9925\",\n \"identifications\": [\n {\n \"id\": \"(string, required) Identifier value. Max 200 characters. Example: 0123456749\",\n \"schemeId\": \"(string, required) Identifier scheme ID. Max 10 characters. Example: 0208\"\n }\n ]\n },\n \"supplier\": {\n \"id\": \"(string) Internal supplier ID. Example: SUP1\",\n \"name\": \"(string) Seller name. Example: INCREDIBLO nv/sa\",\n \"vatNumber\": \"(string) Seller VAT number. Example: BE0999001396\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"address\": {\n \"address1\": \"(string) Street. Example: Lage Weg 123 A\",\n \"city\": \"(string) City. Example: Hoevenen-Stabroek\",\n \"zip\": \"(string) Postal code. Example: 2940\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2 code. Example: BE\",\n \"taxpayersPrefix\": \"(string) VAT UE country prefix (e.g. PL) for intra-Community supplies, cross-border services, and triangular transactions.\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"department\": \"(string) Department or branch. Example: DevelopmentDepartment\",\n \"endpointId\": \"(string) Electronic endpoint identifier. Example: BE2929035935\",\n \"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 9925\",\n \"identifications\": [\n {\n \"id\": \"(string, required) Identifier value. Max 200 characters. Example: 0123456749\",\n \"schemeId\": \"(string, required) Identifier scheme ID. Max 10 characters. Example: 0208\"\n }\n ]\n },\n \"buyer\": {\n \"name\": \"(string) Buyer name. Example: Soluz.io\",\n \"address\": {\n \"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n \"zip\": \"(string) Postal code. Example: Tax 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province. Example: Vl-Br\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n \"companyNumberType\": \"(string) Company number type\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0123456749\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"RecipientType\": \"(string) Flag to indicate Subordinate Local Government Unit or GV member\"\n },\n \"references\": {\n \"accountingCost\": \"(string) Buyer accounting reference. Example: 4217:2323:2323\",\n \"billingReferences\": [\n {\n \"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n \"invoiceDocumentReferenceIssueDate\": \"(string, date) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"reasonForCorrection\": \"(string) Reason for correction\",\n \"externalReference\": \"(string) Number identifying the corrected invoice in the National System of e-Invoices\",\n \"typeOfCorrection\": \"(string) Type of correction\"\n }\n ],\n \"buyerReference\": \"(string) An identifier assigned by the Buyer used for internal routing purposes. An invoice must have buyer reference or purchase order reference (BT-13). Example: ABC/984/B2\",\n \"contractDocReference\": \"(string) Contract identifier by seller. Example: CT-2022-001\",\n \"contractDocIssueDate\": \"(string, date) Contract date by seller (YYYY-MM-DD). Example: 2022-01-15\",\n \"contractDocReferenceCustomer\": \"(string) Contract identifier by customer. Example: CUST-CT-88\",\n \"contractDocIssueDateCustomer\": \"(string, date) Contract date by customer (YYYY-MM-DD). Example: 2022-01-20\",\n \"despatchDocReference\": \"(string) Dispatch advice ID. Example: DESP-993\",\n \"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n \"invoiceDocumentReferenceIssueDate\": \"(string, date) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"originatorDocReference\": \"(string) Tender or lot reference. Example: TND-2022-01\",\n \"projectReference\": \"(string) Project reference. Example: PROJ-Delta-01\",\n \"receiptDocReference\": \"(string) Receiving advice ID. Example: RCPT-331\",\n \"purchaseOrderReference\": \"(string) Purchase order ID. Example: PA992430\",\n \"salesOrderReference\": \"(string) Sales order ID. Example: 11-145210\"\n },\n \"detailLines\": [\n {\n \"id\": \"(string) Unique identifier for this invoice line. Example: 1\",\n \"additionalItemProperties\": \"(object) Additional properties of the goods/services. Example: { \\\"color\\\": \\\"blue\\\" }\",\n \"articleName\": \"(string) Item name. Example: Agenda Timing 2024 genaaid Lima zwart\",\n \"articleDescription\": \"(string) Item description, more detail than name. Example: Hardcover planner with stitched binding\",\n \"articleNumberBuyer\": \"(string) Buyer-assigned item identifier. Example: B-98431\",\n \"articleNumberSupplier\": \"(string) Seller-assigned item identifier. Example: 56.1142.021/9\",\n \"lineExtensionAmount\": \"(number) Net line amount excl. VAT (inclusive of line-level allowances/charges). Example: 9.06\",\n \"commodityClassificationCodes\": \"(object) Classification codes (e.g. UNSPSC, CPV, etc.). Example: { \\\"UNSPSC\\\": \\\"44121706\\\" }\",\n \"deliveryDate\": \"(string, date) Delivery date (YYYY-MM-DD). Example: 2023-11-05\",\n \"deliveryNoteReference\": \"(string) Reference to a delivery note. Example: DN-2023-1115\",\n \"docRefDocType\": \"(string) Document type code for referenced object (use 130 for invoice object reference). Example: 130\",\n \"docRefId\": {\n \"id\": \"(string) Identifier value. Example: 123456789\",\n \"schemeId\": \"(string) Identifier scheme ID. Example: PO\"\n },\n \"note\": \"(string) Unstructured note relevant to this line. Example: Urgent delivery\",\n \"originCountryCode\": \"(string) Country of origin (ISO 3166-1 alpha-2). Example: BE\",\n \"accountingCost\": \"(string) Buyer’s accounting allocation reference. Example: 4217:2323:2323\",\n \"startDate\": \"(string, date) Invoice period start date (YYYY-MM-DD). Example: 2023-11-01\",\n \"endDate\": \"(string, date) Invoice period end date (YYYY-MM-DD). Example: 2023-11-30\",\n \"vatCode\": \"(string) VAT category code. Example: S\",\n \"vatRate\": \"(number) VAT rate (%) applied. Example: 21.00\",\n \"orderLineId\": \"(string) Buyer purchase order line reference. Example: 15\",\n \"quantity\": \"(number) Quantity of items invoiced. Example: 2.00\",\n \"standardItemIdentification\": {\n \"id\": \"(string) Standard identifier value. Example: 5412345123453\",\n \"schemeId\": \"(string) Standard identifier scheme (e.g. GTIN, EAN). Example: GTIN\"\n },\n \"price\": {\n \"articlePrice\": \"(number) The price of an item, exclusive of VAT, after subtracting item price discount. The Item net price has to be equal with the Item gross price less the Item price discount, if they are both provided. Item price can not be negative. Example: 50.00\",\n \"baseQuantity\": \"(number) Quantity basis for price. Example: 1\",\n \"unitOfMeasure\": \"(string) Unit of measure. Codes for unit of packaging from UNECE Recommendation No. 21 can be used in accordance with the descriptions in the Intro section of UN/ECE Recommendation 20, Revision 11 (2015): The 2 character alphanumeric code values in UNECE Recommendation 21 shall be used. o avoid duplication with existing code values in UNECE Recommendation No. 20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure. Example: H87\",\n \"allowanceAmount\": \"(number) The total discount subtracted from the Item gross price to calculate the Item net price. Example: 55.00\",\n \"allowanceBaseAmount\": \"(number) The unit price, exclusive of VAT, before subtracting Item price discount, can not be negative. Example: 60.00\"\n },\n \"allowanceCharge\": {\n \"reason\": \"(string) Reason for allowance/charge. Example: Promotion\",\n \"reasonCode\": \"(string) Coded reason for allowance/charge. Example: 95\",\n \"amount\": \"(decimal) Amount excl. VAT. Example: 1.00\",\n \"chargeIndicator\": \"(number) true=Charge, false=Allowance. Example: false\",\n \"taxCode\": \"(string) VAT category code. Example: S\",\n \"taxPercentage\": \"(number) VAT rate for allowance/charge. Example: 21.00\"\n },\n \"vatExemptionReason\": \"(string) Reason text if VAT-exempt. Example: Intra-community supply\",\n \"vatExemptionReasonCode\": \"(string) Reason code if VAT-exempt. Example: K\",\n \"uuLineNumber\": \"(string) Universal unique line number. Should be unique not only per invoice but per taxpayer or invoicing system\",\n \"lineGTU\": \"(string) Designation for the delivery of goods and the provision of services\",\n \"lineDueDateTypeCode\": \"(string) Code specifying the type of due date that applies to this invoice line. Example: 3\",\n \"referencedDespatchDocId\": \"(string) Identifier of the despatch advice this line refers to. Example: DESP-993\",\n \"referencedDespatchDocLineId\": \"(string) Line identifier within the referenced despatch advice. Example: 2\",\n \"referencedInvoiceDocId\": \"(string) Identifier of the invoice this line refers to. Example: INV-2021-77\",\n \"referencedInvoiceDocLineId\": \"(string) Line identifier within the referenced invoice. Example: 4\",\n \"referencedInvoiceDocTypeCode\": \"(string) Document type code of the referenced invoice. Example: 380\",\n \"referencedInvoiceDocIssueDate\": \"(string, date) Issue date of the referenced invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"referencedReceiptDocId\": \"(string) Identifier of the receiving advice this line refers to. Example: RCPT-331\",\n \"referencedReceiptDocLineId\": \"(string) Line identifier within the referenced receiving advice. Example: 1\",\n \"referencedSalesOrderDocId\": \"(string) Identifier of the sales order this line refers to. Example: SO-10099\",\n \"referencedSalesOrderDocLineId\": \"(string) Line identifier within the referenced sales order. Example: 7\",\n \"deliveryActualDeliveryDate\": \"(string, date) Actual delivery date for this line (YYYY-MM-DD). Example: 2023-11-05\",\n \"deliveryPartyName\": \"(string) Name of the party this line was delivered to. Example: Soluz.io afleveradres\",\n \"deliveryLocationIDs\": \"(string) Identifier of the delivery location for this line. Example: 5412345000013\",\n \"deliveryLocationAddress1\": \"(string) Delivery location street and number. Example: Berendries 52\",\n \"deliveryLocationAddress2\": \"(string) Delivery location address line 2. Example: Building A\",\n \"deliveryLocationAddress3\": \"(string) Delivery location address line 3. Example: Floor 2\",\n \"deliveryLocationCity\": \"(string) Delivery location city. Example: Lovendegem\",\n \"deliveryLocationZIP\": \"(string) Delivery location postal code. Example: 5400\",\n \"deliveryLocationCountrySubEntity\": \"(string) Delivery location province, state or region. Example: O-Vl\",\n \"deliveryLocationCountryCode\": \"(string) Delivery location country (ISO 3166-1 alpha-2). Example: BE\"\n }\n ],\n \"allowanceCharges\": [\n {\n \"reason\": \"(string) Textual reason for allowance/charge. Example: Early payment discount\",\n \"reasonCode\": \"(string) UNCL5189/UNCL7161 code. Example: 95\",\n \"amount\": \"(number) Amount excl. VAT. Example: 5.00\",\n \"chargeIndicator\": \"(boolean) true=Charge, false=Allowance. Example: false\",\n \"taxCode\": \"(string) VAT category code. Example: S\",\n \"taxPercentage\": \"(number) VAT rate for allowance/charge. Example: 21.00\"\n }\n ],\n \"vatSubTotals\": [\n {\n \"code\": \"(string) VAT category code. Example: S\",\n \"rate\": \"(number) VAT rate. Example: 21.00\",\n \"taxableAmount\": \"(number) Taxable amount. Example: 109.41\",\n \"taxAmount\": \"(number) VAT amount. Example: 22.98\",\n \"taxTypeIndicator\": \"(string) Additonal Tax Category for non-standard rate\",\n \"splitPaymentIndicator\": \"(string) Split payment indicator\"\n }\n ],\n \"paymentMeans\": [\n {\n \"code\": \"(string) The means, expressed as code, for how a payment is expected to be or has been settled (e.g. UN/CEFACT 4461). Example: ZZZ\",\n \"text\": \"(string) Description of payment means. Example: Bank transfer\",\n \"mandateId\": \"(string) Unique identifier assigned by the Payee for referencing the direct debit mandate. Example: MandateId\",\n \"mandateFinancialAccountId\": \"(string) The account to be debited by the direct debit. Example: MandateFinancialAccountId\",\n \"paymentId\": \"(string) Payment reference to be used by the payer. Example: PMT-2023-001\",\n \"payeeFinancialInstitutionId\": \"(string) Identifier of Payee's bank (BIC, etc.). Example: KREDBEBB\",\n \"payeeFinancialAccountId\": \"(string) Payee's bank account (IBAN, etc.). Example: BE49000023121121\",\n \"payeeFinancialAccountSchemeId\": \"(string) Scheme ID of Payee's bank account (e.g. IBAN). Example: IBAN\",\n \"payeeFinancialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\"\n }\n ],\n \"paymentTerms\": {\n \"text\": \"(string) A textual description of the payment terms that apply to the amount due for payment (including description of possible penalties). Example: Payment in 30 days\",\n \"settlementDiscountPercentage\": \"(number) Early payment discount percentage. Example: 2\",\n \"settlementDiscountAmount\": \"(number) Early payment discount absolute amount. Example: 50.00\"\n },\n \"parties\": [\n {\n \"partyName\": \"(string) Name of the party. Example: PANDAVA nv/sa\",\n \"roleCode\": \"(string) Code identifying the role this party has on the invoice. Example: SU\",\n \"endpointID\": \"(string) Electronic endpoint identifier of the party. Note the key is endpointID, not endpointId as used on customer and supplier. Example: 0208:be2929035935\",\n \"endpointIDType\": \"(string) Endpoint type or scheme which relates to the endpointID. Example: 0208\",\n \"identifiers\": [\n {\n \"id\": \"(string, required) Identifier value. Example: 5412345000013\",\n \"schemeId\": \"(string, required) Identifier scheme ID. Max 10 characters. Example: GLN\"\n }\n ],\n \"name\": \"(string) Name of the party. Example: PANDAVA nv/sa\",\n \"address1\": \"(string) Street and street number. Example: Zwartzustersvest 24\",\n \"address2\": \"(string) Address line 2. Example: Unit 5\",\n \"address3\": \"(string) Address line 3. Example: c/o Accounts\",\n \"city\": \"(string) City. Example: Mechelen\",\n \"zip\": \"(string) Postal code. Example: 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2 country code. Example: BE\",\n \"countryName\": \"(string) Country name. Example: Belgium\",\n \"countrySubEntity\": \"(string) Province, state or region. Example: Antwerpen\",\n \"vatNumber\": \"(string) VAT number of the party. Example: BE0123456749\",\n \"contactID\": \"(string) Identifier of the contact. Example: CT-001\",\n \"contactName\": \"(string) Contact person. Example: Jan Peeters\",\n \"contactEmail\": \"(string) Contact email. Example: jan@soluz.io\",\n \"contactPhone\": \"(string) Contact phone. Example: +3215999888\",\n \"partyLERegistrationName\": \"(string) Registered legal entity name of the party. Example: PANDAVA nv/sa\",\n \"partyLECompanyID\": \"(string) Legal entity company identifier. Example: 0999001396\",\n \"partyLECompanyIDType\": \"(string) Scheme of the legal entity company identifier. Example: 0208\",\n \"partyLECompanyLegalForm\": \"(string) Legal form of the legal entity. Example: nv/sa\",\n \"recipientType\": \"(string) Flag to indicate Subordinate Local Government Unit or GV member\"\n }\n ],\n \"files\": [\n {\n \"id\": \"(integer) File ID. Example: 53973545\",\n \"name\": \"(string) File name. Example: examplefilename.xml\",\n \"size\": \"(string) File size. Example: 13.98 KB\",\n \"pages\": \"(number) Page count. Example: 0\",\n \"package\": \"(string) File type (XML, PDF, UBL, etc.). Example: XML\"\n }\n ]\n}\n\nAn Outbound invoice, used for fetch of an outbound invoice
\n{\n \"type\": \"object\",\n \"description\": \"Invoice totals\",\n \"additionalProperties\": false,\n \"properties\": {\n \"amountExclVat\": {\n \"type\": \"number\",\n \"description\": \"The total amount of the Invoice without VAT.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"amountInclVat\": {\n \"type\": \"number\",\n \"description\": \"The total amount of the Invoice with VAT. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"lineExtensionAmount\": {\n \"type\": \"number\",\n \"description\": \"Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals.\\nIf not supplied this is calculated as the sum of the LineExtensionAmount on the detail lines\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"payableAmount\": {\n \"type\": \"number\",\n \"description\": \"The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals.\\nIf not filled in the TaxInclusiveAmount will be used\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"payableRoundingAmount\": {\n \"type\": \"number\",\n \"description\": \"The amount to be added to the invoice total to round the amount to be paid. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"prepaidAmount\": {\n \"type\": \"number\",\n \"description\": \"The sum of amounts which have been paid in advance. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"vatAmount\": {\n \"type\": \"number\",\n \"description\": \"The total VAT amount for the Invoice or the VAT total amount expressed in the accounting currency accepted or required in the country of the Seller. Must be rounded to maximum 2 decimals \",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"chargeAmount\": {\n \"type\": \"number\",\n \"description\": \"The sum of all charges on document level in the Invoice. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"allowanceAmount\": {\n \"type\": \"number\",\n \"description\": \"The sum of all allowances on document level in the Invoice. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\",\n \"nullable\": true\n }\n }\n}\n\nInvoice totals
\n{\n \"type\": \"object\",\n \"description\": \"Response model containing customer information as returned by the API.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Internal customer ID in sender's system\",\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"nullable\": true\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"nullable\": true\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"nullable\": true\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"nullable\": true\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"nullable\": true\n }\n }\n },\n \"contact\": {\n \"type\": \"object\",\n \"description\": \"Business contact\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Id of the business contact\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the business contact\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the business contact\",\n \"maxLength\": 300,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Phone number of the contact\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"companyNumber\": {\n \"type\": \"string\",\n \"description\": \"Company number of the customer. CompanyNumber or VAT Number required for companies\",\n \"nullable\": true\n },\n \"department\": {\n \"type\": \"string\",\n \"description\": \"Department of the customer\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the customer\",\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"VAT number of the customer. CompanyNumber or VAT Number required for companies\",\n \"nullable\": true\n },\n \"glnNumber\": {\n \"type\": \"string\",\n \"description\": \"Glnnumber of the customer\",\n \"nullable\": true\n },\n \"endpointId\": {\n \"type\": \"string\",\n \"description\": \"EndpointId of the customer\",\n \"nullable\": true\n },\n \"endpointType\": {\n \"type\": \"string\",\n \"description\": \"EndpointType of the customer\",\n \"nullable\": true\n },\n \"identifications\": {\n \"type\": \"array\",\n \"description\": \"Additional identifiers for the party.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n }\n }\n }\n}\n\nResponse model containing customer information as returned by the API.
\n{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"nullable\": true\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"nullable\": true\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"nullable\": true\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"nullable\": true\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"nullable\": true\n }\n }\n}\n\n{\n \"type\": \"object\",\n \"description\": \"Business contact\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Id of the business contact\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the business contact\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the business contact\",\n \"maxLength\": 300,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Phone number of the contact\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nBusiness contact
\n{\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n}\n\nRepresents an identifier with a value and a scheme.
\n{\n \"type\": \"object\",\n \"description\": \"Supplier info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Internal supplier ID in receiver's system\",\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"nullable\": true\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"nullable\": true\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"nullable\": true\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"nullable\": true\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"nullable\": true\n }\n }\n },\n \"contact\": {\n \"type\": \"object\",\n \"description\": \"Business contact\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Id of the business contact\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the business contact\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the business contact\",\n \"maxLength\": 300,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Phone number of the contact\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"companyNumber\": {\n \"type\": \"string\",\n \"description\": \"Company number of the supplier. CompanyNumber or VAT Number required for companies\",\n \"nullable\": true\n },\n \"department\": {\n \"type\": \"string\",\n \"description\": \"Department of the supplier\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the supplier\",\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"VAT number of the supplier. CompanyNumber or VAT Number required for companies\",\n \"nullable\": true\n },\n \"glnNumber\": {\n \"type\": \"string\",\n \"description\": \"Glnnumber of the Supplier\",\n \"nullable\": true\n },\n \"endpointId\": {\n \"type\": \"string\",\n \"description\": \"EndpointId of the supplier\",\n \"nullable\": true\n },\n \"endpointType\": {\n \"type\": \"string\",\n \"description\": \"EndpointType of the supplier\",\n \"nullable\": true\n },\n \"taxpayersPrefix\": {\n \"type\": \"string\",\n \"description\": \"VAT UE country prefix (e.g. \\\"PL\\\") for intra-Community supplies, cross-border services, and triangular transactions.\",\n \"nullable\": true\n },\n \"identifications\": {\n \"type\": \"array\",\n \"description\": \"Additional identifiers for the party.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n }\n }\n }\n}\n\nSupplier info
\n{\n \"type\": \"object\",\n \"description\": \"References\",\n \"additionalProperties\": false,\n \"properties\": {\n \"accountingCost\": {\n \"type\": \"string\",\n \"description\": \"Buyer accounting reference\\nA textual value that specifies where to book the relevant data into the Buyer's financial accounts.\\nExample value: 4217:2323:2323\",\n \"nullable\": true\n },\n \"billingReferences\": {\n \"type\": \"array\",\n \"description\": \"A group of business terms providing information on the preceding Invoice.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"invoiceDocumentReference\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"invoiceDocumentReferenceIssueDate\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"reasonForCorrection\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"documentTypeCode\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"externalReference\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"typeOfCorrection\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n }\n },\n \"buyerReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier assigned by the Buyer used for internal routing purposes. An invoice must have buyer reference or purchase order reference (BT-13).\",\n \"nullable\": true\n },\n \"contractDocReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of a contract as specified by the sender\",\n \"nullable\": true\n },\n \"contractDocIssueDate\": {\n \"type\": \"string\",\n \"description\": \"Date of the contract as specified by the sender\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"contractDocReferenceCustomer\": {\n \"type\": \"string\",\n \"description\": \"The identification of a contract as specified by the receiver\",\n \"nullable\": true\n },\n \"contractDocIssueDateCustomer\": {\n \"type\": \"string\",\n \"description\": \"Date of the contract as specified by the receiver\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"despatchDocReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced despatch advice.\",\n \"nullable\": true\n },\n \"invoiceDocumentReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of an Invoice that was previously sent by the Seller.\",\n \"nullable\": true\n },\n \"invoiceDocumentReferenceIssueDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Preceding Invoice was issued.Shall be provided in case the Preceding Invoice identifier is not unique. Format = \\\"YYYY-MM-DD\\\".\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"originatorDocReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of the call for tender or lot the invoice relates to.\",\n \"nullable\": true\n },\n \"projectReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of the project the invoice refers to.\",\n \"nullable\": true\n },\n \"purchaseOrderReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced purchase order, issued by the Buyer.An invoice must have buyer reference (BT-10) or purchase order reference.\",\n \"nullable\": true\n },\n \"receiptDocReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced receiving advice.\",\n \"nullable\": true\n },\n \"salesOrderIssueDate\": {\n \"type\": \"string\",\n \"description\": \"Spain only: add Issuer transaction date (recommended, not mandatory)\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"salesOrderReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced sales order, issued by the Seller.\",\n \"nullable\": true\n }\n }\n}\n\nReferences
\n{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"invoiceDocumentReference\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"invoiceDocumentReferenceIssueDate\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"reasonForCorrection\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"documentTypeCode\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"externalReference\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"typeOfCorrection\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\n{\n \"type\": \"object\",\n \"description\": \"Class that holds an invoice detail line\",\n \"additionalProperties\": false,\n \"properties\": {\n \"additionalItemProperties\": {\n \"type\": \"object\",\n \"description\": \"A group of business terms providing information about properties of the goods and services invoiced.\",\n \"nullable\": true,\n \"additionalProperties\": {\n \"type\": \"string\"\n }\n },\n \"articleName\": {\n \"type\": \"string\",\n \"description\": \"A name for an item.\",\n \"nullable\": true\n },\n \"articleDescription\": {\n \"type\": \"string\",\n \"description\": \"A description for an item.The item description allows for describing the item and its features in more detail than the Item name.\",\n \"nullable\": true\n },\n \"articleNumberBuyer\": {\n \"type\": \"string\",\n \"description\": \"An identifier, assigned by the Buyer, for the item.\",\n \"nullable\": true\n },\n \"articleNumberSupplier\": {\n \"type\": \"string\",\n \"description\": \"An identifier, assigned by the Seller, for the item.\",\n \"nullable\": true\n },\n \"lineExtensionAmount\": {\n \"type\": \"number\",\n \"description\": \"The total amount of the Invoice line. The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes.\\nMust be rounded to maximum 2 decimals.\\nIf not supplied, the AmountExclVat will be used\",\n \"format\": \"decimal\"\n },\n \"commodityClassificationCodes\": {\n \"type\": \"object\",\n \"description\": \"A code for classifying the item by its type or nature.\",\n \"nullable\": true,\n \"additionalProperties\": {\n \"type\": \"string\"\n }\n },\n \"deliveryDate\": {\n \"type\": \"string\",\n \"description\": \"Delivery date\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"deliveryNoteReference\": {\n \"type\": \"string\",\n \"description\": \"Delivery note reference\",\n \"nullable\": true\n },\n \"docRefDocType\": {\n \"type\": \"string\",\n \"description\": \"Code \\\"130\\\" MUST be used to indicate an invoice object reference. Not used for other additional documents\",\n \"nullable\": true\n },\n \"docRefId\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n },\n \"note\": {\n \"type\": \"string\",\n \"description\": \"A textual note that gives unstructured information that is relevant to the Invoice line.\",\n \"nullable\": true\n },\n \"originCountryCode\": {\n \"type\": \"string\",\n \"description\": \"The code identifying the country from which the item originates.\",\n \"nullable\": true\n },\n \"id\": {\n \"type\": \"string\",\n \"description\": \"A unique identifier for the individual line within the Invoice.\",\n \"nullable\": true\n },\n \"accountingCost\": {\n \"type\": \"string\",\n \"description\": \"A textual value that specifies where to book the relevant data into the Buyer's financial accounts.\",\n \"nullable\": true\n },\n \"startDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Invoice period for this Invoice line starts. Format =\\\"YYYY-MM-DD\\\"\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"endDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Invoice period for this Invoice line ends. Format =\\\"YYYY-MM-DD\\\"\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"vatCode\": {\n \"type\": \"string\",\n \"description\": \"The VAT category code for the invoiced item.\",\n \"nullable\": true\n },\n \"vatRate\": {\n \"type\": \"number\",\n \"description\": \"The VAT rate, represented as percentage that applies to the invoiced item.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"orderLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for a referenced line within a purchase order, issued by the Buyer.\",\n \"nullable\": true\n },\n \"quantity\": {\n \"type\": \"number\",\n \"description\": \"The quantity of items (goods or services) that is charged in the Invoice line.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"standardItemIdentification\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n },\n \"price\": {\n \"type\": \"object\",\n \"description\": \"A group of items related to the price of an invoiced item\",\n \"additionalProperties\": false,\n \"required\": [\n \"articlePrice\"\n ],\n \"properties\": {\n \"articlePrice\": {\n \"type\": \"number\",\n \"description\": \"The price of an item, exclusive of VAT, after subtracting item price discount.\\nThe Item net price has to be equal with the Item gross price less the Item price discount, if they are both provided.\\nItem price can not be negative.\",\n \"format\": \"decimal\"\n },\n \"baseQuantity\": {\n \"type\": \"number\",\n \"description\": \"The number of item units to which the price applies.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"unitOfMeasure\": {\n \"type\": \"string\",\n \"description\": \"The unit of measure that applies to the invoiced quantity.\\nCodes for unit of packaging from UNECE Recommendation No.\\n21 can be used in accordance with the descriptions in the \\\"Intro\\\" section of UN/ECE Recommendation 20, Revision 11 (2015):\\nThe 2 character alphanumeric code values in UNECE Recommendation 21 shall be used.\\nTo avoid duplication with existing code values in UNECE Recommendation No.\\n20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"allowanceAmount\": {\n \"type\": \"number\",\n \"description\": \"The total discount subtracted from the Item gross price to calculate the Item net price.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"allowanceBaseAmount\": {\n \"type\": \"number\",\n \"description\": \"The unit price, exclusive of VAT, before subtracting Item price discount, can not be negative\",\n \"format\": \"decimal\",\n \"nullable\": true\n }\n }\n },\n \"allowanceCharge\": {\n \"type\": \"object\",\n \"description\": \"A group of items related to an allowance or charge of an invoiced item\",\n \"additionalProperties\": false,\n \"properties\": {\n \"amount\": {\n \"type\": \"number\",\n \"description\": \"The amount of an allowance or a charge, without VAT. Must be rounded to maximum 2 decimals\",\n \"format\": \"decimal\"\n },\n \"baseAmount\": {\n \"type\": \"number\",\n \"description\": \"The base amount that may be used, in conjunction with the line level allowance or charge percentage, to calculate the line level allowance or charge amount.\\nMust be rounded to maximum 2 decimals\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"chargeIndicator\": {\n \"type\": \"boolean\",\n \"description\": \"Use “true” when informing about Charges and “false” when informing about Allowances\"\n },\n \"percentage\": {\n \"type\": \"number\",\n \"description\": \"The percentage that may be used, in conjunction with the line level allowance base amount, to calculate the line level allowance or charge amount.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"reason\": {\n \"type\": \"string\",\n \"description\": \"The reason for the line level allowance or charge, expressed as text.\",\n \"nullable\": true\n },\n \"reasonCode\": {\n \"type\": \"string\",\n \"description\": \"The reason for the line level allowance or charge, expressed as a code.\",\n \"nullable\": true\n }\n }\n },\n \"vatExemptionReason\": {\n \"type\": \"string\",\n \"description\": \"The VatExemptionReason\",\n \"nullable\": true\n },\n \"vatExemptionReasonCode\": {\n \"type\": \"string\",\n \"description\": \"The VatExemptionReasonCode\",\n \"nullable\": true\n },\n \"uuLineNumber\": {\n \"type\": \"string\",\n \"description\": \"Universal unique line number\\nShould be unique not only per invoice but per taxpayer or invoicing system\",\n \"nullable\": true\n },\n \"lineGTU\": {\n \"type\": \"string\",\n \"description\": \"Designation for the delivery of goods and the provision of services\",\n \"nullable\": true\n },\n \"lineDueDateTypeCode\": {\n \"type\": \"string\",\n \"description\": \"Code specifying the type of due date that applies to this Invoice line.\",\n \"nullable\": true\n },\n \"referencedDespatchDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the despatch advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedDespatchDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced despatch advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the invoice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced invoice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocTypeCode\": {\n \"type\": \"string\",\n \"description\": \"The document type code of the referenced invoice.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocIssueDate\": {\n \"type\": \"string\",\n \"description\": \"The issue date of the referenced invoice. Format = \\\"YYYY-MM-DD\\\"\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"referencedReceiptDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the receiving advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedReceiptDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced receiving advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedSalesOrderDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the sales order that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedSalesOrderDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced sales order that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"deliveryActualDeliveryDate\": {\n \"type\": \"string\",\n \"description\": \"The date on which the goods or services on this Invoice line were actually delivered. Format = \\\"YYYY-MM-DD\\\"\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"deliveryPartyName\": {\n \"type\": \"string\",\n \"description\": \"The name of the party that the goods or services on this Invoice line were delivered to.\",\n \"nullable\": true\n },\n \"deliveryLocationIDs\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationAddress1\": {\n \"type\": \"string\",\n \"description\": \"Street and street number of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationAddress2\": {\n \"type\": \"string\",\n \"description\": \"Additional address line of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationAddress3\": {\n \"type\": \"string\",\n \"description\": \"Additional address line of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationCity\": {\n \"type\": \"string\",\n \"description\": \"City of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationZIP\": {\n \"type\": \"string\",\n \"description\": \"Postal code of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationCountrySubEntity\": {\n \"type\": \"string\",\n \"description\": \"Province, state or region of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationCountryCode\": {\n \"type\": \"string\",\n \"description\": \"The country of the delivery location of this Invoice line, as an ISO 3166-1 alpha-2 code.\",\n \"nullable\": true\n }\n }\n}\n\nClass that holds an invoice detail line
\n{\n \"type\": \"object\",\n \"description\": \"A group of items related to the price of an invoiced item\",\n \"additionalProperties\": false,\n \"required\": [\n \"articlePrice\"\n ],\n \"properties\": {\n \"articlePrice\": {\n \"type\": \"number\",\n \"description\": \"The price of an item, exclusive of VAT, after subtracting item price discount.\\nThe Item net price has to be equal with the Item gross price less the Item price discount, if they are both provided.\\nItem price can not be negative.\",\n \"format\": \"decimal\"\n },\n \"baseQuantity\": {\n \"type\": \"number\",\n \"description\": \"The number of item units to which the price applies.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"unitOfMeasure\": {\n \"type\": \"string\",\n \"description\": \"The unit of measure that applies to the invoiced quantity.\\nCodes for unit of packaging from UNECE Recommendation No.\\n21 can be used in accordance with the descriptions in the \\\"Intro\\\" section of UN/ECE Recommendation 20, Revision 11 (2015):\\nThe 2 character alphanumeric code values in UNECE Recommendation 21 shall be used.\\nTo avoid duplication with existing code values in UNECE Recommendation No.\\n20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"allowanceAmount\": {\n \"type\": \"number\",\n \"description\": \"The total discount subtracted from the Item gross price to calculate the Item net price.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"allowanceBaseAmount\": {\n \"type\": \"number\",\n \"description\": \"The unit price, exclusive of VAT, before subtracting Item price discount, can not be negative\",\n \"format\": \"decimal\",\n \"nullable\": true\n }\n }\n}\n\nA group of items related to the price of an invoiced item
\n{\n \"type\": \"object\",\n \"description\": \"A group of items related to an allowance or charge of an invoiced item\",\n \"additionalProperties\": false,\n \"properties\": {\n \"amount\": {\n \"type\": \"number\",\n \"description\": \"The amount of an allowance or a charge, without VAT. Must be rounded to maximum 2 decimals\",\n \"format\": \"decimal\"\n },\n \"baseAmount\": {\n \"type\": \"number\",\n \"description\": \"The base amount that may be used, in conjunction with the line level allowance or charge percentage, to calculate the line level allowance or charge amount.\\nMust be rounded to maximum 2 decimals\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"chargeIndicator\": {\n \"type\": \"boolean\",\n \"description\": \"Use “true” when informing about Charges and “false” when informing about Allowances\"\n },\n \"percentage\": {\n \"type\": \"number\",\n \"description\": \"The percentage that may be used, in conjunction with the line level allowance base amount, to calculate the line level allowance or charge amount.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"reason\": {\n \"type\": \"string\",\n \"description\": \"The reason for the line level allowance or charge, expressed as text.\",\n \"nullable\": true\n },\n \"reasonCode\": {\n \"type\": \"string\",\n \"description\": \"The reason for the line level allowance or charge, expressed as a code.\",\n \"nullable\": true\n }\n }\n}\n\nA group of items related to an allowance or charge of an invoiced item
\n{\n \"type\": \"object\",\n \"description\": \"A group of business terms providing information about allowances applicable to the Invoice as a whole.\\nA group of business terms providing information about charges and taxes other than VAT, applicable to the Invoice as a whole.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"reason\": {\n \"type\": \"string\",\n \"description\": \"The reason for the document level allowance or charge, expressed as text.\\nThe Document level allowance reason code and the Document level allowance reason shall indicate the same allowance reason\",\n \"nullable\": true\n },\n \"reasonCode\": {\n \"type\": \"string\",\n \"description\": \"The reason for the document level allowance or charge, expressed as a code.\\nFor allowances a subset of codelist UNCL5189 is to be used, and for charges codelist UNCL7161 applies.\\nThe Document level allowance reason code and the Document level allowance reason shall indicate the same allowance reason\",\n \"nullable\": true\n },\n \"amount\": {\n \"type\": \"number\",\n \"description\": \"The amount of an allowance or a charge, without VAT. Must be rounded to maximum 2 decimals\",\n \"format\": \"decimal\"\n },\n \"chargeIndicator\": {\n \"type\": \"boolean\",\n \"description\": \"Use “true” when informing about Charges and “false” when informing about Allowances.\"\n },\n \"taxCode\": {\n \"type\": \"string\",\n \"description\": \"A coded identification of what VAT category applies to the document level allowance or charge.\",\n \"nullable\": true\n },\n \"taxPercentage\": {\n \"type\": \"number\",\n \"description\": \"The VAT rate, represented as percentage that applies to the document level allowance or charge.\",\n \"format\": \"decimal\"\n },\n \"taxExemptionReason\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"taxExemptionReasonCode\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n}\n\nA group of business terms providing information about allowances applicable to the Invoice as a whole.\nA group of business terms providing information about charges and taxes other than VAT, applicable to the Invoice as a whole.
\n{\n \"type\": \"object\",\n \"description\": \"VAT Sub totals\",\n \"additionalProperties\": false,\n \"properties\": {\n \"code\": {\n \"type\": \"string\",\n \"description\": \"Coded identification of a VAT category.\",\n \"nullable\": true\n },\n \"rate\": {\n \"type\": \"number\",\n \"description\": \"The VAT rate, represented as percentage that applies for the relevant VAT category.\",\n \"format\": \"decimal\"\n },\n \"exemptionReasonCode\": {\n \"type\": \"string\",\n \"description\": \"A coded statement of the reason for why the amount is exempted from VAT.\",\n \"nullable\": true\n },\n \"exemptionReason\": {\n \"type\": \"string\",\n \"description\": \"A textual statement of the reason why the amount is exempted from VAT or why no VAT is being charged.\",\n \"nullable\": true\n },\n \"taxableAmount\": {\n \"type\": \"number\",\n \"description\": \"Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable).\\nMust be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\"\n },\n \"taxAmount\": {\n \"type\": \"number\",\n \"description\": \"The total VAT amount for a given VAT category. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\"\n },\n \"taxTypeIndicator\": {\n \"type\": \"string\",\n \"description\": \"Tax category for non-standard VAT rates\",\n \"nullable\": true\n },\n \"splitPaymentIndicator\": {\n \"type\": \"string\",\n \"description\": \"Split payment indicator (\\\"mechanizm podzielonej płatności\\\").\\nRequired when invoice total exceeds PLN 15,000 and covers Annex 15 goods/services.\",\n \"nullable\": true\n }\n }\n}\n\nVAT Sub totals
\n{\n \"type\": \"object\",\n \"description\": \"PaymentMeans info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"mandateId\": {\n \"type\": \"string\",\n \"description\": \"Unique identifier assigned by the Payee for referencing the direct debit mandate.\\nUsed in order to pre-notify the Buyer of a SEPA direct debit.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"mandateFinancialAccountId\": {\n \"type\": \"string\",\n \"description\": \"The account to be debited by the direct debit.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"code\": {\n \"type\": \"string\",\n \"description\": \"The means, expressed as code, for how a payment is expected to be or has been settled.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"text\": {\n \"type\": \"string\",\n \"description\": \"The means, expressed as text, for how a payment is expected to be or has been settled.\\nExample value: Credit transfer\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"paymentId\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"payeeFinancialInstitutionId\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"payeeFinancialAccountId\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"payeeFinancialAccountSchemeId\": {\n \"type\": \"string\",\n \"maxLength\": 20,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"payeeFinancialAccountName\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"cardId\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"cardHolderName\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nPaymentMeans info
\n{\n \"type\": \"object\",\n \"description\": \"An additional party involved in the invoice, beyond the Customer, Supplier, Buyer,\\nPayee and TaxRepresentative that have their own dedicated groups. The role the party\\ntakes on the invoice is given by RoleCode.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"partyName\": {\n \"type\": \"string\",\n \"description\": \"The name of the party.\",\n \"nullable\": true\n },\n \"roleCode\": {\n \"type\": \"string\",\n \"description\": \"A code identifying the role that this party takes on the invoice.\",\n \"nullable\": true\n },\n \"endpointID\": {\n \"type\": \"string\",\n \"description\": \"The electronic endpoint identifier of the party.\",\n \"nullable\": true\n },\n \"endpointIDType\": {\n \"type\": \"string\",\n \"description\": \"The endpoint type or scheme which relates to the EndpointID.\",\n \"nullable\": true\n },\n \"identifiers\": {\n \"type\": \"array\",\n \"description\": \"Additional identifiers for the party. Both members of each identifier are mandatory.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n }\n },\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Street and street number of the party.\",\n \"nullable\": true\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Additional address line of the party.\",\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Additional address line of the party.\",\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City of the party.\",\n \"nullable\": true\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"Postal code of the party.\",\n \"nullable\": true\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"The country of the party, as an ISO 3166-1 alpha-2 code.\",\n \"nullable\": true\n },\n \"countryName\": {\n \"type\": \"string\",\n \"description\": \"The country name of the party.\",\n \"nullable\": true\n },\n \"countrySubEntity\": {\n \"type\": \"string\",\n \"description\": \"Province, state or region of the party.\",\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"The VAT number of the party.\",\n \"nullable\": true\n },\n \"contactID\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the contact of the party.\",\n \"nullable\": true\n },\n \"contactName\": {\n \"type\": \"string\",\n \"description\": \"The contact person of the party.\",\n \"nullable\": true\n },\n \"contactEmail\": {\n \"type\": \"string\",\n \"description\": \"The contact email address of the party.\",\n \"nullable\": true\n },\n \"contactPhone\": {\n \"type\": \"string\",\n \"description\": \"The contact phone number of the party.\",\n \"nullable\": true\n },\n \"partyLERegistrationName\": {\n \"type\": \"string\",\n \"description\": \"The registered legal entity name of the party.\",\n \"nullable\": true\n },\n \"partyLECompanyID\": {\n \"type\": \"string\",\n \"description\": \"The legal entity company identifier of the party (e.g. Belgium CBE/KBO).\",\n \"nullable\": true\n },\n \"partyLECompanyIDType\": {\n \"type\": \"string\",\n \"description\": \"The scheme of the legal entity company identifier, using the ICD code list.\",\n \"nullable\": true\n },\n \"partyLECompanyLegalForm\": {\n \"type\": \"string\",\n \"description\": \"The legal form of the legal entity.\",\n \"nullable\": true\n },\n \"recipientType\": {\n \"type\": \"string\",\n \"description\": \"Flag to indicate Subordinate Local Government Unit or GV member.\",\n \"nullable\": true\n }\n }\n}\n\nAn additional party involved in the invoice, beyond the Customer, Supplier, Buyer,\nPayee and TaxRepresentative that have their own dedicated groups. The role the party\ntakes on the invoice is given by RoleCode.
\n{\n \"type\": \"object\",\n \"description\": \"PaymentTerms info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"text\": {\n \"type\": \"string\",\n \"description\": \"A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties).\\nIn case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.\",\n \"maxLength\": 1000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"settlementDiscountAmount\": {\n \"type\": \"number\",\n \"description\": \"The SettlementDiscountAmount. Optional\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"settlementDiscountPercentage\": {\n \"type\": \"number\",\n \"description\": \"The SettlementDiscountPercentage . Optional\",\n \"format\": \"decimal\",\n \"nullable\": true\n }\n }\n}\n\nPaymentTerms info
\n{\n \"type\": \"object\",\n \"description\": \"Buyer info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Full legal name of the buyer\",\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"nullable\": true\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"nullable\": true\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"nullable\": true\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"nullable\": true\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"nullable\": true\n }\n }\n },\n \"glnNumber\": {\n \"type\": \"string\",\n \"description\": \"Global Location Number of the buyer\",\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"VAT number of the buyer\",\n \"nullable\": true\n },\n \"contact\": {\n \"type\": \"object\",\n \"description\": \"Business contact\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Id of the business contact\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the business contact\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the business contact\",\n \"maxLength\": 300,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Phone number of the contact\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"recipientType\": {\n \"type\": \"string\",\n \"description\": \"Type of the buyer\\nPossible values:\\n12: JST Recipient\\n21: GV Recipient\",\n \"nullable\": true\n }\n }\n}\n\nBuyer info
\n{\n \"type\": \"object\",\n \"description\": \"Represents an exchange rate used for tax calculations between different currencies.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"sourceCurrencyCode\": {\n \"type\": \"string\",\n \"description\": \"ISO currency code representing the source currency for the transaction.\",\n \"nullable\": true\n },\n \"targetCurrencyCode\": {\n \"type\": \"string\",\n \"description\": \"ISO currency code representing the target currency for conversion or display.\",\n \"nullable\": true\n },\n \"calculationRate\": {\n \"type\": \"number\",\n \"description\": \"Exchange rate.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"mathematicOperatorCode\": {\n \"type\": \"string\",\n \"description\": \"Mathematical operator used in calculations. Default is \\\"Multiply\\\".\",\n \"nullable\": true\n },\n \"date\": {\n \"type\": \"string\",\n \"description\": \"Date for the calculation rate.\",\n \"format\": \"date-time\",\n \"nullable\": true\n }\n }\n}\n\nRepresents an exchange rate used for tax calculations between different currencies.
\n{\n \"type\": \"object\",\n \"description\": \"Represents a note response containing a subject code and note text.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"subjectcode\": {\n \"type\": \"string\",\n \"description\": \"Subject code for the note.\",\n \"maxLength\": 3,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"note\": {\n \"type\": \"string\",\n \"description\": \"Note text.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nRepresents a note response containing a subject code and note text.
\n{\n \"type\": \"object\",\n \"description\": \"Info about a file within a document\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n },\n \"name\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"size\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"pages\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n },\n \"package\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n}\n\nInfo about a file within a document
\n{\n \"page\": \"(number) Current page number. Example: 1\",\n \"totalPages\": \"(number) Total number of pages available. Example: 5\",\n \"entries\": [\n {\n \"code\": \"(string) Code associated with the audit entry. Example: SENT\",\n \"text\": \"(string) Description of the audit entry. Example: Invoice successfully sent via PEPPOL\",\n \"timestamp\": \"(string, date) Timestamp of the audit entry (YYYY-MM-DDTHH:mm:ssZ). Example: 2023-11-07T10:15:30Z\",\n \"transactionId\": \"(string) Transaction identifier. Example: 2AF410E4DEF234DB89918E6EEC7DF825\",\n \"objectId\": \"(number) Object ID related to the audit entry. Example: 4728\",\n \"externalReference\": \"(string) External reference for the audit entry. Example: EXT-2023-091\"\n }\n ]\n}\n\nRepresents a paged response containing audit entries.
\n{\n \"type\": \"object\",\n \"description\": \" Represents the response for an audit entry. \\n \",\n \"additionalProperties\": false,\n \"properties\": {\n \"code\": {\n \"type\": \"string\",\n \"description\": \" The code associated with the audit entry. \\n \",\n \"nullable\": true\n },\n \"text\": {\n \"type\": \"string\",\n \"description\": \" The text description of the audit entry. \\n \",\n \"nullable\": true\n },\n \"timestamp\": {\n \"type\": \"string\",\n \"description\": \" The timestamp of the audit entry. \\n \",\n \"nullable\": true\n },\n \"transactionId\": {\n \"type\": \"string\",\n \"description\": \" The transaction ID associated with the audit entry. \\n \",\n \"nullable\": true\n },\n \"objectId\": {\n \"type\": \"integer\",\n \"description\": \" The object ID related to the audit entry. \\n \",\n \"format\": \"int32\",\n \"nullable\": true\n },\n \"externalReference\": {\n \"type\": \"string\",\n \"description\": \" The external reference for the audit entry. \\n \",\n \"nullable\": true\n }\n }\n}\n\n Represents the response for an audit entry. \n \n{\n \"type\": \"object\",\n \"description\": \"Represents a paginated response containing feedback entries.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"page\": {\n \"type\": \"integer\",\n \"description\": \" The current page number. \\n \",\n \"format\": \"int32\"\n },\n \"totalPages\": {\n \"type\": \"integer\",\n \"description\": \" The total number of pages. \\n \",\n \"format\": \"int32\"\n },\n \"entries\": {\n \"type\": \"array\",\n \"description\": \"The collection of feedback entries.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \" Represents the response for a feedback entry. \\n \",\n \"additionalProperties\": false,\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"description\": \" The type of the feedback. \\n \",\n \"nullable\": true\n },\n \"code\": {\n \"type\": \"string\",\n \"description\": \" The code associated with the feedback. \\n \",\n \"nullable\": true\n },\n \"text\": {\n \"type\": \"string\",\n \"description\": \" The text of the feedback. \\n \",\n \"nullable\": true\n },\n \"timestamp\": {\n \"type\": \"string\",\n \"description\": \" The timestamp of the feedback. \\n \",\n \"nullable\": true\n },\n \"transactionId\": {\n \"type\": \"string\",\n \"description\": \" The transaction ID associated with the feedback. \\n \",\n \"nullable\": true\n },\n \"objectId\": {\n \"type\": \"integer\",\n \"description\": \" The object ID related to the feedback, if applicable. \\n \",\n \"format\": \"int32\",\n \"nullable\": true\n },\n \"externalReference\": {\n \"type\": \"string\",\n \"description\": \" The external reference for the feedback. \\n \",\n \"nullable\": true\n },\n \"fileId\": {\n \"type\": \"integer\",\n \"description\": \" The file ID associated with the feedback, if applicable. \\n \",\n \"format\": \"int32\",\n \"nullable\": true\n },\n \"extraInfo\": {\n \"type\": \"string\",\n \"description\": \" Any additional information related to the feedback. \\n \",\n \"nullable\": true\n }\n }\n }\n }\n }\n}\n\nRepresents a paginated response containing feedback entries.
\n{\n \"type\": \"object\",\n \"description\": \" Represents the response for a feedback entry. \\n \",\n \"additionalProperties\": false,\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"description\": \" The type of the feedback. \\n \",\n \"nullable\": true\n },\n \"code\": {\n \"type\": \"string\",\n \"description\": \" The code associated with the feedback. \\n \",\n \"nullable\": true\n },\n \"text\": {\n \"type\": \"string\",\n \"description\": \" The text of the feedback. \\n \",\n \"nullable\": true\n },\n \"timestamp\": {\n \"type\": \"string\",\n \"description\": \" The timestamp of the feedback. \\n \",\n \"nullable\": true\n },\n \"transactionId\": {\n \"type\": \"string\",\n \"description\": \" The transaction ID associated with the feedback. \\n \",\n \"nullable\": true\n },\n \"objectId\": {\n \"type\": \"integer\",\n \"description\": \" The object ID related to the feedback, if applicable. \\n \",\n \"format\": \"int32\",\n \"nullable\": true\n },\n \"externalReference\": {\n \"type\": \"string\",\n \"description\": \" The external reference for the feedback. \\n \",\n \"nullable\": true\n },\n \"fileId\": {\n \"type\": \"integer\",\n \"description\": \" The file ID associated with the feedback, if applicable. \\n \",\n \"format\": \"int32\",\n \"nullable\": true\n },\n \"extraInfo\": {\n \"type\": \"string\",\n \"description\": \" Any additional information related to the feedback. \\n \",\n \"nullable\": true\n }\n }\n}\n\n Represents the response for a feedback entry. \n \n{\n \"invoices\": [\n {\n \"id\": \"(number) Internal ID of the Invoice. Used in GetInvoice to get the details of this invoice. Example: 53973544\",\n \"uniqueId\": \"(string) Unique identifier. Example: 0000130974010053973544\",\n \"invoiceNumber\": \"(string) Invoice number. Example: 23110000291\",\n \"currency\": \"(string) ISO 4217 currency code. Example: EUR\",\n \"type\": \"(string) Invoice type (INVOICE or CREDITNOTE). Example: INVOICE\",\n \"date\": \"(string, date) Issue date (YYYY-MM-DD). Example: 2023-11-07\",\n \"dueDate\": \"(string, date) Due date for payment (YYYY-MM-DD). Example: 2023-12-07\",\n \"totals\": {\n \"amountExclVat\": \"(number) Invoice total excl. VAT. Example: 109.41\",\n \"vatAmount\": \"(number) Invoice VAT amount. Example: 22.98\",\n \"amountInclVat\": \"(number) Invoice total incl. VAT. Example: 132.39\"\n },\n \"customer\": {\n \"name\": \"(string) Buyer name. Example: GEMEENTE STABROEK\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0207537834\"\n },\n \"supplier\": {\n \"name\": \"(string) Seller name. Example: PANDAVA nv/sa\",\n \"vatNumber\": \"(string) Seller VAT number. Example: BE0419001396\"\n }\n }\n ]\n}\n\nRepresents a paginated response containing a collection of invoices headers.
\n{\n \"invoicedate-from\": \"(string,date) The start date for the invoice date range. Example: 1951-09-07T18:14:00.209Z\",\n \"invoicedate-to\": \"(string,date) The end date for the invoice date range. Example: 2010-06-27T14:00:39.906Z\",\n \"invoiceNumber\": \"(string) The invoice number. Example: SOL-1200\",\n \"objectId\": \"(string) Object id of the document. Example: 4728\",\n \"uniqueId\": \"(string) Unique id of the document. Example: 1095953\",\n \"page\": {\n \"page-number\": \"(number) Page number. Example: 2\",\n \"records-per-page\": \"(number) Amount of records per page. Example: 25\"\n },\n \"status\": \"(string) Filter on status. Example: PENDING\"\n}\n\nRequest for Outbound invoices
\n{\n \"type\": \"object\",\n \"description\": \" Represents a request for paginated data. \\n \",\n \"additionalProperties\": false,\n \"required\": [\n \"page-number\",\n \"records-per-page\"\n ],\n \"properties\": {\n \"page-number\": {\n \"type\": \"integer\",\n \"description\": \" The page number for the request. \\n \",\n \"format\": \"int32\"\n },\n \"records-per-page\": {\n \"type\": \"integer\",\n \"description\": \" The number of records per page for the request. \\n \",\n \"format\": \"int32\"\n }\n }\n}\n\n Represents a request for paginated data. \n \n{\n \"transactionId\": \"(string) Filter on TransactionId. Example: 2AF410E4DEF234DB89918E6EEC7DF825\",\n \"page\": \"(number) The requested page (default = 1). Example: 1\",\n \"from\": \"(string, date, required) Start date of the audit period (YYYY-MM-DD). Example: 2023-11-01\",\n \"to\": \"(string, date) End date of the audit period (YYYY-MM-DD). Example: 2023-11-30\",\n \"objectId\": \"(number) ObjectId to search on. Example: 4728\",\n \"externalReference\": \"(string) External reference identifier. Example: EXT-2023-091\"\n}\n\nRequest for audit
\n{\n \"type\": \"object\",\n \"description\": \"Request for feedback\",\n \"additionalProperties\": false,\n \"required\": [\n \"from\"\n ],\n \"properties\": {\n \"transactionId\": {\n \"type\": \"string\",\n \"description\": \"Filter on TransactionId\",\n \"nullable\": true\n },\n \"page\": {\n \"type\": \"integer\",\n \"description\": \"The requested page (default = 1)\",\n \"format\": \"int32\",\n \"nullable\": true\n },\n \"from\": {\n \"type\": \"string\",\n \"description\": \"Start date of the audit requested\",\n \"format\": \"date-time\"\n },\n \"to\": {\n \"type\": \"string\",\n \"description\": \"End date of the audit requested\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"objectId\": {\n \"type\": \"integer\",\n \"description\": \"ObjectId to search on\",\n \"format\": \"int32\",\n \"nullable\": true\n },\n \"externalReference\": {\n \"type\": \"string\",\n \"description\": \"External reference\",\n \"nullable\": true\n }\n }\n}\n\nRequest for feedback
\n{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n }\n }\n}\n\n{\n \"type\": \"object\",\n \"additionalProperties\": false\n}\n\nNone
\n{\n \"details\": {\n \"documentNumber\": \"(string) Unique invoice number in sender's system. Example: DEMO/00092\",\n \"invoiceNumber\": \"(string) Invoice number as shown on the document. Example: 23110000291\",\n \"currency\": \"(string, required) ISO 4217 currency code. Example: EUR\",\n \"date\": \"(string, required) Invoice issue date (YYYY-MM-DD). Example: 2022-12-02\",\n \"dueDate\": \"(string) Due date for payment (YYYY-MM-DD). In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present. Example: 2023-12-07\",\n \"note\": \"(string) Free text note printed on the invoice. Example: Note van de factuur\",\n \"structuredCommunication\": \"(string) A textual value used to establish a link between the payment and the Invoice, issued by the Seller. Used for creditor's critical reconciliation information. This information element helps the Seller to assign an incoming payment to the relevant payment process. Example: +++123/569858/336+++\",\n \"type\": \"(string, required) Document type: Invoice, CreditNote. Example: Invoice\",\n \"typeCode\": \"(string) Document type code (e.g. 380=Invoice, 381=CreditNote). Example: 380\",\n \"serviceBeginDate\": \"(string, date) Service period start (YYYY-MM-DD). Example: 2022-12-01\",\n \"serviceEndDate\": \"(string, date) Service period end (YYYY-MM-DD). Example: 2022-12-31\",\n \"taxPointDate\": \"(string, date) Tax point date (YYYY-MM-DD). Example: 2022-12-22\",\n \"placeOfIssue\": \"(string) Place where the invoice was issued\",\n \"fullyPaid\": \"(boolean) Indicates if an invoice has been paid\",\n \"dateOfFullPayment\": \"(string) date of payment\",\n \"simplifiedTriangularProcedure\": \"(string) Indication if invoice is issued under simplified procedure by the second taxpayer\",\n \"checkoutMethod\": \"(boolean) Cash accounting indicator\",\n \"selfBillingIndicator\": \"(boolean) Self-billing indicator\",\n \"warehouseDocumentNumbers\": \"(string) WZ (delivery note) document numbers\",\n \"typeName\": \"(string) Invoice type name\",\n \"restrictedInformation\": \"(string) Indicator if Invoice referred to in Art. 109 sec. 3d of the Act\",\n \"invoicePeriodDescriptionCode\": \"(string) Coded description of the invoice period. Max 50 characters. Example: 3\",\n \"deliveryTermsId\": \"(string) Delivery terms identifier. Max 200 characters. Example: CIF\",\n \"deliveryTermsDeliveryLocationName\": \"(string) Name of the location the delivery terms apply to. Max 200 characters. Example: Port of Antwerp\",\n \"contractDocReferenceTypeCode\": \"(string) Document type code of the referenced contract. Max 100 characters. Example: 130\",\n \"references\": {\n \"accountingCost\": \"(string) Buyer accounting reference Cost center or internal accounting code. A textual value that specifies where to book the relevant data into the Buyer's financial accounts. Example: 4217:2323:2323\",\n \"billingReferences\": [\n {\n \"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n \"invoiceDocumentReferenceIssueDate\": \"(DateTime) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"reasonForCorrection\": \"(string) Reason for correction\",\n \"externalReference\": \"(string) Number identifying the corrected invoice in the National System of e-Invoices\",\n \"typeOfCorrection\": \"(string) Type of correction\"\n }\n ],\n \"buyerReference\": \"(string) Buyer reference or procurement ID. An invoice must have buyer reference or purchase order reference (BT-13) Example: ABC/984/B2\",\n \"purchaseOrderReference\": \"(string) Purchase order number. An invoice must have buyer reference (BT-10) or purchase order reference Example: OR1256\",\n \"contractDocReference\": \"(string) Contract identifier by seller. Example: CT-2022-001\",\n \"contractDocIssueDate\": \"(string, date) Contract date by seller (YYYY-MM-DD). Example: 2022-01-15\",\n \"contractDocReferenceCustomer\": \"(string) Contract identifier by customer. Example: CUST-CT-88\",\n \"contractDocIssueDateCustomer\": \"(string, date) Contract date by customer (YYYY-MM-DD). Example: 2022-01-20\",\n \"despatchDocReference\": \"(string) Dispatch advice ID. Example: DESP-993\",\n \"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n \"invoiceDocumentReferenceIssueDate\": \"(DateTime) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"originatorDocReference\": \"(string) Tender or lot reference. Example: TND-2022-01\",\n \"projectReference\": \"(string) Project reference. Example: PROJ-Delta-01\",\n \"receiptDocReference\": \"(string) Receiving advice ID. Example: RCPT-331\",\n \"salesOrderReference\": \"(string) Seller’s sales order ID. Example: SO-10099\",\n \"salesOrderIssueDate\": \"(string, date) Sales order date (YYYY-MM-DD). Example: 2022-05-18\"\n },\n \"customer\": {\n \"id\": \"(string) Internal customer ID in sender’s system. Example: CUST1\",\n \"name\": \"(string, required) Customer name. Example: Soluz.io\",\n \"address\": {\n \"address1\": \"(string, required) Street and number. Example: Zwartzustersvest 24\",\n \"address2\": \"(string) Address line 2. Example: Unit 5\",\n \"address3\": \"(string) Address line 3. Example: c/o Accounts\",\n \"city\": \"(string, required) City. Example: Mechelen\",\n \"zip\": \"(string, required) Postal code. Example: 2810\",\n \"countryCode\": \"(string, required) ISO 3166-1 alpha-2 country code. Example: BE\",\n \"province\": \"(string) State/Province/Region. Example: Antwerpen\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n \"department\": \"(string) Department or branch. Example: DevelopmentDepartment\",\n \"vatNumber\": \"(string) Customer VAT number. Example: BE0123456749\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"endpointId\": \"(string) Electronic endpoint identifier. Example: 0208:be2929035935\",\n \"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 0208\"\n },\n \"delivery\": {\n \"actualDeliveryDate\": \"(string, date) Delivery date (YYYY-MM-DD). Example: 2023-01-03\",\n \"address\": {\n \"address1\": \"(string)(required in case address is filled) Street and number. Example: Berendries 52\",\n \"address2\": \"(string) Example: Building A\",\n \"address3\": \"(string) Example: Floor 2\",\n \"city\": \"(string) City. Example: Lovendegem\",\n \"zip\": \"(string) Postal code. Example: 5400\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province/region. Example: O-Vl\"\n },\n \"name\": \"(string) Receiver name or delivery contact. Example: Soluz.io afleveradres\",\n \"locationIdentifier\": {\n \"id\": \"(string) Location identifier (GLN or other). Example: 5412345000013\",\n \"schemeId\": \"(string) Scheme ID for location. Example: GLN\"\n }\n },\n \"paymentMeans\": {\n \"code\": \"(string) The means, expressed as code, for how a payment is expected to be or has been settled. (e.g., UN/CEFACT 4461). Example: ZZZ\",\n \"text\": \"(string) Description of payment means. Example: Bank transfer\",\n \"mandateId\": \"(string) Unique identifier assigned by the Payee for referencing the direct debit mandate. Used in order to pre-notify the Buyer of a SEPA direct debit. Example: MandateId\",\n \"mandateFinancialAccountId\": \"(string) The account to be debited by the direct debit. Example: MandateFinancialAccountId\",\n \"paymentId\": \"(string) Payment reference to be used by the payer. Example: PMT-2023-001\",\n \"payeeFinancialInstitutionId\": \"(string) Identifier of Payee's bank (BIC, etc.). Example: KREDBEBB\",\n \"payeeFinancialAccountId\": \"(string) Payee’s bank account (IBAN, etc.). Example: BE49000023121121\",\n \"payeeFinancialAccountSchemeId\": \"(string) Scheme ID of Payee’s bank account (e.g. IBAN). Example: IBAN\",\n \"payeeFinancialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\"\n },\n \"multiplePaymentMeans\": [\n {\n \"code\": \"(string) The means, expressed as code, for how a payment is expected to be or has been settled (e.g. UN/CEFACT 4461). Example: 30\",\n \"text\": \"(string) Description of payment means. Example: Bank transfer\",\n \"mandateId\": \"(string) Unique identifier assigned by the Payee for referencing the direct debit mandate. Example: MandateId\",\n \"mandateFinancialAccountId\": \"(string) The account to be debited by the direct debit. Example: MandateFinancialAccountId\",\n \"paymentId\": \"(string) Payment reference to be used by the payer. Example: PMT-2023-001\",\n \"payeeFinancialInstitutionId\": \"(string) Identifier of Payee's bank (BIC, etc.). Example: KREDBEBB\",\n \"payeeFinancialAccountId\": \"(string) Payee's bank account (IBAN, etc.). Example: BE49000023121121\",\n \"payeeFinancialAccountSchemeId\": \"(string) Scheme ID of Payee's bank account (e.g. IBAN). Example: IBAN\",\n \"payeeFinancialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\"\n }\n ],\n \"payee\": {\n \"companyNumber\": \"(string) This element is used for both the identification of the Payee, or the unique banking reference identifier of Payee (assigned by the Payee bank.) For payee identification use ICD code list, for SEPA bank assigned creditor reference, use SEPA. Example: BE0123456749\",\n \"financialAccountId\": \"(string) Payee’s IBAN. Example: BE49000023121121\",\n \"financialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\",\n \"name\": \"(string) Name of payee. Example: PayeeName\"\n },\n \"paymentTerms\": {\n \"text\": \"(string) A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties). Example: Payment in 30 days\",\n \"settlementDiscountPercentage\": \"(number) Early payment discount percentage. If not filled in but SettlementDiscountPercentage is, this value will be calculated based on SettlementDiscountPercentage. Example: 2\",\n \"settlementDiscountAmount\": \"(number) Early payment discount absolute amount. If not filled in but SettlementDiscountAmount is, this value will be calculated based on SettlementDiscountAmount Example: 50.00\"\n },\n \"supplier\": {\n \"id\": \"(string) Internal supplier ID in sender’s system. Example: SUP1\",\n \"name\": \"(string, required) Supplier name. Example: Soluz.io\",\n \"address\": {\n \"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n \"address2\": \"(string) Example: Tax 1\",\n \"address3\": \"(string) Example: Tax 3\",\n \"city\": \"(string) City. Example: Tax Mechelen\",\n \"zip\": \"(string) Postal code. Example: Tax 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province. Example: Vl-Br\",\n \"taxpayersPrefix\": \"(string) VAT UE country prefix (e.g. PL) for intra-Community supplies, cross-border services, and triangular transactions.\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n \"department\": \"(string) Department or branch. Example: DevelopmentDepartment\",\n \"vatNumber\": \"(string) Customer VAT number. Example: BE0123456749\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"endpointId\": \"(string) Electronic endpoint identifier. Example: 0208:be2929035935\",\n \"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 0208\"\n },\n \"buyer\": {\n \"name\": \"(string) Buyer name. Example: Soluz.io\",\n \"address\": {\n \"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n \"zip\": \"(string) Postal code. Example: Tax 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province. Example: Vl-Br\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n \"companyNumberType\": \"(string) Company number type\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0123456749\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"RecipientType\": \"(string) Flag to indicate Subordinate Local Government Unit or GV member\"\n },\n \"taxRepresentative\": {\n \"address\": {\n \"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n \"address2\": \"(string) Example: Tax 1\",\n \"address3\": \"(string) Example: Tax 3\",\n \"city\": \"(string) City. Example: Tax Mechelen\",\n \"zip\": \"(string) Postal code. Example: Tax 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province. Example: Vl-Br\"\n },\n \"name\": \"(string) Tax representative name. Example: Tax Soluz.io\",\n \"vatNumber\": \"(string) VAT number. Example: BE000000097\"\n },\n \"discount\": {\n \"amount\": \"(number) The discount amount. If not filled in but Percentage is, this value will be calculated based on Percentage. Example: 50\",\n \"percentage\": \"(number) The discount percentage. If not filled in but Amount is, this value will be calculated based on Amount. Example: 10\",\n \"reason\": \"(string) Reason for discount. Example: extra korting van 10%\"\n },\n \"charge\": {\n \"amount\": \"(number) Additional charge excl. VAT. Example: 10\",\n \"vatRate\": \"(number) VAT rate on charge. Example: 21\",\n \"vatCode\": \"(string) VAT category code for charge. Example: S\",\n \"reason\": \"(string) Reason for charge. Example: Handling fee\"\n },\n \"totals\": {\n \"amountExclVat\": \"(number) The total amount of the Invoice without VAT. Must be rounded to maximum 2 decimals. Example: 297.00\",\n \"vatAmount\": \"(number) The total VAT amount for the Invoice or the VAT total amount expressed in the accounting currency accepted or required in the country of the Seller. Must be rounded to maximum 2 decimals. Example: 38.07\",\n \"amountInclVat\": \"(number) The total amount of the Invoice with VAT. Must be rounded to maximum 2 decimals. Example: 335.07\",\n \"lineExtensionAmount\": \"(number) Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals. If not supplied this is calculated as the sum of the LineExtensionAmount on the detail lines. Example: 297.00\",\n \"payableAmount\": \"(number) The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals. If not filled in the TaxInclusiveAmount will be used. Example: 335.07\",\n \"payableRoundingAmount\": \"(number) The amount to be added to the invoice total to round the amount to be paid. Must be rounded to maximum 2 decimals. Example: 0.00\",\n \"prepaidAmount\": \"(number) The sum of amounts which have been paid in advance. Must be rounded to maximum 2 decimals. Example: 0.00\"\n },\n \"vatSubTotals\": [\n {\n \"code\": \"(string) VAT category code. Example: S\",\n \"rate\": \"(number) VAT rate. Example: 21.00\",\n \"exemptionReason\": \"(string) Reason for VAT exemption. Example: Intra-community supply\",\n \"exemptionReasonCode\": \"(string) Code for VAT exemption reason. Example: K\",\n \"taxableAmount\": \"(number) Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable). Must be rounded to maximum 2 decimals. Example: 109.41\",\n \"taxAmount\": \"(number) The total VAT amount for a given VAT category. Must be rounded to maximum 2 decimals. Example: 22.98\",\n \"taxTypeIndicator\": \"(string) Additonal Tax Category for non-standard rate\",\n \"splitPaymentIndicator\": \"(string) Split payment indicator\"\n }\n ],\n \"parties\": [\n {\n \"partyName\": \"(string) Name of the party. Example: PANDAVA nv/sa\",\n \"roleCode\": \"(string) Code identifying the role this party has on the invoice. Example: SU\",\n \"endpointID\": \"(string) Electronic endpoint identifier of the party. Note the key is endpointID, not endpointId as used on customer and supplier. Example: 0208:be2929035935\",\n \"endpointIDType\": \"(string) Endpoint type or scheme which relates to the endpointID. Example: 0208\",\n \"identifiers\": [\n {\n \"id\": \"(string, required) Identifier value. Example: 5412345000013\",\n \"schemeId\": \"(string, required) Identifier scheme ID. Max 10 characters. Example: GLN\"\n }\n ],\n \"name\": \"(string) Name of the party. Example: PANDAVA nv/sa\",\n \"address1\": \"(string) Street and street number. Example: Zwartzustersvest 24\",\n \"address2\": \"(string) Address line 2. Example: Unit 5\",\n \"address3\": \"(string) Address line 3. Example: c/o Accounts\",\n \"city\": \"(string) City. Example: Mechelen\",\n \"zip\": \"(string) Postal code. Example: 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2 country code. Example: BE\",\n \"countryName\": \"(string) Country name. Example: Belgium\",\n \"countrySubEntity\": \"(string) Province, state or region. Example: Antwerpen\",\n \"vatNumber\": \"(string) VAT number of the party. Example: BE0123456749\",\n \"contactID\": \"(string) Identifier of the contact. Example: CT-001\",\n \"contactName\": \"(string) Contact person. Example: Jan Peeters\",\n \"contactEmail\": \"(string) Contact email. Example: jan@soluz.io\",\n \"contactPhone\": \"(string) Contact phone. Example: +3215999888\",\n \"partyLERegistrationName\": \"(string) Registered legal entity name of the party. Example: PANDAVA nv/sa\",\n \"partyLECompanyID\": \"(string) Legal entity company identifier. Example: 0999001396\",\n \"partyLECompanyIDType\": \"(string) Scheme of the legal entity company identifier. Example: 0208\",\n \"partyLECompanyLegalForm\": \"(string) Legal form of the legal entity. Example: nv/sa\",\n \"recipientType\": \"(string) Flag to indicate Subordinate Local Government Unit or GV member\"\n }\n ],\n \"detailLines\": [\n {\n \"id\": \"(string) Unique line ID. Example: 1\",\n \"quantity\": \"(number, required) Quantity invoiced. Example: 3\",\n \"articleName\": \"(string, required) Item name. Example: Agenda Timing 2024\",\n \"accountingCost\": \"(string) A textual value that specifies where to book the relevant data into the Buyer's financial accounts. Example: 700100\",\n \"additionalItemProperties\": \"(object) Additional properties of the goods/services. Example: { \\\"color\\\": \\\"blue\\\" }\",\n \"allowanceReason\": \"(string) Coded reason for allowance/charge. Example: 95\",\n \"allowanceAmount\": \"(number) The allowance amount, if there is an allowance. Example: 1.00\",\n \"chargeReason\": \"(string) Coded reason for allowance/charge. Example: 95\",\n \"chargeAmount\": \"(number) The charge amount, if there is a charge. Example: 1.00\",\n \"commodityClassificationCodes\": \"(object) Classification codes (e.g. UNSPSC, CPV, etc.). Example: { \\\"UNSPSC\\\": \\\"44121706\\\" }\",\n \"articleDescription\": \"(string) Item description. Example: Black hard cover\",\n \"articleNumberBuyer\": \"(string) Buyer’s item code. Example: ITM-001\",\n \"articleNumberSupplier\": \"(string) Supplier’s item code. Example: SUP-7788\",\n \"lineExtensionAmount\": \"(number, required) The total amount of the Invoice line. The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes. Must be rounded to maximum 2 decimals. If not supplied, the AmountExclVat will be used. Example: 150.00\",\n \"vatRate\": \"(number, required) VAT rate percentage. Example: 21\",\n \"vatCode\": \"(string) VAT category code. Example: S\",\n \"orderLineId\": \"(string) Reference to buyer’s order line. Example: 1000\",\n \"note\": \"(string) A textual note that gives unstructured information that is relevant to the Invoice line. Example: Delivered in January\",\n \"deliveryDate\": \"(string, date) Date of delivery for line (YYYY-MM-DD). Example: 2023-01-03\",\n \"deliveryNoteReference\": \"(string) Reference to delivery note. Example: DN-12345\",\n \"docRefDocType\": \"(string) Type of referenced document (code 130 = invoice object reference). Example: 130\",\n \"docRefId\": {\n \"id\": \"(string) Identifier of referenced object. Example: 998877\",\n \"schemeId\": \"(string) Scheme ID of reference. Example: PO\"\n },\n \"originCountryCode\": \"(string) Country of origin (ISO 3166-1 alpha-2). Example: BE\",\n \"standardItemIdentification\": {\n \"id\": \"(string) Standard item identifier. Example: 5412345678908\",\n \"schemeId\": \"(string) Identification scheme. Example: GTIN\"\n },\n \"price\": {\n \"articlePrice\": \"(number) The price of an item, exclusive of VAT, after subtracting item price discount. The Item net price has to be equal with the Item gross price less the Item price discount, if they are both provided. Item price can not be negative. Example: 50.00\",\n \"baseQuantity\": \"(number) Quantity basis for price. Example: 1\",\n \"unitOfMeasure\": \"(string) Unit of measure. Codes for unit of packaging from UNECE Recommendation No. 21 can be used in accordance with the descriptions in the Intro section of UN/ECE Recommendation 20, Revision 11 (2015): The 2 character alphanumeric code values in UNECE Recommendation 21 shall be used. o avoid duplication with existing code values in UNECE Recommendation No. 20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure. Example: H87\",\n \"allowanceAmount\": \"(number) The total discount subtracted from the Item gross price to calculate the Item net price. Example: 55.00\",\n \"allowanceBaseAmount\": \"(number) The unit price, exclusive of VAT, before subtracting Item price discount, can not be negative. Example: 60.00\"\n },\n \"vatExemptionReason\": \"(string) Reason for VAT exemption. Example: Intra-community supply\",\n \"vatExemptionReasonCode\": \"(string) Code for VAT exemption reason. Example: E\",\n \"uuLineNumber\": \"(string) Universal unique line number. Should be unique not only per invoice but per taxpayer or invoicing system\",\n \"lineGTU\": \"(string) Designation for the delivery of goods and the provision of services\",\n \"startDate\": \"(string, date) Invoice period start date for this line (YYYY-MM-DD). Example: 2023-11-01\",\n \"endDate\": \"(string, date) Invoice period end date for this line (YYYY-MM-DD). Example: 2023-11-30\",\n \"exemptFromDiscount\": \"(boolean) Set to true to exempt this line from the invoice level discount. Example: false\",\n \"lineDueDateTypeCode\": \"(string) Code specifying the type of due date that applies to this invoice line. Example: 3\",\n \"referencedDespatchDocId\": \"(string) Identifier of the despatch advice this line refers to. Example: DESP-993\",\n \"referencedDespatchDocLineId\": \"(string) Line identifier within the referenced despatch advice. Example: 2\",\n \"referencedInvoiceDocId\": \"(string) Identifier of the invoice this line refers to. Example: INV-2021-77\",\n \"referencedInvoiceDocLineId\": \"(string) Line identifier within the referenced invoice. Example: 4\",\n \"referencedInvoiceDocTypeCode\": \"(string) Document type code of the referenced invoice. Example: 380\",\n \"referencedInvoiceDocIssueDate\": \"(string, date) Issue date of the referenced invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"referencedReceiptDocId\": \"(string) Identifier of the receiving advice this line refers to. Example: RCPT-331\",\n \"referencedReceiptDocLineId\": \"(string) Line identifier within the referenced receiving advice. Example: 1\",\n \"referencedSalesOrderDocId\": \"(string) Identifier of the sales order this line refers to. Example: SO-10099\",\n \"referencedSalesOrderDocLineId\": \"(string) Line identifier within the referenced sales order. Example: 7\",\n \"deliveryActualDeliveryDate\": \"(string, date) Actual delivery date for this line (YYYY-MM-DD). Example: 2023-11-05\",\n \"deliveryPartyName\": \"(string) Name of the party this line was delivered to. Example: Soluz.io afleveradres\",\n \"deliveryLocationIDs\": \"(string) Identifier of the delivery location for this line. Example: 5412345000013\",\n \"deliveryLocationAddress1\": \"(string) Delivery location street and number. Example: Berendries 52\",\n \"deliveryLocationAddress2\": \"(string) Delivery location address line 2. Example: Building A\",\n \"deliveryLocationAddress3\": \"(string) Delivery location address line 3. Example: Floor 2\",\n \"deliveryLocationCity\": \"(string) Delivery location city. Example: Lovendegem\",\n \"deliveryLocationZIP\": \"(string) Delivery location postal code. Example: 5400\",\n \"deliveryLocationCountrySubEntity\": \"(string) Delivery location province, state or region. Example: O-Vl\",\n \"deliveryLocationCountryCode\": \"(string) Delivery location country (ISO 3166-1 alpha-2). Example: BE\"\n }\n ]\n },\n \"processing\": {\n \"deliveryMethod\": \"(string) Outbound channel (e.g. PEPPOL, E-MAIL, POST). Example: PEPPOL\",\n \"extraCode1\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode2\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode3\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode4\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode5\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode6\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode7\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode8\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode9\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode10\": \"(string) Optional extra information that can be used in rules\",\n \"extraInfo\": \"(string) Free-form text, up to 500 chars.\",\n \"senderPartyEntity\": \"(string) ComFin contract number if ComFin customer. Example: BE00001\",\n \"messageType\": \"(string) Message type for XML (default EFFF). Example: EFFF\"\n },\n \"image\": {\n \"embedded\": \"(boolean) Is it an embedded file? Example: true\",\n \"name\": \"(string) File name. Example: factuurImage.pdf\",\n \"mimeType\": \"(string) MIME type. Example: application/pdf\",\n \"value\": \"(string, base64) Base64 content of file. Example: BASE64 here\"\n },\n \"attachments\": [\n {\n \"embedded\": \"(boolean) Is it an embedded file? Example: true\",\n \"name\": \"(string) File name. Example: Attach.pdf\",\n \"mimeType\": \"(string) MIME type. Example: application/pdf\",\n \"value\": \"(string, base64) Base64 content\"\n }\n ]\n}\n\nClass that holds data for uploading an invoice (outbound)
\n{\n \"type\": \"object\",\n \"description\": \"Class that holds details of an invoice (outbound)\",\n \"additionalProperties\": false,\n \"required\": [\n \"currency\",\n \"date\",\n \"type\",\n \"totals\",\n \"customer\"\n ],\n \"properties\": {\n \"currency\": {\n \"type\": \"string\",\n \"description\": \"The currency in which all Invoice amounts are given.\",\n \"minLength\": 1\n },\n \"date\": {\n \"type\": \"string\",\n \"description\": \"The date when the Invoice was issued. Format \\\"YYYY-MM-DD\\\"\",\n \"format\": \"date\",\n \"minLength\": 1\n },\n \"dueDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the payment is due.Format \\\"YYYY-MM-DD\\\".\\nIn case the Amount due for payment (BT-115) is positive,\\neither the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"note\": {\n \"type\": \"string\",\n \"description\": \"A textual note that gives unstructured information that is relevant to the Invoice as a whole.Such as the reason for any correction or assignment note in case the invoice has been factored.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"documentNumber\": {\n \"type\": \"string\",\n \"description\": \"A unique identification of the Invoice,\\nto uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"invoiceNumber\": {\n \"type\": \"string\",\n \"description\": \"A unique identification of the Invoice,\\nto uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"structuredCommunication\": {\n \"type\": \"string\",\n \"description\": \"A textual value used to establish a link between the payment and the Invoice, issued by the Seller.\\nUsed for creditor's critical reconciliation information.\\nThis information element helps the Seller to assign an incoming payment to the relevant payment process.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"type\": {\n \"type\": \"string\",\n \"description\": \"Invoice|CreditNote\",\n \"minLength\": 1\n },\n \"typeCode\": {\n \"type\": \"string\",\n \"description\": \"380 , 381 ,...\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"serviceBeginDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Invoice period starts. Format = \\\"YYYY-MM-DD\\\".\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"serviceEndDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Invoice period ends. Format = \\\"YYYY-MM-DD\\\".\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"taxPointDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the VAT becomes accountable for the Seller and for the Buyer in so far as that date can be determined and differs from the date of issue of the invoice, according to the VAT directive.\\nThis element is required if the Value added tax point date is different from the Invoice issue date.\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"placeOfIssue\": {\n \"type\": \"string\",\n \"description\": \"Place where the invoice was issued\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"fullyPaid\": {\n \"type\": \"boolean\",\n \"description\": \"Indicates if an invoice has been paid\"\n },\n \"dateOfFullPayment\": {\n \"type\": \"string\",\n \"description\": \"Date of payment if full payment if payment was made by the time of the invoice was issued\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"simplifiedTriangularProcedure\": {\n \"type\": \"boolean\",\n \"description\": \"Indicates a simplified triangular transaction, issued by the second taxpayer in the sequence.\"\n },\n \"checkoutMethod\": {\n \"type\": \"boolean\",\n \"description\": \"Cash accounting indicator\"\n },\n \"selfBillingIndicator\": {\n \"type\": \"boolean\",\n \"description\": \"Self-billing indicator \"\n },\n \"warehouseDocumentNumbers\": {\n \"type\": \"string\",\n \"description\": \"WZ (delivery note) document numbers\",\n \"nullable\": true\n },\n \"typeName\": {\n \"type\": \"string\",\n \"description\": \"Invoice Type name\",\n \"nullable\": true\n },\n \"restrictedInformation\": {\n \"type\": \"boolean\",\n \"description\": \"Indicator if Invoice referred to in Art. 109 sec. 3d of the Act\"\n },\n \"references\": {\n \"type\": \"object\",\n \"description\": \"References\",\n \"additionalProperties\": false,\n \"properties\": {\n \"accountingCost\": {\n \"type\": \"string\",\n \"description\": \"Buyer accounting reference\\nA textual value that specifies where to book the relevant data into the Buyer's financial accounts.\\nExample value: 4217:2323:2323\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"billingReferences\": {\n \"type\": \"array\",\n \"description\": \"A group of business terms providing information on the preceding Invoice.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"invoiceDocumentReference\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"invoiceDocumentReferenceIssueDate\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"reasonForCorrection\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"documentTypeCode\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"externalReference\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"typeOfCorrection\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n }\n },\n \"buyerReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier assigned by the Buyer used for internal routing purposes. An invoice must have buyer reference or purchase order reference (BT-13).\",\n \"maxLength\": 1000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"contractDocReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of a contract as specified by the sender\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"contractDocIssueDate\": {\n \"type\": \"string\",\n \"description\": \"Date of the contract as specified by the sender\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"contractDocReferenceCustomer\": {\n \"type\": \"string\",\n \"description\": \"The identification of a contract as specified by the receiver\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"contractDocIssueDateCustomer\": {\n \"type\": \"string\",\n \"description\": \"Date of the contract as specified by the receiver\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"despatchDocReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced despatch advice.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"invoiceDocumentReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of an Invoice that was previously sent by the Seller.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"invoiceDocumentReferenceIssueDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Preceding Invoice was issued.Shall be provided in case the Preceding Invoice identifier is not unique. Format = \\\"YYYY-MM-DD\\\".\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"originatorDocReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of the call for tender or lot the invoice relates to.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"projectReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of the project the invoice refers to.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"purchaseOrderReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced purchase order, issued by the Buyer.An invoice must have buyer reference (BT-10) or purchase order reference.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"receiptDocReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced receiving advice.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"salesOrderIssueDate\": {\n \"type\": \"string\",\n \"description\": \"Spain only: add Issuer transaction date (recommended, not mandatory)\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"salesOrderReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced sales order, issued by the Seller.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"customer\": {\n \"type\": \"object\",\n \"description\": \"Customer info\",\n \"additionalProperties\": false,\n \"required\": [\n \"address\",\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Customer number in the suppliers system\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"contact\": {\n \"type\": \"object\",\n \"description\": \"Business contact\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Id of the business contact\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the business contact\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the business contact\",\n \"maxLength\": 300,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Phone number of the contact\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"companyNumber\": {\n \"type\": \"string\",\n \"description\": \"Company number of the customer. CompanyNumber or VAT Number required for companies\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"department\": {\n \"type\": \"string\",\n \"description\": \"Department of the customer\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the customer\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"VAT number of the customer. CompanyNumber or VAT Number required for companies\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"glnNumber\": {\n \"type\": \"string\",\n \"description\": \"Glnnumber of the customer\",\n \"nullable\": true\n },\n \"endpointId\": {\n \"type\": \"string\",\n \"description\": \"EndpointId of the customer\",\n \"nullable\": true\n },\n \"endpointType\": {\n \"type\": \"string\",\n \"description\": \"EndpointType of the customer\",\n \"nullable\": true\n },\n \"identifications\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n }\n }\n }\n },\n \"delivery\": {\n \"type\": \"object\",\n \"description\": \"Delivery info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"actualDeliveryDate\": {\n \"type\": \"string\",\n \"description\": \"The date on which the supply of goods or services was made or completed. Format = \\\"YYYY-MM-DD\\\"\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"locationIdentifier\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"The name of the party to which the goods and services are delivered.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"payee\": {\n \"type\": \"object\",\n \"description\": \"Payee info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"companyNumber\": {\n \"type\": \"string\",\n \"description\": \"This element is used for both the identification of the Payee,\\nor the unique banking reference identifier of Payee (assigned by the Payee bank.)\\nFor payee identification use ICD code list, for SEPA bank assigned creditor reference, use SEPA.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"financialAccountId\": {\n \"type\": \"string\",\n \"description\": \"The name of the payment account, at a payment service provider, to which payment should be made.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"financialAccountName\": {\n \"type\": \"string\",\n \"description\": \"The name of the payment account, at a payment service provider, to which payment should be made.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"The name of the Payee.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"paymentMeans\": {\n \"type\": \"object\",\n \"description\": \"PaymentMeans info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"mandateId\": {\n \"type\": \"string\",\n \"description\": \"Unique identifier assigned by the Payee for referencing the direct debit mandate.\\nUsed in order to pre-notify the Buyer of a SEPA direct debit.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"mandateFinancialAccountId\": {\n \"type\": \"string\",\n \"description\": \"The account to be debited by the direct debit.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"code\": {\n \"type\": \"string\",\n \"description\": \"The means, expressed as code, for how a payment is expected to be or has been settled.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"text\": {\n \"type\": \"string\",\n \"description\": \"The means, expressed as text, for how a payment is expected to be or has been settled.\\nExample value: Credit transfer\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"paymentId\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"payeeFinancialInstitutionId\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"payeeFinancialAccountId\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"payeeFinancialAccountSchemeId\": {\n \"type\": \"string\",\n \"maxLength\": 20,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"payeeFinancialAccountName\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"cardId\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"cardHolderName\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"multiplePaymentMeans\": {\n \"type\": \"array\",\n \"description\": \"Multiple payment means\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"PaymentMeans info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"mandateId\": {\n \"type\": \"string\",\n \"description\": \"Unique identifier assigned by the Payee for referencing the direct debit mandate.\\nUsed in order to pre-notify the Buyer of a SEPA direct debit.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"mandateFinancialAccountId\": {\n \"type\": \"string\",\n \"description\": \"The account to be debited by the direct debit.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"code\": {\n \"type\": \"string\",\n \"description\": \"The means, expressed as code, for how a payment is expected to be or has been settled.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"text\": {\n \"type\": \"string\",\n \"description\": \"The means, expressed as text, for how a payment is expected to be or has been settled.\\nExample value: Credit transfer\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"paymentId\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"payeeFinancialInstitutionId\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"payeeFinancialAccountId\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"payeeFinancialAccountSchemeId\": {\n \"type\": \"string\",\n \"maxLength\": 20,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"payeeFinancialAccountName\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"cardId\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"cardHolderName\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n }\n },\n \"paymentTerms\": {\n \"type\": \"object\",\n \"description\": \"PaymentTerms info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"text\": {\n \"type\": \"string\",\n \"description\": \"A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties).\\nIn case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.\",\n \"maxLength\": 1000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"settlementDiscountAmount\": {\n \"type\": \"number\",\n \"description\": \"The SettlementDiscountAmount. Optional\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"settlementDiscountPercentage\": {\n \"type\": \"number\",\n \"description\": \"The SettlementDiscountPercentage . Optional\",\n \"format\": \"decimal\",\n \"nullable\": true\n }\n }\n },\n \"supplier\": {\n \"type\": \"object\",\n \"description\": \"Supplier info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Customer number in the suppliers system\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"contact\": {\n \"type\": \"object\",\n \"description\": \"Business contact\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Id of the business contact\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the business contact\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the business contact\",\n \"maxLength\": 300,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Phone number of the contact\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"companyNumber\": {\n \"type\": \"string\",\n \"description\": \"Company number of the supplier. CompanyNumber or VAT Number required for companies\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"department\": {\n \"type\": \"string\",\n \"description\": \"Department of the supplier\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the supplier\",\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"VAT number of the supplier. CompanyNumber or VAT Number required for companies\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"glnNumber\": {\n \"type\": \"string\",\n \"description\": \"Glnnumber of the supplier\",\n \"nullable\": true\n },\n \"endpointId\": {\n \"type\": \"string\",\n \"description\": \"EndpointId of the supplier\",\n \"nullable\": true\n },\n \"endpointType\": {\n \"type\": \"string\",\n \"description\": \"EndpointType of the supplier\",\n \"nullable\": true\n },\n \"taxpayersPrefix\": {\n \"type\": \"string\",\n \"description\": \"VAT UE country prefix (e.g. \\\"PL\\\") for intra-Community supplies, cross-border services, and triangular transactions.\",\n \"nullable\": true\n },\n \"identifications\": {\n \"type\": \"array\",\n \"description\": \"Additional identifiers for the party.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n }\n }\n }\n },\n \"taxRepresentative\": {\n \"type\": \"object\",\n \"description\": \"Tax representative party\",\n \"additionalProperties\": false,\n \"properties\": {\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"The full name of the Seller's tax representative party.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"The VAT identifier of the Seller's tax representative party.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"totals\": {\n \"type\": \"object\",\n \"description\": \"Invoice totals\",\n \"additionalProperties\": false,\n \"required\": [\n \"amountExclVat\",\n \"amountInclVat\",\n \"vatAmount\"\n ],\n \"properties\": {\n \"amountExclVat\": {\n \"type\": \"number\",\n \"description\": \"The total amount of the Invoice without VAT. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\"\n },\n \"amountInclVat\": {\n \"type\": \"number\",\n \"description\": \"The total amount of the Invoice with VAT. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\"\n },\n \"lineExtensionAmount\": {\n \"type\": \"number\",\n \"description\": \"Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals.\\nIf not supplied this is calculated as the sum of the LineExtensionAmount on the detail lines\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"payableAmount\": {\n \"type\": \"number\",\n \"description\": \"The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals.\\nIf not filled in the TaxInclusiveAmount will be used\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"payableRoundingAmount\": {\n \"type\": \"number\",\n \"description\": \"The amount to be added to the invoice total to round the amount to be paid. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"prepaidAmount\": {\n \"type\": \"number\",\n \"description\": \"The sum of amounts which have been paid in advance. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"vatAmount\": {\n \"type\": \"number\",\n \"description\": \"The total VAT amount for the Invoice or the VAT total amount expressed in the accounting currency accepted or required in the country of the Seller. Must be rounded to maximum 2 decimals \",\n \"format\": \"decimal\"\n }\n }\n },\n \"discount\": {\n \"type\": \"object\",\n \"description\": \"Discount info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"amount\": {\n \"type\": \"number\",\n \"description\": \"The discount amount. Optional\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"percentage\": {\n \"type\": \"number\",\n \"description\": \"The discount percentage. Optional\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"reason\": {\n \"type\": \"string\",\n \"description\": \"Reason for the discount\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"taxExemptionReason\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"taxExemptionReasonCode\": {\n \"type\": \"string\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"charge\": {\n \"type\": \"object\",\n \"description\": \"Charge info\",\n \"additionalProperties\": false,\n \"required\": [\n \"vatRate\"\n ],\n \"properties\": {\n \"amount\": {\n \"type\": \"number\",\n \"description\": \"The Charge amount\",\n \"format\": \"decimal\"\n },\n \"vatRate\": {\n \"type\": \"number\",\n \"description\": \"The charge vat rate\",\n \"format\": \"decimal\"\n },\n \"vatCode\": {\n \"type\": \"string\",\n \"description\": \"The VAT category code for the charge.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"reason\": {\n \"type\": \"string\",\n \"description\": \"Reason for the charge\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"taxExemptionReason\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"taxExemptionReasonCode\": {\n \"type\": \"string\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"vatSubTotals\": {\n \"type\": \"array\",\n \"description\": \"Optional. The VAT Sub totals of the invoice\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"VAT Sub totals\",\n \"additionalProperties\": false,\n \"properties\": {\n \"code\": {\n \"type\": \"string\",\n \"description\": \"Coded identification of a VAT category.\",\n \"nullable\": true\n },\n \"rate\": {\n \"type\": \"number\",\n \"description\": \"The VAT rate, represented as percentage that applies for the relevant VAT category.\",\n \"format\": \"decimal\"\n },\n \"exemptionReasonCode\": {\n \"type\": \"string\",\n \"description\": \"A coded statement of the reason for why the amount is exempted from VAT.\",\n \"nullable\": true\n },\n \"exemptionReason\": {\n \"type\": \"string\",\n \"description\": \"A textual statement of the reason why the amount is exempted from VAT or why no VAT is being charged.\",\n \"nullable\": true\n },\n \"taxableAmount\": {\n \"type\": \"number\",\n \"description\": \"Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable).\\nMust be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\"\n },\n \"taxAmount\": {\n \"type\": \"number\",\n \"description\": \"The total VAT amount for a given VAT category. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\"\n },\n \"taxTypeIndicator\": {\n \"type\": \"string\",\n \"description\": \"Tax category for non-standard VAT rates\",\n \"nullable\": true\n },\n \"splitPaymentIndicator\": {\n \"type\": \"string\",\n \"description\": \"Split payment indicator (\\\"mechanizm podzielonej płatności\\\").\\nRequired when invoice total exceeds PLN 15,000 and covers Annex 15 goods/services.\",\n \"nullable\": true\n }\n }\n }\n },\n \"detailLines\": {\n \"type\": \"array\",\n \"description\": \"Detail lines of the invoice\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Class that holds an invoice detail line\",\n \"additionalProperties\": false,\n \"required\": [\n \"articleName\",\n \"lineExtensionAmount\",\n \"vatRate\",\n \"quantity\"\n ],\n \"properties\": {\n \"additionalItemProperties\": {\n \"type\": \"object\",\n \"description\": \"A group of business terms providing information about properties of the goods and services invoiced.\",\n \"nullable\": true,\n \"additionalProperties\": {\n \"type\": \"string\"\n }\n },\n \"articleName\": {\n \"type\": \"string\",\n \"description\": \"A name for an item.\",\n \"maxLength\": 2000,\n \"minLength\": 0\n },\n \"articleDescription\": {\n \"type\": \"string\",\n \"description\": \"A description for an item.The item description allows for describing the item and its features in more detail than the Item name.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"articleNumberBuyer\": {\n \"type\": \"string\",\n \"description\": \"An identifier, assigned by the Buyer, for the item.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"articleNumberSupplier\": {\n \"type\": \"string\",\n \"description\": \"An identifier, assigned by the Seller, for the item.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"lineExtensionAmount\": {\n \"type\": \"number\",\n \"description\": \"The total amount of the Invoice line. The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes.\\nMust be rounded to maximum 2 decimals.\\nIf not supplied, the AmountExclVat will be used\",\n \"format\": \"decimal\"\n },\n \"allowanceReason\": {\n \"type\": \"string\",\n \"description\": \"The reason for the allowance on this line, if there is an allowance.\",\n \"maxLength\": 1000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"allowanceAmount\": {\n \"type\": \"number\",\n \"description\": \"The allowance amount, if there is an allowance\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"chargeReason\": {\n \"type\": \"string\",\n \"description\": \"The reason for the charge on this line, if there is a charge.\",\n \"maxLength\": 1000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"chargeAmount\": {\n \"type\": \"number\",\n \"description\": \"The charge amount, if there is a charge\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"commodityClassificationCodes\": {\n \"type\": \"object\",\n \"description\": \"A code for classifying the item by its type or nature.\",\n \"nullable\": true,\n \"additionalProperties\": {\n \"type\": \"string\"\n }\n },\n \"deliveryDate\": {\n \"type\": \"string\",\n \"description\": \"Delivery date\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"deliveryNoteReference\": {\n \"type\": \"string\",\n \"description\": \"Delivery note reference\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"docRefDocType\": {\n \"type\": \"string\",\n \"description\": \"Code \\\"130\\\" MUST be used to indicate an invoice object reference. Not used for other additional documents\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"docRefId\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n },\n \"note\": {\n \"type\": \"string\",\n \"description\": \"A textual note that gives unstructured information that is relevant to the Invoice line.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"originCountryCode\": {\n \"type\": \"string\",\n \"description\": \"The code identifying the country from which the item originates.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"id\": {\n \"type\": \"string\",\n \"description\": \"A unique identifier for the individual line within the Invoice.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"accountingCost\": {\n \"type\": \"string\",\n \"description\": \"A textual value that specifies where to book the relevant data into the Buyer's financial accounts.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"startDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Invoice period for this Invoice line starts. Format =\\\"YYYY-MM-DD\\\"\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"endDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Invoice period for this Invoice line ends. Format =\\\"YYYY-MM-DD\\\"\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"exemptFromDiscount\": {\n \"type\": \"boolean\",\n \"description\": \"Set this flag to true to excempt this line from being included in the discount\"\n },\n \"vatCode\": {\n \"type\": \"string\",\n \"description\": \"The VAT category code for the invoiced item.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"vatRate\": {\n \"type\": \"number\",\n \"description\": \"The VAT rate, represented as percentage that applies to the invoiced item.\",\n \"format\": \"decimal\"\n },\n \"orderLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for a referenced line within a purchase order, issued by the Buyer.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"quantity\": {\n \"type\": \"number\",\n \"description\": \"The quantity of items (goods or services) that is charged in the Invoice line.\",\n \"format\": \"decimal\"\n },\n \"standardItemIdentification\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n },\n \"price\": {\n \"type\": \"object\",\n \"description\": \"A group of items related to the price of an invoiced item\",\n \"additionalProperties\": false,\n \"required\": [\n \"articlePrice\"\n ],\n \"properties\": {\n \"articlePrice\": {\n \"type\": \"number\",\n \"description\": \"The price of an item, exclusive of VAT, after subtracting item price discount.\\nThe Item net price has to be equal with the Item gross price less the Item price discount, if they are both provided.\\nItem price can not be negative.\",\n \"format\": \"decimal\"\n },\n \"baseQuantity\": {\n \"type\": \"number\",\n \"description\": \"The number of item units to which the price applies.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"unitOfMeasure\": {\n \"type\": \"string\",\n \"description\": \"The unit of measure that applies to the invoiced quantity.\\nCodes for unit of packaging from UNECE Recommendation No.\\n21 can be used in accordance with the descriptions in the \\\"Intro\\\" section of UN/ECE Recommendation 20, Revision 11 (2015):\\nThe 2 character alphanumeric code values in UNECE Recommendation 21 shall be used.\\nTo avoid duplication with existing code values in UNECE Recommendation No.\\n20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"allowanceAmount\": {\n \"type\": \"number\",\n \"description\": \"The total discount subtracted from the Item gross price to calculate the Item net price.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"allowanceBaseAmount\": {\n \"type\": \"number\",\n \"description\": \"The unit price, exclusive of VAT, before subtracting Item price discount, can not be negative\",\n \"format\": \"decimal\",\n \"nullable\": true\n }\n }\n },\n \"vatExemptionReason\": {\n \"type\": \"string\",\n \"description\": \"The VatExemptionReason\",\n \"nullable\": true\n },\n \"vatExemptionReasonCode\": {\n \"type\": \"string\",\n \"description\": \"The VatExemptionReasonCode\",\n \"nullable\": true\n },\n \"uuLineNumber\": {\n \"type\": \"string\",\n \"description\": \"Universal unique line number\\nShould be unique not only per invoice but per taxpayer or invoicing system\",\n \"nullable\": true\n },\n \"lineGTU\": {\n \"type\": \"string\",\n \"description\": \"Designation for the delivery of goods and the provision of services\",\n \"nullable\": true\n },\n \"lineDueDateTypeCode\": {\n \"type\": \"string\",\n \"description\": \"Code specifying the type of due date that applies to this Invoice line.\",\n \"nullable\": true\n },\n \"referencedDespatchDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the despatch advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedDespatchDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced despatch advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the invoice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced invoice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocTypeCode\": {\n \"type\": \"string\",\n \"description\": \"The document type code of the referenced invoice.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocIssueDate\": {\n \"type\": \"string\",\n \"description\": \"The issue date of the referenced invoice. Format = \\\"YYYY-MM-DD\\\"\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"referencedReceiptDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the receiving advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedReceiptDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced receiving advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedSalesOrderDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the sales order that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedSalesOrderDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced sales order that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"deliveryActualDeliveryDate\": {\n \"type\": \"string\",\n \"description\": \"The date on which the goods or services on this Invoice line were actually delivered. Format = \\\"YYYY-MM-DD\\\"\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"deliveryPartyName\": {\n \"type\": \"string\",\n \"description\": \"The name of the party that the goods or services on this Invoice line were delivered to.\",\n \"nullable\": true\n },\n \"deliveryLocationIDs\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationAddress1\": {\n \"type\": \"string\",\n \"description\": \"Street and street number of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationAddress2\": {\n \"type\": \"string\",\n \"description\": \"Additional address line of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationAddress3\": {\n \"type\": \"string\",\n \"description\": \"Additional address line of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationCity\": {\n \"type\": \"string\",\n \"description\": \"City of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationZIP\": {\n \"type\": \"string\",\n \"description\": \"Postal code of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationCountrySubEntity\": {\n \"type\": \"string\",\n \"description\": \"Province, state or region of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationCountryCode\": {\n \"type\": \"string\",\n \"description\": \"The country of the delivery location of this Invoice line, as an ISO 3166-1 alpha-2 code.\",\n \"nullable\": true\n }\n }\n }\n },\n \"parties\": {\n \"type\": \"array\",\n \"description\": \"Involved parties of the invoice\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"An additional party involved in the invoice, beyond the Customer, Supplier, Buyer,\\nPayee and TaxRepresentative that have their own dedicated groups. The role the party\\ntakes on the invoice is given by RoleCode.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"partyName\": {\n \"type\": \"string\",\n \"description\": \"The name of the party.\",\n \"nullable\": true\n },\n \"roleCode\": {\n \"type\": \"string\",\n \"description\": \"A code identifying the role that this party takes on the invoice.\",\n \"nullable\": true\n },\n \"endpointID\": {\n \"type\": \"string\",\n \"description\": \"The electronic endpoint identifier of the party.\",\n \"nullable\": true\n },\n \"endpointIDType\": {\n \"type\": \"string\",\n \"description\": \"The endpoint type or scheme which relates to the EndpointID.\",\n \"nullable\": true\n },\n \"identifiers\": {\n \"type\": \"array\",\n \"description\": \"Additional identifiers for the party. Both members of each identifier are mandatory.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n }\n },\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Street and street number of the party.\",\n \"nullable\": true\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Additional address line of the party.\",\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Additional address line of the party.\",\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City of the party.\",\n \"nullable\": true\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"Postal code of the party.\",\n \"nullable\": true\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"The country of the party, as an ISO 3166-1 alpha-2 code.\",\n \"nullable\": true\n },\n \"countryName\": {\n \"type\": \"string\",\n \"description\": \"The country name of the party.\",\n \"nullable\": true\n },\n \"countrySubEntity\": {\n \"type\": \"string\",\n \"description\": \"Province, state or region of the party.\",\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"The VAT number of the party.\",\n \"nullable\": true\n },\n \"contactID\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the contact of the party.\",\n \"nullable\": true\n },\n \"contactName\": {\n \"type\": \"string\",\n \"description\": \"The contact person of the party.\",\n \"nullable\": true\n },\n \"contactEmail\": {\n \"type\": \"string\",\n \"description\": \"The contact email address of the party.\",\n \"nullable\": true\n },\n \"contactPhone\": {\n \"type\": \"string\",\n \"description\": \"The contact phone number of the party.\",\n \"nullable\": true\n },\n \"partyLERegistrationName\": {\n \"type\": \"string\",\n \"description\": \"The registered legal entity name of the party.\",\n \"nullable\": true\n },\n \"partyLECompanyID\": {\n \"type\": \"string\",\n \"description\": \"The legal entity company identifier of the party (e.g. Belgium CBE/KBO).\",\n \"nullable\": true\n },\n \"partyLECompanyIDType\": {\n \"type\": \"string\",\n \"description\": \"The scheme of the legal entity company identifier, using the ICD code list.\",\n \"nullable\": true\n },\n \"partyLECompanyLegalForm\": {\n \"type\": \"string\",\n \"description\": \"The legal form of the legal entity.\",\n \"nullable\": true\n },\n \"recipientType\": {\n \"type\": \"string\",\n \"description\": \"Flag to indicate Subordinate Local Government Unit or GV member.\",\n \"nullable\": true\n }\n }\n }\n },\n \"buyer\": {\n \"type\": \"object\",\n \"description\": \"Buyer info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Full legal name of the buyer\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"glnNumber\": {\n \"type\": \"string\",\n \"description\": \"Global Location Number of the buyer\",\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"VAT number of the buyer\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"contact\": {\n \"type\": \"object\",\n \"description\": \"Business contact\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Id of the business contact\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the business contact\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the business contact\",\n \"maxLength\": 300,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Phone number of the contact\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"recipientType\": {\n \"type\": \"string\",\n \"description\": \"Type of the buyer\\nPossible values:\\n12: JST Recipient\\n21: GV Recipient\",\n \"nullable\": true\n }\n }\n },\n \"taxExchangeRate\": {\n \"type\": \"object\",\n \"description\": \"Represents an exchange rate used for tax calculations between different currencies.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"sourceCurrencyCode\": {\n \"type\": \"string\",\n \"description\": \"ISO currency code representing the source currency for the transaction.\",\n \"nullable\": true\n },\n \"targetCurrencyCode\": {\n \"type\": \"string\",\n \"description\": \"ISO currency code representing the target currency for conversion or display.\",\n \"nullable\": true\n },\n \"calculationRate\": {\n \"type\": \"number\",\n \"description\": \"Exchange rate.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"mathematicOperatorCode\": {\n \"type\": \"string\",\n \"description\": \"Mathematical operator used in calculations. Default is \\\"Multiply\\\".\",\n \"nullable\": true\n },\n \"date\": {\n \"type\": \"string\",\n \"description\": \"Date for the calculation rate.\",\n \"format\": \"date-time\",\n \"nullable\": true\n }\n }\n },\n \"invoicePeriodDescriptionCode\": {\n \"type\": \"string\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"deliveryTermsId\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"deliveryTermsDeliveryLocationName\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"contractDocReferenceTypeCode\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nClass that holds details of an invoice (outbound)
\n{\n \"type\": \"object\",\n \"description\": \"References\",\n \"additionalProperties\": false,\n \"properties\": {\n \"accountingCost\": {\n \"type\": \"string\",\n \"description\": \"Buyer accounting reference\\nA textual value that specifies where to book the relevant data into the Buyer's financial accounts.\\nExample value: 4217:2323:2323\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"billingReferences\": {\n \"type\": \"array\",\n \"description\": \"A group of business terms providing information on the preceding Invoice.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"invoiceDocumentReference\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"invoiceDocumentReferenceIssueDate\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"reasonForCorrection\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"documentTypeCode\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"externalReference\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"typeOfCorrection\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n }\n },\n \"buyerReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier assigned by the Buyer used for internal routing purposes. An invoice must have buyer reference or purchase order reference (BT-13).\",\n \"maxLength\": 1000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"contractDocReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of a contract as specified by the sender\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"contractDocIssueDate\": {\n \"type\": \"string\",\n \"description\": \"Date of the contract as specified by the sender\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"contractDocReferenceCustomer\": {\n \"type\": \"string\",\n \"description\": \"The identification of a contract as specified by the receiver\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"contractDocIssueDateCustomer\": {\n \"type\": \"string\",\n \"description\": \"Date of the contract as specified by the receiver\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"despatchDocReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced despatch advice.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"invoiceDocumentReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of an Invoice that was previously sent by the Seller.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"invoiceDocumentReferenceIssueDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Preceding Invoice was issued.Shall be provided in case the Preceding Invoice identifier is not unique. Format = \\\"YYYY-MM-DD\\\".\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"originatorDocReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of the call for tender or lot the invoice relates to.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"projectReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of the project the invoice refers to.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"purchaseOrderReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced purchase order, issued by the Buyer.An invoice must have buyer reference (BT-10) or purchase order reference.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"receiptDocReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced receiving advice.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"salesOrderIssueDate\": {\n \"type\": \"string\",\n \"description\": \"Spain only: add Issuer transaction date (recommended, not mandatory)\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"salesOrderReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced sales order, issued by the Seller.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nReferences
\n{\n \"type\": \"object\",\n \"description\": \"Customer info\",\n \"additionalProperties\": false,\n \"required\": [\n \"address\",\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Customer number in the suppliers system\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"contact\": {\n \"type\": \"object\",\n \"description\": \"Business contact\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Id of the business contact\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the business contact\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the business contact\",\n \"maxLength\": 300,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Phone number of the contact\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"companyNumber\": {\n \"type\": \"string\",\n \"description\": \"Company number of the customer. CompanyNumber or VAT Number required for companies\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"department\": {\n \"type\": \"string\",\n \"description\": \"Department of the customer\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the customer\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"VAT number of the customer. CompanyNumber or VAT Number required for companies\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"glnNumber\": {\n \"type\": \"string\",\n \"description\": \"Glnnumber of the customer\",\n \"nullable\": true\n },\n \"endpointId\": {\n \"type\": \"string\",\n \"description\": \"EndpointId of the customer\",\n \"nullable\": true\n },\n \"endpointType\": {\n \"type\": \"string\",\n \"description\": \"EndpointType of the customer\",\n \"nullable\": true\n },\n \"identifications\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n }\n }\n }\n}\n\nCustomer info
\n{\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nAddress
\n{\n \"type\": \"object\",\n \"description\": \"Delivery info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"actualDeliveryDate\": {\n \"type\": \"string\",\n \"description\": \"The date on which the supply of goods or services was made or completed. Format = \\\"YYYY-MM-DD\\\"\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"locationIdentifier\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"The name of the party to which the goods and services are delivered.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nDelivery info
\n{\n \"type\": \"object\",\n \"description\": \"Payee info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"companyNumber\": {\n \"type\": \"string\",\n \"description\": \"This element is used for both the identification of the Payee,\\nor the unique banking reference identifier of Payee (assigned by the Payee bank.)\\nFor payee identification use ICD code list, for SEPA bank assigned creditor reference, use SEPA.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"financialAccountId\": {\n \"type\": \"string\",\n \"description\": \"The name of the payment account, at a payment service provider, to which payment should be made.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"financialAccountName\": {\n \"type\": \"string\",\n \"description\": \"The name of the payment account, at a payment service provider, to which payment should be made.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"The name of the Payee.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nPayee info
\n{\n \"type\": \"object\",\n \"description\": \"Supplier info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Customer number in the suppliers system\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"contact\": {\n \"type\": \"object\",\n \"description\": \"Business contact\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Id of the business contact\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the business contact\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the business contact\",\n \"maxLength\": 300,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Phone number of the contact\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"companyNumber\": {\n \"type\": \"string\",\n \"description\": \"Company number of the supplier. CompanyNumber or VAT Number required for companies\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"department\": {\n \"type\": \"string\",\n \"description\": \"Department of the supplier\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the supplier\",\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"VAT number of the supplier. CompanyNumber or VAT Number required for companies\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"glnNumber\": {\n \"type\": \"string\",\n \"description\": \"Glnnumber of the supplier\",\n \"nullable\": true\n },\n \"endpointId\": {\n \"type\": \"string\",\n \"description\": \"EndpointId of the supplier\",\n \"nullable\": true\n },\n \"endpointType\": {\n \"type\": \"string\",\n \"description\": \"EndpointType of the supplier\",\n \"nullable\": true\n },\n \"taxpayersPrefix\": {\n \"type\": \"string\",\n \"description\": \"VAT UE country prefix (e.g. \\\"PL\\\") for intra-Community supplies, cross-border services, and triangular transactions.\",\n \"nullable\": true\n },\n \"identifications\": {\n \"type\": \"array\",\n \"description\": \"Additional identifiers for the party.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n }\n }\n }\n}\n\nSupplier info
\n{\n \"type\": \"object\",\n \"description\": \"Tax representative party\",\n \"additionalProperties\": false,\n \"properties\": {\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"The full name of the Seller's tax representative party.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"The VAT identifier of the Seller's tax representative party.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nTax representative party
\n{\n \"type\": \"object\",\n \"description\": \"Invoice totals\",\n \"additionalProperties\": false,\n \"required\": [\n \"amountExclVat\",\n \"amountInclVat\",\n \"vatAmount\"\n ],\n \"properties\": {\n \"amountExclVat\": {\n \"type\": \"number\",\n \"description\": \"The total amount of the Invoice without VAT. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\"\n },\n \"amountInclVat\": {\n \"type\": \"number\",\n \"description\": \"The total amount of the Invoice with VAT. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\"\n },\n \"lineExtensionAmount\": {\n \"type\": \"number\",\n \"description\": \"Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals.\\nIf not supplied this is calculated as the sum of the LineExtensionAmount on the detail lines\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"payableAmount\": {\n \"type\": \"number\",\n \"description\": \"The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals.\\nIf not filled in the TaxInclusiveAmount will be used\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"payableRoundingAmount\": {\n \"type\": \"number\",\n \"description\": \"The amount to be added to the invoice total to round the amount to be paid. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"prepaidAmount\": {\n \"type\": \"number\",\n \"description\": \"The sum of amounts which have been paid in advance. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"vatAmount\": {\n \"type\": \"number\",\n \"description\": \"The total VAT amount for the Invoice or the VAT total amount expressed in the accounting currency accepted or required in the country of the Seller. Must be rounded to maximum 2 decimals \",\n \"format\": \"decimal\"\n }\n }\n}\n\nInvoice totals
\n{\n \"type\": \"object\",\n \"description\": \"Discount info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"amount\": {\n \"type\": \"number\",\n \"description\": \"The discount amount. Optional\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"percentage\": {\n \"type\": \"number\",\n \"description\": \"The discount percentage. Optional\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"reason\": {\n \"type\": \"string\",\n \"description\": \"Reason for the discount\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"taxExemptionReason\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"taxExemptionReasonCode\": {\n \"type\": \"string\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nDiscount info
\n{\n \"type\": \"object\",\n \"description\": \"Charge info\",\n \"additionalProperties\": false,\n \"required\": [\n \"vatRate\"\n ],\n \"properties\": {\n \"amount\": {\n \"type\": \"number\",\n \"description\": \"The Charge amount\",\n \"format\": \"decimal\"\n },\n \"vatRate\": {\n \"type\": \"number\",\n \"description\": \"The charge vat rate\",\n \"format\": \"decimal\"\n },\n \"vatCode\": {\n \"type\": \"string\",\n \"description\": \"The VAT category code for the charge.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"reason\": {\n \"type\": \"string\",\n \"description\": \"Reason for the charge\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"taxExemptionReason\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"taxExemptionReasonCode\": {\n \"type\": \"string\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nCharge info
\n{\n \"type\": \"object\",\n \"description\": \"Class that holds an invoice detail line\",\n \"additionalProperties\": false,\n \"required\": [\n \"articleName\",\n \"lineExtensionAmount\",\n \"vatRate\",\n \"quantity\"\n ],\n \"properties\": {\n \"additionalItemProperties\": {\n \"type\": \"object\",\n \"description\": \"A group of business terms providing information about properties of the goods and services invoiced.\",\n \"nullable\": true,\n \"additionalProperties\": {\n \"type\": \"string\"\n }\n },\n \"articleName\": {\n \"type\": \"string\",\n \"description\": \"A name for an item.\",\n \"maxLength\": 2000,\n \"minLength\": 0\n },\n \"articleDescription\": {\n \"type\": \"string\",\n \"description\": \"A description for an item.The item description allows for describing the item and its features in more detail than the Item name.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"articleNumberBuyer\": {\n \"type\": \"string\",\n \"description\": \"An identifier, assigned by the Buyer, for the item.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"articleNumberSupplier\": {\n \"type\": \"string\",\n \"description\": \"An identifier, assigned by the Seller, for the item.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"lineExtensionAmount\": {\n \"type\": \"number\",\n \"description\": \"The total amount of the Invoice line. The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes.\\nMust be rounded to maximum 2 decimals.\\nIf not supplied, the AmountExclVat will be used\",\n \"format\": \"decimal\"\n },\n \"allowanceReason\": {\n \"type\": \"string\",\n \"description\": \"The reason for the allowance on this line, if there is an allowance.\",\n \"maxLength\": 1000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"allowanceAmount\": {\n \"type\": \"number\",\n \"description\": \"The allowance amount, if there is an allowance\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"chargeReason\": {\n \"type\": \"string\",\n \"description\": \"The reason for the charge on this line, if there is a charge.\",\n \"maxLength\": 1000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"chargeAmount\": {\n \"type\": \"number\",\n \"description\": \"The charge amount, if there is a charge\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"commodityClassificationCodes\": {\n \"type\": \"object\",\n \"description\": \"A code for classifying the item by its type or nature.\",\n \"nullable\": true,\n \"additionalProperties\": {\n \"type\": \"string\"\n }\n },\n \"deliveryDate\": {\n \"type\": \"string\",\n \"description\": \"Delivery date\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"deliveryNoteReference\": {\n \"type\": \"string\",\n \"description\": \"Delivery note reference\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"docRefDocType\": {\n \"type\": \"string\",\n \"description\": \"Code \\\"130\\\" MUST be used to indicate an invoice object reference. Not used for other additional documents\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"docRefId\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n },\n \"note\": {\n \"type\": \"string\",\n \"description\": \"A textual note that gives unstructured information that is relevant to the Invoice line.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"originCountryCode\": {\n \"type\": \"string\",\n \"description\": \"The code identifying the country from which the item originates.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"id\": {\n \"type\": \"string\",\n \"description\": \"A unique identifier for the individual line within the Invoice.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"accountingCost\": {\n \"type\": \"string\",\n \"description\": \"A textual value that specifies where to book the relevant data into the Buyer's financial accounts.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"startDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Invoice period for this Invoice line starts. Format =\\\"YYYY-MM-DD\\\"\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"endDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Invoice period for this Invoice line ends. Format =\\\"YYYY-MM-DD\\\"\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"exemptFromDiscount\": {\n \"type\": \"boolean\",\n \"description\": \"Set this flag to true to excempt this line from being included in the discount\"\n },\n \"vatCode\": {\n \"type\": \"string\",\n \"description\": \"The VAT category code for the invoiced item.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"vatRate\": {\n \"type\": \"number\",\n \"description\": \"The VAT rate, represented as percentage that applies to the invoiced item.\",\n \"format\": \"decimal\"\n },\n \"orderLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for a referenced line within a purchase order, issued by the Buyer.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"quantity\": {\n \"type\": \"number\",\n \"description\": \"The quantity of items (goods or services) that is charged in the Invoice line.\",\n \"format\": \"decimal\"\n },\n \"standardItemIdentification\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n },\n \"price\": {\n \"type\": \"object\",\n \"description\": \"A group of items related to the price of an invoiced item\",\n \"additionalProperties\": false,\n \"required\": [\n \"articlePrice\"\n ],\n \"properties\": {\n \"articlePrice\": {\n \"type\": \"number\",\n \"description\": \"The price of an item, exclusive of VAT, after subtracting item price discount.\\nThe Item net price has to be equal with the Item gross price less the Item price discount, if they are both provided.\\nItem price can not be negative.\",\n \"format\": \"decimal\"\n },\n \"baseQuantity\": {\n \"type\": \"number\",\n \"description\": \"The number of item units to which the price applies.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"unitOfMeasure\": {\n \"type\": \"string\",\n \"description\": \"The unit of measure that applies to the invoiced quantity.\\nCodes for unit of packaging from UNECE Recommendation No.\\n21 can be used in accordance with the descriptions in the \\\"Intro\\\" section of UN/ECE Recommendation 20, Revision 11 (2015):\\nThe 2 character alphanumeric code values in UNECE Recommendation 21 shall be used.\\nTo avoid duplication with existing code values in UNECE Recommendation No.\\n20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"allowanceAmount\": {\n \"type\": \"number\",\n \"description\": \"The total discount subtracted from the Item gross price to calculate the Item net price.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"allowanceBaseAmount\": {\n \"type\": \"number\",\n \"description\": \"The unit price, exclusive of VAT, before subtracting Item price discount, can not be negative\",\n \"format\": \"decimal\",\n \"nullable\": true\n }\n }\n },\n \"vatExemptionReason\": {\n \"type\": \"string\",\n \"description\": \"The VatExemptionReason\",\n \"nullable\": true\n },\n \"vatExemptionReasonCode\": {\n \"type\": \"string\",\n \"description\": \"The VatExemptionReasonCode\",\n \"nullable\": true\n },\n \"uuLineNumber\": {\n \"type\": \"string\",\n \"description\": \"Universal unique line number\\nShould be unique not only per invoice but per taxpayer or invoicing system\",\n \"nullable\": true\n },\n \"lineGTU\": {\n \"type\": \"string\",\n \"description\": \"Designation for the delivery of goods and the provision of services\",\n \"nullable\": true\n },\n \"lineDueDateTypeCode\": {\n \"type\": \"string\",\n \"description\": \"Code specifying the type of due date that applies to this Invoice line.\",\n \"nullable\": true\n },\n \"referencedDespatchDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the despatch advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedDespatchDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced despatch advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the invoice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced invoice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocTypeCode\": {\n \"type\": \"string\",\n \"description\": \"The document type code of the referenced invoice.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocIssueDate\": {\n \"type\": \"string\",\n \"description\": \"The issue date of the referenced invoice. Format = \\\"YYYY-MM-DD\\\"\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"referencedReceiptDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the receiving advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedReceiptDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced receiving advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedSalesOrderDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the sales order that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedSalesOrderDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced sales order that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"deliveryActualDeliveryDate\": {\n \"type\": \"string\",\n \"description\": \"The date on which the goods or services on this Invoice line were actually delivered. Format = \\\"YYYY-MM-DD\\\"\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"deliveryPartyName\": {\n \"type\": \"string\",\n \"description\": \"The name of the party that the goods or services on this Invoice line were delivered to.\",\n \"nullable\": true\n },\n \"deliveryLocationIDs\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationAddress1\": {\n \"type\": \"string\",\n \"description\": \"Street and street number of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationAddress2\": {\n \"type\": \"string\",\n \"description\": \"Additional address line of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationAddress3\": {\n \"type\": \"string\",\n \"description\": \"Additional address line of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationCity\": {\n \"type\": \"string\",\n \"description\": \"City of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationZIP\": {\n \"type\": \"string\",\n \"description\": \"Postal code of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationCountrySubEntity\": {\n \"type\": \"string\",\n \"description\": \"Province, state or region of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationCountryCode\": {\n \"type\": \"string\",\n \"description\": \"The country of the delivery location of this Invoice line, as an ISO 3166-1 alpha-2 code.\",\n \"nullable\": true\n }\n }\n}\n\nClass that holds an invoice detail line
\n{\n \"type\": \"object\",\n \"description\": \"Buyer info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Full legal name of the buyer\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"glnNumber\": {\n \"type\": \"string\",\n \"description\": \"Global Location Number of the buyer\",\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"VAT number of the buyer\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"contact\": {\n \"type\": \"object\",\n \"description\": \"Business contact\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Id of the business contact\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the business contact\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the business contact\",\n \"maxLength\": 300,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Phone number of the contact\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"recipientType\": {\n \"type\": \"string\",\n \"description\": \"Type of the buyer\\nPossible values:\\n12: JST Recipient\\n21: GV Recipient\",\n \"nullable\": true\n }\n }\n}\n\nBuyer info
\n{\n \"type\": \"object\",\n \"description\": \"Represents an exchange rate used for tax calculations between different currencies.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"sourceCurrencyCode\": {\n \"type\": \"string\",\n \"description\": \"ISO currency code representing the source currency for the transaction.\",\n \"nullable\": true\n },\n \"targetCurrencyCode\": {\n \"type\": \"string\",\n \"description\": \"ISO currency code representing the target currency for conversion or display.\",\n \"nullable\": true\n },\n \"calculationRate\": {\n \"type\": \"number\",\n \"description\": \"Exchange rate.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"mathematicOperatorCode\": {\n \"type\": \"string\",\n \"description\": \"Mathematical operator used in calculations. Default is \\\"Multiply\\\".\",\n \"nullable\": true\n },\n \"date\": {\n \"type\": \"string\",\n \"description\": \"Date for the calculation rate.\",\n \"format\": \"date-time\",\n \"nullable\": true\n }\n }\n}\n\nRepresents an exchange rate used for tax calculations between different currencies.
\n{\n \"type\": \"object\",\n \"description\": \"Processing\",\n \"additionalProperties\": false,\n \"properties\": {\n \"deliveryMethod\": {\n \"type\": \"string\",\n \"description\": \"Channel that has to be used to send to invoice to the receiver.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraCode1\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraCode2\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraCode3\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraCode4\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraCode5\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraCode6\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraCode7\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraCode8\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraCode9\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraCode10\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraInfo\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 500,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"senderPartyEntity\": {\n \"type\": \"string\",\n \"description\": \"ComFin contract number if ComFin customer\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"messageType\": {\n \"type\": \"string\",\n \"description\": \"Message type to use for the xml, default EFFF\",\n \"nullable\": true\n }\n }\n}\n\nProcessing
\n{\n \"type\": \"object\",\n \"description\": \"An attachment\",\n \"additionalProperties\": false,\n \"properties\": {\n \"embedded\": {\n \"type\": \"boolean\",\n \"description\": \"Is it an embedded file?\"\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"name of the file\\nIf it isn't an embedded file, it should be included as multipart file-data. The name of the file should be identical.\",\n \"nullable\": true\n },\n \"mimeType\": {\n \"type\": \"string\",\n \"description\": \"mime type of the file\",\n \"nullable\": true\n },\n \"value\": {\n \"type\": \"string\",\n \"description\": \"a base64 (embedded)\",\n \"nullable\": true\n }\n }\n}\n\nAn attachment
\n{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n }\n }\n}\n\n{\n \"type\": \"object\",\n \"description\": \"Response when an object is marked as downloaded\",\n \"additionalProperties\": false,\n \"properties\": {\n \"message\": {\n \"type\": \"string\",\n \"description\": \"Informational message\",\n \"nullable\": true\n }\n }\n}\n\nResponse when an object is marked as downloaded
\n{\n \"isOnPeppol\": \"(boolean) Indicates if the participant is registered on the Peppol network. Example: true\",\n \"receivingInvoices\": \"(boolean) Indicates if the participant can receive invoices via Peppol. Example: true\",\n \"services\": [\n {\n \"participantId\": \"(string) The Peppol participant identifier (schemeId + identifier). Example: 0208:be2929035935\",\n \"documentTypeId\": \"(string) The document type identifier supported. Example: urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##peppol-EN16931::2.1\",\n \"endpointAddress\": \"(string) The endpoint address (URL) where documents can be delivered. Example: https://peppol.codabox.com/peppol/as4\"\n },\n {\n \"participantId\": \"(string) Example: 0192:987654321\",\n \"documentTypeId\": \"(string) Example: urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##peppol-EN16931::2.1\",\n \"endpointAddress\": \"(string) Example: https://peppol.codabox.com/peppol/as4\"\n }\n ]\n}\n\nStatus of a participant on peppol
\n{\n \"type\": \"object\",\n \"description\": \"A service on peppol\",\n \"additionalProperties\": false,\n \"properties\": {\n \"participantId\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"documentTypeId\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"endpointAddress\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n}\n\nA service on peppol
\nx-api-key
\n","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//inbound/companies","description":"Returns all companies in the current tenant that your API key has access to.
\nThe id of each company is its PartyId. Every other request in this API is made for one company and takes this value as {partyId} in the URL.
Usage
\nResponses
\n200 OK: the companies your API key has access to.401 Unauthorized: the API key is missing or not valid.x-api-key
\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//inbound/companies/{{partyId}}","description":"Returns a single company of the current tenant.
\nUsage
\npartyId is the id returned by GET /inbound/companies.id in the response is the same PartyId: use it as {partyId} in all other requests.Responses
\n200 OK: the company.404 Not Found: there is no company with this PartyId that your API key has access to.401 Unauthorized: the API key is missing or not valid.x-api-key
\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//inbound/companies/{{partyId}}/invoices/{{id}}","description":"Returns all details of a received invoice: header, supplier, customer, totals, detail lines, payment information and references.
\nUsage
\nid is the id of the invoice from the inbox, the invoice search, or the id returned when it was uploaded.Responses
\n200 OK: the invoice.404 Not Found: unknown PartyId or invoice.401 Unauthorized: the API key is missing or not valid.x-api-key
\n"},{"key":"Accept","value":"application/octet-stream"}],"url":"https://api.soluz.io//inbound/companies/{{partyId}}/invoices/{{id}}/{{format}}","description":"Downloads one or more files of a received invoice.
\nUsage\nformat selects the files:
ubl: the UBL invoice (XML).pdf or image: the PDF of the invoice.attachments: all additional attachments.ublandimage: the UBL and the PDF.all: the UBL, the PDF and all attachments.xml: the files in the XML package of the invoice.When one file matches, it is returned as is (for example a PDF or XML). When several files match, they are returned together in one ZIP file.
\nResponses
\n200 OK: the file, or a ZIP file with the matching files.404 Not Found: unknown PartyId or invoice, or no file matches format.401 Unauthorized: the API key is missing or not valid.x-api-key
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"invoicedate-from\": \"(string,date) The start date for the invoice date range. Example: 2023-11-01\",\n\t\"invoicedate-to\": \"(string,date) The end date for the invoice date range. Example: 2023-11-30\",\n\t\"invoiceNumber\": \"(string) The invoice number. Example: 23110000291\",\n\t\"objectId\": \"(string) Object id of the document. Used in GetInvoice to get the details of this invoice. Example: 4728\",\n\t\"uniqueId\": \"(string) Unique id of the document. Example: 1095953\",\n\t\"page\": {\n\t\t\"page-number\": \"(number) Page number. Example: 2\",\n\t\t\"records-per-page\": \"(number) Amount of records per page. Example: 25\"\n\t},\n\t\"status\": \"(string) Filter on status. Example: PENDING\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.soluz.io//inbound/companies/{{partyId}}/invoices/search","description":"Searches the received invoices of the company and returns one page of results.
\nUsage
\ninvoicedate-from and invoicedate-to are required. Only invoices with an invoice date in this range (both dates included) are returned. Format: YYYY-MM-DD.invoiceNumber (exact match), objectId and uniqueId. All filled-in filters must match.page: page-number starts at 1. records-per-page defaults to 20 and is capped at 100. Use totalPages in the response to fetch the next pages.id of a result for all details.Responses
\n200 OK: the current page, the number of totalPages and the matching invoices.400 Bad Request: the request body is missing or not valid, for example without the invoice date range.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.x-api-key
\n"},{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"Xml","type":"file","description":"UBL as XML file (optional)
\n","value":""},{"key":"Image","type":"file","description":"Invoice as PDF file (optional)
\n","value":""},{"key":"Attachments","value":"string,string","type":"text","description":"Optional additional attachments
\n"}]},"url":"https://api.soluz.io//inbound/companies/{{partyId}}/invoices/multipart","description":"Uploads a received invoice with its files into the inbound flow of the company, for example an invoice that did not arrive through Peppol.
\nUsage\nSend the request as multipart/form-data, with either:
application/xml, optionally a PDF (application/pdf) and any number of additional attachments. The invoice is processed from the UBL. In Postman, add the files in the Body tab as form-data fields of type File.UploadInvoiceRequest as a part with content type application/json, plus the files it references. For each referenced file, set embedded to false and use the multipart file name as name.To send everything as JSON with embedded (base64) files, use POST /inbound/companies/{partyId}/invoices instead.
\nResponses
\n201 Created: the invoice was uploaded. Use the returned id in GET /inbound/companies/{partyId}/invoices/{id}.400 Bad Request: the request or one of its files is not valid.404 Not Found: unknown PartyId.406 Not Acceptable: the content could not be accepted.401 Unauthorized: the API key is missing or not valid.x-api-key
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"details\": {\n\t\t\"documentNumber\": \"(string) A unique identification of the invoice within the business context, time-frame, operating systems and records of the sender. Max 200 chars. Example: DEMO/00092\",\n\t\t\"invoiceNumber\": \"(string) Invoice number as shown on the document. Max 200 chars. Example: 23110000291\",\n\t\t\"currency\": \"(string, required) ISO 4217 currency code. Example: EUR\",\n\t\t\"date\": \"(string, required, date) Invoice issue date (YYYY-MM-DD). Example: 2022-12-02\",\n\t\t\"dueDate\": \"(string, date) Due date for payment (YYYY-MM-DD). In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present. Example: 2023-12-07\",\n\t\t\"note\": \"(string) A textual note that gives unstructured information that is relevant to the invoice as a whole, such as the reason for any correction or an assignment note in case the invoice has been factored. Max 2000 chars. Example: Note van de factuur\",\n\t\t\"structuredCommunication\": \"(string) A textual value used to establish a link between the payment and the Invoice, issued by the Seller. Used for creditor's critical reconciliation information. This information element helps the Seller to assign an incoming payment to the relevant payment process. Max 2000 chars. Example: +++123/569858/336+++\",\n\t\t\"type\": \"(string, required) Document type: Invoice, CreditNote. Example: Invoice\",\n\t\t\"typeCode\": \"(string) Document type code (e.g. 380=Invoice, 381=CreditNote). Max 100 chars. Example: 380\",\n\t\t\"serviceBeginDate\": \"(string, date) Service period start (YYYY-MM-DD). Example: 2022-12-01\",\n\t\t\"serviceEndDate\": \"(string, date) Service period end (YYYY-MM-DD). Example: 2022-12-31\",\n\t\t\"taxPointDate\": \"(string, date) The date when the VAT becomes accountable for the Seller and for the Buyer, when that date differs from the invoice issue date (YYYY-MM-DD). Example: 2022-12-22\",\n\t\t\"placeOfIssue\": \"(string) Place where the invoice was issued. Max 2000 chars. Example: Mechelen\",\n\t\t\"fullyPaid\": \"(boolean) Indicates if an invoice has been paid. Defaults to false. Example: false\",\n\t\t\"dateOfFullPayment\": \"(string, date-time) Date of payment, when payment was already made at the time the invoice was issued. Example: 2022-12-02T00:00:00\",\n\t\t\"simplifiedTriangularProcedure\": \"(boolean) Indicates a simplified triangular transaction, issued by the second taxpayer in the sequence. Defaults to false. Example: false\",\n\t\t\"checkoutMethod\": \"(boolean) Cash accounting indicator. Defaults to false. Example: false\",\n\t\t\"selfBillingIndicator\": \"(boolean) Self-billing indicator. Defaults to false. Example: false\",\n\t\t\"warehouseDocumentNumbers\": \"(string) WZ (delivery note) document numbers. Example: WZ/2023/114\",\n\t\t\"typeName\": \"(string) Invoice type name. Example: Commercial invoice\",\n\t\t\"restrictedInformation\": \"(boolean) Indicator if Invoice referred to in Art. 109 sec. 3d of the Act. Defaults to false. Example: false\",\n\t\t\"invoicePeriodDescriptionCode\": \"(string) Code describing the invoice or billing period. Typical uses include month, quarter or custom period codes. Max 50 chars. Example: 3\",\n\t\t\"deliveryTermsId\": \"(string) Identifier for the delivery terms applicable to this invoice. Max 200 chars. Example: CIF\",\n\t\t\"deliveryTermsDeliveryLocationName\": \"(string) Human-readable name of the delivery location associated with the delivery terms. Max 200 chars. Example: Antwerpen\",\n\t\t\"contractDocReferenceTypeCode\": \"(string) Code indicating the type of contract or document reference associated with the invoice. Max 100 chars. Example: 1\",\n\t\t\"references\": {\n\t\t\t\"accountingCost\": \"(string) Buyer accounting reference Cost center or internal accounting code. A textual value that specifies where to book the relevant data into the Buyer's financial accounts. Example: 4217:2323:2323\",\n\t\t\t\"billingReferences\": [\n\t\t\t\t{\n\t\t\t\t\t\"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n\t\t\t\t\t\"invoiceDocumentReferenceIssueDate\": \"(DateTime) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n\t\t\t\t\t\"reasonForCorrection\": \"(string) Reason for correction\",\n\t\t\t\t\t\"externalReference\": \"(string) Number identifying the corrected invoice in the National System of e-Invoices\",\n\t\t\t\t\t\"typeOfCorrection\": \"(string) Type of correction\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"buyerReference\": \"(string) Buyer reference or procurement ID. An invoice must have buyer reference or purchase order reference (BT-13) Example: ABC/984/B2\",\n\t\t\t\"purchaseOrderReference\": \"(string) Purchase order number. An invoice must have buyer reference (BT-10) or purchase order reference Example: OR1256\",\n\t\t\t\"contractDocReference\": \"(string) Contract identifier by seller. Example: CT-2022-001\",\n\t\t\t\"contractDocIssueDate\": \"(string, date) Contract date by seller (YYYY-MM-DD). Example: 2022-01-15\",\n\t\t\t\"contractDocReferenceCustomer\": \"(string) Contract identifier by customer. Example: CUST-CT-88\",\n\t\t\t\"contractDocIssueDateCustomer\": \"(string, date) Contract date by customer (YYYY-MM-DD). Example: 2022-01-20\",\n\t\t\t\"despatchDocReference\": \"(string) Dispatch advice ID. Example: DESP-993\",\n\t\t\t\"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n\t\t\t\"invoiceDocumentReferenceIssueDate\": \"(DateTime) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n\t\t\t\"originatorDocReference\": \"(string) Tender or lot reference. Example: TND-2022-01\",\n\t\t\t\"projectReference\": \"(string) Project reference. Example: PROJ-Delta-01\",\n\t\t\t\"receiptDocReference\": \"(string) Receiving advice ID. Example: RCPT-331\",\n\t\t\t\"salesOrderReference\": \"(string) Seller's sales order ID. Example: SO-10099\",\n\t\t\t\"salesOrderIssueDate\": \"(string, date) Sales order date (YYYY-MM-DD). Example: 2022-05-18\"\n\t\t},\n\t\t\"customer\": {\n\t\t\t\"id\": \"(string) Internal customer ID in sender's system. Max 100 chars. Example: CUST1\",\n\t\t\t\"name\": \"(string, required) Customer name, the company receiving the invoice. Max 200 chars. Example: Soluz.io\",\n\t\t\t\"address\": {\n\t\t\t\t\"address1\": \"(string, required) Street and number. Example: Zwartzustersvest 24\",\n\t\t\t\t\"address2\": \"(string) Address line 2. Example: Unit 5\",\n\t\t\t\t\"address3\": \"(string) Address line 3. Example: c/o Accounts\",\n\t\t\t\t\"city\": \"(string, required) City. Example: Mechelen\",\n\t\t\t\t\"zip\": \"(string, required) Postal code. Example: 2810\",\n\t\t\t\t\"countryCode\": \"(string, required) ISO 3166-1 alpha-2 country code. Example: BE\",\n\t\t\t\t\"province\": \"(string) State/Province/Region. Example: Antwerpen\"\n\t\t\t},\n\t\t\t\"contact\": {\n\t\t\t\t\"name\": \"(string) Contact person. Example: Jan Peeters\",\n\t\t\t\t\"email\": \"(string) Contact email. Example: jan@soluz.io\",\n\t\t\t\t\"phone\": \"(string) Contact phone. Example: +3215999888\"\n\t\t\t},\n\t\t\t\"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). CompanyNumber or VAT number is required for companies. Max 200 chars. Example: 0123456749\",\n\t\t\t\"department\": \"(string) Department or branch. Max 200 chars. Example: DevelopmentDepartment\",\n\t\t\t\"vatNumber\": \"(string) Customer VAT number. CompanyNumber or VAT number is required for companies. Max 200 chars. Example: BE0123456749\",\n\t\t\t\"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n\t\t\t\"endpointId\": \"(string) Electronic endpoint identifier. Example: BE2929035935\",\n\t\t\t\"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 9925\",\n\t\t\t\"identifications\": [\n\t\t\t\t{\n\t\t\t\t\t\"id\": \"(string, required) Identifier value. Max 200 chars. Example: 0123456749\",\n\t\t\t\t\t\"schemeId\": \"(string, required) Identifier scheme, using the ICD code list. Max 10 chars. Example: 0208\"\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"delivery\": {\n\t\t\t\"actualDeliveryDate\": \"(string, date) Delivery date (YYYY-MM-DD). Example: 2023-01-03\",\n\t\t\t\"address\": {\n\t\t\t\t\"address1\": \"(string)(required in case address is filled) Street and number. Example: Berendries 52\",\n\t\t\t\t\"address2\": \"(string) Example: Building A\",\n\t\t\t\t\"address3\": \"(string) Example: Floor 2\",\n\t\t\t\t\"city\": \"(string) City. Example: Lovendegem\",\n\t\t\t\t\"zip\": \"(string) Postal code. Example: 5400\",\n\t\t\t\t\"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n\t\t\t\t\"province\": \"(string) Province/region. Example: O-Vl\"\n\t\t\t},\n\t\t\t\"name\": \"(string) Receiver name or delivery contact. Example: Soluz.io afleveradres\",\n\t\t\t\"locationIdentifier\": {\n\t\t\t\t\"id\": \"(string) Location identifier (GLN or other). Example: 5412345000013\",\n\t\t\t\t\"schemeId\": \"(string) Scheme ID for location. Example: 0088\"\n\t\t\t}\n\t\t},\n\t\t\"paymentMeans\": {\n\t\t\t\"code\": \"(string) The means, expressed as code, for how a payment is expected to be or has been settled. (e.g., UN/CEFACT 4461). Example: ZZZ\",\n\t\t\t\"text\": \"(string) Description of payment means. Example: Bank transfer\",\n\t\t\t\"mandateId\": \"(string) Unique identifier assigned by the Payee for referencing the direct debit mandate. Used in order to pre-notify the Buyer of a SEPA direct debit. Example: MandateId\",\n\t\t\t\"mandateFinancialAccountId\": \"(string) The account to be debited by the direct debit. Example: MandateFinancialAccountId\",\n\t\t\t\"paymentId\": \"(string) Payment reference to be used by the payer. Example: PMT-2023-001\",\n\t\t\t\"payeeFinancialInstitutionId\": \"(string) Identifier of Payee's bank (BIC, etc.). Example: KREDBEBB\",\n\t\t\t\"payeeFinancialAccountId\": \"(string) Payee's bank account (IBAN, etc.). Example: BE49000023121121\",\n\t\t\t\"payeeFinancialAccountSchemeId\": \"(string) Scheme ID of Payee's bank account (e.g. IBAN). Example: IBAN\",\n\t\t\t\"payeeFinancialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\"\n\t\t},\n\t\t\"multiplePaymentMeans\": [\n\t\t\t{\n\t\t\t\t\"code\": \"(string) The means, expressed as code, for how a payment is expected to be or has been settled. (e.g., UN/CEFACT 4461). Example: ZZZ\",\n\t\t\t\t\"text\": \"(string) Description of payment means. Example: Bank transfer\",\n\t\t\t\t\"mandateId\": \"(string) Unique identifier assigned by the Payee for referencing the direct debit mandate. Example: MandateId\",\n\t\t\t\t\"mandateFinancialAccountId\": \"(string) The account to be debited by the direct debit. Example: MandateFinancialAccountId\",\n\t\t\t\t\"paymentId\": \"(string) Payment reference to be used by the payer. Example: PMT-2023-001\",\n\t\t\t\t\"payeeFinancialInstitutionId\": \"(string) Identifier of Payee's bank (BIC, etc.). Example: KREDBEBB\",\n\t\t\t\t\"payeeFinancialAccountId\": \"(string) Payee's bank account (IBAN, etc.). Example: BE49000023121121\",\n\t\t\t\t\"payeeFinancialAccountSchemeId\": \"(string) Scheme ID of Payee's bank account (e.g. IBAN). Example: IBAN\",\n\t\t\t\t\"payeeFinancialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\"\n\t\t\t}\n\t\t],\n\t\t\"payee\": {\n\t\t\t\"companyNumber\": \"(string) This element is used for both the identification of the Payee, or the unique banking reference identifier of Payee (assigned by the Payee bank.) For payee identification use ICD code list, for SEPA bank assigned creditor reference, use SEPA. Example: BE0123456749\",\n\t\t\t\"financialAccountId\": \"(string) Payee's IBAN. Example: BE49000023121121\",\n\t\t\t\"financialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\",\n\t\t\t\"name\": \"(string) Name of payee. Example: PayeeName\"\n\t\t},\n\t\t\"paymentTerms\": {\n\t\t\t\"text\": \"(string) A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties). Example: Payment in 30 days\",\n\t\t\t\"settlementDiscountPercentage\": \"(number) Early payment discount percentage. If not filled in but SettlementDiscountAmount is, this value will be calculated based on SettlementDiscountAmount. Example: 2\",\n\t\t\t\"settlementDiscountAmount\": \"(number) Early payment discount absolute amount. If not filled in but SettlementDiscountPercentage is, this value will be calculated based on SettlementDiscountPercentage. Example: 50.00\"\n\t\t},\n\t\t\"supplier\": {\n\t\t\t\"id\": \"(string) Internal supplier ID in sender's system. Example: SUP1\",\n\t\t\t\"name\": \"(string, required) Supplier name, the party that issued the invoice. Example: PANDAVA nv/sa\",\n\t\t\t\"address\": {\n\t\t\t\t\"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n\t\t\t\t\"address2\": \"(string) Example: Tax 1\",\n\t\t\t\t\"address3\": \"(string) Example: Tax 3\",\n\t\t\t\t\"city\": \"(string) City. Example: Tax Mechelen\",\n\t\t\t\t\"zip\": \"(string) Postal code. Example: Tax 2800\",\n\t\t\t\t\"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n\t\t\t\t\"province\": \"(string) Province. Example: Vl-Br\",\n\t\t\t\t\"taxpayersPrefix\": \"(string) VAT UE country prefix (e.g. PL) for intra-Community supplies, cross-border services, and triangular transactions.\"\n\t\t\t},\n\t\t\t\"contact\": {\n\t\t\t\t\"name\": \"(string) Contact person. Example: Jan Peeters\",\n\t\t\t\t\"email\": \"(string) Contact email. Example: jan@soluz.io\",\n\t\t\t\t\"phone\": \"(string) Contact phone. Example: +3215999888\"\n\t\t\t},\n\t\t\t\"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n\t\t\t\"department\": \"(string) Department or branch. Example: DevelopmentDepartment\",\n\t\t\t\"vatNumber\": \"(string) Supplier VAT number. Example: BE0419001396\",\n\t\t\t\"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n\t\t\t\"endpointId\": \"(string) Electronic endpoint identifier. Example: BE2929035935\",\n\t\t\t\"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 9925\"\n\t\t},\n\t\t\"buyer\": {\n\t\t\t\"name\": \"(string) Buyer name. Example: Soluz.io\",\n\t\t\t\"address\": {\n\t\t\t\t\"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n\t\t\t\t\"zip\": \"(string) Postal code. Example: Tax 2800\",\n\t\t\t\t\"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n\t\t\t\t\"province\": \"(string) Province. Example: Vl-Br\"\n\t\t\t},\n\t\t\t\"contact\": {\n\t\t\t\t\"name\": \"(string) Contact person. Example: Jan Peeters\",\n\t\t\t\t\"email\": \"(string) Contact email. Example: jan@soluz.io\",\n\t\t\t\t\"phone\": \"(string) Contact phone. Example: +3215999888\"\n\t\t\t},\n\t\t\t\"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n\t\t\t\"companyNumberType\": \"(string) Company number type\",\n\t\t\t\"vatNumber\": \"(string) Buyer VAT number. Example: BE0123456749\",\n\t\t\t\"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n\t\t\t\"recipientType\": \"(string) Flag to indicate Subordinate Local Government Unit or GV member\"\n\t\t},\n\t\t\"parties\": [\n\t\t\t{\n\t\t\t\t\"partyName\": \"(string) Name of the party. Example: VERVOER BVBA\",\n\t\t\t\t\"name\": \"(string) Name of the party. Example: VERVOER BVBA\",\n\t\t\t\t\"roleCode\": \"(string) Code identifying the role that this party takes on the invoice. Example: DEL\",\n\t\t\t\t\"endpointID\": \"(string) Electronic endpoint identifier of the party. Example: BE2929035935\",\n\t\t\t\t\"endpointIDType\": \"(string) Endpoint type or scheme which relates to the endpointID. Example: 9925\",\n\t\t\t\t\"identifiers\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"id\": \"(string, required) Identifier value. Max 200 chars. Example: 0123456749\",\n\t\t\t\t\t\t\"schemeId\": \"(string, required) Identifier scheme, using the ICD code list. Max 10 chars. Example: 0208\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"address1\": \"(string) Street and street number of the party. Example: Lage Weg 123 A\",\n\t\t\t\t\"address2\": \"(string) Additional address line of the party. Example: Building A\",\n\t\t\t\t\"address3\": \"(string) Additional address line of the party. Example: Floor 2\",\n\t\t\t\t\"city\": \"(string) City of the party. Example: Hoevenen-Stabroek\",\n\t\t\t\t\"zip\": \"(string) Postal code of the party. Example: 2940\",\n\t\t\t\t\"countryCode\": \"(string) Country of the party, ISO 3166-1 alpha-2. Example: BE\",\n\t\t\t\t\"countryName\": \"(string) Country name of the party. Example: Belgium\",\n\t\t\t\t\"countrySubEntity\": \"(string) Province, state or region of the party. Example: Antwerpen\",\n\t\t\t\t\"vatNumber\": \"(string) VAT number of the party. Example: BE0419001396\",\n\t\t\t\t\"contactID\": \"(string) Identifier for the contact of the party. Example: CNT-1\",\n\t\t\t\t\"contactName\": \"(string) Contact person of the party. Example: Jan Peeters\",\n\t\t\t\t\"contactEmail\": \"(string) Contact email of the party. Example: jan@soluz.io\",\n\t\t\t\t\"contactPhone\": \"(string) Contact phone of the party. Example: +3215999888\",\n\t\t\t\t\"partyLERegistrationName\": \"(string) Registered legal entity name of the party. Example: PANDAVA nv/sa\",\n\t\t\t\t\"partyLECompanyID\": \"(string) Legal entity company identifier of the party (e.g. Belgium CBE/KBO). Example: 0419001396\",\n\t\t\t\t\"partyLECompanyIDType\": \"(string) Scheme of the legal entity company identifier, using the ICD code list. Example: 0208\",\n\t\t\t\t\"partyLECompanyLegalForm\": \"(string) Legal form of the legal entity. Example: NV\",\n\t\t\t\t\"recipientType\": \"(string) Flag to indicate Subordinate Local Government Unit or GV member\"\n\t\t\t}\n\t\t],\n\t\t\"taxRepresentative\": {\n\t\t\t\"address\": {\n\t\t\t\t\"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n\t\t\t\t\"address2\": \"(string) Example: Tax 1\",\n\t\t\t\t\"address3\": \"(string) Example: Tax 3\",\n\t\t\t\t\"city\": \"(string) City. Example: Tax Mechelen\",\n\t\t\t\t\"zip\": \"(string) Postal code. Example: Tax 2800\",\n\t\t\t\t\"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n\t\t\t\t\"province\": \"(string) Province. Example: Vl-Br\"\n\t\t\t},\n\t\t\t\"name\": \"(string) Tax representative name. Example: Tax Soluz.io\",\n\t\t\t\"vatNumber\": \"(string) VAT number. Example: BE000000097\"\n\t\t},\n\t\t\"taxExchangeRate\": {\n\t\t\t\"sourceCurrencyCode\": \"(string) ISO 4217 code of the source currency. Example: USD\",\n\t\t\t\"targetCurrencyCode\": \"(string) ISO 4217 code of the target currency. Example: EUR\",\n\t\t\t\"calculationRate\": \"(number) Exchange rate. Example: 0.92\",\n\t\t\t\"mathematicOperatorCode\": \"(string) Mathematical operator used in the calculation. Defaults to Multiply. Example: Multiply\",\n\t\t\t\"date\": \"(string, date-time) Date the calculation rate applies to. Example: 2022-12-02T00:00:00\"\n\t\t},\n\t\t\"discount\": {\n\t\t\t\"amount\": \"(number) The discount amount. If not filled in but Percentage is, this value will be calculated based on Percentage. Example: 50\",\n\t\t\t\"percentage\": \"(number) The discount percentage. If not filled in but Amount is, this value will be calculated based on Amount. Example: 10\",\n\t\t\t\"reason\": \"(string) Reason for discount. Example: extra korting van 10%\"\n\t\t},\n\t\t\"charge\": {\n\t\t\t\"amount\": \"(number) Additional charge excl. VAT. Example: 10\",\n\t\t\t\"vatRate\": \"(number) VAT rate on charge. Example: 21\",\n\t\t\t\"vatCode\": \"(string) VAT category code for charge. Example: S\",\n\t\t\t\"reason\": \"(string) Reason for charge. Example: Handling fee\"\n\t\t},\n\t\t\"totals\": {\n\t\t\t\"amountExclVat\": \"(number) The total amount of the Invoice without VAT. Must be rounded to maximum 2 decimals. Example: 297.00\",\n\t\t\t\"vatAmount\": \"(number) The total VAT amount for the Invoice or the VAT total amount expressed in the accounting currency accepted or required in the country of the Seller. Must be rounded to maximum 2 decimals. Example: 38.07\",\n\t\t\t\"amountInclVat\": \"(number) The total amount of the Invoice with VAT. Must be rounded to maximum 2 decimals. Example: 335.07\",\n\t\t\t\"lineExtensionAmount\": \"(number) Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals. If not supplied this is calculated as the sum of the LineExtensionAmount on the detail lines. Example: 297.00\",\n\t\t\t\"payableAmount\": \"(number) The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals. If not filled in the TaxInclusiveAmount will be used. Example: 335.07\",\n\t\t\t\"payableRoundingAmount\": \"(number) The amount to be added to the invoice total to round the amount to be paid. Must be rounded to maximum 2 decimals. Example: 0.00\",\n\t\t\t\"prepaidAmount\": \"(number) The sum of amounts which have been paid in advance. Must be rounded to maximum 2 decimals. Example: 0.00\"\n\t\t},\n\t\t\"vatSubTotals\": [\n\t\t\t{\n\t\t\t\t\"code\": \"(string) VAT category code. Example: S\",\n\t\t\t\t\"rate\": \"(number) VAT rate. Example: 21.00\",\n\t\t\t\t\"exemptionReason\": \"(string) Reason for VAT exemption. Example: Intra-community supply\",\n\t\t\t\t\"exemptionReasonCode\": \"(string) Code for VAT exemption reason. Example: K\",\n\t\t\t\t\"taxableAmount\": \"(number) Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable). Must be rounded to maximum 2 decimals. Example: 109.41\",\n\t\t\t\t\"taxAmount\": \"(number) The total VAT amount for a given VAT category. Must be rounded to maximum 2 decimals. Example: 22.98\",\n\t\t\t\t\"taxTypeIndicator\": \"(string) Additonal Tax Category for non-standard rate\",\n\t\t\t\t\"splitPaymentIndicator\": \"(string) Split payment indicator\"\n\t\t\t}\n\t\t],\n\t\t\"detailLines\": [\n\t\t\t{\n\t\t\t\t\"id\": \"(string) Unique line ID. Max 100 chars. Example: 1\",\n\t\t\t\t\"quantity\": \"(number, required) Quantity invoiced. Example: 3\",\n\t\t\t\t\"articleName\": \"(string, required) Item name. Max 2000 chars. Example: Agenda Timing 2024\",\n\t\t\t\t\"accountingCost\": \"(string) A textual value that specifies where to book the relevant data into the Buyer's financial accounts. Max 100 chars. Example: 700100\",\n\t\t\t\t\"additionalItemProperties\": \"(object) Additional properties of the goods/services. Example: { \\\"color\\\": \\\"blue\\\" }\",\n\t\t\t\t\"allowanceReason\": \"(string) The reason for the allowance on this line, if there is an allowance, expressed as text. Max 1000 chars. Example: Promotion\",\n\t\t\t\t\"allowanceAmount\": \"(number) The allowance amount, if there is an allowance. Example: 1.00\",\n\t\t\t\t\"chargeReason\": \"(string) The reason for the charge on this line, if there is a charge, expressed as text. Max 1000 chars. Example: Handling fee\",\n\t\t\t\t\"chargeAmount\": \"(number) The charge amount, if there is a charge. Example: 1.00\",\n\t\t\t\t\"commodityClassificationCodes\": \"(object) Classification codes (e.g. UNSPSC, CPV, etc.). Example: { \\\"UNSPSC\\\": \\\"44121706\\\" }\",\n\t\t\t\t\"articleDescription\": \"(string) Item description. Max 2000 chars. Example: Black hard cover\",\n\t\t\t\t\"articleNumberBuyer\": \"(string) Buyer's item code. Max 2000 chars. Example: ITM-001\",\n\t\t\t\t\"articleNumberSupplier\": \"(string) Supplier's item code. Max 200 chars. Example: SUP-7788\",\n\t\t\t\t\"lineExtensionAmount\": \"(number, required) The total amount of the Invoice line. The amount is \\\"net\\\" without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes. Must be rounded to maximum 2 decimals. Example: 150.00\",\n\t\t\t\t\"vatRate\": \"(number, required) VAT rate percentage. Example: 21\",\n\t\t\t\t\"vatCode\": \"(string) VAT category code. Max 200 chars. Example: S\",\n\t\t\t\t\"orderLineId\": \"(string) Reference to buyer's order line. Max 200 chars. Example: 1000\",\n\t\t\t\t\"note\": \"(string) A textual note that gives unstructured information that is relevant to the Invoice line. Max 2000 chars. Example: Delivered in January\",\n\t\t\t\t\"startDate\": \"(string, date) The date when the invoice period for this line starts (YYYY-MM-DD). Example: 2023-11-01\",\n\t\t\t\t\"endDate\": \"(string, date) The date when the invoice period for this line ends (YYYY-MM-DD). Example: 2023-11-30\",\n\t\t\t\t\"exemptFromDiscount\": \"(boolean) Set to true to exclude this line from the document level discount. Defaults to false. Example: false\",\n\t\t\t\t\"deliveryDate\": \"(string, date) Date of delivery for line (YYYY-MM-DD). Example: 2023-01-03\",\n\t\t\t\t\"deliveryNoteReference\": \"(string) Reference to delivery note. Max 2000 chars. Example: DN-12345\",\n\t\t\t\t\"docRefDocType\": \"(string) Type of referenced document (code 130 = invoice object reference). Max 2000 chars. Example: 130\",\n\t\t\t\t\"docRefId\": {\n\t\t\t\t\t\"id\": \"(string, required) Identifier of referenced object. Max 200 chars. Example: 998877\",\n\t\t\t\t\t\"schemeId\": \"(string, required) Scheme ID of reference. Max 10 chars.\"\n\t\t\t\t},\n\t\t\t\t\"originCountryCode\": \"(string) Country of origin (ISO 3166-1 alpha-2). Max 100 chars. Example: BE\",\n\t\t\t\t\"standardItemIdentification\": {\n\t\t\t\t\t\"id\": \"(string, required) Standard item identifier. Max 200 chars. Example: 5412345678908\",\n\t\t\t\t\t\"schemeId\": \"(string, required) Identification scheme, using the ICD code list. Max 10 chars. Example: 0160\"\n\t\t\t\t},\n\t\t\t\t\"price\": {\n\t\t\t\t\t\"articlePrice\": \"(number, required) The price of an item, exclusive of VAT, after subtracting item price discount. The Item net price has to be equal with the Item gross price less the Item price discount, if they are both provided. Item price can not be negative. Example: 50.00\",\n\t\t\t\t\t\"baseQuantity\": \"(number) The number of item units to which the price applies. Example: 1\",\n\t\t\t\t\t\"unitOfMeasure\": \"(string) Unit of measure. Codes for unit of packaging from UNECE Recommendation No. 21 can be used in accordance with the descriptions in the Intro section of UN/ECE Recommendation 20, Revision 11 (2015): The 2 character alphanumeric code values in UNECE Recommendation 21 shall be used. To avoid duplication with existing code values in UNECE Recommendation No. 20, each code value from UNECE Recommendation 21 shall be prefixed with an \\\"X\\\", resulting in a 3 alphanumeric code when used as a unit of measure. Max 200 chars. Example: H87\",\n\t\t\t\t\t\"allowanceAmount\": \"(number) The total discount subtracted from the Item gross price to calculate the Item net price. Example: 55.00\",\n\t\t\t\t\t\"allowanceBaseAmount\": \"(number) The unit price, exclusive of VAT, before subtracting Item price discount, can not be negative. Example: 60.00\"\n\t\t\t\t},\n\t\t\t\t\"vatExemptionReason\": \"(string) Reason for VAT exemption. Example: Intra-community supply\",\n\t\t\t\t\"vatExemptionReasonCode\": \"(string) Code for VAT exemption reason. Example: E\",\n\t\t\t\t\"uuLineNumber\": \"(string) (POLAND) Universal unique line number. Should be unique not only per invoice but per taxpayer or invoicing system\",\n\t\t\t\t\"lineGTU\": \"(string) Designation for the delivery of goods and the provision of services\",\n\t\t\t\t\"lineDueDateTypeCode\": \"(string) Code specifying the type of due date that applies to this invoice line.\",\n\t\t\t\t\"referencedDespatchDocId\": \"(string) An identifier for the despatch advice that this invoice line refers to. Example: DESP-993\",\n\t\t\t\t\"referencedDespatchDocLineId\": \"(string) An identifier for the line within the referenced despatch advice. Example: 2\",\n\t\t\t\t\"referencedInvoiceDocId\": \"(string) An identifier for the invoice that this invoice line refers to. Example: INV-2021-77\",\n\t\t\t\t\"referencedInvoiceDocLineId\": \"(string) An identifier for the line within the referenced invoice. Example: 3\",\n\t\t\t\t\"referencedInvoiceDocTypeCode\": \"(string) The document type code of the referenced invoice. Example: 380\",\n\t\t\t\t\"referencedInvoiceDocIssueDate\": \"(string, date) The issue date of the referenced invoice (YYYY-MM-DD). Example: 2021-11-30\",\n\t\t\t\t\"referencedReceiptDocId\": \"(string) An identifier for the receiving advice that this invoice line refers to. Example: RCPT-331\",\n\t\t\t\t\"referencedReceiptDocLineId\": \"(string) An identifier for the line within the referenced receiving advice. Example: 1\",\n\t\t\t\t\"referencedSalesOrderDocId\": \"(string) An identifier for the sales order that this invoice line refers to. Example: SO-10099\",\n\t\t\t\t\"referencedSalesOrderDocLineId\": \"(string) An identifier for the line within the referenced sales order. Example: 4\",\n\t\t\t\t\"deliveryActualDeliveryDate\": \"(string, date) The date on which the goods or services on this invoice line were actually delivered (YYYY-MM-DD). Example: 2023-01-03\",\n\t\t\t\t\"deliveryPartyName\": \"(string) The name of the party that the goods or services on this invoice line were delivered to. Example: Soluz.io afleveradres\",\n\t\t\t\t\"deliveryLocationIDs\": \"(string) An identifier for the delivery location of this invoice line. Example: 5412345000013\",\n\t\t\t\t\"deliveryLocationAddress1\": \"(string) Street and street number of the delivery location of this invoice line. Example: Berendries 52\",\n\t\t\t\t\"deliveryLocationAddress2\": \"(string) Additional address line of the delivery location. Example: Building A\",\n\t\t\t\t\"deliveryLocationAddress3\": \"(string) Additional address line of the delivery location. Example: Floor 2\",\n\t\t\t\t\"deliveryLocationCity\": \"(string) City of the delivery location. Example: Lovendegem\",\n\t\t\t\t\"deliveryLocationZIP\": \"(string) Postal code of the delivery location. Example: 5400\",\n\t\t\t\t\"deliveryLocationCountrySubEntity\": \"(string) Province, state or region of the delivery location. Example: O-Vl\",\n\t\t\t\t\"deliveryLocationCountryCode\": \"(string) Country of the delivery location (ISO 3166-1 alpha-2). Example: BE\"\n\t\t\t}\n\t\t]\n\t},\n\t\"processing\": {\n\t\t\"deliveryMethod\": \"(string) Channel through which the invoice was received (e.g. PEPPOL, E-MAIL, POST). Example: PEPPOL\",\n\t\t\"extraCode1\": \"(string) Optional extra information that can be used in rules\",\n\t\t\"extraCode2\": \"(string) Optional extra information that can be used in rules\",\n\t\t\"extraCode3\": \"(string) Optional extra information that can be used in rules\",\n\t\t\"extraCode4\": \"(string) Optional extra information that can be used in rules\",\n\t\t\"extraCode5\": \"(string) Optional extra information that can be used in rules\",\n\t\t\"extraCode6\": \"(string) Optional extra information that can be used in rules\",\n\t\t\"extraCode7\": \"(string) Optional extra information that can be used in rules\",\n\t\t\"extraCode8\": \"(string) Optional extra information that can be used in rules\",\n\t\t\"extraCode9\": \"(string) Optional extra information that can be used in rules\",\n\t\t\"extraCode10\": \"(string) Optional extra information that can be used in rules\",\n\t\t\"extraInfo\": \"(string) Free-form text, up to 500 chars.\",\n\t\t\"senderPartyEntity\": \"(string) ComFin contract number if ComFin customer. Example: BE00001\",\n\t\t\"messageType\": \"(string) Message type for XML (default EFFF). Example: EFFF\"\n\t},\n\t\"image\": {\n\t\t\"embedded\": \"(boolean) Is it an embedded file? Example: true\",\n\t\t\"name\": \"(string) File name. Example: factuurImage.pdf\",\n\t\t\"mimeType\": \"(string) MIME type. Example: application/pdf\",\n\t\t\"value\": \"(string, base64) Base64 content of file. Example: BASE64 here\"\n\t},\n\t\"attachments\": [\n\t\t{\n\t\t\t\"embedded\": \"(boolean) Is it an embedded file? Example: true\",\n\t\t\t\"name\": \"(string) File name. Example: Attach.pdf\",\n\t\t\t\"mimeType\": \"(string) MIME type. Example: application/pdf\",\n\t\t\t\"value\": \"(string, base64) Base64 content\"\n\t\t}\n\t],\n\t\"xml\": {\n\t\t\"embedded\": \"(boolean) Is it an embedded file? Example: true\",\n\t\t\"name\": \"(string) File name. Example: invoice.xml\",\n\t\t\"mimeType\": \"(string) MIME type. Example: application/xml\",\n\t\t\"value\": \"(string, base64) Base64 encoded UBL XML\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.soluz.io//inbound/companies/{{partyId}}/invoices","description":"Uploads a received invoice as JSON into the inbound flow of the company, for example an invoice that did not arrive through Peppol.
\nUsage
\ndetails holds the invoice data and is required. An invoice can have at most 10,000 detail lines.image (the PDF) and attachments: set embedded to true, and fill in name, mimeType and value.Responses
\n201 Created: the invoice was uploaded. Use the returned id in GET /inbound/companies/{partyId}/invoices/{id}.400 Bad Request: the request is not valid, or has more than 10,000 detail lines.404 Not Found: unknown PartyId.406 Not Acceptable: the content could not be accepted.401 Unauthorized: the API key is missing or not valid.x-api-key
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"feedbackCode\": \"(string, required) Code of the feedback that is sent back to the supplier. Example: AB\",\n\t\"feedbackMessage\": \"(string, required) Description of the feedback. Example: Invoice approved for payment\",\n\t\"reasonCode\": \"(string) Coded reason for the feedback. Example: REF\",\n\t\"reason\": \"(string) Textual reason for the feedback. Example: Purchase order reference is missing\",\n\t\"requestedActionCode\": \"(string) Coded action requested from the supplier. Example: CNF\",\n\t\"requestedAction\": \"(string) Textual action requested from the supplier. Example: Please send a credit note\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.soluz.io//inbound/companies/{{partyId}}/invoices/{{id}}/feedback","description":"Sends your response on a received invoice back to the supplier, for example that it was approved, or that information is missing.
\nUsage
\nfeedbackCode and feedbackMessage are required, for example AB with \"Invoice approved for payment\".reasonCode, reason) and the action you expect from the supplier (requestedActionCode, requestedAction).succeeded in the response: false means the feedback could not be sent.Responses
\n200 OK: the result, with succeeded and a message.400 Bad Request: the request body is missing or not valid.404 Not Found: unknown PartyId or invoice.401 Unauthorized: the API key is missing or not valid.x-api-key
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"invoicedate-from\": \"(string,date) The start date for the invoice date range. Example: 2023-11-01\",\n\t\"invoicedate-to\": \"(string,date) The end date for the invoice date range. Example: 2023-11-30\",\n\t\"invoiceNumber\": \"(string) The invoice number. Example: 23110000291\",\n\t\"objectId\": \"(string) Object id of the document. Used in GetInvoice to get the details of this invoice. Example: 4728\",\n\t\"uniqueId\": \"(string) Unique id of the document. Example: 1095953\",\n\t\"page\": {\n\t\t\"page-number\": \"(number) Page number. Example: 2\",\n\t\t\"records-per-page\": \"(number) Amount of records per page. Example: 25\"\n\t},\n\t\"status\": \"(string) Filter on status. Example: PENDING\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.soluz.io//inbound/companies/{{partyId}}/inbox/invoices","description":"Searches the inbox of the company: received invoices that are ready to be downloaded and have not been marked as downloaded yet.
\nUsage
\ninvoicedate-from and invoicedate-to are required. Only invoices with an invoice date in this range (both dates included) are returned. Format: YYYY-MM-DD.invoiceNumber (exact match), objectId and uniqueId.page: page-number starts at 1. records-per-page defaults to 20 and is capped at 100.Typical flow
\nResponses
\n200 OK: the current page, the number of totalPages and the matching invoices.400 Bad Request: the request body is missing or not valid.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.x-api-key
\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//inbound/companies/{{partyId}}/inbox/invoices","description":"Returns the first page of the inbox of the company: received invoices that are ready to be downloaded and have not been marked as downloaded yet.
\nUsage
\ntotalPages is more than 1, use POST /inbound/companies/{partyId}/inbox/invoices/search with paging to get the rest.Typical flow
\nResponses
\n200 OK: the first page of the inbox.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.x-api-key
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"invoicedate-from\": \"(string,date) The start date for the invoice date range. Example: 2023-11-01\",\n\t\"invoicedate-to\": \"(string,date) The end date for the invoice date range. Example: 2023-11-30\",\n\t\"invoiceNumber\": \"(string) The invoice number. Example: 23110000291\",\n\t\"objectId\": \"(string) Object id of the document. Used in GetInvoice to get the details of this invoice. Example: 4728\",\n\t\"uniqueId\": \"(string) Unique id of the document. Example: 1095953\",\n\t\"page\": {\n\t\t\"page-number\": \"(number) Page number. Example: 2\",\n\t\t\"records-per-page\": \"(number) Amount of records per page. Example: 25\"\n\t},\n\t\"status\": \"(string) Filter on status. Example: PENDING\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.soluz.io//inbound/companies/{{partyId}}/inbox/invoices/search","description":"Searches the inbox of the company: received invoices that are ready to be downloaded and have not been marked as downloaded yet.
\nUsage
\ninvoicedate-from and invoicedate-to are required. Only invoices with an invoice date in this range (both dates included) are returned. Format: YYYY-MM-DD.invoiceNumber (exact match), objectId and uniqueId.page: page-number starts at 1. records-per-page defaults to 20 and is capped at 100.Typical flow
\nResponses
\n200 OK: the current page, the number of totalPages and the matching invoices.400 Bad Request: the request body is missing or not valid.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.x-api-key
\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//inbound/companies/{{partyId}}/inbox/invoices/{{id}}/markdownloaded","description":"Marks an invoice as downloaded, which removes it from the inbox.
\nUsage
\nResponses
\n200 OK: a message confirming the invoice was marked as downloaded.404 Not Found: unknown PartyId, or the invoice is not in the inbox.401 Unauthorized: the API key is missing or not valid.\n\nScroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
\n
Base URLs:
\n\nGET /inbound/companies
Get companies
\nReturns all companies in the current tenant that your API key has access to.
\nThe id of each company is its PartyId. Every other request in this API is made for one company and takes this value as {partyId} in the URL.
Usage
\nCall this endpoint first to look up the PartyId of the company you want to work with.
\nExample: with PartyId 101, GET /inbound/companies/101/inbox/invoices returns the inbox of that company.
\nResponses
\n200 OK: the companies your API key has access to.
401 Unauthorized: the API key is missing or not valid.
\n\nExample responses
\n
\n\n200 Response
\n
{\n \"companies\": [\n {\n \"id\": \"(number) PartyId of the company. Use it as {partyId} in all other requests, e.g. GET companies/101/inbox/invoices. Example: 101\",\n \"name\": \"(string) Name of the company. Example: Soluz.io\",\n \"vatNumber\": \"(string) VAT number of the company. Example: BE0123456749\",\n \"companyNumber\": \"(string) National company registry number. Example: 0123456749\"\n },\n {\n \"id\": \"(number) PartyId of the company. Use it as {partyId} in all other requests, e.g. GET companies/102/inbox/invoices. Example: 102\",\n \"name\": \"(string) Name of the company. Example: Pandava nv/sa\",\n \"vatNumber\": \"(string) VAT number of the company. Example: BE0999001396\",\n \"companyNumber\": \"(string) National company registry number. Example: 0999001396\"\n }\n ]\n}\n\nThis operation does not require authentication
\nGET /inbound/companies/{partyId}
Get company
\nReturns a single company of the current tenant.
\nUsage
\npartyId is the id returned by GET /inbound/companies.
The id in the response is the same PartyId: use it as {partyId} in all other requests.
Responses
\n200 OK: the company.
404 Not Found: there is no company with this PartyId that your API key has access to.
401 Unauthorized: the API key is missing or not valid.
\n\nExample responses
\n
\n\n200 Response
\n
{\n \"id\": \"(number) PartyId of the company. Use it as {partyId} in all other requests, e.g. GET companies/101/inbox/invoices. Example: 101\",\n \"name\": \"(string) Name of the company. Example: Soluz.io\",\n \"vatNumber\": \"(string) VAT number of the company. Example: BE0123456749\",\n \"companyNumber\": \"(string) National company registry number. Example: 0123456749\"\n}\n\nThis operation does not require authentication
\nPOST /inbound/companies/{partyId}/fr/ereport/multipart
Upload an eReport for France
\nUploads a French e-reporting file for the company.
\nUsage
\nSend the request as multipart/form-data.
Add the eReport as a file part with content type application/xml. In Postman, add it in the Body tab as a form-data field of type File; Postman sets the content type from the .xml extension.
Only the first application/xml part is used as the eReport. Any other parts are kept as attachments.
The eReport format is described in Annexe 6 (Format sémantique FE e-reporting) of the French B2B specifications: https://www.impots.gouv.fr/specifications-externes-b2b
\nResponses
\n202 Accepted: the eReport was received.
400 Bad Request: the uploaded content is not valid.
404 Not Found: unknown PartyId.
401 Unauthorized: the API key is missing or not valid.
\n\nBody parameter
\n
type: object\nproperties:\n Xml:\n type: string\n description: eReport as XML file\n format: binary\n Attachments:\n type: array\n description: Optional additional attachments\n items:\n type: string\n format: binary\n\n\n\nExample responses
\n
\n\n201 Response
\n
{\n \"id\": \"(number) Internal system ID of the created eReport. Example: 53973544\"\n}\n\nThis operation does not require authentication
\nGET /inbound/companies/{partyId}/invoices/{id}
Get invoice
\nReturns all details of a received invoice: header, supplier, customer, totals, detail lines, payment information and references.
\nUsage
\nid is the id of the invoice from the inbox, the invoice search, or the id returned when it was uploaded.
Use GET /inbound/companies/{partyId}/invoices/{id}/{format} to download the UBL, PDF or attachments.
\nResponses
\n200 OK: the invoice.
404 Not Found: unknown PartyId or invoice.
401 Unauthorized: the API key is missing or not valid.
\n\nExample responses
\n
\n\n200 Response
\n
{\n \"id\": \"(number) Internal system ID. Example: 99993544\",\n \"uniqueId\": \"(string) Unique identifier. Example: 0000365474010053973333\",\n \"transactionId\": \"(string) Transaction identifier. Example: 2AF410E4DEF234DB89918E6EEC7DF825\",\n \"invoiceNumber\": \"(string) Invoice number. Example: 23110000291\",\n \"currency\": \"(string) ISO 4217 currency code. Example: EUR\",\n \"type\": \"(string) Invoice type (INVOICE or CREDITNOTE). Example: INVOICE\",\n \"date\": \"(string, date) Issue date (YYYY-MM-DD). Example: 2023-11-07\",\n \"dueDate\": \"(string, date) Due date for payment (YYYY-MM-DD). In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present. Example: 2023-12-07\",\n \"status\": \"(string) Status of the inbound invoice. Example: PENDING\",\n \"clearanceReferenceId\": \"(string) Unique reference identifier associated with the clearance process. Only relevant for countries where clearance is required. Example: 3948572019283746\",\n \"clearanceReferenceDate\": \"(string, date) Date the invoice was cleared by the tax authority. Only relevant for countries where clearance is required. Example: 2023-11-08\",\n \"paymentLink\": \"(string) A link to a payment website, QR code or similar. Example: http://exsite.qr.com/AEU9ZR843J\",\n \"paymentLinkPaidAt\": \"(string, date) The date when the payment link was paid (YYYY-MM-DD). Example: 2023-12-07\",\n \"placeOfIssue\": \"(string) Place where the invoice was issued\",\n \"fullyPaid\": \"(boolean) Indicates if an invoice has been paid\",\n \"dateOfFullPayment\": \"(string) date of payment\",\n \"simplifiedTriangularProcedure\": \"(string) Indication if invoice is issued under simplified procedure by the second taxpayer\",\n \"checkoutMethod\": \"(boolean) Cash accounting indicator\",\n \"selfBillingIndicator\": \"(boolean) Selfbilling indicator\",\n \"warehouseDocumentNumbers\": \"(string) WZ (delivery note) document numbers\",\n \"typeName\": \"(string) Invoice Type\",\n \"restrictedInformation\": \"(string) Indicator if Invoice referred to in Art. 109 sec. 3d of the Act\",\n \"totals\": {\n \"amountExclVat\": \"(number) The total amount of the Invoice without VAT. Must be rounded to maximum 2 decimals. Example: 297.00\",\n \"vatAmount\": \"(number) The total VAT amount for the Invoice or the VAT total amount expressed in the accounting currency accepted or required in the country of the Seller. Must be rounded to maximum 2 decimals. Example: 38.07\",\n \"amountInclVat\": \"(number) The total amount of the Invoice with VAT. Must be rounded to maximum 2 decimals. Example: 335.07\",\n \"lineExtensionAmount\": \"(number) Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals. If not supplied this is calculated as the sum of the LineExtensionAmount on the detail lines. Example: 297.00\",\n \"payableAmount\": \"(number) The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals. If not filled in the TaxInclusiveAmount will be used. Example: 335.07\",\n \"payableRoundingAmount\": \"(number) The amount to be added to the invoice total to round the amount to be paid. Must be rounded to maximum 2 decimals. Example: 0.00\",\n \"prepaidAmount\": \"(number) The sum of amounts which have been paid in advance. Must be rounded to maximum 2 decimals. Example: 0.00\",\n \"chargeAmount\": \"(number) Additional charge excl. VAT. Example: 10\",\n \"allowanceAmount\": \"(number) Total allowance/exemption excl. VAT. Example: 5.00\"\n },\n \"customer\": {\n \"id\": \"(string) Internal customer ID. Example: CUST1\",\n \"name\": \"(string) Buyer name, the company receiving the invoice. Example: GEMEENTE SOL\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0907537834\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"companyNumber\": \"(string) National registry ID (if applicable). Example: 0907537834\",\n \"address\": {\n \"address1\": \"(string) Street. Example: Laatstraat 99\",\n \"city\": \"(string) City. Example: STABROEK\",\n \"zip\": \"(string) Postal code. Example: 2940\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2 code. Example: BE\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"department\": \"(string) Department or branch. Example: DevelopmentDepartment\",\n \"endpointId\": \"(string) Electronic endpoint identifier. Example: BE2929035935\",\n \"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 9925\"\n },\n \"supplier\": {\n \"id\": \"(string) Internal supplier ID. Example: SUP1\",\n \"name\": \"(string) Seller name, the party that issued the invoice. Example: INCREDIBLO nv/sa\",\n \"vatNumber\": \"(string) Seller VAT number. Example: BE0999001396\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"address\": {\n \"address1\": \"(string) Street. Example: Lage Weg 123 A\",\n \"city\": \"(string) City. Example: Hoevenen-Stabroek\",\n \"zip\": \"(string) Postal code. Example: 2940\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2 code. Example: BE\",\n \"taxpayersPrefix\": \"(string) VAT UE country prefix (e.g. PL) for intra-Community supplies, cross-border services, and triangular transactions.\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"department\": \"(string) Department or branch. Example: DevelopmentDepartment\",\n \"endpointId\": \"(string) Electronic endpoint identifier. Example: BE2929035935\",\n \"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 9925\"\n },\n \"buyer\": {\n \"name\": \"(string) Buyer name. Example: Soluz.io\",\n \"address\": {\n \"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n \"zip\": \"(string) Postal code. Example: Tax 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province. Example: Vl-Br\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n \"companyNumberType\": \"(string) Company number type\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0123456749\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"RecipientType\": \"(string) Flag to indicate Subordinate Local Government Unit or GV member\"\n },\n \"references\": {\n \"accountingCost\": \"(string) Buyer accounting reference. Example: 4217:2323:2323\",\n \"billingReferences\": [\n {\n \"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n \"invoiceDocumentReferenceIssueDate\": \"(string, date) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"reasonForCorrection\": \"(string) Reason for correction\",\n \"externalReference\": \"(string) Number identifying the corrected invoice in the National System of e-Invoices\",\n \"typeOfCorrection\": \"(string) Type of correction\"\n }\n ],\n \"buyerReference\": \"(string) An identifier assigned by the Buyer used for internal routing purposes. An invoice must have buyer reference or purchase order reference (BT-13). Example: ABC/984/B2\",\n \"contractDocReference\": \"(string) Contract identifier by seller. Example: CT-2022-001\",\n \"contractDocIssueDate\": \"(string, date) Contract date by seller (YYYY-MM-DD). Example: 2022-01-15\",\n \"contractDocReferenceCustomer\": \"(string) Contract identifier by customer. Example: CUST-CT-88\",\n \"contractDocIssueDateCustomer\": \"(string, date) Contract date by customer (YYYY-MM-DD). Example: 2022-01-20\",\n \"despatchDocReference\": \"(string) Dispatch advice ID. Example: DESP-993\",\n \"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n \"invoiceDocumentReferenceIssueDate\": \"(string, date) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"originatorDocReference\": \"(string) Tender or lot reference. Example: TND-2022-01\",\n \"projectReference\": \"(string) Project reference. Example: PROJ-Delta-01\",\n \"receiptDocReference\": \"(string) Receiving advice ID. Example: RCPT-331\",\n \"purchaseOrderReference\": \"(string) Purchase order ID. Example: PA992430\",\n \"salesOrderReference\": \"(string) Sales order ID. Example: 11-145210\"\n },\n \"detailLines\": [\n {\n \"id\": \"(string) Unique identifier for this invoice line. Example: 1\",\n \"additionalItemProperties\": \"(object) Additional properties of the goods/services. Example: { \\\"color\\\": \\\"blue\\\" }\",\n \"articleName\": \"(string) Item name. Example: Agenda Timing 2024 genaaid Lima zwart\",\n \"articleDescription\": \"(string) Item description, more detail than name. Example: Hardcover planner with stitched binding\",\n \"articleNumberBuyer\": \"(string) Buyer-assigned item identifier. Example: B-98431\",\n \"articleNumberSupplier\": \"(string) Seller-assigned item identifier. Example: 56.1142.021/9\",\n \"lineExtensionAmount\": \"(number) Net line amount excl. VAT (inclusive of line-level allowances/charges). Example: 9.06\",\n \"commodityClassificationCodes\": \"(object) Classification codes (e.g. UNSPSC, CPV, etc.). Example: { \\\"UNSPSC\\\": \\\"44121706\\\" }\",\n \"deliveryDate\": \"(string, date) Delivery date (YYYY-MM-DD). Example: 2023-11-05\",\n \"deliveryNoteReference\": \"(string) Reference to a delivery note. Example: DN-2023-1115\",\n \"docRefDocType\": \"(string) Document type code for referenced object (use 130 for invoice object reference). Example: 130\",\n \"docRefId\": {\n \"id\": \"(string) Identifier value. Example: 123456789\",\n \"schemeId\": \"(string) Identifier scheme ID.\"\n },\n \"note\": \"(string) Unstructured note relevant to this line. Example: Urgent delivery\",\n \"originCountryCode\": \"(string) Country of origin (ISO 3166-1 alpha-2). Example: BE\",\n \"accountingCost\": \"(string) Buyer's accounting allocation reference. Example: 4217:2323:2323\",\n \"startDate\": \"(string, date) Invoice period start date (YYYY-MM-DD). Example: 2023-11-01\",\n \"endDate\": \"(string, date) Invoice period end date (YYYY-MM-DD). Example: 2023-11-30\",\n \"vatCode\": \"(string) VAT category code. Example: S\",\n \"vatRate\": \"(number) VAT rate (%) applied. Example: 21.00\",\n \"orderLineId\": \"(string) Buyer purchase order line reference. Example: 15\",\n \"quantity\": \"(number) Quantity of items invoiced. Example: 2.00\",\n \"standardItemIdentification\": {\n \"id\": \"(string) Standard identifier value. Example: 5412345123453\",\n \"schemeId\": \"(string) Standard identifier scheme (e.g. 0160(GTIN), 0088(EAN) from https://docs.peppol.eu/poacc/billing/3.0/codelist/ICD/). Example: 0160\"\n },\n \"price\": {\n \"articlePrice\": \"(number) The price of an item, exclusive of VAT, after subtracting item price discount. The Item net price has to be equal with the Item gross price minus the Item price discount, if they are both provided. Item price can not be negative. Example: 50.00\",\n \"baseQuantity\": \"(number) Quantity basis for price. Example: 1\",\n \"unitOfMeasure\": \"(string) Unit of measure. Codes for unit of packaging from UNECE Recommendation No. 21 can be used in accordance with the descriptions in the Intro section of UN/ECE Recommendation 20, Revision 11 (2015): The 2 character alphanumeric code values in UNECE Recommendation 21 shall be used. o avoid duplication with existing code values in UNECE Recommendation No. 20, each code value from UNECE Recommendation 21 shall be prefixed with an \\\"X\\\", resulting in a 3 alphanumeric code when used as a unit of measure. Example: H87\",\n \"allowanceAmount\": \"(number) The total discount subtracted from the Item gross price to calculate the Item net price. Example: 55.00\",\n \"allowanceBaseAmount\": \"(number) The unit price, exclusive of VAT, before subtracting Item price discount, can not be negative. Example: 60.00\"\n },\n \"allowanceCharge\": {\n \"reason\": \"(string) Reason for allowance/charge. Example: Promotion\",\n \"reasonCode\": \"(string) Coded reason for allowance/charge. Example: 95\",\n \"amount\": \"(decimal) Amount excl. VAT. Example: 1.00\",\n \"chargeIndicator\": \"(number) true=Charge, false=Allowance. Example: false\",\n \"taxCode\": \"(string) VAT category code. Example: S\",\n \"taxPercentage\": \"(number) VAT rate for allowance/charge. Example: 21.00\"\n },\n \"vatExemptionReason\": \"(string) Reason text if VAT-exempt. Example: Intra-community supply\",\n \"vatExemptionReasonCode\": \"(string) Reason code if VAT-exempt. Example: K\",\n \"uULineNumer\": \"(string) (POLAND) Universal unique line number. Should be unique not only per invoice but per taxpayer or invoicing system\",\n \"lineGTU\": \"(string) Designation for the delivery of goods and the provision of services\"\n }\n ],\n \"allowanceCharges\": [\n {\n \"reason\": \"(string) Textual reason for allowance/charge. Example: Early payment discount\",\n \"reasonCode\": \"(string) UNCL5189/UNCL7161 code. Example: 95\",\n \"amount\": \"(number) Amount excl. VAT. Example: 5.00\",\n \"chargeIndicator\": \"(boolean) true=Charge, false=Allowance. Example: false\",\n \"taxCode\": \"(string) VAT category code. Example: S\",\n \"taxPercentage\": \"(number) VAT rate for allowance/charge. Example: 21.00\"\n }\n ],\n \"vatSubTotals\": [\n {\n \"code\": \"(string) VAT category code. Example: S\",\n \"rate\": \"(number) VAT rate. Example: 21.00\",\n \"taxableAmount\": \"(number) Taxable amount. Example: 109.41\",\n \"taxAmount\": \"(number) VAT amount. Example: 22.98\",\n \"taxTypeIndicator\": \"(string) Additonal Tax Category for non-standard rate\",\n \"splitPaymentIndicator\": \"(string) Split payment indicator\"\n }\n ],\n \"files\": [\n {\n \"id\": \"(integer) File ID. Example: 53973545\",\n \"name\": \"(string) File name. Example: examplefilename.xml\",\n \"size\": \"(string) File size. Example: 13.98 KB\",\n \"pages\": \"(number) Page count. Example: 0\",\n \"package\": \"(string) File type (XML, PDF, UBL, etc.). Use this value as the {format} in GetInvoiceFile. Example: XML\"\n }\n ]\n}\n\nThis operation does not require authentication
\nGET /inbound/companies/{partyId}/invoices/{id}/{format}
Get invoice file
\nDownloads one or more files of a received invoice.
\nUsageformat selects the files:
ubl: the UBL invoice (XML).
pdf or image: the PDF of the invoice.
attachments: all additional attachments.
ublandimage: the UBL and the PDF.
all: the UBL, the PDF and all attachments.
xml: the files in the XML package of the invoice.
a number: the single file with that file ID.
\nWhen one file matches, it is returned as is (for example a PDF or XML). When several files match, they are returned together in one ZIP file.
\nResponses
\n200 OK: the file, or a ZIP file with the matching files.
404 Not Found: unknown PartyId or invoice, or no file matches format.
401 Unauthorized: the API key is missing or not valid.
\n\nExample responses
\n
\n\n200 Response
\n
\n\n401 Response
\n
{\n \"type\": \"object\",\n \"description\": \"Object that represents an unauthorized error\",\n \"additionalProperties\": false,\n \"properties\": {\n \"message\": {\n \"type\": \"string\",\n \"description\": \"A message\",\n \"nullable\": true\n }\n }\n}\n\nThis operation does not require authentication
\nPOST /inbound/companies/{partyId}/invoices/search
Search invoices
\nSearches the received invoices of the company and returns one page of results.
\nUsage
\ninvoicedate-from and invoicedate-to are required. Only invoices with an invoice date in this range (both dates included) are returned. Format: YYYY-MM-DD.
Optional filters: invoiceNumber (exact match), objectId and uniqueId. All filled-in filters must match.
page: page-number starts at 1. records-per-page defaults to 20 and is capped at 100. Use totalPages in the response to fetch the next pages.
The results contain the main invoice fields. Use GET /inbound/companies/{partyId}/invoices/{id} with the id of a result for all details.
Responses
\n200 OK: the current page, the number of totalPages and the matching invoices.
400 Bad Request: the request body is missing or not valid, for example without the invoice date range.
404 Not Found: unknown PartyId.
401 Unauthorized: the API key is missing or not valid.
\n\nBody parameter
\n
{\n \"invoicedate-from\": \"(string,date) The start date for the invoice date range. Example: 2023-11-01\",\n \"invoicedate-to\": \"(string,date) The end date for the invoice date range. Example: 2023-11-30\",\n \"invoiceNumber\": \"(string) The invoice number. Example: 23110000291\",\n \"objectId\": \"(string) Object id of the document. Used in GetInvoice to get the details of this invoice. Example: 4728\",\n \"uniqueId\": \"(string) Unique id of the document. Example: 1095953\",\n \"page\": {\n \"page-number\": \"(number) Page number. Example: 2\",\n \"records-per-page\": \"(number) Amount of records per page. Example: 25\"\n },\n \"status\": \"(string) Filter on status. Example: PENDING\"\n}\n\n\n\nExample responses
\n
\n\n200 Response
\n
{\n \"page\": \"(number) Current page number. Example: 1\",\n \"totalPages\": \"(number) Total number of pages available. Example: 5\",\n \"invoices\": [\n {\n \"id\": \"(number) Internal ID of the Invoice. Used in GetInvoice to get the details of this invoice. Example: 53973544\",\n \"uniqueId\": \"(string) Unique identifier. Example: 0000130974010053973544\",\n \"invoiceNumber\": \"(string) Invoice number. Example: 23110000291\",\n \"currency\": \"(string) ISO 4217 currency code. Example: EUR\",\n \"type\": \"(string) Invoice type (INVOICE or CREDITNOTE). Example: INVOICE\",\n \"date\": \"(string, date) Issue date (YYYY-MM-DD). Example: 2023-11-07\",\n \"dueDate\": \"(string, date) Due date for payment (YYYY-MM-DD). Example: 2023-12-07\",\n \"status\": \"(string) Status of the inbound invoice. Example: PENDING\",\n \"clearanceReferenceId\": \"(string) Unique reference identifier associated with the clearance process. Only relevant for countries where clearance is required. Example: 3948572019283746\",\n \"clearanceReferenceDate\": \"(string, date) Date the invoice was cleared by the tax authority. Only relevant for countries where clearance is required. Example: 2023-11-08\",\n \"totals\": {\n \"amountExclVat\": \"(number) Invoice total excl. VAT. Example: 109.41\",\n \"vatAmount\": \"(number) Invoice VAT amount. Example: 22.98\",\n \"amountInclVat\": \"(number) Invoice total incl. VAT. Example: 132.39\"\n },\n \"customer\": {\n \"name\": \"(string) Buyer name, the company receiving the invoice. Example: GEMEENTE STABROEK\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0207537834\"\n },\n \"supplier\": {\n \"name\": \"(string) Seller name, the party that issued the invoice. Example: PANDAVA nv/sa\",\n \"vatNumber\": \"(string) Seller VAT number. Example: BE0419001396\"\n }\n }\n ]\n}\n\nThis operation does not require authentication
\nPOST /inbound/companies/{partyId}/invoices/multipart
Upload invoice [UBL, PDF, Attachments]
\nUploads a received invoice with its files into the inbound flow of the company, for example an invoice that did not arrive through Peppol.
\nUsage
Send the request as multipart/form-data, with either:
A UBL invoice as a file part with content type application/xml, optionally a PDF (application/pdf) and any number of additional attachments. The invoice is processed from the UBL. In Postman, add the files in the Body tab as form-data fields of type File.
Or an UploadInvoiceRequest as a part with content type application/json, plus the files it references. For each referenced file, set embedded to false and use the multipart file name as name.
To send everything as JSON with embedded (base64) files, use POST /inbound/companies/{partyId}/invoices instead.
\nResponses
\n201 Created: the invoice was uploaded. Use the returned id in GET /inbound/companies/{partyId}/invoices/{id}.
400 Bad Request: the request or one of its files is not valid.
404 Not Found: unknown PartyId.
406 Not Acceptable: the content could not be accepted.
401 Unauthorized: the API key is missing or not valid.
\n\nBody parameter
\n
type: object\nproperties:\n Xml:\n type: string\n description: UBL as XML file (optional)\n format: binary\n Image:\n type: string\n description: Invoice as PDF file (optional)\n format: binary\n Attachments:\n type: array\n description: Optional additional attachments\n items:\n type: string\n format: binary\n\n\n\nExample responses
\n
\n\n201 Response
\n
{\n \"id\": \"(number) Internal system ID of the created invoice. Use this id in GetInvoice to retrieve the invoice. Example: 53973544\"\n}\n\nThis operation does not require authentication
\nPOST /inbound/companies/{partyId}/invoices
Upload invoice [JSON]
\nUploads a received invoice as JSON into the inbound flow of the company, for example an invoice that did not arrive through Peppol.
\nUsage
\ndetails holds the invoice data and is required. An invoice can have at most 10,000 detail lines.
Add files as embedded (base64) files in image (the PDF) and attachments: set embedded to true, and fill in name, mimeType and value.
To upload the files as separate multipart parts instead, use POST /inbound/companies/{partyId}/invoices/multipart.
\nResponses
\n201 Created: the invoice was uploaded. Use the returned id in GET /inbound/companies/{partyId}/invoices/{id}.
400 Bad Request: the request is not valid, or has more than 10,000 detail lines.
404 Not Found: unknown PartyId.
406 Not Acceptable: the content could not be accepted.
401 Unauthorized: the API key is missing or not valid.
\n\nBody parameter
\n
{\n \"details\": {\n \"documentNumber\": \"(string) A unique identification of the invoice within the business context, time-frame, operating systems and records of the sender. Max 200 chars. Example: DEMO/00092\",\n \"invoiceNumber\": \"(string) Invoice number as shown on the document. Max 200 chars. Example: 23110000291\",\n \"currency\": \"(string, required) ISO 4217 currency code. Example: EUR\",\n \"date\": \"(string, required, date) Invoice issue date (YYYY-MM-DD). Example: 2022-12-02\",\n \"dueDate\": \"(string, date) Due date for payment (YYYY-MM-DD). In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present. Example: 2023-12-07\",\n \"note\": \"(string) A textual note that gives unstructured information that is relevant to the invoice as a whole, such as the reason for any correction or an assignment note in case the invoice has been factored. Max 2000 chars. Example: Note van de factuur\",\n \"structuredCommunication\": \"(string) A textual value used to establish a link between the payment and the Invoice, issued by the Seller. Used for creditor's critical reconciliation information. This information element helps the Seller to assign an incoming payment to the relevant payment process. Max 2000 chars. Example: +++123/569858/336+++\",\n \"type\": \"(string, required) Document type: Invoice, CreditNote. Example: Invoice\",\n \"typeCode\": \"(string) Document type code (e.g. 380=Invoice, 381=CreditNote). Max 100 chars. Example: 380\",\n \"serviceBeginDate\": \"(string, date) Service period start (YYYY-MM-DD). Example: 2022-12-01\",\n \"serviceEndDate\": \"(string, date) Service period end (YYYY-MM-DD). Example: 2022-12-31\",\n \"taxPointDate\": \"(string, date) The date when the VAT becomes accountable for the Seller and for the Buyer, when that date differs from the invoice issue date (YYYY-MM-DD). Example: 2022-12-22\",\n \"placeOfIssue\": \"(string) Place where the invoice was issued. Max 2000 chars. Example: Mechelen\",\n \"fullyPaid\": \"(boolean) Indicates if an invoice has been paid. Defaults to false. Example: false\",\n \"dateOfFullPayment\": \"(string, date-time) Date of payment, when payment was already made at the time the invoice was issued. Example: 2022-12-02T00:00:00\",\n \"simplifiedTriangularProcedure\": \"(boolean) Indicates a simplified triangular transaction, issued by the second taxpayer in the sequence. Defaults to false. Example: false\",\n \"checkoutMethod\": \"(boolean) Cash accounting indicator. Defaults to false. Example: false\",\n \"selfBillingIndicator\": \"(boolean) Self-billing indicator. Defaults to false. Example: false\",\n \"warehouseDocumentNumbers\": \"(string) WZ (delivery note) document numbers. Example: WZ/2023/114\",\n \"typeName\": \"(string) Invoice type name. Example: Commercial invoice\",\n \"restrictedInformation\": \"(boolean) Indicator if Invoice referred to in Art. 109 sec. 3d of the Act. Defaults to false. Example: false\",\n \"invoicePeriodDescriptionCode\": \"(string) Code describing the invoice or billing period. Typical uses include month, quarter or custom period codes. Max 50 chars. Example: 3\",\n \"deliveryTermsId\": \"(string) Identifier for the delivery terms applicable to this invoice. Max 200 chars. Example: CIF\",\n \"deliveryTermsDeliveryLocationName\": \"(string) Human-readable name of the delivery location associated with the delivery terms. Max 200 chars. Example: Antwerpen\",\n \"contractDocReferenceTypeCode\": \"(string) Code indicating the type of contract or document reference associated with the invoice. Max 100 chars. Example: 1\",\n \"references\": {\n \"accountingCost\": \"(string) Buyer accounting reference Cost center or internal accounting code. A textual value that specifies where to book the relevant data into the Buyer's financial accounts. Example: 4217:2323:2323\",\n \"billingReferences\": [\n {\n \"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n \"invoiceDocumentReferenceIssueDate\": \"(DateTime) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"reasonForCorrection\": \"(string) Reason for correction\",\n \"externalReference\": \"(string) Number identifying the corrected invoice in the National System of e-Invoices\",\n \"typeOfCorrection\": \"(string) Type of correction\"\n }\n ],\n \"buyerReference\": \"(string) Buyer reference or procurement ID. An invoice must have buyer reference or purchase order reference (BT-13) Example: ABC/984/B2\",\n \"purchaseOrderReference\": \"(string) Purchase order number. An invoice must have buyer reference (BT-10) or purchase order reference Example: OR1256\",\n \"contractDocReference\": \"(string) Contract identifier by seller. Example: CT-2022-001\",\n \"contractDocIssueDate\": \"(string, date) Contract date by seller (YYYY-MM-DD). Example: 2022-01-15\",\n \"contractDocReferenceCustomer\": \"(string) Contract identifier by customer. Example: CUST-CT-88\",\n \"contractDocIssueDateCustomer\": \"(string, date) Contract date by customer (YYYY-MM-DD). Example: 2022-01-20\",\n \"despatchDocReference\": \"(string) Dispatch advice ID. Example: DESP-993\",\n \"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n \"invoiceDocumentReferenceIssueDate\": \"(DateTime) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"originatorDocReference\": \"(string) Tender or lot reference. Example: TND-2022-01\",\n \"projectReference\": \"(string) Project reference. Example: PROJ-Delta-01\",\n \"receiptDocReference\": \"(string) Receiving advice ID. Example: RCPT-331\",\n \"salesOrderReference\": \"(string) Seller's sales order ID. Example: SO-10099\",\n \"salesOrderIssueDate\": \"(string, date) Sales order date (YYYY-MM-DD). Example: 2022-05-18\"\n },\n \"customer\": {\n \"id\": \"(string) Internal customer ID in sender's system. Max 100 chars. Example: CUST1\",\n \"name\": \"(string, required) Customer name, the company receiving the invoice. Max 200 chars. Example: Soluz.io\",\n \"address\": {\n \"address1\": \"(string, required) Street and number. Example: Zwartzustersvest 24\",\n \"address2\": \"(string) Address line 2. Example: Unit 5\",\n \"address3\": \"(string) Address line 3. Example: c/o Accounts\",\n \"city\": \"(string, required) City. Example: Mechelen\",\n \"zip\": \"(string, required) Postal code. Example: 2810\",\n \"countryCode\": \"(string, required) ISO 3166-1 alpha-2 country code. Example: BE\",\n \"province\": \"(string) State/Province/Region. Example: Antwerpen\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). CompanyNumber or VAT number is required for companies. Max 200 chars. Example: 0123456749\",\n \"department\": \"(string) Department or branch. Max 200 chars. Example: DevelopmentDepartment\",\n \"vatNumber\": \"(string) Customer VAT number. CompanyNumber or VAT number is required for companies. Max 200 chars. Example: BE0123456749\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"endpointId\": \"(string) Electronic endpoint identifier. Example: BE2929035935\",\n \"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 9925\",\n \"identifications\": [\n {\n \"id\": \"(string, required) Identifier value. Max 200 chars. Example: 0123456749\",\n \"schemeId\": \"(string, required) Identifier scheme, using the ICD code list. Max 10 chars. Example: 0208\"\n }\n ]\n },\n \"delivery\": {\n \"actualDeliveryDate\": \"(string, date) Delivery date (YYYY-MM-DD). Example: 2023-01-03\",\n \"address\": {\n \"address1\": \"(string)(required in case address is filled) Street and number. Example: Berendries 52\",\n \"address2\": \"(string) Example: Building A\",\n \"address3\": \"(string) Example: Floor 2\",\n \"city\": \"(string) City. Example: Lovendegem\",\n \"zip\": \"(string) Postal code. Example: 5400\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province/region. Example: O-Vl\"\n },\n \"name\": \"(string) Receiver name or delivery contact. Example: Soluz.io afleveradres\",\n \"locationIdentifier\": {\n \"id\": \"(string) Location identifier (GLN or other). Example: 5412345000013\",\n \"schemeId\": \"(string) Scheme ID for location. Example: 0088\"\n }\n },\n \"paymentMeans\": {\n \"code\": \"(string) The means, expressed as code, for how a payment is expected to be or has been settled. (e.g., UN/CEFACT 4461). Example: ZZZ\",\n \"text\": \"(string) Description of payment means. Example: Bank transfer\",\n \"mandateId\": \"(string) Unique identifier assigned by the Payee for referencing the direct debit mandate. Used in order to pre-notify the Buyer of a SEPA direct debit. Example: MandateId\",\n \"mandateFinancialAccountId\": \"(string) The account to be debited by the direct debit. Example: MandateFinancialAccountId\",\n \"paymentId\": \"(string) Payment reference to be used by the payer. Example: PMT-2023-001\",\n \"payeeFinancialInstitutionId\": \"(string) Identifier of Payee's bank (BIC, etc.). Example: KREDBEBB\",\n \"payeeFinancialAccountId\": \"(string) Payee's bank account (IBAN, etc.). Example: BE49000023121121\",\n \"payeeFinancialAccountSchemeId\": \"(string) Scheme ID of Payee's bank account (e.g. IBAN). Example: IBAN\",\n \"payeeFinancialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\"\n },\n \"multiplePaymentMeans\": [\n {\n \"code\": \"(string) The means, expressed as code, for how a payment is expected to be or has been settled. (e.g., UN/CEFACT 4461). Example: ZZZ\",\n \"text\": \"(string) Description of payment means. Example: Bank transfer\",\n \"mandateId\": \"(string) Unique identifier assigned by the Payee for referencing the direct debit mandate. Example: MandateId\",\n \"mandateFinancialAccountId\": \"(string) The account to be debited by the direct debit. Example: MandateFinancialAccountId\",\n \"paymentId\": \"(string) Payment reference to be used by the payer. Example: PMT-2023-001\",\n \"payeeFinancialInstitutionId\": \"(string) Identifier of Payee's bank (BIC, etc.). Example: KREDBEBB\",\n \"payeeFinancialAccountId\": \"(string) Payee's bank account (IBAN, etc.). Example: BE49000023121121\",\n \"payeeFinancialAccountSchemeId\": \"(string) Scheme ID of Payee's bank account (e.g. IBAN). Example: IBAN\",\n \"payeeFinancialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\"\n }\n ],\n \"payee\": {\n \"companyNumber\": \"(string) This element is used for both the identification of the Payee, or the unique banking reference identifier of Payee (assigned by the Payee bank.) For payee identification use ICD code list, for SEPA bank assigned creditor reference, use SEPA. Example: BE0123456749\",\n \"financialAccountId\": \"(string) Payee's IBAN. Example: BE49000023121121\",\n \"financialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\",\n \"name\": \"(string) Name of payee. Example: PayeeName\"\n },\n \"paymentTerms\": {\n \"text\": \"(string) A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties). Example: Payment in 30 days\",\n \"settlementDiscountPercentage\": \"(number) Early payment discount percentage. If not filled in but SettlementDiscountAmount is, this value will be calculated based on SettlementDiscountAmount. Example: 2\",\n \"settlementDiscountAmount\": \"(number) Early payment discount absolute amount. If not filled in but SettlementDiscountPercentage is, this value will be calculated based on SettlementDiscountPercentage. Example: 50.00\"\n },\n \"supplier\": {\n \"id\": \"(string) Internal supplier ID in sender's system. Example: SUP1\",\n \"name\": \"(string, required) Supplier name, the party that issued the invoice. Example: PANDAVA nv/sa\",\n \"address\": {\n \"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n \"address2\": \"(string) Example: Tax 1\",\n \"address3\": \"(string) Example: Tax 3\",\n \"city\": \"(string) City. Example: Tax Mechelen\",\n \"zip\": \"(string) Postal code. Example: Tax 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province. Example: Vl-Br\",\n \"taxpayersPrefix\": \"(string) VAT UE country prefix (e.g. PL) for intra-Community supplies, cross-border services, and triangular transactions.\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n \"department\": \"(string) Department or branch. Example: DevelopmentDepartment\",\n \"vatNumber\": \"(string) Supplier VAT number. Example: BE0419001396\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"endpointId\": \"(string) Electronic endpoint identifier. Example: BE2929035935\",\n \"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 9925\"\n },\n \"buyer\": {\n \"name\": \"(string) Buyer name. Example: Soluz.io\",\n \"address\": {\n \"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n \"zip\": \"(string) Postal code. Example: Tax 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province. Example: Vl-Br\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n \"companyNumberType\": \"(string) Company number type\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0123456749\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"recipientType\": \"(string) Flag to indicate Subordinate Local Government Unit or GV member\"\n },\n \"parties\": [\n {\n \"partyName\": \"(string) Name of the party. Example: VERVOER BVBA\",\n \"name\": \"(string) Name of the party. Example: VERVOER BVBA\",\n \"roleCode\": \"(string) Code identifying the role that this party takes on the invoice. Example: DEL\",\n \"endpointID\": \"(string) Electronic endpoint identifier of the party. Example: BE2929035935\",\n \"endpointIDType\": \"(string) Endpoint type or scheme which relates to the endpointID. Example: 9925\",\n \"identifiers\": [\n {\n \"id\": \"(string, required) Identifier value. Max 200 chars. Example: 0123456749\",\n \"schemeId\": \"(string, required) Identifier scheme, using the ICD code list. Max 10 chars. Example: 0208\"\n }\n ],\n \"address1\": \"(string) Street and street number of the party. Example: Lage Weg 123 A\",\n \"address2\": \"(string) Additional address line of the party. Example: Building A\",\n \"address3\": \"(string) Additional address line of the party. Example: Floor 2\",\n \"city\": \"(string) City of the party. Example: Hoevenen-Stabroek\",\n \"zip\": \"(string) Postal code of the party. Example: 2940\",\n \"countryCode\": \"(string) Country of the party, ISO 3166-1 alpha-2. Example: BE\",\n \"countryName\": \"(string) Country name of the party. Example: Belgium\",\n \"countrySubEntity\": \"(string) Province, state or region of the party. Example: Antwerpen\",\n \"vatNumber\": \"(string) VAT number of the party. Example: BE0419001396\",\n \"contactID\": \"(string) Identifier for the contact of the party. Example: CNT-1\",\n \"contactName\": \"(string) Contact person of the party. Example: Jan Peeters\",\n \"contactEmail\": \"(string) Contact email of the party. Example: jan@soluz.io\",\n \"contactPhone\": \"(string) Contact phone of the party. Example: +3215999888\",\n \"partyLERegistrationName\": \"(string) Registered legal entity name of the party. Example: PANDAVA nv/sa\",\n \"partyLECompanyID\": \"(string) Legal entity company identifier of the party (e.g. Belgium CBE/KBO). Example: 0419001396\",\n \"partyLECompanyIDType\": \"(string) Scheme of the legal entity company identifier, using the ICD code list. Example: 0208\",\n \"partyLECompanyLegalForm\": \"(string) Legal form of the legal entity. Example: NV\",\n \"recipientType\": \"(string) Flag to indicate Subordinate Local Government Unit or GV member\"\n }\n ],\n \"taxRepresentative\": {\n \"address\": {\n \"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n \"address2\": \"(string) Example: Tax 1\",\n \"address3\": \"(string) Example: Tax 3\",\n \"city\": \"(string) City. Example: Tax Mechelen\",\n \"zip\": \"(string) Postal code. Example: Tax 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province. Example: Vl-Br\"\n },\n \"name\": \"(string) Tax representative name. Example: Tax Soluz.io\",\n \"vatNumber\": \"(string) VAT number. Example: BE000000097\"\n },\n \"taxExchangeRate\": {\n \"sourceCurrencyCode\": \"(string) ISO 4217 code of the source currency. Example: USD\",\n \"targetCurrencyCode\": \"(string) ISO 4217 code of the target currency. Example: EUR\",\n \"calculationRate\": \"(number) Exchange rate. Example: 0.92\",\n \"mathematicOperatorCode\": \"(string) Mathematical operator used in the calculation. Defaults to Multiply. Example: Multiply\",\n \"date\": \"(string, date-time) Date the calculation rate applies to. Example: 2022-12-02T00:00:00\"\n },\n \"discount\": {\n \"amount\": \"(number) The discount amount. If not filled in but Percentage is, this value will be calculated based on Percentage. Example: 50\",\n \"percentage\": \"(number) The discount percentage. If not filled in but Amount is, this value will be calculated based on Amount. Example: 10\",\n \"reason\": \"(string) Reason for discount. Example: extra korting van 10%\"\n },\n \"charge\": {\n \"amount\": \"(number) Additional charge excl. VAT. Example: 10\",\n \"vatRate\": \"(number) VAT rate on charge. Example: 21\",\n \"vatCode\": \"(string) VAT category code for charge. Example: S\",\n \"reason\": \"(string) Reason for charge. Example: Handling fee\"\n },\n \"totals\": {\n \"amountExclVat\": \"(number) The total amount of the Invoice without VAT. Must be rounded to maximum 2 decimals. Example: 297.00\",\n \"vatAmount\": \"(number) The total VAT amount for the Invoice or the VAT total amount expressed in the accounting currency accepted or required in the country of the Seller. Must be rounded to maximum 2 decimals. Example: 38.07\",\n \"amountInclVat\": \"(number) The total amount of the Invoice with VAT. Must be rounded to maximum 2 decimals. Example: 335.07\",\n \"lineExtensionAmount\": \"(number) Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals. If not supplied this is calculated as the sum of the LineExtensionAmount on the detail lines. Example: 297.00\",\n \"payableAmount\": \"(number) The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals. If not filled in the TaxInclusiveAmount will be used. Example: 335.07\",\n \"payableRoundingAmount\": \"(number) The amount to be added to the invoice total to round the amount to be paid. Must be rounded to maximum 2 decimals. Example: 0.00\",\n \"prepaidAmount\": \"(number) The sum of amounts which have been paid in advance. Must be rounded to maximum 2 decimals. Example: 0.00\"\n },\n \"vatSubTotals\": [\n {\n \"code\": \"(string) VAT category code. Example: S\",\n \"rate\": \"(number) VAT rate. Example: 21.00\",\n \"exemptionReason\": \"(string) Reason for VAT exemption. Example: Intra-community supply\",\n \"exemptionReasonCode\": \"(string) Code for VAT exemption reason. Example: K\",\n \"taxableAmount\": \"(number) Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable). Must be rounded to maximum 2 decimals. Example: 109.41\",\n \"taxAmount\": \"(number) The total VAT amount for a given VAT category. Must be rounded to maximum 2 decimals. Example: 22.98\",\n \"taxTypeIndicator\": \"(string) Additonal Tax Category for non-standard rate\",\n \"splitPaymentIndicator\": \"(string) Split payment indicator\"\n }\n ],\n \"detailLines\": [\n {\n \"id\": \"(string) Unique line ID. Max 100 chars. Example: 1\",\n \"quantity\": \"(number, required) Quantity invoiced. Example: 3\",\n \"articleName\": \"(string, required) Item name. Max 2000 chars. Example: Agenda Timing 2024\",\n \"accountingCost\": \"(string) A textual value that specifies where to book the relevant data into the Buyer's financial accounts. Max 100 chars. Example: 700100\",\n \"additionalItemProperties\": \"(object) Additional properties of the goods/services. Example: { \\\"color\\\": \\\"blue\\\" }\",\n \"allowanceReason\": \"(string) The reason for the allowance on this line, if there is an allowance, expressed as text. Max 1000 chars. Example: Promotion\",\n \"allowanceAmount\": \"(number) The allowance amount, if there is an allowance. Example: 1.00\",\n \"chargeReason\": \"(string) The reason for the charge on this line, if there is a charge, expressed as text. Max 1000 chars. Example: Handling fee\",\n \"chargeAmount\": \"(number) The charge amount, if there is a charge. Example: 1.00\",\n \"commodityClassificationCodes\": \"(object) Classification codes (e.g. UNSPSC, CPV, etc.). Example: { \\\"UNSPSC\\\": \\\"44121706\\\" }\",\n \"articleDescription\": \"(string) Item description. Max 2000 chars. Example: Black hard cover\",\n \"articleNumberBuyer\": \"(string) Buyer's item code. Max 2000 chars. Example: ITM-001\",\n \"articleNumberSupplier\": \"(string) Supplier's item code. Max 200 chars. Example: SUP-7788\",\n \"lineExtensionAmount\": \"(number, required) The total amount of the Invoice line. The amount is \\\"net\\\" without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes. Must be rounded to maximum 2 decimals. Example: 150.00\",\n \"vatRate\": \"(number, required) VAT rate percentage. Example: 21\",\n \"vatCode\": \"(string) VAT category code. Max 200 chars. Example: S\",\n \"orderLineId\": \"(string) Reference to buyer's order line. Max 200 chars. Example: 1000\",\n \"note\": \"(string) A textual note that gives unstructured information that is relevant to the Invoice line. Max 2000 chars. Example: Delivered in January\",\n \"startDate\": \"(string, date) The date when the invoice period for this line starts (YYYY-MM-DD). Example: 2023-11-01\",\n \"endDate\": \"(string, date) The date when the invoice period for this line ends (YYYY-MM-DD). Example: 2023-11-30\",\n \"exemptFromDiscount\": \"(boolean) Set to true to exclude this line from the document level discount. Defaults to false. Example: false\",\n \"deliveryDate\": \"(string, date) Date of delivery for line (YYYY-MM-DD). Example: 2023-01-03\",\n \"deliveryNoteReference\": \"(string) Reference to delivery note. Max 2000 chars. Example: DN-12345\",\n \"docRefDocType\": \"(string) Type of referenced document (code 130 = invoice object reference). Max 2000 chars. Example: 130\",\n \"docRefId\": {\n \"id\": \"(string, required) Identifier of referenced object. Max 200 chars. Example: 998877\",\n \"schemeId\": \"(string, required) Scheme ID of reference. Max 10 chars.\"\n },\n \"originCountryCode\": \"(string) Country of origin (ISO 3166-1 alpha-2). Max 100 chars. Example: BE\",\n \"standardItemIdentification\": {\n \"id\": \"(string, required) Standard item identifier. Max 200 chars. Example: 5412345678908\",\n \"schemeId\": \"(string, required) Identification scheme, using the ICD code list. Max 10 chars. Example: 0160\"\n },\n \"price\": {\n \"articlePrice\": \"(number, required) The price of an item, exclusive of VAT, after subtracting item price discount. The Item net price has to be equal with the Item gross price less the Item price discount, if they are both provided. Item price can not be negative. Example: 50.00\",\n \"baseQuantity\": \"(number) The number of item units to which the price applies. Example: 1\",\n \"unitOfMeasure\": \"(string) Unit of measure. Codes for unit of packaging from UNECE Recommendation No. 21 can be used in accordance with the descriptions in the Intro section of UN/ECE Recommendation 20, Revision 11 (2015): The 2 character alphanumeric code values in UNECE Recommendation 21 shall be used. To avoid duplication with existing code values in UNECE Recommendation No. 20, each code value from UNECE Recommendation 21 shall be prefixed with an \\\"X\\\", resulting in a 3 alphanumeric code when used as a unit of measure. Max 200 chars. Example: H87\",\n \"allowanceAmount\": \"(number) The total discount subtracted from the Item gross price to calculate the Item net price. Example: 55.00\",\n \"allowanceBaseAmount\": \"(number) The unit price, exclusive of VAT, before subtracting Item price discount, can not be negative. Example: 60.00\"\n },\n \"vatExemptionReason\": \"(string) Reason for VAT exemption. Example: Intra-community supply\",\n \"vatExemptionReasonCode\": \"(string) Code for VAT exemption reason. Example: E\",\n \"uuLineNumber\": \"(string) (POLAND) Universal unique line number. Should be unique not only per invoice but per taxpayer or invoicing system\",\n \"lineGTU\": \"(string) Designation for the delivery of goods and the provision of services\",\n \"lineDueDateTypeCode\": \"(string) Code specifying the type of due date that applies to this invoice line.\",\n \"referencedDespatchDocId\": \"(string) An identifier for the despatch advice that this invoice line refers to. Example: DESP-993\",\n \"referencedDespatchDocLineId\": \"(string) An identifier for the line within the referenced despatch advice. Example: 2\",\n \"referencedInvoiceDocId\": \"(string) An identifier for the invoice that this invoice line refers to. Example: INV-2021-77\",\n \"referencedInvoiceDocLineId\": \"(string) An identifier for the line within the referenced invoice. Example: 3\",\n \"referencedInvoiceDocTypeCode\": \"(string) The document type code of the referenced invoice. Example: 380\",\n \"referencedInvoiceDocIssueDate\": \"(string, date) The issue date of the referenced invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"referencedReceiptDocId\": \"(string) An identifier for the receiving advice that this invoice line refers to. Example: RCPT-331\",\n \"referencedReceiptDocLineId\": \"(string) An identifier for the line within the referenced receiving advice. Example: 1\",\n \"referencedSalesOrderDocId\": \"(string) An identifier for the sales order that this invoice line refers to. Example: SO-10099\",\n \"referencedSalesOrderDocLineId\": \"(string) An identifier for the line within the referenced sales order. Example: 4\",\n \"deliveryActualDeliveryDate\": \"(string, date) The date on which the goods or services on this invoice line were actually delivered (YYYY-MM-DD). Example: 2023-01-03\",\n \"deliveryPartyName\": \"(string) The name of the party that the goods or services on this invoice line were delivered to. Example: Soluz.io afleveradres\",\n \"deliveryLocationIDs\": \"(string) An identifier for the delivery location of this invoice line. Example: 5412345000013\",\n \"deliveryLocationAddress1\": \"(string) Street and street number of the delivery location of this invoice line. Example: Berendries 52\",\n \"deliveryLocationAddress2\": \"(string) Additional address line of the delivery location. Example: Building A\",\n \"deliveryLocationAddress3\": \"(string) Additional address line of the delivery location. Example: Floor 2\",\n \"deliveryLocationCity\": \"(string) City of the delivery location. Example: Lovendegem\",\n \"deliveryLocationZIP\": \"(string) Postal code of the delivery location. Example: 5400\",\n \"deliveryLocationCountrySubEntity\": \"(string) Province, state or region of the delivery location. Example: O-Vl\",\n \"deliveryLocationCountryCode\": \"(string) Country of the delivery location (ISO 3166-1 alpha-2). Example: BE\"\n }\n ]\n },\n \"processing\": {\n \"deliveryMethod\": \"(string) Channel through which the invoice was received (e.g. PEPPOL, E-MAIL, POST). Example: PEPPOL\",\n \"extraCode1\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode2\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode3\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode4\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode5\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode6\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode7\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode8\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode9\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode10\": \"(string) Optional extra information that can be used in rules\",\n \"extraInfo\": \"(string) Free-form text, up to 500 chars.\",\n \"senderPartyEntity\": \"(string) ComFin contract number if ComFin customer. Example: BE00001\",\n \"messageType\": \"(string) Message type for XML (default EFFF). Example: EFFF\"\n },\n \"image\": {\n \"embedded\": \"(boolean) Is it an embedded file? Example: true\",\n \"name\": \"(string) File name. Example: factuurImage.pdf\",\n \"mimeType\": \"(string) MIME type. Example: application/pdf\",\n \"value\": \"(string, base64) Base64 content of file. Example: BASE64 here\"\n },\n \"attachments\": [\n {\n \"embedded\": \"(boolean) Is it an embedded file? Example: true\",\n \"name\": \"(string) File name. Example: Attach.pdf\",\n \"mimeType\": \"(string) MIME type. Example: application/pdf\",\n \"value\": \"(string, base64) Base64 content\"\n }\n ],\n \"xml\": {\n \"embedded\": \"(boolean) Is it an embedded file? Example: true\",\n \"name\": \"(string) File name. Example: invoice.xml\",\n \"mimeType\": \"(string) MIME type. Example: application/xml\",\n \"value\": \"(string, base64) Base64 encoded UBL XML\"\n }\n}\n\n»» dueDate: The date when the payment is due.Format \"YYYY-MM-DD\".
In case the Amount due for payment (BT-115) is positive,
either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.
»» documentNumber: A unique identification of the Invoice,
to uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller.
»» invoiceNumber: A unique identification of the Invoice,
to uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller.
»» structuredCommunication: A textual value used to establish a link between the payment and the Invoice, issued by the Seller.
Used for creditor's critical reconciliation information.
This information element helps the Seller to assign an incoming payment to the relevant payment process.
»» taxPointDate: The date when the VAT becomes accountable for the Seller and for the Buyer in so far as that date can be determined and differs from the date of issue of the invoice, according to the VAT directive.
This element is required if the Value added tax point date is different from the Invoice issue date.
»»» accountingCost: Buyer accounting reference
A textual value that specifies where to book the relevant data into the Buyer's financial accounts.
Example value: 4217:2323:2323
»»» companyNumber: This element is used for both the identification of the Payee,
or the unique banking reference identifier of Payee (assigned by the Payee bank.)
For payee identification use ICD code list, for SEPA bank assigned creditor reference, use SEPA.
»»» mandateId: Unique identifier assigned by the Payee for referencing the direct debit mandate.
Used in order to pre-notify the Buyer of a SEPA direct debit.
»»» text: The means, expressed as text, for how a payment is expected to be or has been settled.
Example value: Credit transfer
»»» text: A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties).
In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.
»»» lineExtensionAmount: Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals.
If not supplied this is calculated as the sum of the LineExtensionAmount on the detail lines
»»» payableAmount: The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals.
If not filled in the TaxInclusiveAmount will be used
»»» taxableAmount: Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable).
Must be rounded to maximum 2 decimals.
»»» splitPaymentIndicator: Split payment indicator (\"mechanizm podzielonej płatności\").
Required when invoice total exceeds PLN 15,000 and covers Annex 15 goods/services.
»»» lineExtensionAmount: The total amount of the Invoice line. The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes.
Must be rounded to maximum 2 decimals.
If not supplied, the AmountExclVat will be used
»»»» articlePrice: The price of an item, exclusive of VAT, after subtracting item price discount.
The Item net price has to be equal with the Item gross price less the Item price discount, if they are both provided.
Item price can not be negative.
»»»» unitOfMeasure: The unit of measure that applies to the invoiced quantity.
Codes for unit of packaging from UNECE Recommendation No.
21 can be used in accordance with the descriptions in the \"Intro\" section of UN/ECE Recommendation 20, Revision 11 (2015):
The 2 character alphanumeric code values in UNECE Recommendation 21 shall be used.
To avoid duplication with existing code values in UNECE Recommendation No.
20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure.
»»» uuLineNumber: Universal unique line number
Should be unique not only per invoice but per taxpayer or invoicing system
»»» recipientType: Type of the buyer
Possible values:
12: JST Recipient
21: GV Recipient
»» name: name of the file
If it isn't an embedded file, it should be included as multipart file-data. The name of the file should be identical.
\n\nExample responses
\n
\n\n201 Response
\n
{\n \"id\": \"(number) Internal system ID of the created invoice. Use this id in GetInvoice to retrieve the invoice. Example: 53973544\"\n}\n\nThis operation does not require authentication
\nPOST /inbound/companies/{partyId}/invoices/{id}/feedback
Send invoice feedback
\nSends your response on a received invoice back to the supplier, for example that it was approved, or that information is missing.
\nUsage
\nfeedbackCode and feedbackMessage are required, for example AB with \"Invoice approved for payment\".
Optionally add a coded and textual reason (reasonCode, reason) and the action you expect from the supplier (requestedActionCode, requestedAction).
Check succeeded in the response: false means the feedback could not be sent.
Responses
\n200 OK: the result, with succeeded and a message.
400 Bad Request: the request body is missing or not valid.
404 Not Found: unknown PartyId or invoice.
401 Unauthorized: the API key is missing or not valid.
\n\nBody parameter
\n
{\n \"feedbackCode\": \"(string, required) Code of the feedback that is sent back to the supplier. Example: AB\",\n \"feedbackMessage\": \"(string, required) Description of the feedback. Example: Invoice approved for payment\",\n \"reasonCode\": \"(string) Coded reason for the feedback. Example: REF\",\n \"reason\": \"(string) Textual reason for the feedback. Example: Purchase order reference is missing\",\n \"requestedActionCode\": \"(string) Coded action requested from the supplier. Example: CNF\",\n \"requestedAction\": \"(string) Textual action requested from the supplier. Example: Please send a credit note\"\n}\n\n\n\nExample responses
\n
\n\n200 Response
\n
{\n \"succeeded\": \"(boolean) Indicates if the feedback was set successfully. Example: true\",\n \"message\": \"(string) Informational message. Example: Feedback set for invoice 23110000291\"\n}\n\nThis operation does not require authentication
\nPOST /inbound/companies/{partyId}/inbox/invoices
Search invoices in the inbox
\nSearches the inbox of the company: received invoices that are ready to be downloaded and have not been marked as downloaded yet.
\nUsage
\ninvoicedate-from and invoicedate-to are required. Only invoices with an invoice date in this range (both dates included) are returned. Format: YYYY-MM-DD.
Optional filters: invoiceNumber (exact match), objectId and uniqueId.
page: page-number starts at 1. records-per-page defaults to 20 and is capped at 100.
POST /inbound/companies/{partyId}/inbox/invoices (without /search) does the same, but is deprecated: use /search.
\nTypical flow
\nList or search the inbox to find new invoices.
\nGet each invoice with GET /inbound/companies/{partyId}/invoices/{id} and its files with GET /inbound/companies/{partyId}/invoices/{id}/{format}.
\nMark it as downloaded with POST /inbound/companies/{partyId}/inbox/invoices/{id}/markdownloaded, so it no longer appears in the inbox.
\nResponses
\n200 OK: the current page, the number of totalPages and the matching invoices.
400 Bad Request: the request body is missing or not valid.
404 Not Found: unknown PartyId.
401 Unauthorized: the API key is missing or not valid.
\n\nBody parameter
\n
{\n \"invoicedate-from\": \"(string,date) The start date for the invoice date range. Example: 2023-11-01\",\n \"invoicedate-to\": \"(string,date) The end date for the invoice date range. Example: 2023-11-30\",\n \"invoiceNumber\": \"(string) The invoice number. Example: 23110000291\",\n \"objectId\": \"(string) Object id of the document. Used in GetInvoice to get the details of this invoice. Example: 4728\",\n \"uniqueId\": \"(string) Unique id of the document. Example: 1095953\",\n \"page\": {\n \"page-number\": \"(number) Page number. Example: 2\",\n \"records-per-page\": \"(number) Amount of records per page. Example: 25\"\n },\n \"status\": \"(string) Filter on status. Example: PENDING\"\n}\n\n\n\nExample responses
\n
\n\n200 Response
\n
{\n \"page\": \"(number) Current page number. Example: 1\",\n \"totalPages\": \"(number) Total number of pages available. Example: 5\",\n \"invoices\": [\n {\n \"id\": \"(number) Internal ID of the Invoice. Used in GetInvoice to get the details of this invoice. Example: 53973544\",\n \"uniqueId\": \"(string) Unique identifier. Example: 0000130974010053973544\",\n \"invoiceNumber\": \"(string) Invoice number. Example: 23110000291\",\n \"currency\": \"(string) ISO 4217 currency code. Example: EUR\",\n \"type\": \"(string) Invoice type (INVOICE or CREDITNOTE). Example: INVOICE\",\n \"date\": \"(string, date) Issue date (YYYY-MM-DD). Example: 2023-11-07\",\n \"dueDate\": \"(string, date) Due date for payment (YYYY-MM-DD). Example: 2023-12-07\",\n \"status\": \"(string) Status of the inbound invoice. Example: PENDING\",\n \"clearanceReferenceId\": \"(string) Unique reference identifier associated with the clearance process. Only relevant for countries where clearance is required. Example: 3948572019283746\",\n \"clearanceReferenceDate\": \"(string, date) Date the invoice was cleared by the tax authority. Only relevant for countries where clearance is required. Example: 2023-11-08\",\n \"totals\": {\n \"amountExclVat\": \"(number) Invoice total excl. VAT. Example: 109.41\",\n \"vatAmount\": \"(number) Invoice VAT amount. Example: 22.98\",\n \"amountInclVat\": \"(number) Invoice total incl. VAT. Example: 132.39\"\n },\n \"customer\": {\n \"name\": \"(string) Buyer name, the company receiving the invoice. Example: GEMEENTE STABROEK\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0207537834\"\n },\n \"supplier\": {\n \"name\": \"(string) Seller name, the party that issued the invoice. Example: PANDAVA nv/sa\",\n \"vatNumber\": \"(string) Seller VAT number. Example: BE0419001396\"\n }\n }\n ]\n}\n\nThis operation does not require authentication
\nGET /inbound/companies/{partyId}/inbox/invoices
List invoices in the inbox
\nReturns the first page of the inbox of the company: received invoices that are ready to be downloaded and have not been marked as downloaded yet.
\nUsage
\ntotalPages is more than 1, use POST /inbound/companies/{partyId}/inbox/invoices/search with paging to get the rest.Typical flow
\nList or search the inbox to find new invoices.
\nGet each invoice with GET /inbound/companies/{partyId}/invoices/{id} and its files with GET /inbound/companies/{partyId}/invoices/{id}/{format}.
\nMark it as downloaded with POST /inbound/companies/{partyId}/inbox/invoices/{id}/markdownloaded, so it no longer appears in the inbox.
\nResponses
\n200 OK: the first page of the inbox.
404 Not Found: unknown PartyId.
401 Unauthorized: the API key is missing or not valid.
\n\nExample responses
\n
\n\n200 Response
\n
{\n \"page\": \"(number) Current page number. Example: 1\",\n \"totalPages\": \"(number) Total number of pages available. Example: 5\",\n \"invoices\": [\n {\n \"id\": \"(number) Internal ID of the Invoice. Used in GetInvoice to get the details of this invoice. Example: 53973544\",\n \"uniqueId\": \"(string) Unique identifier. Example: 0000130974010053973544\",\n \"invoiceNumber\": \"(string) Invoice number. Example: 23110000291\",\n \"currency\": \"(string) ISO 4217 currency code. Example: EUR\",\n \"type\": \"(string) Invoice type (INVOICE or CREDITNOTE). Example: INVOICE\",\n \"date\": \"(string, date) Issue date (YYYY-MM-DD). Example: 2023-11-07\",\n \"dueDate\": \"(string, date) Due date for payment (YYYY-MM-DD). Example: 2023-12-07\",\n \"status\": \"(string) Status of the inbound invoice. Example: PENDING\",\n \"clearanceReferenceId\": \"(string) Unique reference identifier associated with the clearance process. Only relevant for countries where clearance is required. Example: 3948572019283746\",\n \"clearanceReferenceDate\": \"(string, date) Date the invoice was cleared by the tax authority. Only relevant for countries where clearance is required. Example: 2023-11-08\",\n \"totals\": {\n \"amountExclVat\": \"(number) Invoice total excl. VAT. Example: 109.41\",\n \"vatAmount\": \"(number) Invoice VAT amount. Example: 22.98\",\n \"amountInclVat\": \"(number) Invoice total incl. VAT. Example: 132.39\"\n },\n \"customer\": {\n \"name\": \"(string) Buyer name, the company receiving the invoice. Example: GEMEENTE STABROEK\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0207537834\"\n },\n \"supplier\": {\n \"name\": \"(string) Seller name, the party that issued the invoice. Example: PANDAVA nv/sa\",\n \"vatNumber\": \"(string) Seller VAT number. Example: BE0419001396\"\n }\n }\n ]\n}\n\nThis operation does not require authentication
\nPOST /inbound/companies/{partyId}/inbox/invoices/search
Search invoices in the inbox
\nSearches the inbox of the company: received invoices that are ready to be downloaded and have not been marked as downloaded yet.
\nUsage
\ninvoicedate-from and invoicedate-to are required. Only invoices with an invoice date in this range (both dates included) are returned. Format: YYYY-MM-DD.
Optional filters: invoiceNumber (exact match), objectId and uniqueId.
page: page-number starts at 1. records-per-page defaults to 20 and is capped at 100.
POST /inbound/companies/{partyId}/inbox/invoices (without /search) does the same, but is deprecated: use /search.
\nTypical flow
\nList or search the inbox to find new invoices.
\nGet each invoice with GET /inbound/companies/{partyId}/invoices/{id} and its files with GET /inbound/companies/{partyId}/invoices/{id}/{format}.
\nMark it as downloaded with POST /inbound/companies/{partyId}/inbox/invoices/{id}/markdownloaded, so it no longer appears in the inbox.
\nResponses
\n200 OK: the current page, the number of totalPages and the matching invoices.
400 Bad Request: the request body is missing or not valid.
404 Not Found: unknown PartyId.
401 Unauthorized: the API key is missing or not valid.
\n\nBody parameter
\n
{\n \"invoicedate-from\": \"(string,date) The start date for the invoice date range. Example: 2023-11-01\",\n \"invoicedate-to\": \"(string,date) The end date for the invoice date range. Example: 2023-11-30\",\n \"invoiceNumber\": \"(string) The invoice number. Example: 23110000291\",\n \"objectId\": \"(string) Object id of the document. Used in GetInvoice to get the details of this invoice. Example: 4728\",\n \"uniqueId\": \"(string) Unique id of the document. Example: 1095953\",\n \"page\": {\n \"page-number\": \"(number) Page number. Example: 2\",\n \"records-per-page\": \"(number) Amount of records per page. Example: 25\"\n },\n \"status\": \"(string) Filter on status. Example: PENDING\"\n}\n\n\n\nExample responses
\n
\n\n200 Response
\n
{\n \"page\": \"(number) Current page number. Example: 1\",\n \"totalPages\": \"(number) Total number of pages available. Example: 5\",\n \"invoices\": [\n {\n \"id\": \"(number) Internal ID of the Invoice. Used in GetInvoice to get the details of this invoice. Example: 53973544\",\n \"uniqueId\": \"(string) Unique identifier. Example: 0000130974010053973544\",\n \"invoiceNumber\": \"(string) Invoice number. Example: 23110000291\",\n \"currency\": \"(string) ISO 4217 currency code. Example: EUR\",\n \"type\": \"(string) Invoice type (INVOICE or CREDITNOTE). Example: INVOICE\",\n \"date\": \"(string, date) Issue date (YYYY-MM-DD). Example: 2023-11-07\",\n \"dueDate\": \"(string, date) Due date for payment (YYYY-MM-DD). Example: 2023-12-07\",\n \"status\": \"(string) Status of the inbound invoice. Example: PENDING\",\n \"clearanceReferenceId\": \"(string) Unique reference identifier associated with the clearance process. Only relevant for countries where clearance is required. Example: 3948572019283746\",\n \"clearanceReferenceDate\": \"(string, date) Date the invoice was cleared by the tax authority. Only relevant for countries where clearance is required. Example: 2023-11-08\",\n \"totals\": {\n \"amountExclVat\": \"(number) Invoice total excl. VAT. Example: 109.41\",\n \"vatAmount\": \"(number) Invoice VAT amount. Example: 22.98\",\n \"amountInclVat\": \"(number) Invoice total incl. VAT. Example: 132.39\"\n },\n \"customer\": {\n \"name\": \"(string) Buyer name, the company receiving the invoice. Example: GEMEENTE STABROEK\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0207537834\"\n },\n \"supplier\": {\n \"name\": \"(string) Seller name, the party that issued the invoice. Example: PANDAVA nv/sa\",\n \"vatNumber\": \"(string) Seller VAT number. Example: BE0419001396\"\n }\n }\n ]\n}\n\nThis operation does not require authentication
\nPOST /inbound/companies/{partyId}/inbox/invoices/{id}/markdownloaded
Mark invoice as downloaded
\nMarks an invoice as downloaded, which removes it from the inbox.
\nUsage
\nCall this after you have stored the invoice and its files, so the next inbox call only returns new invoices.
\nThe invoice itself is not deleted: it stays available through GET /inbound/companies/{partyId}/invoices/{id} and the invoice search.
\nResponses
\n200 OK: a message confirming the invoice was marked as downloaded.
404 Not Found: unknown PartyId, or the invoice is not in the inbox.
401 Unauthorized: the API key is missing or not valid.
\n\nExample responses
\n
\n\n200 Response
\n
{\n \"message\": \"(string) Informational message. Example: Invoice 23110000291 was marked as downloaded\"\n}\n\nThis operation does not require authentication
\nbackwards compatibility
\n\n\n\n\n{\n \"companies\": [\n {\n \"id\": \"(number) PartyId of the company. Use it as {partyId} in all other requests, e.g. GET companies/101/inbox/invoices. Example: 101\",\n \"name\": \"(string) Name of the company. Example: Soluz.io\",\n \"vatNumber\": \"(string) VAT number of the company. Example: BE0123456749\",\n \"companyNumber\": \"(string) National company registry number. Example: 0123456749\"\n },\n {\n \"id\": \"(number) PartyId of the company. Use it as {partyId} in all other requests, e.g. GET companies/102/inbox/invoices. Example: 102\",\n \"name\": \"(string) Name of the company. Example: Pandava nv/sa\",\n \"vatNumber\": \"(string) VAT number of the company. Example: BE0999001396\",\n \"companyNumber\": \"(string) National company registry number. Example: 0999001396\"\n }\n ]\n}\n\nResponse of GET companies: the companies your API key has access to
\nbackwards compatibility
\n\n\n\n\n{\n \"id\": \"(number) PartyId of the company. Use it as {partyId} in all other requests, e.g. GET companies/101/inbox/invoices. Example: 101\",\n \"name\": \"(string) Name of the company. Example: Soluz.io\",\n \"vatNumber\": \"(string) VAT number of the company. Example: BE0123456749\",\n \"companyNumber\": \"(string) National company registry number. Example: 0123456749\"\n}\n\nCompany
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Object that represents an unauthorized error\",\n \"additionalProperties\": false,\n \"properties\": {\n \"message\": {\n \"type\": \"string\",\n \"description\": \"A message\",\n \"nullable\": true\n }\n }\n}\n\nObject that represents an unauthorized error
\nbackwards compatibility
\n\n\n\n\n{\n \"id\": \"(number) Internal system ID of the created eReport. Example: 53973544\"\n}\n\nbackwards compatibility
\n\n\n\n\n{}\n\nNone
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Object that represents a not found error\",\n \"additionalProperties\": false,\n \"properties\": {\n \"statusCode\": {\n \"type\": \"integer\",\n \"description\": \"A status code\",\n \"format\": \"int32\"\n },\n \"message\": {\n \"type\": \"string\",\n \"description\": \"A message\",\n \"nullable\": true\n }\n }\n}\n\nObject that represents a not found error
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Object that represents a not acceptable error\",\n \"additionalProperties\": false,\n \"properties\": {\n \"message\": {\n \"type\": \"string\",\n \"description\": \"A message\",\n \"nullable\": true\n }\n }\n}\n\nObject that represents a not acceptable error
\nbackwards compatibility
\n\n\n\n\n{\n \"Message\": \"The request is invalid.\",\n \"ModelState\": {\n \"model.name\": [\n \"The name field is required.\"\n ]\n }\n}\n\nObject that represents a bad request error
\nbackwards compatibility
\n\n\n\n\n{\n \"id\": \"(number) Internal system ID. Example: 99993544\",\n \"uniqueId\": \"(string) Unique identifier. Example: 0000365474010053973333\",\n \"transactionId\": \"(string) Transaction identifier. Example: 2AF410E4DEF234DB89918E6EEC7DF825\",\n \"invoiceNumber\": \"(string) Invoice number. Example: 23110000291\",\n \"currency\": \"(string) ISO 4217 currency code. Example: EUR\",\n \"type\": \"(string) Invoice type (INVOICE or CREDITNOTE). Example: INVOICE\",\n \"date\": \"(string, date) Issue date (YYYY-MM-DD). Example: 2023-11-07\",\n \"dueDate\": \"(string, date) Due date for payment (YYYY-MM-DD). In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present. Example: 2023-12-07\",\n \"status\": \"(string) Status of the inbound invoice. Example: PENDING\",\n \"clearanceReferenceId\": \"(string) Unique reference identifier associated with the clearance process. Only relevant for countries where clearance is required. Example: 3948572019283746\",\n \"clearanceReferenceDate\": \"(string, date) Date the invoice was cleared by the tax authority. Only relevant for countries where clearance is required. Example: 2023-11-08\",\n \"paymentLink\": \"(string) A link to a payment website, QR code or similar. Example: http://exsite.qr.com/AEU9ZR843J\",\n \"paymentLinkPaidAt\": \"(string, date) The date when the payment link was paid (YYYY-MM-DD). Example: 2023-12-07\",\n \"placeOfIssue\": \"(string) Place where the invoice was issued\",\n \"fullyPaid\": \"(boolean) Indicates if an invoice has been paid\",\n \"dateOfFullPayment\": \"(string) date of payment\",\n \"simplifiedTriangularProcedure\": \"(string) Indication if invoice is issued under simplified procedure by the second taxpayer\",\n \"checkoutMethod\": \"(boolean) Cash accounting indicator\",\n \"selfBillingIndicator\": \"(boolean) Selfbilling indicator\",\n \"warehouseDocumentNumbers\": \"(string) WZ (delivery note) document numbers\",\n \"typeName\": \"(string) Invoice Type\",\n \"restrictedInformation\": \"(string) Indicator if Invoice referred to in Art. 109 sec. 3d of the Act\",\n \"totals\": {\n \"amountExclVat\": \"(number) The total amount of the Invoice without VAT. Must be rounded to maximum 2 decimals. Example: 297.00\",\n \"vatAmount\": \"(number) The total VAT amount for the Invoice or the VAT total amount expressed in the accounting currency accepted or required in the country of the Seller. Must be rounded to maximum 2 decimals. Example: 38.07\",\n \"amountInclVat\": \"(number) The total amount of the Invoice with VAT. Must be rounded to maximum 2 decimals. Example: 335.07\",\n \"lineExtensionAmount\": \"(number) Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals. If not supplied this is calculated as the sum of the LineExtensionAmount on the detail lines. Example: 297.00\",\n \"payableAmount\": \"(number) The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals. If not filled in the TaxInclusiveAmount will be used. Example: 335.07\",\n \"payableRoundingAmount\": \"(number) The amount to be added to the invoice total to round the amount to be paid. Must be rounded to maximum 2 decimals. Example: 0.00\",\n \"prepaidAmount\": \"(number) The sum of amounts which have been paid in advance. Must be rounded to maximum 2 decimals. Example: 0.00\",\n \"chargeAmount\": \"(number) Additional charge excl. VAT. Example: 10\",\n \"allowanceAmount\": \"(number) Total allowance/exemption excl. VAT. Example: 5.00\"\n },\n \"customer\": {\n \"id\": \"(string) Internal customer ID. Example: CUST1\",\n \"name\": \"(string) Buyer name, the company receiving the invoice. Example: GEMEENTE SOL\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0907537834\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"companyNumber\": \"(string) National registry ID (if applicable). Example: 0907537834\",\n \"address\": {\n \"address1\": \"(string) Street. Example: Laatstraat 99\",\n \"city\": \"(string) City. Example: STABROEK\",\n \"zip\": \"(string) Postal code. Example: 2940\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2 code. Example: BE\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"department\": \"(string) Department or branch. Example: DevelopmentDepartment\",\n \"endpointId\": \"(string) Electronic endpoint identifier. Example: BE2929035935\",\n \"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 9925\"\n },\n \"supplier\": {\n \"id\": \"(string) Internal supplier ID. Example: SUP1\",\n \"name\": \"(string) Seller name, the party that issued the invoice. Example: INCREDIBLO nv/sa\",\n \"vatNumber\": \"(string) Seller VAT number. Example: BE0999001396\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"address\": {\n \"address1\": \"(string) Street. Example: Lage Weg 123 A\",\n \"city\": \"(string) City. Example: Hoevenen-Stabroek\",\n \"zip\": \"(string) Postal code. Example: 2940\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2 code. Example: BE\",\n \"taxpayersPrefix\": \"(string) VAT UE country prefix (e.g. PL) for intra-Community supplies, cross-border services, and triangular transactions.\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"department\": \"(string) Department or branch. Example: DevelopmentDepartment\",\n \"endpointId\": \"(string) Electronic endpoint identifier. Example: BE2929035935\",\n \"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 9925\"\n },\n \"buyer\": {\n \"name\": \"(string) Buyer name. Example: Soluz.io\",\n \"address\": {\n \"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n \"zip\": \"(string) Postal code. Example: Tax 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province. Example: Vl-Br\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n \"companyNumberType\": \"(string) Company number type\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0123456749\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"RecipientType\": \"(string) Flag to indicate Subordinate Local Government Unit or GV member\"\n },\n \"references\": {\n \"accountingCost\": \"(string) Buyer accounting reference. Example: 4217:2323:2323\",\n \"billingReferences\": [\n {\n \"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n \"invoiceDocumentReferenceIssueDate\": \"(string, date) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"reasonForCorrection\": \"(string) Reason for correction\",\n \"externalReference\": \"(string) Number identifying the corrected invoice in the National System of e-Invoices\",\n \"typeOfCorrection\": \"(string) Type of correction\"\n }\n ],\n \"buyerReference\": \"(string) An identifier assigned by the Buyer used for internal routing purposes. An invoice must have buyer reference or purchase order reference (BT-13). Example: ABC/984/B2\",\n \"contractDocReference\": \"(string) Contract identifier by seller. Example: CT-2022-001\",\n \"contractDocIssueDate\": \"(string, date) Contract date by seller (YYYY-MM-DD). Example: 2022-01-15\",\n \"contractDocReferenceCustomer\": \"(string) Contract identifier by customer. Example: CUST-CT-88\",\n \"contractDocIssueDateCustomer\": \"(string, date) Contract date by customer (YYYY-MM-DD). Example: 2022-01-20\",\n \"despatchDocReference\": \"(string) Dispatch advice ID. Example: DESP-993\",\n \"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n \"invoiceDocumentReferenceIssueDate\": \"(string, date) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"originatorDocReference\": \"(string) Tender or lot reference. Example: TND-2022-01\",\n \"projectReference\": \"(string) Project reference. Example: PROJ-Delta-01\",\n \"receiptDocReference\": \"(string) Receiving advice ID. Example: RCPT-331\",\n \"purchaseOrderReference\": \"(string) Purchase order ID. Example: PA992430\",\n \"salesOrderReference\": \"(string) Sales order ID. Example: 11-145210\"\n },\n \"detailLines\": [\n {\n \"id\": \"(string) Unique identifier for this invoice line. Example: 1\",\n \"additionalItemProperties\": \"(object) Additional properties of the goods/services. Example: { \\\"color\\\": \\\"blue\\\" }\",\n \"articleName\": \"(string) Item name. Example: Agenda Timing 2024 genaaid Lima zwart\",\n \"articleDescription\": \"(string) Item description, more detail than name. Example: Hardcover planner with stitched binding\",\n \"articleNumberBuyer\": \"(string) Buyer-assigned item identifier. Example: B-98431\",\n \"articleNumberSupplier\": \"(string) Seller-assigned item identifier. Example: 56.1142.021/9\",\n \"lineExtensionAmount\": \"(number) Net line amount excl. VAT (inclusive of line-level allowances/charges). Example: 9.06\",\n \"commodityClassificationCodes\": \"(object) Classification codes (e.g. UNSPSC, CPV, etc.). Example: { \\\"UNSPSC\\\": \\\"44121706\\\" }\",\n \"deliveryDate\": \"(string, date) Delivery date (YYYY-MM-DD). Example: 2023-11-05\",\n \"deliveryNoteReference\": \"(string) Reference to a delivery note. Example: DN-2023-1115\",\n \"docRefDocType\": \"(string) Document type code for referenced object (use 130 for invoice object reference). Example: 130\",\n \"docRefId\": {\n \"id\": \"(string) Identifier value. Example: 123456789\",\n \"schemeId\": \"(string) Identifier scheme ID.\"\n },\n \"note\": \"(string) Unstructured note relevant to this line. Example: Urgent delivery\",\n \"originCountryCode\": \"(string) Country of origin (ISO 3166-1 alpha-2). Example: BE\",\n \"accountingCost\": \"(string) Buyer's accounting allocation reference. Example: 4217:2323:2323\",\n \"startDate\": \"(string, date) Invoice period start date (YYYY-MM-DD). Example: 2023-11-01\",\n \"endDate\": \"(string, date) Invoice period end date (YYYY-MM-DD). Example: 2023-11-30\",\n \"vatCode\": \"(string) VAT category code. Example: S\",\n \"vatRate\": \"(number) VAT rate (%) applied. Example: 21.00\",\n \"orderLineId\": \"(string) Buyer purchase order line reference. Example: 15\",\n \"quantity\": \"(number) Quantity of items invoiced. Example: 2.00\",\n \"standardItemIdentification\": {\n \"id\": \"(string) Standard identifier value. Example: 5412345123453\",\n \"schemeId\": \"(string) Standard identifier scheme (e.g. 0160(GTIN), 0088(EAN) from https://docs.peppol.eu/poacc/billing/3.0/codelist/ICD/). Example: 0160\"\n },\n \"price\": {\n \"articlePrice\": \"(number) The price of an item, exclusive of VAT, after subtracting item price discount. The Item net price has to be equal with the Item gross price minus the Item price discount, if they are both provided. Item price can not be negative. Example: 50.00\",\n \"baseQuantity\": \"(number) Quantity basis for price. Example: 1\",\n \"unitOfMeasure\": \"(string) Unit of measure. Codes for unit of packaging from UNECE Recommendation No. 21 can be used in accordance with the descriptions in the Intro section of UN/ECE Recommendation 20, Revision 11 (2015): The 2 character alphanumeric code values in UNECE Recommendation 21 shall be used. o avoid duplication with existing code values in UNECE Recommendation No. 20, each code value from UNECE Recommendation 21 shall be prefixed with an \\\"X\\\", resulting in a 3 alphanumeric code when used as a unit of measure. Example: H87\",\n \"allowanceAmount\": \"(number) The total discount subtracted from the Item gross price to calculate the Item net price. Example: 55.00\",\n \"allowanceBaseAmount\": \"(number) The unit price, exclusive of VAT, before subtracting Item price discount, can not be negative. Example: 60.00\"\n },\n \"allowanceCharge\": {\n \"reason\": \"(string) Reason for allowance/charge. Example: Promotion\",\n \"reasonCode\": \"(string) Coded reason for allowance/charge. Example: 95\",\n \"amount\": \"(decimal) Amount excl. VAT. Example: 1.00\",\n \"chargeIndicator\": \"(number) true=Charge, false=Allowance. Example: false\",\n \"taxCode\": \"(string) VAT category code. Example: S\",\n \"taxPercentage\": \"(number) VAT rate for allowance/charge. Example: 21.00\"\n },\n \"vatExemptionReason\": \"(string) Reason text if VAT-exempt. Example: Intra-community supply\",\n \"vatExemptionReasonCode\": \"(string) Reason code if VAT-exempt. Example: K\",\n \"uULineNumer\": \"(string) (POLAND) Universal unique line number. Should be unique not only per invoice but per taxpayer or invoicing system\",\n \"lineGTU\": \"(string) Designation for the delivery of goods and the provision of services\"\n }\n ],\n \"allowanceCharges\": [\n {\n \"reason\": \"(string) Textual reason for allowance/charge. Example: Early payment discount\",\n \"reasonCode\": \"(string) UNCL5189/UNCL7161 code. Example: 95\",\n \"amount\": \"(number) Amount excl. VAT. Example: 5.00\",\n \"chargeIndicator\": \"(boolean) true=Charge, false=Allowance. Example: false\",\n \"taxCode\": \"(string) VAT category code. Example: S\",\n \"taxPercentage\": \"(number) VAT rate for allowance/charge. Example: 21.00\"\n }\n ],\n \"vatSubTotals\": [\n {\n \"code\": \"(string) VAT category code. Example: S\",\n \"rate\": \"(number) VAT rate. Example: 21.00\",\n \"taxableAmount\": \"(number) Taxable amount. Example: 109.41\",\n \"taxAmount\": \"(number) VAT amount. Example: 22.98\",\n \"taxTypeIndicator\": \"(string) Additonal Tax Category for non-standard rate\",\n \"splitPaymentIndicator\": \"(string) Split payment indicator\"\n }\n ],\n \"files\": [\n {\n \"id\": \"(integer) File ID. Example: 53973545\",\n \"name\": \"(string) File name. Example: examplefilename.xml\",\n \"size\": \"(string) File size. Example: 13.98 KB\",\n \"pages\": \"(number) Page count. Example: 0\",\n \"package\": \"(string) File type (XML, PDF, UBL, etc.). Use this value as the {format} in GetInvoiceFile. Example: XML\"\n }\n ]\n}\n\nAn inbound invoice, used for fetch of an inbound invoice
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Invoice totals\",\n \"additionalProperties\": false,\n \"properties\": {\n \"amountExclVat\": {\n \"type\": \"number\",\n \"description\": \"The total amount of the Invoice without VAT.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"amountInclVat\": {\n \"type\": \"number\",\n \"description\": \"The total amount of the Invoice with VAT. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"lineExtensionAmount\": {\n \"type\": \"number\",\n \"description\": \"Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals.\\nIf not supplied this is calculated as the sum of the LineExtensionAmount on the detail lines\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"payableAmount\": {\n \"type\": \"number\",\n \"description\": \"The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals.\\nIf not filled in the TaxInclusiveAmount will be used\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"payableRoundingAmount\": {\n \"type\": \"number\",\n \"description\": \"The amount to be added to the invoice total to round the amount to be paid. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"prepaidAmount\": {\n \"type\": \"number\",\n \"description\": \"The sum of amounts which have been paid in advance. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"vatAmount\": {\n \"type\": \"number\",\n \"description\": \"The total VAT amount for the Invoice or the VAT total amount expressed in the accounting currency accepted or required in the country of the Seller. Must be rounded to maximum 2 decimals \",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"chargeAmount\": {\n \"type\": \"number\",\n \"description\": \"The sum of all charges on document level in the Invoice. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"allowanceAmount\": {\n \"type\": \"number\",\n \"description\": \"The sum of all allowances on document level in the Invoice. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\",\n \"nullable\": true\n }\n }\n}\n\nInvoice totals
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Response model containing customer information as returned by the API.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Internal customer ID in sender's system\",\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"nullable\": true\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"nullable\": true\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"nullable\": true\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"nullable\": true\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"nullable\": true\n }\n }\n },\n \"contact\": {\n \"type\": \"object\",\n \"description\": \"Business contact\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Id of the business contact\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the business contact\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the business contact\",\n \"maxLength\": 300,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Phone number of the contact\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"companyNumber\": {\n \"type\": \"string\",\n \"description\": \"Company number of the customer. CompanyNumber or VAT Number required for companies\",\n \"nullable\": true\n },\n \"department\": {\n \"type\": \"string\",\n \"description\": \"Department of the customer\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the customer\",\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"VAT number of the customer. CompanyNumber or VAT Number required for companies\",\n \"nullable\": true\n },\n \"glnNumber\": {\n \"type\": \"string\",\n \"description\": \"Glnnumber of the customer\",\n \"nullable\": true\n },\n \"endpointId\": {\n \"type\": \"string\",\n \"description\": \"EndpointId of the customer\",\n \"nullable\": true\n },\n \"endpointType\": {\n \"type\": \"string\",\n \"description\": \"EndpointType of the customer\",\n \"nullable\": true\n },\n \"identifications\": {\n \"type\": \"array\",\n \"description\": \"Additional identifiers for the party.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n }\n }\n }\n}\n\nResponse model containing customer information as returned by the API.
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"nullable\": true\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"nullable\": true\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"nullable\": true\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"nullable\": true\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"nullable\": true\n }\n }\n}\n\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Business contact\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Id of the business contact\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the business contact\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the business contact\",\n \"maxLength\": 300,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Phone number of the contact\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nBusiness contact
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n}\n\nRepresents an identifier with a value and a scheme.
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Supplier info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Internal supplier ID in receiver's system\",\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"nullable\": true\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"nullable\": true\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"nullable\": true\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"nullable\": true\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"nullable\": true\n }\n }\n },\n \"contact\": {\n \"type\": \"object\",\n \"description\": \"Business contact\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Id of the business contact\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the business contact\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the business contact\",\n \"maxLength\": 300,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Phone number of the contact\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"companyNumber\": {\n \"type\": \"string\",\n \"description\": \"Company number of the supplier. CompanyNumber or VAT Number required for companies\",\n \"nullable\": true\n },\n \"department\": {\n \"type\": \"string\",\n \"description\": \"Department of the supplier\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the supplier\",\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"VAT number of the supplier. CompanyNumber or VAT Number required for companies\",\n \"nullable\": true\n },\n \"glnNumber\": {\n \"type\": \"string\",\n \"description\": \"Glnnumber of the Supplier\",\n \"nullable\": true\n },\n \"endpointId\": {\n \"type\": \"string\",\n \"description\": \"EndpointId of the supplier\",\n \"nullable\": true\n },\n \"endpointType\": {\n \"type\": \"string\",\n \"description\": \"EndpointType of the supplier\",\n \"nullable\": true\n },\n \"taxpayersPrefix\": {\n \"type\": \"string\",\n \"description\": \"VAT UE country prefix (e.g. \\\"PL\\\") for intra-Community supplies, cross-border services, and triangular transactions.\",\n \"nullable\": true\n },\n \"identifications\": {\n \"type\": \"array\",\n \"description\": \"Additional identifiers for the party.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n }\n }\n }\n}\n\nSupplier info
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"References\",\n \"additionalProperties\": false,\n \"properties\": {\n \"accountingCost\": {\n \"type\": \"string\",\n \"description\": \"Buyer accounting reference\\nA textual value that specifies where to book the relevant data into the Buyer's financial accounts.\\nExample value: 4217:2323:2323\",\n \"nullable\": true\n },\n \"billingReferences\": {\n \"type\": \"array\",\n \"description\": \"A group of business terms providing information on the preceding Invoice.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"invoiceDocumentReference\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"invoiceDocumentReferenceIssueDate\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"reasonForCorrection\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"documentTypeCode\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"externalReference\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"typeOfCorrection\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n }\n },\n \"buyerReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier assigned by the Buyer used for internal routing purposes. An invoice must have buyer reference or purchase order reference (BT-13).\",\n \"nullable\": true\n },\n \"contractDocReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of a contract as specified by the sender\",\n \"nullable\": true\n },\n \"contractDocIssueDate\": {\n \"type\": \"string\",\n \"description\": \"Date of the contract as specified by the sender\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"contractDocReferenceCustomer\": {\n \"type\": \"string\",\n \"description\": \"The identification of a contract as specified by the receiver\",\n \"nullable\": true\n },\n \"contractDocIssueDateCustomer\": {\n \"type\": \"string\",\n \"description\": \"Date of the contract as specified by the receiver\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"despatchDocReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced despatch advice.\",\n \"nullable\": true\n },\n \"invoiceDocumentReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of an Invoice that was previously sent by the Seller.\",\n \"nullable\": true\n },\n \"invoiceDocumentReferenceIssueDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Preceding Invoice was issued.Shall be provided in case the Preceding Invoice identifier is not unique. Format = \\\"YYYY-MM-DD\\\".\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"originatorDocReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of the call for tender or lot the invoice relates to.\",\n \"nullable\": true\n },\n \"projectReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of the project the invoice refers to.\",\n \"nullable\": true\n },\n \"purchaseOrderReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced purchase order, issued by the Buyer.An invoice must have buyer reference (BT-10) or purchase order reference.\",\n \"nullable\": true\n },\n \"receiptDocReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced receiving advice.\",\n \"nullable\": true\n },\n \"salesOrderIssueDate\": {\n \"type\": \"string\",\n \"description\": \"Spain only: add Issuer transaction date (recommended, not mandatory)\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"salesOrderReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced sales order, issued by the Seller.\",\n \"nullable\": true\n }\n }\n}\n\nReferences
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"invoiceDocumentReference\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"invoiceDocumentReferenceIssueDate\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"reasonForCorrection\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"documentTypeCode\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"externalReference\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"typeOfCorrection\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Class that holds an invoice detail line\",\n \"additionalProperties\": false,\n \"properties\": {\n \"additionalItemProperties\": {\n \"type\": \"object\",\n \"description\": \"A group of business terms providing information about properties of the goods and services invoiced.\",\n \"nullable\": true,\n \"additionalProperties\": {\n \"type\": \"string\"\n }\n },\n \"articleName\": {\n \"type\": \"string\",\n \"description\": \"A name for an item.\",\n \"nullable\": true\n },\n \"articleDescription\": {\n \"type\": \"string\",\n \"description\": \"A description for an item.The item description allows for describing the item and its features in more detail than the Item name.\",\n \"nullable\": true\n },\n \"articleNumberBuyer\": {\n \"type\": \"string\",\n \"description\": \"An identifier, assigned by the Buyer, for the item.\",\n \"nullable\": true\n },\n \"articleNumberSupplier\": {\n \"type\": \"string\",\n \"description\": \"An identifier, assigned by the Seller, for the item.\",\n \"nullable\": true\n },\n \"lineExtensionAmount\": {\n \"type\": \"number\",\n \"description\": \"The total amount of the Invoice line. The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes.\\nMust be rounded to maximum 2 decimals.\\nIf not supplied, the AmountExclVat will be used\",\n \"format\": \"decimal\"\n },\n \"commodityClassificationCodes\": {\n \"type\": \"object\",\n \"description\": \"A code for classifying the item by its type or nature.\",\n \"nullable\": true,\n \"additionalProperties\": {\n \"type\": \"string\"\n }\n },\n \"deliveryDate\": {\n \"type\": \"string\",\n \"description\": \"Delivery date\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"deliveryNoteReference\": {\n \"type\": \"string\",\n \"description\": \"Delivery note reference\",\n \"nullable\": true\n },\n \"docRefDocType\": {\n \"type\": \"string\",\n \"description\": \"Code \\\"130\\\" MUST be used to indicate an invoice object reference. Not used for other additional documents\",\n \"nullable\": true\n },\n \"docRefId\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n },\n \"note\": {\n \"type\": \"string\",\n \"description\": \"A textual note that gives unstructured information that is relevant to the Invoice line.\",\n \"nullable\": true\n },\n \"originCountryCode\": {\n \"type\": \"string\",\n \"description\": \"The code identifying the country from which the item originates.\",\n \"nullable\": true\n },\n \"id\": {\n \"type\": \"string\",\n \"description\": \"A unique identifier for the individual line within the Invoice.\",\n \"nullable\": true\n },\n \"accountingCost\": {\n \"type\": \"string\",\n \"description\": \"A textual value that specifies where to book the relevant data into the Buyer's financial accounts.\",\n \"nullable\": true\n },\n \"startDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Invoice period for this Invoice line starts. Format =\\\"YYYY-MM-DD\\\"\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"endDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Invoice period for this Invoice line ends. Format =\\\"YYYY-MM-DD\\\"\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"vatCode\": {\n \"type\": \"string\",\n \"description\": \"The VAT category code for the invoiced item.\",\n \"nullable\": true\n },\n \"vatRate\": {\n \"type\": \"number\",\n \"description\": \"The VAT rate, represented as percentage that applies to the invoiced item.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"orderLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for a referenced line within a purchase order, issued by the Buyer.\",\n \"nullable\": true\n },\n \"quantity\": {\n \"type\": \"number\",\n \"description\": \"The quantity of items (goods or services) that is charged in the Invoice line.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"standardItemIdentification\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n },\n \"price\": {\n \"type\": \"object\",\n \"description\": \"A group of items related to the price of an invoiced item\",\n \"additionalProperties\": false,\n \"required\": [\n \"articlePrice\"\n ],\n \"properties\": {\n \"articlePrice\": {\n \"type\": \"number\",\n \"description\": \"The price of an item, exclusive of VAT, after subtracting item price discount.\\nThe Item net price has to be equal with the Item gross price less the Item price discount, if they are both provided.\\nItem price can not be negative.\",\n \"format\": \"decimal\"\n },\n \"baseQuantity\": {\n \"type\": \"number\",\n \"description\": \"The number of item units to which the price applies.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"unitOfMeasure\": {\n \"type\": \"string\",\n \"description\": \"The unit of measure that applies to the invoiced quantity.\\nCodes for unit of packaging from UNECE Recommendation No.\\n21 can be used in accordance with the descriptions in the \\\"Intro\\\" section of UN/ECE Recommendation 20, Revision 11 (2015):\\nThe 2 character alphanumeric code values in UNECE Recommendation 21 shall be used.\\nTo avoid duplication with existing code values in UNECE Recommendation No.\\n20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"allowanceAmount\": {\n \"type\": \"number\",\n \"description\": \"The total discount subtracted from the Item gross price to calculate the Item net price.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"allowanceBaseAmount\": {\n \"type\": \"number\",\n \"description\": \"The unit price, exclusive of VAT, before subtracting Item price discount, can not be negative\",\n \"format\": \"decimal\",\n \"nullable\": true\n }\n }\n },\n \"allowanceCharge\": {\n \"type\": \"object\",\n \"description\": \"A group of items related to an allowance or charge of an invoiced item\",\n \"additionalProperties\": false,\n \"properties\": {\n \"amount\": {\n \"type\": \"number\",\n \"description\": \"The amount of an allowance or a charge, without VAT. Must be rounded to maximum 2 decimals\",\n \"format\": \"decimal\"\n },\n \"baseAmount\": {\n \"type\": \"number\",\n \"description\": \"The base amount that may be used, in conjunction with the line level allowance or charge percentage, to calculate the line level allowance or charge amount.\\nMust be rounded to maximum 2 decimals\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"chargeIndicator\": {\n \"type\": \"boolean\",\n \"description\": \"Use “true” when informing about Charges and “false” when informing about Allowances\"\n },\n \"percentage\": {\n \"type\": \"number\",\n \"description\": \"The percentage that may be used, in conjunction with the line level allowance base amount, to calculate the line level allowance or charge amount.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"reason\": {\n \"type\": \"string\",\n \"description\": \"The reason for the line level allowance or charge, expressed as text.\",\n \"nullable\": true\n },\n \"reasonCode\": {\n \"type\": \"string\",\n \"description\": \"The reason for the line level allowance or charge, expressed as a code.\",\n \"nullable\": true\n }\n }\n },\n \"vatExemptionReason\": {\n \"type\": \"string\",\n \"description\": \"The VatExemptionReason\",\n \"nullable\": true\n },\n \"vatExemptionReasonCode\": {\n \"type\": \"string\",\n \"description\": \"The VatExemptionReasonCode\",\n \"nullable\": true\n },\n \"uuLineNumber\": {\n \"type\": \"string\",\n \"description\": \"Universal unique line number\\nShould be unique not only per invoice but per taxpayer or invoicing system\",\n \"nullable\": true\n },\n \"lineGTU\": {\n \"type\": \"string\",\n \"description\": \"Designation for the delivery of goods and the provision of services\",\n \"nullable\": true\n },\n \"lineDueDateTypeCode\": {\n \"type\": \"string\",\n \"description\": \"Code specifying the type of due date that applies to this Invoice line.\",\n \"nullable\": true\n },\n \"referencedDespatchDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the despatch advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedDespatchDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced despatch advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the invoice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced invoice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocTypeCode\": {\n \"type\": \"string\",\n \"description\": \"The document type code of the referenced invoice.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocIssueDate\": {\n \"type\": \"string\",\n \"description\": \"The issue date of the referenced invoice. Format = \\\"YYYY-MM-DD\\\"\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"referencedReceiptDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the receiving advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedReceiptDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced receiving advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedSalesOrderDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the sales order that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedSalesOrderDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced sales order that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"deliveryActualDeliveryDate\": {\n \"type\": \"string\",\n \"description\": \"The date on which the goods or services on this Invoice line were actually delivered. Format = \\\"YYYY-MM-DD\\\"\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"deliveryPartyName\": {\n \"type\": \"string\",\n \"description\": \"The name of the party that the goods or services on this Invoice line were delivered to.\",\n \"nullable\": true\n },\n \"deliveryLocationIDs\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationAddress1\": {\n \"type\": \"string\",\n \"description\": \"Street and street number of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationAddress2\": {\n \"type\": \"string\",\n \"description\": \"Additional address line of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationAddress3\": {\n \"type\": \"string\",\n \"description\": \"Additional address line of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationCity\": {\n \"type\": \"string\",\n \"description\": \"City of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationZIP\": {\n \"type\": \"string\",\n \"description\": \"Postal code of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationCountrySubEntity\": {\n \"type\": \"string\",\n \"description\": \"Province, state or region of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationCountryCode\": {\n \"type\": \"string\",\n \"description\": \"The country of the delivery location of this Invoice line, as an ISO 3166-1 alpha-2 code.\",\n \"nullable\": true\n }\n }\n}\n\nClass that holds an invoice detail line
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"A group of items related to the price of an invoiced item\",\n \"additionalProperties\": false,\n \"required\": [\n \"articlePrice\"\n ],\n \"properties\": {\n \"articlePrice\": {\n \"type\": \"number\",\n \"description\": \"The price of an item, exclusive of VAT, after subtracting item price discount.\\nThe Item net price has to be equal with the Item gross price less the Item price discount, if they are both provided.\\nItem price can not be negative.\",\n \"format\": \"decimal\"\n },\n \"baseQuantity\": {\n \"type\": \"number\",\n \"description\": \"The number of item units to which the price applies.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"unitOfMeasure\": {\n \"type\": \"string\",\n \"description\": \"The unit of measure that applies to the invoiced quantity.\\nCodes for unit of packaging from UNECE Recommendation No.\\n21 can be used in accordance with the descriptions in the \\\"Intro\\\" section of UN/ECE Recommendation 20, Revision 11 (2015):\\nThe 2 character alphanumeric code values in UNECE Recommendation 21 shall be used.\\nTo avoid duplication with existing code values in UNECE Recommendation No.\\n20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"allowanceAmount\": {\n \"type\": \"number\",\n \"description\": \"The total discount subtracted from the Item gross price to calculate the Item net price.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"allowanceBaseAmount\": {\n \"type\": \"number\",\n \"description\": \"The unit price, exclusive of VAT, before subtracting Item price discount, can not be negative\",\n \"format\": \"decimal\",\n \"nullable\": true\n }\n }\n}\n\nA group of items related to the price of an invoiced item
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"A group of items related to an allowance or charge of an invoiced item\",\n \"additionalProperties\": false,\n \"properties\": {\n \"amount\": {\n \"type\": \"number\",\n \"description\": \"The amount of an allowance or a charge, without VAT. Must be rounded to maximum 2 decimals\",\n \"format\": \"decimal\"\n },\n \"baseAmount\": {\n \"type\": \"number\",\n \"description\": \"The base amount that may be used, in conjunction with the line level allowance or charge percentage, to calculate the line level allowance or charge amount.\\nMust be rounded to maximum 2 decimals\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"chargeIndicator\": {\n \"type\": \"boolean\",\n \"description\": \"Use “true” when informing about Charges and “false” when informing about Allowances\"\n },\n \"percentage\": {\n \"type\": \"number\",\n \"description\": \"The percentage that may be used, in conjunction with the line level allowance base amount, to calculate the line level allowance or charge amount.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"reason\": {\n \"type\": \"string\",\n \"description\": \"The reason for the line level allowance or charge, expressed as text.\",\n \"nullable\": true\n },\n \"reasonCode\": {\n \"type\": \"string\",\n \"description\": \"The reason for the line level allowance or charge, expressed as a code.\",\n \"nullable\": true\n }\n }\n}\n\nA group of items related to an allowance or charge of an invoiced item
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"A group of business terms providing information about allowances applicable to the Invoice as a whole.\\nA group of business terms providing information about charges and taxes other than VAT, applicable to the Invoice as a whole.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"reason\": {\n \"type\": \"string\",\n \"description\": \"The reason for the document level allowance or charge, expressed as text.\\nThe Document level allowance reason code and the Document level allowance reason shall indicate the same allowance reason\",\n \"nullable\": true\n },\n \"reasonCode\": {\n \"type\": \"string\",\n \"description\": \"The reason for the document level allowance or charge, expressed as a code.\\nFor allowances a subset of codelist UNCL5189 is to be used, and for charges codelist UNCL7161 applies.\\nThe Document level allowance reason code and the Document level allowance reason shall indicate the same allowance reason\",\n \"nullable\": true\n },\n \"amount\": {\n \"type\": \"number\",\n \"description\": \"The amount of an allowance or a charge, without VAT. Must be rounded to maximum 2 decimals\",\n \"format\": \"decimal\"\n },\n \"chargeIndicator\": {\n \"type\": \"boolean\",\n \"description\": \"Use “true” when informing about Charges and “false” when informing about Allowances.\"\n },\n \"taxCode\": {\n \"type\": \"string\",\n \"description\": \"A coded identification of what VAT category applies to the document level allowance or charge.\",\n \"nullable\": true\n },\n \"taxPercentage\": {\n \"type\": \"number\",\n \"description\": \"The VAT rate, represented as percentage that applies to the document level allowance or charge.\",\n \"format\": \"decimal\"\n },\n \"taxExemptionReason\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"taxExemptionReasonCode\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n}\n\nA group of business terms providing information about allowances applicable to the Invoice as a whole.
A group of business terms providing information about charges and taxes other than VAT, applicable to the Invoice as a whole.
backwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"VAT Sub totals\",\n \"additionalProperties\": false,\n \"properties\": {\n \"code\": {\n \"type\": \"string\",\n \"description\": \"Coded identification of a VAT category.\",\n \"nullable\": true\n },\n \"rate\": {\n \"type\": \"number\",\n \"description\": \"The VAT rate, represented as percentage that applies for the relevant VAT category.\",\n \"format\": \"decimal\"\n },\n \"exemptionReasonCode\": {\n \"type\": \"string\",\n \"description\": \"A coded statement of the reason for why the amount is exempted from VAT.\",\n \"nullable\": true\n },\n \"exemptionReason\": {\n \"type\": \"string\",\n \"description\": \"A textual statement of the reason why the amount is exempted from VAT or why no VAT is being charged.\",\n \"nullable\": true\n },\n \"taxableAmount\": {\n \"type\": \"number\",\n \"description\": \"Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable).\\nMust be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\"\n },\n \"taxAmount\": {\n \"type\": \"number\",\n \"description\": \"The total VAT amount for a given VAT category. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\"\n },\n \"taxTypeIndicator\": {\n \"type\": \"string\",\n \"description\": \"Tax category for non-standard VAT rates\",\n \"nullable\": true\n },\n \"splitPaymentIndicator\": {\n \"type\": \"string\",\n \"description\": \"Split payment indicator (\\\"mechanizm podzielonej płatności\\\").\\nRequired when invoice total exceeds PLN 15,000 and covers Annex 15 goods/services.\",\n \"nullable\": true\n }\n }\n}\n\nVAT Sub totals
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"PaymentMeans info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"mandateId\": {\n \"type\": \"string\",\n \"description\": \"Unique identifier assigned by the Payee for referencing the direct debit mandate.\\nUsed in order to pre-notify the Buyer of a SEPA direct debit.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"mandateFinancialAccountId\": {\n \"type\": \"string\",\n \"description\": \"The account to be debited by the direct debit.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"code\": {\n \"type\": \"string\",\n \"description\": \"The means, expressed as code, for how a payment is expected to be or has been settled.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"text\": {\n \"type\": \"string\",\n \"description\": \"The means, expressed as text, for how a payment is expected to be or has been settled.\\nExample value: Credit transfer\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"paymentId\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"payeeFinancialInstitutionId\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"payeeFinancialAccountId\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"payeeFinancialAccountSchemeId\": {\n \"type\": \"string\",\n \"maxLength\": 20,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"payeeFinancialAccountName\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"cardId\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"cardHolderName\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nPaymentMeans info
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"An additional party involved in the invoice, beyond the Customer, Supplier, Buyer,\\nPayee and TaxRepresentative that have their own dedicated groups. The role the party\\ntakes on the invoice is given by RoleCode.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"partyName\": {\n \"type\": \"string\",\n \"description\": \"The name of the party.\",\n \"nullable\": true\n },\n \"roleCode\": {\n \"type\": \"string\",\n \"description\": \"A code identifying the role that this party takes on the invoice.\",\n \"nullable\": true\n },\n \"endpointID\": {\n \"type\": \"string\",\n \"description\": \"The electronic endpoint identifier of the party.\",\n \"nullable\": true\n },\n \"endpointIDType\": {\n \"type\": \"string\",\n \"description\": \"The endpoint type or scheme which relates to the EndpointID.\",\n \"nullable\": true\n },\n \"identifiers\": {\n \"type\": \"array\",\n \"description\": \"Additional identifiers for the party. Both members of each identifier are mandatory.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n }\n },\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Street and street number of the party.\",\n \"nullable\": true\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Additional address line of the party.\",\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Additional address line of the party.\",\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City of the party.\",\n \"nullable\": true\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"Postal code of the party.\",\n \"nullable\": true\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"The country of the party, as an ISO 3166-1 alpha-2 code.\",\n \"nullable\": true\n },\n \"countryName\": {\n \"type\": \"string\",\n \"description\": \"The country name of the party.\",\n \"nullable\": true\n },\n \"countrySubEntity\": {\n \"type\": \"string\",\n \"description\": \"Province, state or region of the party.\",\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"The VAT number of the party.\",\n \"nullable\": true\n },\n \"contactID\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the contact of the party.\",\n \"nullable\": true\n },\n \"contactName\": {\n \"type\": \"string\",\n \"description\": \"The contact person of the party.\",\n \"nullable\": true\n },\n \"contactEmail\": {\n \"type\": \"string\",\n \"description\": \"The contact email address of the party.\",\n \"nullable\": true\n },\n \"contactPhone\": {\n \"type\": \"string\",\n \"description\": \"The contact phone number of the party.\",\n \"nullable\": true\n },\n \"partyLERegistrationName\": {\n \"type\": \"string\",\n \"description\": \"The registered legal entity name of the party.\",\n \"nullable\": true\n },\n \"partyLECompanyID\": {\n \"type\": \"string\",\n \"description\": \"The legal entity company identifier of the party (e.g. Belgium CBE/KBO).\",\n \"nullable\": true\n },\n \"partyLECompanyIDType\": {\n \"type\": \"string\",\n \"description\": \"The scheme of the legal entity company identifier, using the ICD code list.\",\n \"nullable\": true\n },\n \"partyLECompanyLegalForm\": {\n \"type\": \"string\",\n \"description\": \"The legal form of the legal entity.\",\n \"nullable\": true\n },\n \"recipientType\": {\n \"type\": \"string\",\n \"description\": \"Flag to indicate Subordinate Local Government Unit or GV member.\",\n \"nullable\": true\n }\n }\n}\n\nAn additional party involved in the invoice, beyond the Customer, Supplier, Buyer,
Payee and TaxRepresentative that have their own dedicated groups. The role the party
takes on the invoice is given by RoleCode.
backwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"PaymentTerms info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"text\": {\n \"type\": \"string\",\n \"description\": \"A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties).\\nIn case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.\",\n \"maxLength\": 1000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"settlementDiscountAmount\": {\n \"type\": \"number\",\n \"description\": \"The SettlementDiscountAmount. Optional\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"settlementDiscountPercentage\": {\n \"type\": \"number\",\n \"description\": \"The SettlementDiscountPercentage . Optional\",\n \"format\": \"decimal\",\n \"nullable\": true\n }\n }\n}\n\nPaymentTerms info
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Buyer info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Full legal name of the buyer\",\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"nullable\": true\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"nullable\": true\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"nullable\": true\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"nullable\": true\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"nullable\": true\n }\n }\n },\n \"glnNumber\": {\n \"type\": \"string\",\n \"description\": \"Global Location Number of the buyer\",\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"VAT number of the buyer\",\n \"nullable\": true\n },\n \"contact\": {\n \"type\": \"object\",\n \"description\": \"Business contact\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Id of the business contact\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the business contact\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the business contact\",\n \"maxLength\": 300,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Phone number of the contact\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"recipientType\": {\n \"type\": \"string\",\n \"description\": \"Type of the buyer\\nPossible values:\\n12: JST Recipient\\n21: GV Recipient\",\n \"nullable\": true\n }\n }\n}\n\nBuyer info
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Represents an exchange rate used for tax calculations between different currencies.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"sourceCurrencyCode\": {\n \"type\": \"string\",\n \"description\": \"ISO currency code representing the source currency for the transaction.\",\n \"nullable\": true\n },\n \"targetCurrencyCode\": {\n \"type\": \"string\",\n \"description\": \"ISO currency code representing the target currency for conversion or display.\",\n \"nullable\": true\n },\n \"calculationRate\": {\n \"type\": \"number\",\n \"description\": \"Exchange rate.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"mathematicOperatorCode\": {\n \"type\": \"string\",\n \"description\": \"Mathematical operator used in calculations. Default is \\\"Multiply\\\".\",\n \"nullable\": true\n },\n \"date\": {\n \"type\": \"string\",\n \"description\": \"Date for the calculation rate.\",\n \"format\": \"date-time\",\n \"nullable\": true\n }\n }\n}\n\nRepresents an exchange rate used for tax calculations between different currencies.
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Represents a note response containing a subject code and note text.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"subjectcode\": {\n \"type\": \"string\",\n \"description\": \"Subject code for the note.\",\n \"maxLength\": 3,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"note\": {\n \"type\": \"string\",\n \"description\": \"Note text.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nRepresents a note response containing a subject code and note text.
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Info about a file within a document\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n },\n \"name\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"size\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"pages\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n },\n \"package\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n}\n\nInfo about a file within a document
\nbackwards compatibility
\n\n\n\n\n{\n \"page\": \"(number) Current page number. Example: 1\",\n \"totalPages\": \"(number) Total number of pages available. Example: 5\",\n \"invoices\": [\n {\n \"id\": \"(number) Internal ID of the Invoice. Used in GetInvoice to get the details of this invoice. Example: 53973544\",\n \"uniqueId\": \"(string) Unique identifier. Example: 0000130974010053973544\",\n \"invoiceNumber\": \"(string) Invoice number. Example: 23110000291\",\n \"currency\": \"(string) ISO 4217 currency code. Example: EUR\",\n \"type\": \"(string) Invoice type (INVOICE or CREDITNOTE). Example: INVOICE\",\n \"date\": \"(string, date) Issue date (YYYY-MM-DD). Example: 2023-11-07\",\n \"dueDate\": \"(string, date) Due date for payment (YYYY-MM-DD). Example: 2023-12-07\",\n \"status\": \"(string) Status of the inbound invoice. Example: PENDING\",\n \"clearanceReferenceId\": \"(string) Unique reference identifier associated with the clearance process. Only relevant for countries where clearance is required. Example: 3948572019283746\",\n \"clearanceReferenceDate\": \"(string, date) Date the invoice was cleared by the tax authority. Only relevant for countries where clearance is required. Example: 2023-11-08\",\n \"totals\": {\n \"amountExclVat\": \"(number) Invoice total excl. VAT. Example: 109.41\",\n \"vatAmount\": \"(number) Invoice VAT amount. Example: 22.98\",\n \"amountInclVat\": \"(number) Invoice total incl. VAT. Example: 132.39\"\n },\n \"customer\": {\n \"name\": \"(string) Buyer name, the company receiving the invoice. Example: GEMEENTE STABROEK\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0207537834\"\n },\n \"supplier\": {\n \"name\": \"(string) Seller name, the party that issued the invoice. Example: PANDAVA nv/sa\",\n \"vatNumber\": \"(string) Seller VAT number. Example: BE0419001396\"\n }\n }\n ]\n}\n\nRepresents a paged response that contains invoice DTOs returned by the API.
\nbackwards compatibility
\n\n\n\n\n{\n \"invoicedate-from\": \"(string,date) The start date for the invoice date range. Example: 2023-11-01\",\n \"invoicedate-to\": \"(string,date) The end date for the invoice date range. Example: 2023-11-30\",\n \"invoiceNumber\": \"(string) The invoice number. Example: 23110000291\",\n \"objectId\": \"(string) Object id of the document. Used in GetInvoice to get the details of this invoice. Example: 4728\",\n \"uniqueId\": \"(string) Unique id of the document. Example: 1095953\",\n \"page\": {\n \"page-number\": \"(number) Page number. Example: 2\",\n \"records-per-page\": \"(number) Amount of records per page. Example: 25\"\n },\n \"status\": \"(string) Filter on status. Example: PENDING\"\n}\n\nRequest for inbound invoices
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \" Represents a request for paginated data. \\n \",\n \"additionalProperties\": false,\n \"required\": [\n \"page-number\",\n \"records-per-page\"\n ],\n \"properties\": {\n \"page-number\": {\n \"type\": \"integer\",\n \"description\": \" The page number for the request. \\n \",\n \"format\": \"int32\"\n },\n \"records-per-page\": {\n \"type\": \"integer\",\n \"description\": \" The number of records per page for the request. \\n \",\n \"format\": \"int32\"\n }\n }\n}\n\n Represents a request for paginated data. \n \n\nbackwards compatibility
\n\n\n\n\n{\n \"id\": \"(number) Internal system ID of the created invoice. Use this id in GetInvoice to retrieve the invoice. Example: 53973544\"\n}\n\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Defines a serializable container for storing error information. This information is stored as key/value pairs. The dictionary keys to look up standard error information are available on the HttpErrorKeys type.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Message\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets the high-level, user-visible message explaining the cause of the error. Information carried in this field should be considered public in that it will go over the wire regardless of the IncludeErrorDetailPolicy. As a result care should be taken not to disclose sensitive information about the server or the application.\",\n \"nullable\": true\n },\n \"ModelState\": \"[Circular]\",\n \"MessageDetail\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets a detailed description of the error intended for the developer to understand exactly what failed.\",\n \"nullable\": true\n },\n \"ExceptionMessage\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets the message of the Exception if available.\",\n \"nullable\": true\n },\n \"ExceptionType\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets the type of the Exception if available.\",\n \"nullable\": true\n },\n \"StackTrace\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets the stack trace information associated with this instance if available.\",\n \"nullable\": true\n },\n \"InnerException\": \"[Circular]\"\n }\n}\n\nDefines a serializable container for storing error information. This information is stored as key/value pairs. The dictionary keys to look up standard error information are available on the HttpErrorKeys type.
\nbackwards compatibility
\n\n\n\n\n{\n \"details\": {\n \"documentNumber\": \"(string) A unique identification of the invoice within the business context, time-frame, operating systems and records of the sender. Max 200 chars. Example: DEMO/00092\",\n \"invoiceNumber\": \"(string) Invoice number as shown on the document. Max 200 chars. Example: 23110000291\",\n \"currency\": \"(string, required) ISO 4217 currency code. Example: EUR\",\n \"date\": \"(string, required, date) Invoice issue date (YYYY-MM-DD). Example: 2022-12-02\",\n \"dueDate\": \"(string, date) Due date for payment (YYYY-MM-DD). In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present. Example: 2023-12-07\",\n \"note\": \"(string) A textual note that gives unstructured information that is relevant to the invoice as a whole, such as the reason for any correction or an assignment note in case the invoice has been factored. Max 2000 chars. Example: Note van de factuur\",\n \"structuredCommunication\": \"(string) A textual value used to establish a link between the payment and the Invoice, issued by the Seller. Used for creditor's critical reconciliation information. This information element helps the Seller to assign an incoming payment to the relevant payment process. Max 2000 chars. Example: +++123/569858/336+++\",\n \"type\": \"(string, required) Document type: Invoice, CreditNote. Example: Invoice\",\n \"typeCode\": \"(string) Document type code (e.g. 380=Invoice, 381=CreditNote). Max 100 chars. Example: 380\",\n \"serviceBeginDate\": \"(string, date) Service period start (YYYY-MM-DD). Example: 2022-12-01\",\n \"serviceEndDate\": \"(string, date) Service period end (YYYY-MM-DD). Example: 2022-12-31\",\n \"taxPointDate\": \"(string, date) The date when the VAT becomes accountable for the Seller and for the Buyer, when that date differs from the invoice issue date (YYYY-MM-DD). Example: 2022-12-22\",\n \"placeOfIssue\": \"(string) Place where the invoice was issued. Max 2000 chars. Example: Mechelen\",\n \"fullyPaid\": \"(boolean) Indicates if an invoice has been paid. Defaults to false. Example: false\",\n \"dateOfFullPayment\": \"(string, date-time) Date of payment, when payment was already made at the time the invoice was issued. Example: 2022-12-02T00:00:00\",\n \"simplifiedTriangularProcedure\": \"(boolean) Indicates a simplified triangular transaction, issued by the second taxpayer in the sequence. Defaults to false. Example: false\",\n \"checkoutMethod\": \"(boolean) Cash accounting indicator. Defaults to false. Example: false\",\n \"selfBillingIndicator\": \"(boolean) Self-billing indicator. Defaults to false. Example: false\",\n \"warehouseDocumentNumbers\": \"(string) WZ (delivery note) document numbers. Example: WZ/2023/114\",\n \"typeName\": \"(string) Invoice type name. Example: Commercial invoice\",\n \"restrictedInformation\": \"(boolean) Indicator if Invoice referred to in Art. 109 sec. 3d of the Act. Defaults to false. Example: false\",\n \"invoicePeriodDescriptionCode\": \"(string) Code describing the invoice or billing period. Typical uses include month, quarter or custom period codes. Max 50 chars. Example: 3\",\n \"deliveryTermsId\": \"(string) Identifier for the delivery terms applicable to this invoice. Max 200 chars. Example: CIF\",\n \"deliveryTermsDeliveryLocationName\": \"(string) Human-readable name of the delivery location associated with the delivery terms. Max 200 chars. Example: Antwerpen\",\n \"contractDocReferenceTypeCode\": \"(string) Code indicating the type of contract or document reference associated with the invoice. Max 100 chars. Example: 1\",\n \"references\": {\n \"accountingCost\": \"(string) Buyer accounting reference Cost center or internal accounting code. A textual value that specifies where to book the relevant data into the Buyer's financial accounts. Example: 4217:2323:2323\",\n \"billingReferences\": [\n {\n \"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n \"invoiceDocumentReferenceIssueDate\": \"(DateTime) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"reasonForCorrection\": \"(string) Reason for correction\",\n \"externalReference\": \"(string) Number identifying the corrected invoice in the National System of e-Invoices\",\n \"typeOfCorrection\": \"(string) Type of correction\"\n }\n ],\n \"buyerReference\": \"(string) Buyer reference or procurement ID. An invoice must have buyer reference or purchase order reference (BT-13) Example: ABC/984/B2\",\n \"purchaseOrderReference\": \"(string) Purchase order number. An invoice must have buyer reference (BT-10) or purchase order reference Example: OR1256\",\n \"contractDocReference\": \"(string) Contract identifier by seller. Example: CT-2022-001\",\n \"contractDocIssueDate\": \"(string, date) Contract date by seller (YYYY-MM-DD). Example: 2022-01-15\",\n \"contractDocReferenceCustomer\": \"(string) Contract identifier by customer. Example: CUST-CT-88\",\n \"contractDocIssueDateCustomer\": \"(string, date) Contract date by customer (YYYY-MM-DD). Example: 2022-01-20\",\n \"despatchDocReference\": \"(string) Dispatch advice ID. Example: DESP-993\",\n \"invoiceDocumentReference\": \"(string) Reference to a previous invoice. Example: INV-2021-77\",\n \"invoiceDocumentReferenceIssueDate\": \"(DateTime) Issue date of previous invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"originatorDocReference\": \"(string) Tender or lot reference. Example: TND-2022-01\",\n \"projectReference\": \"(string) Project reference. Example: PROJ-Delta-01\",\n \"receiptDocReference\": \"(string) Receiving advice ID. Example: RCPT-331\",\n \"salesOrderReference\": \"(string) Seller's sales order ID. Example: SO-10099\",\n \"salesOrderIssueDate\": \"(string, date) Sales order date (YYYY-MM-DD). Example: 2022-05-18\"\n },\n \"customer\": {\n \"id\": \"(string) Internal customer ID in sender's system. Max 100 chars. Example: CUST1\",\n \"name\": \"(string, required) Customer name, the company receiving the invoice. Max 200 chars. Example: Soluz.io\",\n \"address\": {\n \"address1\": \"(string, required) Street and number. Example: Zwartzustersvest 24\",\n \"address2\": \"(string) Address line 2. Example: Unit 5\",\n \"address3\": \"(string) Address line 3. Example: c/o Accounts\",\n \"city\": \"(string, required) City. Example: Mechelen\",\n \"zip\": \"(string, required) Postal code. Example: 2810\",\n \"countryCode\": \"(string, required) ISO 3166-1 alpha-2 country code. Example: BE\",\n \"province\": \"(string) State/Province/Region. Example: Antwerpen\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). CompanyNumber or VAT number is required for companies. Max 200 chars. Example: 0123456749\",\n \"department\": \"(string) Department or branch. Max 200 chars. Example: DevelopmentDepartment\",\n \"vatNumber\": \"(string) Customer VAT number. CompanyNumber or VAT number is required for companies. Max 200 chars. Example: BE0123456749\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"endpointId\": \"(string) Electronic endpoint identifier. Example: BE2929035935\",\n \"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 9925\",\n \"identifications\": [\n {\n \"id\": \"(string, required) Identifier value. Max 200 chars. Example: 0123456749\",\n \"schemeId\": \"(string, required) Identifier scheme, using the ICD code list. Max 10 chars. Example: 0208\"\n }\n ]\n },\n \"delivery\": {\n \"actualDeliveryDate\": \"(string, date) Delivery date (YYYY-MM-DD). Example: 2023-01-03\",\n \"address\": {\n \"address1\": \"(string)(required in case address is filled) Street and number. Example: Berendries 52\",\n \"address2\": \"(string) Example: Building A\",\n \"address3\": \"(string) Example: Floor 2\",\n \"city\": \"(string) City. Example: Lovendegem\",\n \"zip\": \"(string) Postal code. Example: 5400\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province/region. Example: O-Vl\"\n },\n \"name\": \"(string) Receiver name or delivery contact. Example: Soluz.io afleveradres\",\n \"locationIdentifier\": {\n \"id\": \"(string) Location identifier (GLN or other). Example: 5412345000013\",\n \"schemeId\": \"(string) Scheme ID for location. Example: 0088\"\n }\n },\n \"paymentMeans\": {\n \"code\": \"(string) The means, expressed as code, for how a payment is expected to be or has been settled. (e.g., UN/CEFACT 4461). Example: ZZZ\",\n \"text\": \"(string) Description of payment means. Example: Bank transfer\",\n \"mandateId\": \"(string) Unique identifier assigned by the Payee for referencing the direct debit mandate. Used in order to pre-notify the Buyer of a SEPA direct debit. Example: MandateId\",\n \"mandateFinancialAccountId\": \"(string) The account to be debited by the direct debit. Example: MandateFinancialAccountId\",\n \"paymentId\": \"(string) Payment reference to be used by the payer. Example: PMT-2023-001\",\n \"payeeFinancialInstitutionId\": \"(string) Identifier of Payee's bank (BIC, etc.). Example: KREDBEBB\",\n \"payeeFinancialAccountId\": \"(string) Payee's bank account (IBAN, etc.). Example: BE49000023121121\",\n \"payeeFinancialAccountSchemeId\": \"(string) Scheme ID of Payee's bank account (e.g. IBAN). Example: IBAN\",\n \"payeeFinancialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\"\n },\n \"multiplePaymentMeans\": [\n {\n \"code\": \"(string) The means, expressed as code, for how a payment is expected to be or has been settled. (e.g., UN/CEFACT 4461). Example: ZZZ\",\n \"text\": \"(string) Description of payment means. Example: Bank transfer\",\n \"mandateId\": \"(string) Unique identifier assigned by the Payee for referencing the direct debit mandate. Example: MandateId\",\n \"mandateFinancialAccountId\": \"(string) The account to be debited by the direct debit. Example: MandateFinancialAccountId\",\n \"paymentId\": \"(string) Payment reference to be used by the payer. Example: PMT-2023-001\",\n \"payeeFinancialInstitutionId\": \"(string) Identifier of Payee's bank (BIC, etc.). Example: KREDBEBB\",\n \"payeeFinancialAccountId\": \"(string) Payee's bank account (IBAN, etc.). Example: BE49000023121121\",\n \"payeeFinancialAccountSchemeId\": \"(string) Scheme ID of Payee's bank account (e.g. IBAN). Example: IBAN\",\n \"payeeFinancialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\"\n }\n ],\n \"payee\": {\n \"companyNumber\": \"(string) This element is used for both the identification of the Payee, or the unique banking reference identifier of Payee (assigned by the Payee bank.) For payee identification use ICD code list, for SEPA bank assigned creditor reference, use SEPA. Example: BE0123456749\",\n \"financialAccountId\": \"(string) Payee's IBAN. Example: BE49000023121121\",\n \"financialAccountName\": \"(string) Name of the financial institution/account. Example: KBC\",\n \"name\": \"(string) Name of payee. Example: PayeeName\"\n },\n \"paymentTerms\": {\n \"text\": \"(string) A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties). Example: Payment in 30 days\",\n \"settlementDiscountPercentage\": \"(number) Early payment discount percentage. If not filled in but SettlementDiscountAmount is, this value will be calculated based on SettlementDiscountAmount. Example: 2\",\n \"settlementDiscountAmount\": \"(number) Early payment discount absolute amount. If not filled in but SettlementDiscountPercentage is, this value will be calculated based on SettlementDiscountPercentage. Example: 50.00\"\n },\n \"supplier\": {\n \"id\": \"(string) Internal supplier ID in sender's system. Example: SUP1\",\n \"name\": \"(string, required) Supplier name, the party that issued the invoice. Example: PANDAVA nv/sa\",\n \"address\": {\n \"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n \"address2\": \"(string) Example: Tax 1\",\n \"address3\": \"(string) Example: Tax 3\",\n \"city\": \"(string) City. Example: Tax Mechelen\",\n \"zip\": \"(string) Postal code. Example: Tax 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province. Example: Vl-Br\",\n \"taxpayersPrefix\": \"(string) VAT UE country prefix (e.g. PL) for intra-Community supplies, cross-border services, and triangular transactions.\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n \"department\": \"(string) Department or branch. Example: DevelopmentDepartment\",\n \"vatNumber\": \"(string) Supplier VAT number. Example: BE0419001396\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"endpointId\": \"(string) Electronic endpoint identifier. Example: BE2929035935\",\n \"endpointType\": \"(string) Endpoint type or scheme which relates to the endpointId. Example: 9925\"\n },\n \"buyer\": {\n \"name\": \"(string) Buyer name. Example: Soluz.io\",\n \"address\": {\n \"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n \"zip\": \"(string) Postal code. Example: Tax 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province. Example: Vl-Br\"\n },\n \"contact\": {\n \"name\": \"(string) Contact person. Example: Jan Peeters\",\n \"email\": \"(string) Contact email. Example: jan@soluz.io\",\n \"phone\": \"(string) Contact phone. Example: +3215999888\"\n },\n \"companyNumber\": \"(string) National company number (e.g. Belgium CBE/KBO). Example: 0123456749\",\n \"companyNumberType\": \"(string) Company number type\",\n \"vatNumber\": \"(string) Buyer VAT number. Example: BE0123456749\",\n \"glnNumber\": \"(string) Global Location Number (13 digits). Example: 5412345000013\",\n \"recipientType\": \"(string) Flag to indicate Subordinate Local Government Unit or GV member\"\n },\n \"parties\": [\n {\n \"partyName\": \"(string) Name of the party. Example: VERVOER BVBA\",\n \"name\": \"(string) Name of the party. Example: VERVOER BVBA\",\n \"roleCode\": \"(string) Code identifying the role that this party takes on the invoice. Example: DEL\",\n \"endpointID\": \"(string) Electronic endpoint identifier of the party. Example: BE2929035935\",\n \"endpointIDType\": \"(string) Endpoint type or scheme which relates to the endpointID. Example: 9925\",\n \"identifiers\": [\n {\n \"id\": \"(string, required) Identifier value. Max 200 chars. Example: 0123456749\",\n \"schemeId\": \"(string, required) Identifier scheme, using the ICD code list. Max 10 chars. Example: 0208\"\n }\n ],\n \"address1\": \"(string) Street and street number of the party. Example: Lage Weg 123 A\",\n \"address2\": \"(string) Additional address line of the party. Example: Building A\",\n \"address3\": \"(string) Additional address line of the party. Example: Floor 2\",\n \"city\": \"(string) City of the party. Example: Hoevenen-Stabroek\",\n \"zip\": \"(string) Postal code of the party. Example: 2940\",\n \"countryCode\": \"(string) Country of the party, ISO 3166-1 alpha-2. Example: BE\",\n \"countryName\": \"(string) Country name of the party. Example: Belgium\",\n \"countrySubEntity\": \"(string) Province, state or region of the party. Example: Antwerpen\",\n \"vatNumber\": \"(string) VAT number of the party. Example: BE0419001396\",\n \"contactID\": \"(string) Identifier for the contact of the party. Example: CNT-1\",\n \"contactName\": \"(string) Contact person of the party. Example: Jan Peeters\",\n \"contactEmail\": \"(string) Contact email of the party. Example: jan@soluz.io\",\n \"contactPhone\": \"(string) Contact phone of the party. Example: +3215999888\",\n \"partyLERegistrationName\": \"(string) Registered legal entity name of the party. Example: PANDAVA nv/sa\",\n \"partyLECompanyID\": \"(string) Legal entity company identifier of the party (e.g. Belgium CBE/KBO). Example: 0419001396\",\n \"partyLECompanyIDType\": \"(string) Scheme of the legal entity company identifier, using the ICD code list. Example: 0208\",\n \"partyLECompanyLegalForm\": \"(string) Legal form of the legal entity. Example: NV\",\n \"recipientType\": \"(string) Flag to indicate Subordinate Local Government Unit or GV member\"\n }\n ],\n \"taxRepresentative\": {\n \"address\": {\n \"address1\": \"(string) Street and street number. Example: Tax Zwartzustersvest 24\",\n \"address2\": \"(string) Example: Tax 1\",\n \"address3\": \"(string) Example: Tax 3\",\n \"city\": \"(string) City. Example: Tax Mechelen\",\n \"zip\": \"(string) Postal code. Example: Tax 2800\",\n \"countryCode\": \"(string) ISO 3166-1 alpha-2. Example: BE\",\n \"province\": \"(string) Province. Example: Vl-Br\"\n },\n \"name\": \"(string) Tax representative name. Example: Tax Soluz.io\",\n \"vatNumber\": \"(string) VAT number. Example: BE000000097\"\n },\n \"taxExchangeRate\": {\n \"sourceCurrencyCode\": \"(string) ISO 4217 code of the source currency. Example: USD\",\n \"targetCurrencyCode\": \"(string) ISO 4217 code of the target currency. Example: EUR\",\n \"calculationRate\": \"(number) Exchange rate. Example: 0.92\",\n \"mathematicOperatorCode\": \"(string) Mathematical operator used in the calculation. Defaults to Multiply. Example: Multiply\",\n \"date\": \"(string, date-time) Date the calculation rate applies to. Example: 2022-12-02T00:00:00\"\n },\n \"discount\": {\n \"amount\": \"(number) The discount amount. If not filled in but Percentage is, this value will be calculated based on Percentage. Example: 50\",\n \"percentage\": \"(number) The discount percentage. If not filled in but Amount is, this value will be calculated based on Amount. Example: 10\",\n \"reason\": \"(string) Reason for discount. Example: extra korting van 10%\"\n },\n \"charge\": {\n \"amount\": \"(number) Additional charge excl. VAT. Example: 10\",\n \"vatRate\": \"(number) VAT rate on charge. Example: 21\",\n \"vatCode\": \"(string) VAT category code for charge. Example: S\",\n \"reason\": \"(string) Reason for charge. Example: Handling fee\"\n },\n \"totals\": {\n \"amountExclVat\": \"(number) The total amount of the Invoice without VAT. Must be rounded to maximum 2 decimals. Example: 297.00\",\n \"vatAmount\": \"(number) The total VAT amount for the Invoice or the VAT total amount expressed in the accounting currency accepted or required in the country of the Seller. Must be rounded to maximum 2 decimals. Example: 38.07\",\n \"amountInclVat\": \"(number) The total amount of the Invoice with VAT. Must be rounded to maximum 2 decimals. Example: 335.07\",\n \"lineExtensionAmount\": \"(number) Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals. If not supplied this is calculated as the sum of the LineExtensionAmount on the detail lines. Example: 297.00\",\n \"payableAmount\": \"(number) The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals. If not filled in the TaxInclusiveAmount will be used. Example: 335.07\",\n \"payableRoundingAmount\": \"(number) The amount to be added to the invoice total to round the amount to be paid. Must be rounded to maximum 2 decimals. Example: 0.00\",\n \"prepaidAmount\": \"(number) The sum of amounts which have been paid in advance. Must be rounded to maximum 2 decimals. Example: 0.00\"\n },\n \"vatSubTotals\": [\n {\n \"code\": \"(string) VAT category code. Example: S\",\n \"rate\": \"(number) VAT rate. Example: 21.00\",\n \"exemptionReason\": \"(string) Reason for VAT exemption. Example: Intra-community supply\",\n \"exemptionReasonCode\": \"(string) Code for VAT exemption reason. Example: K\",\n \"taxableAmount\": \"(number) Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable). Must be rounded to maximum 2 decimals. Example: 109.41\",\n \"taxAmount\": \"(number) The total VAT amount for a given VAT category. Must be rounded to maximum 2 decimals. Example: 22.98\",\n \"taxTypeIndicator\": \"(string) Additonal Tax Category for non-standard rate\",\n \"splitPaymentIndicator\": \"(string) Split payment indicator\"\n }\n ],\n \"detailLines\": [\n {\n \"id\": \"(string) Unique line ID. Max 100 chars. Example: 1\",\n \"quantity\": \"(number, required) Quantity invoiced. Example: 3\",\n \"articleName\": \"(string, required) Item name. Max 2000 chars. Example: Agenda Timing 2024\",\n \"accountingCost\": \"(string) A textual value that specifies where to book the relevant data into the Buyer's financial accounts. Max 100 chars. Example: 700100\",\n \"additionalItemProperties\": \"(object) Additional properties of the goods/services. Example: { \\\"color\\\": \\\"blue\\\" }\",\n \"allowanceReason\": \"(string) The reason for the allowance on this line, if there is an allowance, expressed as text. Max 1000 chars. Example: Promotion\",\n \"allowanceAmount\": \"(number) The allowance amount, if there is an allowance. Example: 1.00\",\n \"chargeReason\": \"(string) The reason for the charge on this line, if there is a charge, expressed as text. Max 1000 chars. Example: Handling fee\",\n \"chargeAmount\": \"(number) The charge amount, if there is a charge. Example: 1.00\",\n \"commodityClassificationCodes\": \"(object) Classification codes (e.g. UNSPSC, CPV, etc.). Example: { \\\"UNSPSC\\\": \\\"44121706\\\" }\",\n \"articleDescription\": \"(string) Item description. Max 2000 chars. Example: Black hard cover\",\n \"articleNumberBuyer\": \"(string) Buyer's item code. Max 2000 chars. Example: ITM-001\",\n \"articleNumberSupplier\": \"(string) Supplier's item code. Max 200 chars. Example: SUP-7788\",\n \"lineExtensionAmount\": \"(number, required) The total amount of the Invoice line. The amount is \\\"net\\\" without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes. Must be rounded to maximum 2 decimals. Example: 150.00\",\n \"vatRate\": \"(number, required) VAT rate percentage. Example: 21\",\n \"vatCode\": \"(string) VAT category code. Max 200 chars. Example: S\",\n \"orderLineId\": \"(string) Reference to buyer's order line. Max 200 chars. Example: 1000\",\n \"note\": \"(string) A textual note that gives unstructured information that is relevant to the Invoice line. Max 2000 chars. Example: Delivered in January\",\n \"startDate\": \"(string, date) The date when the invoice period for this line starts (YYYY-MM-DD). Example: 2023-11-01\",\n \"endDate\": \"(string, date) The date when the invoice period for this line ends (YYYY-MM-DD). Example: 2023-11-30\",\n \"exemptFromDiscount\": \"(boolean) Set to true to exclude this line from the document level discount. Defaults to false. Example: false\",\n \"deliveryDate\": \"(string, date) Date of delivery for line (YYYY-MM-DD). Example: 2023-01-03\",\n \"deliveryNoteReference\": \"(string) Reference to delivery note. Max 2000 chars. Example: DN-12345\",\n \"docRefDocType\": \"(string) Type of referenced document (code 130 = invoice object reference). Max 2000 chars. Example: 130\",\n \"docRefId\": {\n \"id\": \"(string, required) Identifier of referenced object. Max 200 chars. Example: 998877\",\n \"schemeId\": \"(string, required) Scheme ID of reference. Max 10 chars.\"\n },\n \"originCountryCode\": \"(string) Country of origin (ISO 3166-1 alpha-2). Max 100 chars. Example: BE\",\n \"standardItemIdentification\": {\n \"id\": \"(string, required) Standard item identifier. Max 200 chars. Example: 5412345678908\",\n \"schemeId\": \"(string, required) Identification scheme, using the ICD code list. Max 10 chars. Example: 0160\"\n },\n \"price\": {\n \"articlePrice\": \"(number, required) The price of an item, exclusive of VAT, after subtracting item price discount. The Item net price has to be equal with the Item gross price less the Item price discount, if they are both provided. Item price can not be negative. Example: 50.00\",\n \"baseQuantity\": \"(number) The number of item units to which the price applies. Example: 1\",\n \"unitOfMeasure\": \"(string) Unit of measure. Codes for unit of packaging from UNECE Recommendation No. 21 can be used in accordance with the descriptions in the Intro section of UN/ECE Recommendation 20, Revision 11 (2015): The 2 character alphanumeric code values in UNECE Recommendation 21 shall be used. To avoid duplication with existing code values in UNECE Recommendation No. 20, each code value from UNECE Recommendation 21 shall be prefixed with an \\\"X\\\", resulting in a 3 alphanumeric code when used as a unit of measure. Max 200 chars. Example: H87\",\n \"allowanceAmount\": \"(number) The total discount subtracted from the Item gross price to calculate the Item net price. Example: 55.00\",\n \"allowanceBaseAmount\": \"(number) The unit price, exclusive of VAT, before subtracting Item price discount, can not be negative. Example: 60.00\"\n },\n \"vatExemptionReason\": \"(string) Reason for VAT exemption. Example: Intra-community supply\",\n \"vatExemptionReasonCode\": \"(string) Code for VAT exemption reason. Example: E\",\n \"uuLineNumber\": \"(string) (POLAND) Universal unique line number. Should be unique not only per invoice but per taxpayer or invoicing system\",\n \"lineGTU\": \"(string) Designation for the delivery of goods and the provision of services\",\n \"lineDueDateTypeCode\": \"(string) Code specifying the type of due date that applies to this invoice line.\",\n \"referencedDespatchDocId\": \"(string) An identifier for the despatch advice that this invoice line refers to. Example: DESP-993\",\n \"referencedDespatchDocLineId\": \"(string) An identifier for the line within the referenced despatch advice. Example: 2\",\n \"referencedInvoiceDocId\": \"(string) An identifier for the invoice that this invoice line refers to. Example: INV-2021-77\",\n \"referencedInvoiceDocLineId\": \"(string) An identifier for the line within the referenced invoice. Example: 3\",\n \"referencedInvoiceDocTypeCode\": \"(string) The document type code of the referenced invoice. Example: 380\",\n \"referencedInvoiceDocIssueDate\": \"(string, date) The issue date of the referenced invoice (YYYY-MM-DD). Example: 2021-11-30\",\n \"referencedReceiptDocId\": \"(string) An identifier for the receiving advice that this invoice line refers to. Example: RCPT-331\",\n \"referencedReceiptDocLineId\": \"(string) An identifier for the line within the referenced receiving advice. Example: 1\",\n \"referencedSalesOrderDocId\": \"(string) An identifier for the sales order that this invoice line refers to. Example: SO-10099\",\n \"referencedSalesOrderDocLineId\": \"(string) An identifier for the line within the referenced sales order. Example: 4\",\n \"deliveryActualDeliveryDate\": \"(string, date) The date on which the goods or services on this invoice line were actually delivered (YYYY-MM-DD). Example: 2023-01-03\",\n \"deliveryPartyName\": \"(string) The name of the party that the goods or services on this invoice line were delivered to. Example: Soluz.io afleveradres\",\n \"deliveryLocationIDs\": \"(string) An identifier for the delivery location of this invoice line. Example: 5412345000013\",\n \"deliveryLocationAddress1\": \"(string) Street and street number of the delivery location of this invoice line. Example: Berendries 52\",\n \"deliveryLocationAddress2\": \"(string) Additional address line of the delivery location. Example: Building A\",\n \"deliveryLocationAddress3\": \"(string) Additional address line of the delivery location. Example: Floor 2\",\n \"deliveryLocationCity\": \"(string) City of the delivery location. Example: Lovendegem\",\n \"deliveryLocationZIP\": \"(string) Postal code of the delivery location. Example: 5400\",\n \"deliveryLocationCountrySubEntity\": \"(string) Province, state or region of the delivery location. Example: O-Vl\",\n \"deliveryLocationCountryCode\": \"(string) Country of the delivery location (ISO 3166-1 alpha-2). Example: BE\"\n }\n ]\n },\n \"processing\": {\n \"deliveryMethod\": \"(string) Channel through which the invoice was received (e.g. PEPPOL, E-MAIL, POST). Example: PEPPOL\",\n \"extraCode1\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode2\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode3\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode4\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode5\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode6\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode7\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode8\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode9\": \"(string) Optional extra information that can be used in rules\",\n \"extraCode10\": \"(string) Optional extra information that can be used in rules\",\n \"extraInfo\": \"(string) Free-form text, up to 500 chars.\",\n \"senderPartyEntity\": \"(string) ComFin contract number if ComFin customer. Example: BE00001\",\n \"messageType\": \"(string) Message type for XML (default EFFF). Example: EFFF\"\n },\n \"image\": {\n \"embedded\": \"(boolean) Is it an embedded file? Example: true\",\n \"name\": \"(string) File name. Example: factuurImage.pdf\",\n \"mimeType\": \"(string) MIME type. Example: application/pdf\",\n \"value\": \"(string, base64) Base64 content of file. Example: BASE64 here\"\n },\n \"attachments\": [\n {\n \"embedded\": \"(boolean) Is it an embedded file? Example: true\",\n \"name\": \"(string) File name. Example: Attach.pdf\",\n \"mimeType\": \"(string) MIME type. Example: application/pdf\",\n \"value\": \"(string, base64) Base64 content\"\n }\n ],\n \"xml\": {\n \"embedded\": \"(boolean) Is it an embedded file? Example: true\",\n \"name\": \"(string) File name. Example: invoice.xml\",\n \"mimeType\": \"(string) MIME type. Example: application/xml\",\n \"value\": \"(string, base64) Base64 encoded UBL XML\"\n }\n}\n\nClass that holds data for uploading an invoice (Inbound)
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Class that holds details of an invoice (outbound)\",\n \"additionalProperties\": false,\n \"required\": [\n \"currency\",\n \"date\",\n \"type\",\n \"totals\"\n ],\n \"properties\": {\n \"currency\": {\n \"type\": \"string\",\n \"description\": \"The currency in which all Invoice amounts are given.\",\n \"minLength\": 1\n },\n \"date\": {\n \"type\": \"string\",\n \"description\": \"The date when the Invoice was issued. Format \\\"YYYY-MM-DD\\\"\",\n \"format\": \"date\",\n \"minLength\": 1\n },\n \"dueDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the payment is due.Format \\\"YYYY-MM-DD\\\".\\nIn case the Amount due for payment (BT-115) is positive,\\neither the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"note\": {\n \"type\": \"string\",\n \"description\": \"A textual note that gives unstructured information that is relevant to the Invoice as a whole.Such as the reason for any correction or assignment note in case the invoice has been factored.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"documentNumber\": {\n \"type\": \"string\",\n \"description\": \"A unique identification of the Invoice,\\nto uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"invoiceNumber\": {\n \"type\": \"string\",\n \"description\": \"A unique identification of the Invoice,\\nto uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"structuredCommunication\": {\n \"type\": \"string\",\n \"description\": \"A textual value used to establish a link between the payment and the Invoice, issued by the Seller.\\nUsed for creditor's critical reconciliation information.\\nThis information element helps the Seller to assign an incoming payment to the relevant payment process.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"type\": {\n \"type\": \"string\",\n \"description\": \"Invoice|CreditNote\",\n \"minLength\": 1\n },\n \"typeCode\": {\n \"type\": \"string\",\n \"description\": \"380 , 381 ,...\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"serviceBeginDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Invoice period starts. Format = \\\"YYYY-MM-DD\\\".\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"serviceEndDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Invoice period ends. Format = \\\"YYYY-MM-DD\\\".\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"taxPointDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the VAT becomes accountable for the Seller and for the Buyer in so far as that date can be determined and differs from the date of issue of the invoice, according to the VAT directive.\\nThis element is required if the Value added tax point date is different from the Invoice issue date.\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"placeOfIssue\": {\n \"type\": \"string\",\n \"description\": \"Place where the invoice was issued\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"fullyPaid\": {\n \"type\": \"boolean\",\n \"description\": \"Indicates if an invoice has been paid\"\n },\n \"dateOfFullPayment\": {\n \"type\": \"string\",\n \"description\": \"Date of payment if full payment if payment was made by the time of the invoice was issued\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"simplifiedTriangularProcedure\": {\n \"type\": \"boolean\",\n \"description\": \"Indicates a simplified triangular transaction, issued by the second taxpayer in the sequence.\"\n },\n \"checkoutMethod\": {\n \"type\": \"boolean\",\n \"description\": \"Cash accounting indicator\"\n },\n \"selfBillingIndicator\": {\n \"type\": \"boolean\",\n \"description\": \"Self-billing indicator \"\n },\n \"warehouseDocumentNumbers\": {\n \"type\": \"string\",\n \"description\": \"WZ (delivery note) document numbers\",\n \"nullable\": true\n },\n \"typeName\": {\n \"type\": \"string\",\n \"description\": \"Invoice Type name\",\n \"nullable\": true\n },\n \"restrictedInformation\": {\n \"type\": \"boolean\",\n \"description\": \"Indicator if Invoice referred to in Art. 109 sec. 3d of the Act\"\n },\n \"references\": {\n \"type\": \"object\",\n \"description\": \"References\",\n \"additionalProperties\": false,\n \"properties\": {\n \"accountingCost\": {\n \"type\": \"string\",\n \"description\": \"Buyer accounting reference\\nA textual value that specifies where to book the relevant data into the Buyer's financial accounts.\\nExample value: 4217:2323:2323\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"billingReferences\": {\n \"type\": \"array\",\n \"description\": \"A group of business terms providing information on the preceding Invoice.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"invoiceDocumentReference\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"invoiceDocumentReferenceIssueDate\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"reasonForCorrection\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"documentTypeCode\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"externalReference\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"typeOfCorrection\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n }\n },\n \"buyerReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier assigned by the Buyer used for internal routing purposes. An invoice must have buyer reference or purchase order reference (BT-13).\",\n \"maxLength\": 1000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"contractDocReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of a contract as specified by the sender\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"contractDocIssueDate\": {\n \"type\": \"string\",\n \"description\": \"Date of the contract as specified by the sender\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"contractDocReferenceCustomer\": {\n \"type\": \"string\",\n \"description\": \"The identification of a contract as specified by the receiver\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"contractDocIssueDateCustomer\": {\n \"type\": \"string\",\n \"description\": \"Date of the contract as specified by the receiver\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"despatchDocReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced despatch advice.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"invoiceDocumentReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of an Invoice that was previously sent by the Seller.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"invoiceDocumentReferenceIssueDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Preceding Invoice was issued.Shall be provided in case the Preceding Invoice identifier is not unique. Format = \\\"YYYY-MM-DD\\\".\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"originatorDocReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of the call for tender or lot the invoice relates to.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"projectReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of the project the invoice refers to.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"purchaseOrderReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced purchase order, issued by the Buyer.An invoice must have buyer reference (BT-10) or purchase order reference.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"receiptDocReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced receiving advice.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"salesOrderIssueDate\": {\n \"type\": \"string\",\n \"description\": \"Spain only: add Issuer transaction date (recommended, not mandatory)\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"salesOrderReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced sales order, issued by the Seller.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"customer\": {\n \"type\": \"object\",\n \"description\": \"Customer info\",\n \"additionalProperties\": false,\n \"required\": [\n \"address\",\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Customer number in the suppliers system\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"contact\": {\n \"type\": \"object\",\n \"description\": \"Business contact\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Id of the business contact\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the business contact\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the business contact\",\n \"maxLength\": 300,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Phone number of the contact\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"companyNumber\": {\n \"type\": \"string\",\n \"description\": \"Company number of the customer. CompanyNumber or VAT Number required for companies\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"department\": {\n \"type\": \"string\",\n \"description\": \"Department of the customer\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the customer\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"VAT number of the customer. CompanyNumber or VAT Number required for companies\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"glnNumber\": {\n \"type\": \"string\",\n \"description\": \"Glnnumber of the customer\",\n \"nullable\": true\n },\n \"endpointId\": {\n \"type\": \"string\",\n \"description\": \"EndpointId of the customer\",\n \"nullable\": true\n },\n \"endpointType\": {\n \"type\": \"string\",\n \"description\": \"EndpointType of the customer\",\n \"nullable\": true\n },\n \"identifications\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n }\n }\n }\n },\n \"delivery\": {\n \"type\": \"object\",\n \"description\": \"Delivery info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"actualDeliveryDate\": {\n \"type\": \"string\",\n \"description\": \"The date on which the supply of goods or services was made or completed. Format = \\\"YYYY-MM-DD\\\"\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"locationIdentifier\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"The name of the party to which the goods and services are delivered.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"payee\": {\n \"type\": \"object\",\n \"description\": \"Payee info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"companyNumber\": {\n \"type\": \"string\",\n \"description\": \"This element is used for both the identification of the Payee,\\nor the unique banking reference identifier of Payee (assigned by the Payee bank.)\\nFor payee identification use ICD code list, for SEPA bank assigned creditor reference, use SEPA.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"financialAccountId\": {\n \"type\": \"string\",\n \"description\": \"The name of the payment account, at a payment service provider, to which payment should be made.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"financialAccountName\": {\n \"type\": \"string\",\n \"description\": \"The name of the payment account, at a payment service provider, to which payment should be made.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"The name of the Payee.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"paymentMeans\": {\n \"type\": \"object\",\n \"description\": \"PaymentMeans info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"mandateId\": {\n \"type\": \"string\",\n \"description\": \"Unique identifier assigned by the Payee for referencing the direct debit mandate.\\nUsed in order to pre-notify the Buyer of a SEPA direct debit.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"mandateFinancialAccountId\": {\n \"type\": \"string\",\n \"description\": \"The account to be debited by the direct debit.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"code\": {\n \"type\": \"string\",\n \"description\": \"The means, expressed as code, for how a payment is expected to be or has been settled.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"text\": {\n \"type\": \"string\",\n \"description\": \"The means, expressed as text, for how a payment is expected to be or has been settled.\\nExample value: Credit transfer\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"paymentId\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"payeeFinancialInstitutionId\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"payeeFinancialAccountId\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"payeeFinancialAccountSchemeId\": {\n \"type\": \"string\",\n \"maxLength\": 20,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"payeeFinancialAccountName\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"cardId\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"cardHolderName\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"multiplePaymentMeans\": {\n \"type\": \"array\",\n \"description\": \"Multiple payment means\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"PaymentMeans info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"mandateId\": {\n \"type\": \"string\",\n \"description\": \"Unique identifier assigned by the Payee for referencing the direct debit mandate.\\nUsed in order to pre-notify the Buyer of a SEPA direct debit.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"mandateFinancialAccountId\": {\n \"type\": \"string\",\n \"description\": \"The account to be debited by the direct debit.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"code\": {\n \"type\": \"string\",\n \"description\": \"The means, expressed as code, for how a payment is expected to be or has been settled.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"text\": {\n \"type\": \"string\",\n \"description\": \"The means, expressed as text, for how a payment is expected to be or has been settled.\\nExample value: Credit transfer\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"paymentId\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"payeeFinancialInstitutionId\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"payeeFinancialAccountId\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"payeeFinancialAccountSchemeId\": {\n \"type\": \"string\",\n \"maxLength\": 20,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"payeeFinancialAccountName\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"cardId\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"cardHolderName\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n }\n },\n \"paymentTerms\": {\n \"type\": \"object\",\n \"description\": \"PaymentTerms info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"text\": {\n \"type\": \"string\",\n \"description\": \"A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties).\\nIn case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.\",\n \"maxLength\": 1000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"settlementDiscountAmount\": {\n \"type\": \"number\",\n \"description\": \"The SettlementDiscountAmount. Optional\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"settlementDiscountPercentage\": {\n \"type\": \"number\",\n \"description\": \"The SettlementDiscountPercentage . Optional\",\n \"format\": \"decimal\",\n \"nullable\": true\n }\n }\n },\n \"supplier\": {\n \"type\": \"object\",\n \"description\": \"Supplier info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Customer number in the suppliers system\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"contact\": {\n \"type\": \"object\",\n \"description\": \"Business contact\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Id of the business contact\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the business contact\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the business contact\",\n \"maxLength\": 300,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Phone number of the contact\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"companyNumber\": {\n \"type\": \"string\",\n \"description\": \"Company number of the supplier. CompanyNumber or VAT Number required for companies\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"department\": {\n \"type\": \"string\",\n \"description\": \"Department of the supplier\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the supplier\",\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"VAT number of the supplier. CompanyNumber or VAT Number required for companies\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"glnNumber\": {\n \"type\": \"string\",\n \"description\": \"Glnnumber of the supplier\",\n \"nullable\": true\n },\n \"endpointId\": {\n \"type\": \"string\",\n \"description\": \"EndpointId of the supplier\",\n \"nullable\": true\n },\n \"endpointType\": {\n \"type\": \"string\",\n \"description\": \"EndpointType of the supplier\",\n \"nullable\": true\n },\n \"taxpayersPrefix\": {\n \"type\": \"string\",\n \"description\": \"VAT UE country prefix (e.g. \\\"PL\\\") for intra-Community supplies, cross-border services, and triangular transactions.\",\n \"nullable\": true\n },\n \"identifications\": {\n \"type\": \"array\",\n \"description\": \"Additional identifiers for the party.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n }\n }\n }\n },\n \"taxRepresentative\": {\n \"type\": \"object\",\n \"description\": \"Tax representative party\",\n \"additionalProperties\": false,\n \"properties\": {\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"The full name of the Seller's tax representative party.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"The VAT identifier of the Seller's tax representative party.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"totals\": {\n \"type\": \"object\",\n \"description\": \"Invoice totals\",\n \"additionalProperties\": false,\n \"required\": [\n \"amountExclVat\",\n \"amountInclVat\",\n \"vatAmount\"\n ],\n \"properties\": {\n \"amountExclVat\": {\n \"type\": \"number\",\n \"description\": \"The total amount of the Invoice without VAT. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\"\n },\n \"amountInclVat\": {\n \"type\": \"number\",\n \"description\": \"The total amount of the Invoice with VAT. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\"\n },\n \"lineExtensionAmount\": {\n \"type\": \"number\",\n \"description\": \"Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals.\\nIf not supplied this is calculated as the sum of the LineExtensionAmount on the detail lines\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"payableAmount\": {\n \"type\": \"number\",\n \"description\": \"The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals.\\nIf not filled in the TaxInclusiveAmount will be used\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"payableRoundingAmount\": {\n \"type\": \"number\",\n \"description\": \"The amount to be added to the invoice total to round the amount to be paid. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"prepaidAmount\": {\n \"type\": \"number\",\n \"description\": \"The sum of amounts which have been paid in advance. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"vatAmount\": {\n \"type\": \"number\",\n \"description\": \"The total VAT amount for the Invoice or the VAT total amount expressed in the accounting currency accepted or required in the country of the Seller. Must be rounded to maximum 2 decimals \",\n \"format\": \"decimal\"\n }\n }\n },\n \"discount\": {\n \"type\": \"object\",\n \"description\": \"Discount info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"amount\": {\n \"type\": \"number\",\n \"description\": \"The discount amount. Optional\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"percentage\": {\n \"type\": \"number\",\n \"description\": \"The discount percentage. Optional\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"reason\": {\n \"type\": \"string\",\n \"description\": \"Reason for the discount\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"taxExemptionReason\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"taxExemptionReasonCode\": {\n \"type\": \"string\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"charge\": {\n \"type\": \"object\",\n \"description\": \"Charge info\",\n \"additionalProperties\": false,\n \"required\": [\n \"vatRate\"\n ],\n \"properties\": {\n \"amount\": {\n \"type\": \"number\",\n \"description\": \"The Charge amount\",\n \"format\": \"decimal\"\n },\n \"vatRate\": {\n \"type\": \"number\",\n \"description\": \"The charge vat rate\",\n \"format\": \"decimal\"\n },\n \"vatCode\": {\n \"type\": \"string\",\n \"description\": \"The VAT category code for the charge.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"reason\": {\n \"type\": \"string\",\n \"description\": \"Reason for the charge\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"taxExemptionReason\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"taxExemptionReasonCode\": {\n \"type\": \"string\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"vatSubTotals\": {\n \"type\": \"array\",\n \"description\": \"Optional. The VAT Sub totals of the invoice\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"VAT Sub totals\",\n \"additionalProperties\": false,\n \"properties\": {\n \"code\": {\n \"type\": \"string\",\n \"description\": \"Coded identification of a VAT category.\",\n \"nullable\": true\n },\n \"rate\": {\n \"type\": \"number\",\n \"description\": \"The VAT rate, represented as percentage that applies for the relevant VAT category.\",\n \"format\": \"decimal\"\n },\n \"exemptionReasonCode\": {\n \"type\": \"string\",\n \"description\": \"A coded statement of the reason for why the amount is exempted from VAT.\",\n \"nullable\": true\n },\n \"exemptionReason\": {\n \"type\": \"string\",\n \"description\": \"A textual statement of the reason why the amount is exempted from VAT or why no VAT is being charged.\",\n \"nullable\": true\n },\n \"taxableAmount\": {\n \"type\": \"number\",\n \"description\": \"Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable).\\nMust be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\"\n },\n \"taxAmount\": {\n \"type\": \"number\",\n \"description\": \"The total VAT amount for a given VAT category. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\"\n },\n \"taxTypeIndicator\": {\n \"type\": \"string\",\n \"description\": \"Tax category for non-standard VAT rates\",\n \"nullable\": true\n },\n \"splitPaymentIndicator\": {\n \"type\": \"string\",\n \"description\": \"Split payment indicator (\\\"mechanizm podzielonej płatności\\\").\\nRequired when invoice total exceeds PLN 15,000 and covers Annex 15 goods/services.\",\n \"nullable\": true\n }\n }\n }\n },\n \"detailLines\": {\n \"type\": \"array\",\n \"description\": \"Detail lines of the invoice\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Class that holds an invoice detail line\",\n \"additionalProperties\": false,\n \"required\": [\n \"articleName\",\n \"lineExtensionAmount\",\n \"vatRate\",\n \"quantity\"\n ],\n \"properties\": {\n \"additionalItemProperties\": {\n \"type\": \"object\",\n \"description\": \"A group of business terms providing information about properties of the goods and services invoiced.\",\n \"nullable\": true,\n \"additionalProperties\": {\n \"type\": \"string\"\n }\n },\n \"articleName\": {\n \"type\": \"string\",\n \"description\": \"A name for an item.\",\n \"maxLength\": 2000,\n \"minLength\": 0\n },\n \"articleDescription\": {\n \"type\": \"string\",\n \"description\": \"A description for an item.The item description allows for describing the item and its features in more detail than the Item name.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"articleNumberBuyer\": {\n \"type\": \"string\",\n \"description\": \"An identifier, assigned by the Buyer, for the item.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"articleNumberSupplier\": {\n \"type\": \"string\",\n \"description\": \"An identifier, assigned by the Seller, for the item.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"lineExtensionAmount\": {\n \"type\": \"number\",\n \"description\": \"The total amount of the Invoice line. The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes.\\nMust be rounded to maximum 2 decimals.\\nIf not supplied, the AmountExclVat will be used\",\n \"format\": \"decimal\"\n },\n \"allowanceReason\": {\n \"type\": \"string\",\n \"description\": \"The reason for the allowance on this line, if there is an allowance.\",\n \"maxLength\": 1000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"allowanceAmount\": {\n \"type\": \"number\",\n \"description\": \"The allowance amount, if there is an allowance\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"chargeReason\": {\n \"type\": \"string\",\n \"description\": \"The reason for the charge on this line, if there is a charge.\",\n \"maxLength\": 1000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"chargeAmount\": {\n \"type\": \"number\",\n \"description\": \"The charge amount, if there is a charge\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"commodityClassificationCodes\": {\n \"type\": \"object\",\n \"description\": \"A code for classifying the item by its type or nature.\",\n \"nullable\": true,\n \"additionalProperties\": {\n \"type\": \"string\"\n }\n },\n \"deliveryDate\": {\n \"type\": \"string\",\n \"description\": \"Delivery date\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"deliveryNoteReference\": {\n \"type\": \"string\",\n \"description\": \"Delivery note reference\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"docRefDocType\": {\n \"type\": \"string\",\n \"description\": \"Code \\\"130\\\" MUST be used to indicate an invoice object reference. Not used for other additional documents\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"docRefId\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n },\n \"note\": {\n \"type\": \"string\",\n \"description\": \"A textual note that gives unstructured information that is relevant to the Invoice line.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"originCountryCode\": {\n \"type\": \"string\",\n \"description\": \"The code identifying the country from which the item originates.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"id\": {\n \"type\": \"string\",\n \"description\": \"A unique identifier for the individual line within the Invoice.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"accountingCost\": {\n \"type\": \"string\",\n \"description\": \"A textual value that specifies where to book the relevant data into the Buyer's financial accounts.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"startDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Invoice period for this Invoice line starts. Format =\\\"YYYY-MM-DD\\\"\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"endDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Invoice period for this Invoice line ends. Format =\\\"YYYY-MM-DD\\\"\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"exemptFromDiscount\": {\n \"type\": \"boolean\",\n \"description\": \"Set this flag to true to excempt this line from being included in the discount\"\n },\n \"vatCode\": {\n \"type\": \"string\",\n \"description\": \"The VAT category code for the invoiced item.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"vatRate\": {\n \"type\": \"number\",\n \"description\": \"The VAT rate, represented as percentage that applies to the invoiced item.\",\n \"format\": \"decimal\"\n },\n \"orderLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for a referenced line within a purchase order, issued by the Buyer.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"quantity\": {\n \"type\": \"number\",\n \"description\": \"The quantity of items (goods or services) that is charged in the Invoice line.\",\n \"format\": \"decimal\"\n },\n \"standardItemIdentification\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n },\n \"price\": {\n \"type\": \"object\",\n \"description\": \"A group of items related to the price of an invoiced item\",\n \"additionalProperties\": false,\n \"required\": [\n \"articlePrice\"\n ],\n \"properties\": {\n \"articlePrice\": {\n \"type\": \"number\",\n \"description\": \"The price of an item, exclusive of VAT, after subtracting item price discount.\\nThe Item net price has to be equal with the Item gross price less the Item price discount, if they are both provided.\\nItem price can not be negative.\",\n \"format\": \"decimal\"\n },\n \"baseQuantity\": {\n \"type\": \"number\",\n \"description\": \"The number of item units to which the price applies.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"unitOfMeasure\": {\n \"type\": \"string\",\n \"description\": \"The unit of measure that applies to the invoiced quantity.\\nCodes for unit of packaging from UNECE Recommendation No.\\n21 can be used in accordance with the descriptions in the \\\"Intro\\\" section of UN/ECE Recommendation 20, Revision 11 (2015):\\nThe 2 character alphanumeric code values in UNECE Recommendation 21 shall be used.\\nTo avoid duplication with existing code values in UNECE Recommendation No.\\n20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"allowanceAmount\": {\n \"type\": \"number\",\n \"description\": \"The total discount subtracted from the Item gross price to calculate the Item net price.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"allowanceBaseAmount\": {\n \"type\": \"number\",\n \"description\": \"The unit price, exclusive of VAT, before subtracting Item price discount, can not be negative\",\n \"format\": \"decimal\",\n \"nullable\": true\n }\n }\n },\n \"vatExemptionReason\": {\n \"type\": \"string\",\n \"description\": \"The VatExemptionReason\",\n \"nullable\": true\n },\n \"vatExemptionReasonCode\": {\n \"type\": \"string\",\n \"description\": \"The VatExemptionReasonCode\",\n \"nullable\": true\n },\n \"uuLineNumber\": {\n \"type\": \"string\",\n \"description\": \"Universal unique line number\\nShould be unique not only per invoice but per taxpayer or invoicing system\",\n \"nullable\": true\n },\n \"lineGTU\": {\n \"type\": \"string\",\n \"description\": \"Designation for the delivery of goods and the provision of services\",\n \"nullable\": true\n },\n \"lineDueDateTypeCode\": {\n \"type\": \"string\",\n \"description\": \"Code specifying the type of due date that applies to this Invoice line.\",\n \"nullable\": true\n },\n \"referencedDespatchDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the despatch advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedDespatchDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced despatch advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the invoice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced invoice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocTypeCode\": {\n \"type\": \"string\",\n \"description\": \"The document type code of the referenced invoice.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocIssueDate\": {\n \"type\": \"string\",\n \"description\": \"The issue date of the referenced invoice. Format = \\\"YYYY-MM-DD\\\"\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"referencedReceiptDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the receiving advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedReceiptDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced receiving advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedSalesOrderDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the sales order that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedSalesOrderDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced sales order that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"deliveryActualDeliveryDate\": {\n \"type\": \"string\",\n \"description\": \"The date on which the goods or services on this Invoice line were actually delivered. Format = \\\"YYYY-MM-DD\\\"\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"deliveryPartyName\": {\n \"type\": \"string\",\n \"description\": \"The name of the party that the goods or services on this Invoice line were delivered to.\",\n \"nullable\": true\n },\n \"deliveryLocationIDs\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationAddress1\": {\n \"type\": \"string\",\n \"description\": \"Street and street number of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationAddress2\": {\n \"type\": \"string\",\n \"description\": \"Additional address line of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationAddress3\": {\n \"type\": \"string\",\n \"description\": \"Additional address line of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationCity\": {\n \"type\": \"string\",\n \"description\": \"City of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationZIP\": {\n \"type\": \"string\",\n \"description\": \"Postal code of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationCountrySubEntity\": {\n \"type\": \"string\",\n \"description\": \"Province, state or region of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationCountryCode\": {\n \"type\": \"string\",\n \"description\": \"The country of the delivery location of this Invoice line, as an ISO 3166-1 alpha-2 code.\",\n \"nullable\": true\n }\n }\n }\n },\n \"parties\": {\n \"type\": \"array\",\n \"description\": \"Involved parties of the invoice\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"An additional party involved in the invoice, beyond the Customer, Supplier, Buyer,\\nPayee and TaxRepresentative that have their own dedicated groups. The role the party\\ntakes on the invoice is given by RoleCode.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"partyName\": {\n \"type\": \"string\",\n \"description\": \"The name of the party.\",\n \"nullable\": true\n },\n \"roleCode\": {\n \"type\": \"string\",\n \"description\": \"A code identifying the role that this party takes on the invoice.\",\n \"nullable\": true\n },\n \"endpointID\": {\n \"type\": \"string\",\n \"description\": \"The electronic endpoint identifier of the party.\",\n \"nullable\": true\n },\n \"endpointIDType\": {\n \"type\": \"string\",\n \"description\": \"The endpoint type or scheme which relates to the EndpointID.\",\n \"nullable\": true\n },\n \"identifiers\": {\n \"type\": \"array\",\n \"description\": \"Additional identifiers for the party. Both members of each identifier are mandatory.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n }\n },\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Street and street number of the party.\",\n \"nullable\": true\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Additional address line of the party.\",\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Additional address line of the party.\",\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City of the party.\",\n \"nullable\": true\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"Postal code of the party.\",\n \"nullable\": true\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"The country of the party, as an ISO 3166-1 alpha-2 code.\",\n \"nullable\": true\n },\n \"countryName\": {\n \"type\": \"string\",\n \"description\": \"The country name of the party.\",\n \"nullable\": true\n },\n \"countrySubEntity\": {\n \"type\": \"string\",\n \"description\": \"Province, state or region of the party.\",\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"The VAT number of the party.\",\n \"nullable\": true\n },\n \"contactID\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the contact of the party.\",\n \"nullable\": true\n },\n \"contactName\": {\n \"type\": \"string\",\n \"description\": \"The contact person of the party.\",\n \"nullable\": true\n },\n \"contactEmail\": {\n \"type\": \"string\",\n \"description\": \"The contact email address of the party.\",\n \"nullable\": true\n },\n \"contactPhone\": {\n \"type\": \"string\",\n \"description\": \"The contact phone number of the party.\",\n \"nullable\": true\n },\n \"partyLERegistrationName\": {\n \"type\": \"string\",\n \"description\": \"The registered legal entity name of the party.\",\n \"nullable\": true\n },\n \"partyLECompanyID\": {\n \"type\": \"string\",\n \"description\": \"The legal entity company identifier of the party (e.g. Belgium CBE/KBO).\",\n \"nullable\": true\n },\n \"partyLECompanyIDType\": {\n \"type\": \"string\",\n \"description\": \"The scheme of the legal entity company identifier, using the ICD code list.\",\n \"nullable\": true\n },\n \"partyLECompanyLegalForm\": {\n \"type\": \"string\",\n \"description\": \"The legal form of the legal entity.\",\n \"nullable\": true\n },\n \"recipientType\": {\n \"type\": \"string\",\n \"description\": \"Flag to indicate Subordinate Local Government Unit or GV member.\",\n \"nullable\": true\n }\n }\n }\n },\n \"buyer\": {\n \"type\": \"object\",\n \"description\": \"Buyer info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Full legal name of the buyer\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"glnNumber\": {\n \"type\": \"string\",\n \"description\": \"Global Location Number of the buyer\",\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"VAT number of the buyer\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"contact\": {\n \"type\": \"object\",\n \"description\": \"Business contact\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Id of the business contact\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the business contact\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the business contact\",\n \"maxLength\": 300,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Phone number of the contact\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"recipientType\": {\n \"type\": \"string\",\n \"description\": \"Type of the buyer\\nPossible values:\\n12: JST Recipient\\n21: GV Recipient\",\n \"nullable\": true\n }\n }\n },\n \"taxExchangeRate\": {\n \"type\": \"object\",\n \"description\": \"Represents an exchange rate used for tax calculations between different currencies.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"sourceCurrencyCode\": {\n \"type\": \"string\",\n \"description\": \"ISO currency code representing the source currency for the transaction.\",\n \"nullable\": true\n },\n \"targetCurrencyCode\": {\n \"type\": \"string\",\n \"description\": \"ISO currency code representing the target currency for conversion or display.\",\n \"nullable\": true\n },\n \"calculationRate\": {\n \"type\": \"number\",\n \"description\": \"Exchange rate.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"mathematicOperatorCode\": {\n \"type\": \"string\",\n \"description\": \"Mathematical operator used in calculations. Default is \\\"Multiply\\\".\",\n \"nullable\": true\n },\n \"date\": {\n \"type\": \"string\",\n \"description\": \"Date for the calculation rate.\",\n \"format\": \"date-time\",\n \"nullable\": true\n }\n }\n },\n \"invoicePeriodDescriptionCode\": {\n \"type\": \"string\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"deliveryTermsId\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"deliveryTermsDeliveryLocationName\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"contractDocReferenceTypeCode\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nClass that holds details of an invoice (outbound)
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"References\",\n \"additionalProperties\": false,\n \"properties\": {\n \"accountingCost\": {\n \"type\": \"string\",\n \"description\": \"Buyer accounting reference\\nA textual value that specifies where to book the relevant data into the Buyer's financial accounts.\\nExample value: 4217:2323:2323\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"billingReferences\": {\n \"type\": \"array\",\n \"description\": \"A group of business terms providing information on the preceding Invoice.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"invoiceDocumentReference\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"invoiceDocumentReferenceIssueDate\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"reasonForCorrection\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"documentTypeCode\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"externalReference\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"typeOfCorrection\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n }\n },\n \"buyerReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier assigned by the Buyer used for internal routing purposes. An invoice must have buyer reference or purchase order reference (BT-13).\",\n \"maxLength\": 1000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"contractDocReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of a contract as specified by the sender\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"contractDocIssueDate\": {\n \"type\": \"string\",\n \"description\": \"Date of the contract as specified by the sender\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"contractDocReferenceCustomer\": {\n \"type\": \"string\",\n \"description\": \"The identification of a contract as specified by the receiver\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"contractDocIssueDateCustomer\": {\n \"type\": \"string\",\n \"description\": \"Date of the contract as specified by the receiver\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"despatchDocReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced despatch advice.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"invoiceDocumentReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of an Invoice that was previously sent by the Seller.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"invoiceDocumentReferenceIssueDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Preceding Invoice was issued.Shall be provided in case the Preceding Invoice identifier is not unique. Format = \\\"YYYY-MM-DD\\\".\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"originatorDocReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of the call for tender or lot the invoice relates to.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"projectReference\": {\n \"type\": \"string\",\n \"description\": \"The identification of the project the invoice refers to.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"purchaseOrderReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced purchase order, issued by the Buyer.An invoice must have buyer reference (BT-10) or purchase order reference.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"receiptDocReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced receiving advice.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"salesOrderIssueDate\": {\n \"type\": \"string\",\n \"description\": \"Spain only: add Issuer transaction date (recommended, not mandatory)\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"salesOrderReference\": {\n \"type\": \"string\",\n \"description\": \"An identifier of a referenced sales order, issued by the Seller.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nReferences
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Customer info\",\n \"additionalProperties\": false,\n \"required\": [\n \"address\",\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Customer number in the suppliers system\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"contact\": {\n \"type\": \"object\",\n \"description\": \"Business contact\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Id of the business contact\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the business contact\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the business contact\",\n \"maxLength\": 300,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Phone number of the contact\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"companyNumber\": {\n \"type\": \"string\",\n \"description\": \"Company number of the customer. CompanyNumber or VAT Number required for companies\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"department\": {\n \"type\": \"string\",\n \"description\": \"Department of the customer\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the customer\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"VAT number of the customer. CompanyNumber or VAT Number required for companies\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"glnNumber\": {\n \"type\": \"string\",\n \"description\": \"Glnnumber of the customer\",\n \"nullable\": true\n },\n \"endpointId\": {\n \"type\": \"string\",\n \"description\": \"EndpointId of the customer\",\n \"nullable\": true\n },\n \"endpointType\": {\n \"type\": \"string\",\n \"description\": \"EndpointType of the customer\",\n \"nullable\": true\n },\n \"identifications\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n }\n }\n }\n}\n\nCustomer info
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nAddress
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Delivery info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"actualDeliveryDate\": {\n \"type\": \"string\",\n \"description\": \"The date on which the supply of goods or services was made or completed. Format = \\\"YYYY-MM-DD\\\"\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"locationIdentifier\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"The name of the party to which the goods and services are delivered.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nDelivery info
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Payee info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"companyNumber\": {\n \"type\": \"string\",\n \"description\": \"This element is used for both the identification of the Payee,\\nor the unique banking reference identifier of Payee (assigned by the Payee bank.)\\nFor payee identification use ICD code list, for SEPA bank assigned creditor reference, use SEPA.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"financialAccountId\": {\n \"type\": \"string\",\n \"description\": \"The name of the payment account, at a payment service provider, to which payment should be made.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"financialAccountName\": {\n \"type\": \"string\",\n \"description\": \"The name of the payment account, at a payment service provider, to which payment should be made.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"The name of the Payee.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nPayee info
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Supplier info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Customer number in the suppliers system\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"contact\": {\n \"type\": \"object\",\n \"description\": \"Business contact\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Id of the business contact\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the business contact\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the business contact\",\n \"maxLength\": 300,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Phone number of the contact\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"companyNumber\": {\n \"type\": \"string\",\n \"description\": \"Company number of the supplier. CompanyNumber or VAT Number required for companies\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"department\": {\n \"type\": \"string\",\n \"description\": \"Department of the supplier\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the supplier\",\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"VAT number of the supplier. CompanyNumber or VAT Number required for companies\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"glnNumber\": {\n \"type\": \"string\",\n \"description\": \"Glnnumber of the supplier\",\n \"nullable\": true\n },\n \"endpointId\": {\n \"type\": \"string\",\n \"description\": \"EndpointId of the supplier\",\n \"nullable\": true\n },\n \"endpointType\": {\n \"type\": \"string\",\n \"description\": \"EndpointType of the supplier\",\n \"nullable\": true\n },\n \"taxpayersPrefix\": {\n \"type\": \"string\",\n \"description\": \"VAT UE country prefix (e.g. \\\"PL\\\") for intra-Community supplies, cross-border services, and triangular transactions.\",\n \"nullable\": true\n },\n \"identifications\": {\n \"type\": \"array\",\n \"description\": \"Additional identifiers for the party.\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n }\n }\n }\n}\n\nSupplier info
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Tax representative party\",\n \"additionalProperties\": false,\n \"properties\": {\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"The full name of the Seller's tax representative party.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"The VAT identifier of the Seller's tax representative party.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nTax representative party
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Invoice totals\",\n \"additionalProperties\": false,\n \"required\": [\n \"amountExclVat\",\n \"amountInclVat\",\n \"vatAmount\"\n ],\n \"properties\": {\n \"amountExclVat\": {\n \"type\": \"number\",\n \"description\": \"The total amount of the Invoice without VAT. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\"\n },\n \"amountInclVat\": {\n \"type\": \"number\",\n \"description\": \"The total amount of the Invoice with VAT. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\"\n },\n \"lineExtensionAmount\": {\n \"type\": \"number\",\n \"description\": \"Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals.\\nIf not supplied this is calculated as the sum of the LineExtensionAmount on the detail lines\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"payableAmount\": {\n \"type\": \"number\",\n \"description\": \"The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals.\\nIf not filled in the TaxInclusiveAmount will be used\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"payableRoundingAmount\": {\n \"type\": \"number\",\n \"description\": \"The amount to be added to the invoice total to round the amount to be paid. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"prepaidAmount\": {\n \"type\": \"number\",\n \"description\": \"The sum of amounts which have been paid in advance. Must be rounded to maximum 2 decimals.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"vatAmount\": {\n \"type\": \"number\",\n \"description\": \"The total VAT amount for the Invoice or the VAT total amount expressed in the accounting currency accepted or required in the country of the Seller. Must be rounded to maximum 2 decimals \",\n \"format\": \"decimal\"\n }\n }\n}\n\nInvoice totals
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Discount info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"amount\": {\n \"type\": \"number\",\n \"description\": \"The discount amount. Optional\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"percentage\": {\n \"type\": \"number\",\n \"description\": \"The discount percentage. Optional\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"reason\": {\n \"type\": \"string\",\n \"description\": \"Reason for the discount\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"taxExemptionReason\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"taxExemptionReasonCode\": {\n \"type\": \"string\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nDiscount info
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Charge info\",\n \"additionalProperties\": false,\n \"required\": [\n \"vatRate\"\n ],\n \"properties\": {\n \"amount\": {\n \"type\": \"number\",\n \"description\": \"The Charge amount\",\n \"format\": \"decimal\"\n },\n \"vatRate\": {\n \"type\": \"number\",\n \"description\": \"The charge vat rate\",\n \"format\": \"decimal\"\n },\n \"vatCode\": {\n \"type\": \"string\",\n \"description\": \"The VAT category code for the charge.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"reason\": {\n \"type\": \"string\",\n \"description\": \"Reason for the charge\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"taxExemptionReason\": {\n \"type\": \"string\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"taxExemptionReasonCode\": {\n \"type\": \"string\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nCharge info
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Class that holds an invoice detail line\",\n \"additionalProperties\": false,\n \"required\": [\n \"articleName\",\n \"lineExtensionAmount\",\n \"vatRate\",\n \"quantity\"\n ],\n \"properties\": {\n \"additionalItemProperties\": {\n \"type\": \"object\",\n \"description\": \"A group of business terms providing information about properties of the goods and services invoiced.\",\n \"nullable\": true,\n \"additionalProperties\": {\n \"type\": \"string\"\n }\n },\n \"articleName\": {\n \"type\": \"string\",\n \"description\": \"A name for an item.\",\n \"maxLength\": 2000,\n \"minLength\": 0\n },\n \"articleDescription\": {\n \"type\": \"string\",\n \"description\": \"A description for an item.The item description allows for describing the item and its features in more detail than the Item name.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"articleNumberBuyer\": {\n \"type\": \"string\",\n \"description\": \"An identifier, assigned by the Buyer, for the item.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"articleNumberSupplier\": {\n \"type\": \"string\",\n \"description\": \"An identifier, assigned by the Seller, for the item.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"lineExtensionAmount\": {\n \"type\": \"number\",\n \"description\": \"The total amount of the Invoice line. The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes.\\nMust be rounded to maximum 2 decimals.\\nIf not supplied, the AmountExclVat will be used\",\n \"format\": \"decimal\"\n },\n \"allowanceReason\": {\n \"type\": \"string\",\n \"description\": \"The reason for the allowance on this line, if there is an allowance.\",\n \"maxLength\": 1000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"allowanceAmount\": {\n \"type\": \"number\",\n \"description\": \"The allowance amount, if there is an allowance\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"chargeReason\": {\n \"type\": \"string\",\n \"description\": \"The reason for the charge on this line, if there is a charge.\",\n \"maxLength\": 1000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"chargeAmount\": {\n \"type\": \"number\",\n \"description\": \"The charge amount, if there is a charge\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"commodityClassificationCodes\": {\n \"type\": \"object\",\n \"description\": \"A code for classifying the item by its type or nature.\",\n \"nullable\": true,\n \"additionalProperties\": {\n \"type\": \"string\"\n }\n },\n \"deliveryDate\": {\n \"type\": \"string\",\n \"description\": \"Delivery date\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"deliveryNoteReference\": {\n \"type\": \"string\",\n \"description\": \"Delivery note reference\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"docRefDocType\": {\n \"type\": \"string\",\n \"description\": \"Code \\\"130\\\" MUST be used to indicate an invoice object reference. Not used for other additional documents\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"docRefId\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n },\n \"note\": {\n \"type\": \"string\",\n \"description\": \"A textual note that gives unstructured information that is relevant to the Invoice line.\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"originCountryCode\": {\n \"type\": \"string\",\n \"description\": \"The code identifying the country from which the item originates.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"id\": {\n \"type\": \"string\",\n \"description\": \"A unique identifier for the individual line within the Invoice.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"accountingCost\": {\n \"type\": \"string\",\n \"description\": \"A textual value that specifies where to book the relevant data into the Buyer's financial accounts.\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"startDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Invoice period for this Invoice line starts. Format =\\\"YYYY-MM-DD\\\"\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"endDate\": {\n \"type\": \"string\",\n \"description\": \"The date when the Invoice period for this Invoice line ends. Format =\\\"YYYY-MM-DD\\\"\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"exemptFromDiscount\": {\n \"type\": \"boolean\",\n \"description\": \"Set this flag to true to excempt this line from being included in the discount\"\n },\n \"vatCode\": {\n \"type\": \"string\",\n \"description\": \"The VAT category code for the invoiced item.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"vatRate\": {\n \"type\": \"number\",\n \"description\": \"The VAT rate, represented as percentage that applies to the invoiced item.\",\n \"format\": \"decimal\"\n },\n \"orderLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for a referenced line within a purchase order, issued by the Buyer.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"quantity\": {\n \"type\": \"number\",\n \"description\": \"The quantity of items (goods or services) that is charged in the Invoice line.\",\n \"format\": \"decimal\"\n },\n \"standardItemIdentification\": {\n \"type\": \"object\",\n \"description\": \"Represents an identifier with a value and a scheme.\",\n \"additionalProperties\": false,\n \"required\": [\n \"id\",\n \"schemeId\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The idenfier Id\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"schemeId\": {\n \"type\": \"string\",\n \"description\": \"The identifier schemeid\",\n \"maxLength\": 10,\n \"minLength\": 0\n }\n }\n },\n \"price\": {\n \"type\": \"object\",\n \"description\": \"A group of items related to the price of an invoiced item\",\n \"additionalProperties\": false,\n \"required\": [\n \"articlePrice\"\n ],\n \"properties\": {\n \"articlePrice\": {\n \"type\": \"number\",\n \"description\": \"The price of an item, exclusive of VAT, after subtracting item price discount.\\nThe Item net price has to be equal with the Item gross price less the Item price discount, if they are both provided.\\nItem price can not be negative.\",\n \"format\": \"decimal\"\n },\n \"baseQuantity\": {\n \"type\": \"number\",\n \"description\": \"The number of item units to which the price applies.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"unitOfMeasure\": {\n \"type\": \"string\",\n \"description\": \"The unit of measure that applies to the invoiced quantity.\\nCodes for unit of packaging from UNECE Recommendation No.\\n21 can be used in accordance with the descriptions in the \\\"Intro\\\" section of UN/ECE Recommendation 20, Revision 11 (2015):\\nThe 2 character alphanumeric code values in UNECE Recommendation 21 shall be used.\\nTo avoid duplication with existing code values in UNECE Recommendation No.\\n20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"allowanceAmount\": {\n \"type\": \"number\",\n \"description\": \"The total discount subtracted from the Item gross price to calculate the Item net price.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"allowanceBaseAmount\": {\n \"type\": \"number\",\n \"description\": \"The unit price, exclusive of VAT, before subtracting Item price discount, can not be negative\",\n \"format\": \"decimal\",\n \"nullable\": true\n }\n }\n },\n \"vatExemptionReason\": {\n \"type\": \"string\",\n \"description\": \"The VatExemptionReason\",\n \"nullable\": true\n },\n \"vatExemptionReasonCode\": {\n \"type\": \"string\",\n \"description\": \"The VatExemptionReasonCode\",\n \"nullable\": true\n },\n \"uuLineNumber\": {\n \"type\": \"string\",\n \"description\": \"Universal unique line number\\nShould be unique not only per invoice but per taxpayer or invoicing system\",\n \"nullable\": true\n },\n \"lineGTU\": {\n \"type\": \"string\",\n \"description\": \"Designation for the delivery of goods and the provision of services\",\n \"nullable\": true\n },\n \"lineDueDateTypeCode\": {\n \"type\": \"string\",\n \"description\": \"Code specifying the type of due date that applies to this Invoice line.\",\n \"nullable\": true\n },\n \"referencedDespatchDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the despatch advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedDespatchDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced despatch advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the invoice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced invoice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocTypeCode\": {\n \"type\": \"string\",\n \"description\": \"The document type code of the referenced invoice.\",\n \"nullable\": true\n },\n \"referencedInvoiceDocIssueDate\": {\n \"type\": \"string\",\n \"description\": \"The issue date of the referenced invoice. Format = \\\"YYYY-MM-DD\\\"\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"referencedReceiptDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the receiving advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedReceiptDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced receiving advice that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedSalesOrderDocId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the sales order that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"referencedSalesOrderDocLineId\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the line within the referenced sales order that this Invoice line refers to.\",\n \"nullable\": true\n },\n \"deliveryActualDeliveryDate\": {\n \"type\": \"string\",\n \"description\": \"The date on which the goods or services on this Invoice line were actually delivered. Format = \\\"YYYY-MM-DD\\\"\",\n \"format\": \"date-time\",\n \"nullable\": true\n },\n \"deliveryPartyName\": {\n \"type\": \"string\",\n \"description\": \"The name of the party that the goods or services on this Invoice line were delivered to.\",\n \"nullable\": true\n },\n \"deliveryLocationIDs\": {\n \"type\": \"string\",\n \"description\": \"An identifier for the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationAddress1\": {\n \"type\": \"string\",\n \"description\": \"Street and street number of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationAddress2\": {\n \"type\": \"string\",\n \"description\": \"Additional address line of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationAddress3\": {\n \"type\": \"string\",\n \"description\": \"Additional address line of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationCity\": {\n \"type\": \"string\",\n \"description\": \"City of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationZIP\": {\n \"type\": \"string\",\n \"description\": \"Postal code of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationCountrySubEntity\": {\n \"type\": \"string\",\n \"description\": \"Province, state or region of the delivery location of this Invoice line.\",\n \"nullable\": true\n },\n \"deliveryLocationCountryCode\": {\n \"type\": \"string\",\n \"description\": \"The country of the delivery location of this Invoice line, as an ISO 3166-1 alpha-2 code.\",\n \"nullable\": true\n }\n }\n}\n\nClass that holds an invoice detail line
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Buyer info\",\n \"additionalProperties\": false,\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Full legal name of the buyer\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Address\",\n \"additionalProperties\": false,\n \"required\": [\n \"address1\",\n \"city\",\n \"zip\",\n \"countryCode\"\n ],\n \"properties\": {\n \"address1\": {\n \"type\": \"string\",\n \"description\": \"Address 1\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"address2\": {\n \"type\": \"string\",\n \"description\": \"Address 2\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"address3\": {\n \"type\": \"string\",\n \"description\": \"Address 3\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"zip\": {\n \"type\": \"string\",\n \"description\": \"ZIP code\",\n \"maxLength\": 200,\n \"minLength\": 0\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"description\": \"ISO country code\",\n \"minLength\": 1\n },\n \"province\": {\n \"type\": \"string\",\n \"description\": \"Province\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"glnNumber\": {\n \"type\": \"string\",\n \"description\": \"Global Location Number of the buyer\",\n \"nullable\": true\n },\n \"vatNumber\": {\n \"type\": \"string\",\n \"description\": \"VAT number of the buyer\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"contact\": {\n \"type\": \"object\",\n \"description\": \"Business contact\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Id of the business contact\",\n \"nullable\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the business contact\",\n \"maxLength\": 100,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"email\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the business contact\",\n \"maxLength\": 300,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"phone\": {\n \"type\": \"string\",\n \"description\": \"Phone number of the contact\",\n \"maxLength\": 50,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"recipientType\": {\n \"type\": \"string\",\n \"description\": \"Type of the buyer\\nPossible values:\\n12: JST Recipient\\n21: GV Recipient\",\n \"nullable\": true\n }\n }\n}\n\nBuyer info
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Represents an exchange rate used for tax calculations between different currencies.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"sourceCurrencyCode\": {\n \"type\": \"string\",\n \"description\": \"ISO currency code representing the source currency for the transaction.\",\n \"nullable\": true\n },\n \"targetCurrencyCode\": {\n \"type\": \"string\",\n \"description\": \"ISO currency code representing the target currency for conversion or display.\",\n \"nullable\": true\n },\n \"calculationRate\": {\n \"type\": \"number\",\n \"description\": \"Exchange rate.\",\n \"format\": \"decimal\",\n \"nullable\": true\n },\n \"mathematicOperatorCode\": {\n \"type\": \"string\",\n \"description\": \"Mathematical operator used in calculations. Default is \\\"Multiply\\\".\",\n \"nullable\": true\n },\n \"date\": {\n \"type\": \"string\",\n \"description\": \"Date for the calculation rate.\",\n \"format\": \"date-time\",\n \"nullable\": true\n }\n }\n}\n\nRepresents an exchange rate used for tax calculations between different currencies.
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"Processing\",\n \"additionalProperties\": false,\n \"properties\": {\n \"deliveryMethod\": {\n \"type\": \"string\",\n \"description\": \"Channel that has to be used to send to invoice to the receiver.\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraCode1\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraCode2\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraCode3\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraCode4\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraCode5\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraCode6\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraCode7\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraCode8\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraCode9\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraCode10\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 200,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"extraInfo\": {\n \"type\": \"string\",\n \"description\": \"Optional extra information that can be used in rules\",\n \"maxLength\": 500,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nProcessing
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"description\": \"An attachment\",\n \"additionalProperties\": false,\n \"properties\": {\n \"embedded\": {\n \"type\": \"boolean\",\n \"description\": \"Is it an embedded file?\"\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"name of the file\\nIf it isn't an embedded file, it should be included as multipart file-data. The name of the file should be identical.\",\n \"nullable\": true\n },\n \"mimeType\": {\n \"type\": \"string\",\n \"description\": \"mime type of the file\",\n \"nullable\": true\n },\n \"value\": {\n \"type\": \"string\",\n \"description\": \"a base64 (embedded)\",\n \"nullable\": true\n }\n }\n}\n\nAn attachment
\nbackwards compatibility
\n\n\n\n\n{\n \"succeeded\": \"(boolean) Indicates if the feedback was set successfully. Example: true\",\n \"message\": \"(string) Informational message. Example: Feedback set for invoice 23110000291\"\n}\n\nRepresents the response returned after attempting to send feedback for an invoice.
\nbackwards compatibility
\n\n\n\n\n{\n \"feedbackCode\": \"(string, required) Code of the feedback that is sent back to the supplier. Example: AB\",\n \"feedbackMessage\": \"(string, required) Description of the feedback. Example: Invoice approved for payment\",\n \"reasonCode\": \"(string) Coded reason for the feedback. Example: REF\",\n \"reason\": \"(string) Textual reason for the feedback. Example: Purchase order reference is missing\",\n \"requestedActionCode\": \"(string) Coded action requested from the supplier. Example: CNF\",\n \"requestedAction\": \"(string) Textual action requested from the supplier. Example: Please send a credit note\"\n}\n\nbackwards compatibility
\n\n\n\n\n{\n \"message\": \"(string) Informational message. Example: Invoice 23110000291 was marked as downloaded\"\n}\n\nResponse when an object is marked as downloaded
\nx-api-key
\n","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//masterdata/companies","description":"Returns all companies in the current tenant that your API key has access to.
\nThe id of each company is its PartyId. Every other request in this API is made for one company and takes this value as {partyId} in the URL.
Usage
\nResponses
\n200 OK: the companies your API key has access to.401 Unauthorized: the API key is missing or not valid.x-api-key
\n","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//masterdata/companies/:partyId","description":"Returns a single company of the current tenant.
\nUsage
\npartyId is the id returned by GET /masterdata/companies.id in the response is the same PartyId: use it as {partyId} in all other requests.Responses
\n200 OK: the company.404 Not Found: there is no company with this PartyId that your API key has access to.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
x-api-key
\n","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//masterdata/companies/:partyId/contacts/:id","description":"Returns a single customer by its ID.\nThis endpoint only finds customers. Use GET /masterdata/companies/{partyId}/suppliers/{id} for a supplier. GET /masterdata/companies/{partyId}/customers/{id} returns the same result.
\nUsage
\nid is the ID you gave the customer when you uploaded it.Responses
\n200 OK: the customer.404 Not Found: unknown PartyId or customer.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
The ID of the customer, as given when it was uploaded.
\n","type":"text/plain"},"type":"any","value":"string","key":"id"}]}},"response":[{"id":"093abdb0-9b7d-420a-868f-26d31ed8474e","name":"OK","originalRequest":{"method":"GET","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//masterdata/companies/:partyId/contacts/:id","host":["https://api.soluz.io/"],"path":["masterdata","companies",":partyId","contacts",":id"],"variable":[{"key":"partyId","value":"1908","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"string","description":"The ID of the customer, as given when it was uploaded."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"id\": \"(string) Unique ID of the customer, chosen by you. Use it to get, update or delete the customer. Example: SOL-CU-0001\",\n\t\"name\": \"(string) Legal or display name. Example: Soluz.io\",\n\t\"language\": \"(string) ISO 639 language code (2 or 3 letters). Example: EN\",\n\t\"countryCode\": \"(string) ISO 3166 country code (2 or 3 letters). Example: BE\",\n\t\"defaultChannel\": \"(string) Delivery channel for the INVOICES document group. Ignored when channels is filled. Example: PEPPOL\",\n\t\"vatNumber\": \"(string) VAT number. Example: BE0123456789\",\n\t\"companyNumber\": \"(string) Company number: CBE/KBO number for BE, SIRET number for FR. Example: 0123456789\",\n\t\"glnNumber\": \"(string) GLN number (13 digits). Example: 5412345000013\",\n\t\"source\": \"(string) Source of the contact information. Example: ERP\",\n\t\"sourceChannel\": \"(string) Source channel of the contact information. Example: CRM\",\n\t\"validateInvoices\": \"(boolean) Validate invoices for this customer before they are sent. Example: true\",\n\t\"active\": \"(boolean) Whether the customer is active. Example: true\",\n\t\"contractReference\": \"(string) Contract number / assignment code of the buyer. Example: CTR-2025-SOL-17\",\n\t\"contractIssueDate\": \"(string, date) Issue date of the contract / assignment of the buyer (YYYY-MM-DD). Example: 2025-01-15\",\n\t\"defaultEmailAddress\": \"(string) Default e-mail address. Example: billing@soluz.example\",\n\t\"channels\": [\n\t\t{\n\t\t\t\"documentGroup\": \"(string) Document group the channel applies to. Example: INVOICES\",\n\t\t\t\"channel\": \"(string) Delivery channel for this document group. Example: PEPPOL\",\n\t\t\t\"target\": \"(string) Optional target within the channel. A channel set through defaultChannel gets the target Default. Example: Default\"\n\t\t}\n\t],\n\t\"mobile\": \"(string) Mobile phone number. Example: +32470111222\",\n\t\"website\": \"(string) Website. Example: https://www.soluz.example\",\n\t\"extraCode1\": \"(string) Free field 1 for your own codes. Example: CODE1\",\n\t\"extraCode2\": \"(string) Free field 2 for your own codes. Example: CODE2\",\n\t\"extraCode3\": \"(string) Free field 3 for your own codes. Example: CODE3\",\n\t\"extraCode4\": \"(string) Free field 4 for your own codes. Example: CODE4\",\n\t\"extraCode5\": \"(string) Free field 5 for your own codes. Example: CODE5\",\n\t\"defaultAddress\": {\n\t\t\"addressee\": \"(string) Addressee (name on the address). Example: Soluz.io\",\n\t\t\"street\": \"(string) Street. Example: Zwartzustersvest\",\n\t\t\"number\": \"(string) House number. Example: 24\",\n\t\t\"zip\": \"(string) Postal code. Example: 2800\",\n\t\t\"city\": \"(string) City. Example: Mechelen\",\n\t\t\"country\": \"(string) Country name. Example: Belgium\",\n\t\t\"postBox\": \"(string) Post box, if any. Example: PB12\",\n\t\t\"state\": \"(string) State / province / region. Example: Antwerpen\"\n\t},\n\t\"endpointId\": \"(string) EndpointID used in UBL as the identification number of the receiver. Example: 0123456789\",\n\t\"endpointSchemeId\": \"(string) Scheme of the Endpoint ID. Example: 0208\",\n\t\"esAccountingUnit\": \"(Spain)(string) Accounting office (Oficina Contable, FacturaE), a DIR3 code. Example: LA0003446\",\n\t\"esManagingUnit\": \"(Spain)(string) Managing body (Órgano Gestor, FacturaE), a DIR3 code. Example: GE0001450\",\n\t\"esClientName\": \"(Spain)(string) Proposing agency (Órgano Proponente, FacturaE). Example: GE0001453\",\n\t\"esProcessingUnit\": \"(Spain)(string) Processing unit (Unidad Tramitadora, FacturaE), a DIR3 code. Example: GE0001464\",\n\t\"itDestinationCode\": \"(Italy)(string) Recipient code (Codice Destinatario, FatturaPA). Example: A1B2C3D\",\n\t\"itClerkCode\": \"(Italy)(string) Order / agreement code (Codice Commessa, FatturaPA). Example: COMM-0042\",\n\t\"frServiceCode\": \"(France)(string) Chorus Pro service code. Example: SRV-789\",\n\t\"frServiceCodeName\": \"(France)(string) Chorus Pro service code name. Example: Direction Achats\"\n}"},{"id":"ae356561-1a95-49b9-aa7f-bfec3948d628","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//masterdata/companies/:partyId/contacts/:id","host":["https://api.soluz.io/"],"path":["masterdata","companies",":partyId","contacts",":id"],"variable":[{"key":"partyId","value":"1908","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"string","description":"The ID of the customer, as given when it was uploaded."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"message\": \"string\"\n}"},{"id":"e12ef244-2e19-48a5-8cc7-b3d8bd90d87d","name":"NotFound","originalRequest":{"method":"GET","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//masterdata/companies/:partyId/contacts/:id","host":["https://api.soluz.io/"],"path":["masterdata","companies",":partyId","contacts",":id"],"variable":[{"key":"partyId","value":"1908","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"string","description":"The ID of the customer, as given when it was uploaded."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"statusCode\": 6767,\n\t\"message\": \"string\"\n}"}],"_postman_id":"c73e50cf-341c-4b62-b9ce-e7d642b54ace"},{"name":"Delete contact (customer)","id":"d2a87bf6-639e-439c-a06d-e5dfae2e8993","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"x-api-key
\n","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//masterdata/companies/:partyId/contacts/:id","description":"Deletes a single customer by its ID.\nThis endpoint only deletes customers. Use DELETE /masterdata/companies/{partyId}/suppliers/{id} for a supplier.
\nUsage
\nid is the ID you gave the customer when you uploaded it.Responses
\n200 OK: the message \"The contact was deleted\".404 Not Found: unknown PartyId or customer.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
The ID of the customer, as given when it was uploaded.
\n","type":"text/plain"},"type":"any","value":"string","key":"id"}]}},"response":[{"id":"70bb02a0-6579-454c-a654-3072023c6062","name":"OK","originalRequest":{"method":"DELETE","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//masterdata/companies/:partyId/contacts/:id","host":["https://api.soluz.io/"],"path":["masterdata","companies",":partyId","contacts",":id"],"variable":[{"key":"partyId","value":"1908","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"string","description":"The ID of the customer, as given when it was uploaded."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"string"},{"id":"f107c74b-605a-4426-9d0d-5efe48d6830e","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//masterdata/companies/:partyId/contacts/:id","host":["https://api.soluz.io/"],"path":["masterdata","companies",":partyId","contacts",":id"],"variable":[{"key":"partyId","value":"1908","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"string","description":"The ID of the customer, as given when it was uploaded."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"message\": \"string\"\n}"},{"id":"89d3cff6-292d-49aa-b6d5-16c56b8436e2","name":"NotFound","originalRequest":{"method":"DELETE","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//masterdata/companies/:partyId/contacts/:id","host":["https://api.soluz.io/"],"path":["masterdata","companies",":partyId","contacts",":id"],"variable":[{"key":"partyId","value":"1908","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"string","description":"The ID of the customer, as given when it was uploaded."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"statusCode\": 6767,\n\t\"message\": \"string\"\n}"}],"_postman_id":"d2a87bf6-639e-439c-a06d-e5dfae2e8993"},{"name":"Add or update a contact","id":"595c3e77-b3d7-4fea-941b-135d9ed3e08a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"x-api-key
\n","key":"Authorization","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"id\": \"(required)(string, max 255) Unique ID of the contact, chosen by you. Use it to get, update or delete the contact. Example: SOL-CT-0001\",\n\t\"name\": \"(string, max 255) Legal or display name. Example: Soluz.io\",\n\t\"type\": \"(number) Contact type: 1 = Customer, 2 = Supplier. When omitted, the contact is uploaded as a customer. Example: 1\",\n\t\"language\": \"(string) ISO 639 language code (2 or 3 letters). Example: EN\",\n\t\"countryCode\": \"(string) ISO 3166 country code (2 or 3 letters). Example: BE\",\n\t\"defaultChannel\": \"(Customer only)(string, max 200) Delivery channel for the INVOICES document group. Ignored when channels is filled. Example: PEPPOL\",\n\t\"vatNumber\": \"(string, max 100) VAT number. Example: BE0123456789\",\n\t\"companyNumber\": \"(string, max 100) Company number: CBE/KBO number for BE, SIRET number for FR. Example: 0123456789\",\n\t\"glnNumber\": \"(string, max 100) GLN number (13 digits). Example: 5412345000013\",\n\t\"source\": \"(string, max 100) Source of the contact information. Example: BC365\",\n\t\"sourceChannel\": \"(Customer only)(string, max 100) Source channel of the contact information. Example: CRM\",\n\t\"financialAccountID\": \"(Supplier only)(string, max 100) Bank account (IBAN). Example: BE68539007547034\",\n\t\"alternativeFinancialAccountIDs\": \"(Supplier only)(string, max 250) Additional bank accounts (IBAN), separated by a comma and a space. Example: BE71096111112222, BE62310033334444\",\n\t\"validateInvoices\": \"(Customer only)(boolean) Validate invoices for this contact before they are sent. Example: true\",\n\t\"active\": \"(boolean) Whether the contact is active. Example: true\",\n\t\"contractReference\": \"(Customer only)(string, max 100) Contract number / assignment code of the buyer. Example: CTR-2025-SOL-17\",\n\t\"contractIssueDate\": \"(Customer only)(string, date) Issue date of the contract / assignment of the buyer (YYYY-MM-DD). Example: 2025-01-15\",\n\t\"invoiceApprovalCategory\": \"(Supplier only)(string, max 100) Approval category for invoices of this supplier. Example: STANDARD\",\n\t\"defaultEmailAddress\": \"(string, max 200) Default e-mail address. Example: ap@soluz.example\",\n\t\"channels\": [\n\t\t{\n\t\t\t\"documentGroup\": \"(Customer only)(required)(string, max 200) Document group the channel applies to. Example: INVOICES\",\n\t\t\t\"channel\": \"(string, max 200) Delivery channel for this document group. Example: PEPPOL\",\n\t\t\t\"target\": \"(string, max 200) Optional target within the channel. A channel set through defaultChannel gets the target Default. Example: Default\"\n\t\t}\n\t],\n\t\"mobile\": \"(string, max 30) Mobile phone number. Example: +32475123456\",\n\t\"website\": \"(string, max 200) Website. Example: https://www.soluz.example\",\n\t\"extraCode1\": \"(string, max 1000) Free field 1 for your own codes. Example: CODE1\",\n\t\"extraCode2\": \"(string, max 1000) Free field 2 for your own codes. Example: CODE2\",\n\t\"extraCode3\": \"(string, max 1000) Free field 3 for your own codes. Example: CODE3\",\n\t\"extraCode4\": \"(string, max 1000) Free field 4 for your own codes. Example: CODE4\",\n\t\"extraCode5\": \"(string, max 1000) Free field 5 for your own codes. Example: CODE5\",\n\t\"defaultAddress\": {\n\t\t\"addressee\": \"(string, max 200) Addressee (name on the address). Example: Soluz.io\",\n\t\t\"street\": \"(string, max 200) Street. Example: Zwartzustersvest\",\n\t\t\"number\": \"(string, max 30) House number. Example: 24\",\n\t\t\"zip\": \"(string, max 30) Postal code. Example: 2800\",\n\t\t\"city\": \"(string, max 100) City. Example: Mechelen\",\n\t\t\"country\": \"(string, max 50) Country name. Example: Belgium\",\n\t\t\"postBox\": \"(string, max 30) Post box, if any. Example: PB12\",\n\t\t\"state\": \"(string, max 50) State / province / region. Example: Antwerpen\"\n\t},\n\t\"endpointId\": \"(Customer only)(string, max 50) EndpointID used in UBL as the identification number of the receiver. Example: 0123456789\",\n\t\"endpointSchemeId\": \"(Customer only)(string, max 50) Scheme of the Endpoint ID. Example: 0208\",\n\t\"esAccountingUnit\": \"(Customer only)(Spain)(string, max 200) Accounting office (Oficina Contable, FacturaE), a DIR3 code. Example: LA0003446\",\n\t\"esManagingUnit\": \"(Customer only)(Spain)(string, max 100) Managing body (Órgano Gestor, FacturaE), a DIR3 code. Example: GE0001450\",\n\t\"esClientName\": \"(Customer only)(Spain)(string, max 100) Proposing agency (Órgano Proponente, FacturaE). Example: GE0001453\",\n\t\"esProcessingUnit\": \"(Customer only)(Spain)(string, max 200) Processing unit (Unidad Tramitadora, FacturaE), a DIR3 code. Example: GE0001464\",\n\t\"itDestinationCode\": \"(Customer only)(Italy)(string, max 100) Recipient code (Codice Destinatario, FatturaPA). Example: A1B2C3D\",\n\t\"itClerkCode\": \"(Customer only)(Italy)(string, max 100) Order / agreement code (Codice Commessa, FatturaPA). Example: COMM-0042\",\n\t\"frServiceCode\": \"(Customer only)(France)(string, max 100) Chorus Pro service code. Example: SRV-789\",\n\t\"frServiceCodeName\": \"(Customer only)(France)(string, max 200) Chorus Pro service code name. Example: Direction Achats\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.soluz.io//masterdata/companies/:partyId/contacts","description":"Adds a contact, or updates the existing contact with the same id and type.
Usage
\nid is your own unique ID for the contact. You use it later to get, update or delete the contact.type decides whether the contact is stored as a customer (1) or a supplier (2). When type is omitted, it is stored as a customer.channels is filled, defaultChannel is ignored. Otherwise defaultChannel is stored as the delivery channel for the INVOICES document group.contractIssueDate uses the format YYYY-MM-DD.Responses
\n201 Created: the contact was processed.400 Bad Request: the request is not valid, for example an unknown type.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
x-api-key
\n","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//masterdata/companies/:partyId/suppliers/:id","description":"Returns a single supplier by its ID.
\nUsage
\nid is the ID you gave the supplier when you uploaded it.Responses
\n200 OK: the supplier.404 Not Found: unknown PartyId or supplier.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
The ID of the supplier, as given when it was uploaded.
\n","type":"text/plain"},"type":"any","value":"string","key":"id"}]}},"response":[{"id":"9e19fd3a-7960-483f-a644-cd9accad3ace","name":"OK","originalRequest":{"method":"GET","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//masterdata/companies/:partyId/suppliers/:id","host":["https://api.soluz.io/"],"path":["masterdata","companies",":partyId","suppliers",":id"],"variable":[{"key":"partyId","value":"1908","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"string","description":"The ID of the supplier, as given when it was uploaded."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"id\": \"(string) Unique ID of the supplier, chosen by you. Use it to get, update or delete the supplier. Example: SOL-SU-0001\",\n\t\"name\": \"(string) Legal or display name. Example: Soluz.io\",\n\t\"language\": \"(string) ISO 639 language code (2 or 3 letters). Example: EN\",\n\t\"countryCode\": \"(string) ISO 3166 country code (2 or 3 letters). Example: BE\",\n\t\"vatNumber\": \"(string) VAT number. Example: BE0123456789\",\n\t\"companyNumber\": \"(string) Company number: CBE/KBO number for BE, SIRET number for FR. Example: 0123456789\",\n\t\"glnNumber\": \"(string) GLN number (13 digits). Example: 5412345000013\",\n\t\"source\": \"(string) Source of the contact information. Example: Vendor Onboarding\",\n\t\"financialAccountID\": \"(string) Bank account (IBAN). Example: BE68539007547034\",\n\t\"alternativeFinancialAccountIDs\": \"(string) Additional bank accounts (IBAN), separated by a comma and a space. Example: BE71096111112222, BE62310033334444\",\n\t\"active\": \"(boolean) Whether the supplier is active. Example: true\",\n\t\"invoiceApprovalCategory\": \"(string) Approval category for invoices of this supplier. Example: STANDARD\",\n\t\"defaultEmailAddress\": \"(string) Default e-mail address. Example: ar@soluz.example\",\n\t\"mobile\": \"(string) Mobile phone number. Example: +32476123456\",\n\t\"website\": \"(string) Website. Example: https://www.soluz.example\",\n\t\"extraCode1\": \"(string) Free field 1 for your own codes. Example: CODE1\",\n\t\"extraCode2\": \"(string) Free field 2 for your own codes. Example: CODE2\",\n\t\"extraCode3\": \"(string) Free field 3 for your own codes. Example: CODE3\",\n\t\"extraCode4\": \"(string) Free field 4 for your own codes. Example: CODE4\",\n\t\"extraCode5\": \"(string) Free field 5 for your own codes. Example: CODE5\",\n\t\"defaultAddress\": {\n\t\t\"addressee\": \"(string) Addressee (name on the address). Example: Soluz.io\",\n\t\t\"street\": \"(string) Street. Example: Zwartzustersvest\",\n\t\t\"number\": \"(string) House number. Example: 24\",\n\t\t\"zip\": \"(string) Postal code. Example: 2800\",\n\t\t\"city\": \"(string) City. Example: Mechelen\",\n\t\t\"country\": \"(string) Country name. Example: Belgium\",\n\t\t\"postBox\": \"(string) Post box, if any. Example: PB12\",\n\t\t\"state\": \"(string) State / province / region. Example: Antwerpen\"\n\t}\n}"},{"id":"5b6804a9-11a2-41d3-a51c-35337333e027","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//masterdata/companies/:partyId/suppliers/:id","host":["https://api.soluz.io/"],"path":["masterdata","companies",":partyId","suppliers",":id"],"variable":[{"key":"partyId","value":"1908","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"string","description":"The ID of the supplier, as given when it was uploaded."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"message\": \"string\"\n}"},{"id":"a87ca52c-b12d-4f87-94d0-cde02202fee7","name":"NotFound","originalRequest":{"method":"GET","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//masterdata/companies/:partyId/suppliers/:id","host":["https://api.soluz.io/"],"path":["masterdata","companies",":partyId","suppliers",":id"],"variable":[{"key":"partyId","value":"1908","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"string","description":"The ID of the supplier, as given when it was uploaded."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"statusCode\": 6767,\n\t\"message\": \"string\"\n}"}],"_postman_id":"0a1568e5-ea95-4c23-a84c-64d2eae13754"},{"name":"Delete supplier","id":"1e3f0d9f-1067-45b8-8c35-78dfd5641dd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"x-api-key
\n","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//masterdata/companies/:partyId/suppliers/:id","description":"Deletes a single supplier by its ID.
\nUsage
\nid is the ID you gave the supplier when you uploaded it.Responses
\n200 OK: the message \"The contact was deleted\".404 Not Found: unknown PartyId or supplier.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
The ID of the supplier, as given when it was uploaded.
\n","type":"text/plain"},"type":"any","value":"string","key":"id"}]}},"response":[{"id":"2b394a14-61ac-4878-9fe7-a2112c634a3f","name":"OK","originalRequest":{"method":"DELETE","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//masterdata/companies/:partyId/suppliers/:id","host":["https://api.soluz.io/"],"path":["masterdata","companies",":partyId","suppliers",":id"],"variable":[{"key":"partyId","value":"1908","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"string","description":"The ID of the supplier, as given when it was uploaded."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"string"},{"id":"00166704-0945-4b92-a27b-a53bba56e14e","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//masterdata/companies/:partyId/suppliers/:id","host":["https://api.soluz.io/"],"path":["masterdata","companies",":partyId","suppliers",":id"],"variable":[{"key":"partyId","value":"1908","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"string","description":"The ID of the supplier, as given when it was uploaded."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"message\": \"string\"\n}"},{"id":"0945dae0-295c-42ce-baa2-b282020dff22","name":"NotFound","originalRequest":{"method":"DELETE","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//masterdata/companies/:partyId/suppliers/:id","host":["https://api.soluz.io/"],"path":["masterdata","companies",":partyId","suppliers",":id"],"variable":[{"key":"partyId","value":"1908","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"string","description":"The ID of the supplier, as given when it was uploaded."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"statusCode\": 6767,\n\t\"message\": \"string\"\n}"}],"_postman_id":"1e3f0d9f-1067-45b8-8c35-78dfd5641dd0"},{"name":"Add or update a supplier","id":"1cb35206-43b4-4208-b17b-5d3ea9c2b693","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"x-api-key
\n","key":"Authorization","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"id\": \"(required)(string, max 255) Unique ID of the supplier, chosen by you. Use it to get, update or delete the supplier. Example: SOL-SU-0001\",\n\t\"name\": \"(string, max 255) Legal or display name. Example: Soluz.io\",\n\t\"language\": \"(string) ISO 639 language code (2 or 3 letters). Example: EN\",\n\t\"countryCode\": \"(string) ISO 3166 country code (2 or 3 letters). Example: BE\",\n\t\"vatNumber\": \"(string, max 100) VAT number. Example: BE0123456789\",\n\t\"companyNumber\": \"(string, max 100) Company number: CBE/KBO number for BE, SIRET number for FR. Example: 0123456789\",\n\t\"glnNumber\": \"(string, max 100) GLN number (13 digits). Example: 5412345000013\",\n\t\"source\": \"(string, max 100) Source of the contact information. Example: Vendor Onboarding\",\n\t\"financialAccountID\": \"(string, max 100) Bank account (IBAN). Example: BE68539007547034\",\n\t\"alternativeFinancialAccountIDs\": \"(string, max 250) Additional bank accounts (IBAN), separated by a comma and a space. Example: BE71096111112222, BE62310033334444\",\n\t\"active\": \"(boolean) Whether the supplier is active. Example: true\",\n\t\"invoiceApprovalCategory\": \"(string, max 100) Approval category for invoices of this supplier. Example: STANDARD\",\n\t\"defaultEmailAddress\": \"(string, max 200) Default e-mail address. Example: ar@soluz.example\",\n\t\"mobile\": \"(string, max 30) Mobile phone number. Example: +32476123456\",\n\t\"website\": \"(string, max 200) Website. Example: https://www.soluz.example\",\n\t\"extraCode1\": \"(string, max 1000) Free field 1 for your own codes. Example: CODE1\",\n\t\"extraCode2\": \"(string, max 1000) Free field 2 for your own codes. Example: CODE2\",\n\t\"extraCode3\": \"(string, max 1000) Free field 3 for your own codes. Example: CODE3\",\n\t\"extraCode4\": \"(string, max 1000) Free field 4 for your own codes. Example: CODE4\",\n\t\"extraCode5\": \"(string, max 1000) Free field 5 for your own codes. Example: CODE5\",\n\t\"defaultAddress\": {\n\t\t\"addressee\": \"(string, max 200) Addressee (name on the address). Example: Soluz.io\",\n\t\t\"street\": \"(string, max 200) Street. Example: Zwartzustersvest\",\n\t\t\"number\": \"(string, max 30) House number. Example: 24\",\n\t\t\"zip\": \"(string, max 30) Postal code. Example: 2800\",\n\t\t\"city\": \"(string, max 100) City. Example: Mechelen\",\n\t\t\"country\": \"(string, max 50) Country name. Example: Belgium\",\n\t\t\"postBox\": \"(string, max 30) Post box, if any. Example: PB12\",\n\t\t\"state\": \"(string, max 50) State / province / region. Example: Antwerpen\"\n\t}\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.soluz.io//masterdata/companies/:partyId/suppliers","description":"Adds a supplier, or updates the existing supplier with the same id.
Usage
\nid is your own unique ID for the supplier. You use it later to get, update or delete the supplier.Responses
\n201 Created: the supplier was processed.400 Bad Request: the request is not valid.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
x-api-key
\n","key":"Authorization","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"(string) Name of the supplier (exact match). Example: Soluz.io\",\n\t\"language\": \"(string) ISO 639 language code (2 or 3 letters). Example: EN\",\n\t\"countryCode\": \"(string) ISO 3166 country code (2 or 3 letters). Example: BE\",\n\t\"source\": \"(string) Source of the contact information (exact match). Example: ERP\",\n\t\"vatNumber\": \"(string) VAT number (exact match). Example: BE0123456789\",\n\t\"companyNumber\": \"(string) Company number (exact match). Example: 0123456789\",\n\t\"glnNumber\": \"(string) GLN number (exact match). Example: 5412345000013\",\n\t\"status\": \"(number) 0 = All (default), 1 = Active, 2 = Inactive. Example: 1\",\n\t\"financialAccountID\": \"(string) Bank account (IBAN, exact match). Example: BE68539007547034\",\n\t\"invoiceApprovalCategory\": \"(string) Approval category (exact match). Example: STANDARD\",\n\t\"page\": {\n\t\t\"page-number\": \"(required)(number) Page to return, starting at 1. Example: 1\",\n\t\t\"records-per-page\": \"(required)(number) Records per page. Default 20, maximum 100. Example: 20\"\n\t}\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.soluz.io//masterdata/companies/:partyId/suppliers/search","description":"Searches the suppliers of the company and returns one page of results.
\nUsage
\nstatus: 0 = all (default), 1 = active only, 2 = inactive only.page: page-number starts at 1. records-per-page defaults to 20 and is capped at 100. Use totalPages in the response to fetch the next pages.Responses
\n200 OK: the current page, the number of totalPages and the matching suppliers.400 Bad Request: the request is not valid, for example a status other than 0, 1 or 2.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
x-api-key
\n","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//masterdata/companies/:partyId/customers/:id","description":"Returns a single customer by its ID.
\nUsage
\nid is the ID you gave the customer when you uploaded it.Responses
\n200 OK: the customer.404 Not Found: unknown PartyId or customer.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
The ID of the customer, as given when it was uploaded.
\n","type":"text/plain"},"type":"any","value":"string","key":"id"}]}},"response":[{"id":"1b5cb4e1-a0cb-4ae9-b627-f036329dcc21","name":"OK","originalRequest":{"method":"GET","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//masterdata/companies/:partyId/customers/:id","host":["https://api.soluz.io/"],"path":["masterdata","companies",":partyId","customers",":id"],"variable":[{"key":"partyId","value":"1908","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"string","description":"The ID of the customer, as given when it was uploaded."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"id\": \"(string) Unique ID of the customer, chosen by you. Use it to get, update or delete the customer. Example: SOL-CU-0001\",\n\t\"name\": \"(string) Legal or display name. Example: Soluz.io\",\n\t\"language\": \"(string) ISO 639 language code (2 or 3 letters). Example: EN\",\n\t\"countryCode\": \"(string) ISO 3166 country code (2 or 3 letters). Example: BE\",\n\t\"defaultChannel\": \"(string) Delivery channel for the INVOICES document group. Ignored when channels is filled. Example: PEPPOL\",\n\t\"vatNumber\": \"(string) VAT number. Example: BE0123456789\",\n\t\"companyNumber\": \"(string) Company number: CBE/KBO number for BE, SIRET number for FR. Example: 0123456789\",\n\t\"glnNumber\": \"(string) GLN number (13 digits). Example: 5412345000013\",\n\t\"source\": \"(string) Source of the contact information. Example: ERP\",\n\t\"sourceChannel\": \"(string) Source channel of the contact information. Example: CRM\",\n\t\"validateInvoices\": \"(boolean) Validate invoices for this customer before they are sent. Example: true\",\n\t\"active\": \"(boolean) Whether the customer is active. Example: true\",\n\t\"contractReference\": \"(string) Contract number / assignment code of the buyer. Example: CTR-2025-SOL-17\",\n\t\"contractIssueDate\": \"(string, date) Issue date of the contract / assignment of the buyer (YYYY-MM-DD). Example: 2025-01-15\",\n\t\"defaultEmailAddress\": \"(string) Default e-mail address. Example: billing@soluz.example\",\n\t\"channels\": [\n\t\t{\n\t\t\t\"documentGroup\": \"(string) Document group the channel applies to. Example: INVOICES\",\n\t\t\t\"channel\": \"(string) Delivery channel for this document group. Example: PEPPOL\",\n\t\t\t\"target\": \"(string) Optional target within the channel. A channel set through defaultChannel gets the target Default. Example: Default\"\n\t\t}\n\t],\n\t\"mobile\": \"(string) Mobile phone number. Example: +32470111222\",\n\t\"website\": \"(string) Website. Example: https://www.soluz.example\",\n\t\"extraCode1\": \"(string) Free field 1 for your own codes. Example: CODE1\",\n\t\"extraCode2\": \"(string) Free field 2 for your own codes. Example: CODE2\",\n\t\"extraCode3\": \"(string) Free field 3 for your own codes. Example: CODE3\",\n\t\"extraCode4\": \"(string) Free field 4 for your own codes. Example: CODE4\",\n\t\"extraCode5\": \"(string) Free field 5 for your own codes. Example: CODE5\",\n\t\"defaultAddress\": {\n\t\t\"addressee\": \"(string) Addressee (name on the address). Example: Soluz.io\",\n\t\t\"street\": \"(string) Street. Example: Zwartzustersvest\",\n\t\t\"number\": \"(string) House number. Example: 24\",\n\t\t\"zip\": \"(string) Postal code. Example: 2800\",\n\t\t\"city\": \"(string) City. Example: Mechelen\",\n\t\t\"country\": \"(string) Country name. Example: Belgium\",\n\t\t\"postBox\": \"(string) Post box, if any. Example: PB12\",\n\t\t\"state\": \"(string) State / province / region. Example: Antwerpen\"\n\t},\n\t\"endpointId\": \"(string) EndpointID used in UBL as the identification number of the receiver. Example: 0123456789\",\n\t\"endpointSchemeId\": \"(string) Scheme of the Endpoint ID. Example: 0208\",\n\t\"esAccountingUnit\": \"(Spain)(string) Accounting office (Oficina Contable, FacturaE), a DIR3 code. Example: LA0003446\",\n\t\"esManagingUnit\": \"(Spain)(string) Managing body (Órgano Gestor, FacturaE), a DIR3 code. Example: GE0001450\",\n\t\"esClientName\": \"(Spain)(string) Proposing agency (Órgano Proponente, FacturaE). Example: GE0001453\",\n\t\"esProcessingUnit\": \"(Spain)(string) Processing unit (Unidad Tramitadora, FacturaE), a DIR3 code. Example: GE0001464\",\n\t\"itDestinationCode\": \"(Italy)(string) Recipient code (Codice Destinatario, FatturaPA). Example: A1B2C3D\",\n\t\"itClerkCode\": \"(Italy)(string) Order / agreement code (Codice Commessa, FatturaPA). Example: COMM-0042\",\n\t\"frServiceCode\": \"(France)(string) Chorus Pro service code. Example: SRV-789\",\n\t\"frServiceCodeName\": \"(France)(string) Chorus Pro service code name. Example: Direction Achats\"\n}"},{"id":"9a86be96-a678-42ce-a138-90f0bc5494fb","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//masterdata/companies/:partyId/customers/:id","host":["https://api.soluz.io/"],"path":["masterdata","companies",":partyId","customers",":id"],"variable":[{"key":"partyId","value":"1908","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"string","description":"The ID of the customer, as given when it was uploaded."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"message\": \"string\"\n}"},{"id":"82f62540-9903-4672-b209-1ba16c3d0a67","name":"NotFound","originalRequest":{"method":"GET","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//masterdata/companies/:partyId/customers/:id","host":["https://api.soluz.io/"],"path":["masterdata","companies",":partyId","customers",":id"],"variable":[{"key":"partyId","value":"1908","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"string","description":"The ID of the customer, as given when it was uploaded."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"statusCode\": 6767,\n\t\"message\": \"string\"\n}"}],"_postman_id":"2c968177-2988-42c7-9fc5-80681776c81d"},{"name":"Delete customer","id":"9ae3d646-cdf4-432d-b7ba-1c305174f80b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"x-api-key
\n","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":"https://api.soluz.io//masterdata/companies/:partyId/customers/:id","description":"Deletes a single customer by its ID.
\nUsage
\nid is the ID you gave the customer when you uploaded it.Responses
\n200 OK: the message \"The contact was deleted\".404 Not Found: unknown PartyId or customer.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
The ID of the customer, as given when it was uploaded.
\n","type":"text/plain"},"type":"any","value":"string","key":"id"}]}},"response":[{"id":"5b5c2302-39a4-4783-8e9c-37763952cc5c","name":"OK","originalRequest":{"method":"DELETE","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//masterdata/companies/:partyId/customers/:id","host":["https://api.soluz.io/"],"path":["masterdata","companies",":partyId","customers",":id"],"variable":[{"key":"partyId","value":"1908","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"string","description":"The ID of the customer, as given when it was uploaded."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"string"},{"id":"6bda5120-a78f-4aff-b275-3aa5d0ce360d","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//masterdata/companies/:partyId/customers/:id","host":["https://api.soluz.io/"],"path":["masterdata","companies",":partyId","customers",":id"],"variable":[{"key":"partyId","value":"1908","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"string","description":"The ID of the customer, as given when it was uploaded."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"message\": \"string\"\n}"},{"id":"7403a4c8-3b95-4b8f-a62b-8a188caae287","name":"NotFound","originalRequest":{"method":"DELETE","header":[{"description":"x-api-key","key":"Authorization","value":"string"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.soluz.io//masterdata/companies/:partyId/customers/:id","host":["https://api.soluz.io/"],"path":["masterdata","companies",":partyId","customers",":id"],"variable":[{"key":"partyId","value":"1908","description":"The PartyId of the company: the `id` returned by GET companies."},{"key":"id","value":"string","description":"The ID of the customer, as given when it was uploaded."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"statusCode\": 6767,\n\t\"message\": \"string\"\n}"}],"_postman_id":"9ae3d646-cdf4-432d-b7ba-1c305174f80b"},{"name":"Add or update a customer","id":"d6dfd967-216f-4395-a644-c9691345a309","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"x-api-key
\n","key":"Authorization","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"id\": \"(required)(string, max 255) Unique ID of the customer, chosen by you. Use it to get, update or delete the customer. Example: SOL-CU-0001\",\n\t\"name\": \"(string, max 255) Legal or display name. Example: Soluz.io\",\n\t\"language\": \"(string) ISO 639 language code (2 or 3 letters). Example: EN\",\n\t\"countryCode\": \"(string) ISO 3166 country code (2 or 3 letters). Example: BE\",\n\t\"defaultChannel\": \"(string, max 200) Delivery channel for the INVOICES document group. Ignored when channels is filled. Example: PEPPOL\",\n\t\"vatNumber\": \"(string, max 100) VAT number. Example: BE0123456789\",\n\t\"companyNumber\": \"(string, max 100) Company number: CBE/KBO number for BE, SIRET number for FR. Example: 0123456789\",\n\t\"glnNumber\": \"(string, max 100) GLN number (13 digits). Example: 5412345000013\",\n\t\"source\": \"(string, max 100) Source of the contact information. Example: ERP\",\n\t\"sourceChannel\": \"(string, max 100) Source channel of the contact information. Example: CRM\",\n\t\"validateInvoices\": \"(boolean) Validate invoices for this customer before they are sent. Example: true\",\n\t\"active\": \"(boolean) Whether the customer is active. Example: true\",\n\t\"contractReference\": \"(string, max 100) Contract number / assignment code of the buyer. Example: CTR-2025-SOL-17\",\n\t\"contractIssueDate\": \"(string, date) Issue date of the contract / assignment of the buyer (YYYY-MM-DD). Example: 2025-01-15\",\n\t\"defaultEmailAddress\": \"(string, max 200) Default e-mail address. Example: billing@soluz.example\",\n\t\"channels\": [\n\t\t{\n\t\t\t\"documentGroup\": \"(required)(string, max 200) Document group the channel applies to. Example: INVOICES\",\n\t\t\t\"channel\": \"(string, max 200) Delivery channel for this document group. Example: PEPPOL\",\n\t\t\t\"target\": \"(string, max 200) Optional target within the channel. A channel set through defaultChannel gets the target Default. Example: Default\"\n\t\t}\n\t],\n\t\"mobile\": \"(string, max 30) Mobile phone number. Example: +32470111222\",\n\t\"website\": \"(string, max 200) Website. Example: https://www.soluz.example\",\n\t\"extraCode1\": \"(string, max 1000) Free field 1 for your own codes. Example: CODE1\",\n\t\"extraCode2\": \"(string, max 1000) Free field 2 for your own codes. Example: CODE2\",\n\t\"extraCode3\": \"(string, max 1000) Free field 3 for your own codes. Example: CODE3\",\n\t\"extraCode4\": \"(string, max 1000) Free field 4 for your own codes. Example: CODE4\",\n\t\"extraCode5\": \"(string, max 1000) Free field 5 for your own codes. Example: CODE5\",\n\t\"defaultAddress\": {\n\t\t\"addressee\": \"(string, max 200) Addressee (name on the address). Example: Soluz.io\",\n\t\t\"street\": \"(string, max 200) Street. Example: Zwartzustersvest\",\n\t\t\"number\": \"(string, max 30) House number. Example: 24\",\n\t\t\"zip\": \"(string, max 30) Postal code. Example: 2800\",\n\t\t\"city\": \"(string, max 100) City. Example: Mechelen\",\n\t\t\"country\": \"(string, max 50) Country name. Example: Belgium\",\n\t\t\"postBox\": \"(string, max 30) Post box, if any. Example: PB12\",\n\t\t\"state\": \"(string, max 50) State / province / region. Example: Antwerpen\"\n\t},\n\t\"endpointId\": \"(string, max 50) EndpointID used in UBL as the identification number of the receiver. Example: 0123456789\",\n\t\"endpointSchemeId\": \"(string, max 50) Scheme of the Endpoint ID. Example: 0208\",\n\t\"esAccountingUnit\": \"(Spain)(string, max 200) Accounting office (Oficina Contable, FacturaE), a DIR3 code. Example: LA0003446\",\n\t\"esManagingUnit\": \"(Spain)(string, max 100) Managing body (Órgano Gestor, FacturaE), a DIR3 code. Example: GE0001450\",\n\t\"esClientName\": \"(Spain)(string, max 100) Proposing agency (Órgano Proponente, FacturaE). Example: GE0001453\",\n\t\"esProcessingUnit\": \"(Spain)(string, max 200) Processing unit (Unidad Tramitadora, FacturaE), a DIR3 code. Example: GE0001464\",\n\t\"itDestinationCode\": \"(Italy)(string, max 100) Recipient code (Codice Destinatario, FatturaPA). Example: A1B2C3D\",\n\t\"itClerkCode\": \"(Italy)(string, max 100) Order / agreement code (Codice Commessa, FatturaPA). Example: COMM-0042\",\n\t\"frServiceCode\": \"(France)(string, max 100) Chorus Pro service code. Example: SRV-789\",\n\t\"frServiceCodeName\": \"(France)(string, max 200) Chorus Pro service code name. Example: Direction Achats\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.soluz.io//masterdata/companies/:partyId/customers","description":"Adds a customer, or updates the existing customer with the same id.
Usage
\nid is your own unique ID for the customer. You use it later to get, update or delete the customer.channels is filled, defaultChannel is ignored. Otherwise defaultChannel is stored as the delivery channel for the INVOICES document group.contractIssueDate uses the format YYYY-MM-DD.Responses
\n201 Created: the customer was processed.400 Bad Request: the request is not valid.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
x-api-key
\n","key":"Authorization","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"(string) Name of the customer (exact match). Example: Soluz.io\",\n\t\"language\": \"(string) ISO 639 language code (2 or 3 letters). Example: EN\",\n\t\"countryCode\": \"(string) ISO 3166 country code (2 or 3 letters). Example: BE\",\n\t\"source\": \"(string) Source of the contact information (exact match). Example: ERP\",\n\t\"vatNumber\": \"(string) VAT number (exact match). Example: BE0123456789\",\n\t\"companyNumber\": \"(string) Company number (exact match). Example: 0123456789\",\n\t\"glnNumber\": \"(string) GLN number (exact match). Example: 5412345000013\",\n\t\"status\": \"(number) 0 = All (default), 1 = Active, 2 = Inactive. Example: 1\",\n\t\"page\": {\n\t\t\"page-number\": \"(required)(number) Page to return, starting at 1. Example: 1\",\n\t\t\"records-per-page\": \"(required)(number) Records per page. Default 20, maximum 100. Example: 20\"\n\t}\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.soluz.io//masterdata/companies/:partyId/customers/search","description":"Searches the customers of the company and returns one page of results.
\nUsage
\nstatus: 0 = all (default), 1 = active only, 2 = inactive only.page: page-number starts at 1. records-per-page defaults to 20 and is capped at 100. Use totalPages in the response to fetch the next pages.Responses
\n200 OK: the current page, the number of totalPages and the matching customers.400 Bad Request: the request is not valid, for example a status other than 0, 1 or 2.404 Not Found: unknown PartyId.401 Unauthorized: the API key is missing or not valid.The PartyId of the company: the id returned by GET companies.
Generator: Widdershins v4.0.1
\nGET /companies
\n\nExample responses
\n
\n\n200 Response
\n
{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Companies\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Id\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n },\n \"Name\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n }\n }\n }\n}\n\nThis operation does not require authentication
\nGET /companies/{partyId}
\n\nExample responses
\n
\n\n200 Response
\n
{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Id\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n },\n \"Name\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n}\n\nThis operation does not require authentication
\nGET /companies/{partyId}/contacts/{id}
\n\nExample responses
\n
\n\n200 Response
\n
{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"Id\"\n ],\n \"properties\": {\n \"Id\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"Name\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Type\": {\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n },\n \"Types\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n }\n },\n \"Language\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"CountryCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultChannel\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"VATNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"CompanyNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"GlnNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Source\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"SourceChannel\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FinancialAccountID\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ValidateInvoices\": {\n \"type\": \"boolean\",\n \"nullable\": true\n },\n \"Active\": {\n \"type\": \"boolean\",\n \"nullable\": true\n },\n \"ContractReference\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ContractIssueDate\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"InvoiceApprovalCategory\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultEmailAddress\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultAddress\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Addressee\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Street\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Number\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Zip\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"City\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Country\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"PostBox\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"State\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"IdentificationNumbers\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Key\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Value\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n }\n },\n \"ESAccountingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESManagingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESClientName\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESProcessingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ITDestinationCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FRServiceCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FRServiceCodeName\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n}\n\nThis operation does not require authentication
\nDELETE /companies/{partyId}/contacts/{id}
\n\nExample responses
\n
\n\n200 Response
\n
\n\n401 Response
\n
{\n \"allOf\": [\n {\n \"type\": \"object\",\n \"additionalProperties\": {}\n },\n {\n \"type\": \"object\",\n \"description\": \"Defines a serializable container for storing error information. This information is stored as key/value pairs. The dictionary keys to look up standard error information are available on the HttpErrorKeys type.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Message\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets the high-level, user-visible message explaining the cause of the error. Information carried in this field should be considered public in that it will go over the wire regardless of the IncludeErrorDetailPolicy. As a result care should be taken not to disclose sensitive information about the server or the application.\",\n \"nullable\": true\n },\n \"ModelState\": \"[Circular]\",\n \"MessageDetail\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets a detailed description of the error intended for the developer to understand exactly what failed.\",\n \"nullable\": true\n },\n \"ExceptionMessage\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets the message of the Exception if available.\",\n \"nullable\": true\n },\n \"ExceptionType\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets the type of the Exception if available.\",\n \"nullable\": true\n },\n \"StackTrace\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets the stack trace information associated with this instance if available.\",\n \"nullable\": true\n },\n \"InnerException\": \"[Circular]\"\n }\n }\n ]\n}\n\nThis operation does not require authentication
\nPOST /companies/{partyId}/contacts/upload
\n\nBody parameter
\n
{\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"Id\"\n ],\n \"properties\": {\n \"Id\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"Name\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Type\": {\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n },\n \"Types\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n }\n },\n \"Language\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"CountryCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultChannel\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"VATNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"CompanyNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"GlnNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Source\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"SourceChannel\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FinancialAccountID\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ValidateInvoices\": {\n \"type\": \"boolean\",\n \"nullable\": true\n },\n \"Active\": {\n \"type\": \"boolean\",\n \"nullable\": true\n },\n \"ContractReference\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ContractIssueDate\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"InvoiceApprovalCategory\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultEmailAddress\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultAddress\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Addressee\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Street\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Number\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Zip\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"City\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Country\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"PostBox\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"State\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"IdentificationNumbers\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Key\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Value\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n }\n },\n \"ESAccountingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESManagingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESClientName\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESProcessingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ITDestinationCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FRServiceCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FRServiceCodeName\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n }\n}\n\n\n\nExample responses
\n
\n\n201 Response
\n
{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"ItemsProcessed\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n },\n \"ItemsFailed\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n }\n }\n}\n\nThis operation does not require authentication
\nPOST /companies/{partyId}/contacts
\n\nBody parameter
\n
{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"Id\"\n ],\n \"properties\": {\n \"Id\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"Name\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Type\": {\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n },\n \"Types\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n }\n },\n \"Language\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"CountryCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultChannel\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"VATNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"CompanyNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"GlnNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Source\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"SourceChannel\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FinancialAccountID\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ValidateInvoices\": {\n \"type\": \"boolean\",\n \"nullable\": true\n },\n \"Active\": {\n \"type\": \"boolean\",\n \"nullable\": true\n },\n \"ContractReference\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ContractIssueDate\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"InvoiceApprovalCategory\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultEmailAddress\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultAddress\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Addressee\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Street\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Number\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Zip\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"City\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Country\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"PostBox\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"State\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"IdentificationNumbers\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Key\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Value\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n }\n },\n \"ESAccountingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESManagingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESClientName\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESProcessingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ITDestinationCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FRServiceCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FRServiceCodeName\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n}\n\n\n\nExample responses
\n
\n\n201 Response
\n
{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"ItemsProcessed\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n },\n \"ItemsFailed\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n }\n }\n}\n\nThis operation does not require authentication
\nGET /companies/{partyId}/suppliers/{id}
\n\nExample responses
\n
\n\n200 Response
\n
{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"Id\"\n ],\n \"properties\": {\n \"Id\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"Name\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Type\": {\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n },\n \"Types\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n }\n },\n \"Language\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"CountryCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultChannel\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"VATNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"CompanyNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"GlnNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Source\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"SourceChannel\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FinancialAccountID\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ValidateInvoices\": {\n \"type\": \"boolean\",\n \"nullable\": true\n },\n \"Active\": {\n \"type\": \"boolean\",\n \"nullable\": true\n },\n \"ContractReference\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ContractIssueDate\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"InvoiceApprovalCategory\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultEmailAddress\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultAddress\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Addressee\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Street\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Number\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Zip\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"City\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Country\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"PostBox\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"State\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"IdentificationNumbers\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Key\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Value\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n }\n },\n \"ESAccountingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESManagingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESClientName\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESProcessingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ITDestinationCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FRServiceCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FRServiceCodeName\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n}\n\nThis operation does not require authentication
\nDELETE /companies/{partyId}/suppliers/{id}
\n\nExample responses
\n
\n\n200 Response
\n
\n\n401 Response
\n
{\n \"allOf\": [\n {\n \"type\": \"object\",\n \"additionalProperties\": {}\n },\n {\n \"type\": \"object\",\n \"description\": \"Defines a serializable container for storing error information. This information is stored as key/value pairs. The dictionary keys to look up standard error information are available on the HttpErrorKeys type.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Message\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets the high-level, user-visible message explaining the cause of the error. Information carried in this field should be considered public in that it will go over the wire regardless of the IncludeErrorDetailPolicy. As a result care should be taken not to disclose sensitive information about the server or the application.\",\n \"nullable\": true\n },\n \"ModelState\": \"[Circular]\",\n \"MessageDetail\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets a detailed description of the error intended for the developer to understand exactly what failed.\",\n \"nullable\": true\n },\n \"ExceptionMessage\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets the message of the Exception if available.\",\n \"nullable\": true\n },\n \"ExceptionType\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets the type of the Exception if available.\",\n \"nullable\": true\n },\n \"StackTrace\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets the stack trace information associated with this instance if available.\",\n \"nullable\": true\n },\n \"InnerException\": \"[Circular]\"\n }\n }\n ]\n}\n\nThis operation does not require authentication
\nPOST /companies/{partyId}/suppliers/upload
\n\nBody parameter
\n
{\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"Id\"\n ],\n \"properties\": {\n \"Id\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"Name\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Type\": {\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n },\n \"Types\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n }\n },\n \"Language\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"CountryCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultChannel\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"VATNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"CompanyNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"GlnNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Source\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"SourceChannel\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FinancialAccountID\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ValidateInvoices\": {\n \"type\": \"boolean\",\n \"nullable\": true\n },\n \"Active\": {\n \"type\": \"boolean\",\n \"nullable\": true\n },\n \"ContractReference\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ContractIssueDate\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"InvoiceApprovalCategory\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultEmailAddress\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultAddress\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Addressee\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Street\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Number\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Zip\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"City\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Country\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"PostBox\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"State\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"IdentificationNumbers\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Key\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Value\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n }\n },\n \"ESAccountingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESManagingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESClientName\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESProcessingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ITDestinationCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FRServiceCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FRServiceCodeName\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n }\n}\n\n\n\nExample responses
\n
\n\n201 Response
\n
{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"ItemsProcessed\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n },\n \"ItemsFailed\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n }\n }\n}\n\nThis operation does not require authentication
\nPOST /companies/{partyId}/suppliers
\n\nBody parameter
\n
{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"Id\"\n ],\n \"properties\": {\n \"Id\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"Name\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Type\": {\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n },\n \"Types\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n }\n },\n \"Language\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"CountryCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultChannel\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"VATNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"CompanyNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"GlnNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Source\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"SourceChannel\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FinancialAccountID\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ValidateInvoices\": {\n \"type\": \"boolean\",\n \"nullable\": true\n },\n \"Active\": {\n \"type\": \"boolean\",\n \"nullable\": true\n },\n \"ContractReference\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ContractIssueDate\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"InvoiceApprovalCategory\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultEmailAddress\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultAddress\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Addressee\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Street\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Number\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Zip\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"City\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Country\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"PostBox\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"State\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"IdentificationNumbers\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Key\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Value\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n }\n },\n \"ESAccountingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESManagingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESClientName\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESProcessingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ITDestinationCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FRServiceCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FRServiceCodeName\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n}\n\n\n\nExample responses
\n
\n\n201 Response
\n
{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"ItemsProcessed\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n },\n \"ItemsFailed\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n }\n }\n}\n\nThis operation does not require authentication
\nGET /companies/{partyId}/customers/{id}
\n\nExample responses
\n
\n\n200 Response
\n
{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"Id\"\n ],\n \"properties\": {\n \"Id\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"Name\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Type\": {\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n },\n \"Types\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n }\n },\n \"Language\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"CountryCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultChannel\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"VATNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"CompanyNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"GlnNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Source\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"SourceChannel\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FinancialAccountID\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ValidateInvoices\": {\n \"type\": \"boolean\",\n \"nullable\": true\n },\n \"Active\": {\n \"type\": \"boolean\",\n \"nullable\": true\n },\n \"ContractReference\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ContractIssueDate\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"InvoiceApprovalCategory\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultEmailAddress\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultAddress\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Addressee\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Street\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Number\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Zip\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"City\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Country\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"PostBox\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"State\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"IdentificationNumbers\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Key\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Value\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n }\n },\n \"ESAccountingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESManagingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESClientName\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESProcessingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ITDestinationCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FRServiceCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FRServiceCodeName\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n}\n\nThis operation does not require authentication
\nDELETE /companies/{partyId}/customers/{id}
\n\nExample responses
\n
\n\n200 Response
\n
\n\n401 Response
\n
{\n \"allOf\": [\n {\n \"type\": \"object\",\n \"additionalProperties\": {}\n },\n {\n \"type\": \"object\",\n \"description\": \"Defines a serializable container for storing error information. This information is stored as key/value pairs. The dictionary keys to look up standard error information are available on the HttpErrorKeys type.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Message\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets the high-level, user-visible message explaining the cause of the error. Information carried in this field should be considered public in that it will go over the wire regardless of the IncludeErrorDetailPolicy. As a result care should be taken not to disclose sensitive information about the server or the application.\",\n \"nullable\": true\n },\n \"ModelState\": \"[Circular]\",\n \"MessageDetail\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets a detailed description of the error intended for the developer to understand exactly what failed.\",\n \"nullable\": true\n },\n \"ExceptionMessage\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets the message of the Exception if available.\",\n \"nullable\": true\n },\n \"ExceptionType\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets the type of the Exception if available.\",\n \"nullable\": true\n },\n \"StackTrace\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets the stack trace information associated with this instance if available.\",\n \"nullable\": true\n },\n \"InnerException\": \"[Circular]\"\n }\n }\n ]\n}\n\nThis operation does not require authentication
\nPOST /companies/{partyId}/customers/upload
\n\nBody parameter
\n
{\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"Id\"\n ],\n \"properties\": {\n \"Id\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"Name\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Type\": {\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n },\n \"Types\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n }\n },\n \"Language\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"CountryCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultChannel\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"VATNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"CompanyNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"GlnNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Source\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"SourceChannel\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FinancialAccountID\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ValidateInvoices\": {\n \"type\": \"boolean\",\n \"nullable\": true\n },\n \"Active\": {\n \"type\": \"boolean\",\n \"nullable\": true\n },\n \"ContractReference\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ContractIssueDate\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"InvoiceApprovalCategory\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultEmailAddress\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultAddress\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Addressee\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Street\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Number\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Zip\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"City\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Country\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"PostBox\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"State\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"IdentificationNumbers\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Key\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Value\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n }\n },\n \"ESAccountingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESManagingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESClientName\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESProcessingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ITDestinationCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FRServiceCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FRServiceCodeName\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n }\n}\n\n\n\nExample responses
\n
\n\n201 Response
\n
{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"ItemsProcessed\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n },\n \"ItemsFailed\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n }\n }\n}\n\nThis operation does not require authentication
\nPOST /companies/{partyId}/customers
\n\nBody parameter
\n
{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"Id\"\n ],\n \"properties\": {\n \"Id\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"Name\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Type\": {\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n },\n \"Types\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n }\n },\n \"Language\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"CountryCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultChannel\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"VATNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"CompanyNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"GlnNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Source\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"SourceChannel\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FinancialAccountID\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ValidateInvoices\": {\n \"type\": \"boolean\",\n \"nullable\": true\n },\n \"Active\": {\n \"type\": \"boolean\",\n \"nullable\": true\n },\n \"ContractReference\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ContractIssueDate\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"InvoiceApprovalCategory\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultEmailAddress\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultAddress\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Addressee\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Street\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Number\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Zip\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"City\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Country\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"PostBox\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"State\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"IdentificationNumbers\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Key\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Value\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n }\n },\n \"ESAccountingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESManagingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESClientName\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESProcessingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ITDestinationCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FRServiceCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FRServiceCodeName\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n}\n\n\n\nExample responses
\n
\n\n201 Response
\n
{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"ItemsProcessed\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n },\n \"ItemsFailed\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n }\n }\n}\n\nThis operation does not require authentication
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Companies\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Id\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n },\n \"Name\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n }\n }\n }\n}\n\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Id\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n },\n \"Name\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n}\n\nbackwards compatibility
\n\n\n\n\n{\n \"allOf\": [\n {\n \"type\": \"object\",\n \"additionalProperties\": {}\n },\n {\n \"type\": \"object\",\n \"description\": \"Defines a serializable container for storing error information. This information is stored as key/value pairs. The dictionary keys to look up standard error information are available on the HttpErrorKeys type.\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Message\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets the high-level, user-visible message explaining the cause of the error. Information carried in this field should be considered public in that it will go over the wire regardless of the IncludeErrorDetailPolicy. As a result care should be taken not to disclose sensitive information about the server or the application.\",\n \"nullable\": true\n },\n \"ModelState\": \"[Circular]\",\n \"MessageDetail\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets a detailed description of the error intended for the developer to understand exactly what failed.\",\n \"nullable\": true\n },\n \"ExceptionMessage\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets the message of the Exception if available.\",\n \"nullable\": true\n },\n \"ExceptionType\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets the type of the Exception if available.\",\n \"nullable\": true\n },\n \"StackTrace\": {\n \"type\": \"string\",\n \"description\": \"Gets or sets the stack trace information associated with this instance if available.\",\n \"nullable\": true\n },\n \"InnerException\": \"[Circular]\"\n }\n }\n ]\n}\n\nallOf
\nand
\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"required\": [\n \"Id\"\n ],\n \"properties\": {\n \"Id\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"Name\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Type\": {\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n },\n \"Types\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n }\n },\n \"Language\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"CountryCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultChannel\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"VATNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"CompanyNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"GlnNumber\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Source\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"SourceChannel\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FinancialAccountID\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ValidateInvoices\": {\n \"type\": \"boolean\",\n \"nullable\": true\n },\n \"Active\": {\n \"type\": \"boolean\",\n \"nullable\": true\n },\n \"ContractReference\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ContractIssueDate\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"InvoiceApprovalCategory\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultEmailAddress\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"DefaultAddress\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Addressee\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Street\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Number\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Zip\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"City\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Country\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"PostBox\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"State\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n },\n \"IdentificationNumbers\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Key\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Value\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n }\n },\n \"ESAccountingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESManagingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESClientName\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ESProcessingUnit\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"ITDestinationCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FRServiceCode\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"FRServiceCodeName\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n}\n\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"integer\",\n \"description\": \"\",\n \"x-enumNames\": [\n \"Undefined\",\n \"Customer\",\n \"Supplier\"\n ],\n \"enum\": [\n 0,\n 1,\n 2\n ]\n}\n\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Addressee\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Street\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Number\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Zip\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"City\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"Country\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"PostBox\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n },\n \"State\": {\n \"type\": \"string\",\n \"maxLength\": 2000,\n \"minLength\": 0,\n \"nullable\": true\n }\n }\n}\n\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Key\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"Value\": {\n \"type\": \"string\",\n \"nullable\": true\n }\n }\n}\n\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"ItemsProcessed\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n },\n \"ItemsFailed\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n }\n }\n}\n\nbackwards compatibility
\n\n\n\n\n{\n \"type\": \"object\",\n \"additionalProperties\": false\n}\n\nNone
\n","_postman_id":"0ac8d4ed-5d1c-4158-b259-fb34ca8079db"},{"name":"Examples","item":[{"name":"Outbound API","item":[{"name":"DEMO: Invoice cash discount","id":"948c8c49-6905-48a9-a6fe-f35bfdd2a20f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Add a PDF (image) or an XML (UBL) invoice file directly to the section of the Body.
\nPlease note that the file should not be added as a binary file as we only allow Body content-types application/json or multipart/form-data.\nAdditional attachments can also, optionally, be uploaded as multipart files.
\n","urlObject":{"path":["outbound","companies","{{partyid}}","invoices","multipart"],"host":["{{baseurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"877bc608-01f9-4bf4-975d-a7971d3d3b35"}],"id":"430d7962-1fbd-4286-9029-ae78229109fd","_postman_id":"430d7962-1fbd-4286-9029-ae78229109fd","description":""}],"id":"2cac3247-4865-40d6-a36d-8bdb65b7f198","description":"