Send Document

Send a document to a customer

Authorization

AuthorizationBasic <token>

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

In: header

Request Body

application/json

recipient*|

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

email?

Email delivery options. When Peppol recipient is provided, email is optional and you can choose to always send the email, or only when Peppol delivery fails. When Peppol recipient is null, email becomes the primary delivery method and email.to is required. Each sent email is counted towards your document quota.

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 or raw XML documents.

documentType*string

The type of document.

document*|||||

doctypeId?string

The document type identifier. Not required, only used when documentType is "xml". For supported document types, the doctypeId can be detected automatically from your XML document, if that's not the case you can provide it manually.

processId?string

The process identifier. Not required, only used when documentType is "xml". For supported document types, the processId can be detected automatically from your XML document, if that's not the case you can provide it manually.

Response Body

`application/json`

curl -X POST "https://app.recommand.eu/api/v1/string/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": "21.00",          "vat": {            "percentage": "21.00"          }        }      ]    }  }'

{
  "success": true,
  "sentOverPeppol": true,
  "sentOverEmail": true,
  "emailRecipients": [
    "string"
  ],
  "teamId": "string",
  "companyId": "string",
  "id": "string",
  "peppolMessageId": "string",
  "envelopeId": "string"
}

{
  "success": false,
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}

{
  "success": false,
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

422application/json

`application/json`

`application/json`

`application/json`