API Integration

Using the exposed API on Peppol.com you’ll be able to integrate your own systems with Peppol.com.

Connect with Peppol.com

It is easy to integrate your own IT system with Peppol.com. Online documentation (Swagger) for the API can be located at this URL.

Authentication

The Peppol.com API uses the Oauth2/OpenId specifications and supports the following flows:

  • Password (including client-id and client-secret) (see more here)
  • Authorization Code (see more here)

The Authorization Server can be found here and you can see the OpenId specifications here.

Document (/api/v1/document) [POST]

With this method you can upload a Peppol document and transmit it to the endpoint receiver.

The access-token retrieved from the Authorization Server identifies you and makes sure, that the document will be uploaded in your space at peppol.com.

Get List of Documents (/api/v1/document/{documentType}) [GET]

Online documentation about this method can be found here.

Once you have an access-token, you can retrieve a list of your submitted documents.

Document Types:

1 = Invoices
2 = Credit Notes

Additional parameters:

  • includeXmlPayloadInResponse - by setting this parameter to true/false you can control whether or not to include the actual document payload or not. Default is true.

Get Document By Id (/api/v1/document/{documentType}/{documentId}) [GET]

Online documentation about this method can be found here.

If you have a document ID – which can be retrieved using the list of documents-method – you can download the actual document using the Get Document-method. You must know which type the document is though, since ID of the document can both exist as an Invoice, but also as a Credit Note.

Document Types:

1 = Invoices
2 = Credit Notes

Additional parameters:

  • includeXmlPayloadInResponse - by setting this parameter to true/false you can control whether or not to include the actual document payload or not. Default is true.