Generate Document

Generate the XML document that would be written for the given payload, without sending or storing it. Accepts the same body as the send document endpoint, minus the email delivery options and the raw XML document type. The document type identifier and process are resolved against the recipient exactly as they are when sending, so leaving them out returns the document written as the format the recipient is registered to receive; naming both yourself skips that lookup, again exactly as sending does. This endpoint does not check that the recipient can receive the document. The generated document is validated exactly as it is when sending. Documents generated through this endpoint do not count towards your Recommand subscription usage.

Authorization

AuthorizationBasic <token>

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

In: header

Path Parameters

companyId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

recipient*string

The Peppol address of the recipient the document is generated for.

Example"0208:987654321"

pdfGeneration?object

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*object

Invoice to send to a recipient

Response Body

`application/json`

curl -X POST "https://app.recommand.eu/api/v1/string/generate" \  -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,
  "xml": "string",
  "documentType": "invoice",
  "doctypeId": "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": "urn:fdc:peppol.eu:2017:poacc:billing:01:1.0"
}

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

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

`application/json`

`application/json`