https://api.e-invoice.be. The API key selects the mode: a key of a sandbox company makes the SDK run in test mode, and a key of a production company sends documents on the Peppol network. See Test mode and sandbox companies.
Available SDKs
The TypeScript SDK also runs in Deno 1.28.0 and later, Bun 1.0 and later, Cloudflare Workers and the Vercel Edge Runtime. The README of the repository has the full list.
Install an SDK
The PHP SDK sends requests through a PSR-18 HTTP client. If your application has no PSR-18 client, install one, for example with
composer require symfony/http-client nyholm/psr7.The Java coordinates above are the coordinates in the README of the Java SDK. At the time of writing (2026-11-04), the artifact
com.e_invoice.api:e-invoice-java is not yet on Maven Central: repo1.maven.org returns 404 for it. If your build cannot find the artifact, see the README of the repository for the current status.Authenticate
Each SDK reads the API key from the environment variableE_INVOICE_API_KEY. Do not put the key in your source code.
Validate, create and send a document
The samples do the same operations in each language:- Create a client and read the account of the API key (
GET /api/me/). - Validate the invoice JSON (
POST /api/validate/json). - Create the document (
POST /api/documents/). The document is in theDRAFTstate. - Send the document (
POST /api/documents/{document_id}/send).
Validation is not a separate mandatory call.
POST /api/documents/ rejects a payload that does not pass the same rules. Use POST /api/validate/json while you develop, because it returns all rule failures and the generated UBL.The samples use the vendor E-INVOICE BV (
BE1018265814). Replace vendor_name, vendor_tax_id and vendor_address with the data of your own company. A sandbox company has a synthetic VAT number. To find it, read peppol_ids in the account response. Example: for 0208:0999123457, use vendor_tax_id BE0999123457.sender_peppol_scheme, sender_peppol_id, receiver_peppol_scheme and receiver_peppol_id. It also accepts email, which is deprecated. In PHP and Java, the names are in camel case. Example in PHP: $client->documents->send($document->id, senderPeppolScheme: '0208', senderPeppolID: '1018265814'). See Create e-invoices for when to set them.
With a sandbox company, the send call does not use the Peppol network. See Test mode and sandbox companies.
Method names for each SDK
In Ruby, the send method has the name
send_ with an underscore at the end, because send is a method of each Ruby object.api.md with the full list of methods.
Versions and the OpenAPI specification
The API has one OpenAPI specification, which is version 1.1.0 at this time. Each SDK follows this specification, but each SDK has its own version number. An SDK version number does not agree with the version number of the specification.- All SDKs follow semantic versioning, with the exceptions that each README gives.
- The Ruby and PHP SDKs have major version
0. In these SDKs, a minor version can contain a breaking change. Example: an update from0.7.2to0.8.0can change a method signature. - A new endpoint can be in the API before it is in an SDK. The API reference always shows the current API. Each README shows how to call an endpoint that the SDK does not have yet.
Report a problem
Report a problem with an SDK in the issues of its repository:- e-invoice-ts issues
- e-invoice-py issues
- e-invoice-rb issues
- e-invoice-php issues
- e-invoice-java issues
Next Steps
peppol CLI
Validate, create and send documents from the command line
Create e-invoices
Learn the fields of an invoice
Errors and troubleshooting
Handle the errors that the API returns
API reference
See all endpoints and schemas