Document

Create, convert and send documents via the Peppol network.

The Document endpoints handle the full lifecycle: generate UBL XML from various input formats, validate against PEPPOL Schematron rules, and send through the Peppol network.

Looking for a worked example? Examples → BusinessDocument (UBL invoice) walks through a complete cross-border PEPPOL invoice via the standard-agnostic endpoint, in cURL, Java SDK, Python, Node.js and PHP.

List all renditions sharing a processId (sibling lookup)

GET /bizzlink/documents

Returns every document rendition produced by the same create-and-send call, identified by the shared processId. Useful when a single business document is rendered into multiple wire formats (e.g. IT seller → FatturaPA via SDI plus UBL via Peppol) and the caller wants the full picture without polling each rendition id separately.

Tenant-scoped — only renditions owned by the authenticated tenant are returned. Returns an empty data array if no renditions match.

Responses:

Status	Description
`200`	Sibling renditions
`400`	Invalid direction parameter

cURL Request

curl -X GET https://gateway.vigasoft.lu/bizzlink/documents \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "X-Bizzlink-Signature: t=$TIMESTAMP,v1=$SIGNATURE"

Send a document from a JSON structure

POST /bizzlink/documents/json

Accepts a BusinessDocument (the same model the on-prem connector plugins build) and generates one or more wire-format renditions depending on sender/receiver country and regulatory requirements. The polymorphic @type discriminator (InvoiceDocument / CreditNoteDocument) decides the JSON:API resource type of each response entry (invoices or credit-notes).

The routing layer — based on sender country, receiver country and SMP capabilities — decides which formats/targets the document is rendered into. Examples:

LU/AT/BE/NL/DK/SE/IE seller → 1× UBL via Peppol
IT seller (any buyer) → FatturaPA via SDI plus UBL via Peppol (when receiver is not IT)
FR seller (post-2026-09-01) → Factur-X/UBL via PPF/PDP plus UBL via Peppol (when receiver is not FR)

Response is a JSON:API collection: data is an array with one entry per rendition. Each entry has its own id (= per-rendition document id, pollable via GET /documents/{id}/status); all siblings share the same attributes.processId, looked up via GET /documents?processId={uuid}.

Request Body:

Field	Type	Required	Description
`data`	`object`	Yes	Resource envelope. 'attributes' holds the domain fields; 'meta.scope' declares whether the resource belongs to the whole tenant or to a specific legal entity (Peppol ID).
`attributes`	`any`	Yes	The actual resource fields.
`meta`	`JsonApiMeta`	No	Optional JSON:API meta. Only used by scoped resources (e.g. email templates, notification emails) to declare their ownership scope.
`scope`	`JsonApiScope`	Yes
`type`	`string`	Yes	Scope type. 'tenant' = applies to the whole tenant. 'legal-entity' = applies only to the Peppol ID given in 'value'. 'partner' = applies to all child tenants of the calling partner tenant; 'value' must be empty.
`value`	`string`	No	Required when type='legal-entity': the Peppol ID (scheme:identifier) that owns this resource, e.g. '9938:lu28079289'. Must belong to the requesting tenant. Ignored when type='tenant'. Must be empty when type='partner'.
`type`	`string`	No	Must be 'business-documents' for this endpoint.

Responses:

Status	Description
`200`	Document(s) accepted for async processing
`403`	Sender Peppol ID does not belong to the tenant
`422`	Synchronous XML generation failed or routing target not supported
`500`	Internal server error

Response Body — JsonApiListDocumentDocumentAcceptedAttributes:

Field	Type	Description
`data`	`JsonApiResourceDocumentAcceptedAttributes[]`
`attributes`	`DocumentAcceptedAttributes`	Resource-specific fields.
`format`	`string`	Wire format of the generated XML for this rendition.
`processId`	`uuid`	Correlation id shared by all renditions produced by the same create call. Use GET /documents?processId={uuid} to retrieve sibling renditions.
`status`	`string`	Status at the time of acknowledgement. Typically QUEUED_FOR_VALIDATION (awaiting async validation), VALID (when validation was skipped), or FAILED (on synchronous generation/conversion error).
`target`	`string`	Destination network/platform this rendition will be delivered to.
`xml`	`string`	Generated XML content in the indicated format. Present when generation succeeded.
`id`	`string`	Unique resource identifier (UUID). Use this value to poll the status endpoint or to reference the resource in subsequent requests.
`type`	`string`	Resource type — matches the endpoint (e.g. 'invoices' for POST /documents/invoices, 'documents' for GET /documents/{id}/status).
`links`	`JsonApiLinks`
`first`	`string`	URL of the first page.
`last`	`string`	URL of the last page.
`next`	`string`	URL of the next page, null on last page.
`prev`	`string`	URL of the previous page, null on first page.
`self`	`string`	URL of the current page.
`meta`	`JsonApiPaginationMeta`
`page`	`integer`	1-based index of the current page.
`size`	`integer`	Number of items per page.
`totalElements`	`integer`	Total number of items across all pages.
`totalPages`	`integer`	Total number of pages.

cURL Request

curl -X POST https://gateway.vigasoft.lu/bizzlink/documents/json \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "X-Bizzlink-Signature: t=$TIMESTAMP,v1=$SIGNATURE" \
  -H "Content-Type: application/json" \
  -d '{
      "data": {}
  }'

Response
200 OK

{
    "data": [
    {
        "attributes": {
          "format": "string",
          "processId": "00000000-0000-0000-0000-000000000000",
          "status": "QUEUED_FOR_VALIDATION",
          "target": "string"
      },
        "id": "770e8400-e29b-41d4-a716-446655440000",
        "type": "invoices"
    }
    ],
    "links": {
      "first": "https://gateway.vigasoft.lu/bizzlink/documents?page%5Bnumber%5D=1&page%5Bsize%5D=20",
      "last": "https://gateway.vigasoft.lu/bizzlink/documents?page%5Bnumber%5D=7&page%5Bsize%5D=20",
      "next": "https://gateway.vigasoft.lu/bizzlink/documents?page%5Bnumber%5D=4&page%5Bsize%5D=20",
      "prev": "https://gateway.vigasoft.lu/bizzlink/documents?page%5Bnumber%5D=2&page%5Bsize%5D=20",
      "self": "https://gateway.vigasoft.lu/bizzlink/documents?page%5Bnumber%5D=3&page%5Bsize%5D=20"
  },
    "meta": {
      "page": 1,
      "size": 20,
      "totalElements": 137,
      "totalPages": 7
  }
}

Send a document from an XML file

POST /bizzlink/documents/xml

Accepts a UBL 2.1 Invoice or Credit Note XML, validates it asynchronously against PEPPOL BIS 3.0 Schematron rules, and sends it into the Peppol network.

Request body is a JSON:API resource envelope with data.type = "ubl-xml". Response shape: JSON:API collection (data: [...]) with one rendition per entry. Each entry’s JSON:API type reflects the detected document kind (invoices or credit-notes).

Poll GET /documents/{id}/status per rendition for the validation/delivery outcome.

Request Body:

Field	Type	Required	Description
`data`	`object`	Yes	Resource envelope. 'attributes' holds the domain fields; 'meta.scope' declares whether the resource belongs to the whole tenant or to a specific legal entity (Peppol ID).
`attributes`	`UblDocumentRequest`	Yes	The actual resource fields.
`emailDelivery`	`EmailDeliveryRequest`	No	Optional email delivery after successful Peppol transmission
`attachments`	`string[]`	No	Attachments to include. Valid values: 'pdf', 'xml'. Default: ['pdf']
`bcc`	`EmailRecipient[]`	No	BCC recipients (optional)
`address`	`string`	Yes	Email address
`name`	`string`	No	Display name
`bodyTemplateId`	`uuid`	No	ID of an email body template owned by the sender. If null, a default body is used.
`cc`	`EmailRecipient[]`	No	CC recipients (optional)
`address`	`string`	Yes	Email address
`name`	`string`	No	Display name
`context`	`object`	No	Custom template variables that override or extend variables extracted from the UBL XML. Available in subject and body via {{variableName}} placeholders.
`from`	`EmailRecipient`	No	Custom sender address. The domain's SPF record must authorize our mail server. If set, the email is sent from this address instead of noreply@bizzlink.lu, and replyTo becomes optional.
`address`	`string`	Yes	Email address
`name`	`string`	No	Display name
`pdfTemplateId`	`uuid`	No	ID of a PDF template owned by the sender. If null, the default Jasper template is used.
`replyTo`	`EmailRecipient`	No	Reply-To address. Required if 'from' is not set (since emails default to noreply@bizzlink.lu). Optional if 'from' is provided.
`address`	`string`	Yes	Email address
`name`	`string`	No	Display name
`subject`	`string`	No	Email subject with optional {{variable}} placeholders. If empty, a default subject is used: 'Invoice {{invoiceNumber}} from {{sellerName}}'
`to`	`EmailRecipient[]`	Yes	Primary recipients (mandatory, at least one)
`address`	`string`	Yes	Email address
`name`	`string`	No	Display name
`skipValidation`	`boolean`	No	Skip Schematron validation before sending (default: false)
`ublXml`	`string`	Yes	UBL 2.1 Invoice or Credit Note XML content
`meta`	`JsonApiMeta`	No	Optional JSON:API meta. Only used by scoped resources (e.g. email templates, notification emails) to declare their ownership scope.
`scope`	`JsonApiScope`	Yes
`type`	`string`	Yes	Scope type. 'tenant' = applies to the whole tenant. 'legal-entity' = applies only to the Peppol ID given in 'value'. 'partner' = applies to all child tenants of the calling partner tenant; 'value' must be empty.
`value`	`string`	No	Required when type='legal-entity': the Peppol ID (scheme:identifier) that owns this resource, e.g. '9938:lu28079289'. Must belong to the requesting tenant. Ignored when type='tenant'. Must be empty when type='partner'.
`type`	`string`	No	Must be 'ubl-xml' for this endpoint.

Responses:

Status	Description
`200`	Document accepted for async processing
`403`	Sender Peppol ID does not belong to the tenant
`422`	Synchronous processing failed
`500`	Internal server error

Response Body — JsonApiListDocumentDocumentAcceptedAttributes:

Field	Type	Description
`data`	`JsonApiResourceDocumentAcceptedAttributes[]`
`attributes`	`DocumentAcceptedAttributes`	Resource-specific fields.
`format`	`string`	Wire format of the generated XML for this rendition.
`processId`	`uuid`	Correlation id shared by all renditions produced by the same create call. Use GET /documents?processId={uuid} to retrieve sibling renditions.
`status`	`string`	Status at the time of acknowledgement. Typically QUEUED_FOR_VALIDATION (awaiting async validation), VALID (when validation was skipped), or FAILED (on synchronous generation/conversion error).
`target`	`string`	Destination network/platform this rendition will be delivered to.
`xml`	`string`	Generated XML content in the indicated format. Present when generation succeeded.
`id`	`string`	Unique resource identifier (UUID). Use this value to poll the status endpoint or to reference the resource in subsequent requests.
`type`	`string`	Resource type — matches the endpoint (e.g. 'invoices' for POST /documents/invoices, 'documents' for GET /documents/{id}/status).
`links`	`JsonApiLinks`
`first`	`string`	URL of the first page.
`last`	`string`	URL of the last page.
`next`	`string`	URL of the next page, null on last page.
`prev`	`string`	URL of the previous page, null on first page.
`self`	`string`	URL of the current page.
`meta`	`JsonApiPaginationMeta`
`page`	`integer`	1-based index of the current page.
`size`	`integer`	Number of items per page.
`totalElements`	`integer`	Total number of items across all pages.
`totalPages`	`integer`	Total number of pages.

cURL Request

curl -X POST https://gateway.vigasoft.lu/bizzlink/documents/xml \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "X-Bizzlink-Signature: t=$TIMESTAMP,v1=$SIGNATURE" \
  -H "Content-Type: application/json" \
  -d '{
      "data": {}
  }'

Response
200 OK

{
    "data": [
    {
        "attributes": {
          "format": "string",
          "processId": "00000000-0000-0000-0000-000000000000",
          "status": "QUEUED_FOR_VALIDATION",
          "target": "string"
      },
        "id": "770e8400-e29b-41d4-a716-446655440000",
        "type": "invoices"
    }
    ],
    "links": {
      "first": "https://gateway.vigasoft.lu/bizzlink/documents?page%5Bnumber%5D=1&page%5Bsize%5D=20",
      "last": "https://gateway.vigasoft.lu/bizzlink/documents?page%5Bnumber%5D=7&page%5Bsize%5D=20",
      "next": "https://gateway.vigasoft.lu/bizzlink/documents?page%5Bnumber%5D=4&page%5Bsize%5D=20",
      "prev": "https://gateway.vigasoft.lu/bizzlink/documents?page%5Bnumber%5D=2&page%5Bsize%5D=20",
      "self": "https://gateway.vigasoft.lu/bizzlink/documents?page%5Bnumber%5D=3&page%5Bsize%5D=20"
  },
    "meta": {
      "page": 1,
      "size": 20,
      "totalElements": 137,
      "totalPages": 7
  }
}

Get document processing status

GET /bizzlink/documents/{documentId}/status

Returns the current processing status of a document as a JSON:API resource. Use this endpoint to poll the status of asynchronously processed documents.

Possible attributes.status values:

ACCEPTED — Document received and saved
QUEUED_FOR_VALIDATION — Waiting for Schematron validation
VALID — Passed validation
INVALID — Failed validation (see attributes.errors)
QUEUED_FOR_SENDING — Waiting for Peppol transmission
SENT — Transmitted to Peppol network
DELIVERED — Delivery confirmed
FAILED — Processing failed

Responses:

Status	Description
`200`	Document status retrieved
`403`	Document belongs to a different tenant
`404`	Document not found

Response Body — JsonApiDocumentDocumentAttributes:

Field	Type	Description
`data`	`JsonApiResourceDocumentAttributes`
`attributes`	`DocumentAttributes`	Resource-specific fields.
`acknowledgementStatus`	`string`	Acknowledgement outcome of a sent document: SUCCESS (AS4 receipt / positive MLS AP/AB) or FAILURE (send failure / negative MLS RE). Null until acknowledged.
`createdAt`	`datetime`	Timestamp when the document was first accepted.
`errors`	`ValidationError[]`	Validation errors. Populated after async Schematron validation completes with status INVALID. Null otherwise.
`flag`	`string`	Raw schematron severity flag id (e.g. fatal_error, warn)
`id`	`string`	Schematron rule ID
`location`	`string`	XPath location of the error in the XML
`severity`	`string`	Parsed severity; ERROR/FATAL_ERROR block sending, WARNING/INFO do not
`text`	`string`	Human-readable error message
`format`	`string`	Wire format of the stored XML.
`processId`	`uuid`	Correlation id shared by all renditions produced by the same create call. Use GET /documents?processId={uuid} to retrieve sibling renditions.
`status`	`string`	Symbolic status. Typical values: ACCEPTED, QUEUED_FOR_VALIDATION, VALID, INVALID, QUEUED_FOR_SENDING, SENT, DELIVERED, FAILED.
`target`	`string`	Destination network/platform this rendition was/will be delivered to.
`updatedAt`	`datetime`	Timestamp of the most recent state change.
`id`	`string`	Unique resource identifier (UUID). Use this value to poll the status endpoint or to reference the resource in subsequent requests.
`type`	`string`	Resource type — matches the endpoint (e.g. 'invoices' for POST /documents/invoices, 'documents' for GET /documents/{id}/status).

cURL Request

curl -X GET https://gateway.vigasoft.lu/bizzlink/documents/{documentId}/status \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "X-Bizzlink-Signature: t=$TIMESTAMP,v1=$SIGNATURE"

Response
200 OK

{
    "data": {
      "attributes": {
        "acknowledgementStatus": "SUCCESS",
        "createdAt": "2026-01-01T00:00:00Z",
        "errors": [
        {
            "flag": "fatal_error",
            "id": "BR-01",
            "location": "/Invoice/cac:AccountingSupplierParty",
            "severity": "FATAL_ERROR",
            "text": "An Invoice shall have a Specification identifier"
        }
        ],
        "format": "string",
        "processId": "00000000-0000-0000-0000-000000000000",
        "status": "VALID",
        "target": "string",
        "updatedAt": "2026-01-01T00:00:00Z"
    },
      "id": "770e8400-e29b-41d4-a716-446655440000",
      "type": "invoices"
  }
}