Peppol BE API

OpenAPI Definition:
Download

Getting started and overview

The Peppol BE API is designed to facilitate the exchange of electronic documents in compliance with the Belgian e-invoicing regulations.

The platform runs on top of the Peppol Network, allowing seamless interoperability between different systems and ensuring that your documents are delivered securely and efficiently. Learn more about Peppol here and here.

On the A-Cube platform the general Peppol exchange network runs on the domain peppol.api.acubeapi.com for production and peppol-sandbox.api.acubeapi.com for sandbox. The Belgian Peppol API is a specific implementation of the Peppol standard, tailored to meet the requirements of the Belgian market and runs on the same domain but with the endpoint prefix /be (i.e. peppol.api.acubeapi.com/be)
Free sandbox environment

The sandbox environment is useful to develop and test the integration directly into the Peppol network test environment.

You can create an account for FREE by registering here.

To get started:

  1. Get a valid token, see here
  2. Onboard the company (LegalEntity) into the Peppol Network, see here
  3. Prepare and send a new document, you can choose between standard UBL 2.1 XML or the JSON format, see here
  4. Receive the uuid identifier for the newly created document as response and store it
  5. Receive information about the delivery to your configured webhook, match against the previously stored identifier.

Environments

  • sandbox is the environment where you can test the entire platform without paying at any time. Documents are by the way exchanged through the Peppol test Network The base URL is https://peppol-sandbox.api.acubeapi.com
  • production is the environment where documents exchange happens in the official Peppol Network The base URL is https://peppol.api.acubeapi.com

Authentication

You can find all the information about the authentication here.

API orchestration and webhooks

You can configure via API your webhooks where to receive information in real-time, as soon as an event happens.

A-Cube Peppol API supports two types of events:

  • outgoing-document it is dispatched to inform your webhook about an outgoing deliver
  • incoming-document it is dispatched when an incoming document has been delivered to your account
You will received a HTTP POST request to your configured URL with body
Copy
Copied
{
  "success": bool
  "document_id": string - the document unique identifier
  "document_type": string - the document type code
  "request_at": datetime - when the request has been sent from corner 2
  "response_at": datetime - when the response has been sent from corner 3
}

You can find more information about webhooks here.