` is\n non-empty free text. The general participant identifier restrictions also apply: spaces, dots and colons are not\n allowed. For example: `123456789_SENDER`.\n* Set `peppolRegistration` to `true`. This flag means that our API manages the participant in SML/SMP; it does not mean\n that the participant can receive invoices.\n* Include `FR_CDAR_REGULATED` in `supportedDocuments`; it is mandatory. You may additionally include\n `FR_CDAR_NONREGULATED`, which is optional. Non-regulated CDAR alone does not qualify as sender-only.\n* You may also include `PEPPOL_MESSAGE_LEVEL_RESPONSE_TRANSACTION_3_0` and/or\n `PEPPOL_INVOICE_RESPONSE_TRANSACTION_3_0`. These optional capabilities are not added automatically.\n* Do not include invoice, credit note or other receiving capabilities. If any such capability is present, the\n registration is treated as a normal France receiving participant and the normal France capability and Annuaire rules\n apply.\n\n`publishInPeppolDirectory` controls publication in the Peppol Directory independently; it does not create a receiving\nline in the France Annuaire.\n\nYou can create the legal entity and its sender-only registration together using\n[Create a legal entity](#tag/Legal-Entity/operation/createLegalEntity):\n\n```json\n{\n \"legalEntityDetails\": {\n \"name\": \"EXAMPLE COMPANY\",\n \"countryCode\": \"FR\",\n \"legalIdentifiers\": [\n {\n \"scheme\": \"0002\",\n \"identifier\": \"123456789\"\n }\n ],\n \"publishInPeppolDirectory\": false\n },\n \"peppolRegistrations\": [\n {\n \"peppolIdentifier\": {\n \"scheme\": \"0225\",\n \"identifier\": \"123456789_SENDER\"\n },\n \"peppolRegistration\": true,\n \"supportedDocuments\": [\n \"FR_CDAR_REGULATED\"\n ]\n }\n ]\n}\n```\n\nIf the French legal entity already exists, use\n[Register a legal entity in the Peppol network](#tag/Legal-Entity-Peppol-Registration/operation/createPeppolRegistrationForLegalEntity)\nwith the following request body:\n\n```json\n{\n \"peppolRegistrationDetails\": {\n \"peppolIdentifier\": {\n \"scheme\": \"0225\",\n \"identifier\": \"123456789_SENDER\"\n },\n \"peppolRegistration\": true,\n \"supportedDocuments\": [\n \"FR_CDAR_REGULATED\"\n ]\n }\n}\n```\n\nThe same capability rules apply when updating the registration. Requests without mandatory `FR_CDAR_REGULATED` are\nrejected before SMP publication; it is not added automatically. A sender-only registration is published in SMP with\nregulated CDAR and any supplied non-regulated CDAR or optional public response capabilities. It is not registered as an invoice receiver in the France Annuaire.\n\nIf your French `0225` registration contains only optional response capabilities and omits regulated CDAR, creation or\nupdate returns `LEGAL_ENTITY_ERROR` explaining that `FR_CDAR_REGULATED` must be included in `supportedDocuments`.\nAdd regulated CDAR to correct a sender-only request; you do not need to add invoice-receiving capabilities.\n\nFor regulated French invoices between `0225` identifiers, this sender-only exception applies both when submitting an\ninvoice through the API and when receiving an invoice from Peppol. For API submissions, we check the stored registration\nmatching the sender's scheme and identifier: it must have the sender-only capability profile described above, regardless\nof whether `peppolRegistration` is `true` or `false`. That flag controls SMP management, not outgoing sender-only\nclassification. No sender SMP lookup is needed for this check. For incoming invoices, we check the external sender's\ncomplete SMP capability set instead. When the applicable check confirms the sender-only profile, the sender's Annuaire\nreceiving line is not required. When submitting, the sender's Annuaire platform\ncomparison is also skipped, but the sender must still be registered in your workspace and pass the normal submission\nchecks. The receiver must still have a valid Annuaire entry. If the sender advertises other document capabilities or its\nsender-only profile cannot be confirmed from the applicable source, the normal Annuaire checks remain in place.\n\nCDAR lifecycle responses can be sent back to a sender-only invoice issuer without an Annuaire receiving line. CDAR\nsubmissions do not perform the invoice-specific Annuaire checks on either party. The sending participant must still be\nregistered in your workspace, the document must pass the normal submission validations, and the receiver must advertise\nthe corresponding CDAR capability and process in SMP. This applies to API-submitted and automatically generated CDARs.\n\n---\n\n#### Supported documents\n\nThe list of supported documents for France is specific. When registering a legal entity, the following document types are typically supported:\n\nUBL Documents:\n* `FR_UBL_INVOICE_CIUS_REGULATED`\n* `FR_UBL_INVOICE_CIUS_NONREGULATED`\n* `FR_UBL_INVOICE_EXTENSION_REGULATED`\n* `FR_UBL_INVOICE_EXTENSION_NONREGULATED`\n* `FR_UBL_CREDIT_NOTE_CIUS_REGULATED`\n* `FR_UBL_CREDIT_NOTE_CIUS_NONREGULATED`\n* `FR_UBL_CREDIT_NOTE_EXTENSION_REGULATED`\n* `FR_UBL_CREDIT_NOTE_EXTENSION_NONREGULATED`\n\nCII (Cross Industry Invoice) Documents:\n* `FR_CII_INVOICE_CIUS_REGULATED`\n* `FR_CII_INVOICE_CIUS_NONREGULATED`\n* `FR_CII_INVOICE_EXTENSION_REGULATED`\n* `FR_CII_INVOICE_EXTENSION_NONREGULATED`\n* `FR_FACTUR_X_REGULATED`\n* `FR_FACTUR_X_NONREGULATED`\n\nAcknowledgement/Response Documents:\n* `FR_CDAR_REGULATED`\n* `FR_CDAR_NONREGULATED`\n\n> **Note:** For France CII and CDAR documents, we use the official schemas version `D22B` published by UNECE here: [https://unece.org/trade/documents/2023/06/standards/cross-industry-invoice-d22b](https://unece.org/trade/documents/2023/06/standards/cross-industry-invoice-d22b) and here: [https://unece.org/trade/documents/2023/07/standards/cross-domain-acknowledgement-and-response-d22b](https://unece.org/trade/documents/2023/07/standards/cross-domain-acknowledgement-and-response-d22b)\n>\n> For creating your CII invoice or credit note, use the **uncoupled CII D22B XSDs** from the [official UNECE package](https://unece.org/sites/default/files/2025-07/CII_D22B.zip), located in the ZIP file under: `XSD/uncoupled/Schema/uncefact`.\n> \n> For creating your CII invoice or credit note for Factur-X, use the **Factur-X XSDs** from [fnfe-mpe.org](https://fnfe-mpe.org/ressources/), located in the section `Les Schematrons des profils EN16931 et EXTENDED-CTC-FR ainsi que ceux des règles de gestion additionnelles France BR-FR-CTC, développés par le FNFE-MPE`.\n\n---\n\n#### PA responsibilities towards PPF\n\nIn the French model, the `PA` (*Plateforme agréée*) is the platform through which participants exchange invoices and related France-specific lifecycle messages, while the `PPF` is the French authority platform that receives regulatory reporting.\n\nFor B2B exchanges between French legal entities, it is the responsibility of the `PA` to report the exchanged documents to `PPF`. This means that you continue to send and receive your invoices through Peppol as usual, and we, acting as the platform, perform the corresponding reporting to `PPF` automatically without requiring any extra action from you. We also notify you (the seller) about these authority submissions through the France `PPF / C5` notifications described in the section below.\n\nThe following table details exactly what we report to `PPF` and when, for B2B exchanges:\n\n| What is reported to PPF | When | Initiation | Your role |\n|---|--------------------------------------------------------------------------------------|---|---|\n| The invoice (or credit note) | When you send a Peppol invoice through our platform | Triggered by your invoice submission | Seller |\n| Lifecycle status `Déposée` | At the same time as the invoice submission - confirms the invoice has been deposited | Automatic by our platform (`PA`) | Seller |\n| Lifecycle status `Rejetée` | At the same time as the invoice submission, if the invoice is rejected at submission | Automatic by our platform (`PA`) | Seller |\n| Lifecycle status `Refusée` | When you send a Peppol invoice response with status *Refused* | Initiated by you (user action) | Buyer |\n| Lifecycle status `Encaissée` | When you send a Peppol invoice response with status *Collected* | Initiated by you (user action) | Seller |\n\n> **Note:** Other lifecycle statuses, such as `Approuvée`, `Mise à disposition`, `Prise en charge`, or `Paiement transmis`, may be supported and exchanged between platforms where applicable. However, under the French e-invoicing reform, the statuses that must be reported to the `PPF` for regulatory purposes are `Déposée`, `Rejetée`, `Refusée`, and, where payment reporting is required, `Encaissée`. The `Encaissée` status is mandatory only for transactions where payment data must be reported, for example where VAT is due on cash receipt.\n\nFor B2C transactions, and also for B2B transactions where the buyer is not a legal company residing in France, the reporting is not triggered automatically from the Peppol exchange flow. In these cases, it is your responsibility to use the dedicated [France e-reporting endpoint](#tag/France-PPF-Submission/operation/submitFranceEReportingXmlForLegalEntity) to submit the reporting payload to `PPF`.\n\n---\n\n#### Notifications\n\nSimilar to other countries, you will receive notifications when sending and receiving documents. \nAfter a document (e.g. an invoice) is sent, you will receive a `DOCUMENT_SENT` notification. You can then use the `transmissionId` from the notification to retrieve the transport evidence, which serves as proof of delivery to the recipient's platform. \nWhen you receive a document (e.g. an invoice), you will get a `DOCUMENT_RECEIVED` notification. You can then use the `transmissionId` from the notification to retrieve the received document content in its original format (either UBL XML, CII XML or Factur-X PDF).\n\nFrance also introduces notification types that are specific to the French document lifecycle and French authority reporting flows.\n\n##### CDAR notifications\n\n`CDAR` stands for Cross Domain Acknowledgement And Response. In practice, these notifications are used for France-specific invoice lifecycle updates exchanged over Peppol.\n\n* `CDAR_SENT`: a France lifecycle CDAR message was successfully sent by our platform. This is different from `DOCUMENT_SENT`, which confirms that the original invoice or credit note was delivered to the recipient Access Point. `CDAR_SENT` is about the lifecycle response itself. For example, when a France invoice is successfully sent, we as a platform (`PA`) will also send a seller-side `Déposée` CDAR in the France flow.\n* `CDAR_RECEIVED`: a France lifecycle CDAR message was received by our platform for a previously sent or received document. This notification means that the referenced invoice or credit note has received a France-specific status update. For example, after the buyer receives an invoice, they might send a `Rejetée` CDAR back to the seller, which would trigger a `CDAR_RECEIVED` notification for the seller.\n\n##### PPF / C5 reporting notifications\n\nPPF reporting is asynchronous and independent of Peppol delivery. A `DOCUMENT_SENT` notification confirms delivery to the recipient's Access Point; it does not confirm reporting to PPF. PPF entries are sent in bulk, but you receive notifications for each individual invoice, credit note, CDAR or e-reporting payload.\n\nA typical successful lifecycle is `C5_DOCUMENT_ENQUEUED` → `C5_DOCUMENT_SUBMITTED` → `C5_DOCUMENT_ACKNOWLEDGED` → `C5_DOCUMENT_PROCESSED`:\n\n| Event type | Meaning |\n|---|---|\n| `C5_DOCUMENT_ENQUEUED` | The individual entry was created and is waiting to be included in a PPF bulk submission. It has not yet been sent to PPF. |\n| `C5_DOCUMENT_SUBMITTED` | The bulk archive containing the entry was uploaded to PPF. This confirms transport only, not technical or business acceptance. |\n| `C5_DOCUMENT_SUBMISSION_FAILED` | The entry could not be prepared/queued, or its bulk archive could not be uploaded after all retries. `details` contains the available error information. A manual resubmission starts a new reporting lifecycle. |\n| `C5_DOCUMENT_ACKNOWLEDGED` | PPF returned technical status `500` (*Recevable*). The archive passed PPF's initial checks, but business processing is not yet complete. |\n| `C5_DOCUMENT_NOT_ACKNOWLEDGED` | PPF returned technical status `501` (*Irrecevable*). The archive failed PPF's initial checks; rejection information is returned when supplied by PPF. |\n| `C5_DOCUMENT_PROCESSED` | PPF completed business processing successfully (`250` for e-invoicing or `300` for e-reporting). |\n| `C5_DOCUMENT_PROCESSING_FAILED` | PPF completed processing with a business rejection (`251` for e-invoicing, `301` for e-reporting or `601` for a lifecycle report). |\n\nUse the notification fields as follows:\n\n* `submissionId` identifies the individual PPF entry; `c5TransmissionId` identifies the outbound bulk archive and is therefore normally absent from the initial `C5_DOCUMENT_ENQUEUED` notification.\n* On PPF response notifications, `acknowledgementId` is the name of the incoming PPF acknowledgement or business-response archive that produced the notification.\n* For invoices, credit notes and CDAR responses sent through Peppol, use `transmissionId` to correlate the C5 notification with the corresponding Peppol document submission.\n* Standalone France e-reporting submissions do not have a Peppol `transmissionId`. Correlate their notifications using the `submissionId` returned when the e-reporting submission was initially accepted.\n* `success` describes the outcome of the current event, not the final outcome of the entire lifecycle. General errors are returned in `details`; PPF business or validation reasons can be returned in `documentStatus`, `documentStatusDetails` and their nested `notes`.\n\nFields that do not apply to the current stage may be omitted. PPF acknowledgements and business responses arrive later, so consumers should use `eventType` and the identifiers above rather than assuming that the notifications will be returned together.\n\n---\n\n##### Detailed France exchange walkthrough\n\nThe following example shows a typical France invoice exchange and the related CDAR and PPF/C5 notifications end to end.\n\nAlthough this flow is representative of real-world exchanges, it is intentionally detailed to illustrate a longer end-to-end scenario. It is not the minimal possible example. In practice, multiple variations are possible, and some production flows can be significantly simpler than the one shown below.\n\n\nDetailed France exchange example
\n\n\n\n\n
\n \n \n | Document | \n Route | \n Seller | \n Buyer | \n
\n \n \n \n Invoice
INV1775 | \n Seller → Buyer
(via Peppol) | \n \n \n - initiates the sending by submitting the document
\n - \n the submission response contains:\n
\n - transmissionId=a51631b74d0a11f1be530237451f649b
\n - documentId=INV1775
\n \n \n - \n when the document reaches the recipient's AP, will have a DOCUMENT_SENT notification with:\n
\n - transmissionId=a51631b74d0a11f1be530237451f649b
\n - documentId=INV1775
\n \n \n \n | \n \n \n - \n receives the document at the AP, will have a DOCUMENT_RECEIVED notification with:\n
\n - transmissionId=abc5dd8c4d0a11f1be530237451f649b
\n - documentId=INV1775
\n \n \n \n | \n
\n \n Invoice
INV1775 | \n Seller → PPF | \n \n \n - \n initiates the PPF submission (automatically)\n
\n - \n has a C5_DOCUMENT_ENQUEUED notification when the report enters the PPF queue,\n followed by C5_DOCUMENT_SUBMITTED after its bulk archive is uploaded, with:\n
\n - transmissionId=a51631b74d0a11f1be530237451f649b
\n - documentId=INV1775
\n \n \n \n | \n | \n
\n \n | \n
\n \n CDAR Déposée
INV1775_CDV_200 | \n Seller → Buyer (via Peppol) | \n \n \n - \n initiates the sending of the CDAR (automatically)\n
\n - \n when the document reaches the recipient's AP, will have a CDAR_SENT notification with:\n
\n - referencedDocument.transmissionId=a51631b74d0a11f1be530237451f649b
\n - referencedDocument.documentId=INV1775
\n - currentDocument.transmissionId=b15668d84d0a11f1962d0a1599d5134b\n
\n - currentDocument.documentId=INV1775_CDV_200
\n \n \n \n | \n \n \n - \n receives the document at the AP, will have a CDAR_RECEIVED notification with:\n
\n - referencedDocument.transmissionId=abc5dd8c4d0a11f1be530237451f649b
\n - referencedDocument.documentId=INV1775
\n - currentDocument.transmissionId=b8ddc14d4d0a11f1962d0a1599d5134b\n
\n - currentDocument.documentId=INV1775_CDV_200
\n \n \n \n | \n
\n \n CDAR Déposée
INV1775_CDV_200 | \n Seller → PPF | \n \n \n - \n initiates the PPF submission (automatically)\n
\n - \n has a C5_DOCUMENT_ENQUEUED notification when the report enters the PPF queue,\n followed by C5_DOCUMENT_SUBMITTED after its bulk archive is uploaded, with:\n
\n - transmissionId=b15668d84d0a11f1962d0a1599d5134b\n
\n - documentId=INV1775_CDV_200
\n \n \n \n | \n | \n
\n \n | \n
\n \n CDAR Approuvée
INV1775_CDV_205 | \n Buyer → Seller (via Peppol) | \n \n \n - \n receives the CDAR document at the AP, will have a CDAR_RECEIVED notification with:\n
\n - referencedDocument.transmissionId=a51631b74d0a11f1be530237451f649b
\n - referencedDocument.documentId=INV1775
\n - currentDocument.transmissionId=caf263284e0a11f1612d8a159ad5f54b\n
\n - currentDocument.documentId=INV1775_CDV_205
\n \n \n \n | \n \n \n - \n responds to the seller announcing the approval of the invoice (initiates the sending of the\n CDAR manually, since this is optional)\n
\n - \n when the document reaches the recipient's AP, will have a CDAR_SENT notification with:\n
\n - referencedDocument.transmissionId=abc5dd8c4d0a11f1be530237451f649b
\n - referencedDocument.documentId=INV1775
\n - currentDocument.transmissionId=c9e779214e0a11f1962d8a159ad5134b\n
\n - currentDocument.documentId=INV1775_CDV_205
\n \n \n \n | \n
\n \n CDAR Approuvée
INV1775_CDV_205 | \n Buyer → PPF | \n | \n \n \n - \n initiates the PPF submission (manually, as reporting this lifecycle event is optional)\n
\n - \n has a C5_DOCUMENT_ENQUEUED notification when the report enters the PPF queue,\n followed by C5_DOCUMENT_SUBMITTED after its bulk archive is uploaded, with:\n
\n - transmissionId=c9e779214e0a11f1962d8a159ad5134b\n
\n - documentId=INV1775_CDV_205
\n \n \n \n | \n
\n \n | \n
\n \n CDAR Paiement transmis
INV1775_CDV_211 | \n Buyer → Seller (via Peppol) | \n \n \n - \n receives the CDAR document at the AP, will have a CDAR_RECEIVED notification with:\n
\n - referencedDocument.transmissionId=a51631b74d0a11f1be530237451f649b
\n - referencedDocument.documentId=INV1775
\n - currentDocument.transmissionId=5ab84d9a4f0c11f1a44b0c4a11de5f2c\n
\n - currentDocument.documentId=INV1775_CDV_211
\n \n \n \n | \n \n \n - \n responds to the seller announcing that the payment has been made (initiates the sending of the CDAR manually, since this is optional)\n
\n - \n when the document reaches the recipient's AP, will have a CDAR_SENT notification with:\n
\n - referencedDocument.transmissionId=abc5dd8c4d0a11f1be530237451f649b
\n - referencedDocument.documentId=INV1775
\n - currentDocument.transmissionId=6bc95eab4f0c11f1b55c1d5b22ef603d\n
\n - currentDocument.documentId=INV1775_CDV_211
\n \n \n \n | \n
\n \n CDAR Paiement transmis
INV1775_CDV_211 | \n Buyer → PPF | \n | \n \n \n - \n initiates the PPF submission (manually, as reporting this lifecycle event is optional)\n
\n - \n has a C5_DOCUMENT_ENQUEUED notification when the report enters the PPF queue,\n followed by C5_DOCUMENT_SUBMITTED after its bulk archive is uploaded, with:\n
\n - transmissionId=6bc95eab4f0c11f1b55c1d5b22ef603d\n
\n - documentId=INV1775_CDV_211
\n \n \n \n | \n
\n \n | \n
\n \n CDAR Encaissée
INV1775_CDV_212 | \n Seller → Buyer (via Peppol) | \n \n \n - \n initiates the sending of the CDAR (manually; this is mandatory only for transactions where payment data must be reported, eg VAT is due on cash receipt)\n
\n - \n when the document reaches the recipient's AP, will have a CDAR_SENT notification with:\n
\n - referencedDocument.transmissionId=a51631b74d0a11f1be530237451f649b
\n - referencedDocument.documentId=INV1775
\n - currentDocument.transmissionId=d3a41f5c4f0b11f1a12e0b2688e6c25a\n
\n - currentDocument.documentId=INV1775_CDV_212
\n \n \n \n | \n \n \n - \n receives the document at the AP, will have a CDAR_RECEIVED notification with:\n
\n - referencedDocument.transmissionId=abc5dd8c4d0a11f1be530237451f649b
\n - referencedDocument.documentId=INV1775
\n - currentDocument.transmissionId=d4b52a6d4f0b11f1b23f0c3799f7d36b\n
\n - currentDocument.documentId=INV1775_CDV_212
\n \n \n \n | \n
\n \n CDAR Encaissée
INV1775_CDV_212 | \n Seller → PPF | \n \n \n - \n initiates the PPF submission (automatically)\n
\n - \n has a C5_DOCUMENT_ENQUEUED notification when the report enters the PPF queue,\n followed by C5_DOCUMENT_SUBMITTED after its bulk archive is uploaded, with:\n
\n - transmissionId=d3a41f5c4f0b11f1a12e0b2688e6c25a\n
\n - documentId=INV1775_CDV_212
\n \n \n \n | \n | \n
\n \n
\n
\n\n\n\n# Glossary\n\n## Participant scheme and identifier\n\nThe **participant scheme** and **participant identifier** together represent the unique identifier of a participant in\nthe Peppol network. For instance the participant scheme and identifier of Ademico Software is `0208:0522912569`.\n\nThe **participant scheme** describes the **participant identifier** type eg VAT number, Chamber of Commerce number, GLN\nnumber, etc. The participant scheme is usually specific to each country eg for Belgium is `0208` which is the enterprise\nnumber but you can also have an\ninternationally used scheme eg GLN number.\nThe complete list of Peppol participant schemes can be\nfound on the Peppol website under\nsection `Participant Identifier Schemes`.\n\nThe **participant identifier** can be the participant's VAT number, Chamber of Commerce number, GLN, etc. For instance\nthe\nparticipant number of Ademico Software is the enterprise number from the Belgian Crossroad Bank of Enterprises which is\n0552912569.\n\nA legal entity can be registered in the Peppol network multiple times using different identifiers. For instance a legal\nentity in Belgium can be registered with the company registration number 0208:0552912569 and with the Belgium VAT number\n9925:BE0552912569.\n\nHere are some examples of Peppol identifiers in different countries:\n\n\n \n | Country | \n Peppol identifiers | \n
\n \n | Belgium | \n \n \n - 0208:0552912569 where 0208 is the scheme for the company registration number and 0552912569 is\n the company registration number value\n
\n - 9925:BE0552912569 where 9925 is the scheme for the Belgium VAT number and BE0552912569 is the\n VAT number value\n
\n \n | \n
\n \n | Luxembourg | \n \n \n - 9938:LU12345678 where 9938 is the scheme for the Luxembourg VAT number and LU12345678 is the\n VAT number value\n
\n \n | \n
\n \n | Netherlands | \n \n \n - 0106:12345678 where 0106 is the scheme for the Netherlands KvK number(Chamber of Commerce) and\n 12345678 is the KvK number value\n
\n - 0190:00000001801999999943 where 0190 is the scheme for the Netherlands OIN(Governmental\n organization number) and 00000001801999999943 is the OIN value\n
\n - 9944:nl001234567b01 where 9944 is the scheme for the Netherlands VAT number and nl001234567b01\n is the VAT number value\n
\n \n | \n
\n \n | Australia | \n \n \n - 0151:12345678901 where 0151 is the scheme for the Australian Business Number and 12345678901 is\n the Australian Business Number value\n
\n \n | \n
\n \n | New Zealand | \n \n \n - 0088:1234567890012 where 0088 is the scheme for the GLN(Global Location Number) and\n 1234567890012 is the GLN value\n
\n \n | \n
\n \n | Singapore | \n \n \n - 0195:SGUEN123456789W where 0195 is the scheme for the Singapore UEN and SGUEN123456789W is the\n standard identification number of an entity\n
\n \n | \n
\n \n | France | \n \n 0225 is the scheme used in France for identifiers used as electronic addresses in the context of the French Continuous Transactional Control reform on e-invoicing. \n \n - 0225:123456789 is the most common form you'll encounter in practice: 0225 followed by the SIREN number of the company
\n - 0225:123456789_12345678900001 is the form merging both the SIREN and SIRET number of the legal entity (allows companies to track invoices at the level of each establishment)
\n - 0225:123456789_A1234 is used to address a specific department, at the company level; it is formed by SIREN followed by a SUFFIX
\n - 0225:123456789_12345678900001_X123 is used to address a specific department of a specific establishment of the company; it is formed by SIREN followed by SIRET followed by a ROUTINGCODE
\n \n Other identifiers used in the context of the French e-invoicing are: \n \n - 0002:123456789 - the SIREN of the company (9 digits)
\n - 0009:12345678900001 - the SIRET of the establishment (14 digits)
\n - 9957:FR123456789 - the VAT number of the company
\n \n | \n
\n\n
\n\n## Document usage counts\n\nThe [document count endpoint](#tag/Statistics/operation/countDocuments) counts retained\nbusiness transmissions in the authenticated workspace. Optional date filters are\ninclusive and use each record's audit timestamp. The participant filter\nmatches the local sender for outgoing documents and the local recipient for incoming\ndocuments. Recorded failed submissions count as well as successful ones.\n\nIncluded types are `INVOICE`, `CREDIT_NOTE`, `CII_INVOICE`, `FACTURX`,\n`FACTURX_BASIC_WL`, `FACTURX_EN16931`, `FACTURX_EXTENDED`, `ORDER`, `ORDER_ADVANCED`,\n`ORDER_CHANGE`, `ORDER_CANCELLATION`, `ORDER_RESPONSE_ADVANCED`, `SG_ORDER_BALANCE`,\nand France `E_REPORTING`. Invoice/credit-note variants include self-billing and\ncorrective documents across supported profiles and countries.\n\n`CDAR_RESPONSE`, `APPLICATION_RESPONSE` (including Invoice Response, MLR and MLS),\nstatistics reports, envelopes, notifications, PPF responses and bulk archives are\nexcluded. They do not increase customer usage counts.\n\nEach matching audit record counts. Submitting the same invoice five times counts\nas **five**, even when its invoice number is unchanged. Multiple audit records\nsharing a transmission ID are counted separately, using each record's timestamp.\n\nFrance e-reporting counts **one persisted report submission**, not its individual\ntransaction/payment rows or PPF archive. It is attributed to its reporting legal\nidentifier (`0002:SIREN`), which can be used as the participant filter. Usage counts\nare updated asynchronously after the report submission is processed and persisted.\nAcceptance for processing alone does not count. Later transport failures, retries\nand callbacks do not alter its original usage count or date.\n\nCounts are limited to retained audit history. E-reporting audit retention is\nindependent of report-payload retention. The same policy applies to admin\norganization totals and their workspace/company breakdowns. Previously submitted\ne-reporting files are not backfilled into the audit history.\n\n# Changelog\n\n- 1.22 - September 2026\n - Fixed misleading “not found in Annuaire” errors when a directory lookup fails temporarily.\n - France e-reporting submission now selects a legal entity using `POST /api/peppol/v1/c5/france/ppf/legal-entities/{legalEntityId}/e-reporting-submissions`. Use the ID of an active legal entity in your workspace that matches the XML reporting SIREN. Multiple entities may share that SIREN.\n - The previous submission endpoint remains callable but is deprecated and removed from this reference. It still requires an unambiguous reporting SIREN. Existing clients can continue sending the same XML request without additional parameters or headers. XML retrieval is unchanged.\n - Added French PPF extraction mappings for consolidated credit notes (type `262`, reported as `381` with the contract reference and billing-period start), VAT exemptions, delivery fields, line selection and prices. The original customer document is preserved.\n - Improved documentation\n- 1.21 - September 2026\n - Added an endpoint for [retrieving the original France e-reporting XML](#tag/France-PPF-Submission/operation/getFranceEReportingSubmission) by the `submissionId` \n - Added support and documentation for French sender-only legal entities. These registrations use scheme `0225`, `peppolRegistration=true`, and mandatory `FR_CDAR_REGULATED`. `FR_CDAR_NONREGULATED`, MLR and Invoice Response are optional and are not added automatically. Their identifier must start with a 9-digit SIREN followed by an underscore and non-empty text. Internal MLS capabilities are not exposed through the public API. \n- 1.20 - September 2026\n - Added `claimedByPa` to each result returned when [searching the France Annuaire by SIREN or SIRET](#tag/France-Annuaire/operation/findPeppolIdentifiersBySirenOrSiret). A value of `false` means that the Annuaire record exists but is not routable because no real Plateforme Agréée has claimed it; `true` means that a real PA is assigned. The platform identifier is not exposed.\n - Corrected the OpenAPI specification to declare the shared `Order` tag only once, allowing strict validators and client generators to process the specification successfully.\n - Corrected OpenAPI response schemas, examples, date formats, and license metadata so that strict validation and generated-client compilation succeed.\n- 1.19 - August 2026\n - Added [Factur-X generation from a built-in France CII template](#tag/France-Factur-X-Generation/operation/generateFromTemplate), requiring only the seller and buyer Peppol identifiers and SIRENs, with optional VAT identifiers and an optional human-readable PDF language (`FR`, the default, or `EN`). Generated seller and buyer SIRENs use the French `0002` identifier scheme.\n - Added [Factur-X generation from a supplied EN16931 CII](#tag/France-Factur-X-Generation/operation/generateFromCii), with an optional readable PDF/A-1 or PDF/A-3 document. When the readable PDF is omitted, it is generated in French by default or in the requested `FR` or `EN` language. Invalid CII responses include the detailed XML, XSD, or Schematron validation report. These generation endpoints return the PDF and do not submit it to Peppol.\n - Corrected the France PPF submission retrieval contract so generated clients expose the returned `application/xml` response body instead of treating the endpoint as a DTO/no-content response.\n - Extended structured France CDAR submissions with requested-action code and text, detailed-status sequence numbers, and general document characteristics such as the paired `DIV`/`DVA` VAT-rate correction values from XP Z12-012 Annexe A/B v1.4.\n - Completed CDAR sending and receiving notifications with root notes, requested actions, amounts, and document characteristics.\n - Detailed-status sequence numbers are now allocated automatically when omitted, and root CDAR notes preserve their supported content, content-code, and subject-code fields.\n - Corrected the France CDAR OpenAPI examples to use French motif codes such as `TX_TVA_ERR`; approved status `205` no longer carries the invalid `APP` motif example.\n- 1.18 - August 2026\n - Added support for embedding Base64 attachments in PA-to-PA CDAR submissions. These attachments are omitted from the PPF-bound CDAR as required by the French PPF profile.\n - Added support for MEN, RAP, MPA, ESC, RAB, and REM amount details in structured JSON CDAR submissions, including the currency and VAT rate required for the generated CDAR XML.\n- 1.17 - July 2026\n - Added support for France UBL, CII, and Factur-X self-billing invoices and credit notes identified from their BT-3 document type code\n - Possibility to search exchanged documents using the legal entity id\n - Added an endpoint for [retrieving PPF submissions](#tag/France-PPF-Submission/operation/getFranceEInvoicingSubmission) to retrieve the content of the PPF submissions sent to the French authorities.\n - Added an endpoint for [requesting France PPF C5 reporting](#tag/France-PPF-Submission/operation/requestFranceEInvoicingC5Reporting) for an already sent France e-invoicing document.\n - Legal entity creation, legal entity updates, and Peppol registration updates now validate that the participant identifier scheme is allowed for the legal entity country; invalid combinations are rejected with a `LEGAL_ENTITY_ERROR`.\n - Legal entity creation, legal entity updates, and Peppol registration updates now validate that France legal entities support all mandatory France document types; missing document types are rejected with a `LEGAL_ENTITY_ERROR`.\n - Enhanced C5 notifications to include more details about the C5 submission status and acknowledgements.\n- 1.16 - July 2026\n - Legal entities can now be deleted even if they have exchanged documents\n - Added an endpoint for [searching exchanged documents](#tag/Documents/operation/getDocuments), such as invoices and orders, using common document, participant, transmission, country, and direction filters.\n - Added an endpoint for [searching the France Annuaire by SIREN or SIRET](#tag/France-Annuaire/operation/findPeppolIdentifiersBySirenOrSiret) to retrieve the currently effective Peppol electronic invoicing identifiers. \n- 1.15 - May 2026\n - Possibility to skip C5 submission on demand \n- 1.14 - May 2026\n - Possibility to [ submit a CDAR](#tag/France-CDAR/operation/sendCDAR)\n - Enhanced support for [CDAR notifications](#tag/Notification/operation/getNotifications)\n - Support for [France authority e-reporting flow](#tag/France-PPF-Submission/operation/submitFranceEReportingXmlForLegalEntity)\n - Possibility to [download Factur-X invoices](#tag/InvoiceCredit-Note/operation/getInvoiceInFacturxFormat) \n - Added a new `DOCUMENT_RECEIVE_FAILED` [notification type](#tag/Notification/operation/getNotifications) for incoming documents that are rejected due to technical issues (e.g., invalid format, failed validation, etc)\n - Included more details in the `INVOICE_RESPONSE_SENT` and `INVOICE_RESPONSE_RECEIVED` notifications\n - The legacy Participant API has been removed\n- 1.13 - March 2026\n - Ability to [Retrieve the transport evidence](#tag/Transport-Evidences/operation/downloadTransportEvidence) for a transmission ID. This can be used to demonstrate that the document was delivered to the receiver Access Point.\n - Ability to [Retrieve the number of documents exchanged within a specified period](#tag/Statistics/operation/countDocuments).The period and Peppol identifier are optional filters.\n - Improved validation error messages when a document cannot be delivered to the receiver Access Point due to a technical issue.\n- 1.12 - February 2026\n - Possibility to retrieve the transport evidences for a sent or received document\n- 1.11 - January 2026\n - Possibility to self-manage webhook configuration via the REST API\n - Possibility to send and receive duplicate documents, allowing the same document (with the same document ID) to be transmitted/received multiple times.\n- 1.10 - December 2025\n - Added the Party Identification details to the optional email we send you upon receiving a document (e.g., Invoice, Credit Note, or Order) \n- 1.9 - October 2025\n - Support for invoice and credit note Self-Billing\n - Belgian companies are now automatically de-registered from Hermes when you are trying to register them in\n Peppol\n- 1.8 - September 2025\n - Support for Advanced Ordering: Advanced Order, Order Change, Order Cancellation, Advanced Order Response\n - Support for Singapore Order Balance\n - The legal entity geographical information and contacts are now optional when registering/updating a legal entity\n- 1.7 - March 2025\n - New notifications endpoint which makes it easier to get notifications using one endpoint.\n - Singapore:\n - Possibility to perform KYC CorpPass process using API\n - Possibility to report documents to IRAS C5\n- 1.6 - May 2024\n - New Legal Entity API to better manage Peppol registrations;\n - Fix an issue when duplicate notifications were created in case the same invoice was submitted in parallel in the\n same time\n - Added support for PINT AU-NZ Invoices/Credit Notes used in Australia/New Zealand\n - Added support for Singapore PINT Invoices/Credit notes\n - Added support for Japan PINT Invoices/Credit notes\n- 1.5 - January 2024\n - Removed the suffix \"@ademico-software.com\" from the transmission id\n - Reduced the time to wait after registering a participant\n- 1.4 - December 2023\n - Added support for SI-UBL Invoices/Credit Notes used in Netherlands\n - Added support for OpenPeppol statistics\n - Possibility to filter on event type in the sending notifications\n\n- 1.3 - October 2023\n - Possibility to send an email to specific email recipients when receiving a document eg Invoice/Credit Note/Order.\n The email contains the UBL XML and the attachments contained in the UBL XML eg the Invoice in PDF format\n - Support for Purchase Order - BIS Order only\n\n- 1.2 - July 2023\n - Added support for Singapore Invoices/Credit Notes\n - Added possibility to filter the notifications(sending, receiving and invoice response) based on start date and end\n date\n - Possibility to send and receive Invoices/Credit Notes up to 50MB\n - Updated validation rules to the Peppol May release\n\n- 1.1 - March 2023\n - Added possibility to filter the notifications(sending, receiving and invoice response) based on the sender and the\n receiver\n - Improved documentation\n\n\nAdemico Peppol REST API Documentation
\n","termsOfService":"https://ademico-software.com/terms-and-conditions/","contact":{"name":"Contact","url":"https://ademico-software.com/peppol/peppol-service-provider/","email":"info@ademico-software.com"},"license":{"name":"Proprietary","url":"https://ademico-software.com/terms-and-conditions/"},"version":"v1.22","x-logo":{"altText":"Ademico Logo","url":"https://ademico-software.com/wp-content/uploads/2022/11/PEPPOL-REST-API-redocly-logo.png"}},"servers":[{"url":"https://test-peppol-api.ademico-software.com"},{"url":"https://test-peppol-api1.ademico-software.com/domibus"},{"url":"https://peppol-api.ademico-software.com"},{"url":"https://peppol-api1.ademico-software.com/domibus"}],"tags":[{"name":"Legal Entity KYC(Singapore and Malaysia)","description":"Use the Legal Entity KYC(Know Your Customer) API to manage the KYC process in certain countries eg Singapore using Corppass"},{"name":"Legal Entity C5 Singapore","description":"Use the Legal Entity C5 API to manage C5 activation in Singapore"},{"name":"Legal Entity Peppol Registration","description":"Use the Legal Entity Peppol Registration API in case you want to update the Peppol registration for an existing Legal Entity."},{"name":"France Annuaire","description":"France annuaire lookup API"},{"name":"Webhook Settings API","description":"Use the Webhook Settings API to self configure push notifications (webhooks) mechanism. Push notifications allow you to receive real-time updates about message events, such as when a message is sent, received, or fails to be send. By configuring webhooks, you can automate workflows and improve the efficiency of your messaging processes."},{"name":"Order","description":"Orders API"},{"name":"Singapore IRAS Submission","description":"Singapore IRAS Submission API"},{"name":"Notification","description":"Notifications API"},{"name":"Connectivity","description":"Connectivity API"},{"name":"Legal Entity","description":"A legal entity is an organization/company that sends and receives documents in the Peppol network. It is mandatory to create a legal entity before sending or receiving documents in the Peppol network.Use the Legal Entity API to create a legal entity and register it in the Peppol network."},{"name":"France PPF Submission","description":"France PPF e-invoicing and e-reporting submission API"},{"name":"Invoice Response","description":"Invoice Response API"},{"name":"Statistics","description":"Document statistics"},{"name":"Transport Evidences","description":"Transport Evidences API for retrieving AS4 transport evidences."},{"name":"France Factur-X Generation","description":"Generate France Factur-X PDF documents without submitting them to Peppol"},{"name":"Documents","description":"Search exchanged documents"},{"name":"France CDAR","description":"Cross Domain Acknowledgement and Response API"},{"name":"Invoice/Credit Note","description":"Invoice/Credit Note API"}],"paths":{"/api/peppol/v1/settings/webhooks":{"get":{"tags":["Webhook Settings API"],"summary":"Retrieve webhook notification settings","description":"Retrieve the current configuration for push notifications (webhooks).
This endpoint allows users to view and manage their webhook notification preferences. The response includes details such as the webhook URL, activation status, additional headers, and authentication settings.
Note that for security reasons, the actual password is not returned in the response; instead, a placeholder is used to indicate that a password is set.","operationId":"getNotificationSettings","parameters":[{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Error retrieving the settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"GENERIC_ERROR","message":"Error retrieving or updating settings"}}}},"200":{"description":"Webhook notification settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSettingsRO"},"examples":{"Notification settings example":{"description":"Notification settings example","value":{"active":true,"webhookUrl":"https://your-url-here.com/webhook","authentication":{"type":"OAUTH2","user":"yourUsername","password":"***","oauth2":{"authorizationPrefix":"Bearer","tokenUrl":"https://auth.your-url-here.com/token","tokenBody":"grant_type=client_credentials&client_id=yourClientId&client_secret=***","tokenExpiresLimitMinutes":10,"tokenHeaders":{"Content-Type":"application/x-www-form-urlencoded"}}},"additionalHeaders":{"Content-Type":"application/json","X-Custom-Header":"value"}}}}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]},"put":{"tags":["Webhook Settings API"],"summary":"Update webhook notification settings","description":"Update the configuration for push notifications (webhooks).
This endpoint allows users to set or modify their webhook notification preferences. When updating the settings, users can specify details such as the webhook URL, activation status, additional headers, and authentication settings.
Note that all webhooks settings are overwritten when using this endpoint. To partially update the settings (i.e., merge with existing ones), use the PATCH method instead.","operationId":"updateNotificationSettings","parameters":[{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Notification settings to be applied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSettingsRO"},"examples":{"Notification settings (OAuth2)":{"description":"Notification settings (OAuth2)","value":{"active":true,"webhookUrl":"https://your-url-here.com/webhook","authentication":{"type":"OAUTH2","user":"yourUsername","password":"yourPassword","oauth2":{"authorizationPrefix":"Bearer","tokenUrl":"https://auth.your-url-here.com/token","tokenBody":"grant_type=client_credentials&client_id=yourClientId&client_secret=yourClientSecret","tokenExpiresLimitMinutes":10,"tokenHeaders":{"Content-Type":"application/x-www-form-urlencoded"}}},"additionalHeaders":{"Content-Type":"application/json","X-Custom-Header":"value"}}},"Notification settings (BasicAuth)":{"description":"Notification settings (BasicAuth)","value":{"active":true,"webhookUrl":"https://your-url-here.com/webhook","authentication":{"type":"BASIC_AUTH","user":"yourUsername","password":"yourPassword"},"additionalHeaders":{"Content-Type":"application/json","X-Custom-Header":"value"}}},"Notification settings (No Auth - for test only)":{"description":"Notification settings (No Auth - for test only)","value":{"active":true,"webhookUrl":"https://your-url-here.com/webhook","authentication":{"type":"NONE"}}}}}},"required":true},"responses":{"400":{"description":"Error updating the webhook notification settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"GENERIC_ERROR","message":"Error retrieving or updating settings"}}}},"204":{"description":"Webhook notification settings updated successfully."}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]},"patch":{"tags":["Webhook Settings API"],"summary":"Partially update webhook notification settings","description":"Update the configuration for push notifications (webhooks).
This endpoint allows users to set or modify their webhook notification preferences. When updating the settings, users can specify details such as the webhook URL, activation status, additional headers, and authentication settings.
Note that only the provided fields are updated; other existing settings remain unchanged. To overwrite all webhook settings, use the PUT method instead.","operationId":"patchNotificationSettings","parameters":[{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Notification settings to be applied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSettingsRO"},"examples":{"Updating the webhook URL":{"description":"Updating the webhook URL","value":{"webhookUrl":"https://your-url-here.com/webhook"}},"Updating the webhook OAuth2 details":{"description":"Updating the webhook OAuth2 details","value":{"authentication":{"oauth2":{"authorizationPrefix":"Bearer","tokenUrl":"https://auth.your-url-here.com/token","tokenBody":"grant_type=client_credentials&client_id=yourClientId&client_secret=yourClientSecret","tokenHeaders":{"Content-Type":"application/x-www-form-urlencoded"}}}}},"Disabling Push notifications":{"description":"Disabling Push notifications","value":{"active":false}}}}},"required":true},"responses":{"400":{"description":"Error updating the webhook notification settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"GENERIC_ERROR","message":"Error retrieving or updating settings"}}}},"204":{"description":"Webhook notification settings updated successfully."}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/legal-entities/{legalEntityId}":{"put":{"tags":["Legal Entity"],"summary":"Update a legal entity","description":"Update a legal entity and publish it(optionally) in the Peppol Directory. For the TEST environment the legal entity is published in TEST Peppol Directory Set the flag `publishInPeppolDirectory` to false if you don't want to publish the legal entity details in the Peppol Directory. ","operationId":"updateLegalEntity","parameters":[{"name":"legalEntityId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Legal entity creation examples","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntityUpdateRequestRO"},"examples":{"Legal entity request example":{"description":"Legal entity request example","value":{"legalEntityDetails":{"publishInPeppolDirectory":true,"name":"Ademico Software","countryCode":"BE","geographicalInformation":"204 My street, My City, My Country","registrationDate":"2019-08-24T14:15:22.000","websiteURL":"https://ademico-software.com","contacts":[{"contactType":"public","name":"Your company name","phoneNumber":"+32 123456","email":"info@example.com"}],"additionalInformation":"Our company is specialized in ...","peppolAdditionalIdentifiers":[{"scheme":"0208","identifier":"0552912569"}]}}}}}},"required":true},"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"Legal entity updated successfully."},"400":{"description":"Error updating legal entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"LEGAL_ENTITY_ERROR","message":"Error updating legal entity"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]},"delete":{"tags":["Legal Entity"],"summary":"Delete a legal entity","description":"Delete a legal entity from the Peppol network(SML/SMP) and from the Peppol Directory. For the TEST environment the legal entity is deleted from the TEST Peppol Directory. ","operationId":"deleteLegalEntity","parameters":[{"name":"legalEntityId","in":"path","description":"The identifier of the legal entity you want to delete","required":true,"schema":{"type":"integer","format":"int64"},"example":7},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Error deleting legal entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"LEGAL_ENTITY_ERROR","message":"Could not delete legal entity: legal entity already sent or receive documents in the Peppol network"}}}},"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"Legal entity deleted successfully"}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/legal-entities/{legalEntityId}/peppol-registrations/{peppolRegistrationId}":{"put":{"tags":["Legal Entity Peppol Registration"],"summary":"Update a Peppol registration for a legal entity","description":"Update a Peppol registration for a legal entity(for instance to update the supported documents). You can have a look in the section Register your legal entity as a participant in the Peppol network for more details. For French sender-only capability rules, see Register a France 0225 identifier for sending only.","operationId":"updatePeppolRegistrationForLegalEntity","parameters":[{"name":"legalEntityId","in":"path","description":"The id of the legal entity you want to update in the Peppol network","required":true,"schema":{"type":"integer","format":"int64"},"example":7},{"name":"peppolRegistrationId","in":"path","description":"The id of the Peppol registration you want to update","required":true,"schema":{"type":"integer","format":"int64"},"example":1},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Peppol registration of legal entities update examples","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntityPeppolRegistrationUpdateRequestRO"},"examples":{"Peppol registration of a legal entity update example":{"description":"Peppol registration of a legal entity update example","value":{"peppolRegistrationDetails":{"peppolIdentifier":{"scheme":"0208","identifier":"0552912569"},"supportedDocuments":["PEPPOL_BIS_BILLING_UBL_INVOICE_V3","PEPPOL_BIS_BILLING_UBL_CREDIT_NOTE_V3","PEPPOL_MESSAGE_LEVEL_RESPONSE_TRANSACTION_3_0"],"peppolRegistration":true}}},"Update to a French sender-only 0225 Peppol registration":{"description":"Update to a French sender-only 0225 Peppol registration","value":{"peppolRegistrationDetails":{"peppolIdentifier":{"scheme":"0225","identifier":"123456789_SENDER"},"supportedDocuments":["FR_CDAR_REGULATED"],"peppolRegistration":true}}}}}},"required":true},"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"Legal entity updated successfully."},"400":{"description":"Error updating legal entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"LEGAL_ENTITY_ERROR","message":"Error creating legal entity"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]},"delete":{"tags":["Legal Entity Peppol Registration"],"summary":"Delete a Peppol registration for a legal entity","description":"Delete a Peppol registration for a legal entity. The Peppol registration of the legal entity will be also deleted from the Peppol network(SML/SMP). ","operationId":"deletePeppolRegistrationForLegalEntity","parameters":[{"name":"legalEntityId","in":"path","description":"The id of the legal entity","required":true,"schema":{"type":"integer","format":"int64"},"example":7},{"name":"peppolRegistrationId","in":"path","description":"The id of the Peppol registration you want to delete","required":true,"schema":{"type":"integer","format":"int64"},"example":1},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"Peppol registration deleted successfully"},"400":{"description":"Error deleting Peppol registration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"LEGAL_ENTITY_ERROR","message":"Could not delete the Peppol registration for legal entity"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/legal-entities/{legalEntityId}/peppol-registrations/{peppolRegistrationId}/kyc/pdf":{"put":{"tags":["Legal Entity KYC(Singapore and Malaysia)"],"summary":"KYC process using PDF authorisation document","description":"This endpoint is used in Singapore and Malaysia. Provide a PDF authorisation document to sign and complete the KYC process for a Peppol registration. For Singapore, you can use this service only in the Test environment. In the Production environment, you must use Corppass to complete the KYC process.","operationId":"signKYCUsingPdfForPeppolRegistration","parameters":[{"name":"legalEntityId","in":"path","description":"The id of the legal entity","required":true,"schema":{"type":"integer","format":"int64"},"example":7},{"name":"peppolRegistrationId","in":"path","description":"The id of the Peppol registration for which you want to sign the KYC","required":true,"schema":{"type":"integer","format":"int64"},"example":1},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request to initiate the KYC process using PDF authorisation document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntityKycSignRequestRO"},"examples":{"KYC email request example":{"description":"KYC email request example","value":{"pdfDocumentBase64":"VGhlIFBERiBhdXRob3JpemF0aW9uIGRvY3VtZW50IGluIGJhc2U2NA=="}}}}},"required":true},"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"Signed KYC using PDF successfully."},"400":{"description":"Error signing KYC using PDF","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"LEGAL_ENTITY_ERROR","message":"Error signing KYC process using PDF"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/sg-order-balances/ubl-submissions":{"post":{"tags":["Order"],"summary":"Send an UBL Singapore Order Balance to the Seller","description":"The Singapore Order Balance is scheduled in the queue to be sent to the Seller. The UBL is validated before is being sent.You get notified either via pull or push mechanism when the Singapore Order Balance has be received by the Seller. See below for possible validation errors you can get.","operationId":"submitSgOrderBalanceFile","parameters":[{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The SG Order Balance in UBL XML format","format":"binary"}}}}}},"responses":{"400":{"description":"Error sending the UBL SG Order Balance to the Seller. In this case the UBL SG Order Balance is not sent to the Seller. Examples of cases when you get an error:
- The submitted file does not contain an UBL SG Order Balance
- The XML validation, XSD validation or Schematron validation fails.
- Duplicate document: the SG Order Balance has been already sent
- The receiver is not registered in the Peppol network or it doesn't support receiving an UBL Order
","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSubmissionResultError"},"example":{"message":{"code":"SCHEMATRON_VALIDATION_ERROR","message":"The Schematron validation failed has failed for document [Order-invalid.xml]"},"validationReport":{"globalStatus":"ERROR","validatedXmlName":"Order-invalid.xml","xmlValidationReport":{"validatedWith":"Order-invalid.xml","reportStatus":"SUCCESS","warningsCount":0,"errorsCount":0,"xmlValidationMessages":[],"validationType":"XML_SYNTAX"},"xsdValidationReport":{"validatedWith":"UBL-Order-2.1.xsd","reportStatus":"SUCCESS","warningsCount":0,"errorsCount":0,"xsdValidationMessages":[],"validationType":"XSD_SCHEMA"},"schematronValidationReport":[{"validatedWith":"PEPPOLBIS-T01","reportStatus":"ERROR","warningsCount":0,"errorsCount":1,"schematronValidationMessages":[{"errorLevel":"ERROR","description":"Expected total amount with TAX = Expected total amount without TAX + Order total TAX amount.","lineNumber":263,"columnNumber":32,"schematronTest":"if($taxinclusiveAmount and /ubl:Order/cac:TaxTotal) then ($taxinclusiveAmount = $taxexclusiveAmount + $TAXamount) else 1","errorId":"PEPPOL-T01-R017","xpath":"/*:Order[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:Order-2'][1]/*:AnticipatedMonetaryTotal[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2'][1]","xpathWithoutNamespaces":"/Order[1]/AnticipatedMonetaryTotal[1]"}],"validationType":"SCHEMATRON"}],"warningsCount":0,"errorsCount":1,"xmlContent":""}}}}},"200":{"description":"The SG Order Balance has been scheduled in the queue to be sent to the Seller.You get notified either via pull or push mechanism when the SG Order Balance has be received by the Seller. Please check for more details in the notification sections.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentSubmissionResultRO"},"example":{"transmissionId":"803828d52d4911ed85f512ef9c5638d0","documentId":"pbe000512-1","documentTypeEnum":"SG_ORDER_BALANCE","sender":"0195:YOUR_PEPPOL_ID","receiver":"0195:SGTSTKADVORDERING01"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/orders/ubl-submissions":{"post":{"tags":["Order"],"summary":"Send an UBL Order to the Seller","description":"The Order is scheduled in the queue to be sent to the Seller. The UBL is validated before is being sent.You get notified either via pull or push mechanism when the Order has be received by the Seller. See below for possible validation errors you can get.","operationId":"submitOrderFile","parameters":[{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The Order in UBL XML format","format":"binary"}}}}}},"responses":{"200":{"description":"The Order has been scheduled in the queue to be sent to the Seller.You get notified either via pull or push mechanism when the Order has be received by the Seller. Please check for more details in the notification sections.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentSubmissionResultRO"},"example":{"transmissionId":"803828d52d4911ed85f512ef9c5638d0","documentId":"pbe000512-1","documentTypeEnum":"ORDER","sender":"0208:0552912569","receiver":"0208:1999999943"}}}},"400":{"description":"Error sending the UBL Order to the Seller. In this case the UBL Order is not sent to the Seller. Examples of cases when you get an error: - The submitted file does not contain an UBL Order
- The XML validation, XSD validation or Schematron validation fails.
- Duplicate order: the Order has been already sent
- The receiver is not registered in the Peppol network or it doesn't support receiving an UBL Order
","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSubmissionResultError"},"example":{"message":{"code":"SCHEMATRON_VALIDATION_ERROR","message":"The Schematron validation failed has failed for document [Order-invalid.xml]"},"validationReport":{"globalStatus":"ERROR","validatedXmlName":"Order-invalid.xml","xmlValidationReport":{"validatedWith":"Order-invalid.xml","reportStatus":"SUCCESS","warningsCount":0,"errorsCount":0,"xmlValidationMessages":[],"validationType":"XML_SYNTAX"},"xsdValidationReport":{"validatedWith":"UBL-Order-2.1.xsd","reportStatus":"SUCCESS","warningsCount":0,"errorsCount":0,"xsdValidationMessages":[],"validationType":"XSD_SCHEMA"},"schematronValidationReport":[{"validatedWith":"PEPPOLBIS-T01","reportStatus":"ERROR","warningsCount":0,"errorsCount":1,"schematronValidationMessages":[{"errorLevel":"ERROR","description":"Expected total amount with TAX = Expected total amount without TAX + Order total TAX amount.","lineNumber":263,"columnNumber":32,"schematronTest":"if($taxinclusiveAmount and /ubl:Order/cac:TaxTotal) then ($taxinclusiveAmount = $taxexclusiveAmount + $TAXamount) else 1","errorId":"PEPPOL-T01-R017","xpath":"/*:Order[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:Order-2'][1]/*:AnticipatedMonetaryTotal[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2'][1]","xpathWithoutNamespaces":"/Order[1]/AnticipatedMonetaryTotal[1]"}],"validationType":"SCHEMATRON"}],"warningsCount":0,"errorsCount":1,"xmlContent":""}}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/order-responses/ubl-submissions":{"post":{"tags":["Order"],"summary":"Send an UBL Order Response to the Buyer","description":"The Order Response is scheduled in the queue to be sent to the Buyer. The UBL is validated before is being sent.You get notified either via pull or push mechanism when the Order Response has be received by the Buyer. See below for possible validation errors you can get.","operationId":"submitOrderResponseFile","parameters":[{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The Order Response in UBL XML format","format":"binary"}}}}}},"responses":{"400":{"description":"Error sending the UBL Order Response to the Buyer. In this case the UBL Order Response is not sent to the Buyer. Examples of cases when you get an error: - The submitted file does not contain an UBL Order Response
- The XML validation, XSD validation or Schematron validation fails.
- Duplicate document: the Order Response has been already sent
- The receiver is not registered in the Peppol network or it doesn't support receiving an UBL Order
","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSubmissionResultError"},"example":{"message":{"code":"SCHEMATRON_VALIDATION_ERROR","message":"The Schematron validation failed has failed for document [Order-invalid.xml]"},"validationReport":{"globalStatus":"ERROR","validatedXmlName":"Order-invalid.xml","xmlValidationReport":{"validatedWith":"Order-invalid.xml","reportStatus":"SUCCESS","warningsCount":0,"errorsCount":0,"xmlValidationMessages":[],"validationType":"XML_SYNTAX"},"xsdValidationReport":{"validatedWith":"UBL-Order-2.1.xsd","reportStatus":"SUCCESS","warningsCount":0,"errorsCount":0,"xsdValidationMessages":[],"validationType":"XSD_SCHEMA"},"schematronValidationReport":[{"validatedWith":"PEPPOLBIS-T01","reportStatus":"ERROR","warningsCount":0,"errorsCount":1,"schematronValidationMessages":[{"errorLevel":"ERROR","description":"Expected total amount with TAX = Expected total amount without TAX + Order total TAX amount.","lineNumber":263,"columnNumber":32,"schematronTest":"if($taxinclusiveAmount and /ubl:Order/cac:TaxTotal) then ($taxinclusiveAmount = $taxexclusiveAmount + $TAXamount) else 1","errorId":"PEPPOL-T01-R017","xpath":"/*:Order[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:Order-2'][1]/*:AnticipatedMonetaryTotal[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2'][1]","xpathWithoutNamespaces":"/Order[1]/AnticipatedMonetaryTotal[1]"}],"validationType":"SCHEMATRON"}],"warningsCount":0,"errorsCount":1,"xmlContent":""}}}}},"200":{"description":"The Order Response has been scheduled in the queue to be sent to the Buyer.You get notified either via pull or push mechanism when the Order Response has be received by the Buyer. Please check for more details in the notification sections.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentSubmissionResultRO"},"example":{"transmissionId":"803828d52d4911ed85f512ef9c5638d0","documentId":"pbe000512-1","documentTypeEnum":"ORDER_RESPONSE_ADVANCED","sender":"0208:0552912569","receiver":"0208:1999999943"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/order-changes/ubl-submissions":{"post":{"tags":["Order"],"summary":"Send an UBL Order Change to the Seller","description":"The Order Change is scheduled in the queue to be sent to the Seller. The UBL is validated before is being sent.You get notified either via pull or push mechanism when the Order Change has be received by the Seller. See below for possible validation errors you can get.","operationId":"submitOrderChangeFile","parameters":[{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The Order Change in UBL XML format","format":"binary"}}}}}},"responses":{"400":{"description":"Error sending the UBL Order Change to the Seller. In this case the UBL Order Change is not sent to the Seller. Examples of cases when you get an error: - The submitted file does not contain an UBL Order Change
- The XML validation, XSD validation or Schematron validation fails.
- Duplicate document: the Order Change has been already sent
- The receiver is not registered in the Peppol network or it doesn't support receiving an UBL Order
","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSubmissionResultError"},"example":{"message":{"code":"SCHEMATRON_VALIDATION_ERROR","message":"The Schematron validation failed has failed for document [Order-invalid.xml]"},"validationReport":{"globalStatus":"ERROR","validatedXmlName":"Order-invalid.xml","xmlValidationReport":{"validatedWith":"Order-invalid.xml","reportStatus":"SUCCESS","warningsCount":0,"errorsCount":0,"xmlValidationMessages":[],"validationType":"XML_SYNTAX"},"xsdValidationReport":{"validatedWith":"UBL-Order-2.1.xsd","reportStatus":"SUCCESS","warningsCount":0,"errorsCount":0,"xsdValidationMessages":[],"validationType":"XSD_SCHEMA"},"schematronValidationReport":[{"validatedWith":"PEPPOLBIS-T01","reportStatus":"ERROR","warningsCount":0,"errorsCount":1,"schematronValidationMessages":[{"errorLevel":"ERROR","description":"Expected total amount with TAX = Expected total amount without TAX + Order total TAX amount.","lineNumber":263,"columnNumber":32,"schematronTest":"if($taxinclusiveAmount and /ubl:Order/cac:TaxTotal) then ($taxinclusiveAmount = $taxexclusiveAmount + $TAXamount) else 1","errorId":"PEPPOL-T01-R017","xpath":"/*:Order[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:Order-2'][1]/*:AnticipatedMonetaryTotal[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2'][1]","xpathWithoutNamespaces":"/Order[1]/AnticipatedMonetaryTotal[1]"}],"validationType":"SCHEMATRON"}],"warningsCount":0,"errorsCount":1,"xmlContent":""}}}}},"200":{"description":"The Order Change has been scheduled in the queue to be sent to the Seller.You get notified either via pull or push mechanism when the Order Change has be received by the Seller. Please check for more details in the notification sections.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentSubmissionResultRO"},"example":{"transmissionId":"803828d52d4911ed85f512ef9c5638d0","documentId":"pbe000512-1","documentTypeEnum":"ORDER_CHANGE","sender":"0208:0552912569","receiver":"0208:1999999943"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/order-cancellations/ubl-submissions":{"post":{"tags":["Order"],"summary":"Send an UBL Order Cancellation to the Seller","description":"The Order Cancellation is scheduled in the queue to be sent to the Seller. The UBL is validated before is being sent.You get notified either via pull or push mechanism when the Order Cancellation has be received by the Seller. See below for possible validation errors you can get.","operationId":"submitOrderCancellationFile","parameters":[{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The Order Cancellation in UBL XML format","format":"binary"}}}}}},"responses":{"400":{"description":"Error sending the UBL Order Cancellation to the Seller. In this case the UBL Order Cancellation is not sent to the Seller. Examples of cases when you get an error: - The submitted file does not contain an UBL Order Cancellation
- The XML validation, XSD validation or Schematron validation fails.
- Duplicate document: the Order Cancellation has been already sent
- The receiver is not registered in the Peppol network or it doesn't support receiving an UBL Order
","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSubmissionResultError"},"example":{"message":{"code":"SCHEMATRON_VALIDATION_ERROR","message":"The Schematron validation failed has failed for document [Order-invalid.xml]"},"validationReport":{"globalStatus":"ERROR","validatedXmlName":"Order-invalid.xml","xmlValidationReport":{"validatedWith":"Order-invalid.xml","reportStatus":"SUCCESS","warningsCount":0,"errorsCount":0,"xmlValidationMessages":[],"validationType":"XML_SYNTAX"},"xsdValidationReport":{"validatedWith":"UBL-Order-2.1.xsd","reportStatus":"SUCCESS","warningsCount":0,"errorsCount":0,"xsdValidationMessages":[],"validationType":"XSD_SCHEMA"},"schematronValidationReport":[{"validatedWith":"PEPPOLBIS-T01","reportStatus":"ERROR","warningsCount":0,"errorsCount":1,"schematronValidationMessages":[{"errorLevel":"ERROR","description":"Expected total amount with TAX = Expected total amount without TAX + Order total TAX amount.","lineNumber":263,"columnNumber":32,"schematronTest":"if($taxinclusiveAmount and /ubl:Order/cac:TaxTotal) then ($taxinclusiveAmount = $taxexclusiveAmount + $TAXamount) else 1","errorId":"PEPPOL-T01-R017","xpath":"/*:Order[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:Order-2'][1]/*:AnticipatedMonetaryTotal[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2'][1]","xpathWithoutNamespaces":"/Order[1]/AnticipatedMonetaryTotal[1]"}],"validationType":"SCHEMATRON"}],"warningsCount":0,"errorsCount":1,"xmlContent":""}}}}},"200":{"description":"The Order Cancellation has been scheduled in the queue to be sent to the Seller.You get notified either via pull or push mechanism when the Order Cancellation has be received by the Seller. Please check for more details in the notification sections.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentSubmissionResultRO"},"example":{"transmissionId":"803828d52d4911ed85f512ef9c5638d0","documentId":"pbe000512-1","documentTypeEnum":"ORDER_CANCELLATION","sender":"0208:0552912569","receiver":"0208:1999999943"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/legal-entities":{"get":{"tags":["Legal Entity"],"summary":"Get the list of the legal entities","description":"Get the list of the legal entities including the Peppol registrations(Peppol identifiers and supported documents)","operationId":"getLegalEntities","parameters":[{"name":"legalEntityId","in":"query","description":"The legal entity identifier","required":false,"schema":{"type":"integer","format":"int64"},"example":15},{"name":"name","in":"query","description":"The legal entity name","required":false,"schema":{"type":"string"},"example":"Company name"},{"name":"country","in":"query","description":"The legal entity country","required":false,"schema":{"$ref":"#/components/schemas/CountryCodeEnum"},"example":"BE"},{"name":"peppolRegistrationScheme","in":"query","description":"The Peppol identifier scheme of the legal entity","required":false,"schema":{"type":"string"},"example":"0208"},{"name":"peppolRegistrationIdentifier","in":"query","description":"The Peppol identifier of the legal entity","required":false,"schema":{"type":"string"},"example":"0552912569"},{"name":"peppolSupportedDocument","in":"query","description":"The document that can be received by the legal entity in the Peppol network","required":false,"schema":{"$ref":"#/components/schemas/PeppolDocumentSchemeEnumRO"},"example":"PEPPOL_BIS_BILLING_UBL_INVOICE_V3"},{"name":"page","in":"query","description":"The starting page number from which we want to retrieve results. The first page is 0.","required":false,"schema":{"type":"integer","format":"int32","default":0},"example":0},{"name":"pageSize","in":"query","description":"How many results we retrieve per page","required":false,"schema":{"type":"integer","format":"int32","default":10},"example":10},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Error retrieving legal entities","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"LEGAL_ENTITY_ERROR","message":"Error getting legal entities"}}}},"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"Legal entities retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntityListRO"},"example":{"pagination":{"count":2,"page":0,"pageSize":10},"legalEntities":[{"legalEntityId":1,"legalEntityDetails":{"publishInPeppolDirectory":true,"name":"Ademico Software","creationDate":"2024-01-05T07:20:51.068","registrationDate":"2019-08-24T14:15:22.000","countryCode":"BE","geographicalInformation":"204 My street, My City, My Country","websiteURL":"https://ademico-software.com","contacts":[{"contactType":"public","name":"Your company name","phoneNumber":"+32 123456","email":"info@example.com"}],"additionalInformation":"Our company is specialized in Peppol services","peppolAdditionalIdentifiers":[{"scheme":"0208","identifier":"0552912569"},{"scheme":"9925","identifier":"BE0552912569"}]},"peppolRegistrations":[{"peppolRegistrationId":1,"creationDate":"2024-01-05T07:21:15.000","peppolRegistrationDetails":{"peppolIdentifier":{"scheme":"0208","identifier":"0552912569"},"supportedDocuments":["PEPPOL_BIS_BILLING_UBL_INVOICE_V3","PEPPOL_BIS_BILLING_UBL_CREDIT_NOTE_V3","PEPPOL_MESSAGE_LEVEL_RESPONSE_TRANSACTION_3_0","PEPPOL_INVOICE_RESPONSE_TRANSACTION_3_0"],"peppolRegistration":true}},{"peppolRegistrationId":2,"creationDate":"2024-01-05T07:21:16.000","peppolRegistrationDetails":{"peppolIdentifier":{"scheme":"9925","identifier":"BE0552912569"},"supportedDocuments":["PEPPOL_BIS_BILLING_UBL_INVOICE_V3","PEPPOL_BIS_BILLING_UBL_CREDIT_NOTE_V3","PEPPOL_MESSAGE_LEVEL_RESPONSE_TRANSACTION_3_0","PEPPOL_INVOICE_RESPONSE_TRANSACTION_3_0"],"peppolRegistration":true}}]},{"legalEntityId":2,"legalEntityDetails":{"publishInPeppolDirectory":true,"name":"Your company","creationDate":"2024-02-01T10:00:00.000","registrationDate":"2023-08-24T14:15:22.000","countryCode":"BE","geographicalInformation":"204 My street, My City, My Country","websiteURL":"https://example.com","contacts":[{"contactType":"public","name":"Your company name","phoneNumber":"+32 123456","email":"info@example.com"}],"additionalInformation":"Our company is specialized in ..."},"peppolRegistrations":[{"peppolRegistrationId":3,"creationDate":"2024-02-01T10:05:00.000","peppolRegistrationDetails":{"peppolIdentifier":{"scheme":"0208","identifier":"123456789"},"supportedDocuments":["PEPPOL_BIS_BILLING_UBL_INVOICE_V3","PEPPOL_BIS_BILLING_UBL_CREDIT_NOTE_V3","PEPPOL_MESSAGE_LEVEL_RESPONSE_TRANSACTION_3_0","PEPPOL_INVOICE_RESPONSE_TRANSACTION_3_0"],"peppolRegistration":true}}]}]}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]},"post":{"tags":["Legal Entity"],"summary":"Create a legal entity and register it in the Peppol network","description":"Create a legal entity and register it in the Peppol network. In the section Register your legal entity as a participant in the Peppol network we explain in detail how to create your legal entity. For a French 0225 identifier used only for sending, see Register a France 0225 identifier for sending only.","operationId":"createLegalEntity","parameters":[{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Legal entity registration examples","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntityCreateRequestRO"},"examples":{"Create legal entity and register it in the Peppol network example":{"description":"Create legal entity and register it in the Peppol network example","value":{"legalEntityDetails":{"additionalInformation":"Our company is specialized in ...","contacts":[{"contactType":"public","email":"info@example.com","name":"Your company name","phoneNumber":"+32 123456"}],"countryCode":"BE","geographicalInformation":"204 My street, My City, My Country","name":"Ademico Software","peppolAdditionalIdentifiers":[{"identifier":"0552912569","scheme":"0208"}],"legalIdentifiers":[{"scheme":"9925","identifier":"BE0552912569"}],"publishInPeppolDirectory":true,"registrationDate":"2019-08-24T14:15:22.000","websiteURL":"https://ademico-software.com"},"peppolRegistrations":[{"peppolIdentifier":{"identifier":"0552912569","scheme":"0208"},"peppolRegistration":true,"supportedDocuments":["PEPPOL_BIS_BILLING_UBL_INVOICE_V3","PEPPOL_BIS_BILLING_UBL_CREDIT_NOTE_V3","PEPPOL_MESSAGE_LEVEL_RESPONSE_TRANSACTION_3_0","PEPPOL_INVOICE_RESPONSE_TRANSACTION_3_0"]}]}},"Create French legal entity with a sender-only 0225 registration":{"description":"Create French legal entity with a sender-only 0225 registration","value":{"legalEntityDetails":{"name":"Example Company","countryCode":"FR","legalIdentifiers":[{"scheme":"0002","identifier":"123456789"}],"publishInPeppolDirectory":false},"peppolRegistrations":[{"peppolIdentifier":{"scheme":"0225","identifier":"123456789_SENDER"},"supportedDocuments":["FR_CDAR_REGULATED"],"peppolRegistration":true}]}},"Create legal entity without registering it in the Peppol network example":{"description":"Create legal entity without registering it in the Peppol network example","value":{"legalEntityDetails":{"publishInPeppolDirectory":true,"name":"Ademico Software","countryCode":"BE","geographicalInformation":"204 My street, My City, My Country","registrationDate":"2019-08-24T14:15:22.000","websiteURL":"https://ademico-software.com","contacts":[{"contactType":"public","name":"Your company name","phoneNumber":"+32 123456","email":"info@example.com"}],"additionalInformation":"Our company is specialized in ...","peppolAdditionalIdentifiers":[{"scheme":"0208","identifier":"0552912569"}]}}}}}},"required":true},"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"Legal entity created and registered in Peppol successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntityCreateResponseRO"},"example":{"legalEntityId":0}}}},"400":{"description":"Error creating legal entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"LEGAL_ENTITY_ERROR","message":"Error creating legal entity"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/legal-entities/{legalEntityId}/peppol-registrations":{"get":{"tags":["Legal Entity Peppol Registration"],"summary":"Get the list of Peppol registrations for a legal entity","description":"You get a list of Peppol registrations with the following details:- The scheme and identifier of the legal entity in the Peppol network eg 0208:0552912569
- The list of Peppol supported documents the legal entity can send and receive eg PEPPOL_BIS_BILLING_UBL_INVOICE_V3
","operationId":"getPeppolRegistrationsForLegalEntity","parameters":[{"name":"legalEntityId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"peppolRegistrationId","in":"query","description":"The id of the Peppol registration","required":false,"schema":{"type":"integer","format":"int64"},"example":9},{"name":"peppolRegistrationScheme","in":"query","description":"The Peppol identifier scheme of the legal entity","required":false,"schema":{"type":"string"},"example":"0208"},{"name":"peppolRegistrationIdentifier","in":"query","description":"The Peppol identifier of the legal entity","required":false,"schema":{"type":"string"},"example":"0552912569"},{"name":"peppolSupportedDocument","in":"query","description":"The document that can be received by the legal entity in the Peppol network","required":false,"schema":{"$ref":"#/components/schemas/PeppolDocumentSchemeEnumRO"},"example":"PEPPOL_BIS_BILLING_UBL_INVOICE_V3"},{"name":"page","in":"query","description":"The starting page number from which we want to retrieve results. The first page is 0.","required":false,"schema":{"type":"integer","format":"int32","default":0},"example":0},{"name":"pageSize","in":"query","description":"How many results we retrieve per page","required":false,"schema":{"type":"integer","format":"int32","default":10},"example":10},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"Peppol registrations for legal entity retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntityPeppolRegistrationListRO"},"example":{"pagination":{"count":2,"page":0,"pageSize":10},"peppolRegistrations":[{"peppolRegistrationId":1,"peppolRegistrationDetails":{"peppolIdentifier":{"scheme":"0208","identifier":"0552912569"},"supportedDocuments":["PEPPOL_BIS_BILLING_UBL_INVOICE_V3","PEPPOL_BIS_BILLING_UBL_CREDIT_NOTE_V3","PEPPOL_MESSAGE_LEVEL_RESPONSE_TRANSACTION_3_0","PEPPOL_INVOICE_RESPONSE_TRANSACTION_3_0"],"peppolRegistration":true}},{"peppolRegistrationId":1,"peppolRegistrationDetails":{"peppolIdentifier":{"scheme":"9925","identifier":"BE0552912569"},"supportedDocuments":["PEPPOL_BIS_BILLING_UBL_INVOICE_V3","PEPPOL_BIS_BILLING_UBL_CREDIT_NOTE_V3","PEPPOL_MESSAGE_LEVEL_RESPONSE_TRANSACTION_3_0","PEPPOL_INVOICE_RESPONSE_TRANSACTION_3_0"],"peppolRegistration":true}}]}}}},"400":{"description":"Error retrieving Peppol registrations for legal entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"LEGAL_ENTITY_ERROR","message":"Error retrieving Peppol registrations for legal entity"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]},"post":{"tags":["Legal Entity Peppol Registration"],"summary":"Register a legal entity in the Peppol network","description":"Register a legal entity as a participant in the Peppol network. You can have a look in the section Register your legal entity as a participant in the Peppol network for more details. For a French 0225 identifier used only for sending, see Register a France 0225 identifier for sending only.","operationId":"createPeppolRegistrationForLegalEntity","parameters":[{"name":"legalEntityId","in":"path","description":"The id of the legal entity you want to register in the Peppol network","required":true,"schema":{"type":"integer","format":"int64"},"example":7},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request to register a legal entity in the Peppol network(SML/SMP) ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntityPeppolRegistrationCreateRequestRO"},"examples":{"Peppol registration of a legal entity example":{"description":"Peppol registration of a legal entity example","value":{"peppolRegistrationDetails":{"peppolIdentifier":{"scheme":"0208","identifier":"0552912569"},"supportedDocuments":["PEPPOL_BIS_BILLING_UBL_INVOICE_V3","PEPPOL_BIS_BILLING_UBL_CREDIT_NOTE_V3","PEPPOL_MESSAGE_LEVEL_RESPONSE_TRANSACTION_3_0","PEPPOL_INVOICE_RESPONSE_TRANSACTION_3_0"],"peppolRegistration":true}}},"French sender-only 0225 Peppol registration":{"description":"French sender-only 0225 Peppol registration","value":{"peppolRegistrationDetails":{"peppolIdentifier":{"scheme":"0225","identifier":"123456789_SENDER"},"supportedDocuments":["FR_CDAR_REGULATED"],"peppolRegistration":true}}}}}},"required":true},"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"400":{"description":"Error creating Peppol registration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"LEGAL_ENTITY_ERROR","message":"Error registering legal entity in the Peppol network"}}}},"200":{"description":"Peppol registration created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntityPeppolRegistrationCreateResponseRO"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/legal-entities/{legalEntityId}/peppol-registrations/{peppolRegistrationId}/kyc/corppass/initiate":{"post":{"tags":["Legal Entity KYC(Singapore and Malaysia)"],"summary":"Singapore Corppass - Initiate the KYC process","description":"Provide the contact details to initiate the Corppass KYC process. The response contains the Corppass signing URL.","operationId":"initiateKYCCorppassForPeppolRegistration","parameters":[{"name":"legalEntityId","in":"path","description":"The id of the legal entity","required":true,"schema":{"type":"integer","format":"int64"},"example":7},{"name":"peppolRegistrationId","in":"path","description":"The id of the Peppol registration for which you want to initiate the Corppass KYC process","required":true,"schema":{"type":"integer","format":"int64"},"example":1},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request to initiate the KYC process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntityKycCorpassInitiateRequestRO"},"examples":{"KYC Corppass request example":{"description":"KYC Corppass request example","value":{"signerName":"John Doe","signerEmail":"john.doe@example.com"}}}}},"required":true},"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"Corppass KYC initiated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntityKycCorpassInitiateResponseRO"}}}},"400":{"description":"Error initiating Corppass KYC request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"LEGAL_ENTITY_ERROR","message":"Error initiating KYC in Corppass"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/legal-entities/{legalEntityId}/peppol-registrations/{peppolRegistrationId}/kyc/corppass/cancel":{"post":{"tags":["Legal Entity KYC(Singapore and Malaysia)"],"summary":"Singapore Corppass - Cancel the KYC process","description":"Cancel an initiated Corppass KYC process","operationId":"cancelKYCCorppassPendingActivationForPeppolRegistration","parameters":[{"name":"legalEntityId","in":"path","description":"The id of the legal entity","required":true,"schema":{"type":"integer","format":"int64"},"example":7},{"name":"peppolRegistrationId","in":"path","description":"The id of the Peppol registration for which you want to cancel the Corppass KYC process","required":true,"schema":{"type":"integer","format":"int64"},"example":1},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Error cancelling Corppass KYC request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"LEGAL_ENTITY_ERROR","message":"Error cancelling KYC in Corppass"}}}},"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"Corppass KYC cancelled successfully."}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/legal-entities/{legalEntityId}/peppol-registrations/{peppolRegistrationId}/c5/corppass/deactivate":{"post":{"tags":["Legal Entity C5 Singapore"],"summary":"Singapore - Initiate C5 deactivation","description":"Provide the contact details to initiate the Corppass C5 deactivation. You will receive an email with instructions to complete the Corppass C5 deactivation","operationId":"initiateC5CorppassDeactivation","parameters":[{"name":"legalEntityId","in":"path","description":"The id of the legal entity","required":true,"schema":{"type":"integer","format":"int64"},"example":7},{"name":"peppolRegistrationId","in":"path","description":"The id of the Peppol registration for which you want to initiate the Corppass C5 deactivation","required":true,"schema":{"type":"integer","format":"int64"},"example":1},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request to initiate the C5 deactivation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntityC5CorpassDeactivateRequestRO"},"examples":{"C5 Corppass deactivation request example":{"description":"C5 Corppass deactivation request example","value":{"signerName":"John Doe","signerEmail":"john.doe@example.com"}}}}},"required":true},"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"400":{"description":"Error initiating Corppass C5 deactivation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"LEGAL_ENTITY_ERROR","message":"Error initiating C5 in Corppass"}}}},"200":{"description":"Corppass C5 deactivation requested successfully."}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/legal-entities/{legalEntityId}/peppol-registrations/{peppolRegistrationId}/c5/corppass/cancel":{"post":{"tags":["Legal Entity C5 Singapore"],"summary":"Singapore - Cancel the C5 activation or deactivation","description":"Cancel an initiated Corppass C5 activation or deactivation","operationId":"cancelC5CorppassPendingActivationOrDeactivation","parameters":[{"name":"legalEntityId","in":"path","description":"The id of the legal entity","required":true,"schema":{"type":"integer","format":"int64"},"example":7},{"name":"peppolRegistrationId","in":"path","description":"The id of the Peppol registration for which you want to cancel the Corppass activation or deactivation process","required":true,"schema":{"type":"integer","format":"int64"},"example":1},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Error cancelling Corppass C5 activation/deactivation request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"LEGAL_ENTITY_ERROR","message":"Error cancelling C5 in Corppass"}}}},"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"Corppass C5 cancelled successfully."}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/legal-entities/{legalEntityId}/peppol-registrations/{peppolRegistrationId}/c5/corppass/activate":{"post":{"tags":["Legal Entity C5 Singapore"],"summary":"Singapore - Initiate C5 activation","description":"Provide the contact details to initiate the Corppass C5 activation. The response contains the Corppass signing URL.","operationId":"initiateC5CorppassActivation","parameters":[{"name":"legalEntityId","in":"path","description":"The id of the legal entity","required":true,"schema":{"type":"integer","format":"int64"},"example":7},{"name":"peppolRegistrationId","in":"path","description":"The id of the Peppol registration for which you want to initiate the Corppass C5 activation","required":true,"schema":{"type":"integer","format":"int64"},"example":1},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request to initiate the C5 activation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntityC5CorpassActivateRequestRO"},"examples":{"C5 Corppass activation request example":{"description":"C5 Corppass activation request example","value":{"signerName":"John Doe","signerEmail":"john.doe@example.com"}}}}},"required":true},"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"400":{"description":"Error initiating Corppass C5 activation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"LEGAL_ENTITY_ERROR","message":"Error initiating C5 in Corppass"}}}},"200":{"description":"Corppass C5 initiated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntityC5CorpassActivateResponseRO"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/invoices/{transmissionId}/cdar":{"get":{"tags":["France CDAR"],"summary":"Get a CDAR document","description":"Get the content of a sent or received CDAR document in XML format. ","operationId":"getCdarInXmlFormat","parameters":[{"name":"transmissionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Authentication failure","content":{"application/xml;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"CDAR XML retrieved successfully","content":{"application/xml":{"schema":{"type":"string"},"example":"\n\n \n \n \n \n S1\n \n \n \n \n urn.cpro.gouv.fr:1p0:CDV:einvoicingF2\n \n \n \n \n \n UC1-02-CDV-DEPOSEE\n \n Cycle de vie - Facture déposée\n \n \n \n 20230101180000\n \n \n \n \n 1111\n \n WK\n \n \n \n \n 1111\n \n WK\n \n \n \n \n 0000\n \n DFH\n \n \n \n \n \n \n \n false\n \n \n \n \n 20230101170000\n \n \n \n \n pbe000512-8\n \n 380\n \n \n \n 20230101150000\n \n \n urn.cpro.gouv.fr:1p0:CDV:einvoicingF2\n \n \n \n 20230101120000\n \n \n 200\n \n Déposée\n \n \n \n 100000009\n \n SE\n \n \n \n \n\n"}}},"400":{"description":"Error retrieving the CDAR XML ","content":{"application/xml;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]},"post":{"tags":["France CDAR"],"summary":"Send a CDAR (Cross Domain Acknowledgement and Response) to the counterparty","description":"Send a CDAR document for the referenced invoice/credit note. This endpoint is used both by the Buyer to send a CDAR to the Seller (eg when the invoice is approved or refused or paid) and by the Seller to send a CDAR status update to the Buyer (eg payment collected). The CDAR document is built based on the provided information in the request and then scheduled in the queue to be sent to the counterparty. You are notified either via pull or push mechanism when the CDAR document has been received by the counterparty.","operationId":"sendCDAR","parameters":[{"name":"transmissionId","in":"path","description":"The transmission ID of the invoice/credit note referenced by this CDAR document","required":true,"schema":{"type":"string"}},{"name":"X-C5-REPORTING","in":"header","description":"The HTTP header `X-C5-REPORTING` is a flag that specifies whether the reporting to C5 (i.e. the country‑specific fiscal authority) will be done automatically once we successfully send the document to the receiver. This is currently available for France and Singapore. Please find below the default value for specific countries.• France: true. For France C5 is PPF. If you do not set this flag, we will report the submission to C5 automatically after the document was sent to the receiver. If you set this flag to false, we will not automatically report to C5. • Singapore: false. For Singapore C5 is IRAS. If you do not set this flag, we will not report the submission to C5 automatically after the document was sent to the receiver. If you set this flag to true, we will report the submission to C5 automatically after the document was sent to the receiver.","required":false,"schema":{"type":"boolean"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request to send a CDAR referencing an existing document (invoice or credit note). The CDAR document is built based on the provided information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CdarRO"},"examples":{"Invoice disputed - corrective invoice":{"description":"Invoice disputed - corrective invoice","value":{"id":"F202500006-207","issuer":{"globalId":"0225:100000010","name":"Buyer"},"recipient":{"globalId":"0225:100000009","name":"Seller"},"referencedDocument":{"id":"F202500006","typeCode":"380","issueDate":"2025-07-01T00:00:00","receiptDateTime":"2025-07-01T16:10:00","status":"FR_IN_DISPUTE","issuer":{"globalId":"0225:100000009","legalId":"0002:100000009","name":"Seller"},"detailedStatuses":[{"reasonCode":"TX_TVA_ERR","reasonText":"Taux de TVA erroné","requestedActionCode":"NIN","requestedAction":"Créer une Facture Rectificative","sequenceNumber":1,"documentCharacteristics":[{"id":"BT-152","typeCode":"DIV","valueChanged":true,"name":"Taux TVA","location":"/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent","valuePercent":10.0},{"id":"BT-152","typeCode":"DVA","valueChanged":true,"name":"Taux TVA","location":"/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent","valuePercent":20.0}],"notes":[{"contentCode":"G1.24","content":"The invoiced VAT rate is 10%; the expected rate is 20%.","subjectCode":"ram:RateApplicablePercent"}]}]},"notes":[{"contentCode":"G1.24","content":"Buyer dispute concerning the VAT rate.","subjectCode":"ram:RateApplicablePercent"}]}},"Invoice disputed - full credit note":{"description":"Invoice disputed - full credit note","value":{"id":"F202500007-207","issuer":{"globalId":"0225:100000010","name":"Buyer"},"recipient":{"globalId":"0225:100000009","name":"Seller"},"referencedDocument":{"id":"F202500007","typeCode":"380","issueDate":"2025-07-02T00:00:00","receiptDateTime":"2025-07-02T17:10:00","status":"FR_IN_DISPUTE","issuer":{"globalId":"0225:100000009","legalId":"0002:100000009","name":"Seller"},"detailedStatuses":[{"reasonCode":"TX_TVA_ERR","reasonText":"Taux de TVA erroné","requestedActionCode":"CNF","requestedAction":"Créer un Avoir total","sequenceNumber":1,"documentCharacteristics":[{"id":"BT-152","typeCode":"DIV","valueChanged":true,"name":"Taux TVA","location":"/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent","valuePercent":10.0},{"id":"BT-152","typeCode":"DVA","valueChanged":true,"name":"Taux TVA","location":"/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent","valuePercent":20.0}]}]}}},"Invoice approved":{"description":"Invoice approved","value":{"id":"INV123_205","issuer":{"globalId":"0225:0552912569","name":"Buyer Company"},"recipient":{"globalId":"0225:123456789","name":"Seller Company"},"referencedDocument":{"id":"INV123","typeCode":"380","issueDate":"2025-11-20T00:00:00","receiptDateTime":"2025-11-21T10:00:00","status":"FR_APPROVED","issuer":{"globalId":"0225:123456789","legalId":"0002:123456789","name":"Seller Company"}},"notes":[{"content":"This is a CDAR response indicating that the invoice has been approved."},{"content":"Second note providing additional context about the approval."}]}}}}},"required":true},"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"The CDAR document has been scheduled in the queue to be sent to the counterparty. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentSubmissionResultRO"},"example":{"transmissionId":"4a4f4540458211f1af51005056c00001","documentId":"INV123_205","documentTypeEnum":"CDAR_RESPONSE","sender":"0225:0552912569","receiver":"0225:123456789","sbdhInstanceIdentifier":"4a4f453f458211f1af51005056c00001"}}}},"400":{"description":"Error sending the CDAR document to the counterparty","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"GENERIC_ERROR","message":"Error sending Invoice Response"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/invoices/ubl-submissions":{"post":{"tags":["Invoice/Credit Note"],"summary":"Send an UBL invoice/credit note to the receiver","description":"The invoice/credit note is scheduled in the queue to be sent to the receiver. The UBL is validated before is being sent.You get notified either via pull or push mechanism when the invoice/credit note has be received by the receiver. For a standard invoice/credit note, the Seller sends the document to the Buyer. For a self-billing invoice or credit note, the Buyer sends the document to the Seller.","operationId":"submitUblFile","parameters":[{"name":"X-C5-REPORTING","in":"header","description":"The HTTP header `X-C5-REPORTING` is a flag that specifies whether the reporting to C5 (i.e. the country‑specific fiscal authority) will be done automatically once we successfully send the document to the receiver. This is currently available for France and Singapore. Please find below the default value for specific countries.• France: true. For France C5 is PPF. If you do not set this flag, we will report the submission to C5 automatically after the document was sent to the receiver. If you set this flag to false, we will not automatically report to C5. • Singapore: false. For Singapore C5 is IRAS. If you do not set this flag, we will not report the submission to C5 automatically after the document was sent to the receiver. If you set this flag to true, we will report the submission to C5 automatically after the document was sent to the receiver.","required":false,"schema":{"type":"boolean"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The invoice or credit note in UBL XML format","format":"binary"}}}}}},"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"400":{"description":"Error sending the UBL invoice/credit note to the receiver. In this case the UBL invoice/credit note is not sent to the receiver. Examples of cases when you get an error: - The submitted file does not contain an UBL invoice/credit note
- The XML validation, XSD validation or Schematron validation fails.
- The receiver is not registered in the Peppol network or it doesn't support receiving the provided UBL invoice/credit note
","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSubmissionResultError"},"examples":{"Validation error":{"description":"Validation error","value":{"message":{"code":"SCHEMATRON_VALIDATION_ERROR","message":"The Schematron validation failed has failed for document [invoice.xml]"},"validationReport":{"globalStatus":"ERROR","validatedXmlName":"invoice.xml","xmlValidationReport":{"validatedWith":"invoice.xml","reportStatus":"SUCCESS","warningsCount":0,"errorsCount":0,"xmlValidationMessages":[],"validationType":"XML_SYNTAX"},"xsdValidationReport":{"validatedWith":"UBL-Invoice-2.1.xsd","reportStatus":"SUCCESS","warningsCount":0,"errorsCount":0,"xsdValidationMessages":[],"validationType":"XSD_SCHEMA"},"schematronValidationReport":[{"validatedWith":"EN16931-UBL-validation.xslt","reportStatus":"ERROR","warningsCount":0,"errorsCount":2,"schematronValidationMessages":[{"errorLevel":"ERROR","description":"[BR-CO-15]-Invoice total amount with VAT (BT-112) = Invoice total amount without VAT (BT-109) + Invoice total VAT amount (BT-110).","lineNumber":3,"columnNumber":73,"schematronTest":"every $Currency in cbc:DocumentCurrencyCode satisfies (count(cac:TaxTotal/xs:decimal(cbc:TaxAmount[@currencyID=$Currency])) eq 1) and (cac:LegalMonetaryTotal/xs:decimal(cbc:TaxInclusiveAmount) = round( (cac:LegalMonetaryTotal/xs:decimal(cbc:TaxExclusiveAmount) + cac:TaxTotal/xs:decimal(cbc:TaxAmount[@currencyID=$Currency])) * 10 * 10) div 100)","errorId":"BR-CO-15","xpath":"/*:Invoice[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:Invoice-2'][1]"},{"errorLevel":"ERROR","description":"[BR-CO-14]-Invoice total VAT amount (BT-110) = Σ VAT category tax amount (BT-117).","lineNumber":130,"columnNumber":19,"schematronTest":"(xs:decimal(child::cbc:TaxAmount)= round((sum(cac:TaxSubtotal/xs:decimal(cbc:TaxAmount)) * 10 * 10)) div 100) or not(cac:TaxSubtotal)","errorId":"BR-CO-14","xpath":"/*:Invoice[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:Invoice-2'][1]/*:TaxTotal[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2'][1]"}],"validationType":"SCHEMATRON"}],"warningsCount":0,"errorsCount":2,"xmlContent":"\n urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0\n urn:fdc:peppol.eu:2017:poacc:billing:01:1.0\n pbe000512-8\n 2022-05-19\n 2022-06-19\n 380\n EUR\n 4025:123:4343\n 0150abc\n \n test-ademico-001\n test-ademico-001\n \n \n \n 0552912569\n \n 0552912569\n \n \n Ademico Software\n \n \n Heidebergstraat 204\n Kessel-Lo\n 3010\n \n BE\n \n \n \n BE0552912569\n \n VAT\n \n \n \n Ademico Software\n 0552912569\n \n \n info@ademico-software.com\n \n \n \n\n \n \n 1999999943\n \n 1999999943\n \n \n Company name\n \n \n Simon Bolivarlaan\n Brussel\n 1000\n \n BE\n \n \n \n BE1999999943\n \n VAT\n \n \n \n Company name\n 1999999943\n \n \n info@example.com\n \n \n \n \n 2017-11-01\n \n 9483759475923478\n \n Delivery street 2\n Building 56\n Stockholm\n 21234\n \n SE\n \n \n \n \n \n Delivery party Name\n \n \n \n \n 30\n Snippet1\n \n IBAN32423940\n AccountName\n \n BIC324098\n \n \n \n \n Payment within 10 days, 2% discount\n \n \n true\n Insurance\n 10\n \n E\n 0\n \n VAT\n \n \n \n \n \n 310.09\n \n 1481.4\n 311.09\n \n S\n 21.0\n \n VAT\n \n \n \n \n 30\n 0\n \n E\n 0\n VATEX-EU-F\n \n VAT\n \n \n \n \n \n 1501.4\n 1511.4\n 1822.49\n 10\n 1822.49\n \n\n \n 1\n 2\n 20\n Consulting Fees\n \n test-ademico-001\n \n \n TEST 0%\n TEST 0%\n \n 21382183120983\n \n \n NO\n \n \n 09348023\n \n \n E\n 0\n \n VAT\n \n \n \n \n 10\n \n \n \n 2\n 12\n 1481.4\n \n test-ademico-001\n \n \n Description 2\n TEST 21%\n \n 21382183120983\n \n \n NO\n \n \n 09348023\n \n \n S\n 21.0\n \n VAT\n \n \n \n \n 123.45\n \n \n"}}}}}}},"200":{"description":"The invoice/credit note has been scheduled in the queue to be sent to the receiver.You get notified either via pull or push mechanism when the invoice/credit note has be received by the receiver. Please check for more details in the notification sections.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentSubmissionResultRO"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/invoices/facturx-submissions":{"post":{"tags":["Invoice/Credit Note"],"summary":"Send a Factur-X invoice/credit note to the receiver","description":"The invoice/credit note is scheduled in the queue to be sent to the receiver. The Factur-X is validated before is being sent.You get notified either via pull or push mechanism when the invoice/credit note has be received by the receiver. For a standard invoice/credit note, the Seller sends the document to the Buyer. For a self-billing invoice or credit note, the Buyer sends the document to the Seller.","operationId":"submitFacturXFile","parameters":[{"name":"X-C5-REPORTING","in":"header","description":"The HTTP header `X-C5-REPORTING` is a flag that specifies whether the reporting to C5 (i.e. the country‑specific fiscal authority) will be done automatically once we successfully send the document to the receiver. This is currently available for France and Singapore. Please find below the default value for specific countries.• France: true. For France C5 is PPF. If you do not set this flag, we will report the submission to C5 automatically after the document was sent to the receiver. If you set this flag to false, we will not automatically report to C5. • Singapore: false. For Singapore C5 is IRAS. If you do not set this flag, we will not report the submission to C5 automatically after the document was sent to the receiver. If you set this flag to true, we will report the submission to C5 automatically after the document was sent to the receiver.","required":false,"schema":{"type":"boolean"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The invoice or credit note as a Factur-X PDF (EN16931 or Extended profile)","format":"binary"}}}}}},"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"400":{"description":"Error sending the Factur-X invoice/credit note to the receiver. In this case the Factur-X invoice/credit note is not sent to the receiver. Examples of cases when you get an error: - The submitted file does not contain a Factur-X invoice/credit note
- The XML validation, XSD validation or Schematron validation fails.
- The receiver is not registered in the Peppol network or it doesn't support receiving the this particular type of invoice/credit note
","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSubmissionResultError"},"examples":{"Validation error":{"description":"Validation error","value":{"message":{"code":"SCHEMATRON_VALIDATION_ERROR","message":"The Schematron validation failed has failed for document [invoice.xml]"},"validationReport":{"globalStatus":"ERROR","validatedXmlName":"invoice.xml","xmlValidationReport":{"validatedWith":"invoice.xml","reportStatus":"SUCCESS","warningsCount":0,"errorsCount":0,"xmlValidationMessages":[],"validationType":"XML_SYNTAX"},"xsdValidationReport":{"validatedWith":"UBL-Invoice-2.1.xsd","reportStatus":"SUCCESS","warningsCount":0,"errorsCount":0,"xsdValidationMessages":[],"validationType":"XSD_SCHEMA"},"schematronValidationReport":[{"validatedWith":"EN16931-UBL-validation.xslt","reportStatus":"ERROR","warningsCount":0,"errorsCount":2,"schematronValidationMessages":[{"errorLevel":"ERROR","description":"[BR-CO-15]-Invoice total amount with VAT (BT-112) = Invoice total amount without VAT (BT-109) + Invoice total VAT amount (BT-110).","lineNumber":3,"columnNumber":73,"schematronTest":"every $Currency in cbc:DocumentCurrencyCode satisfies (count(cac:TaxTotal/xs:decimal(cbc:TaxAmount[@currencyID=$Currency])) eq 1) and (cac:LegalMonetaryTotal/xs:decimal(cbc:TaxInclusiveAmount) = round( (cac:LegalMonetaryTotal/xs:decimal(cbc:TaxExclusiveAmount) + cac:TaxTotal/xs:decimal(cbc:TaxAmount[@currencyID=$Currency])) * 10 * 10) div 100)","errorId":"BR-CO-15","xpath":"/*:Invoice[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:Invoice-2'][1]"},{"errorLevel":"ERROR","description":"[BR-CO-14]-Invoice total VAT amount (BT-110) = Σ VAT category tax amount (BT-117).","lineNumber":130,"columnNumber":19,"schematronTest":"(xs:decimal(child::cbc:TaxAmount)= round((sum(cac:TaxSubtotal/xs:decimal(cbc:TaxAmount)) * 10 * 10)) div 100) or not(cac:TaxSubtotal)","errorId":"BR-CO-14","xpath":"/*:Invoice[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:Invoice-2'][1]/*:TaxTotal[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2'][1]"}],"validationType":"SCHEMATRON"}],"warningsCount":0,"errorsCount":2,"xmlContent":"\n urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0\n urn:fdc:peppol.eu:2017:poacc:billing:01:1.0\n pbe000512-8\n 2022-05-19\n 2022-06-19\n 380\n EUR\n 4025:123:4343\n 0150abc\n \n test-ademico-001\n test-ademico-001\n \n \n \n 0552912569\n \n 0552912569\n \n \n Ademico Software\n \n \n Heidebergstraat 204\n Kessel-Lo\n 3010\n \n BE\n \n \n \n BE0552912569\n \n VAT\n \n \n \n Ademico Software\n 0552912569\n \n \n info@ademico-software.com\n \n \n \n\n \n \n 1999999943\n \n 1999999943\n \n \n Company name\n \n \n Simon Bolivarlaan\n Brussel\n 1000\n \n BE\n \n \n \n BE1999999943\n \n VAT\n \n \n \n Company name\n 1999999943\n \n \n info@example.com\n \n \n \n \n 2017-11-01\n \n 9483759475923478\n \n Delivery street 2\n Building 56\n Stockholm\n 21234\n \n SE\n \n \n \n \n \n Delivery party Name\n \n \n \n \n 30\n Snippet1\n \n IBAN32423940\n AccountName\n \n BIC324098\n \n \n \n \n Payment within 10 days, 2% discount\n \n \n true\n Insurance\n 10\n \n E\n 0\n \n VAT\n \n \n \n \n \n 310.09\n \n 1481.4\n 311.09\n \n S\n 21.0\n \n VAT\n \n \n \n \n 30\n 0\n \n E\n 0\n VATEX-EU-F\n \n VAT\n \n \n \n \n \n 1501.4\n 1511.4\n 1822.49\n 10\n 1822.49\n \n\n \n 1\n 2\n 20\n Consulting Fees\n \n test-ademico-001\n \n \n TEST 0%\n TEST 0%\n \n 21382183120983\n \n \n NO\n \n \n 09348023\n \n \n E\n 0\n \n VAT\n \n \n \n \n 10\n \n \n \n 2\n 12\n 1481.4\n \n test-ademico-001\n \n \n Description 2\n TEST 21%\n \n 21382183120983\n \n \n NO\n \n \n 09348023\n \n \n S\n 21.0\n \n VAT\n \n \n \n \n 123.45\n \n \n"}}}}}}},"200":{"description":"The invoice/credit note has been scheduled in the queue to be sent to the receiver.You get notified either via pull or push mechanism when the invoice/credit note has be received by the receiver. Please check for more details in the notification sections.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentSubmissionResultRO"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/invoices/cii-submissions":{"post":{"tags":["Invoice/Credit Note"],"summary":"Send a CII invoice/credit note to the receiver","description":"The invoice/credit note is scheduled in the queue to be sent to the receiver. The CII is validated before is being sent.You get notified either via pull or push mechanism when the invoice/credit note has be received by the receiver. For a standard invoice/credit note, the Seller sends the document to the Buyer. For a self-billing invoice or credit note, the Buyer sends the document to the Seller.","operationId":"submitCiiFile","parameters":[{"name":"X-C5-REPORTING","in":"header","description":"The HTTP header `X-C5-REPORTING` is a flag that specifies whether the reporting to C5 (i.e. the country‑specific fiscal authority) will be done automatically once we successfully send the document to the receiver. This is currently available for France and Singapore. Please find below the default value for specific countries.• France: true. For France C5 is PPF. If you do not set this flag, we will report the submission to C5 automatically after the document was sent to the receiver. If you set this flag to false, we will not automatically report to C5. • Singapore: false. For Singapore C5 is IRAS. If you do not set this flag, we will not report the submission to C5 automatically after the document was sent to the receiver. If you set this flag to true, we will report the submission to C5 automatically after the document was sent to the receiver.","required":false,"schema":{"type":"boolean"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The invoice or credit note in CII XML format","format":"binary"}}}}}},"responses":{"400":{"description":"Error sending the CII invoice/credit note to the receiver. In this case the CII invoice/credit note is not sent to the receiver. Examples of cases when you get an error: - The submitted file does not contain a CII invoice/credit note
- The XML validation, XSD validation or Schematron validation fails.
- The receiver is not registered in the Peppol network or it doesn't support receiving the this particular type of invoice/credit note
","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSubmissionResultError"},"examples":{"Validation error":{"description":"Validation error","value":{"message":{"code":"SCHEMATRON_VALIDATION_ERROR","message":"The Schematron validation failed has failed for document [invoice.xml]"},"validationReport":{"globalStatus":"ERROR","validatedXmlName":"invoice.xml","xmlValidationReport":{"validatedWith":"invoice.xml","reportStatus":"SUCCESS","warningsCount":0,"errorsCount":0,"xmlValidationMessages":[],"validationType":"XML_SYNTAX"},"xsdValidationReport":{"validatedWith":"UBL-Invoice-2.1.xsd","reportStatus":"SUCCESS","warningsCount":0,"errorsCount":0,"xsdValidationMessages":[],"validationType":"XSD_SCHEMA"},"schematronValidationReport":[{"validatedWith":"EN16931-UBL-validation.xslt","reportStatus":"ERROR","warningsCount":0,"errorsCount":2,"schematronValidationMessages":[{"errorLevel":"ERROR","description":"[BR-CO-15]-Invoice total amount with VAT (BT-112) = Invoice total amount without VAT (BT-109) + Invoice total VAT amount (BT-110).","lineNumber":3,"columnNumber":73,"schematronTest":"every $Currency in cbc:DocumentCurrencyCode satisfies (count(cac:TaxTotal/xs:decimal(cbc:TaxAmount[@currencyID=$Currency])) eq 1) and (cac:LegalMonetaryTotal/xs:decimal(cbc:TaxInclusiveAmount) = round( (cac:LegalMonetaryTotal/xs:decimal(cbc:TaxExclusiveAmount) + cac:TaxTotal/xs:decimal(cbc:TaxAmount[@currencyID=$Currency])) * 10 * 10) div 100)","errorId":"BR-CO-15","xpath":"/*:Invoice[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:Invoice-2'][1]"},{"errorLevel":"ERROR","description":"[BR-CO-14]-Invoice total VAT amount (BT-110) = Σ VAT category tax amount (BT-117).","lineNumber":130,"columnNumber":19,"schematronTest":"(xs:decimal(child::cbc:TaxAmount)= round((sum(cac:TaxSubtotal/xs:decimal(cbc:TaxAmount)) * 10 * 10)) div 100) or not(cac:TaxSubtotal)","errorId":"BR-CO-14","xpath":"/*:Invoice[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:Invoice-2'][1]/*:TaxTotal[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2'][1]"}],"validationType":"SCHEMATRON"}],"warningsCount":0,"errorsCount":2,"xmlContent":"\n urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0\n urn:fdc:peppol.eu:2017:poacc:billing:01:1.0\n pbe000512-8\n 2022-05-19\n 2022-06-19\n 380\n EUR\n 4025:123:4343\n 0150abc\n \n test-ademico-001\n test-ademico-001\n \n \n \n 0552912569\n \n 0552912569\n \n \n Ademico Software\n \n \n Heidebergstraat 204\n Kessel-Lo\n 3010\n \n BE\n \n \n \n BE0552912569\n \n VAT\n \n \n \n Ademico Software\n 0552912569\n \n \n info@ademico-software.com\n \n \n \n\n \n \n 1999999943\n \n 1999999943\n \n \n Company name\n \n \n Simon Bolivarlaan\n Brussel\n 1000\n \n BE\n \n \n \n BE1999999943\n \n VAT\n \n \n \n Company name\n 1999999943\n \n \n info@example.com\n \n \n \n \n 2017-11-01\n \n 9483759475923478\n \n Delivery street 2\n Building 56\n Stockholm\n 21234\n \n SE\n \n \n \n \n \n Delivery party Name\n \n \n \n \n 30\n Snippet1\n \n IBAN32423940\n AccountName\n \n BIC324098\n \n \n \n \n Payment within 10 days, 2% discount\n \n \n true\n Insurance\n 10\n \n E\n 0\n \n VAT\n \n \n \n \n \n 310.09\n \n 1481.4\n 311.09\n \n S\n 21.0\n \n VAT\n \n \n \n \n 30\n 0\n \n E\n 0\n VATEX-EU-F\n \n VAT\n \n \n \n \n \n 1501.4\n 1511.4\n 1822.49\n 10\n 1822.49\n \n\n \n 1\n 2\n 20\n Consulting Fees\n \n test-ademico-001\n \n \n TEST 0%\n TEST 0%\n \n 21382183120983\n \n \n NO\n \n \n 09348023\n \n \n E\n 0\n \n VAT\n \n \n \n \n 10\n \n \n \n 2\n 12\n 1481.4\n \n test-ademico-001\n \n \n Description 2\n TEST 21%\n \n 21382183120983\n \n \n NO\n \n \n 09348023\n \n \n S\n 21.0\n \n VAT\n \n \n \n \n 123.45\n \n \n"}}}}}}},"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"The invoice/credit note has been scheduled in the queue to be sent to the receiver.You get notified either via pull or push mechanism when the invoice/credit note has be received by the receiver. Please check for more details in the notification sections.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentSubmissionResultRO"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/invoice-responses":{"post":{"tags":["Invoice Response"],"summary":"Send the Invoice Response back to the Seller","description":"Send the Invoice Response back to the Seller after we have received an invoice/credit note. The Invoice Response is scheduled in the queue to be sent to the Seller. You get notified either via pull or push mechanism when the Invoice Response has be received by the Seller.
An Invoice Response can be used to inform the Seller of the status of an invoice in the Buyer's approval and payment processes, based on the Buyer's business rules and/or a Seller/Buyer agreement.The following values can be used for the Invoice Response status codes:
| Code | Description |
|---|
| AB | Buyer acknowledges: Status is used when Buyer has received a readable invoice message that can be understood and submitted for processing by the Buyer. |
| IP | In process: Status is used when the processing of the Invoice has started in Buyers system. |
| UQ | Under query: Status is used when Buyer will not proceed to accept the Invoice without receiving additional information from the Seller. |
| CA | Conditionally accepted: Status is used when Buyer is accepting the Invoice under conditions stated in 'Status Reason' and proceed to pay accordingly unless disputed by Seller. |
| RE | Rejected: MLR reject or Invoice reject. Status is used only when the Buyer will not process the referenced Invoice any further. Buyer is rejecting this invoice but not necessarily the commercial transaction. Although it can be used also for rejection for commercial reasons (invoice not corresponding to delivery). |
| AP | Accepted: Status is used only when the Buyer has given a final approval of the invoice and the next step is payment. |
| PD | Paid: Fully paid or partially paid. When partially paid: Status is used together with Clarification Reason code PPD, only when the Buyer has initiated the payment of the invoice without having paid the accepted amount in full. |
You can find here more details about the Invoice Response status codes
Depending on the status code, a clarification may be needed to state the Buyer's reason for the status and/or any expected action from the Seller's side. The clarification may be given either as text (in Status Reason) or as code (in StatusReasonCode). The purpose of the clarification is to provide the Seller with structured information which enables him to partially or fully automate his processing. The clarifications are of two types:
- Reasons for the given status.
- Actions that the Buyer requests from the Seller.
The following values can be used for the clarification code reason(when clarificationType=OPStatusReason):
| Code | Description |
|---|
| NO | No issue |
| REF | References incorrect |
| LEG | Legal information incorrect |
| REC | Receiver unknown |
| QUA | Item quality insufficient |
| DEL | Delivery proposed or provided is not acceptable |
| PRI | Prices incorrect |
| QTY | Quantity incorrect |
| ITM | Items incorrect |
| PAY | Payment terms incorrect |
| UNR | Not recognized |
| FIN | Finance incorrect |
| PPD | Partially Paid |
| OTH | Other |
The following values can be used for the clarification code reason(when clarificationType=OPStatusAction):
| Code | Description |
|---|
| NOA | No action required |
| PIN | Provide information |
| NIN | Issue new invoice |
| CNF | Credit fully |
| CNP | Credit partially |
| CNA | Credit the amount |
| OTH | Other |
You can find here more details about the Invoice Response clarifications
","operationId":"sendInvoiceResponse","parameters":[{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceResponseRO"}}},"required":true},"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"The Invoice Response has been scheduled in the queue to be sent to the Seller. You get notified either via pull or push mechanism when the Invoice Response has be received by the Seller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentSubmissionResultRO"}}}},"400":{"description":"Error sending the Invoice Response to the Seller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"GENERIC_ERROR","message":"Error sending Invoice Response"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/france/facturx-generations/template":{"post":{"tags":["France Factur-X Generation"],"summary":"Generate Factur-X from the built-in France CII template","description":"Creates a sample EN16931 Factur-X invoice using fixed invoice data and the supplied routing and legal identifiers. The seller and buyer Peppol identifiers and SIRENs are required. VAT identifiers are optional; documented dummy values are used when omitted. The human-readable invoice language is optional and can be FR or EN; it defaults to FR. The generated document is returned only and is not submitted to Peppol.","operationId":"generateFromTemplate","parameters":[{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FranceFacturXTemplateGenerationRequestRO"},"example":{"seller":{"peppolIdentifier":"0225:055291256","siren":"055291256","vatIdentifier":"FR40055291256"},"buyer":{"peppolIdentifier":"0225:120283148_12028314882246","siren":"120283148"},"language":"FR"}}},"required":true},"responses":{"200":{"description":"Factur-X generated successfully","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"400":{"description":"The request identifiers are missing or invalid, or the generated CII is not valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/france/facturx-generations/from-cii":{"post":{"tags":["France Factur-X Generation"],"summary":"Generate Factur-X from a supplied CII","description":"Validates the supplied EN16931 CII and returns a Factur-X PDF/A-3 document. The readable PDF/A-1 or PDF/A-3 document is optional; when omitted, it is generated from the CII in French by default or in the requested language. When a PDF is supplied in the pdf part, it is used as the visual source for the Factur-X output and the language parameter is ignored. The generated document is not submitted to Peppol.","operationId":"generateFromCii","parameters":[{"name":"language","in":"query","description":"Language used when generating the readable PDF from the CII. Ignored when pdf is supplied","required":false,"schema":{"type":"string","default":"FR","enum":["FR","EN"]}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FranceFacturXGenerationFilesRO"}}},"required":true},"responses":{"200":{"description":"Factur-X generated successfully","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"400":{"description":"The CII is missing or invalid, or the optional PDF is not PDF/A-1 or PDF/A-3","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSubmissionResultError"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/c5/singapore/iras/sales":{"post":{"tags":["Singapore IRAS Submission"],"summary":"Send Sales Invoices/Credit Notes to IRAS.","description":"These are the documents that you have sent to your Buyers. The UBL XML is validated before is being sent.","operationId":"sendSalesToSingaporeIras","parameters":[{"name":"X-SBDH-IDENTIFIER","in":"header","description":"If you provide a value, the API will set this value in the StandardBusinessDocumentHeader->DocumentIdentification->InstanceIdentifier element.If you don't provide any value, the API will generate a random value. This value must be unique for each transmission.","required":false,"schema":{"type":"string"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The document in UBL XML format","format":"binary"}}}}}},"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"400":{"description":"Error sending the document IRAS.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSubmissionResultError"},"example":{"message":{"code":"SCHEMATRON_VALIDATION_ERROR","message":"The Schematron validation failed has failed for document [invoice.xml]"},"validationReport":{"globalStatus":"ERROR","validatedXmlName":"invoice.xml","xmlValidationReport":{"validatedWith":"invoice.xml","reportStatus":"SUCCESS","warningsCount":0,"errorsCount":0,"xmlValidationMessages":[],"validationType":"XML_SYNTAX"},"xsdValidationReport":{"validatedWith":"UBL-Invoice-2.1.xsd","reportStatus":"SUCCESS","warningsCount":0,"errorsCount":0,"xsdValidationMessages":[],"validationType":"XSD_SCHEMA"},"schematronValidationReport":[{"validatedWith":"EN16931-UBL-validation.xslt","reportStatus":"ERROR","warningsCount":0,"errorsCount":2,"schematronValidationMessages":[{"errorLevel":"ERROR","description":"[BR-CO-15]-Invoice total amount with VAT (BT-112) = Invoice total amount without VAT (BT-109) + Invoice total VAT amount (BT-110).","lineNumber":3,"columnNumber":73,"schematronTest":"every $Currency in cbc:DocumentCurrencyCode satisfies (count(cac:TaxTotal/xs:decimal(cbc:TaxAmount[@currencyID=$Currency])) eq 1) and (cac:LegalMonetaryTotal/xs:decimal(cbc:TaxInclusiveAmount) = round( (cac:LegalMonetaryTotal/xs:decimal(cbc:TaxExclusiveAmount) + cac:TaxTotal/xs:decimal(cbc:TaxAmount[@currencyID=$Currency])) * 10 * 10) div 100)","errorId":"BR-CO-15","xpath":"/*:Invoice[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:Invoice-2'][1]"},{"errorLevel":"ERROR","description":"[BR-CO-14]-Invoice total VAT amount (BT-110) = Σ VAT category tax amount (BT-117).","lineNumber":130,"columnNumber":19,"schematronTest":"(xs:decimal(child::cbc:TaxAmount)= round((sum(cac:TaxSubtotal/xs:decimal(cbc:TaxAmount)) * 10 * 10)) div 100) or not(cac:TaxSubtotal)","errorId":"BR-CO-14","xpath":"/*:Invoice[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:Invoice-2'][1]/*:TaxTotal[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2'][1]"}],"validationType":"SCHEMATRON"}],"warningsCount":0,"errorsCount":2,"xmlContent":"\n urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0\n urn:fdc:peppol.eu:2017:poacc:billing:01:1.0\n pbe000512-8\n 2022-05-19\n 2022-06-19\n 380\n EUR\n 4025:123:4343\n 0150abc\n \n test-ademico-001\n test-ademico-001\n \n \n \n 0552912569\n \n 0552912569\n \n \n Ademico Software\n \n \n Heidebergstraat 204\n Kessel-Lo\n 3010\n \n BE\n \n \n \n BE0552912569\n \n VAT\n \n \n \n Ademico Software\n 0552912569\n \n \n info@ademico-software.com\n \n \n \n\n \n \n 1999999943\n \n 1999999943\n \n \n Company name\n \n \n Simon Bolivarlaan\n Brussel\n 1000\n \n BE\n \n \n \n BE1999999943\n \n VAT\n \n \n \n Company name\n 1999999943\n \n \n info@example.com\n \n \n \n \n 2017-11-01\n \n 9483759475923478\n \n Delivery street 2\n Building 56\n Stockholm\n 21234\n \n SE\n \n \n \n \n \n Delivery party Name\n \n \n \n \n 30\n Snippet1\n \n IBAN32423940\n AccountName\n \n BIC324098\n \n \n \n \n Payment within 10 days, 2% discount\n \n \n true\n Insurance\n 10\n \n E\n 0\n \n VAT\n \n \n \n \n \n 310.09\n \n 1481.4\n 311.09\n \n S\n 21.0\n \n VAT\n \n \n \n \n 30\n 0\n \n E\n 0\n VATEX-EU-F\n \n VAT\n \n \n \n \n \n 1501.4\n 1511.4\n 1822.49\n 10\n 1822.49\n \n\n \n 1\n 2\n 20\n Consulting Fees\n \n test-ademico-001\n \n \n TEST 0%\n TEST 0%\n \n 21382183120983\n \n \n NO\n \n \n 09348023\n \n \n E\n 0\n \n VAT\n \n \n \n \n 10\n \n \n \n 2\n 12\n 1481.4\n \n test-ademico-001\n \n \n Description 2\n TEST 21%\n \n 21382183120983\n \n \n NO\n \n \n 09348023\n \n \n S\n 21.0\n \n VAT\n \n \n \n \n 123.45\n \n \n"}}}}},"200":{"description":"The document was sent successfully to IRAS.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IrasSubmissionResultRO"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/c5/singapore/iras/purchases":{"post":{"tags":["Singapore IRAS Submission"],"summary":"Send Purchase Invoices/Credit Notes to IRAS.","description":"These are the documents that you have received from your Sellers. The UBL XML is validated before is being sent.","operationId":"sendPurchasesToSingaporeIras","parameters":[{"name":"X-SBDH_IDENTIFIER","in":"header","description":"If you provide a value, the API will set this value in the StandardBusinessDocumentHeader->DocumentIdentification->InstanceIdentifier element.If you don't provide any value, the API will generate a random value","required":false,"schema":{"type":"string"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The document in UBL XML format","format":"binary"}}}}}},"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"400":{"description":"Error sending the document IRAS.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSubmissionResultError"},"example":{"message":{"code":"SCHEMATRON_VALIDATION_ERROR","message":"The Schematron validation failed has failed for document [invoice.xml]"},"validationReport":{"globalStatus":"ERROR","validatedXmlName":"invoice.xml","xmlValidationReport":{"validatedWith":"invoice.xml","reportStatus":"SUCCESS","warningsCount":0,"errorsCount":0,"xmlValidationMessages":[],"validationType":"XML_SYNTAX"},"xsdValidationReport":{"validatedWith":"UBL-Invoice-2.1.xsd","reportStatus":"SUCCESS","warningsCount":0,"errorsCount":0,"xsdValidationMessages":[],"validationType":"XSD_SCHEMA"},"schematronValidationReport":[{"validatedWith":"EN16931-UBL-validation.xslt","reportStatus":"ERROR","warningsCount":0,"errorsCount":2,"schematronValidationMessages":[{"errorLevel":"ERROR","description":"[BR-CO-15]-Invoice total amount with VAT (BT-112) = Invoice total amount without VAT (BT-109) + Invoice total VAT amount (BT-110).","lineNumber":3,"columnNumber":73,"schematronTest":"every $Currency in cbc:DocumentCurrencyCode satisfies (count(cac:TaxTotal/xs:decimal(cbc:TaxAmount[@currencyID=$Currency])) eq 1) and (cac:LegalMonetaryTotal/xs:decimal(cbc:TaxInclusiveAmount) = round( (cac:LegalMonetaryTotal/xs:decimal(cbc:TaxExclusiveAmount) + cac:TaxTotal/xs:decimal(cbc:TaxAmount[@currencyID=$Currency])) * 10 * 10) div 100)","errorId":"BR-CO-15","xpath":"/*:Invoice[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:Invoice-2'][1]"},{"errorLevel":"ERROR","description":"[BR-CO-14]-Invoice total VAT amount (BT-110) = Σ VAT category tax amount (BT-117).","lineNumber":130,"columnNumber":19,"schematronTest":"(xs:decimal(child::cbc:TaxAmount)= round((sum(cac:TaxSubtotal/xs:decimal(cbc:TaxAmount)) * 10 * 10)) div 100) or not(cac:TaxSubtotal)","errorId":"BR-CO-14","xpath":"/*:Invoice[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:Invoice-2'][1]/*:TaxTotal[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2'][1]"}],"validationType":"SCHEMATRON"}],"warningsCount":0,"errorsCount":2,"xmlContent":"\n urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0\n urn:fdc:peppol.eu:2017:poacc:billing:01:1.0\n pbe000512-8\n 2022-05-19\n 2022-06-19\n 380\n EUR\n 4025:123:4343\n 0150abc\n \n test-ademico-001\n test-ademico-001\n \n \n \n 0552912569\n \n 0552912569\n \n \n Ademico Software\n \n \n Heidebergstraat 204\n Kessel-Lo\n 3010\n \n BE\n \n \n \n BE0552912569\n \n VAT\n \n \n \n Ademico Software\n 0552912569\n \n \n info@ademico-software.com\n \n \n \n\n \n \n 1999999943\n \n 1999999943\n \n \n Company name\n \n \n Simon Bolivarlaan\n Brussel\n 1000\n \n BE\n \n \n \n BE1999999943\n \n VAT\n \n \n \n Company name\n 1999999943\n \n \n info@example.com\n \n \n \n \n 2017-11-01\n \n 9483759475923478\n \n Delivery street 2\n Building 56\n Stockholm\n 21234\n \n SE\n \n \n \n \n \n Delivery party Name\n \n \n \n \n 30\n Snippet1\n \n IBAN32423940\n AccountName\n \n BIC324098\n \n \n \n \n Payment within 10 days, 2% discount\n \n \n true\n Insurance\n 10\n \n E\n 0\n \n VAT\n \n \n \n \n \n 310.09\n \n 1481.4\n 311.09\n \n S\n 21.0\n \n VAT\n \n \n \n \n 30\n 0\n \n E\n 0\n VATEX-EU-F\n \n VAT\n \n \n \n \n \n 1501.4\n 1511.4\n 1822.49\n 10\n 1822.49\n \n\n \n 1\n 2\n 20\n Consulting Fees\n \n test-ademico-001\n \n \n TEST 0%\n TEST 0%\n \n 21382183120983\n \n \n NO\n \n \n 09348023\n \n \n E\n 0\n \n VAT\n \n \n \n \n 10\n \n \n \n 2\n 12\n 1481.4\n \n test-ademico-001\n \n \n Description 2\n TEST 21%\n \n 21382183120983\n \n \n NO\n \n \n 09348023\n \n \n S\n 21.0\n \n VAT\n \n \n \n \n 123.45\n \n \n"}}}}},"200":{"description":"The document was sent successfully to IRAS.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IrasSubmissionResultRO"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/c5/france/ppf/legal-entities/{legalEntityId}/e-reporting-submissions":{"post":{"tags":["France PPF Submission"],"summary":"Submit a France e-reporting XML to PPF.","description":"Uploads a user-provided France e-reporting XML, validates it, and submits it to PPF. The selected legal entity must be active in your workspace and match the XML reporting SIREN. Peppol registration is not required.","operationId":"submitFranceEReportingXmlForLegalEntity","parameters":[{"name":"legalEntityId","in":"path","description":"Legal entity ID in your authenticated workspace.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"France e-reporting XML file.","format":"binary"}}}}}},"responses":{"400":{"description":"The uploaded XML is malformed or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSubmissionResultError"}}}},"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}},"200":{"description":"The France e-reporting XML was submitted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/C5SubmissionResultRO"},"examples":{"Successful submission result":{"description":"Successful submission result","value":{"submissionId":"FFE1025A_PPF230_PPF2301025177737471354460","documentId":"TR123457_01022026_28022026","reporter":"0002:123456789","receiver":"PPF","status":"SUBMITTED"}}}}}},"403":{"description":"The reporting SIREN is not available in the current workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSubmissionResultError"}}}},"503":{"description":"The XML could not be submitted to PPF.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSubmissionResultError"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/c5/france/ppf/e-invoicing-submissions/{transmissionId}":{"post":{"tags":["France PPF Submission"],"summary":"Request France PPF C5 reporting for an already sent France e-invoicing document.","description":"Requests C5 reporting for an already sent France e-invoicing document identified by its Peppol transmission id.","operationId":"requestFranceEInvoicingC5Reporting","parameters":[{"name":"transmissionId","in":"path","description":"The Peppol transmission id of the France e-invoicing submission to report to C5.","required":true,"schema":{"type":"string"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}},"202":{"description":"The France PPF C5 reporting request was accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/C5SubmissionResultRO"},"examples":{"Accepted C5 reporting request":{"description":"Accepted C5 reporting request","value":{"submissionId":"FFE1025A_PPF230_PPF2301025177711742550002","documentId":"INV-2026-001","reporter":"0225:123456789","receiver":"PPF","status":"SCHEDULED"}}}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/transport-evidences/{transmissionId}":{"get":{"tags":["Transport Evidences"],"summary":"Download Transport Evidence","description":"Downloads the transport evidence as a ZIP archive containing the non-repudiation data related to the submitted document. This transport evidence can be used as proof in case the receiver claims that the sent document was not received. The ZIP file includes: - sbdh.xml - the Standard Business Document Header (SBDH) generated by the Access Point based on the submitted document;
- envelope.xml - the AS4 SOAP envelope sent by Ademico Access Point to the receiver's Access Point;
- receipt.xml - the AS4 SOAP envelope containing the delivery receipt, which proves that the receiver's Access Point successfully received the SBDH envelope.
","operationId":"downloadTransportEvidence","parameters":[{"name":"transmissionId","in":"path","description":"The transmission ID","required":true,"schema":{"type":"string"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Authentication failure","content":{"application/zip":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"Transport evidence ZIP retrieved successfully","content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Error retrieving the transport evidence","content":{"application/zip":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/tools/documents/count":{"get":{"tags":["Statistics"],"summary":"Count documents exchanged","description":"Counts retained business-document audit records: invoices and credit notes (including self-billing and corrective variants), CII and all supported Factur-X representations, ORDER, ORDER_ADVANCED, ORDER_CHANGE, ORDER_CANCELLATION, ORDER_RESPONSE_ADVANCED, SG_ORDER_BALANCE, and France e-reporting submissions. CDAR, Invoice Response, MLR/MLS, technical acknowledgements, notifications, envelopes and statistics reports are excluded. Each matching audit record counts: submitting the same invoice five times counts as five. Multiple audit records sharing a transmission ID are counted separately. France e-reporting counts one persisted report submission, regardless of its transaction/payment row count or PPF archive. Date filters include both boundaries and use each record's audit timestamp.","operationId":"countDocuments","parameters":[{"name":"startDateTime","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"endDateTime","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"peppolIdentifier","in":"query","description":"Optional Peppol identifier filter in the format scheme:identifier","required":false,"schema":{"type":"string"},"example":"0208:0552912569"},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}},"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCountRO"},"example":{"documentCount":12}}}},"400":{"description":"Error performing operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/tools/connectivity":{"get":{"tags":["Connectivity"],"summary":"Check access to our service","description":"If you get a status `200` it means that you have access, status `401` means that your authentication credentials are not correct.","operationId":"testConnectivity","parameters":[{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Connectivity test successful"},"401":{"description":"Connectivity test failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/sg-order-balances/{transmissionId}/ubl":{"get":{"tags":["Order"],"summary":"Get an SG Order Balance in UBL format","description":"Get the content of a sent or received SG Order Balance in UBL format","operationId":"getSgOrderBalanceInUBLFormat","parameters":[{"name":"transmissionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SG Order Balance UBL XML retrieved successfully","content":{"application/xml":{"schema":{"type":"string"},"example":"\n\t\turn:fdc:imda.gov.sg:trns:order_balance:1\n\t\turn:fdc:imda.gov.sg:bis:order_balance:1\n\t\t34\n\t\t2025-02-28\n\t\t12:30:00\n\t\t348\n\t\t\n\t\tSGD\n\t\t9000012345\n\t\t\n\t\t\tOrderID321\n\t\t\t2025-01-02\n\t\t\n\t\t\n\t\t\t\n\t\t\t\tYOUR_PEPPOL_ID\n\t\t\t\t\n\t\t\t\t\tBuyers-additionalID\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\tAP Testing - Buyer\n\t\t\t\t\tUENBuyer\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\tBill\n\t\t\t\t\t5121230\n\t\t\t\t\tbuyer@buyer.com\n\t\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\tSGTSTKADVORDERING01\n\t\t\t\t\n\t\t\t\t\tVendorID\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\tGallery Photo Supplier\n\t\t\t\t\tUENSeller\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\tAvery Lee\n\t\t\t\t\t4621230\n\t\t\t\t\teinvoice@imda.gov.sg\n\t\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t6000\n\t\t\t6000\n\t\t\n\t\t\n\t\t\tFreetext note on line 1\n\t\t\t\n\t\t\t\t1\n\t\t\t\t120\n\t\t\t\t6000.00\n\t\t\t\t\n\t\t\t\t\t50.000\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\tStapler\n\t\t\t\t\n\t\t\t\n\t\t\n\t"}}},"400":{"description":"Error retrieving the SG Order Balance UBL XML ","content":{"application/xml;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/orders/{transmissionId}/ubl":{"get":{"tags":["Order"],"summary":"Get an Order in UBL format","description":"Get the content of a sent or received Order in UBL format","operationId":"getOrderInUBLFormat","parameters":[{"name":"transmissionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Error retrieving the Order UBL XML ","content":{"application/xml;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}},"200":{"description":"Order UBL XML retrieved successfully","content":{"application/xml":{"schema":{"type":"string"},"example":"\n\n\n\turn:fdc:peppol.eu:poacc:trns:order:3\n\turn:fdc:peppol.eu:poacc:bis:order_only:3\n\tpbe000512-8\n\t112233\n\t2018-09-01\n\t12:30:00\n\t220\n\tInformation text for the whole order\n\tNOK\n\t123456\n\tProject123\n\t\n\t\t2013-01-31\n\t\n\t\n\t\tQuoteID123\n\t\n\t\n\t\tmy reference\n\t\n\t\n\t\tMAFO\n\t\n\t\n\t\tDoc1\n\t\tTimesheet\n\t\t\n\t\t\t\n\t\t\t\thttp://www.example.com/sheet001.html\n\t\t\t\n\t\t\n\t\n\t\n\t\tDoc2\n\t\tOrder\n\t\t\n\t\t\tUjBsR09EbGhjZ0dTQUxNQUFBUUNBRU1tQ1p0dU1GUXhEUzhi\n\t\t\t\n\t\t\n\t\n\t\n\t\t34322\n\t\n\t\n\t\t\n\t\t\t0552912569\n\t\t\t\n\t\t\t\t0552912569\n\t\t\t\n\t\t\t\n\t\t\t\tAdemico Software\n\t\t\t\n\t\t\t\n\t\t\t\tHeidebergstraat 204\n\t\t\t\tKessel-Lo\n\t\t\t\t3010\n\t\t\t\tRegion\n\t\t\t\t\n\t\t\t\t\tAddress Line 3\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\tBE\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\tBE0552912569\n\t\t\t\t\n\t\t\t\t\tVAT\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\tAdemico Software\n\t\t\t\t0552912569\n\t\t\t\t\n\t\t\t\t\tLeuven\n\t\t\t\t\t\n\t\t\t\t\t\tBE\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\tJohn Doe\n\t\t\t\t1234567\n\t\t\t\tinfo@example.com\n\t\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\t0552912569_order1\n\t\t\t\n\t\t\t\t0552912569_order1\n\t\t\t\n\t\t\t\n\t\t\t\tAdemico Software Order\n\t\t\t\n\t\t\t\n\t\t\t\tMy street\n\t\t\t\tLeuven\n\t\t\t\t3010\n\t\t\t\tRegion\n\t\t\t\t\n\t\t\t\t\tAddress Line 3\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\tBE\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\tAdemico Software Order\n\t\t\t\t0552912569_order1\n\t\t\t\t\n\t\t\t\t\tLeuven\n\t\t\t\t\t\n\t\t\t\t\t\tBE\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\tJohn doe\n\t\t\t\t123456\n\t\t\t\tinfo@example.com\n\t\t\t\n\t\t\n\t\n\t\n\t\t\n\n\t\t\t\n\t\t\t\tAdemico\n\t\t\t\n\t\t\t\n\t\t\t\tJohn Doe\n\t\t\t\t123456\n\t\t\t\tinfo@example.com\n\t\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\t123456785\n\t\t\t\n\t\t\t\tAccounting\n\t\t\t\n\t\t\t\n\t\t\t\tMy street\n\t\t\t\tOslo\n\t\t\t\t3010\n\t\t\t\tRegion\n\t\t\t\t\n\t\t\t\t\tAddress Line 3\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\tBE\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\tBE0552912569\n\t\t\t\t\n\t\t\t\t\tVAT\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\tAdemico Software\n\t\t\t\t123486723\n\t\t\t\t\n\t\t\t\t\tLeuven\n\t\t\t\t\t\n\t\t\t\t\t\tBE\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\t9483759475923478\n\t\t\t\n\t\t\t\tDelivery street 2\n\t\t\t\tBuilding 56\n\t\t\t\tStockholm\n\t\t\t\t21234\n\t\t\t\t\n\t\t\t\t\tSE\n\t\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t2012-10-10\n\t\t\t2012-10-20\n\t\t\n\t\t\n\t\t\t\n\t\t\t\tDelivery party Name\n\t\t\t\n\t\t\n\t\n\t\n\t\tFOB\n\t\tCAD\n\t\t\n\t\t\tFOB Oslo\n\t\t\n\t\n\t\n\t\tPayment terms description\n\t\n\t\n\t\ttrue\n\t\tABK\n\t\tMiscellaneous services\n\t\t400.00\n\t\t\n\t\t\tZ\n\t\t\t0\n\t\t\t\n\t\t\t\tVAT\n\t\t\t\n\t\t\n\t\n\t\n\t\tfalse\n\t\t95\n\t\tDiscount\n\t\t10\n\t\t652.50\n\t\t6525.00\n\t\t\n\t\t\tS\n\t\t\t25\n\t\t\t\n\t\t\t\tVAT\n\t\t\t\n\t\t\n\t\n\t\n\t\t100.00\n\t\n\t\n\t\t6525.00\n\t\t6272.50\n\t\t6372.50\n\t\t652.50\n\t\t400.00\n\t\t10.00\n\t\t0.50\n\t\t6363\n\t\n\t\n\t\tFreetext note on line 1\n\t\t\n\t\t\t1\n\t\t\t120\n\t\t\t6300.00\n\t\t\tfalse\n\t\t\t12345678\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t2010-02-10\n\t\t\t\t\t2010-02-25\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t1234567890\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\tJohn K.\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\ttrue\n\t\t\t\tABK\n\t\t\t\tMiscellaneous services\n\t\t\t\t600.00\n\t\t\t\n\t\t\t\n\t\t\t\tfalse\n\t\t\t\t95\n\t\t\t\tDiscount\n\t\t\t\t5\n\t\t\t\t300.00\n\t\t\t\t6000.00\n\t\t\t\n\t\t\t\n\t\t\t\t50.000\n\t\t\t\t1\n\t\t\t\t\n\t\t\t\t\tfalse\n\t\t\t\t\t10.00\n\t\t\t\t\t60.00\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\tNeedle 4mm\n\t\t\t\tNeedle 4mm\n\t\t\t\t\n\t\t\t\t\t123456\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t121212\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t0060000012345\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t12345678\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t12345678\n\t\t\t\t\n\n\t\t\t\t\n\t\t\t\t\tS\n\t\t\t\t\t25\n\t\t\t\t\t\n\t\t\t\t\t\tVAT\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\tLength\n\t\t\t\t\t30 mm\n\t\t\t\t\t30\n\t\t\t\t\tdescr\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\tSE-123456\n\t\t\t\t\t\n\t\t\t\t\t\tLO-123456\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t\n\t\tFreetext note on line 2\n\t\t\n\t\t\t2\n\t\t\t15\n\t\t\t225.00\n\t\t\ttrue\n\t\t\tProjectID123\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t2012-10-15\n\t\t\t\t\t2012-10-31\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t1234567890\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\tJohn K.\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t15.000\n\t\t\t\t1\n\t\t\t\t\n\t\t\t\t\tfalse\n\t\t\t\t\t100.0000\n\t\t\t\t\t115.0000\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\tWet tissues for children\n\t\t\t\tWet tissues\n\t\t\t\t\n\t\t\t\t\tSItemNo011\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t56789123\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\tS\n\t\t\t\t\t25\n\t\t\t\t\t\n\t\t\t\t\t\tVAT\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\tWeight\n\t\t\t\t\t100 g\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\n"}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/order-responses/{transmissionId}/ubl":{"get":{"tags":["Order"],"summary":"Get an Order Response in UBL format","description":"Get the content of a sent or received Order Response in UBL format","operationId":"getOrderResponseInUBLFormat","parameters":[{"name":"transmissionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Error retrieving the Order Response UBL XML ","content":{"application/xml;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}},"200":{"description":"Order Response UBL XML retrieved successfully","content":{"application/xml":{"schema":{"type":"string"},"example":"\n\n urn:fdc:peppol.eu:poacc:trns:order_response_advanced:3\n urn:fdc:peppol.eu:poacc:bis:advanced_ordering:3\n pbe000512-8\n 2022-02-01\n CA\n Response message with amendments in the details\n EUR\n \n Order-1\n \n \n \n 0552912569\n \n 0552912569\n \n \n Ademico Software\n \n \n \n \n \n 1999999943\n \n 1999999943\n \n \n The Supplier AB\n \n \n \n \n \n 2022-02-15\n 2022-02-20\n \n \n \n \n 1\n Reduced quantity to 5 and added Sellers item identification\n 3\n 5\n \n Item 1\n \n SN-1\n \n \n \n \n 1\n \n \n \n \n 2\n Added Sellers item identification\n 3\n \n Item 2\n \n SN-2\n \n \n \n \n 2\n \n \n\n"}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/order-changes/{transmissionId}/ubl":{"get":{"tags":["Order"],"summary":"Get an Order Change in UBL format","description":"Get the content of a sent or received Order Change in UBL format","operationId":"getOrderChangeInUBLFormat","parameters":[{"name":"transmissionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Error retrieving the Order Change UBL XML ","content":{"application/xml;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}},"200":{"description":"Order Change UBL XML retrieved successfully","content":{"application/xml":{"schema":{"type":"string"},"example":"\n\n urn:fdc:peppol.eu:poacc:trns:order_change:3\n urn:fdc:peppol.eu:poacc:bis:advanced_ordering:3\n pbe000512-8\n 2022-02-01\n 1\n Changes according to Order reponse\n EUR\n \n 2022-03-01\n \n \n pbe000512-9\n \n \n \n 0552912569\n \n 0552912569\n \n \n \n BE\n \n \n \n Ademico Software\n 0552912569\n \n Leuven\n \n BE\n \n \n \n \n info@ademico-software.com\n \n \n \n \n \n 1999999943\n \n 1999999943\n \n \n The Supplier AB\n \n \n \n BE\n \n \n \n The Supplier\n \n \n \n \n \n \n Lower street 5\n Reception\n Stockholm\n 11120\n \n\t\t\tRight\n \n \n SE\n \n \n \n \n 2013-07-15\n 2013-07-16\n \n \n \n Hospital Tourist Department\n \n \n John \n john@example.com\n \n \n \n \n 100\n \n \n\t\t500\n\t\t500\n\t\t600\n\t\t600\n\t\n \n \n 1\n 3\n 5\n 200\n \n 40\n \n \n Item 1\n \n S\n 20\n \n VAT\n \n \n \n \n \n \n \n 2\n 3\n 50\n 300\n \n 6\n \n \n Item 2\n \n S\n 20\n \n VAT\n \n \n \n \n \n\n"}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/order-cancellations/{transmissionId}/ubl":{"get":{"tags":["Order"],"summary":"Get an Order Cancellation in UBL format","description":"Get the content of a sent or received Order Cancellation in UBL format","operationId":"getOrderCancellationInUBLFormat","parameters":[{"name":"transmissionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Error retrieving the Order Cancellation UBL XML ","content":{"application/xml;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}},"200":{"description":"Order Cancellation UBL XML retrieved successfully","content":{"application/xml":{"schema":{"type":"string"},"example":"\n\n urn:fdc:peppol.eu:poacc:trns:order_cancellation:3\n urn:fdc:peppol.eu:poacc:bis:advanced_ordering:3\n pbe000512-8\n 2022-02-01\n With reference to phone call\n \n Order-1\n \n \n \n 0552912569\n \n 0552912569\n \n \n \n BE\n \n \n \n Ademico Software\n \n \n \n \n \n 1999999943\n \n 1999999943\n \n \n \n BE\n \n \n \n The Supplier AB\n \n \n \n\n"}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/notifications":{"get":{"tags":["Notification"],"summary":"Get the list of notifications","description":"The API creates notifications to inform you when a document was sent successfully or when you receive a document from other legal entities.The following status values are possible when you, acting as a Seller, are sending an invoice/credit note to a Buyer. You will get notified via the notification `InvoiceSendingNotificationRO`:| Code | Description |
|---|
| QUEUED | Waiting to be sent to the Buyer |
| SENT | Acknowledged by the receiver Access Point C3 |
| SEND_FAILED | Failed to send to the receiver's Access Point C3 |
The following status values are possible when you, acting as a Seller, have sent an invoice/credit note to the Access Point of the Buyer and it was received. You will get notified via the notification `MLRReceivingNotificationRO`:| Code | Description |
|---|
| TECHNICAL_ACCEPTANCE | Document received and accepted by the Access Point of the Buyer, but it was not (yet) read by Buyer |
| REJECTED | MLR reject. Status is used when the Access Point of the Buyer will not process the referenced document any further due to validation errors. |
When you, acting as a Buyer, are receiving an invoice/credit note from the Seller you will get notified via the notification `InvoiceReceivingNotificationRO`. This notification contains a unique identifier called `transmissionId` which you will use to get the incoming invoice/credit note using the endpoint Get Invoice/Credit Note.The following status values are possible when you, acting as a Seller, are receiving an InvoiceResponse notification(IR) from the Buyer. Not all Buyers are sending an InvoiceResponse.You will get notified via the notification `InvoiceResponseReceivingNotificationRO`:| Code | Description |
|---|
| BUYER_ACKNOWLEDGE | Status is used when Buyer has received a readable invoice message that can be understood and submitted for processing by the Buyer. |
| IN_PROCESS | Status is used when the processing of the Invoice has started in Buyers system. |
| UNDER_QUERY | Status is used when Buyer will not proceed to accept the Invoice without receiving additional information from the Seller. |
| CONDITIONALLY_ACCEPTED | Status is used when Buyer is accepting the Invoice under conditions stated in 'Status Reason' and proceed to pay accordingly unless disputed by Seller. |
| REJECTED | Invoice reject. Status is used only when the Buyer will not process the referenced Invoice any further. Buyer is rejecting this invoice but not necessarily the commercial transaction. Although it can be used also for rejection for commercial reasons (invoice not corresponding to delivery). |
| ACCEPTED | Status is used only when the Buyer has given a final approval of the invoice and the next step is payment |
| PARTIALLY_PAID | Status is used together with Clarification Reason code PPD, only when the Buyer has initiated the payment of the invoice without having paid the accepted amount in full. |
| FULLY_PAID | Status is used only when the Buyer has initiated the payment of the invoice. |
France PPF/C5 notificationsPPF reporting is asynchronous and independent of Peppol delivery. A typical successful lifecycle is C5_DOCUMENT_ENQUEUED → C5_DOCUMENT_SUBMITTED → C5_DOCUMENT_ACKNOWLEDGED → C5_DOCUMENT_PROCESSED. C5_DOCUMENT_ENQUEUED means that the entry is queued locally and has not yet been sent to PPF. C5_DOCUMENT_SUBMITTED means that the bulk archive containing the entry was uploaded to PPF; it does not confirm technical or business acceptance. C5_DOCUMENT_SUBMISSION_FAILED reports a submission failure, including an upload failure after retries are exhausted. PPF technical acceptance or rejection is reported by C5_DOCUMENT_ACKNOWLEDGED or C5_DOCUMENT_NOT_ACKNOWLEDGED; business processing results are reported by C5_DOCUMENT_PROCESSED or C5_DOCUMENT_PROCESSING_FAILED. C5SendingNotificationRO reports queueing and upload outcomes; C5ReceivingNotificationRO reports PPF technical and business responses. The success field applies only to the stage identified by eventType. submissionId identifies the individual entry, c5TransmissionId the outbound bulk archive, and acknowledgementId the incoming PPF response archive. c5TransmissionId can be absent while the entry is only enqueued. The Peppol transmissionId can be absent for standalone e-reporting. Use details and, when present, documentStatusDetails for rejection reasons.France CDAR notificationsCDAR_SENT confirms that a France invoice lifecycle CDAR message was sent successfully; CDAR_SEND_FAILED reports that sending the CDAR failed. Both use CDARSendingNotificationRO. CDAR_RECEIVED uses CDARReceivingNotificationRO and reports a received CDAR status update for a referenced invoice or credit note. These events concern the lifecycle message itself, including messages generated automatically by the platform. DOCUMENT_SENT and DOCUMENT_RECEIVED concern the original document exchange. In CDAR notifications, currentDocument identifies the CDAR and referencedDocument identifies the invoice or credit note. documentStatus carries the French lifecycle status (for example, FR_DEPOSITED or FR_APPROVED), while detailedStatuses and details provide additional information when available. Reporting a CDAR to PPF has its own C5_DOCUMENT_* notifications.Here is a list of all notifications defined in our OpenAPI specifications that you can receive:| Name | Event Type | Description |
|---|
| InvoiceSendingNotificationRO | DOCUMENT_SENTDOCUMENT_SEND_FAILED | Notification created when you, acting as a Seller, send an invoice/credit note to a Buyer. This notifies you whether the invoice was sent successfully or failed to be sent. |
| InvoiceReceivingNotificationRO | DOCUMENT_RECEIVED | Notification created when you, acting as a Buyer, receive an invoice/credit note from a Seller. |
| MLRReceivingNotificationRO | MLR_RECEIVED | Notification created when you, acting as a Seller, have sent an invoice/credit note to the Buyer's Access Point and it has been received. This notifies you whether the Buyer's Access Point has accepted or rejected the invoice for technical reasons. |
| InvoiceResponseSendingNotificationRO | INVOICE_RESPONSE_SENTINVOICE_RESPONSE_SEND_FAILED | Notification created when you, acting as a Buyer, send an Invoice Response (IR) to a Seller. This notifies you whether the Invoice Response was sent successfully or failed to be sent. |
| InvoiceResponseReceivingNotificationRO | INVOICE_RESPONSE_RECEIVED | Notification created when you, acting as a Seller, receive an Invoice Response (IR) from a Buyer. This notifies you whether the invoice you sent to the Buyer was accepted, rejected, paid, etc. |
| CDARSendingNotificationRO | CDAR_SENTCDAR_SEND_FAILED | Notification created when you, acting as a Buyer, send a CDAR document to a Seller. The same notification type is also created when you, acting as a Seller, send a CDAR with a status update to the Buyer. This notifies you whether the CDAR document was sent successfully or failed to be sent. |
| CDARReceivingNotificationRO | CDAR_RECEIVED | Notification created when you, acting as a Seller, receive a CDAR document from a Buyer. The same notification type is also created when you, acting as a Buyer, receive a CDAR with a status update from the Seller. |
| OrderSendingNotificationRO | DOCUMENT_SENTDOCUMENT_SEND_FAILED | Notification created when you, acting as a Buyer, send an order to a Seller. This notifies you whether the order was sent successfully or failed to be sent. |
| OrderReceivingNotificationRO | DOCUMENT_RECEIVED | Notification created when you, acting as a Seller, receive an order from a Buyer. |
| LegalEntityCorppassKycNotificationRO | LEGAL_ENTITY_KYC_CORPPASS_ACTIVATEDLEGAL_ENTITY_KYC_CORPPASS_ACTIVATION_ERROR | Specific to Singapore only: Notification created to inform you about the status of the legal entity KYC in Corppass. |
| LegalEntityCorppassC5NotificationRO | LEGAL_ENTITY_C5_ACTIVATEDLEGAL_ENTITY_C5_ACTIVATION_ERRORLEGAL_ENTITY_C5_DEACTIVATEDLEGAL_ENTITY_C5_DEACTIVATION_ERROR | Specific to Singapore only: Notification created to inform you about the status of the legal entity C5 activation/deactivation in Corppass. |
| IrasSendingNotificationRO | IRAS_DOCUMENT_SENTIRAS_DOCUMENT_SEND_FAILED | Specific to Singapore only: Notification created when you, acting as a Seller, send an invoice/credit note to a Buyer and you have indicated to our API to automatically report to IRAS via the HTTP header X-C5-REPORTING. |
| C5SendingNotificationRO | C5_DOCUMENT_ENQUEUEDC5_DOCUMENT_SUBMITTEDC5_DOCUMENT_SUBMISSION_FAILED | Notification created when a document is either queued for submission or submitted to C5 (i.e. the country‑specific fiscal authority), or its submission to C5 failed. |
| C5ReceivingNotificationRO | C5_DOCUMENT_ACKNOWLEDGEDC5_DOCUMENT_NOT_ACKNOWLEDGEDC5_DOCUMENT_PROCESSEDC5_DOCUMENT_PROCESSING_FAILED | Notification created when C5 technical acknowledgement, rejection or processing results are received for a previously submitted document. |
","operationId":"getNotifications","parameters":[{"name":"transmissionId","in":"query","description":"The transmission id of the notification","required":false,"schema":{"type":"string"},"example":"803828d52d4911ed85f512ef9c5638d0"},{"name":"documentId","in":"query","description":"The document id of a document eg Invoice/Credit Note","required":false,"schema":{"type":"string"},"example":"pbe000512-1"},{"name":"eventType","in":"query","description":"The notification event type","required":false,"schema":{"$ref":"#/components/schemas/EventTypeRO"},"example":"INVOICE_RESPONSE_RECEIVED"},{"name":"peppolDocumentType","in":"query","description":"The document type: INVOICE, CREDIT_NOTE, ORDER","required":false,"schema":{"$ref":"#/components/schemas/PeppolDocumentTypeRO"},"example":"INVOICE"},{"name":"sender","in":"query","description":"The sender of the notification","required":false,"schema":{"type":"string"},"example":"0208:0552912569"},{"name":"receiver","in":"query","description":"The receiver of the notification","required":false,"schema":{"type":"string"},"example":"0208:0552912569"},{"name":"startDateTime","in":"query","description":"The start date time of the period to filter the notifications. To filter all notifications for a specific time E.g. `2023-07-25T11:03:26.688Z` use `startDateTime=2023-07-25T11:03:26.688Z` and `endDateTime=2023-07-29T11:03:26.688Z","required":false,"schema":{"type":"string","format":"date-time"},"example":"2023-07-25T11:03:26.688Z"},{"name":"endDateTime","in":"query","description":"The end date time of the period to filter the notifications.","required":false,"schema":{"type":"string","format":"date-time"},"example":"2023-07-29T11:03:26.688Z"},{"name":"page","in":"query","description":"The starting page number from which we want to retrieve results. The first page is 0.","required":false,"schema":{"type":"integer","format":"int32","default":0},"example":0},{"name":"pageSize","in":"query","description":"How many results we retrieve per page","required":false,"schema":{"type":"integer","format":"int32","default":10},"example":10},{"name":"sort","in":"query","description":"Whether to sort the results in ascending ('asc') or descending ('desc') order","required":false,"schema":{"type":"string","default":"asc"},"example":"asc"},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"Notifications retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationsResponseRO"},"examples":{"All notification types":{"description":"All notification types","value":{"notifications":[{"documentId":"pbe000512-AUNZ-1","documentStatus":"SENT","eventType":"DOCUMENT_SENT","notificationDate":"2025-03-25T13:28:59.878","notificationId":1,"peppolDocumentType":"INVOICE","receiver":"0151:20234567890","sbdhTransmissionId":"1a5363fd097d11f083b9c2b5d1f6eb7f","sender":"0151:47555222000","transmissionId":"1a5363fe097d11f083b9c2b5d1f6eb7f","details":[]},{"documentId":"pbe000512-2","documentStatus":"SEND_FAILED","eventType":"DOCUMENT_SEND_FAILED","notificationDate":"2025-03-25T13:29:05.931","notificationId":5,"peppolDocumentType":"INVOICE","receiver":"0208:1999999943","sbdhTransmissionId":"1faf4efd097d11f083b9c2b5d1f6eb7f","sender":"0208:0552912569","transmissionId":"1faf4efe097d11f083b9c2b5d1f6eb7f","details":[{"code":"DOCUMENT_TRANSMISSION_ERROR","message":"Error dispatching the message to http://receiver:8080/msh"},{"code":"DOCUMENT_TRANSMISSION_ERROR","message":"Error2"}]},{"documentId":"pbe000512-3","documentStatus":"REJECTED","eventType":"MLR_RECEIVED","notificationDate":"2025-03-25T13:29:07.536","notificationId":7,"peppolDocumentType":"INVOICE","receivedDate":"2025-03-25T13:29:07.536","receiver":"0208:0552912569","sender":"0208:1999999943","transmissionId":"20029f22097d11f083b9c2b5d1f6eb7f","details":[{"code":"GENERIC_ERROR","message":"/Invoice[1]/InvoiceLine[1]/Item[1]/ClassifiedTaxCategory[1]:[BR-S-05]-In an Invoice line (BG-25) where the Invoiced item VAT category code (BT-151) is \"Standard rated\" the Invoiced item VAT rate (BT-152) shall be greater than zero."},{"code":"GENERIC_ERROR","message":"/Invoice[1]/LegalMonetaryTotal[1]:[BR-CO-13]-Invoice total amount without VAT (BT-109) = Σ Invoice line net amount (BT-131) - Sum of allowances on document level (BT-107) + Sum of charges on document level (BT-108)."},{"code":"GENERIC_ERROR","message":"/Invoice[1]/TaxTotal[1]/TaxSubtotal[1]/TaxCategory[1]:[BR-S-08]-For each different value of VAT category rate (BT-119) where the VAT category code (BT-118) is \"Standard rated\", the VAT category taxable amount (BT-116) in a VAT breakdown (BG-23) shall equal the sum of Invoice line net amounts (BT-131) plus the sum of document level charge amounts (BT-99) minus the sum of document level allowance amounts (BT-92) where the VAT category code (BT-151, BT-102, BT-95) is \"Standard rated\" and the VAT rate (BT-152, BT-103, BT-96) equals the VAT category rate (BT-119)."},{"code":"GENERIC_ERROR","message":"/Invoice[1]:[BR-CO-15]-Invoice total amount with VAT (BT-112) = Invoice total amount without VAT (BT-109) + Invoice total VAT amount (BT-110)."}]},{"details":[],"documentId":"pbe000512-4","documentStatus":"ACCEPTED","eventType":"INVOICE_RESPONSE_RECEIVED","invoiceResponse":{"invoiceResponseId":"5eb4a831508b11f1a85c005056c00001","effectiveDate":"2022-05-22","invoiceClarifications":[],"invoiceTransmissionId":"221ca588097d11f083b9c2b5d1f6eb7f","note":null,"responseCode":"AP"},"notificationDate":"2025-03-25T13:29:09.937","notificationId":9,"peppolDocumentType":"INVOICE","receiver":"0208:0552912569","sender":"0208:1999999943","transmissionId":"221ca588097d11f083b9c2b5d1f6eb7f","sbdhInstanceIdentifier":"5eb4a831508b11f1a85c005056c00001"},{"details":[],"documentId":"pbe000512-5","documentStatus":"REJECTED","eventType":"INVOICE_RESPONSE_RECEIVED","invoiceResponse":{"invoiceResponseId":"e042941e508811f18900005056c00001","effectiveDate":"2022-08-24","invoiceClarifications":[{"clarification":"VAT Reference not found","clarificationCode":"LEG","clarificationType":"OPStatusReason"},{"clarification":"Credit fully","clarificationCode":"CNF","clarificationType":"OPStatusAction"},{"clarification":"Issue new invoice","clarificationCode":"NIN","clarificationType":"OPStatusAction"}],"invoiceTransmissionId":"22578bae097d11f083b9c2b5d1f6eb7f","note":"custom note","responseCode":"RE"},"notificationDate":"2025-03-25T13:29:10.460","notificationId":11,"peppolDocumentType":"INVOICE","receiver":"0208:0552912569","sender":"0208:1999999943","transmissionId":"22578bae097d11f083b9c2b5d1f6eb7f","sbdhInstanceIdentifier":"e042941e508811f18900005056c00001"},{"details":[],"documentId":"pbe000512-6","eventType":"DOCUMENT_RECEIVED","notificationDate":"2025-03-25T13:29:11.011","notificationId":12,"peppolDocumentType":"INVOICE","receivedDate":"2025-03-25T13:29:11.011","receiver":"0208:0552912569","sbdhTransmissionId":"5555555","sender":"0208:1999999943","transmissionId":"22e76fa4097d11f083b9c2b5d1f6eb7f"},{"details":[],"documentId":"pbe000512-8","documentStatus":"ACCEPTED","eventType":"INVOICE_RESPONSE_SENT","notificationDate":"2025-03-25T13:29:14.982","notificationId":15,"receiver":"0208:1999999943","sender":"0208:0552912569","transmissionId":"250ebc83097d11f083b9c2b5d1f6eb7f","sbdhInstanceIdentifier":"8348abc5508b11f1a85c005056c00001"},{"details":[],"documentId":"pbe000512-9","documentStatus":"REJECTED","eventType":"INVOICE_RESPONSE_SENT","notificationDate":"2025-03-25T13:29:17.621","notificationId":17,"receiver":"0208:1999999943","sender":"0208:0552912569","transmissionId":"26cf584a097d11f083b9c2b5d1f6eb7f","sbdhInstanceIdentifier":"8059a223508b11f1a85c005056c00001"},{"eventType":"CDAR_RECEIVED","notificationId":18,"notificationDate":"2025-03-25T13:29:20.000","documentStatus":"FR_IN_DISPUTE","sender":"0225:100000010","receiver":"0225:100000009","currentDocument":{"documentId":"F202500006-207","peppolDocumentType":"CDAR_RESPONSE","transmissionId":"2edcea46a44e11f18d216045bd1accf2"},"referencedDocument":{"documentId":"F202500006","peppolDocumentType":"INVOICE","transmissionId":"87bce77ca3dd11f18efc0a1599d5134b"},"details":[],"detailedStatuses":[{"reasonCode":"TX_TVA_ERR","reasonText":"Taux de TVA erroné","requestedActionCode":"NIN","requestedAction":"Créer une Facture Rectificative","sequenceNumber":1,"notes":[{"contentCode":"G1.24","content":"The invoiced VAT rate is 10%; the expected rate is 20%.","subjectCode":"ram:RateApplicablePercent"}],"documentCharacteristics":[{"id":"BT-152","typeCode":"DIV","valueChanged":true,"name":"Taux TVA","location":"/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent","valuePercent":10.0},{"id":"BT-152","typeCode":"DVA","valueChanged":true,"name":"Taux TVA","location":"/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent","valuePercent":20.0}]}],"notes":[{"contentCode":"G1.24","content":"Buyer dispute concerning the VAT rate.","subjectCode":"ram:RateApplicablePercent"}]},{"activationDate":"2025-03-25T14:29:45.897","eventType":"LEGAL_ENTITY_KYC_CORPPASS_ACTIVATED","initiatedDate":"2025-03-25T14:29:45.828","legalEntityId":2,"legalEntityRegistrationId":2,"notificationDate":"2025-03-25T14:29:45.899","notificationId":1,"signerEmail":"john.doe@example.com","signerName":"John Doe"},{"activationDate":"2025-03-25T14:29:47.524","eventType":"LEGAL_ENTITY_C5_ACTIVATED","initiatedDate":"2025-03-25T14:29:47.500","legalEntityId":5,"legalEntityRegistrationId":5,"notificationDate":"2025-03-25T14:29:47.524","notificationId":2,"signerEmail":"john.doe@example.com","signerName":"John Doe"},{"activationErrorDate":"2025-03-25T14:29:48.143","details":[{"code":null,"message":"Corppass error detail"}],"eventType":"LEGAL_ENTITY_C5_ACTIVATION_ERROR","initiatedDate":"2025-03-25T14:29:48.126","legalEntityId":6,"legalEntityRegistrationId":6,"notificationDate":"2025-03-25T14:29:48.143","notificationId":3,"signerEmail":"john.doe@example.com","signerName":"John Doe"},{"activationErrorDate":"2025-03-25T14:29:48.612","details":[{"code":null,"message":"Corppass error detail"}],"eventType":"LEGAL_ENTITY_KYC_CORPPASS_ACTIVATION_ERROR","initiatedDate":"2025-03-25T14:29:48.598","legalEntityId":7,"legalEntityRegistrationId":7,"notificationDate":"2025-03-25T14:29:48.612","notificationId":4,"signerEmail":"john.doe@example.com","signerName":"John Doe"}],"pagination":{"count":13,"page":0,"pageSize":20}}},"Complete CDAR received notification":{"description":"Complete CDAR received notification","value":{"pagination":{"count":1,"page":0,"pageSize":10},"notifications":[{"eventType":"CDAR_RECEIVED","notificationId":4311,"notificationDate":"2026-08-30T08:39:01.000","documentStatus":"FR_IN_DISPUTE","sender":"0225:100000010","receiver":"0225:100000009","currentDocument":{"documentId":"F202500006-207","peppolDocumentType":"CDAR_RESPONSE","transmissionId":"2edcea46a44e11f18d216045bd1accf2"},"referencedDocument":{"documentId":"F202500006","peppolDocumentType":"INVOICE","transmissionId":"87bce77ca3dd11f18efc0a1599d5134b"},"details":[],"detailedStatuses":[{"reasonCode":"TX_TVA_ERR","reasonText":"Taux de TVA erroné","requestedActionCode":"NIN","requestedAction":"Créer une Facture Rectificative","sequenceNumber":1,"notes":[{"contentCode":"G1.24","content":"The invoiced VAT rate is 10%; the expected rate is 20%.","subjectCode":"ram:RateApplicablePercent"}],"documentCharacteristics":[{"id":"BT-152","typeCode":"DIV","valueChanged":true,"name":"Taux TVA","location":"/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent","valuePercent":10.0},{"id":"BT-152","typeCode":"DVA","valueChanged":true,"name":"Taux TVA","location":"/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent","valuePercent":20.0}]}],"notes":[{"contentCode":"G1.24","content":"Buyer dispute concerning the VAT rate.","subjectCode":"ram:RateApplicablePercent"}]}]}},"Complete CDAR sent notification":{"description":"Complete CDAR sent notification","value":{"pagination":{"count":1,"page":0,"pageSize":10},"notifications":[{"eventType":"CDAR_SENT","notificationId":4310,"notificationDate":"2026-08-30T08:38:59.000","documentStatus":"FR_IN_DISPUTE","sender":"0225:100000010","receiver":"0225:100000009","currentDocument":{"documentId":"F202500006-207","peppolDocumentType":"CDAR_RESPONSE","transmissionId":"2edcea46a44e11f18d216045bd1accf2"},"referencedDocument":{"documentId":"F202500006","peppolDocumentType":"INVOICE","transmissionId":"87bce77ca3dd11f18efc0a1599d5134b"},"details":[],"detailedStatuses":[{"reasonCode":"TX_TVA_ERR","reasonText":"Taux de TVA erroné","requestedActionCode":"NIN","requestedAction":"Créer une Facture Rectificative","sequenceNumber":1,"notes":[{"contentCode":"G1.24","content":"The invoiced VAT rate is 10%; the expected rate is 20%.","subjectCode":"ram:RateApplicablePercent"}],"documentCharacteristics":[{"id":"BT-152","typeCode":"DIV","valueChanged":true,"name":"Taux TVA","location":"/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent","valuePercent":10.0},{"id":"BT-152","typeCode":"DVA","valueChanged":true,"name":"Taux TVA","location":"/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent","valuePercent":20.0}]}],"notes":[{"contentCode":"G1.24","content":"Buyer dispute concerning the VAT rate.","subjectCode":"ram:RateApplicablePercent"}]}]}}}}}},"400":{"description":"Error getting the Notifications","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"GENERIC_ERROR","message":"Error getting notifications"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/legal-entities/{legalEntityId}/peppol-registrations/{peppolRegistrationId}/c5/corppass":{"get":{"tags":["Legal Entity C5 Singapore"],"summary":"Singapore - Get the details of the C5 activation","description":"The details of the C5 activation.- ACTIVATED= The C5 activation has been signed
- INITIATED_ACTIVATION= Signing of a C5 activation has been initiated
- INITIATED_DEACTIVATION= Signing of a deactivation of an existing C5 activation has been initiated
- PENDING_KYC= C5 Activation has been initiated but participant is still waiting for KYC signing
","operationId":"getLegalEntityC5Activation","parameters":[{"name":"legalEntityId","in":"path","description":"The id of the legal entity","required":true,"schema":{"type":"integer","format":"int64"},"example":7},{"name":"peppolRegistrationId","in":"path","description":"The id of the Peppol registration for which you want to get the Corppass activation details","required":true,"schema":{"type":"integer","format":"int64"},"example":1},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"400":{"description":"Error getting Corppass C5 activation details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"LEGAL_ENTITY_ERROR","message":"Error getting the Corppass C5 activation details"}}}},"200":{"description":"Corppass C5 activation retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntityC5ActivationGetResponseRO"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/invoices/{transmissionId}/ubl":{"get":{"tags":["Invoice/Credit Note"],"summary":"Get an Invoice/Credit Note in UBL format","description":"Get the content of a sent or received Invoice/Credit Note in UBL format","operationId":"getInvoiceInUBLFormat","parameters":[{"name":"transmissionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Authentication failure","content":{"application/xml;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"Invoice/Credit Note UBL XML retrieved successfully","content":{"application/xml":{"schema":{"type":"string"},"example":"\n urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0\n urn:fdc:peppol.eu:2017:poacc:billing:01:1.0\n pbe000512-8\n 2022-05-19\n 2022-06-19\n 380\n EUR\n 4025:123:4343\n 0150abc\n \n test-ademico-001\n test-ademico-001\n \n \n invoice1\n \n \n dGhpcyBpcyB0aGUgcGRmIGludm9pY2UgYmFzZTY0IGVuY29kZWQ=\n \n \n \n \n \n 0552912569\n \n 0552912569\n \n \n Ademico Software\n \n \n My street, my number\n Leuven\n 3010\n \n BE\n \n \n \n BE0552912569\n \n VAT\n \n \n \n Ademico Software\n 0552912569\n \n \n info@ademico-software.com\n \n \n \n\n \n \n 1999999943\n \n 1999999943\n \n \n Company name\n \n \n Simon Bolivarlaan\n Brussel\n 1000\n \n BE\n \n \n \n BE1999999943\n \n VAT\n \n \n \n Company name\n 1999999943\n \n \n info@example.com\n \n \n \n \n 2017-11-01\n \n 9483759475923478\n \n Delivery street 2\n Building 56\n Stockholm\n 21234\n \n SE\n \n \n \n \n \n Delivery party Name\n \n \n \n \n 30\n Snippet1\n \n IBAN32423940\n AccountName\n \n BIC324098\n \n \n \n \n Payment within 10 days, 2% discount\n \n \n true\n Insurance\n 10\n \n E\n 0\n \n VAT\n \n \n \n \n 311.09\n \n 1481.4\n 311.09\n \n S\n 21.0\n \n VAT\n \n \n \n \n 30\n 0\n \n E\n 0\n VATEX-EU-F\n \n VAT\n \n \n \n \n \n 1501.4\n 1511.4\n 1822.49\n 10\n 1822.49\n \n\n \n 1\n 2\n 20\n Consulting Fees\n \n test-ademico-001\n \n \n TEST 0%\n TEST 0%\n \n 21382183120983\n \n \n NO\n \n \n 09348023\n \n \n E\n 0\n \n VAT\n \n \n \n \n 10\n \n \n \n 2\n 12\n 1481.4\n \n test-ademico-001\n \n \n Description 2\n TEST 21%\n \n 21382183120983\n \n \n NO\n \n \n 09348023\n \n \n S\n 21.0\n \n VAT\n \n \n \n \n 123.45\n \n \n"}}},"400":{"description":"Error retrieving the Invoice/Credit Note UBL XML ","content":{"application/xml;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/invoices/{transmissionId}/facturx":{"get":{"tags":["Invoice/Credit Note"],"summary":"Get an Invoice/Credit Note in Factur-X format","description":"Get the content of a sent or received Invoice/Credit Note in Factur-X format","operationId":"getInvoiceInFacturxFormat","parameters":[{"name":"transmissionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Authentication failure","content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"Invoice/Credit Note Factur-X retrieved successfully","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Error retrieving the Invoice/Credit Note Factur-X","content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"DOCUMENT_NOT_FOUND","message":"Could not find Invoice/Credit Note with transmission id [803828d52d4911ed85f512ef9c5638d0]"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/invoices/{transmissionId}/cii":{"get":{"tags":["Invoice/Credit Note"],"summary":"Get an Invoice/Credit Note in CII format","description":"Get the content of a sent or received Invoice/Credit Note in CII format","operationId":"getInvoiceInCIIFormat","parameters":[{"name":"transmissionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Invoice/Credit Note CII XML retrieved successfully","content":{"application/xml":{"schema":{"type":"string"},"example":"\n\n\n \n \n S1\n \n \n urn:cen.eu:en16931:2017\n \n \n\n \n INV1234\n 380\n \n 20251120\n \n \n Les frais de recouvrement sont de 40 euros.\n PMT\n \n \n En cas de retard de paiement, des pénalités de 3 fois le taux d'intérêt légal seront appliquées.\n PMD\n \n \n Aucun escompte n'est accordé pour paiement anticipé.\n AAB\n \n \n\n \n \n \n 1\n \n \n Produit A\n \n \n \n 50.00\n \n \n \n 10\n \n \n \n VAT\n S\n 20.00\n \n \n 500.00\n \n \n \n\n \n \n 2\n \n \n Service B\n \n \n \n 100.00\n \n \n \n 5\n \n \n \n VAT\n S\n 20.00\n \n \n 500.00\n \n \n \n\n \n S1\n \n 51278912300015\n 51278912300015\n Société Example SARL\n \n 512789123\n Société Example SARL\n \n \n 75001\n 12 rue des Lilas\n Paris\n FR\n \n \n 0552912569\n \n \n FR12512789123\n \n \n \n 81234567800029\n 81234567800029\n Client Français SA\n \n 812345678\n \n \n 69001\n 45 avenue de la République\n Lyon\n FR\n \n \n FR55812345678\n \n \n FR55812345678\n \n \n \n \n \n \n 20251120\n \n \n \n \n EUR\n \n 31\n \n FR7612345678901234567890123\n \n \n \n 200.00\n VAT\n 1000.00\n S\n 20.00\n \n \n Paiement à 30 jours\n \n 20251220\n \n \n \n 1000.00\n 1000.00\n 200.00\n 1200.00\n 1200.00\n \n \n \n\n\n"}}},"400":{"description":"Error retrieving the Invoice/Credit Note CII XML ","content":{"application/xml;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}},"401":{"description":"Authentication failure","content":{"application/xml;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/documents":{"get":{"tags":["Documents"],"summary":"Search exchanged documents","description":"Search exchanged documents by type, identifier, sender, receiver, transmission details, direction, or date range.","operationId":"getDocuments","parameters":[{"name":"peppolDocumentType","in":"query","description":"The document type: Eg INVOICE, CREDIT_NOTE, ORDER","required":false,"schema":{"$ref":"#/components/schemas/PeppolDocumentTypeRO"},"example":"INVOICE"},{"name":"documentId","in":"query","description":"The document id","required":false,"schema":{"type":"string"},"example":"INV-100"},{"name":"sender","in":"query","description":"The sender participant identifier","required":false,"schema":{"type":"string"},"example":"0208:0552912569"},{"name":"senderCountry","in":"query","description":"The sender party country","required":false,"schema":{"$ref":"#/components/schemas/CountryCodeEnum"},"example":"BE"},{"name":"receiver","in":"query","description":"The receiver participant identifier","required":false,"schema":{"type":"string"},"example":"0208:1999999943"},{"name":"receiverCountry","in":"query","description":"The receiver party country","required":false,"schema":{"$ref":"#/components/schemas/CountryCodeEnum"},"example":"BE"},{"name":"sbdhTransmissionId","in":"query","description":"The SBDH transmission identifier","required":false,"schema":{"type":"string"},"example":"6b56b28947e511eda0b802bb4e4747f9"},{"name":"transmissionId","in":"query","description":"The transmission identifier","required":false,"schema":{"type":"string"},"example":"803828d52d4911ed85f512ef9c5638d0"},{"name":"direction","in":"query","description":"The transmission direction","required":false,"schema":{"$ref":"#/components/schemas/TransmissionDirectionEnumRO"},"example":"SENDING"},{"name":"startDateTime","in":"query","description":"The start date time of the period to filter the documents.","required":false,"schema":{"type":"string","format":"date-time"},"example":"2023-07-25T11:03:26.688Z"},{"name":"endDateTime","in":"query","description":"The end date time of the period to filter the documents.","required":false,"schema":{"type":"string","format":"date-time"},"example":"2023-07-29T11:03:26.688Z"},{"name":"legalEntityId","in":"query","description":"The id of the legal entity to filter the documents.","required":false,"schema":{"type":"integer","format":"int64"},"example":12345},{"name":"page","in":"query","description":"The starting page number from which we want to retrieve results. The first page is 0.","required":false,"schema":{"type":"integer","format":"int32","default":0},"example":0},{"name":"pageSize","in":"query","description":"How many results we retrieve per page","required":false,"schema":{"type":"integer","format":"int32","default":10},"example":10},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Documents retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentSearchResponseRO"}}}},"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}},"400":{"description":"Error retrieving documents","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/c5/france/ppf/e-reporting-submissions/{submissionId}/xml":{"get":{"tags":["France PPF Submission"],"summary":"Get a France PPF e-reporting submission.","description":"Retrieves the France PPF e-reporting submission XML for the provided submission id.","operationId":"getFranceEReportingSubmission","parameters":[{"name":"submissionId","in":"path","description":"The submission id returned when the France e-reporting XML was submitted.","required":true,"schema":{"type":"string"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"The France PPF e-reporting submission XML could not be retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}},"400":{"description":"No France PPF e-reporting submission was found for the provided submission id in the current workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}},"401":{"description":"Authentication failure","content":{"application/xml;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}},"200":{"description":"The France PPF e-reporting submission XML was retrieved successfully.","headers":{"X-C5-SUBMISSION-ID":{"description":"Identifier of the exact individual PPF submission returned.","required":true,"style":"simple","schema":{"type":"string"}},"X-C5-TRANSMISSION-DATE":{"description":"Creation timestamp of the bulk C5 transmission, when assigned.","style":"simple","schema":{"type":"string"}},"X-C5-ACKNOWLEDGEMENT-STATUS":{"description":"Status derived from the PPF acknowledgement, when received.","style":"simple","schema":{"type":"string","enum":["ACKNOWLEDGED","REJECTED"]}},"Content-Disposition":{"description":"Attachment disposition with a safe XML download filename.","required":true,"style":"simple","schema":{"type":"string"}},"X-C5-ACKNOWLEDGEMENT-DATE":{"description":"Timestamp when the PPF acknowledgement was received.","style":"simple","schema":{"type":"string"}},"X-C5-TRANSMISSION-ID":{"description":"Identifier of the bulk C5 transmission containing this submission, when assigned.","style":"simple","schema":{"type":"string"}},"X-C5-ACKNOWLEDGEMENT-ID":{"description":"Identifier of the PPF acknowledgement archive, when received.","style":"simple","schema":{"type":"string"}}},"content":{"application/xml":{"schema":{"type":"string"},"example":"\n \n REPORT-EXAMPLE-001\n Example e-reporting submission\n \n 2026-01-15T10:30:00\n \n 10\n \n 0000\n Example Platform\n WK\n \n \n 000000000\n Example Reporting Entity\n SE\n \n \n \n \n 2026-01-01\n 2026-01-31\n \n \n"}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/c5/france/ppf/e-invoicing-submissions/{transmissionId}/xml":{"get":{"tags":["France PPF Submission"],"summary":"Get a France PPF e-invoicing submission.","description":"Retrieves the France PPF e-invoicing submission XML for the provided Peppol transmission id in your workspace, together with available transmission headers.","operationId":"getFranceEInvoicingSubmission","parameters":[{"name":"transmissionId","in":"path","description":"The Peppol transmission id of the France e-invoicing submission.","required":true,"schema":{"type":"string"}},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Authentication failure","content":{"application/xml;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"The France PPF e-invoicing submission XML was retrieved successfully.","headers":{"X-C5-SUBMISSION-ID":{"description":"Identifier of the exact individual PPF submission returned.","required":true,"style":"simple","schema":{"type":"string"}},"X-C5-TRANSMISSION-DATE":{"description":"Creation timestamp of the bulk C5 transmission, when assigned.","style":"simple","schema":{"type":"string"}},"X-C5-ACKNOWLEDGEMENT-STATUS":{"description":"Status derived from the PPF acknowledgement, when received.","style":"simple","schema":{"type":"string","enum":["ACKNOWLEDGED","REJECTED"]}},"Content-Disposition":{"description":"Attachment disposition with a safe XML download filename.","required":true,"style":"simple","schema":{"type":"string"}},"X-C5-ACKNOWLEDGEMENT-DATE":{"description":"Timestamp when the PPF acknowledgement was received.","style":"simple","schema":{"type":"string"}},"X-C5-TRANSMISSION-ID":{"description":"Identifier of the bulk C5 transmission containing this submission, when assigned.","style":"simple","schema":{"type":"string"}},"X-C5-ACKNOWLEDGEMENT-ID":{"description":"Identifier of the PPF acknowledgement archive, when received.","style":"simple","schema":{"type":"string"}}},"content":{"application/xml":{"schema":{"type":"string"},"example":"\n urn.cpro.gouv.fr:1p0:einvoicingextract#Full\n S1\n P_INV-2026-001\n 2026-08-20\n 2026-09-20\n 380\n #PMT# Les frais de recouvrement sont de 40 euros.\n #PMD# En cas de retard de paiement, des pénalités de 3 fois le taux d'intérêt légal seront appliquées.\n #AAB# Aucun escompte n'est accordé pour paiement anticipé.\n EUR\n \n \n \n 1 rue de l'Exemple\n Paris\n 75001\n \n FR\n \n \n \n FR00000000001\n \n VAT\n \n \n \n 000000001\n \n \n \n \n \n \n 000000002_RECEIVER\n \n \n 2 avenue de l'Exemple\n Lyon\n 69001\n \n FR\n \n \n \n FR00000000002\n \n VAT\n \n \n \n 000000002\n \n \n \n \n 200\n \n 1000\n 200\n \n S\n 20\n \n VAT\n \n \n \n \n \n 1000\n \n \n 10\n \n Produit A\n \n \n 50\n \n false\n 50\n \n \n \n \n 5\n \n Service B\n \n \n 100\n \n false\n 100\n \n \n \n"}}},"500":{"description":"The France PPF e-invoicing submission XML could not be retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}},"400":{"description":"No France PPF e-invoicing submission was found for the provided transmission id in the current workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/c5/france/annuaire/peppol-identifiers":{"get":{"tags":["France Annuaire"],"summary":"Find France annuaire Peppol identifiers by SIREN or SIRET","description":"Search the France annuaire by SIREN or SIRET (exactly one must be provided) and return all annuaire registrations effective on the provided date. If the date is omitted, the current date is used. The returned Peppol identifiers are the annuaire IDENTIFIANT values prefixed with the 0225 scheme (for example 0225:996158478_99615847867544). Each record includes claimedByPa: false means that the record exists but is not routable because no real Plateforme Agréée (PA) has claimed it, while true means that a real PA is assigned. The platform identifier is not exposed. An empty list is returned when no effective registrations match.","operationId":"findPeppolIdentifiersBySirenOrSiret","parameters":[{"name":"siren","in":"query","description":"SIREN with exactly 9 digits; mutually exclusive with siret","required":false,"schema":{"type":"string"},"example":"996158478"},{"name":"siret","in":"query","description":"SIRET with exactly 14 digits; mutually exclusive with siren","required":false,"schema":{"type":"string"},"example":"99615847867544"},{"name":"effectiveDate","in":"query","description":"Optional lookup date in ISO format yyyy-MM-dd. If omitted, the current date is used.","required":false,"schema":{"type":"string","format":"date"},"example":"2026-07-08"},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Error performing the France annuaire Peppol identifiers lookup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"}}}},"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"200":{"description":"France annuaire Peppol identifiers lookup performed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnuaireSearchResponseRO"},"example":{"identifiers":[{"peppolIdentifier":"0225:996158478_99615847867544","siren":"996158478","siret":"99615847867544","routage":null,"suffixe":null,"claimedByPa":true,"dateDebut":"2026-07-08","dateFin":null,"dateFinEffective":null}]}}}}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}},"/api/peppol/v1/notifications/{notificationId}":{"delete":{"tags":["Notification"],"summary":"Consume a notification to remove it from the queue","description":"Once consumed, the notification will not be returned anymore when getting the notifications list","operationId":"consumeNotification","parameters":[{"name":"notificationId","in":"path","description":"The id of the notification we want to consume","required":true,"schema":{"type":"integer","format":"int64"},"example":7},{"name":"accessToken","in":"query","description":"The Ademico API access token supplied for your environment. Send this query parameter with every request, using either Basic authentication or OAuth2.","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Authentication failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"SECURITY_ERROR","message":"Invalid authentication credentials"}}}},"400":{"description":"Error consuming notification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationMessage"},"example":{"code":"GENERIC_ERROR","message":"Error consuming notification"}}}},"200":{"description":"Notification consumed successfully"}},"security":[{"BasicAuth":[]},{"OAuth2":[]}]}}},"components":{"schemas":{"AuthenticationSettingsRO":{"type":"object","properties":{"type":{"type":"string","description":"Type of authentication to use for the webhook notifications URL","enum":["NONE","BASIC_AUTH","OAUTH2"]},"user":{"type":"string","description":"Username for BASIC authentication or for OAuth2 token request"},"password":{"type":"string","description":"Password for BASIC authentication or for OAuth2 token request. This field is write-only and will not be returned in responses."},"oauth2":{"$ref":"#/components/schemas/OAuth2SettingsRO"}},"description":"Authentication settings for the URL to which the webhook notifications will be sent"},"OAuth2SettingsRO":{"type":"object","properties":{"authorizationPrefix":{"type":"string","description":"The prefix to use in the Authorization header when sending the OAuth2 token. Typically 'Bearer'."},"tokenUrl":{"type":"string","description":"The URL from which to obtain the OAuth2 token"},"tokenBody":{"type":"string","description":"The body to send in the request to obtain the OAuth2 token. Use key-value pairs separated by '&', e.g. 'grant_type=password&client_id=yourClientId&username=api.user&password=yourPassword'. Each value needs to be URL-encoded, for example if you use special characters like '&', '=', '#', etc. in the password, they should be URL-encoded to '%26', '%3D', '%23', etc."},"tokenExpiresLimitMinutes":{"type":"integer","description":"The number of minutes before the token's expiry when a new token should be obtained. For example, if the token is valid for 60 minutes and this value is set to 5, a new token will be obtained after 55 minutes.","format":"int32"},"tokenHeaders":{"type":"object","additionalProperties":{"type":"string","description":"Additional headers to include in the request to obtain the OAuth2 token"},"description":"Additional headers to include in the request to obtain the OAuth2 token"}},"description":"OAuth2 specific settings. Required if authentication type is OAUTH2."},"WebhookSettingsRO":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether or not webhook notifications are active"},"bulk":{"type":"boolean","description":"Whether or not bulk webhook notifications are supported. If true, multiple events may be sent in a single webhook notification request. If false, each event will be sent in a separate webhook notification request."},"webhookUrl":{"type":"string","description":"The URL to which webhook notifications will be sent"},"authentication":{"$ref":"#/components/schemas/AuthenticationSettingsRO"},"additionalHeaders":{"type":"object","additionalProperties":{"type":"string","description":"Additional headers to include in the webhook notification requests"},"description":"Additional headers to include in the webhook notification requests"}},"description":"Webhooks settings"},"ApplicationMessage":{"type":"object","properties":{"code":{"type":"string","description":"The message code","nullable":true,"example":"GENERIC_ERROR"},"message":{"type":"string","description":"The message description","example":"Details of the occurred error"}},"description":"Contains the details of a message"},"CountryCodeEnumRO":{"type":"string","description":"The country in which the legal entity is registered","example":"BE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","YE","YT","ZA","ZM","ZW"]},"LegalEntityContactRO":{"required":["contactType","email","name"],"type":"object","properties":{"contactType":{"type":"string","description":"The type of the contact (sales, support, etc.)","example":"public"},"name":{"type":"string","description":"The name of the contact (individual or organisational unit)","example":"Your company name"},"phoneNumber":{"type":"string","description":"The public telephone number of the contact","example":"+32 123456"},"email":{"type":"string","description":"The public email address of the contact","example":"info@example.com"}},"description":"The list of contacts"},"LegalEntityDetailsRO":{"required":["countryCode","name"],"type":"object","properties":{"publishInPeppolDirectory":{"type":"boolean","description":"True if the legal entity details are published in the Peppol Directory","example":true},"name":{"type":"string","description":"The legal entity name","example":"Ademico Software"},"countryCode":{"$ref":"#/components/schemas/CountryCodeEnumRO"},"geographicalInformation":{"type":"string","description":"The legal entity's address","example":"204 My street, My City, My Country"},"creationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the legal entity was created in our system","readOnly":true},"registrationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the legal entity was registered in the Peppol network"},"websiteURL":{"type":"string","description":"The legal entity's website","example":"https://ademico-software.com"},"contacts":{"type":"array","description":"The list of contacts","items":{"$ref":"#/components/schemas/LegalEntityContactRO"}},"additionalInformation":{"type":"string","description":"Any additional information relevant to the legal entity"},"peppolAdditionalIdentifiers":{"type":"array","description":"The legal entity's Peppol additional identifiers","items":{"$ref":"#/components/schemas/LegalEntityIdentifierRO"}},"legalIdentifiers":{"type":"array","description":"The legal entity's legal identifiers. For France, include at least one legal identifier with scheme `0002` (SIREN), for example `0002:123456789`.","items":{"$ref":"#/components/schemas/LegalEntityIdentifierRO"}}},"description":"The details of the legal entity which is registered in the Peppol network"},"LegalEntityIdentifierRO":{"required":["identifier","scheme"],"type":"object","properties":{"scheme":{"type":"string","description":"The Participant scheme","example":"0208"},"identifier":{"type":"string","description":"The Participant unique identifier","example":"0552912569"}},"description":"The legal entity identifier is composed of the peppol registration scheme and it's unique identifier eg company registration number. You can have a look for more details in section Participant scheme and identifier"},"LegalEntityUpdateRequestRO":{"required":["legalEntityDetails"],"type":"object","properties":{"legalEntityDetails":{"$ref":"#/components/schemas/LegalEntityDetailsRO"}},"description":"The details needed to update a legal entity"},"LegalEntityPeppolRegistrationDetailsRO":{"required":["peppolIdentifier","supportedDocuments"],"type":"object","properties":{"peppolIdentifier":{"$ref":"#/components/schemas/LegalEntityIdentifierRO"},"supportedDocuments":{"type":"array","description":"The list of supported documents the legal entity can receive. You can have a look for more details in section Supported Peppol documents. For a French sender-only 0225 registration, FR_CDAR_REGULATED is mandatory. FR_CDAR_NONREGULATED, PEPPOL_MESSAGE_LEVEL_RESPONSE_TRANSACTION_3_0 (MLR) and PEPPOL_INVOICE_RESPONSE_TRANSACTION_3_0 (Invoice Response) are optional. No other capabilities are allowed in this profile.","items":{"$ref":"#/components/schemas/PeppolDocumentSchemeEnumRO"}},"peppolRegistration":{"type":"boolean","description":"True to publish the participant and its receiving capabilities in the Peppol network (SML/SMP). False keeps the registration local for sending documents without enabling reception through this API. The sender does not need an existing SML/SMP registration; registration managed by another provider is also supported. A non-empty supportedDocuments list is required in both cases. Setting publishInPeppolDirectory to false only hides the Directory listing; it does not disable reception. For a French sender-only participant using scheme 0225, set this flag to true and provide mandatory FR_CDAR_REGULATED. FR_CDAR_NONREGULATED, MLR and Invoice Response may also be provided, but are not added by default. Requests without FR_CDAR_REGULATED are rejected; it is not added automatically. The identifier must start with a 9-digit SIREN followed by an underscore and non-empty text. See Register a France 0225 identifier for sending only.","example":true}},"description":"The details of the Peppol registration: legal entity scheme, unique identifier and supported Peppol documents. A French sender-only registration uses scheme 0225 and an identifier composed of a 9-digit SIREN, an underscore and a non-empty suffix, for example 123456789_SENDER."},"LegalEntityPeppolRegistrationUpdateRequestRO":{"required":["peppolRegistrationDetails"],"type":"object","properties":{"peppolRegistrationDetails":{"$ref":"#/components/schemas/LegalEntityPeppolRegistrationDetailsRO"}},"description":"The Peppol registration update details"},"PeppolDocumentSchemeEnumRO":{"type":"string","description":"The supported documents the participant can receive.","enum":["PEPPOL_BIS_BILLING_UBL_INVOICE_V3","PEPPOL_BIS_BILLING_UBL_CREDIT_NOTE_V3","PEPPOL_BIS_SELF_BILLING_UBL_INVOICE_V3","PEPPOL_BIS_SELF_BILLING_UBL_CREDIT_NOTE_V3","XRECHNUNG_UBL_INVOICE_V3_0","XRECHNUNG_UBL_CREDIT_NOTE_V3_0","AU_NZ_UBL_INVOICE_V3","AU_NZ_UBL_CREDIT_NOTE_V3","A_NZ_PINT_INVOICE_V1_0","A_NZ_PINT_CREDIT_NOTE_V1_0","A_NZ_PINT_INVOICE_V1_0_WILDCARD","A_NZ_PINT_CREDIT_NOTE_V1_0_WILDCARD","SG_PEPPOL_BIS_BILLING_3_0_INVOICE","SG_PEPPOL_BIS_BILLING_3_0_CREDIT_NOTE","SG_PINT_INVOICE_V1_0","SG_PINT_CREDIT_NOTE_V1_0","PEPPOL_SG_ORDER_BALANCE","MY_PINT_INVOICE_V1_0","MY_PINT_INVOICE_V1_0_WILDCARD","MY_PINT_SELF_BILLING_INVOICE_V1_0","MY_PINT_SELF_BILLING_INVOICE_V1_0_WILDCARD","MY_PINT_CREDIT_NOTE_V1_0","MY_PINT_CREDIT_NOTE_V1_0_WILDCARD","MY_PINT_SELF_BILLING_CREDIT_NOTE_V1_0","MY_PINT_SELF_BILLING_CREDIT_NOTE_V1_0_WILDCARD","SI_UBL_2_0_INVOICE","SI_UBL_2_0_CREDITNOTE","UBL_BE_INVOICE_3_0","UBL_BE_CREDIT_NOTE_3_0","PEPPOL_ORDER_TRANSACTION_3_0_ORDER_ONLY","PEPPOL_ORDER_TRANSACTION_3_0_ADVANCED","PEPPOL_ORDER_CHANGE","PEPPOL_ORDER_CANCELLATION","PEPPOL_ORDER_RESPONSE_ADVANCED","PEPPOL_MESSAGE_LEVEL_RESPONSE_TRANSACTION_3_0","PEPPOL_INVOICE_RESPONSE_TRANSACTION_3_0","JP_PINT_INVOICE_V1_0","JP_PINT_INVOICE_V1_0_WILDCARD","PEPPOL_PINT_INVOICE_1_0","PEPPOL_PINT_CREDIT_NOTE_V1_0","FR_CII_INVOICE_CIUS_REGULATED","FR_CII_INVOICE_CIUS_NONREGULATED","FR_CII_INVOICE_EXTENSION_REGULATED","FR_CII_INVOICE_EXTENSION_NONREGULATED","FR_UBL_INVOICE_CIUS_REGULATED","FR_UBL_INVOICE_CIUS_NONREGULATED","FR_UBL_INVOICE_EXTENSION_REGULATED","FR_UBL_INVOICE_EXTENSION_NONREGULATED","FR_UBL_CREDIT_NOTE_CIUS_REGULATED","FR_UBL_CREDIT_NOTE_CIUS_NONREGULATED","FR_UBL_CREDIT_NOTE_EXTENSION_REGULATED","FR_UBL_CREDIT_NOTE_EXTENSION_NONREGULATED","FR_CDAR_REGULATED","FR_CDAR_NONREGULATED","FR_FACTUR_X_REGULATED","FR_FACTUR_X_NONREGULATED"]},"LegalEntityKycSignRequestRO":{"required":["pdfDocumentBase64"],"type":"object","properties":{"pdfDocumentBase64":{"type":"string","description":"The PDF authorisation document"}},"description":"The PDF authorisation request"},"FileSubmissionResultError":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/ApplicationMessage"},"validationReport":{"$ref":"#/components/schemas/PeppolValidationReportRO"}}},"PeppolValidationReportRO":{"type":"object","properties":{"globalStatus":{"$ref":"#/components/schemas/ValidationReportStatus"},"validatedXmlName":{"type":"string"},"xmlValidationReport":{"$ref":"#/components/schemas/XmlValidationReportRO"},"xsdValidationReport":{"$ref":"#/components/schemas/XsdValidationReportRO"},"schematronValidationReport":{"type":"array","items":{"$ref":"#/components/schemas/SchematronValidationReportRO"}},"warningsCount":{"type":"integer","format":"int32"},"errorsCount":{"type":"integer","format":"int32"},"xmlContent":{"type":"string"}}},"SchematronValidationMessageRO":{"type":"object","properties":{"errorLevel":{"$ref":"#/components/schemas/ValidationErrorLevel"},"description":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"columnNumber":{"type":"integer","format":"int32"},"schematronTest":{"type":"string"},"errorId":{"type":"string"},"xpath":{"type":"string"},"xpathWithoutNamespaces":{"type":"string"}}},"SchematronValidationReportRO":{"type":"object","properties":{"validatedWith":{"type":"string"},"reportStatus":{"$ref":"#/components/schemas/ValidationReportStatus"},"warningsCount":{"type":"integer","format":"int32"},"errorsCount":{"type":"integer","format":"int32"},"schematronValidationMessages":{"type":"array","items":{"$ref":"#/components/schemas/SchematronValidationMessageRO"}},"validationType":{"$ref":"#/components/schemas/ValidationType"}}},"ValidationErrorLevel":{"type":"string","enum":["INFO","WARNING","ERROR"]},"ValidationReportStatus":{"type":"string","enum":["SUCCESS","WARNING","ERROR"]},"ValidationType":{"type":"string","enum":["XML_SYNTAX","XSD_SCHEMA","SCHEMATRON"]},"XmlValidationMessageRO":{"type":"object","properties":{"errorLevel":{"$ref":"#/components/schemas/ValidationErrorLevel"},"description":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"columnNumber":{"type":"integer","format":"int32"}}},"XmlValidationReportRO":{"type":"object","properties":{"validatedWith":{"type":"string"},"reportStatus":{"$ref":"#/components/schemas/ValidationReportStatus"},"warningsCount":{"type":"integer","format":"int32"},"errorsCount":{"type":"integer","format":"int32"},"xmlValidationMessages":{"type":"array","items":{"$ref":"#/components/schemas/XmlValidationMessageRO"}},"validationType":{"$ref":"#/components/schemas/ValidationType"}}},"XsdValidationMessageRO":{"type":"object","properties":{"errorLevel":{"$ref":"#/components/schemas/ValidationErrorLevel"},"description":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"columnNumber":{"type":"integer","format":"int32"}}},"XsdValidationReportRO":{"type":"object","properties":{"validatedWith":{"type":"string"},"reportStatus":{"$ref":"#/components/schemas/ValidationReportStatus"},"warningsCount":{"type":"integer","format":"int32"},"errorsCount":{"type":"integer","format":"int32"},"xsdValidationMessages":{"type":"array","items":{"$ref":"#/components/schemas/XsdValidationMessageRO"}},"validationType":{"$ref":"#/components/schemas/ValidationType"}}},"C5DocumentSubmissionResultRO":{"type":"object","properties":{"status":{"type":"string","enum":["NOT_SENDING","SCHEDULED","SUBMITTED","ERROR","ACKNOWLEDGED","REJECTED"]},"details":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationMessage"}}},"description":"The C5 submission result if C5 is activated","example":{"status":"SCHEDULED","details":[]}},"DocumentSubmissionResultRO":{"type":"object","properties":{"transmissionId":{"type":"string","description":"Document transmission id","example":"803828d52d4911ed85f512ef9c5638d0"},"documentId":{"type":"string","description":"The document id","example":"pbe000512-1"},"documentTypeEnum":{"$ref":"#/components/schemas/PeppolDocumentTypeEnum"},"sender":{"type":"string","description":"The sender of the document eg the Seller","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the document eg the Buyer","example":"0208:1999999943"},"sbdhInstanceIdentifier":{"type":"string","description":"The SBDH instance identifier used when sending the document","example":"6b56b28947e511eda0b802bb4e4747f9"},"c5SubmissionResult":{"$ref":"#/components/schemas/C5DocumentSubmissionResultRO"}},"description":"Contains the transmission details(eg transmissionId) that can be used later on to identify the document transmission"},"PeppolDocumentTypeEnum":{"type":"string","description":"The type of the document reported to C5","example":"INVOICE","enum":["INVOICE","CREDIT_NOTE","CII_INVOICE","FACTURX","ORDER","ORDER_ADVANCED","ORDER_CHANGE","ORDER_CANCELLATION","ORDER_RESPONSE_ADVANCED","SG_ORDER_BALANCE","APPLICATION_RESPONSE","CDAR_RESPONSE","E_REPORTING"]},"LegalEntityCreateRequestRO":{"required":["legalEntityDetails"],"type":"object","properties":{"legalEntityDetails":{"$ref":"#/components/schemas/LegalEntityDetailsRO"},"peppolRegistrations":{"type":"array","description":"The details of the legal entity registration in the Peppol network","items":{"$ref":"#/components/schemas/LegalEntityPeppolRegistrationDetailsRO"}}},"description":"The request to create a legal entity and optionally register it in the Peppol network"},"LegalEntityCreateResponseRO":{"type":"object","properties":{"legalEntityId":{"type":"integer","description":"The legal entity id which was created","format":"int64"}},"description":"The response details following the creation of a legal entity"},"LegalEntityPeppolRegistrationCreateRequestRO":{"required":["peppolRegistrationDetails"],"type":"object","properties":{"peppolRegistrationDetails":{"$ref":"#/components/schemas/LegalEntityPeppolRegistrationDetailsRO"}},"description":"The details needed to register a legal entity in the Peppol network"},"LegalEntityPeppolRegistrationCreateResponseRO":{"type":"object","properties":{"peppolRegistrationId":{"type":"integer","description":"The registration id of a legal entity Peppol identifier which was created","format":"int64"}},"description":"The response details following the registration of a Peppol identifier for a legal entity"},"LegalEntityKycCorpassInitiateRequestRO":{"required":["signerEmail","signerName"],"type":"object","properties":{"signerName":{"type":"string","description":"The name of the person who will sign the Peppol registration via Corppass","example":"John Doe"},"signerEmail":{"type":"string","description":"The email address of the person who will sign the Peppol registration via Corppass","example":"john.doe@example.com"}},"description":"The request used to initiate the KYC process"},"LegalEntityKycCorpassInitiateResponseRO":{"type":"object","properties":{"signingLink":{"type":"string","description":"The Corppass signing URL returned for pending KYC","example":"https://example.com/kyc"}},"description":"The response details following the initiation of Corppass KYC"},"LegalEntityC5CorpassDeactivateRequestRO":{"required":["signerEmail","signerName"],"type":"object","properties":{"signerName":{"type":"string","description":"The name of the person who will sign the C5 deactivation via Corppass","example":"John Doe"},"signerEmail":{"type":"string","description":"The email address of the person who will sign the C5 deactivation via Corppass","example":"john.doe@example.com"}},"description":"The request used to initiate the C5 deactivation"},"LegalEntityC5CorpassActivateRequestRO":{"required":["signerEmail","signerName"],"type":"object","properties":{"signerName":{"type":"string","description":"The name of the person who will sign the C5 activation via Corppass","example":"John Doe"},"signerEmail":{"type":"string","description":"The email address of the person who will sign the C5 activation via Corppass","example":"john.doe@example.com"}},"description":"The request used to initiate the C5 activation"},"LegalEntityC5CorpassActivateResponseRO":{"type":"object","properties":{"signingLink":{"type":"string","description":"The Corppass signing URL returned for pending C5 activation","example":"https://example.com/c5-activation"}},"description":"The response details following the initiation of Corppass C5 activation"},"CdarAmountRO":{"required":["amount","currencyCode","type","vatRate"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/CdarAmountTypeEnumRO"},"amount":{"type":"number","description":"The monetary amount","example":600.0},"currencyCode":{"type":"string","description":"The ISO 4217 currency code","example":"EUR"},"vatRate":{"type":"number","description":"The applicable VAT rate","example":20.0}},"description":"An amount reported in a detailed CDAR document status"},"CdarAmountTypeEnumRO":{"type":"string","description":"French PPF amount type reported in a CDAR document status","example":"MEN","enum":["RAP","ESC","RAB","REM","MPA","MEN"]},"CdarAttachmentRO":{"required":["content"],"type":"object","properties":{"content":{"type":"string","description":"The attachment content encoded as Base64 in the JSON request","format":"byte","example":"SlZCRVJpMHhMalFLLi4u"},"filename":{"type":"string","description":"The attachment filename","example":"supporting-document.pdf"},"mimeCode":{"type":"string","description":"The MIME type of the attachment","example":"application/pdf"},"format":{"type":"string","description":"The attachment format","example":"PDF"}},"description":"A binary attachment associated with the document referenced by the CDAR"},"CdarDetailedStatusRO":{"type":"object","properties":{"reasonCode":{"type":"string","description":"The applicable French status motif code from XP Z12-012 Annexe A","example":"TX_TVA_ERR"},"reasonText":{"type":"string","description":"The human-readable status motif","example":"Taux de TVA erroné"},"requestedActionCode":{"type":"string","description":"The requested-action code from the French CDAR code list","example":"NIN"},"requestedAction":{"type":"string","description":"The human-readable action requested from the counterparty","example":"Créer une Facture Rectificative"},"sequenceNumber":{"minimum":1,"type":"integer","description":"The incremental sequence number of this detailed status. When omitted, a stable value is allocated automatically","format":"int32","example":1},"notes":{"type":"array","description":"The notes attached to this detailed status. Optional.","items":{"$ref":"#/components/schemas/CdarNoteRO"}},"amounts":{"type":"array","description":"The amounts reported for this detailed status, such as MEN or RAP. Optional.","items":{"$ref":"#/components/schemas/CdarAmountRO"}},"documentCharacteristics":{"type":"array","description":"Structured characteristics of the referenced document, such as paired DIV/DVA invalid and expected values. Optional.","items":{"$ref":"#/components/schemas/CdarDocumentCharacteristicRO"}}},"description":"A detailed document status block inside a referenced CDAR document"},"CdarDocumentCharacteristicRO":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the affected document data or EN 16931 business term","example":"BT-152"},"typeCode":{"type":"string","description":"The French CDAR characteristic type code. DIV identifies an invalid value and DVA its expected valid value","example":"DIV"},"valueChanged":{"type":"boolean","description":"Whether the reported value is intended to replace the current document value","example":true},"name":{"type":"string","description":"The human-readable name of the affected data","example":"Taux TVA"},"location":{"type":"string","description":"The XPath locating the affected data in the referenced XML document","example":"/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent"},"valuePercent":{"type":"number","description":"The percentage value reported by this characteristic","example":10.0}},"description":"A structured characteristic of the referenced document, such as an invalid value or its expected replacement"},"CdarNoteRO":{"type":"object","properties":{"contentCode":{"type":"string","description":"The management-rule code that caused the reported error, when applicable","example":"G1.24"},"content":{"type":"string","description":"The human-readable note content","example":"We have refused the invoice because the VAT reference is missing. Please provide the VAT reference in order to get the invoice approved."},"subjectCode":{"type":"string","description":"The file, line, or XML element associated with the note. This maps to IncludedNote/SubjectCode and is not a substitute for SpecifiedDocumentCharacteristic/ID","example":"ram:RateApplicablePercent"}},"description":"A note attached either to the CDAR exchanged document or to a specified document status"},"CdarPartyRO":{"type":"object","properties":{"globalId":{"type":"string","description":"The global identifier of the party","example":"0225:123456789_12345678911111"},"legalId":{"type":"string","description":"The legal identifier of the party","example":"0002:123456789"},"name":{"type":"string","description":"The display name of the party","example":"Company ABC"}},"description":"A trade party used in the CDAR exchanged document or referenced document"},"CdarRO":{"required":["referencedDocument"],"type":"object","properties":{"id":{"type":"string","description":"The CDAR document identifier. Optional (it will be autogenerated if not provided)","example":"INV123-210"},"issuer":{"$ref":"#/components/schemas/CdarPartyRO"},"recipient":{"$ref":"#/components/schemas/CdarPartyRO"},"referencedDocument":{"$ref":"#/components/schemas/CdarReferencedDocumentRO"},"notes":{"type":"array","items":{"$ref":"#/components/schemas/CdarNoteRO"}}},"description":"Structured payload used to build a CrossDomainAcknowledgementAndResponse (CDAR) document"},"CdarReferencedDocumentRO":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the referenced document","example":"INV123"},"typeCode":{"type":"string","description":"The type code of the referenced document","example":"380"},"issueDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","type":"string","description":"The local date of the referenced document. Offset-less values are interpreted deterministically without using the server timezone","example":"2025-11-20T00:00:00"},"receiptDateTime":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","type":"string","description":"The local date and time when the referenced document was received. Offset-less values are interpreted deterministically without using the server timezone","example":"2025-07-01T16:10:00"},"status":{"$ref":"#/components/schemas/DocumentStatusEnumRO"},"issuer":{"$ref":"#/components/schemas/CdarPartyRO"},"attachments":{"type":"array","description":"Optional binary attachments associated with the referenced document.\n\nConcrete cases in the current normative XP Z12-014 Annex A v1.4 include:\n\n- **Subcontracting with direct payment:** a CDAR with status **224 - Demande de Paiement Direct** attaches invoice F1 using MDT-96. It is mandatory where the B2B transaction falls under the French public-procurement rules.\n- **Factoring:** CDAR statuses 225/226/228 may be sent to the factor with the invoice attached in base64.\n- **Third-party payer or media-agent workflows:** the invoice can be attached when the CDAR is used to pass it to a party that does not already possess it.","items":{"$ref":"#/components/schemas/CdarAttachmentRO"}},"detailedStatuses":{"type":"array","description":"Detailed specified document statuses, typically used for rejection details","items":{"$ref":"#/components/schemas/CdarDetailedStatusRO"}}},"description":"The document referenced by the CDAR (eg the original invoice/credit note that is being refused, accepted, or otherwise responded to)"},"DocumentStatusEnumRO":{"type":"string","description":"The current document status","example":"SENT","enum":["QUEUED","SENT","SEND_FAILED","TECHNICAL_ACCEPTANCE","BUYER_ACKNOWLEDGE","IN_PROCESS","UNDER_QUERY","CONDITIONALLY_ACCEPTED","REJECTED","ACCEPTED","PARTIALLY_PAID","FULLY_PAID","FR_DEPOSITED","FR_ISSUED","FR_RECEIVED","FR_MADE_AVAILABLE","FR_TAKEN_CARE_OF","FR_APPROVED","FR_PARTIALLY_APPROVED","FR_IN_DISPUTE","FR_SUSPENDED","FR_COMPLETED","FR_REFUSED","FR_PAID","FR_COLLECTED","FR_REJECTED","FR_FLUX_RECEIVABLE","FR_FLUX_IRRECEIVABLE","FR_FLUX_DEPOSITED","FR_FLUX_REJECTED"]},"ClarificationCodeEnum":{"type":"string","description":"Clarification code","example":"LEG","enum":["NON","REF","LEG","REC","QUA","DEL","PRI","QTY","ITM","PAY","UNR","FIN","PPD","NOA","PIN","NIN","CNF","CNP","CNA","OTH"]},"ClarificationTypeEnum":{"type":"string","description":"Clarification type","example":"OPStatusReason","enum":["OPStatusReason","OPStatusAction"]},"InvoiceClarificationRO":{"required":["clarificationCode","clarificationType"],"type":"object","properties":{"clarificationType":{"$ref":"#/components/schemas/ClarificationTypeEnum"},"clarificationCode":{"$ref":"#/components/schemas/ClarificationCodeEnum"},"clarification":{"type":"string","description":"Clarification description","example":"VAT Reference not found"}},"description":"Clarification to state the Buyer's reason for the status and/or any expected action from the Seller's side"},"InvoiceResponseCodeEnumRO":{"type":"string","description":"The Invoice Response status code","example":"RE","enum":["AB","IP","UQ","CA","RE","AP","PD"]},"InvoiceResponseRO":{"required":["invoiceTransmissionId","responseCode"],"type":"object","properties":{"invoiceResponseId":{"type":"string","description":"Identifier of the Invoice Response. If not provided, it will be auto-generated","example":"d4b52c6f1f0b11f1b23f0c3799f7d36b"},"invoiceTransmissionId":{"type":"string","description":"Invoice/Credit Note transmission id","example":"803828d52d4911ed85f512ef9c5638d0"},"responseCode":{"$ref":"#/components/schemas/InvoiceResponseCodeEnumRO"},"note":{"type":"string","description":"A note providing more details for the Invoice Response","nullable":true,"example":"The invoice has been rejected"},"effectiveDate":{"type":"string","description":"The date when the status became effective.","format":"date"},"invoiceClarifications":{"type":"array","description":"A list of clarifications to state the Buyer's reason for the status and/or any expected action from the Seller's side","items":{"$ref":"#/components/schemas/InvoiceClarificationRO"}}},"description":"Contains the Invoice Response details"},"FranceFacturXPartyRO":{"required":["peppolIdentifier","siren"],"type":"object","properties":{"peppolIdentifier":{"type":"string","description":"French Peppol participant identifier used for routing, including the 0225 scheme","example":"0225:055291256"},"siren":{"type":"string","description":"French legal entity identifier (SIREN), containing exactly 9 digits","example":"055291256"},"vatIdentifier":{"type":"string","description":"Optional French VAT identifier. A deterministic dummy value from the template is used when omitted.","example":"FR40055291256"}},"description":"Buyer identifiers inserted into the built-in CII template"},"FranceFacturXTemplateGenerationRequestRO":{"required":["buyer","seller"],"type":"object","properties":{"seller":{"$ref":"#/components/schemas/FranceFacturXPartyRO"},"buyer":{"$ref":"#/components/schemas/FranceFacturXPartyRO"},"language":{"type":"string","description":"Language of the human-readable invoice in the generated PDF. Defaults to French when omitted","default":"FR","enum":["FR","EN"]}}},"FranceFacturXGenerationFilesRO":{"required":["cii"],"type":"object","properties":{"cii":{"type":"string","description":"Factur-X EN16931 CII XML document","format":"binary"},"pdf":{"type":"string","description":"Optional human-readable source document in PDF/A-1 or PDF/A-3 format. When omitted, it is generated from the CII","format":"binary"}}},"IrasSubmissionResultRO":{"type":"object","properties":{"sbdhTransmissionId":{"type":"string","description":"SBDH instance identifier","example":"803828d52d4911ed85f512ef9c5638d0"},"acknowledgementId":{"type":"string","description":"Acknowledgement id received from IRAS","example":"803828d52d4911ed85f512ef9c5638d0"},"documentId":{"type":"string","description":"The document id","example":"pbe000512-1"},"documentTypeEnum":{"$ref":"#/components/schemas/PeppolDocumentTypeEnum"},"sender":{"type":"string","description":"The sender of the document eg the Seller","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the document eg the Buyer","example":"0208:1999999943"},"irasReporter":{"type":"string","description":"The identifier of the participant who reports to IRAS","example":"0208:1999999943"}}},"C5SubmissionResultRO":{"type":"object","properties":{"submissionId":{"type":"string","description":"Unique identifier of this submission","example":"FFE1025A_PPF230_PPF2301025177711742550002"},"c5TransmissionId":{"type":"string","description":"Unique identifier of the transmission to C5 for this submission","example":"FFE1025A_PPF230_PPF2301025177711742570001"},"documentId":{"type":"string","description":"The identifier of the submitted document","example":"pbe000512-1"},"reporter":{"type":"string","description":"The reporter of this submission eg the Seller","example":"0002:123456789"},"receiver":{"type":"string","description":"The receiver of this submission (C5)","example":"PPF","enum":["IRAS","PPF"]},"status":{"type":"string","description":"The C5 submission status","example":"SUBMITTED","enum":["NOT_SENDING","SCHEDULED","SUBMITTED","ERROR","ACKNOWLEDGED","REJECTED"]}},"description":"Contains the submission details(eg submissionId) that can be used later on to identify the C5 submission and to check its status"},"DocumentCountRO":{"type":"object","properties":{"documentCount":{"type":"integer","format":"int64"}}},"EventTypeRO":{"type":"string","description":"The event type","example":"DOCUMENT_SENT","enum":["DOCUMENT_SENT","DOCUMENT_SEND_FAILED","MLR_RECEIVED","INVOICE_RESPONSE_RECEIVED","CDAR_RECEIVED","DOCUMENT_RECEIVED","DOCUMENT_RECEIVE_FAILED","INVOICE_RESPONSE_SENT","INVOICE_RESPONSE_SEND_FAILED","CDAR_SENT","CDAR_SEND_FAILED","LEGAL_ENTITY_KYC_CORPPASS_ACTIVATED","LEGAL_ENTITY_KYC_CORPPASS_ACTIVATION_ERROR","LEGAL_ENTITY_C5_ACTIVATED","LEGAL_ENTITY_C5_ACTIVATION_ERROR","LEGAL_ENTITY_C5_DEACTIVATED","LEGAL_ENTITY_C5_DEACTIVATION_ERROR","IRAS_DOCUMENT_SENT","IRAS_DOCUMENT_SEND_FAILED","C5_DOCUMENT_ENQUEUED","C5_DOCUMENT_SUBMITTED","C5_DOCUMENT_SUBMISSION_FAILED","C5_DOCUMENT_ACKNOWLEDGED","C5_DOCUMENT_NOT_ACKNOWLEDGED","C5_DOCUMENT_PROCESSED","C5_DOCUMENT_PROCESSING_FAILED"]},"PeppolDocumentTypeRO":{"type":"string","description":"The document type: Eg INVOICE, CREDIT_NOTE, ORDER","example":"INVOICE","enum":["INVOICE","CREDIT_NOTE","CII_INVOICE","ORDER","ORDER_ADVANCED","SG_ORDER_BALANCE","ORDER_CHANGE","ORDER_CANCELLATION","ORDER_RESPONSE_ADVANCED","FACTURX_BASIC_WL","FACTURX_EN16931","FACTURX_EXTENDED","CDAR_RESPONSE"]},"C5ReceivingNotificationRO":{"required":["eventType","notificationDate","notificationId"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"transmissionId":{"type":"string","description":"The Peppol transmission identifier of the related document, when available. It is absent for standalone submissions such as France e-reporting","example":"803828d52d4911ed85f512ef9c5638d0"},"sbdhTransmissionId":{"type":"string","description":"SBDH instance identifier","example":"6b56b28947e511eda0b802bb4e4747f9"},"submissionId":{"type":"string","description":"C5 submission identifier. This identifies the individual file submitted to C5","example":"FFE1025A_PPF230_PPF2301025177711742550002"},"c5TransmissionId":{"type":"string","description":"C5 transmission identifier. This identifies the bundle sent to C5","example":"FFE1025A_PPF230_PPF2301025177738641389659"},"acknowledgementId":{"type":"string","description":"Identifier of the incoming C5 acknowledgement or business-response that produced this notification","example":"CFE1025A_PPF230_PPF2301025177738641389659"},"acknowledgementDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"Date reported in the acknowledgement or business response received from C5","example":"2023-07-25T11:03:26.688"},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"documentId":{"type":"string","description":"The internal id of the document reported to C5","example":"INV123"},"peppolDocumentType":{"$ref":"#/components/schemas/PeppolDocumentTypeEnum"},"documentStatus":{"$ref":"#/components/schemas/DocumentStatusEnumRO"},"documentStatusDetails":{"type":"array","description":"Structured details returned by C5 for the document status","items":{"$ref":"#/components/schemas/DocumentStatusDetailRO"}},"sender":{"type":"string","description":"The sender of the document eg the Seller","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the document eg the Buyer","example":"0208:1999999943"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}},"success":{"type":"boolean","description":"Whether the C5 lifecycle stage represented by eventType succeeded","example":true}},"description":"The details of the notification received from C5"},"C5SendingNotificationRO":{"required":["eventType","notificationDate","notificationId"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"transmissionId":{"type":"string","description":"The Peppol transmission identifier of the related document, when available. It is absent for standalone submissions such as France e-reporting","example":"803828d52d4911ed85f512ef9c5638d0"},"sbdhTransmissionId":{"type":"string","description":"SBDH instance identifier","example":"6b56b28947e511eda0b802bb4e4747f9"},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"documentId":{"type":"string","description":"The internal id of the document reported to C5","example":"INV123"},"peppolDocumentType":{"$ref":"#/components/schemas/PeppolDocumentTypeEnum"},"sender":{"type":"string","description":"The sender of the document eg the Seller","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the document eg the Buyer","example":"0208:1999999943"},"success":{"type":"boolean","description":"Whether the C5 lifecycle stage represented by eventType succeeded","example":true},"submissionId":{"type":"string","description":"C5 submission identifier. This identifies the individual file submitted to C5","example":"FFE1025A_PPF230_PPF2301025177711742550002"},"c5TransmissionId":{"type":"string","description":"C5 transmission identifier. This identifies the outbound bundle sent to C5 and can be absent while the entry is only enqueued","example":"FFE1025A_PPF230_PPF2301025177738641389659"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}}},"description":"The details of the C5 notification"},"CDARReceivingNotificationRO":{"required":["currentDocument","documentStatus","eventType","notificationDate","notificationId","receiver","referencedDocument","sender"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"documentStatus":{"$ref":"#/components/schemas/DocumentStatusEnumRO"},"sender":{"type":"string","description":"The sender of the Invoice/Credit Note","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the Invoice/Credit Note","example":"0208:1999999943"},"currentDocument":{"$ref":"#/components/schemas/DocumentIdentificationDetailsRO"},"referencedDocument":{"$ref":"#/components/schemas/DocumentIdentificationDetailsRO"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}},"detailedStatuses":{"type":"array","description":"Detailed status and notes, if available. Typically used for rejection details","items":{"$ref":"#/components/schemas/CdarDetailedStatusRO"}},"notes":{"type":"array","description":"Notes attached to the exchanged CDAR document, if available","items":{"$ref":"#/components/schemas/CdarNoteRO"}}},"description":"The details of the CDAR receiving notification"},"CDARSendingNotificationRO":{"required":["currentDocument","documentStatus","eventType","notificationDate","notificationId","receiver","referencedDocument","sender"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"documentStatus":{"$ref":"#/components/schemas/DocumentStatusEnumRO"},"sender":{"type":"string","description":"The sender of the CDAR","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the CDAR","example":"0208:1999999943"},"currentDocument":{"$ref":"#/components/schemas/DocumentIdentificationDetailsRO"},"referencedDocument":{"$ref":"#/components/schemas/DocumentIdentificationDetailsRO"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}},"detailedStatuses":{"type":"array","description":"Detailed status and notes, if available. Typically used for rejection details","items":{"$ref":"#/components/schemas/CdarDetailedStatusRO"}},"notes":{"type":"array","description":"Notes attached to the exchanged CDAR document, if available","items":{"$ref":"#/components/schemas/CdarNoteRO"}}},"description":"The details of the CDAR sending notification"},"DocumentIdentificationDetailsRO":{"required":["documentId","peppolDocumentType","transmissionId"],"type":"object","properties":{"documentId":{"type":"string","description":"The identifier of the document itself","example":"INV1234"},"peppolDocumentType":{"$ref":"#/components/schemas/PeppolDocumentTypeRO"},"transmissionId":{"type":"string","description":"The transmission unique identifier","example":"803828d52d4911ed85f512ef9c5638d0"}},"description":"The identification details of a document exchanged in a transmission"},"DocumentReceivingFailedNotificationRO":{"required":["documentId","eventType","notificationDate","notificationId","peppolDocumentType","receivedDate","receiver","sender"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"documentId":{"type":"string","description":"The document id of the Invoice/Credit Note, if available","example":"pbe000512-1"},"peppolDocumentType":{"$ref":"#/components/schemas/PeppolDocumentTypeRO"},"sender":{"type":"string","description":"The sender of the document","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the document","example":"0208:1999999943"},"receivedDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the document failed to be received","example":"2023-07-25T11:03:26.688"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}}},"description":"The details of the document receive failure notification"},"DocumentStatusDetailRO":{"type":"object","properties":{"reasonCode":{"type":"string","description":"Status reason code returned by C5","example":"REJ_SEMAN"},"reasonText":{"type":"string","description":"Status reason text returned by C5","example":"Analyse du format sémantique"},"sequenceNumber":{"type":"integer","description":"Sequence number for the document status detail","format":"int32","example":2},"notes":{"type":"array","description":"Notes returned by C5 for this document status detail","items":{"$ref":"#/components/schemas/DocumentStatusNoteRO"}}},"description":"Structured detail returned by C5 for a document status"},"DocumentStatusNoteRO":{"type":"object","properties":{"contentCode":{"type":"string","description":"Content code returned by C5","example":"G1.05"},"contentText":{"type":"string","description":"Content text returned by C5","example":"L'identifiant de la facture TT-19 ne respecte pas le format attendu."},"subjectCode":{"type":"string","description":"Subject code returned by C5","example":"/Report/TransactionsReport/Invoice[2]/ID"}},"description":"Note returned by C5 within a document status detail"},"InvoiceReceivingNotificationRO":{"required":["documentId","eventType","notificationDate","notificationId","peppolDocumentType","receivedDate","receiver","sender","transmissionId"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"transmissionId":{"type":"string","description":"The transmission unique identifier","example":"803828d52d4911ed85f512ef9c5638d0"},"sbdhTransmissionId":{"type":"string","description":"SBDH instance identifier","example":"6b56b28947e511eda0b802bb4e4747f9"},"documentId":{"type":"string","description":"The document id of the Invoice/Credit Note","example":"pbe000512-1"},"peppolDocumentType":{"$ref":"#/components/schemas/PeppolDocumentTypeRO"},"sender":{"type":"string","description":"The sender of the Invoice/Credit Note","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the Invoice/Credit Note","example":"0208:1999999943"},"receivedDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the Invoice/Credit Note was received","example":"2023-07-25T11:03:26.688"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}}},"description":"The details of the Invoice/Credit Note receiving notification"},"InvoiceResponseReceivingNotificationRO":{"required":["documentId","documentStatus","eventType","invoiceResponse","notificationDate","notificationId","peppolDocumentType","receiver","sbdhInstanceIdentifier","sender","transmissionId"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"transmissionId":{"type":"string","description":"The transmission unique identifier","example":"803828d52d4911ed85f512ef9c5638d0"},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"documentId":{"type":"string","description":"The document id of the Invoice/Credit Note","example":"pbe000512-1"},"peppolDocumentType":{"$ref":"#/components/schemas/PeppolDocumentTypeRO"},"documentStatus":{"$ref":"#/components/schemas/DocumentStatusEnumRO"},"sender":{"type":"string","description":"The sender of the Invoice/Credit Note","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the Invoice/Credit Note","example":"0208:1999999943"},"invoiceResponse":{"$ref":"#/components/schemas/InvoiceResponseRO"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}},"sbdhInstanceIdentifier":{"type":"string","description":"The SBDH instance identifier","example":"6b56b28947e511eda0b802bb4e4747f9"}},"description":"The details of the Invoice Response receiving notification"},"InvoiceResponseSendingNotificationRO":{"required":["documentId","documentStatus","eventType","notificationDate","notificationId","receiver","sbdhInstanceIdentifier","sender","transmissionId"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"transmissionId":{"type":"string","description":"The transmission unique identifier","example":"803828d52d4911ed85f512ef9c5638d0"},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"documentId":{"type":"string","description":"The document id of the Invoice/Credit Note for which we have sent an Invoice Response","example":"pbe000512-1"},"documentStatus":{"$ref":"#/components/schemas/DocumentStatusEnumRO"},"sender":{"type":"string","description":"The sender of the Invoice Response","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the Invoice Response","example":"0208:1999999943"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}},"sbdhInstanceIdentifier":{"type":"string","description":"The SBDH instance identifier","example":"6b56b28947e511eda0b802bb4e4747f9"}},"description":"The details of the Invoice Response sending notification"},"InvoiceSendingNotificationRO":{"required":["documentId","documentStatus","eventType","notificationDate","notificationId","peppolDocumentType","receiver","sender","transmissionId"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"transmissionId":{"type":"string","description":"The transmission unique identifier","example":"803828d52d4911ed85f512ef9c5638d0"},"sbdhTransmissionId":{"type":"string","description":"SBDH instance identifier","example":"6b56b28947e511eda0b802bb4e4747f9"},"documentId":{"type":"string","description":"The document id of the Invoice/Credit Note","example":"pbe000512-1"},"peppolDocumentType":{"$ref":"#/components/schemas/PeppolDocumentTypeRO"},"documentStatus":{"$ref":"#/components/schemas/DocumentStatusEnumRO"},"sender":{"type":"string","description":"The sender of the Invoice/Credit Note","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the Invoice/Credit Note","example":"0208:1999999943"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}}},"description":"The details of the Invoice/Credit Note sending notification"},"IrasSendingNotificationRO":{"required":["eventType","notificationDate","notificationId","transmissionId"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"transmissionId":{"type":"string","description":"The transmission unique identifier of the Invoice/Credit Note","example":"803828d52d4911ed85f512ef9c5638d0"},"sbdhTransmissionId":{"type":"string","description":"SBDH instance identifier","example":"6b56b28947e511eda0b802bb4e4747f9"},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"documentId":{"type":"string","description":"The document id","example":"pbe000512-1"},"peppolDocumentType":{"$ref":"#/components/schemas/PeppolDocumentTypeEnum"},"sender":{"type":"string","description":"The sender of the document eg the Seller","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the document eg the Buyer","example":"0208:1999999943"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}},"success":{"type":"boolean","description":"The status of the success","example":true},"acknowledgementId":{"type":"string","description":"Acknowledgement id received from IRAS","example":"803828d52d4911ed85f512ef9c5638d0"}},"description":"The details of the Invoice/Credit Note IRAS sending notification"},"LegalEntityCorppassC5NotificationRO":{"required":["eventType","initiatedDate","legalEntityId","legalEntityRegistrationId","notificationDate","notificationId","signerEmail","signerName"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"legalEntityId":{"type":"integer","description":"The legal entity id for which the Corppass C5 was performed","format":"int64","example":7},"legalEntityRegistrationId":{"type":"integer","description":"The legal entity Peppol registration id for which the Corppass C5 was performed","format":"int64","example":9},"signerName":{"type":"string","description":"The name of the person who signs the Peppol registration C5 in Corppass","example":"John Doe"},"signerEmail":{"type":"string","description":"The email address of the person who signs the Peppol registration C5 in Corppass","example":"john.doe@example.com"},"initiatedDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the Corppass activation was initiated","example":"2023-07-25T11:03:26.688"},"activationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the Corppass activation was completed","example":"2023-07-25T11:03:26.688"},"activationErrorDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the Corppass activation failed","example":"2023-07-25T11:03:26.688"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}}},"description":"The details of the Corppass C5 notification"},"LegalEntityCorppassKycNotificationRO":{"required":["eventType","initiatedDate","legalEntityId","legalEntityRegistrationId","notificationDate","notificationId","signerEmail","signerName"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"legalEntityId":{"type":"integer","description":"The legal entity id for which the Corppass KYC was performed","format":"int64","example":7},"legalEntityRegistrationId":{"type":"integer","description":"The legal entity Peppol registration id for which the Corppass KYC was performed","format":"int64","example":9},"signerName":{"type":"string","description":"The name of the person who signs the Peppol registration KYC in Corppass","example":"John Doe"},"signerEmail":{"type":"string","description":"The email address of the person who signs the Peppol registration KYC in Corppass","example":"john.doe@example.com"},"initiatedDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the Corppass activation was initiated","example":"2023-07-25T11:03:26.688"},"activationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the Corppass activation was completed","example":"2023-07-25T11:03:26.688"},"activationErrorDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the Corppass activation failed","example":"2023-07-25T11:03:26.688"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}}},"description":"The details of the Corpass KYC notification"},"MLRReceivingNotificationRO":{"required":["documentId","documentStatus","eventType","notificationDate","notificationId","peppolDocumentType","receivedDate","receiver","sender","transmissionId"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"transmissionId":{"type":"string","description":"The transmission unique identifier","example":"803828d52d4911ed85f512ef9c5638d0"},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"documentId":{"type":"string","description":"The document id of the Invoice/Credit Note","example":"pbe000512-1"},"peppolDocumentType":{"$ref":"#/components/schemas/PeppolDocumentTypeRO"},"documentStatus":{"$ref":"#/components/schemas/DocumentStatusEnumRO"},"sender":{"type":"string","description":"The sender of the MLR","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the MLR","example":"0208:1999999943"},"receivedDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the MLR was received","example":"2023-07-25T11:03:26.688"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}}},"description":"The details of the MLR receiving notification"},"NotificationRO":{"required":["eventType","notificationDate","notificationId"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}}},"description":"The details of the notification","anyOf":[{"$ref":"#/components/schemas/InvoiceSendingNotificationRO"},{"$ref":"#/components/schemas/InvoiceReceivingNotificationRO"},{"$ref":"#/components/schemas/MLRReceivingNotificationRO"},{"$ref":"#/components/schemas/DocumentReceivingFailedNotificationRO"},{"$ref":"#/components/schemas/InvoiceResponseSendingNotificationRO"},{"$ref":"#/components/schemas/InvoiceResponseReceivingNotificationRO"},{"$ref":"#/components/schemas/CDARSendingNotificationRO"},{"$ref":"#/components/schemas/CDARReceivingNotificationRO"},{"$ref":"#/components/schemas/OrderSendingNotificationRO"},{"$ref":"#/components/schemas/OrderReceivingNotificationRO"},{"$ref":"#/components/schemas/OrderChangeSendingNotificationRO"},{"$ref":"#/components/schemas/OrderChangeReceivingNotificationRO"},{"$ref":"#/components/schemas/OrderCancellationSendingNotificationRO"},{"$ref":"#/components/schemas/OrderCancellationReceivingNotificationRO"},{"$ref":"#/components/schemas/OrderResponseSendingNotificationRO"},{"$ref":"#/components/schemas/OrderResponseReceivingNotificationRO"},{"$ref":"#/components/schemas/SgOrderBalanceSendingNotificationRO"},{"$ref":"#/components/schemas/SgOrderBalanceReceivingNotificationRO"},{"$ref":"#/components/schemas/LegalEntityCorppassKycNotificationRO"},{"$ref":"#/components/schemas/LegalEntityCorppassC5NotificationRO"},{"$ref":"#/components/schemas/IrasSendingNotificationRO"},{"$ref":"#/components/schemas/C5SendingNotificationRO"},{"$ref":"#/components/schemas/C5ReceivingNotificationRO"}]},"NotificationsResponseRO":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/PageableResponseRO"},"notifications":{"type":"array","description":"The details of the notifications","items":{"$ref":"#/components/schemas/NotificationRO"}}},"description":"The details of the notifications and the pagination details"},"OrderCancellationReceivingNotificationRO":{"required":["documentId","eventType","notificationDate","notificationId","orderReferenceId","peppolDocumentType","receivedDate","receiver","sender","transmissionId"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"transmissionId":{"type":"string","description":"The transmission unique identifier","example":"803828d52d4911ed85f512ef9c5638d0"},"sbdhTransmissionId":{"type":"string","description":"SBDH instance identifier","example":"6b56b28947e511eda0b802bb4e4747f9"},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"documentId":{"type":"string","description":"The document id of the Order Cancellation","example":"pbe000512-1"},"orderReferenceId":{"type":"string","description":"The Order document id referred in this Order Cancellation","example":"pbe000512-1"},"peppolDocumentType":{"$ref":"#/components/schemas/PeppolDocumentTypeRO"},"sender":{"type":"string","description":"The sender of the Order Cancellation","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the Order Cancellation","example":"0208:1999999943"},"receivedDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the Order Cancellation was received","example":"2023-07-25T11:03:26.688"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}}},"description":"The details of the Order Cancellation receiving notification"},"OrderCancellationSendingNotificationRO":{"required":["documentId","documentStatus","eventType","notificationDate","notificationId","orderReferenceId","peppolDocumentType","receiver","sender","transmissionId"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"transmissionId":{"type":"string","description":"The transmission unique identifier","example":"803828d52d4911ed85f512ef9c5638d0"},"sbdhTransmissionId":{"type":"string","description":"SBDH instance identifier","example":"6b56b28947e511eda0b802bb4e4747f9"},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"documentId":{"type":"string","description":"The document id of the Order Cancellation","example":"pbe000512-1"},"orderReferenceId":{"type":"string","description":"The Order document id referred in this Order Cancellation","example":"pbe000512-1"},"peppolDocumentType":{"$ref":"#/components/schemas/PeppolDocumentTypeRO"},"documentStatus":{"$ref":"#/components/schemas/OrderStatusEnumRO"},"sender":{"type":"string","description":"The sender of the Order Cancellation","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the Order Cancellation","example":"0208:1999999943"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}}},"description":"The details of the Order Cancellation sending notification"},"OrderChangeReceivingNotificationRO":{"required":["documentId","eventType","notificationDate","notificationId","orderReferenceId","peppolDocumentType","receivedDate","receiver","sender","transmissionId"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"transmissionId":{"type":"string","description":"The transmission unique identifier","example":"803828d52d4911ed85f512ef9c5638d0"},"sbdhTransmissionId":{"type":"string","description":"SBDH instance identifier","example":"6b56b28947e511eda0b802bb4e4747f9"},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"documentId":{"type":"string","description":"The document id of the Order Change","example":"pbe000512-1"},"orderReferenceId":{"type":"string","description":"The Order document id referred in this Order Change","example":"pbe000512-1"},"peppolDocumentType":{"$ref":"#/components/schemas/PeppolDocumentTypeRO"},"sender":{"type":"string","description":"The sender of the Order Change","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the Order Change","example":"0208:1999999943"},"receivedDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the Order Change was received","example":"2023-07-25T11:03:26.688"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}}},"description":"The details of the Order Change receiving notification"},"OrderChangeSendingNotificationRO":{"required":["documentId","documentStatus","eventType","notificationDate","notificationId","orderReferenceId","peppolDocumentType","receiver","sender","transmissionId"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"transmissionId":{"type":"string","description":"The transmission unique identifier","example":"803828d52d4911ed85f512ef9c5638d0"},"sbdhTransmissionId":{"type":"string","description":"SBDH instance identifier","example":"6b56b28947e511eda0b802bb4e4747f9"},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"documentId":{"type":"string","description":"The document id of the Order Change","example":"pbe000512-1"},"orderReferenceId":{"type":"string","description":"The Order document id referred in this Order Change","example":"pbe000512-1"},"peppolDocumentType":{"$ref":"#/components/schemas/PeppolDocumentTypeRO"},"documentStatus":{"$ref":"#/components/schemas/OrderStatusEnumRO"},"sender":{"type":"string","description":"The sender of the Order Change","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the Order Change","example":"0208:1999999943"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}}},"description":"The details of the Order Change sending notification"},"OrderReceivingNotificationRO":{"required":["documentId","eventType","notificationDate","notificationId","peppolDocumentType","receivedDate","receiver","sender","transmissionId"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"transmissionId":{"type":"string","description":"The transmission unique identifier","example":"803828d52d4911ed85f512ef9c5638d0"},"sbdhTransmissionId":{"type":"string","description":"SBDH instance identifier","example":"6b56b28947e511eda0b802bb4e4747f9"},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"documentId":{"type":"string","description":"The document id of the Order","example":"pbe000512-1"},"peppolDocumentType":{"$ref":"#/components/schemas/PeppolDocumentTypeRO"},"sender":{"type":"string","description":"The sender of the Order","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the Order","example":"0208:1999999943"},"receivedDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the Order was received","example":"2023-07-25T11:03:26.688"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}}},"description":"The details of the Order receiving notification"},"OrderResponseReceivingNotificationRO":{"required":["documentId","eventType","notificationDate","notificationId","orderReferenceId","peppolDocumentType","receivedDate","receiver","sender","transmissionId"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"transmissionId":{"type":"string","description":"The transmission unique identifier","example":"803828d52d4911ed85f512ef9c5638d0"},"sbdhTransmissionId":{"type":"string","description":"SBDH instance identifier","example":"6b56b28947e511eda0b802bb4e4747f9"},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"documentId":{"type":"string","description":"The document id of the Order Response","example":"pbe000512-1"},"orderReferenceId":{"type":"string","description":"The Order document id referred in this Order Response","example":"pbe000512-1"},"peppolDocumentType":{"$ref":"#/components/schemas/PeppolDocumentTypeRO"},"sender":{"type":"string","description":"The sender of the Order Response","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the Order Response","example":"0208:1999999943"},"receivedDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the Order Response was received","example":"2023-07-25T11:03:26.688"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}}},"description":"The details of the Order Response receiving notification"},"OrderResponseSendingNotificationRO":{"required":["documentId","documentStatus","eventType","notificationDate","notificationId","orderReferenceId","peppolDocumentType","receiver","sender","transmissionId"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"transmissionId":{"type":"string","description":"The transmission unique identifier","example":"803828d52d4911ed85f512ef9c5638d0"},"sbdhTransmissionId":{"type":"string","description":"SBDH instance identifier","example":"6b56b28947e511eda0b802bb4e4747f9"},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"documentId":{"type":"string","description":"The document id of the Order Response","example":"pbe000512-1"},"orderReferenceId":{"type":"string","description":"The Order document id referred in this Order Response","example":"pbe000512-1"},"peppolDocumentType":{"$ref":"#/components/schemas/PeppolDocumentTypeRO"},"documentStatus":{"$ref":"#/components/schemas/OrderStatusEnumRO"},"sender":{"type":"string","description":"The sender of the Order Response","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the Order Response","example":"0208:1999999943"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}}},"description":"The details of the Order Response sending notification"},"OrderSendingNotificationRO":{"required":["documentId","documentStatus","eventType","notificationDate","notificationId","peppolDocumentType","receiver","sender","transmissionId"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"transmissionId":{"type":"string","description":"The transmission unique identifier","example":"803828d52d4911ed85f512ef9c5638d0"},"sbdhTransmissionId":{"type":"string","description":"SBDH instance identifier","example":"6b56b28947e511eda0b802bb4e4747f9"},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"documentId":{"type":"string","description":"The document id of the Order","example":"pbe000512-1"},"peppolDocumentType":{"$ref":"#/components/schemas/PeppolDocumentTypeRO"},"documentStatus":{"$ref":"#/components/schemas/OrderStatusEnumRO"},"sender":{"type":"string","description":"The sender of the Order","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the Order","example":"0208:1999999943"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}}},"description":"The details of the Order sending notification"},"OrderStatusEnumRO":{"type":"string","description":"The status of the SG Order Balance","example":"SENT","enum":["QUEUED","SENT","SEND_FAILED","TECHNICAL_ACCEPTANCE","REJECTED"]},"PageableResponseRO":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of results in the database","format":"int64","example":5},"page":{"type":"integer","description":"The starting page number of the retrieved results","format":"int32","example":0},"pageSize":{"type":"integer","description":"How many results we want have retrieved per page","format":"int32","example":10}},"description":"The pagination details"},"SgOrderBalanceReceivingNotificationRO":{"required":["documentId","eventType","notificationDate","notificationId","orderReferenceId","peppolDocumentType","receivedDate","receiver","sender","transmissionId"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"transmissionId":{"type":"string","description":"The transmission unique identifier","example":"803828d52d4911ed85f512ef9c5638d0"},"sbdhTransmissionId":{"type":"string","description":"SBDH instance identifier","example":"6b56b28947e511eda0b802bb4e4747f9"},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"documentId":{"type":"string","description":"The document id of the SG Order Balance","example":"pbe000512-1"},"orderReferenceId":{"type":"string","description":"The Order document id referred in this SG Order Balance","example":"pbe000512-1"},"peppolDocumentType":{"$ref":"#/components/schemas/PeppolDocumentTypeRO"},"sender":{"type":"string","description":"The sender of the SG Order Balance","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the SG Order Balance","example":"0208:1999999943"},"receivedDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the SG Order Balance was received","example":"2023-07-25T11:03:26.688"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}}},"description":"The details of the SG Order Balance receiving notification"},"SgOrderBalanceSendingNotificationRO":{"required":["documentId","documentStatus","eventType","notificationDate","notificationId","orderReferenceId","peppolDocumentType","receiver","sender","transmissionId"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/EventTypeRO"},"notificationId":{"type":"integer","description":"The notification id","format":"int64","example":7},"transmissionId":{"type":"string","description":"The transmission unique identifier","example":"803828d52d4911ed85f512ef9c5638d0"},"sbdhTransmissionId":{"type":"string","description":"SBDH instance identifier","example":"6b56b28947e511eda0b802bb4e4747f9"},"notificationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the notification was created","example":"2023-07-25T11:03:26.688"},"documentId":{"type":"string","description":"The document id of the SG Order Balance","example":"pbe000512-1"},"orderReferenceId":{"type":"string","description":"The Order document id referred in this SG Order Balance","example":"pbe000512-1"},"peppolDocumentType":{"$ref":"#/components/schemas/PeppolDocumentTypeRO"},"documentStatus":{"$ref":"#/components/schemas/OrderStatusEnumRO"},"sender":{"type":"string","description":"The sender of the SG Order Balance","example":"0208:0552912569"},"receiver":{"type":"string","description":"The receiver of the SG Order Balance","example":"0208:1999999943"},"details":{"type":"array","description":"Additional details regarding the notification","items":{"$ref":"#/components/schemas/ApplicationMessage"}}},"description":"The details of the SG Order Balance sending notification"},"CountryCodeEnum":{"type":"string","description":"The receiver party country","example":"BE","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","YE","YT","ZA","ZM","ZW","ZZ"]},"LegalEntityListRO":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/PageableResponseRO"},"legalEntities":{"type":"array","description":"A list containing the details of the legal entities","items":{"$ref":"#/components/schemas/LegalEntityRO"}}},"description":"The list of legal entities and the pagination details"},"LegalEntityPeppolRegistrationC5DetailsRO":{"type":"object","properties":{"c5Activated":{"type":"boolean","description":"True if the legal entity registration is C5 activated","example":true}},"description":"The C5 details of the Peppol legal entity registration"},"LegalEntityPeppolRegistrationKycDetailsRO":{"type":"object","properties":{"kycCompleted":{"type":"boolean","description":"True if the legal entity registration is C5 activated","example":true}},"description":"The KYC details of the Peppol legal entity registration. It is used only in specific country eg Singapore, Malaysia"},"LegalEntityPeppolRegistrationRO":{"type":"object","properties":{"peppolRegistrationId":{"type":"integer","description":"The Peppol registration id","format":"int64"},"creationDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the Peppol registration was created in our system","readOnly":true},"peppolRegistrationDetails":{"$ref":"#/components/schemas/LegalEntityPeppolRegistrationDetailsRO"},"c5Details":{"$ref":"#/components/schemas/LegalEntityPeppolRegistrationC5DetailsRO"},"kycDetails":{"$ref":"#/components/schemas/LegalEntityPeppolRegistrationKycDetailsRO"}},"description":"The registrations details of the legal entity in the Peppol network. A registration contains the Peppol identifier and the legal entity supported documents. A legal entity can be registered multiple times using different identifiers eg company registration number, VAT, etc"},"LegalEntityRO":{"type":"object","properties":{"legalEntityId":{"type":"integer","description":"The legal entity id","format":"int64"},"legalEntityDetails":{"$ref":"#/components/schemas/LegalEntityDetailsRO"},"peppolRegistrations":{"type":"array","description":"The registrations of the legal entity in the Peppol network. A registration contains the Peppol identifier and the legal entity supported documents. A legal entity can be registered multiple times using different identifiers eg company registration number, VAT, etc","items":{"$ref":"#/components/schemas/LegalEntityPeppolRegistrationRO"}}},"description":"The details of the legal entity which is registered in the Peppol network"},"LegalEntityPeppolRegistrationListRO":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/PageableResponseRO"},"peppolRegistrations":{"type":"array","description":"A list containing the details of the Peppol registrations for a legal entity","items":{"$ref":"#/components/schemas/LegalEntityPeppolRegistrationRO"}}},"description":"The list of Peppol registrations for a legal entity and the pagination details"},"LegalEntityC5ActivationGetResponseRO":{"required":["initiatedDate","signed","signerEmail","state"],"type":"object","properties":{"initiatedDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the C5 activation or deactivation was initiated","example":"2019-08-24T14:15:22.000"},"signed":{"type":"boolean","description":"True if the C5 activation has been signed","example":true},"signerEmail":{"type":"string","description":"The email of the business representative used when sending out the C5 activation/deactivation signing e-mail","example":"john.doe@example.com"},"signerName":{"type":"string","description":"The name of the business representative used when sending out the C5 activation/deactivation signing e-mail","example":"John Doe"},"signingLink":{"type":"string","description":"The Corppass signing URL returned for pending C5 activation or deactivation","example":"https://example.com/c5-activation"},"signedDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The date when the C5 activation has been signed","example":"2019-08-24T14:15:22.000"},"state":{"type":"string","description":"The state of the C5 activation.- ACTIVATED= The C5 activation has been signed
- INITIATED_ACTIVATION= Signing of a C5 activation has been initiated
- INITIATED_DEACTIVATION= Signing of a deactivation of an existing C5 activation has been initiated
- PENDING_KYC= C5 Activation has been initiated but participant is still waiting for KYC signing
","example":"ACTIVATED","enum":["ACTIVATED","INITIATED_ACTIVATION","INITIATED_DEACTIVATION","KYC_PENDING","PENDING_VERIFICATION","PENDING_ACTIVATION","PENDING_DEACTIVATION","DEACTIVATED","ACTIVATION_CANCELLED"]}},"description":"The details of the C5 activation"},"TransmissionDirectionEnumRO":{"type":"string","description":"The transmission direction","example":"SENDING","enum":["SENDING","RECEIVING"]},"DocumentSearchRO":{"type":"object","properties":{"peppolDocumentType":{"$ref":"#/components/schemas/PeppolDocumentTypeRO"},"documentId":{"type":"string","description":"The business document identifier","example":"INV-100"},"sender":{"type":"string","description":"The sender participant identifier","example":"0208:0552912569"},"senderPartyName":{"type":"string","description":"The sender party registration name","example":"Ademico Software"},"senderCountry":{"$ref":"#/components/schemas/CountryCodeEnum"},"senderLegalEntityCountry":{"$ref":"#/components/schemas/CountryCodeEnum"},"receiver":{"type":"string","description":"The receiver participant identifier","example":"0208:1999999943"},"receiverPartyName":{"type":"string","description":"The receiver party registration name","example":"Buyer Official Name"},"receiverCountry":{"$ref":"#/components/schemas/CountryCodeEnum"},"sbdhTransmissionId":{"type":"string","description":"The SBDH transmission identifier","example":"6b56b28947e511eda0b802bb4e4747f9"},"transmissionId":{"type":"string","description":"The transmission identifier","example":"803828d52d4911ed85f512ef9c5638d0"},"as4MessageId":{"type":"string","description":"The AS4 message identifier","example":"as4-message-id-123"},"creationTime":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}$","type":"string","description":"The document creation time"},"direction":{"$ref":"#/components/schemas/TransmissionDirectionEnumRO"},"documentStatus":{"$ref":"#/components/schemas/DocumentStatusEnumRO"}},"description":"The details of an exchanged document"},"DocumentSearchResponseRO":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/PageableResponseRO"},"documents":{"type":"array","description":"The exchanged documents found for the current page","items":{"$ref":"#/components/schemas/DocumentSearchRO"}}},"description":"The list of exchanged documents and the pagination details"},"AnnuairePeppolIdentifierRO":{"type":"object","properties":{"peppolIdentifier":{"type":"string","description":"Peppol participant identifier registered in the France annuaire","example":"0225:123456789_12345678901111"},"siren":{"type":"string","description":"SIREN of the annuaire line","example":"123456789"},"siret":{"type":"string","description":"SIRET of the annuaire line, when present","nullable":true,"example":"12345678901111"},"routage":{"type":"string","description":"Routing code of the annuaire line, when present","nullable":true,"example":"ROUTE1"},"suffixe":{"type":"string","description":"Suffix of the annuaire line, when present","nullable":true,"example":"SUFFIXE1"},"claimedByPa":{"type":"boolean","description":"Whether a real Plateforme Agréée (PA) is assigned to this annuaire registration. False means that the record exists but is not routable because no real PA has claimed it; true means that a real PA is assigned. The platform identifier is not exposed.","example":true},"dateDebut":{"type":"string","description":"Effective start date of the annuaire registration in ISO format yyyy-MM-dd","format":"date","example":"2026-07-08"},"dateFin":{"type":"string","description":"Announced end date of the annuaire registration in ISO format yyyy-MM-dd, when present","format":"date","nullable":true},"dateFinEffective":{"type":"string","description":"Effective end date of the annuaire registration in ISO format yyyy-MM-dd, when present","format":"date","nullable":true}},"description":"Contains an effective France annuaire registration matching the requested SIREN or SIRET"},"AnnuaireSearchResponseRO":{"type":"object","properties":{"identifiers":{"type":"array","description":"The list of Peppol identifiers found in Annuaire for the given query","items":{"$ref":"#/components/schemas/AnnuairePeppolIdentifierRO"}}},"description":"Result of an Annuaire query"}},"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://test-peppol-oauth2.ademico-software.com/oauth2/token","scopes":{"peppol/document":"Access to send and receive Invoices and Credit Notes"}}}},"BasicAuth":{"type":"http","scheme":"basic"}}},"x-tagGroups":[{"name":"Legal entities","tags":["Legal Entity","Legal Entity Peppol Registration","Legal Entity KYC(Singapore and Malaysia)","Legal Entity C5 Singapore"]},{"name":"Invoices/Credit Notes","tags":["Invoice/Credit Note","Invoice Response"]},{"name":"Country Specifics","tags":["Singapore IRAS Submission","France Annuaire","France Factur-X Generation","France PPF Submission","France CDAR"]},{"name":"Orders","tags":["Order"]},{"name":"Documents","tags":["Documents"]},{"name":"Transport Evidence","tags":["Transport Evidences"]},{"name":"Notifications","tags":["Notification","Webhook Settings API"]},{"name":"Statistics","tags":["Statistics"]},{"name":"Connectivity","tags":["Connectivity"]}]}