mib:Peppol REST API
Connect any invoicing platform to the Peppol network through our certified Access Point.
Peppol for any system
Everything we provide through our Access Point is also available as a REST API layer — designed specifically for companies that want to integrate Peppol directly into their own system. Whether you run SAP, a custom ERP, or a completely different invoicing platform, our API handles the Peppol communication on your behalf.
The API is organised into four functional groups: authentication, invoice submission, credit and debit notes, and document status tracking. Each group has clearly defined endpoints, documented via OpenAPI and available for live testing in Swagger.
- check_circle Compatible with SAP and non-SAP systems
- check_circle JSON input or ready-made XML — your choice
- check_circle Schematron validation on demand
- check_circle Full document lifecycle tracking
- check_circle OpenAPI docs + Swagger live testing
Four functional groups
The API is built around four clear areas, each with its own set of endpoints — covering the complete flow from authentication to status monitoring.
Authentication
Every request must include a static HTTP header token — X-API-Token. Optional headers enable XML schema validation (X-Validation) or a dry-run test mode (X-TestOnly).
Invoices
Submit invoices directly to the Peppol network via AS4. The input can be a structured JSON payload — we generate the BIS 3 UBL XML for you — or a ready-made XML file you supply yourself. Schematron validation is optional.
Credit & Debit Notes
The same approach applies to corrective documents. Dedicated endpoints handle credit notes and debit notes separately, operating on the same principle as invoice submission.
Document Status
A set of GET endpoints lets you track the full lifecycle of any document: current delivery status, processing history, a queue of pending documents, and a filtered list by client identifier.
Selected endpoints
The list below is a representative subset. The full reference is always up to date in the Swagger documentation.
/api/v1/credit-notes/submit Submit BIS 3 Credit Note to the Peppol network.
/api/v1/invoices/files Get document files — returns files associated with a given document.
/api/v1/invoices/submit Submit invoice to the Peppol network — returns the UUID of the created record.
/api/v1/invoices/status Get document audit log — returns the processing history and status trail for a specific document.
/api/identity/check Check API token — confirms token validity and API service availability.
/api/v1/pdf/tdd/generate Generate PDF from TDD XML — input is a TDD XML document, output is a ready PDF file.
/api/v1/pdf/mls/generate Generate PDF from MLS XML — input is an MLS XML document, output is a ready PDF file.
/api/v1/pdf/document/generate Generate PDF from UBL XML — input is any UBL XML document, output is a ready PDF file.
Live via Swagger
The REST API is fully described using the OpenAPI standard and exposed through Swagger UI. Open it in any browser to see every available endpoint, its required parameters, request schemas, and example responses.
You can also try out individual endpoints directly in Swagger — test your calls before writing a single line of integration code.
