{"openapi":"3.0.0","paths":{"/status":{"get":{"description":"Gets the status of the API","operationId":"AppController_getStatus","parameters":[],"responses":{"200":{"description":"The API is up and running.","content":{"text/plain":{"schema":{"type":"string","example":"The API is up and running."}}}}},"summary":"","tags":["App"]}},"/clients/deactivate-client-registration":{"post":{"description":"This call deactivates registration of the calling client.<br/><br/>Feedback needs to be received on registered webhook for event \"client.cancellation\", it is required to have this webhook registered before cancelling a subscription","operationId":"ClientController_deactivateClientRegistrationForClient","parameters":[],"responses":{"200":{"description":"Deactivation of client registration successfully initiated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCancellationResponseDto"}}}},"400":{"description":"No Webhook with event \"client.cancellation\" was registered for client","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}}},"summary":"Deactivates the registration for the calling client","tags":["clients"]}},"/client-counter":{"get":{"description":"Retrieves a list of ClientCounters indicating the amount of counted items for a given period for client","operationId":"ClientCounterController_getClientCounterForClientBetweenDates","parameters":[{"name":"fromDate","required":true,"in":"query","description":"The from date in ISO format, cannot be more than 365 days ago.","schema":{"format":"date-time","example":"2023-01-01","type":"string"}},{"name":"toDate","required":true,"in":"query","description":"The to date in ISO format, cannot be more than 365 days ago.","schema":{"format":"date-time","example":"2023-01-02","type":"string"}},{"name":"flow","required":false,"in":"query","description":"Optional flow filter for client counter data - if provided only counters that for given flow will be returned","schema":{"type":"string"}}],"responses":{"200":{"description":"List of client counters for specified date range","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClientCounterDto"}}}}},"400":{"description":"The provided request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}}},"summary":"Gets the client counters for client","tags":["client-counter"]}},"/webhooks":{"post":{"description":"Register a new webhook URL for a given list of events.<br/><br/>URL needs to be publicly accessible, accepting POST request and should return 200 OK immediatelty. Processing of the received data should happen asynchronously.  No data is expected in the response.<br/><br/>It is possible to register multiple webhooks for the same event, in that case all URLs will be called.  If no webhooks are registered for a given event, nothing will be called but processing will never be blocked.<br/><br/>A client can register a total of 10 webhooks","operationId":"WebhookController_createWebhook","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestDto"}}}},"responses":{"201":{"description":"The webhook has been registered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookResponseDto"}}}},"400":{"description":"The provided request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}}},"summary":"Register webhook","tags":["webhooks"]},"get":{"description":"Lists all registered webhooks.","operationId":"WebhookController_getWebhooks","parameters":[],"responses":{"200":{"description":"List of registered webhooks.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WebhookResponseDto"}}}}},"400":{"description":"The provided request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}}},"summary":"List webhooks","tags":["webhooks"]}},"/webhooks/{ulid}":{"delete":{"description":"Deregister a webhook based on its ulid and clientUlid.<br/><br/>","operationId":"WebhookController_deleteWebhook","parameters":[{"name":"ulid","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The webhook has been deregistered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteWebhookResponseDto"}}}},"400":{"description":"The provided request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}},"404":{"description":"No webhook found for provided ulid and clientUlid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}}},"summary":"Deregister webhook","tags":["webhooks"]}},"/webhooks/secretKey":{"post":{"description":"Generate a webhook secret as a client. In case you need a new key, rerun this operation to invalidate the previous key and regenerate a new one","operationId":"WebhookController_generateWebhookSecretForClient","parameters":[],"responses":{"201":{"description":"The webhook secret has been generated for the client.","content":{"text/plain":{"schema":{"type":"string","example":"your-webhook-secret-key"}}}},"400":{"description":"The provided request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}}},"summary":"Generate a webhook secret key","tags":["webhooks"]}},"/conversion-runs":{"post":{"description":"Initiates a new conversion run and returns pre-signed upload URLs.<br/><br/>A pre-signed URL will be returned to which the actual input can be uploaded with additional pre-signed URLs for each requested additional document. A PUT call should be made with the file as binary body.<br/><b>Important:</b> If you need to upload additional documents, do so <b>before</b> uploading the main file.<br/>Once the main file is uploaded to its pre-signed URL, the conversion starts and <b>no more files can be added</b>.<br/><br/>Upload using a <code>PUT</code> request with the file as binary body. Each URL is valid only <b>once</b>.<br/><br/>Feedback can be received on registered webhooks for event `conversion-run.processed`","operationId":"ConversionRunController_createConversionRun","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConversionRunRequestDto"}}}},"responses":{"201":{"description":"The conversion run has been created successfully, send the actual input via the provided presigned URL","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConversionRunResponseDto"}}}},"400":{"description":"The provided request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}}},"summary":"Create a conversion run","tags":["conversion-runs"]}},"/conversion-runs/{conversionRunUlid}/complete":{"post":{"description":"Conversion runs should be completed when results are received. When a document is completed all uploaded and created documents are removed from the conversion API.","operationId":"ConversionRunController_completeConversionRun","parameters":[{"name":"conversionRunUlid","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The conversion run has been completed","content":{"text/plain":{"schema":{"type":"string","example":"The conversion run has been completed"}}}},"400":{"description":"The provided request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}}},"summary":"Complete the conversion run","tags":["conversion-runs"]}}},"info":{"title":"Conversion API","description":"\n# Steps to take when you want to use the conversion API\n\n## Step 1: Register a Webhook\nFor efficient communication and to receive the results, you need to register at least one webhook for the `conversion-run.processed` event.\n## Step 2: Create a conversion run\nStart the conversion by creating a conversion run via the API with your chosen converter. On success, you receive:\n* a **presigned URL** to upload your document, and\n* a **ULID** identifying the conversion run (use this in any follow-up with the Dokapi team).\n## Step 2b: (optional): Add additional documents\nIf your conversion needs supporting files—such as attachments, source data, or supplementary metadata—you can request them when creating the conversion run.\n\n<b>Important:</b> The additional documents should always be uploaded <b>before</b> uploading the main document!\n* Maximum number of additional documents: **2**\n* Combined size of additional documents: **≤ 25 MB**\n## Step 3: Upload your main document to the presigned url\nUpload your main document to the provided presigned URL. After a successful upload, the conversion run automatically starts.\n## Step 4: Receive a webhook\nWhen processing finishes, we invoke your webhook. You can correlate the webhook to its conversion run via the **ULID** in the body (or via your own external reference, if provided).\n* Event body schema:  `ConversionRunProcessedFeedbackDto`.\n* The webhook payload includes presigned URLs to retrieve any resulting files.\n\n## Step 5: Download your resulting document\nIf the conversion run succeeded, download the resulting document using the presigned URL(s) provided in the webhook body.\n## Step 6: Complete your conversion run\nFinally when the webhook is handled and all documents are retrieved a conversion run should be completed. This will remove all documents related to the conversion run from our file system. Conversion runs can and should also be completed for failure responses!\n\n> **Retention:** Files in the Conversion API are retained for a maximum of **7 days**.\n\n# Converters\n## UBL_MAPPER_INVOICE\n\nCreates an Invoice UBL (`urn:oasis:names:specification:ubl:schema:xsd:Invoice-2`) from our invoice request domain model. Validity is best-effort; if needed, use the validation flow in the Peppol API.\n\nCommonly used to create **Peppol BIS Billing** and **Peppol BIS Self-Billing** invoices.\n\n- 📄 [Peppol BIS Billing 3.0 Documentation](https://docs.peppol.eu/poacc/billing/3.0/)\n- 📄 [Peppol BIS Self-Billing 3.0 Documentation](https://docs.peppol.eu/poacc/self-billing/3.0/)\n\n**Request schema:** `InvoiceRequestDto` (JSON). The combined size of this request and any additional documents must be **≤ 25 MB**.\n\n<details>\n<summary>Full example with optional fields below:</summary>\n\n```\n{\n  \"customizationID\": \"urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0\",\n  \"profileID\": \"urn:fdc:peppol.eu:2017:poacc:billing:01:1.0\",\n  \"invoiceID\": \"INV-123456\",\n  \"issueDate\": \"2025-03-01\",\n  \"dueDate\": \"2025-03-15\",\n  \"invoiceTypeCode\": \"380\",\n  \"currency\": \"EUR\",\n  \"taxPointDate\": \"2025-04-15\",\n  \"alternateTaxCurrency\": {\n    \"currencyCode\": \"USD\",\n    \"exchangeRate\": 1.16\n  },\n  \"accountingCost\": \"4217:2323:2323\",\n  \"orderReference\": {\n    \"id\": \"PO-789012\",\n    \"salesOrderID\": \"SO-456789\"\n  },\n  \"buyerReference\": \"a-buyer-reference\",\n  \"projectReference\": \"PROJECT-001\",\n  \"contractDocumentReference\": {\n    \"id\": \"CONTRACT-001\"\n  },\n  \"receiptDocumentReference\": {\n    \"id\": \"RECEIPT-001\"\n  },\n  \"despatchDocumentReference\": {\n    \"id\": \"DESPATCH-001\"\n  },\n  \"originatorDocumentReference\": {\n    \"id\": \"TENDER-001\"\n  },\n  \"billingReferences\": [\n    {\n      \"id\": \"INV-PRIOR-001\",\n      \"issueDate\": \"2025-01-15\"\n    }\n  ],\n  \"invoicePeriod\": {\n    \"startDate\": \"2025-01-31\",\n    \"endDate\": \"2025-12-31\",\n    \"descriptionCode\": \"35\"\n  },\n  \"notes\": [\n    \"A textual note that gives unstructured information that is relevant to the invoice as a whole\"\n  ],\n  \"payeeParty\": {\n    \"name\": \"Payee BV\",\n    \"legalEntity\": {\n      \"companyID\": \"0123456789\",\n      \"companySchemeID\": \"0208\"\n    },\n    \"partyIdentificationList\": [\n      {\n        \"schemeID\": \"0208\",\n        \"id\": \"0123456789\"\n      }\n    ]\n  },\n  \"taxRepresentativeParty\": {\n    \"name\": \"Tax Representative BV\",\n    \"vatNumber\": \"BE0999999999\",\n    \"postalAddress\": {\n      \"streetName\": \"Tax Rep Street 12\",\n      \"cityName\": \"Brussels\",\n      \"postalZone\": \"1000\",\n      \"countryIdentificationCode\": \"BE\"\n    }\n  },\n  \"supplier\": {\n    \"endpointID\": \"0123456789\",\n    \"endpointSchemeID\": \"0208\",\n    \"postalAddress\": {\n      \"streetName\": \"Main Street 1\",\n      \"cityName\": \"Brussels\",\n      \"postalZone\": \"1000\",\n      \"additionalStreetName\": \"Box 123\",\n      \"addressLine\": \"Building 3\",\n      \"countryIdentificationCode\": \"BE\"\n    },\n    \"vatNumber\": \"BE0123456789\",\n    \"name\": \"SUPPLIER COMPANY\",\n    \"email\": \"supplier@dokapi.io\",\n    \"telephone\": \"09 123 45 67\",\n    \"legalEntity\": {\n      \"registrationName\": \"SUPPLIER BV\",\n      \"languageID\": \"NL\",\n      \"companyID\": \"0123456789\",\n      \"companySchemeID\": \"0208\",\n      \"companyLegalForm\": \"Share capital\"\n    },\n    \"partyIdentificationList\": [\n      {\n        \"schemeID\": \"0208\",\n        \"id\": \"0123456789\"\n      }\n    ]\n  },\n  \"customer\": {\n    \"endpointID\": \"0987654321\",\n    \"endpointSchemeID\": \"0208\",\n    \"postalAddress\": {\n      \"streetName\": \"Customer Road 5\",\n      \"cityName\": \"Antwerp\",\n      \"postalZone\": \"2000\",\n      \"additionalStreetName\": \"Po Box 987\",\n      \"addressLine\": \"Floor 2\",\n      \"countryIdentificationCode\": \"BE\"\n    },\n    \"vatNumber\": \"BE0987654321\",\n    \"name\": \"CUSTOMER COMPANY\",\n    \"email\": \"customer@dokapi.io\",\n    \"telephone\": \"+32 499 12 34 56\",\n    \"legalEntity\": {\n      \"registrationName\": \"CUSTOMER\",\n      \"companyID\": \"0987654321\",\n      \"companySchemeID\": \"0208\"\n    },\n    \"partyIdentificationList\": [\n      {\n        \"schemeID\": \"0208\",\n        \"id\": \"0987654321\"\n      }\n    ]\n  },\n  \"billingLines\": [\n    {\n      \"invoicedQuantity\": 10,\n      \"unitCode\": \"C62\",\n      \"priceAmount\": 10,\n      \"accountingCost\": \"my-invoice-line-accounting-cost\",\n      \"documentReference\": {\n        \"id\": \"OBJECT-LINE-1\",\n        \"schemeID\": \"AHL\",\n        \"documentTypeCode\": \"130\"\n      },\n      \"invoicePeriod\": {\n        \"startDate\": \"2025-04-01\",\n        \"endDate\": \"2025-04-15\",\n        \"descriptionCode\": \"35\"\n      },\n      \"item\": {\n        \"name\": \"Product A\",\n        \"description\": \"Detailed product A description\",\n        \"sellersItemIdentification\": {\n          \"identification\": \"SELLER-SKU-A\"\n        },\n        \"buyersItemIdentification\": {\n          \"identification\": \"BUYER-SKU-A\"\n        },\n        \"originCountry\": \"BE\",\n        \"taxCategory\": {\n          \"taxCategoryID\": \"S\",\n          \"taxPercentage\": 21\n        },\n        \"commodityClassifications\": [\n          {\n            \"itemClassificationCode\": \"9873242\",\n            \"itemTypeIdentificationCode\": \"STI\"\n          }\n        ]\n      },\n      \"allowanceCharges\": [\n        {\n          \"chargeIndicator\": true,\n          \"amount\": 15,\n          \"allowanceChargeReasonCode\": \"DL\"\n        },\n        {\n          \"chargeIndicator\": false,\n          \"amount\": 10,\n          \"allowanceChargeReason\": \"discount\"\n        }\n      ]\n    },\n    {\n      \"invoicedQuantity\": 5,\n      \"unitCode\": \"C62\",\n      \"priceAmount\": 10,\n      \"item\": {\n        \"name\": \"Product B\",\n        \"taxCategory\": {\n          \"taxPercentage\": 21,\n          \"taxCategoryID\": \"S\"\n        }\n      },\n      \"note\": \"item note\",\n      \"orderLineReference\": \"orderLineReference\"\n    },\n    {\n      \"invoicedQuantity\": 15,\n      \"unitCode\": \"C62\",\n      \"priceAmount\": 15,\n      \"item\": {\n        \"name\": \"Product no tax\",\n        \"taxCategory\": {\n          \"taxPercentage\": 0,\n          \"taxCategoryID\": \"AE\"\n        }\n      }\n    },\n    {\n      \"invoicedQuantity\": 1,\n      \"unitCode\": \"C62\",\n      \"priceAmount\": 1,\n      \"item\": {\n        \"name\": \"Product addition info\",\n        \"taxCategory\": {\n          \"taxPercentage\": 0,\n          \"taxCategoryID\": \"AE\"\n        },\n        \"additionalItemProperties\": [\n          {\n            \"name\": \"additional-property\",\n            \"value\": \"value\"\n          }\n        ],\n        \"standardItemIdentification\": {\n          \"scheme\": \"0160\",\n          \"identification\": \"item-identification\"\n        }\n      }\n    }\n  ],\n  \"monetaryTotal\": {\n    \"prepaidAmount\": 20,\n    \"payableAmount\": 2000\n  },\n  \"paymentMeans\": [\n    {\n      \"paymentMeansCode\": \"58\",\n      \"paymentMeansName\": \"SEPA credit transfer\",\n      \"paymentID\": \"PM-12345\",\n      \"financialAccount\": {\n        \"id\": \"BE99999999999999\",\n        \"name\": \"Supplier Main Account\",\n        \"financialInstitutionBranch\": {\n          \"id\": \"XXXXXXXX\"\n        }\n      },\n      \"cardAccount\": {\n        \"primaryAccountNumberID\": \"4111111111111111\",\n        \"holderName\": \"Card Holder Name\"\n      },\n      \"paymentMandate\": {\n        \"id\": \"MANDATE-001\",\n        \"payerFinancialAccount\": {\n          \"id\": \"BE99999999999999\",\n          \"financialInstitutionBranch\": {\n            \"id\": \"XXXXXXXX\"\n          }\n        }\n      }\n    }\n  ],\n  \"paymentTerms\": {\n    \"note\": \"Net within 30 days\"\n  },\n  \"allowanceCharges\": [\n    {\n      \"chargeIndicator\": true,\n      \"amount\": 200,\n      \"allowanceChargeReasonCode\": \"DL\",\n      \"taxCategory\": {\n        \"taxPercentage\": 25,\n        \"taxCategoryID\": \"S\"\n      }\n    },\n    {\n      \"chargeIndicator\": false,\n      \"amount\": 100,\n      \"allowanceChargeReason\": \"discount\",\n      \"taxCategory\": {\n        \"taxPercentage\": 10,\n        \"taxCategoryID\": \"S\"\n      }\n    }\n  ],\n  \"taxSubtotals\": [\n    {\n      \"taxCategory\": {\n        \"taxPercentage\": 0,\n        \"taxCategoryID\": \"AE\"\n      },\n      \"taxExemptionReason\": \"custom tax exemption reason\",\n      \"taxExemptionReasonCode\": \"custom tax exemption reason code for AE\"\n    }\n  ],\n  \"delivery\": {\n    \"actualDeliveryDate\": \"2025-03-31\",\n    \"deliveryLocation\": {\n      \"id\": \"location-id\",\n      \"postalAddress\": {\n        \"streetName\": \"Customer Road 5\",\n        \"cityName\": \"Antwerp\",\n        \"postalZone\": \"2000\",\n        \"addressLine\": \"Dock 7\",\n        \"countryIdentificationCode\": \"BE\"\n      }\n    },\n    \"deliveryParty\": {\n      \"name\": \"delivery party name\"\n    }\n  },\n  \"additionalDocuments\": [\n    {\n      \"id\": \"doc-001\",\n      \"filename\": \"invoice-attachment.pdf\",\n      \"mimeCode\": \"application/pdf\",\n      \"documentDescription\": \"Signed invoice note PDF\",\n      \"content\": \"RW5jb2RlZCBjb250ZW50IGV4YW1wbGUgZm9yIERva2FwaSBDb252ZXJzaW9uCg==\"\n    },\n    {\n      \"filename\": \"invoice-details.csv\",\n      \"mimeCode\": \"text/csv\",\n      \"documentDescription\": \"Detailed csv billing lines\"\n    },\n    {\n      \"id\": \"external-document\",\n      \"documentDescription\": \"A reference to an external document\",\n      \"externalReferenceURI\": \"https://example.com/attachments/timesheet-2025-04.pdf\"\n    }\n  ]\n}\n```\n</details>\n\n\n## UBL_MAPPER_CREDIT_NOTE\n\nCreates a Credit Note UBL (`urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2`) from our credit note request domain model. Validity is best-effort; if needed, use the validation flow in the Peppol API.\n\nCommonly used to create **Peppol BIS Billing** and **Peppol BIS Self-Billing** credit notes.\n\n- 📄 [Peppol BIS Billing 3.0 Documentation](https://docs.peppol.eu/poacc/billing/3.0/)\n- 📄 [Peppol BIS Self-Billing 3.0 Documentation](https://docs.peppol.eu/poacc/self-billing/3.0/)\n\n**Request schema:** `CreditNoteRequestDto` (JSON). The combined size of this request and any additional documents must be **≤ 25 MB**.\n\n<details>\n<summary>Full example with optional fields below:</summary>\n\n```\n{\n  \"customizationID\": \"urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0\",\n  \"profileID\": \"urn:fdc:peppol.eu:2017:poacc:billing:01:1.0\",\n  \"creditNoteID\": \"CRD-123456\",\n  \"issueDate\": \"2025-03-01\",\n  \"creditNoteTypeCode\": \"381\",\n  \"currency\": \"EUR\",\n  \"taxPointDate\": \"2025-04-15\",\n  \"alternateTaxCurrency\": {\n    \"currencyCode\": \"USD\",\n    \"exchangeRate\": 1.16\n  },\n  \"accountingCost\": \"4217:2323:2323\",\n  \"orderReference\": {\n    \"id\": \"PO-789012\",\n    \"salesOrderID\": \"SO-456789\"\n  },\n  \"buyerReference\": \"my-buyer-reference\",\n  \"contractDocumentReference\": {\n    \"id\": \"CONTRACT-001\"\n  },\n  \"receiptDocumentReference\": {\n    \"id\": \"RECEIPT-001\"\n  },\n  \"despatchDocumentReference\": {\n    \"id\": \"DESPATCH-001\"\n  },\n  \"originatorDocumentReference\": {\n    \"id\": \"TENDER-001\"\n  },\n  \"billingReferences\": [\n    {\n      \"id\": \"INV-PRIOR-001\",\n      \"issueDate\": \"2025-01-15\"\n    }\n  ],\n  \"invoicePeriod\": {\n    \"startDate\": \"2025-01-31\",\n    \"endDate\": \"2025-12-31\",\n    \"descriptionCode\": \"35\"\n  },\n  \"notes\": [\n    \"A textual note that gives unstructured information that is relevant to the credit note as a whole\"\n  ],\n  \"payeeParty\": {\n    \"name\": \"Payee BV\",\n    \"legalEntity\": {\n      \"companyID\": \"0123456789\",\n      \"companySchemeID\": \"0208\"\n    },\n    \"partyIdentificationList\": [\n      {\n        \"schemeID\": \"0208\",\n        \"id\": \"0123456789\"\n      }\n    ]\n  },\n  \"taxRepresentativeParty\": {\n    \"name\": \"Tax Representative BV\",\n    \"vatNumber\": \"BE0999999999\",\n    \"postalAddress\": {\n      \"streetName\": \"Tax Rep Street 12\",\n      \"cityName\": \"Brussels\",\n      \"postalZone\": \"1000\",\n      \"countryIdentificationCode\": \"BE\"\n    }\n  },\n  \"supplier\": {\n    \"endpointID\": \"0123456789\",\n    \"endpointSchemeID\": \"0208\",\n    \"postalAddress\": {\n      \"streetName\": \"Main Street 1\",\n      \"cityName\": \"Brussels\",\n      \"postalZone\": \"1000\",\n      \"additionalStreetName\": \"Box 123\",\n      \"addressLine\": \"Building 3\",\n      \"countryIdentificationCode\": \"BE\"\n    },\n    \"vatNumber\": \"BE0123456789\",\n    \"name\": \"SUPPLIER COMPANY\",\n    \"email\": \"supplier@dokapi.io\",\n    \"telephone\": \"09 123 45 67\",\n    \"legalEntity\": {\n      \"registrationName\": \"SUPPLIER BV\",\n      \"languageID\": \"NL\",\n      \"companyID\": \"0123456789\",\n      \"companySchemeID\": \"0208\",\n      \"companyLegalForm\": \"Share capital\"\n    },\n    \"partyIdentificationList\": [\n      {\n        \"schemeID\": \"0208\",\n        \"id\": \"0123456789\"\n      }\n    ]\n  },\n  \"customer\": {\n    \"endpointID\": \"0987654321\",\n    \"endpointSchemeID\": \"0208\",\n    \"postalAddress\": {\n      \"streetName\": \"Customer Road 5\",\n      \"cityName\": \"Antwerp\",\n      \"postalZone\": \"2000\",\n      \"additionalStreetName\": \"Po Box 987\",\n      \"addressLine\": \"Floor 2\",\n      \"countryIdentificationCode\": \"BE\"\n    },\n    \"vatNumber\": \"BE0987654321\",\n    \"name\": \"CUSTOMER COMPANY\",\n    \"email\": \"customer@dokapi.io\",\n    \"telephone\": \"+32 499 12 34 56\",\n    \"legalEntity\": {\n      \"registrationName\": \"CUSTOMER\",\n      \"companyID\": \"0987654321\",\n      \"companySchemeID\": \"0208\"\n    },\n    \"partyIdentificationList\": [\n      {\n        \"schemeID\": \"0208\",\n        \"id\": \"0987654321\"\n      }\n    ]\n  },\n  \"billingLines\": [\n    {\n      \"invoicedQuantity\": 10,\n      \"unitCode\": \"C62\",\n      \"priceAmount\": 10,\n      \"accountingCost\": \"my-invoice-line-accounting-cost\",\n      \"documentReference\": {\n        \"id\": \"OBJECT-LINE-1\",\n        \"schemeID\": \"AHL\",\n        \"documentTypeCode\": \"130\"\n      },\n      \"invoicePeriod\": {\n        \"startDate\": \"2025-04-01\",\n        \"endDate\": \"2025-04-15\"\n      },\n      \"item\": {\n        \"name\": \"Product A\",\n        \"description\": \"Detailed product A description\",\n        \"sellersItemIdentification\": {\n          \"identification\": \"SELLER-SKU-A\"\n        },\n        \"buyersItemIdentification\": {\n          \"identification\": \"BUYER-SKU-A\"\n        },\n        \"originCountry\": \"BE\",\n        \"taxCategory\": {\n          \"taxCategoryID\": \"S\",\n          \"taxPercentage\": 21\n        },\n        \"commodityClassifications\": [\n          {\n            \"itemClassificationCode\": \"9873242\",\n            \"itemTypeIdentificationCode\": \"STI\"\n          }\n        ]\n      },\n      \"allowanceCharges\": [\n        {\n          \"chargeIndicator\": true,\n          \"amount\": 15,\n          \"allowanceChargeReasonCode\": \"DL\"\n        },\n        {\n          \"chargeIndicator\": false,\n          \"amount\": 10,\n          \"allowanceChargeReason\": \"discount\"\n        }\n      ]\n    },\n    {\n      \"invoicedQuantity\": 5,\n      \"unitCode\": \"C62\",\n      \"priceAmount\": 10,\n      \"item\": {\n        \"name\": \"Product B\",\n        \"taxCategory\": {\n          \"taxPercentage\": 21,\n          \"taxCategoryID\": \"S\"\n        }\n      },\n      \"note\": \"item note\",\n      \"orderLineReference\": \"orderLineReference\"\n    },\n    {\n      \"invoicedQuantity\": 15,\n      \"unitCode\": \"C62\",\n      \"priceAmount\": 15,\n      \"item\": {\n        \"name\": \"Product exempt from tax\",\n        \"taxCategory\": {\n          \"taxPercentage\": 0,\n          \"taxCategoryID\": \"E\"\n        }\n      }\n    },\n    {\n      \"invoicedQuantity\": 1,\n      \"unitCode\": \"C62\",\n      \"priceAmount\": 1,\n      \"item\": {\n        \"name\": \"Product addition info\",\n        \"taxCategory\": {\n          \"taxPercentage\": 0,\n          \"taxCategoryID\": \"AE\"\n        },\n        \"additionalItemProperties\": [\n          {\n            \"name\": \"additional-property\",\n            \"value\": \"value\"\n          }\n        ],\n        \"standardItemIdentification\": {\n          \"scheme\": \"0160\",\n          \"identification\": \"item-identification\"\n        }\n      }\n    }\n  ],\n  \"monetaryTotal\": {\n    \"prepaidAmount\": 4.99,\n    \"payableAmount\": 100\n  },\n  \"paymentMeans\": [\n    {\n      \"paymentMeansCode\": \"58\",\n      \"paymentMeansName\": \"SEPA credit transfer\",\n      \"paymentID\": \"PM-12345\",\n      \"paymentDueDate\": \"2025-04-01\",\n      \"financialAccount\": {\n        \"id\": \"BE99999999999999\",\n        \"name\": \"Supplier Main Account\",\n        \"financialInstitutionBranch\": {\n          \"id\": \"XXXXXXXX\"\n        }\n      },\n      \"cardAccount\": {\n        \"primaryAccountNumberID\": \"4111111111111111\",\n        \"holderName\": \"Card Holder Name\"\n      },\n      \"paymentMandate\": {\n        \"id\": \"MANDATE-001\",\n        \"payerFinancialAccount\": {\n          \"id\": \"BE99999999999999\",\n          \"financialInstitutionBranch\": {\n            \"id\": \"XXXXXXXX\"\n          }\n        }\n      }\n    }\n  ],\n  \"paymentTerms\": {\n    \"note\": \"Net within 30 days\"\n  },\n  \"allowanceCharges\": [\n    {\n      \"chargeIndicator\": true,\n      \"amount\": 200,\n      \"allowanceChargeReasonCode\": \"DL\",\n      \"taxCategory\": {\n        \"taxPercentage\": 25,\n        \"taxCategoryID\": \"S\"\n      }\n    },\n    {\n      \"chargeIndicator\": false,\n      \"amount\": 100,\n      \"allowanceChargeReason\": \"discount\",\n      \"taxCategory\": {\n        \"taxPercentage\": 10,\n        \"taxCategoryID\": \"S\"\n      }\n    }\n  ],\n  \"taxSubtotals\": [\n    {\n      \"taxCategory\": {\n        \"taxPercentage\": 0,\n        \"taxCategoryID\": \"AE\"\n      },\n      \"taxExemptionReason\": \"custom tax exemption reason\",\n      \"taxExemptionReasonCode\": \"custom tax exemption reason code for AE\"\n    }\n  ],\n  \"delivery\": {\n    \"actualDeliveryDate\": \"2025-03-31\",\n    \"deliveryLocation\": {\n      \"id\": \"location-id\",\n      \"postalAddress\": {\n        \"streetName\": \"Customer Road 5\",\n        \"cityName\": \"Antwerp\",\n        \"postalZone\": \"2000\",\n        \"addressLine\": \"Dock 7\",\n        \"countryIdentificationCode\": \"BE\"\n      }\n    },\n    \"deliveryParty\": {\n      \"name\": \"delivery party name\"\n    }\n  },\n  \"additionalDocuments\": [\n    {\n      \"id\": \"doc-001\",\n      \"filename\": \"credit-note-attachment.pdf\",\n      \"mimeCode\": \"application/pdf\",\n      \"documentDescription\": \"Signed credit note PDF\",\n      \"content\": \"RW5jb2RlZCBjb250ZW50IGV4YW1wbGUgZm9yIERva2FwaSBDb252ZXJzaW9uCg==\"\n    },\n    {\n      \"filename\": \"credit-note-details.csv\",\n      \"mimeCode\": \"text/csv\",\n      \"documentDescription\": \"Detailed csv billing lines\"\n    },\n    {\n      \"id\": \"external-document\",\n      \"documentDescription\": \"A reference to an external document\",\n      \"externalReferenceURI\": \"https://example.com/attachments/timesheet-2025-04.pdf\"\n    }\n  ]\n}\n```\n</details>\n\n## CII_TO_UBL_MAPPER\n\n**CII_TO_UBL_MAPPER** converts a CII (UN/CEFACT Cross Industry Invoice D16B) XML document into a UBL 2.1 invoice or credit note XML document, following the EN 16931 European e-invoicing standard.\n\n### Input\n\nA valid **CII D16B** (`urn:un:unece:uncefact:data:standard:CrossIndustryInvoice:100`) XML file. The document type (invoice vs. credit note) is determined automatically from the CII `TypeCode`.\n\n**Request schema:** Upload the CII XML file directly to the presigned URL. The combined size of this file and any additional documents must be **≤ 25 MB**.\n\n### Output\n\nA UBL 2.1 XML document in either Invoice (`urn:oasis:names:specification:ubl:schema:xsd:Invoice-2`) or CreditNote (`urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2`) format, validated against EN 16931 rules.\n\n### Conversion quality\n\n| Profile | Quality |\n|---------|---------|\n| **EN 16931** (`urn:cen.eu:en16931:2017`) | Full support — all EN 16931 business terms are mapped. |\n| **XRechnung** (`xrechnung`) | Best effort — core EN 16931 terms are mapped; XRechnung-specific extensions may not be fully preserved. |\n| **FR-XP-Z12-012** (French extensions, `B1` process / `factur-x`) | Best effort — EN 16931 core is mapped; French-specific extension fields may not be fully preserved. |\n| **Other CII profiles** | Best effort — fields outside the EN 16931 standard may result in minor data loss. |\n\n## PDF_MAPPER\n\n**PDF_MAPPER** converts a machine-readable UBL XML invoice or credit note into a basic, human-readable PDF document.\n\n### Input\n\nA valid **Peppol BIS Billing 3.0** invoice or credit note XML file.\n\n**Important:** Ensure the correct namespaces are used in the XML file:\n- `urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2`\n- `urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2`\n\n### Output\n\nA formatted PDF that visualizes the key invoice details. The layout is basic and utilitarian.\n\nOptional: The raw XML file is provided as additional pages when `addUbl` is set to true in the request body.\n\n<details>\n<summary>Displayed Fields</summary>\n\nThe PDF includes the following fields:\n\n- **Invoice number**\n- **Issue date**\n- **Due date**\n- **Order reference**\n- **Currency**\n- **Seller details**\n- **Buyer details**\n- **Line items**\n  - Description\n  - Quantity\n  - Price\n  - Tax %\n- **Tax amounts**\n- **Total amounts**\n\n</details>\n","version":"N/A","contact":{}},"tags":[],"servers":[{"url":"https://conversion-api.dokapi.io/v1"}],"components":{"schemas":{"ProblemDetailDto":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type.","format":"uri","example":"https://httpstatuses.com/500"},"title":{"type":"string","description":"A short, human-readable summary of the problem.","example":"Service Unavailable"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem.","example":"The service is currently unable to handle the request."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem.","example":"/errors/12345"},"status":{"type":"number","description":"The HTTP status code for this occurrence of the problem.","example":500},"uuid":{"type":"string","description":"A UUID that uniquely identifies this specific error occurrence.","example":"550e8400-e29b-41d4-a716-446655440000"}},"required":["title","detail"]},"ClientCancellationFeedbackDto":{"type":"object","properties":{"event":{"type":"string","description":"Will always be `client.cancellation` in this case."},"ulid":{"type":"string","description":"A unique identifier for this webhook invocation, requests with the same ULID coming in again can be ignored"},"body":{"type":"string","description":"A message being set as feedback for client cancellation","example":"Cancellation process completed successfully!"}},"required":["event","ulid","body"]},"ClientCancellationResponseDto":{"type":"object","properties":{"message":{"type":"string","example":"Client cancellation successfully initiated. Further communications will be sent to the client.cancellation webhook."}},"required":["message"]},"ClientCounterDto":{"type":"object","properties":{"clientUlid":{"type":"string","example":"01HT00M1TBRPRPN6HT5ARZ1R2F"},"creationTimestamp":{"type":"string","example":"2024-03-08T15:34:18.242Z"},"lastModifiedTimestamp":{"type":"string","example":"2024-03-08T15:34:18.242Z"},"flow":{"type":"string","description":"indication of for which flow we are incrementing the counter"},"count":{"type":"number","description":"current count for the counter in context of the flow"}},"required":["clientUlid","creationTimestamp","lastModifiedTimestamp","flow","count"]},"WebhookRequestDto":{"type":"object","properties":{"url":{"type":"string","description":"A valid HTTPS Webhook URL.","format":"url","example":"https://webhook-test.com/004818c78eecacef393fee5822991234"},"events":{"description":"A list of event identifiers to be received on this webhook.<br/><br/>","example":["outgoing-peppol-documents.sent","incoming-peppol-documents.received","client.cancellation"],"type":"array","items":{"type":"string"}}},"required":["url","events"]},"WebhookResponseDto":{"type":"object","properties":{"ulid":{"type":"string","example":"01HT00M1TBRPRPN6HT5ARZ1R2F"},"clientUlid":{"type":"string","example":"01HT00M1TBRPRPN6HT5ARZ1R2F"},"creationTimestamp":{"type":"string","example":"2024-03-08T15:34:18.242Z"},"lastModifiedTimestamp":{"type":"string","example":"2024-03-08T15:34:18.242Z"},"url":{"type":"string","format":"url","example":"https://webhook-test.com/004818c78eecacef393fee5822991234"},"events":{"example":["outgoing-peppol-documents.sent","incoming-peppol-documents.received","client.cancellation"],"type":"array","items":{"type":"string"}}},"required":["ulid","clientUlid","creationTimestamp","lastModifiedTimestamp","url","events"]},"CreateWebhookResponseDto":{"type":"object","properties":{"message":{"type":"string","description":"Info about the webhook being created or not","example":"Webhook created successfully"},"webhook":{"description":"Info about the webhook","allOf":[{"$ref":"#/components/schemas/WebhookResponseDto"}]}},"required":["message","webhook"]},"DeleteWebhookResponseDto":{"type":"object","properties":{"message":{"type":"string","description":"Info about the webhook being deleted or not","example":"Webhook deleted successfully"}},"required":["message"]},"ConverterDto":{"type":"object","properties":{"name":{"enum":["UBL_MAPPER_INVOICE","UBL_MAPPER_CREDIT_NOTE","PDF_MAPPER","CII_TO_UBL_MAPPER"],"type":"string","example":"UBL_MAPPER_INVOICE"}},"required":["name"]},"ConversionRunFeedbackDto":{"type":"object","properties":{"ulid":{"type":"string","description":"A unique identifier for the conversion run within Dokapi."},"status":{"enum":["NEW","PROCESSING","PROCESSED","PROCESSING_FAILED","COMPLETE"],"type":"string","description":"Status will always be PROCESSED in this case."},"statusMessage":{"type":"string","description":"The status message will contain some additional info regarding the actual status."},"converter":{"description":"More information about the exact converter that was used for this - example: UBL_MAPPER_INVOICE","allOf":[{"$ref":"#/components/schemas/ConverterDto"}]},"creationTimestamp":{"type":"string","description":"Timestamp created during the creation of this conversion run."},"externalReference":{"type":"string","description":"Optional field provided by the API client during creation of the conversion run to identify this run."},"resultPresignedUrl":{"type":"string","description":"Optional field containing a presigned url where the converted item may be fetched."},"converterDetailsPresignedUrl":{"type":"string","description":"Presigned URL to fetch converter details\n- UblMapperConverterDetailsDto (for UBL conversions)\n- PdfMapperConverterDetailsDto (for PDF conversions)\n"}},"required":["ulid","status","statusMessage","converter","creationTimestamp"]},"ConversionRunProcessedFeedbackDto":{"type":"object","properties":{"event":{"type":"string","enum":["outgoing-peppol-documents.created","outgoing-peppol-documents.sent","incoming-peppol-documents.created","incoming-peppol-documents.received","validating-peppol-documents.created","validating-peppol-documents.validated","recognition.finished","conversion-run.processed","mandate.requested","mandate.reviewing","mandate.action-required","mandate.reviewed","mandate.activating","mandate.active","mandate.inactive","client.cancellation"],"description":"Will always be `conversion-run.processed` in this case."},"ulid":{"type":"string","description":"A unique identifier for this webhook invocation, requests with the same ULID coming in again can be ignored"},"body":{"$ref":"#/components/schemas/ConversionRunFeedbackDto"}},"required":["event","ulid","body"]},"OrderReferenceDto":{"type":"object","properties":{"id":{"type":"string","description":"An identifier of a referenced purchase order (BT-13).","example":"PO-2025-001"},"salesOrderID":{"type":"string","description":"An identifier of a referenced sales order issued by the seller (BT-14).","example":"SO-2025-042"}}},"DocumentReferenceDto":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the referenced document.","example":"INV-2025-001"},"schemeID":{"type":"string","description":"The identification scheme of the document identifier.","example":"IT"},"issueDate":{"type":"string","description":"The date the referenced document was issued. Format \"YYYY-MM-DD\".","example":"2025-01-15"},"documentTypeCode":{"type":"string","description":"A code specifying the type of the referenced document (e.g. \"130\" for invoiced object).","example":"130"},"documentDescription":{"type":"string","description":"A description of the referenced document.","example":"timesheet"}}},"PayeePartyLegalEntityDto":{"type":"object","properties":{"companyID":{"type":"string","description":"The legal registration number of the payee (BT-61).","example":"0123456789"},"companySchemeID":{"type":"string","description":"The identification scheme of the legal registration number. See code list \"ISO 6523 ICD list\".","example":"0208"},"languageID":{"type":"string","description":"Language identifier for the payee's legal entity. Must be 'NL' for Dutch or 'FR' for French. Typically only used when sending to the Belgian Peppol Authority (Hermes).","example":"NL"}},"required":["companyID"]},"PartyIdentification":{"type":"object","properties":{"schemeID":{"type":"string","description":"The identification scheme identifier for the id. See code list \"ISO 6523 ICD list\".","example":"0208"},"id":{"type":"string","description":"An identifier for the party.","example":"1016764193"}},"required":["id"]},"PayeePartyDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the payee party (BT-59).","example":"Acme Holding NV"},"legalEntity":{"description":"Legal entity details for the payee. When provided, the registration number (BT-61) is required.","allOf":[{"$ref":"#/components/schemas/PayeePartyLegalEntityDto"}]},"partyIdentificationList":{"description":"An identifier for the payee party (BT-60). At most one entry is allowed.","type":"array","items":{"$ref":"#/components/schemas/PartyIdentification"}}},"required":["name"]},"PostalAddressDto":{"type":"object","properties":{"addressLine":{"type":"string","description":"An additional address line providing further detail (BT-162/163/164/165), e.g. floor, building name, or PO box.","example":"Building C, 3rd floor"},"streetName":{"type":"string","description":"The main address line in an address.","example":"Schuttersvest 75"},"additionalStreetName":{"type":"string","description":"An additional address line in an address that can be used to give further details supplementing the main line.","example":"Po Box 987"},"cityName":{"type":"string","description":"The common name of the city, town or village, where the address is located.","example":"Mechelen"},"postalZone":{"type":"string","description":"The identifier for an addressable group of properties according to the relevant postal service.","example":"2800"},"countryIdentificationCode":{"type":"string","description":"A code that identifies the country. See code list \"ISO 3166-1:Alpha2 Country codes\".","example":"BE"}},"required":["countryIdentificationCode"]},"TaxRepresentativePartyDto":{"type":"object","properties":{"name":{"type":"string","description":"The full name of the tax representative (BT-62).","example":"Tax Rep SARL"},"vatNumber":{"type":"string","description":"The VAT identifier of the tax representative (BT-63).","example":"FR12345678901"},"postalAddress":{"description":"The postal address of the tax representative (BG-12).","allOf":[{"$ref":"#/components/schemas/PostalAddressDto"}]}},"required":["name","vatNumber","postalAddress"]},"AdditionalDocumentDto":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the additional document. If no id is provided the filename will be used. Either the filename or the ID should be present.","example":"DOC-12345-678"},"schemeID":{"type":"string","description":"The identification scheme of the document identifier (e.g. \"IT\" for Italian SDI reference).","example":"IT"},"issueDate":{"type":"string","description":"The date the referenced document was issued. Format \"YYYY-MM-DD\".","example":"2025-01-15"},"documentTypeCode":{"type":"string","description":"A code specifying the type of the document. Use \"130\" to mark the additional document as the invoiced object (BT-18).","example":"130"},"filename":{"type":"string","description":"The name of the file. If no content was provided the filename is used to check additional document added during conversion run creation. If neither the content nor the file via filename can be found the conversion will fail.","example":"my-additional-file.pdf"},"mimeCode":{"type":"string","description":"The mime code of the attached document. The mime code should exist in the peppol code list \"Mime code (subset of IANA code list)\".","example":"application/pdf"},"documentDescription":{"type":"string","description":"A description of the document.","example":"timesheet"},"content":{"type":"string","description":"An document content as binary object (Base64 encoded string). This is not used if the file was uploaded via additional documents during conversion run creation.","example":"aHR0cHM6Ly90ZXN0LXZlZmEuZGlmaS5uby9wZXBwb2xiaXMvcG9hY2MvYmlsbGluZy8zLjAvYmlzLw=="},"externalReferenceURI":{"type":"string","description":"A URI pointing to an external document (BT-124).","example":"https://example.com/attachments/timesheet-2025-04.pdf"}}},"TaxCategoryDto":{"type":"object","properties":{"taxPercentage":{"type":"number","description":"The VAT rate, represented as percentage that applies to the item. Maximum of 2 decimals.","example":"21.00"},"taxCategoryID":{"type":"string","description":"The VAT category code for the item. See code list \"Duty or tax or fee category code (Subset of UNCL5305)\".","example":"S"}},"required":["taxPercentage","taxCategoryID"]},"TaxSubtotalDto":{"type":"object","properties":{"taxExemptionReason":{"type":"string","description":"A textual statement of the reason why the amount is exempted from VAT or why no VAT is being charged.","example":"Exempt"},"taxExemptionReasonCode":{"type":"string","description":"A coded statement of the reason for why the amount is exempted from VAT. See code list \"CEF VATEX\".","example":"VATEX-EU-AE"},"taxCategory":{"$ref":"#/components/schemas/TaxCategoryDto"}},"required":["taxCategory"]},"AlternateTaxCurrencyDto":{"type":"object","properties":{"currencyCode":{"type":"string","description":"The currency used for additional tax total calculation. See code list \"ISO 4217 Currency codes\".","example":"USD"},"exchangeRate":{"type":"number","description":"The exchange rate from the document currency to the currency for the additional tax.","minimum":0,"example":"12.99"}},"required":["currencyCode","exchangeRate"]},"InvoicePeriodDto":{"type":"object","properties":{"startDate":{"type":"string","description":"The date when the Invoice period starts. Format = \"YYYY-MM-DD\".","example":"2025-01-31"},"endDate":{"type":"string","description":"The date when the Invoice period ends. Format = \"YYYY-MM-DD\".","example":"2025-12-31"},"descriptionCode":{"type":"string","description":"The code of the date when the VAT becomes accountable for the Seller and for the Buyer. See code list \"VAT date code (UNCL2005 subset)\".","example":"35"}}},"LegalEntityDto":{"type":"object","properties":{"registrationName":{"type":"string","description":"The full name of the legal entity.","example":"DOK-API"},"languageID":{"type":"string","description":"Language identifier for the legal entity. This field is not required or supported by the core Peppol UBL specification but must be supplied when sending invoices to the Belgian Peppol Authority (Hermes). Must be 'NL' for Dutch or 'FR' for French.","example":"NL"},"companyID":{"type":"string","description":"An identifier issued by an official registrar that identifies the legal entity or person.","example":"1016764193"},"companySchemeID":{"type":"string","description":"The identification scheme identifier of the legal registration identifier. See code list \"ISO 6523 ICD list\".","example":"0208"},"companyLegalForm":{"type":"string","description":"Additional legal information relevant for the Seller. Can only be added for suppliers.","example":"Share capital"}},"required":["registrationName"]},"PartyDto":{"type":"object","properties":{"endpointID":{"type":"string","description":"Identifies the electronic address of the party used for communication.","example":"1016764193"},"endpointSchemeID":{"type":"string","description":"The identification scheme identifier of the electronic address. See code list \"Electronic Address Scheme (EAS)\".This is **not** the Peppol scheme identifier (e.g., 'iso6523-actorid-upis'), but rather the numeric scheme ID part used in the endpoint address format (e.g., '0208:123456789').","example":"0208"},"vatNumber":{"type":"string","description":"The VAT identifier of the party.","example":"BE1016764193"},"name":{"type":"string","description":"A name by which the party is known.","example":"Dokapi"},"email":{"type":"string","description":"An e-mail address to contact the party.","format":"email","example":"info@dokapi.io"},"telephone":{"type":"string","description":"A phone number to contact the party in any format.","example":"+32 475 12 34 56"},"partyIdentificationList":{"description":"For the customer party only 1 party identification is allowed!","type":"array","items":{"$ref":"#/components/schemas/PartyIdentification"}},"postalAddress":{"$ref":"#/components/schemas/PostalAddressDto"},"legalEntity":{"$ref":"#/components/schemas/LegalEntityDto"}},"required":["endpointID","endpointSchemeID","postalAddress","legalEntity"]},"LineItemIdentificationDto":{"type":"object","properties":{"identification":{"type":"string","description":"The identifier assigned by the seller or buyer to the item.","example":"ART-9876"}},"required":["identification"]},"ItemPropertyDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute or property of the item.","example":"Color"},"value":{"type":"string","description":"The value of the attribute or property of the item.","example":"Black"}},"required":["name","value"]},"StandardItemIdentificationDto":{"type":"object","properties":{"scheme":{"type":"string","description":"The identification scheme identifier of the Item standard identifier. See code list \"ISO 6523 ICD list\".","example":"0160"},"identification":{"type":"string","description":"An item identifier based on a registered scheme.","example":"10986700"}},"required":["scheme","identification"]},"CommodityClassificationDto":{"type":"object","properties":{"itemClassificationCode":{"type":"string","description":"A code for classifying the item by its type or nature.","example":"9873242"},"itemTypeIdentificationCode":{"type":"string","description":"The identification scheme identifier of the Item classification identifier. See code list \"Item type identification code (UNCL7143)\".","example":"IB"}},"required":["itemClassificationCode","itemTypeIdentificationCode"]},"BillingLineItemDto":{"type":"object","properties":{"name":{"type":"string","description":"A name for an item.","example":"Item name"},"description":{"type":"string","description":"A description of the item (BT-154).","example":"High-quality widget with extended warranty"},"sellersItemIdentification":{"description":"An identifier assigned by the seller to the item (BT-155).","allOf":[{"$ref":"#/components/schemas/LineItemIdentificationDto"}]},"buyersItemIdentification":{"description":"An identifier assigned by the buyer to the item (BT-156).","allOf":[{"$ref":"#/components/schemas/LineItemIdentificationDto"}]},"originCountry":{"type":"string","description":"The code identifying the country of origin of the item (BT-159). See code list \"ISO 3166-1:Alpha2 Country codes\".","example":"FR"},"taxCategory":{"$ref":"#/components/schemas/TaxCategoryDto"},"additionalItemProperties":{"type":"array","items":{"$ref":"#/components/schemas/ItemPropertyDto"}},"standardItemIdentification":{"$ref":"#/components/schemas/StandardItemIdentificationDto"},"commodityClassifications":{"type":"array","items":{"$ref":"#/components/schemas/CommodityClassificationDto"}}},"required":["name","taxCategory"]},"AllowanceChargeDto":{"type":"object","properties":{"chargeIndicator":{"type":"boolean","description":"Use \"true\" when informing about Charges and \"false\" when informing about Allowances.","example":true},"allowanceChargeReasonCode":{"type":"string","description":"The reason for the document level allowance or charge, expressed as a code. A code or a reason for the charge or allowance must be provided. See code lists \"Allowance reason codes (UNCL5189 subset)\" and \"Charge reason code (UNCL7161)\".","example":"95"},"allowanceChargeReason":{"type":"string","description":"The reason for the document level allowance or charge, expressed as text. A code or a reason for the charge or allowance must be provided.","example":"Discount"},"amount":{"type":"number","description":"The amount of an allowance or a charge, without VAT. Must be rounded to maximum 2 decimals.","minimum":0,"example":"12.99"},"taxCategory":{"description":"The tax category for the allowance charge. Must only be provided for document level allowances or charges.","allOf":[{"$ref":"#/components/schemas/TaxCategoryDto"}]}},"required":["chargeIndicator","amount"]},"BillingLineDto":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the individual line within the document. Either all billing lines must define an id, or none may define an id. When no id values are provided, identifiers will be generated automatically.","example":"1"},"invoicedQuantity":{"type":"number","description":"The quantity of items (goods or services) that is charged in the billing line.","example":"20"},"unitCode":{"type":"string","description":"The unit of measure that applies to the quantity, most commonly \"C62 - one\". See code list \"Recommendation 20, including Recommendation 21 codes - prefixed with X (UN/ECE)\".","example":"C62"},"priceAmount":{"type":"number","description":"The price of an item, exclusive of VAT, after subtracting item price discount. Item price can not be negative.","minimum":0,"example":"25.99"},"note":{"type":"string","description":"A textual note that gives unstructured information that is relevant to the Invoice line.","example":"New article number 12345"},"orderLineReference":{"type":"string","description":"An identifier for a referenced line within a purchase order, issued by the Buyer.","example":"3"},"documentReference":{"description":"A reference to an object (e.g. a timesheet) related to this billing line (BT-128).","allOf":[{"$ref":"#/components/schemas/DocumentReferenceDto"}]},"invoicePeriod":{"description":"The billing period applicable to this individual line (BG-26).","allOf":[{"$ref":"#/components/schemas/InvoicePeriodDto"}]},"accountingCost":{"type":"string"},"item":{"$ref":"#/components/schemas/BillingLineItemDto"},"allowanceCharges":{"type":"array","items":{"$ref":"#/components/schemas/AllowanceChargeDto"}}},"required":["invoicedQuantity","unitCode","priceAmount","item"]},"CardAccountDto":{"type":"object","properties":{"primaryAccountNumberID":{"type":"string","description":"The Primary Account Number (PAN) of the card used for payment, masked for security (BT-87).","example":"1234"},"holderName":{"type":"string","description":"The name of the card holder (BT-88).","example":"John Doe"}},"required":["primaryAccountNumberID"]},"FinancialInstitutionBranchDto":{"type":"object","properties":{"id":{"type":"string","description":"An identifier for the payment service provider where a payment account is located. Such as a BIC or a national clearing code where required.","example":"XXXXXXXX"}},"required":["id"]},"FinancialAccountDto":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier of the financial payment account, at a payment service provider, to which payment should be made. Such as IBAN or BBAN.","example":"BE99999999999999"},"name":{"type":"string","description":"The name of the financial account (BT-85).","example":"MON COMPTE BANCAIRE"},"financialInstitutionBranch":{"$ref":"#/components/schemas/FinancialInstitutionBranchDto"}},"required":["id"]},"PaymentMandateDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the mandate or agreement that was signed between the seller and the buyer (BT-89).","example":"MANDATE-2025-001"},"payerFinancialAccount":{"description":"The financial account of the payer to be debited by the direct debit (BT-91).","allOf":[{"$ref":"#/components/schemas/FinancialAccountDto"}]}},"required":["id"]},"PaymentMeansDto":{"type":"object","properties":{"paymentMeansCode":{"type":"string","description":"The means, expressed as code, for how a payment is expected to be or has been settled. See code list \"Payment means code (UNCL4461)\".","example":"58"},"paymentMeansName":{"type":"string","description":"The name of the payment means (BT-82), e.g. \"Virement\" or \"SEPA Credit Transfer\".","example":"SEPA Credit Transfer"},"paymentID":{"type":"string","description":"A textual value used to establish a link between the payment and the document. Used for creditor's critical reconciliation information. This information element helps the Seller to assign an incoming payment to the relevant payment process.","example":"432948234234234"},"paymentDueDate":{"type":"string","description":"The date when payment is due (BT-9). Credit notes only — invoices use the top-level \"dueDate\" field. Format \"YYYY-MM-DD\".","example":"2025-08-02"},"cardAccount":{"description":"Payment card information (BG-18).","allOf":[{"$ref":"#/components/schemas/CardAccountDto"}]},"paymentMandate":{"description":"Direct debit mandate information (BG-19).","allOf":[{"$ref":"#/components/schemas/PaymentMandateDto"}]},"financialAccount":{"$ref":"#/components/schemas/FinancialAccountDto"}},"required":["paymentMeansCode"]},"PaymentTermsDto":{"type":"object","properties":{"note":{"type":"string","description":"A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties).","example":"Net within 30 days"}},"required":["note"]},"MonetaryTotalDto":{"type":"object","properties":{"prepaidAmount":{"type":"number","description":"The sum of amounts which have been paid in advance. Maximum of 2 decimals.","example":"200.00"},"payableAmount":{"type":"number","description":"Optional override for the final amount to be paid. Use this only if your rounding differs from Peppol BIS Billing rounding rules. Any difference is applied to PayableRoundingAmount in the resulting UBL. Max 2 decimals.","example":"2000.00"}}},"DeliveryLocationDto":{"type":"object","properties":{"id":{"type":"string","description":"An identifier for the location at which the goods and services are delivered.","example":"83745498753497"},"postalAddress":{"$ref":"#/components/schemas/PostalAddressDto"}}},"DeliveryPartyDto":{"type":"object","properties":{"name":{"type":"string","description":"A name by which the party is known.","example":"Dokapi"}},"required":["name"]},"DeliveryDto":{"type":"object","properties":{"actualDeliveryDate":{"type":"string","description":"The date on which the supply of goods or services was made or completed. Format = \"YYYY-MM-DD\".","example":"2025-04-01"},"deliveryLocation":{"$ref":"#/components/schemas/DeliveryLocationDto"},"deliveryParty":{"$ref":"#/components/schemas/DeliveryPartyDto"}}},"InvoiceRequestDto":{"type":"object","properties":{"customizationID":{"type":"string","description":"An identification of the specification containing the total set of rules regarding semantic content, cardinalities and business rules to which the data contained in the instance document conforms.","example":"urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0"},"profileID":{"type":"string","description":"Identifies the business process context in which the transaction appears, to enable the receiver to process the document in an appropriate way.","example":"urn:fdc:peppol.eu:2017:poacc:billing:01:1.0"},"issueDate":{"type":"string","description":"The date when the document was issued. Format \"YYYY-MM-DD\"","example":"2025-05-01"},"taxPointDate":{"type":"string","description":"The date of the supply of goods or services if it differs from the issue date. Format \"YYYY-MM-DD\".","example":"2025-04-30"},"currency":{"type":"string","description":"The currency used for the full document. See code list \"ISO 4217 Currency codes\".","example":"EUR"},"accountingCost":{"type":"string","description":"A textual value that specifies where to book the relevant data into the Buyer's financial accounts.","example":"123456"},"orderReference":{"description":"Reference to a purchase order.","allOf":[{"$ref":"#/components/schemas/OrderReferenceDto"}]},"buyerReference":{"type":"string","description":"An identifier assigned by the Buyer used for internal routing purposes.","example":"123456"},"contractDocumentReference":{"description":"A reference to a contract associated with this document.","allOf":[{"$ref":"#/components/schemas/DocumentReferenceDto"}]},"receiptDocumentReference":{"description":"A reference to a receiving advice or goods receipt document.","allOf":[{"$ref":"#/components/schemas/DocumentReferenceDto"}]},"despatchDocumentReference":{"description":"A reference to a despatch advice document.","allOf":[{"$ref":"#/components/schemas/DocumentReferenceDto"}]},"originatorDocumentReference":{"description":"A reference to an originator document.","allOf":[{"$ref":"#/components/schemas/DocumentReferenceDto"}]},"billingReferences":{"description":"References to preceding invoices that this document relates to (BG-3).","type":"array","items":{"$ref":"#/components/schemas/DocumentReferenceDto"}},"notes":{"description":"Textual notes relevant to the document as a whole.","example":["Please note our new phone number 33 44 55 66"],"type":"array","items":{"type":"string"}},"payeeParty":{"description":"The payee party if different from the seller (BG-10). Only name and legal entity registration number are permitted.","allOf":[{"$ref":"#/components/schemas/PayeePartyDto"}]},"taxRepresentativeParty":{"description":"The tax representative party of the seller (BG-11). Required when the seller is not established in the buyer's country.","allOf":[{"$ref":"#/components/schemas/TaxRepresentativePartyDto"}]},"additionalDocuments":{"description":"Optional list of additional documents related to the conversion run.\n    Each document can either be referenced by filename (if it was uploaded during conversion run creation) or embedded directly via Base64-encoded content.\n    If a referenced filename or provided content cannot be resolved, the conversion will fail.\n    The total combined size of all additional documents (sum of all Base64 content fields and uploaded files) must not exceed 25 MB.","type":"array","items":{"$ref":"#/components/schemas/AdditionalDocumentDto"}},"taxSubtotals":{"description":"Optional field to edit tax subtotals. Defaults for tax subtotals are:\n  ```\n  [\n    {\n      \"taxCategory\": {\n        \"taxPercentage\": 0,\n        \"taxCategoryID\": \"AE\"\n      },\n      \"taxExemptionReason\": \"Reverse charge\",\n      \"taxExemptionReasonCode\": \"VATEX-EU-AE\"\n    },\n    {\n      \"taxCategory\": {\n        \"taxPercentage\": 0,\n        \"taxCategoryID\": \"E\"\n      },\n      \"taxExemptionReason\": \"Goods/services are exempt from tax.\",\n      \"taxExemptionReasonCode\": null\n    },\n    {\n      \"taxCategory\": {\n        \"taxPercentage\": 0,\n        \"taxCategoryID\": \"K\"\n      },\n      \"taxExemptionReason\": \"Intra-community supply\",\n      \"taxExemptionReasonCode\": \"VATEX-EU-IC\"\n    },\n    {\n      \"taxCategory\": {\n        \"taxPercentage\": 0,\n        \"taxCategoryID\": \"G\"\n      },\n      \"taxExemptionReason\": \"Export outside the EU\",\n      \"taxExemptionReasonCode\": \"VATEX-EU-G\"\n    },\n    {\n      \"taxCategory\": {\n        \"taxPercentage\": 0,\n        \"taxCategoryID\": \"O\"\n      },\n      \"taxExemptionReason\": \"Not subject to VAT\",\n      \"taxExemptionReasonCode\": \"VATEX-EU-O\"\n    }\n  ]\n  ```","type":"array","items":{"$ref":"#/components/schemas/TaxSubtotalDto"}},"invoiceID":{"type":"string","description":"A unique identification of the invoice.","example":"123456"},"dueDate":{"type":"string","description":"The date when the payment is due.Format \"YYYY-MM-DD\".","example":"2025-04-01"},"invoiceTypeCode":{"type":"string","description":"A code specifying the functional type of the document. Usually \"380\" for invoices and \"381\" for credit notes. See code list \"Invoice type code (UNCL1001 subset)\".","example":"380"},"projectReference":{"type":"string","description":"The identifier of the project the invoice relates to (BT-11).","example":"PROJ-2025-007"},"alternateTaxCurrency":{"$ref":"#/components/schemas/AlternateTaxCurrencyDto"},"invoicePeriod":{"$ref":"#/components/schemas/InvoicePeriodDto"},"supplier":{"$ref":"#/components/schemas/PartyDto"},"customer":{"$ref":"#/components/schemas/PartyDto"},"billingLines":{"type":"array","items":{"$ref":"#/components/schemas/BillingLineDto"}},"paymentMeans":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMeansDto"}},"paymentTerms":{"$ref":"#/components/schemas/PaymentTermsDto"},"monetaryTotal":{"$ref":"#/components/schemas/MonetaryTotalDto"},"delivery":{"$ref":"#/components/schemas/DeliveryDto"},"allowanceCharges":{"type":"array","items":{"$ref":"#/components/schemas/AllowanceChargeDto"}}},"required":["customizationID","profileID","issueDate","currency","invoiceID","invoiceTypeCode","supplier","customer","billingLines"]},"CreditNoteRequestDto":{"type":"object","properties":{"customizationID":{"type":"string","description":"An identification of the specification containing the total set of rules regarding semantic content, cardinalities and business rules to which the data contained in the instance document conforms.","example":"urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0"},"profileID":{"type":"string","description":"Identifies the business process context in which the transaction appears, to enable the receiver to process the document in an appropriate way.","example":"urn:fdc:peppol.eu:2017:poacc:billing:01:1.0"},"issueDate":{"type":"string","description":"The date when the document was issued. Format \"YYYY-MM-DD\"","example":"2025-05-01"},"taxPointDate":{"type":"string","description":"The date of the supply of goods or services if it differs from the issue date. Format \"YYYY-MM-DD\".","example":"2025-04-30"},"currency":{"type":"string","description":"The currency used for the full document. See code list \"ISO 4217 Currency codes\".","example":"EUR"},"accountingCost":{"type":"string","description":"A textual value that specifies where to book the relevant data into the Buyer's financial accounts.","example":"123456"},"orderReference":{"description":"Reference to a purchase order.","allOf":[{"$ref":"#/components/schemas/OrderReferenceDto"}]},"buyerReference":{"type":"string","description":"An identifier assigned by the Buyer used for internal routing purposes.","example":"123456"},"contractDocumentReference":{"description":"A reference to a contract associated with this document.","allOf":[{"$ref":"#/components/schemas/DocumentReferenceDto"}]},"receiptDocumentReference":{"description":"A reference to a receiving advice or goods receipt document.","allOf":[{"$ref":"#/components/schemas/DocumentReferenceDto"}]},"despatchDocumentReference":{"description":"A reference to a despatch advice document.","allOf":[{"$ref":"#/components/schemas/DocumentReferenceDto"}]},"originatorDocumentReference":{"description":"A reference to an originator document.","allOf":[{"$ref":"#/components/schemas/DocumentReferenceDto"}]},"billingReferences":{"description":"References to preceding invoices that this document relates to (BG-3).","type":"array","items":{"$ref":"#/components/schemas/DocumentReferenceDto"}},"notes":{"description":"Textual notes relevant to the document as a whole.","example":["Please note our new phone number 33 44 55 66"],"type":"array","items":{"type":"string"}},"payeeParty":{"description":"The payee party if different from the seller (BG-10). Only name and legal entity registration number are permitted.","allOf":[{"$ref":"#/components/schemas/PayeePartyDto"}]},"taxRepresentativeParty":{"description":"The tax representative party of the seller (BG-11). Required when the seller is not established in the buyer's country.","allOf":[{"$ref":"#/components/schemas/TaxRepresentativePartyDto"}]},"additionalDocuments":{"description":"Optional list of additional documents related to the conversion run.\n    Each document can either be referenced by filename (if it was uploaded during conversion run creation) or embedded directly via Base64-encoded content.\n    If a referenced filename or provided content cannot be resolved, the conversion will fail.\n    The total combined size of all additional documents (sum of all Base64 content fields and uploaded files) must not exceed 25 MB.","type":"array","items":{"$ref":"#/components/schemas/AdditionalDocumentDto"}},"taxSubtotals":{"description":"Optional field to edit tax subtotals. Defaults for tax subtotals are:\n  ```\n  [\n    {\n      \"taxCategory\": {\n        \"taxPercentage\": 0,\n        \"taxCategoryID\": \"AE\"\n      },\n      \"taxExemptionReason\": \"Reverse charge\",\n      \"taxExemptionReasonCode\": \"VATEX-EU-AE\"\n    },\n    {\n      \"taxCategory\": {\n        \"taxPercentage\": 0,\n        \"taxCategoryID\": \"E\"\n      },\n      \"taxExemptionReason\": \"Goods/services are exempt from tax.\",\n      \"taxExemptionReasonCode\": null\n    },\n    {\n      \"taxCategory\": {\n        \"taxPercentage\": 0,\n        \"taxCategoryID\": \"K\"\n      },\n      \"taxExemptionReason\": \"Intra-community supply\",\n      \"taxExemptionReasonCode\": \"VATEX-EU-IC\"\n    },\n    {\n      \"taxCategory\": {\n        \"taxPercentage\": 0,\n        \"taxCategoryID\": \"G\"\n      },\n      \"taxExemptionReason\": \"Export outside the EU\",\n      \"taxExemptionReasonCode\": \"VATEX-EU-G\"\n    },\n    {\n      \"taxCategory\": {\n        \"taxPercentage\": 0,\n        \"taxCategoryID\": \"O\"\n      },\n      \"taxExemptionReason\": \"Not subject to VAT\",\n      \"taxExemptionReasonCode\": \"VATEX-EU-O\"\n    }\n  ]\n  ```","type":"array","items":{"$ref":"#/components/schemas/TaxSubtotalDto"}},"creditNoteID":{"type":"string","description":"A unique identification of the credit note.","example":"123456"},"creditNoteTypeCode":{"type":"string","description":"A code specifying the functional type of the credit note, usually \"381\". See code list \"Credit note type code (UNCL1001 subset)\".","example":"381"},"alternateTaxCurrency":{"$ref":"#/components/schemas/AlternateTaxCurrencyDto"},"invoicePeriod":{"$ref":"#/components/schemas/InvoicePeriodDto"},"supplier":{"$ref":"#/components/schemas/PartyDto"},"customer":{"$ref":"#/components/schemas/PartyDto"},"billingLines":{"type":"array","items":{"$ref":"#/components/schemas/BillingLineDto"}},"paymentMeans":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMeansDto"}},"paymentTerms":{"$ref":"#/components/schemas/PaymentTermsDto"},"monetaryTotal":{"$ref":"#/components/schemas/MonetaryTotalDto"},"delivery":{"$ref":"#/components/schemas/DeliveryDto"},"allowanceCharges":{"type":"array","items":{"$ref":"#/components/schemas/AllowanceChargeDto"}}},"required":["customizationID","profileID","issueDate","currency","creditNoteID","creditNoteTypeCode","supplier","customer","billingLines"]},"PdfMapperConverterDetailsDto":{"type":"object","properties":{"documentReference":{"type":"string","description":"Reference of document, constructed as follows: {$clientUlid:$conversionUlid}"},"statusMessage":{"type":"string","description":"Human-readable status message","example":"Conversion completed successfully"},"success":{"type":"boolean","description":"Whether the conversion was successful","example":true},"status":{"type":"string","enum":["SUCCESS"],"example":"SUCCESS"}},"required":["documentReference","statusMessage","success","status"]},"UblMapperRequestValidationErrorDto":{"type":"object","properties":{"path":{"type":"string","example":"invoice.totalAmount"},"message":{"type":"string","example":"Value must be a positive number"},"invalidValue":{"type":"string","description":"The invalid value that was provided","example":-10}},"required":["path","message","invalidValue"]},"UblMapperConverterDetailsDto":{"type":"object","properties":{"documentReference":{"type":"string","description":"Reference of document, constructed as follows: {$clientUlid:$conversionUlid}"},"statusMessage":{"type":"string","description":"Human-readable status message","example":"Conversion completed successfully"},"success":{"type":"boolean","description":"Whether the conversion was successful","example":true},"status":{"type":"string","enum":["SUCCESS","UNPROCESSABLE_REQUEST","INVALID_REQUEST","UNABLE_TO_CREATE_VALID_UBL"],"example":"SUCCESS"},"documentType":{"enum":["UBL_INVOICE","UBL_CREDIT_NOTE"],"type":"string","example":"UBL_INVOICE"},"requestValidationErrors":{"description":"Errors found while validating the request","type":"array","items":{"$ref":"#/components/schemas/UblMapperRequestValidationErrorDto"}},"ublTypeErrors":{"description":"Errors related to UBL generation","example":["Missing mandatory element: cac:AccountingSupplierParty"],"type":"array","items":{"type":"string"}}},"required":["documentReference","statusMessage","success","status","documentType"]},"UblConverterSettingsDto":{"type":"object","properties":{}},"PdfConverterSettingsDto":{"type":"object","properties":{"outputLanguage":{"enum":["NL","FR","EN","DE","ES"],"type":"string","example":"NL","description":"The language of the output PDF"},"addUbl":{"type":"boolean","example":true,"description":"Indicates whether the raw UBL should be added to the PDF as an attachment"}}},"ConverterSettingsDto":{"type":"object","properties":{"ubl":{"description":"Optional settings that will be applied when choosing UBL converter","allOf":[{"$ref":"#/components/schemas/UblConverterSettingsDto"}]},"pdf":{"description":"Optional settings that will be applied when choosing PDF converter","allOf":[{"$ref":"#/components/schemas/PdfConverterSettingsDto"}]}}},"CreateConversionRunRequestDto":{"type":"object","properties":{"converter":{"description":"The chosen converter for this conversion run","allOf":[{"$ref":"#/components/schemas/ConverterDto"}]},"converterSettings":{"description":"Optional settings to be used during the conversion run","allOf":[{"$ref":"#/components/schemas/ConverterSettingsDto"}]},"externalReference":{"type":"string","description":"This is an external reference that can be stored on the conversion run.  We don't do anything with it, it's purely for referencing.  This external reference will also be included when sending feedback to registered webhooks.","example":"any_reference"},"additionalDocuments":{"maxItems":2,"description":"Allows attaching an additional document to a conversion run, enriching the context for processing. This can be used to provide supplementary data or references necessary for completing or enhancing the conversion results. The response will contain a presigned url for each additional document. The maximum amount of additional documents to be added is 2. The maximum size of all additional documents cannot exceed 25MB. The documents have to be uploaded before uploading the conversionRunRequest via presigned url!","example":["product-specifications.pdf","financial-summary.csv"],"type":"array","items":{"type":"string"}}},"required":["converter"]},"ConversionRunDto":{"type":"object","properties":{"ulid":{"type":"string","example":"01HSZZ39TECCTQ0G9DC9ZEDSV7"},"externalReference":{"type":"string","example":"any_reference"},"converter":{"$ref":"#/components/schemas/ConverterDto"},"converterSettings":{"$ref":"#/components/schemas/ConverterSettingsDto"},"creationTimestamp":{"type":"string","example":"2024-03-08T15:34:18.242Z"},"lastModifiedTimestamp":{"type":"string","example":"2024-03-08T15:34:18.242Z"},"additionalDocuments":{"example":["additionalFile1.pdf","additionalFile2.png"],"type":"array","items":{"type":"string"}}},"required":["ulid","converter","converterSettings","creationTimestamp","lastModifiedTimestamp","additionalDocuments"]},"CreateConversionRunResponseDto":{"type":"object","properties":{"message":{"type":"string","example":"Conversion Run created successfully"},"conversionRun":{"$ref":"#/components/schemas/ConversionRunDto"},"preSignedUploadUrl":{"type":"string","example":"https://s3.eu-central-1.amazonaws.com/conversionapi-conversionrunsuploadbucket-x","description":"Presigned URL for uploading the main conversion run request document. This triggers the start of the conversion run. If you have any additional documents this should be uploaded last!"},"additionalDocumentUploadUrls":{"type":"object","description":"A map of additional document filenames to their corresponding presigned upload URLs. These should be uploaded before uploading the main conversion run request!","example":{"financial-summary.csv":"https://s3.eu-central-1.amazonaws.com/conversionapi-uploadbucket/financial-summary.csv?signature=abc123","product-specifications.pdf":"https://s3.eu-central-1.amazonaws.com/conversionapi-uploadbucket/product-specifications.pdf?signature=def456"}}},"required":["message","conversionRun","preSignedUploadUrl","additionalDocumentUploadUrls"]}},"securitySchemes":{"oauth2-cc":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://dev-portal.dokapi.io/api/oauth2/token","scopes":{}}},"description":"This API uses OAuth2 Client Credentials. Client credentials can be retrieved from the subscription details.<br/><br/>The endpoints to which you have access depend on your subscription. If an endpoint does not appear to be available, it might not be included in your current subscription.","x-receive-token-in":"request-body","x-client-id":"","x-client-secret":""}}},"security":[{"oauth2-cc":[]}]}