How do I send documents via API?
Before you start, a short checklist:
- Are your files ready? These can be PDFs or a structured file (e.g., XML or UBL).
- Size and count: you can send up to 5 files at once, each file up to 5 MB.
- Optional: you can add information such as cost center and department, and select the desired delivery channel per document (PEPPOL …).
- Access: an access token is required.
Step 1: choose your delivery method.
- SendingId: for manually submitted shipments.
- SendingConfigurationId: for automatic submission or reusing a shipment for the same day (useful for daily batches).
You cannot combine both methods.
Step 2: gather your files
- Prepare the documents (up to 5, each maximum 5 MB).
- Check the format: PDF or structured.
Step 3 (optional): choose the delivery channel per document.
- Provide the delivery channel per document (PEPPOL …).
Step 4 (optional): add extra info
Send your own metadata, such as:
- Cost center
- Department
- ...
Step 5: obtain an access token
- Authentication is done via OAuth 2.0.
- Your IT requests a token.
- Store the token; you’ll need it in the next step.
Step 6: upload your documents
- Send your files to the upload endpoint.
- Add your token in the Authorization header.
- Include the following information:
- One of the IDs
- Optional metadata
- Optional channel per document
Step 7: check your confirmation
After the upload, you will receive a response with the status.
API Rate limit: please note that API calls are limited to 500 calls per minute for authenticated users, and 100 calls per minute for unauthenticated users.