Send Document

Send a document to a customer over the Peppol network, by email, or both.

POST

/api/v1/{companyId}/send

Send a document to a customer over the Peppol network, by email, or both. The document type identifier and process are resolved against the recipient unless you name both yourself. The document is stored under the company and returned document ID, and it counts towards your subscription usage. When Peppol delivery fails and no email fallback applies, the request fails with a 422 and nothing is stored.

Authorization

AuthorizationBasic <token>

Basic API key authentication. Create a new API key and secret in the Recommand dashboard.

In: header

Path Parameters

companyId*string

The ID of the company sending the document. The document is sent from this company's Peppol identifier.

Example"c_01JQZ8X0M4T7RB6K9V2NDHW3PA"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

recipient*|

The Peppol address of the recipient. If null, the document will be sent via email only (requires email.to).

Example"0208:987654321"

email?Email

Email delivery options. When a Peppol recipient is provided, email is optional and you can choose to always send the email, or only when Peppol delivery fails, whether that is refused at send time or reported later by the access point. When the Peppol recipient is null, email becomes the primary delivery method and email.to is required. Each email counts towards your document quota at the moment it is sent.

pdfGeneration?PDFGeneration

Optionally generate a PDF of the document and include it as an embedded attachment (also included in email attachments when email sending is enabled). Not supported for message level responses, French Invoicing CDAR messages, or raw XML documents.

doctypeId?string

The document type identifier. For JSON documents it is selected automatically: the recipient is looked up and the document is sent as the first format, in our order of preference, the recipient is registered to receive it in, falling back to the standard Peppol BIS 3 UBL document type for the selected documentType. For raw XML documents it can be detected automatically where supported.

Example

"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1"

processId?string

Optional process identifier override. It is detected automatically for supported JSON and XML document types. For JSON documents the process the recipient is registered for is preferred, as far as the document itself leaves the choice open.

Example"urn:fdc:peppol.eu:2017:poacc:billing:01:1.0"

documentType*string

The type of document.

Example"invoice"

document*Invoice to send

Invoice to send to a recipient

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/c_01JQZ8X0M4T7RB6K9V2NDHW3PA/send" \  -H "Content-Type: application/json" \  -d '{    "recipient": "0208:987654321",    "documentType": "invoice",    "document": {      "invoiceNumber": "INV-2024-001",      "buyer": {        "name": "Example Company",        "street": "Example Street 1",        "city": "Brussels",        "postalZone": "1000",        "country": "BE"      },      "lines": [        {          "netPriceAmount": "12.40",          "vat": {            "percentage": "21.00"          }        }      ]    }  }'

{  "success": true,  "sentOverPeppol": true,  "sentOverEmail": false,  "emailRecipients": [],  "teamId": "team_01JQZ8X0M4T7RB6K9V2NDHW3PA",  "companyId": "c_01JQZ8X0M4T7RB6K9V2NDHW3PA",  "id": "doc_01JQZ8X0M4T7RB6K9V2NDHW3PA",  "peppolMessageId": "b7c2f0a4-3d1e-4a58-9c6d-0f2e8a1b4c73@recommand.eu",  "envelopeId": "9f1b3c7e-52a4-4d68-8b0f-6c9d2e4a17b5",  "deliveryStatus": "delivered",  "deliveries": [    {      "id": "dlv_01JQZ8X0M4T7RB6K9V2NDHW3PA",      "channel": "peppol",      "address": "0208:0428643097",      "status": "delivered",      "statusChangedAt": "2019-08-24T14:15:22Z",      "failure": {        "category": "validation",        "message": "string",        "providerCode": "TXE-1005"      },      "references": {        "peppolMessageId": "string",        "peppolConversationId": "string",        "envelopeId": "string",        "messageId": "string"      }    }  ]}

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

422application/json

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`