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 documents

GET /bizzlink/documents

Lists documents belonging to the authenticated tenant — plus its sub-tenants when the caller is a PARTNER. Two modes:

Filter by direction (direction=inbound|outbound, optional since): returns a paginated JSON:API collection with data, links (self/first/last/prev/next) and meta (page/size/totalElements/totalPages). Pagination via page[number] (1-based) and page[size] (default 20, max 100).

Sibling lookup (processId=<uuid>): returns every document rendition produced by the same create-and-send call — useful when a single business document is rendered into multiple wire formats (e.g. FatturaPA via SDI plus UBL via Peppol). Returns an unpaginated collection; direction, since and pagination parameters are ignored. Returns an empty data array if no renditions match.

Exactly one of direction or processId must be provided.

Responses

Status	Description
`200`	Document list
`400`	Missing or invalid direction/processId parameter

Response Body — `JsonApiListDocumentDocumentAttributes`

Field	Type	Description
	`JsonApiResourceDocumentAttributes[]`
	`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.
	`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`	Processing status. Outbound lifecycle: ACCEPTED → QUEUED_FOR_VALIDATION → VALID/INVALID → QUEUED_FOR_SENDING → SUBMITTED → DELIVERED, or FAILED. Inbound documents use RECEIVED → READY_FOR_PICKUP → PICKED_UP, or INBOUND_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).
	`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.
	`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 GET https://gateway.vigasoft.lu/bizzlink/documents \
  -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": "documents"
    }
    ],
    "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 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	Description
required	`object`	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).
required	`BusinessDocument (oneOf)`	The actual resource fields.
	@type = "InvoiceDocument"
`accountingCurrency`	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
`additionalIdentifiers`	`object`	Escape-hatch for format-specific identifiers not yet mapped to a typed field. Empty if none.
	`Attachment[]`	BG-24 — Embedded supporting documents / binary attachments (e.g. a PDF rendition). Empty if none.
`content`required	`string`	BG-24 embedded binary content, Base64-encoded (BT-125)
`contentType`required	`string`	BG-24 attachment MIME type — must be application/pdf for v1.0
`description`	`string`	BG-24 human-readable document description (BT-123)
`filename`required	`string`	BG-24 attachment file name (e.g. invoice-2026-001.pdf)
`businessProcessType`	`string`	BT-23 — Business process type the invoice belongs to.
required	`Party`
`additionalLegalInfo`	`string`	BT-33 — Additional legal information about the party (e.g. share capital, legal form).
required	`Address`
`additionalStreet`	`string`	BT-162 / BT-163 — Additional address line.
`city`required	`string`	BT-37 (seller) / BT-52 (buyer) — City / town.
`countryCode`required	`string`	ISO 3166-1 alpha-2 country code (BT-40, BT-55, BT-159). Serialized in JSON as the two-letter country code, which is the enum constant name, e.g. "LU", "DE", "FR".
`countrySubdivision`	`string`	BT-39 (seller) / BT-54 (buyer) — Country subdivision (region / state / province).
`postCode`required	`string`	BT-38 (seller) / BT-53 (buyer) — Post code / ZIP.
`street1`required	`string`	BT-35 (seller) / BT-50 (buyer) — Address line 1 (street and number).
`street2`	`string`	BT-36 / BT-51 — Address line 2.
	`Contact`
`email`	`string`	BT-43 (seller) / BT-58 (buyer) — Contact email address.
`name`	`string`	BT-41 (seller) / BT-56 (buyer) — Contact point name.
`telephone`	`string`	BT-42 (seller) / BT-57 (buyer) — Contact telephone number.
`electronicAddress`required	`string`	BT-34 (seller) / BT-49 (buyer) — Electronic address: the Peppol participant value, paired with electronicAddressSchemeId.
`electronicAddressSchemeId`required	`string`	Peppol EAS (Electronic Address Scheme, iso6523-actorid-upis) code list identifying the scheme of a participant's electronic address. Serialized in JSON as the numeric EAS code, e.g. "9938" = LU:VAT, "0211" = IT:IVA, "0235" = AE:TIN, "0088" = GLN; for backward compatibility the enum constant name (colon replaced by underscore, e.g. "LU_VAT") is also accepted on deserialization.
`identifier`	`string`	BT-29 (seller) / BT-46 (buyer) — Party identifier (with optional scheme).
`legalRegistrationId`	`string`	BT-30 (seller) / BT-47 (buyer) — Legal registration identifier (e.g. commercial register no.).
`name`required	`string`	BT-27 (seller) / BT-44 (buyer) — Party legal name.
`taxRegistration`	`string`	BT-32 — Seller tax registration identifier (where a non-VAT tax number applies).
`tradingName`	`string`	BT-28 (seller) / BT-45 (buyer) — Trading name, if different from the legal name.
`vatId`required	`string`	BT-31 (seller) / BT-48 (buyer) — VAT identifier.
`buyerAccountingReference`	`string`	BT-19 — Buyer accounting reference (e.g. accounting cost / GL account).
`buyerReference`	`string`	BT-10 — Buyer reference (e.g. cost centre); often mandatory for B2G.
`contractReference`	`string`	BT-12 — Contract reference.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
	`Delivery`
	`Address`
`additionalStreet`	`string`	BT-162 / BT-163 — Additional address line.
`city`required	`string`	BT-37 (seller) / BT-52 (buyer) — City / town.
`countryCode`required	`string`	ISO 3166-1 alpha-2 country code (BT-40, BT-55, BT-159). Serialized in JSON as the two-letter country code, which is the enum constant name, e.g. "LU", "DE", "FR".
`countrySubdivision`	`string`	BT-39 (seller) / BT-54 (buyer) — Country subdivision (region / state / province).
`postCode`required	`string`	BT-38 (seller) / BT-53 (buyer) — Post code / ZIP.
`street1`required	`string`	BT-35 (seller) / BT-50 (buyer) — Address line 1 (street and number).
`street2`	`string`	BT-36 / BT-51 — Address line 2.
`deliveryDate`	`date`	BG-13 actual delivery date (BT-72)
`locationIdentifier`	`string`	BG-13 deliver-to location identifier (BT-71)
`locationIdentifierSchemeId`	`string`	BG-13 deliver-to location identifier scheme (BT-71-1)
`partyName`	`string`	BG-13 deliver-to party name (BT-70)
`despatchAdviceReference`	`string`	BT-16 — Despatch advice reference.
`documentId`required	`string`	BT-1 — Invoice number. Unique identifier of the invoice from the sender.
	`Allowance[]`	BG-20 — Document-level allowances (discounts). Empty if none.
required	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
`percentage`	`number`	BG-20/BG-27 allowance percentage (BT-94 / BT-138)
`reasonCode`	`string`	BG-20/BG-27 allowance reason code (BT-98 / BT-140)
`reasonText`	`string`	BG-20/BG-27 allowance reason text (BT-97 / BT-139)
`vatCategoryCode`required	`string`	UNCL5305 VAT category code (BT-118, BT-151), e.g. S standard rate, Z zero rated, E exempt, AE reverse charge, K intra-community supply, G free export, O outside scope, L Canary Islands IGIC, M Ceuta and Melilla (plus PINT MY jurisdiction codes). Serialized in JSON as the category code, which is the enum constant name, e.g. "S", "AE".
`vatRate`	`number`	BG-20/BG-27 allowance VAT rate (BT-96)
	`Charge[]`	BG-21 — Document-level charges (fees). Empty if none.
required	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
`percentage`	`number`	BG-21/BG-28 charge percentage (BT-101 / BT-143)
`reasonCode`	`string`	BG-21/BG-28 charge reason code (BT-105 / BT-145)
`reasonText`	`string`	BG-21/BG-28 charge reason text (BT-104 / BT-144)
`vatCategoryCode`required	`string`	UNCL5305 VAT category code (BT-118, BT-151), e.g. S standard rate, Z zero rated, E exempt, AE reverse charge, K intra-community supply, G free export, O outside scope, L Canary Islands IGIC, M Ceuta and Melilla (plus PINT MY jurisdiction codes). Serialized in JSON as the category code, which is the enum constant name, e.g. "S", "AE".
`vatRate`	`number`	BG-21/BG-28 charge VAT rate (BT-103)
`dueDate`	`date`	BT-9 — Payment due date.
	`FacturXExtensions`
`profile`required	`string`	Factur-X / ZUGFeRD 2.x conformance profile, in increasing order of completeness: MINIMUM, BASIC_WL (basic without invoice lines), BASIC, EN16931 (EN 16931 compliant), EXTENDED.
`renderHumanReadablePdf`	`boolean`	Whether to render a human-readable PDF representation of the invoice.
	`FatturaPaExtensions`
`codiceDestinatario`	`string`	Recipient SDI destination code (Codice Destinatario) for routing the invoice through the Sistema di Interscambio.
`codiceFiscaleSender`	`string`	Sender's Italian fiscal code (Codice Fiscale).
	`FatturaPaContractRef`
`codiceCIG`	`string`	Tender identification code (CodiceCIG), mandatory for public-administration invoices.
`codiceCUP`	`string`	Single project code (CodiceCUP), mandatory for public-administration invoices.
`data`required	`date`	Contract date (Data).
`idDocumento`required	`string`	Contract document identifier (IdDocumento).
	`FatturaPaDdtRef`
`dataDdt`required	`date`	Transport document date (DataDDT).
`numeroDdt`required	`string`	Transport document number (NumeroDDT).
`esigibilitaIVA`	`string`	FatturaPA EsigibilitaIVA code list defining the VAT chargeability point: I (immediate), D (deferred), or S (split payment / scissione dei pagamenti).
`modalitaPagamento`	`string`	FatturaPA ModalitaPagamento code list (MP01..MP23) identifying the Italian payment method.
`naturaPerTaxBreakdown`	`string[]`	VAT-exemption nature codes (Natura, N1..N7) applied per tax breakdown line, mandatory when the VAT rate is zero.
`pecDestinatario`	`string`	Recipient certified e-mail address (PEC) used as an alternative delivery channel when no Codice Destinatario applies.
`regimeFiscale`required	`string`	FatturaPA RegimeFiscale code list (RF01..RF19) identifying the sender's Italian tax regime.
`splitPayment`	`boolean`	Whether split payment (scissione dei pagamenti) applies, meaning the buyer pays VAT directly to the tax authority.
`tipoDocumento`required	`string`	FatturaPA TipoDocumento code list (TD01..TD29) identifying the Italian SDI document type. Reference: Agenzia delle Entrate, FatturaPA v1.9 (April 2025).
`invoicedObjectIdentifier`	`string`	BT-18 — Invoiced object identifier.
`issueDate`required	`date`	BT-2 — Invoice issue date.
required	`LineItem[]`	BG-25 — Invoice lines. At least one line is required.
	`Allowance[]`	BG-27 — Invoice line allowances (discounts). Empty if none.
required	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
`percentage`	`number`	BG-20/BG-27 allowance percentage (BT-94 / BT-138)
`reasonCode`	`string`	BG-20/BG-27 allowance reason code (BT-98 / BT-140)
`reasonText`	`string`	BG-20/BG-27 allowance reason text (BT-97 / BT-139)
`vatCategoryCode`required	`string`	UNCL5305 VAT category code (BT-118, BT-151), e.g. S standard rate, Z zero rated, E exempt, AE reverse charge, K intra-community supply, G free export, O outside scope, L Canary Islands IGIC, M Ceuta and Melilla (plus PINT MY jurisdiction codes). Serialized in JSON as the category code, which is the enum constant name, e.g. "S", "AE".
`vatRate`	`number`	BG-20/BG-27 allowance VAT rate (BT-96)
	`NameValue[]`	BG-32 — Item attributes (additional name/value characteristics). Empty if none.
`name`required	`string`	Attribute name / item property name (BT-160)
`value`required	`string`	Attribute value / item property value (BT-161)
`buyerAccountingRef`	`string`	BT-133 — Invoice line buyer accounting reference.
`buyerItemId`	`string`	BT-156 — Buyer's item identifier.
	`Charge[]`	BG-28 — Invoice line charges (fees). Empty if none.
required	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
`percentage`	`number`	BG-21/BG-28 charge percentage (BT-101 / BT-143)
`reasonCode`	`string`	BG-21/BG-28 charge reason code (BT-105 / BT-145)
`reasonText`	`string`	BG-21/BG-28 charge reason text (BT-104 / BT-144)
`vatCategoryCode`required	`string`	UNCL5305 VAT category code (BT-118, BT-151), e.g. S standard rate, Z zero rated, E exempt, AE reverse charge, K intra-community supply, G free export, O outside scope, L Canary Islands IGIC, M Ceuta and Melilla (plus PINT MY jurisdiction codes). Serialized in JSON as the category code, which is the enum constant name, e.g. "S", "AE".
`vatRate`	`number`	BG-21/BG-28 charge VAT rate (BT-103)
`classificationId`	`string`	BT-158 — Item classification identifier (e.g. CPV / UNSPSC).
`countryOfOrigin`	`string`	ISO 3166-1 alpha-2 country code (BT-40, BT-55, BT-159). Serialized in JSON as the two-letter country code, which is the enum constant name, e.g. "LU", "DE", "FR".
	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
`id`required	`string`	BT-126 — Invoice line identifier.
`itemDescription`	`string`	BT-154 — Item description.
`itemName`required	`string`	BT-153 — Item name.
required	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
`note`	`string`	BT-127 — Invoice line note (free text).
`objectIdentifier`	`string`	BT-128 — Invoice line object identifier.
`periodEnd`	`date`	BT-135 — Invoice line period end date.
`periodStart`	`date`	BT-134 — Invoice line period start date.
`priceBaseQuantity`	`number`	BT-149 — Item price base quantity (number of units the price applies to).
`priceBaseQuantityUnit`	`string`	UN/ECE Recommendation 20 unit of measure code (BT-130, BT-150), e.g. C62 piece, HUR hour, KGM kilogram, MTR metre. Serialized in JSON as the Rec 20 code, which is the enum constant name, e.g. "C62", "HUR".
	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
`purchaseOrderLineRef`	`string`	BT-132 — Referenced purchase order line.
`quantity`required	`number`	BT-129 — Invoiced quantity.
`sellerItemId`	`string`	BT-155 — Seller's item identifier.
`standardItemId`	`string`	BT-157 — Item standard identifier (with scheme, e.g. GTIN).
`unitCode`required	`string`	UN/ECE Recommendation 20 unit of measure code (BT-130, BT-150), e.g. C62 piece, HUR hour, KGM kilogram, MTR metre. Serialized in JSON as the Rec 20 code, which is the enum constant name, e.g. "C62", "HUR".
`vatCategoryCode`required	`string`	UNCL5305 VAT category code (BT-118, BT-151), e.g. S standard rate, Z zero rated, E exempt, AE reverse charge, K intra-community supply, G free export, O outside scope, L Canary Islands IGIC, M Ceuta and Melilla (plus PINT MY jurisdiction codes). Serialized in JSON as the category code, which is the enum constant name, e.g. "S", "AE".
`vatRate`required	`number`	BT-152 — Invoiced item VAT rate (percentage).
`note`	`string`	BT-22 — Invoice note (free-text remarks).
	`PaymentInfo`
	`BankAccount[]`	BG-17 credit-transfer bank accounts (BT-84..86); empty when not applicable
`accountName`	`string`	Payment account name (BT-85)
`bic`	`string`	Payment service provider identifier / BIC (BT-86)
`iban`required	`string`	Payment account identifier / IBAN for credit transfer (BT-84)
`paymentMeansCode`required	`string`	UNCL4461 payment means code (BT-81), e.g. 30 credit transfer, 58 SEPA credit transfer, 48 card, 49 direct debit. Serialized in JSON as the enum constant name (e.g. "CREDIT_TRANSFER", "SEPA_CREDIT_TRANSFER"); the numeric code is exposed separately via code().
`paymentMeansText`	`string`	BG-16 payment means text (BT-82)
`remittanceInformation`	`string`	BG-16 remittance / payment reference (BT-83)
`paymentTermsText`	`string`	BT-20 — Payment terms in free text.
	`PeppolExtensions`
`profileIdOverride`	`string`	Optional override for the PEPPOL profile identifier.
`receiverSchemeIdOverride`	`string`	Peppol EAS (Electronic Address Scheme, iso6523-actorid-upis) code list identifying the scheme of a participant's electronic address. Serialized in JSON as the numeric EAS code, e.g. "9938" = LU:VAT, "0211" = IT:IVA, "0235" = AE:TIN, "0088" = GLN; for backward compatibility the enum constant name (colon replaced by underscore, e.g. "LU_VAT") is also accepted on deserialization.
`senderSchemeIdOverride`	`string`	Peppol EAS (Electronic Address Scheme, iso6523-actorid-upis) code list identifying the scheme of a participant's electronic address. Serialized in JSON as the numeric EAS code, e.g. "9938" = LU:VAT, "0211" = IT:IVA, "0235" = AE:TIN, "0088" = GLN; for backward compatibility the enum constant name (colon replaced by underscore, e.g. "LU_VAT") is also accepted on deserialization.
`precedingInvoiceDate`	`date`	BT-26 — Preceding invoice issue date.
`precedingInvoiceReference`	`string`	BT-25 — Preceding invoice reference (the invoice number this one corrects/relates to).
	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
`projectReference`	`string`	BT-11 — Project reference.
`purchaseOrderReference`	`string`	BT-13 — Purchase order reference.
`receivingAdviceReference`	`string`	BT-15 — Receiving advice reference.
`salesOrderReference`	`string`	BT-14 — Sales order reference.
required	`Party`
`additionalLegalInfo`	`string`	BT-33 — Additional legal information about the party (e.g. share capital, legal form).
required	`Address`
`additionalStreet`	`string`	BT-162 / BT-163 — Additional address line.
`city`required	`string`	BT-37 (seller) / BT-52 (buyer) — City / town.
`countryCode`required	`string`	ISO 3166-1 alpha-2 country code (BT-40, BT-55, BT-159). Serialized in JSON as the two-letter country code, which is the enum constant name, e.g. "LU", "DE", "FR".
`countrySubdivision`	`string`	BT-39 (seller) / BT-54 (buyer) — Country subdivision (region / state / province).
`postCode`required	`string`	BT-38 (seller) / BT-53 (buyer) — Post code / ZIP.
`street1`required	`string`	BT-35 (seller) / BT-50 (buyer) — Address line 1 (street and number).
`street2`	`string`	BT-36 / BT-51 — Address line 2.
	`Contact`
`email`	`string`	BT-43 (seller) / BT-58 (buyer) — Contact email address.
`name`	`string`	BT-41 (seller) / BT-56 (buyer) — Contact point name.
`telephone`	`string`	BT-42 (seller) / BT-57 (buyer) — Contact telephone number.
`electronicAddress`required	`string`	BT-34 (seller) / BT-49 (buyer) — Electronic address: the Peppol participant value, paired with electronicAddressSchemeId.
`electronicAddressSchemeId`required	`string`	Peppol EAS (Electronic Address Scheme, iso6523-actorid-upis) code list identifying the scheme of a participant's electronic address. Serialized in JSON as the numeric EAS code, e.g. "9938" = LU:VAT, "0211" = IT:IVA, "0235" = AE:TIN, "0088" = GLN; for backward compatibility the enum constant name (colon replaced by underscore, e.g. "LU_VAT") is also accepted on deserialization.
`identifier`	`string`	BT-29 (seller) / BT-46 (buyer) — Party identifier (with optional scheme).
`legalRegistrationId`	`string`	BT-30 (seller) / BT-47 (buyer) — Legal registration identifier (e.g. commercial register no.).
`name`required	`string`	BT-27 (seller) / BT-44 (buyer) — Party legal name.
`taxRegistration`	`string`	BT-32 — Seller tax registration identifier (where a non-VAT tax number applies).
`tradingName`	`string`	BT-28 (seller) / BT-45 (buyer) — Trading name, if different from the legal name.
`vatId`required	`string`	BT-31 (seller) / BT-48 (buyer) — VAT identifier.
required	`TaxBreakdown[]`	BG-23 — VAT breakdown per category/rate. At least one entry is required.
`categoryCode`required	`string`	UNCL5305 VAT category code (BT-118, BT-151), e.g. S standard rate, Z zero rated, E exempt, AE reverse charge, K intra-community supply, G free export, O outside scope, L Canary Islands IGIC, M Ceuta and Melilla (plus PINT MY jurisdiction codes). Serialized in JSON as the category code, which is the enum constant name, e.g. "S", "AE".
`exemptionReasonCode`	`string`	BT-121 — VAT exemption reason code.
`exemptionReasonText`	`string`	BT-120 — VAT exemption reason text.
`rate`required	`number`	BT-119 — VAT category rate (percentage).
required	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
`tenderOrLotReference`	`string`	BT-17 — Tender or lot reference.
`typeCode`required	`string`	UN/CEFACT 1001 document type code (BT-3), e.g. 380 commercial invoice, 381 credit note, 384 corrected invoice, 386 prepayment invoice, 389 self-billed invoice. Serialized in JSON as the enum constant name (e.g. "COMMERCIAL_INVOICE", "CREDIT_NOTE"); the numeric code is exposed separately via code().
`vatPointDate`	`date`	BT-7 — VAT point date: the date when VAT becomes accountable.
`vatPointDateCode`	`string`	BT-8 — VAT point date code, when the VAT point is expressed as a code instead of a date.
	`XRechnungExtensions`
`b2gMode`	`boolean`	Whether to enable German B2G mode.
	`LeitwegId`
`value`required	`string`	The Leitweg-ID value, e.g. 04011000-12345-37.
	@type = "CreditNoteDocument"
`accountingCurrency`	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
`additionalIdentifiers`	`object`	Escape-hatch for format-specific identifiers not yet mapped to a typed field. Empty if none.
	`Attachment[]`	BG-24 — Embedded supporting documents / binary attachments (e.g. a PDF rendition). Empty if none.
`content`required	`string`	BG-24 embedded binary content, Base64-encoded (BT-125)
`contentType`required	`string`	BG-24 attachment MIME type — must be application/pdf for v1.0
`description`	`string`	BG-24 human-readable document description (BT-123)
`filename`required	`string`	BG-24 attachment file name (e.g. invoice-2026-001.pdf)
`businessProcessType`	`string`	BT-23 — Business process type the document belongs to.
required	`Party`
`additionalLegalInfo`	`string`	BT-33 — Additional legal information about the party (e.g. share capital, legal form).
required	`Address`
`additionalStreet`	`string`	BT-162 / BT-163 — Additional address line.
`city`required	`string`	BT-37 (seller) / BT-52 (buyer) — City / town.
`countryCode`required	`string`	ISO 3166-1 alpha-2 country code (BT-40, BT-55, BT-159). Serialized in JSON as the two-letter country code, which is the enum constant name, e.g. "LU", "DE", "FR".
`countrySubdivision`	`string`	BT-39 (seller) / BT-54 (buyer) — Country subdivision (region / state / province).
`postCode`required	`string`	BT-38 (seller) / BT-53 (buyer) — Post code / ZIP.
`street1`required	`string`	BT-35 (seller) / BT-50 (buyer) — Address line 1 (street and number).
`street2`	`string`	BT-36 / BT-51 — Address line 2.
	`Contact`
`email`	`string`	BT-43 (seller) / BT-58 (buyer) — Contact email address.
`name`	`string`	BT-41 (seller) / BT-56 (buyer) — Contact point name.
`telephone`	`string`	BT-42 (seller) / BT-57 (buyer) — Contact telephone number.
`electronicAddress`required	`string`	BT-34 (seller) / BT-49 (buyer) — Electronic address: the Peppol participant value, paired with electronicAddressSchemeId.
`electronicAddressSchemeId`required	`string`	Peppol EAS (Electronic Address Scheme, iso6523-actorid-upis) code list identifying the scheme of a participant's electronic address. Serialized in JSON as the numeric EAS code, e.g. "9938" = LU:VAT, "0211" = IT:IVA, "0235" = AE:TIN, "0088" = GLN; for backward compatibility the enum constant name (colon replaced by underscore, e.g. "LU_VAT") is also accepted on deserialization.
`identifier`	`string`	BT-29 (seller) / BT-46 (buyer) — Party identifier (with optional scheme).
`legalRegistrationId`	`string`	BT-30 (seller) / BT-47 (buyer) — Legal registration identifier (e.g. commercial register no.).
`name`required	`string`	BT-27 (seller) / BT-44 (buyer) — Party legal name.
`taxRegistration`	`string`	BT-32 — Seller tax registration identifier (where a non-VAT tax number applies).
`tradingName`	`string`	BT-28 (seller) / BT-45 (buyer) — Trading name, if different from the legal name.
`vatId`required	`string`	BT-31 (seller) / BT-48 (buyer) — VAT identifier.
`buyerAccountingReference`	`string`	BT-19 — Buyer accounting reference (e.g. accounting cost / GL account).
`buyerReference`	`string`	BT-10 — Buyer reference (e.g. cost centre); often mandatory for B2G.
`contractReference`	`string`	BT-12 — Contract reference.
`creditNoteReasonCode`	`string`	BTAE-03 — Credit note reason code (jurisdiction-specific). Mandatory for PINT AE credit notes (from the 'Reasons for credit note' code list); ignored where the jurisdiction does not define it.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
	`Delivery`
	`Address`
`additionalStreet`	`string`	BT-162 / BT-163 — Additional address line.
`city`required	`string`	BT-37 (seller) / BT-52 (buyer) — City / town.
`countryCode`required	`string`	ISO 3166-1 alpha-2 country code (BT-40, BT-55, BT-159). Serialized in JSON as the two-letter country code, which is the enum constant name, e.g. "LU", "DE", "FR".
`countrySubdivision`	`string`	BT-39 (seller) / BT-54 (buyer) — Country subdivision (region / state / province).
`postCode`required	`string`	BT-38 (seller) / BT-53 (buyer) — Post code / ZIP.
`street1`required	`string`	BT-35 (seller) / BT-50 (buyer) — Address line 1 (street and number).
`street2`	`string`	BT-36 / BT-51 — Address line 2.
`deliveryDate`	`date`	BG-13 actual delivery date (BT-72)
`locationIdentifier`	`string`	BG-13 deliver-to location identifier (BT-71)
`locationIdentifierSchemeId`	`string`	BG-13 deliver-to location identifier scheme (BT-71-1)
`partyName`	`string`	BG-13 deliver-to party name (BT-70)
`despatchAdviceReference`	`string`	BT-16 — Despatch advice reference.
`documentId`required	`string`	BT-1 — Credit note number. Unique identifier from the sender.
	`Allowance[]`	BG-20 — Document-level allowances (discounts). Empty if none.
required	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
`percentage`	`number`	BG-20/BG-27 allowance percentage (BT-94 / BT-138)
`reasonCode`	`string`	BG-20/BG-27 allowance reason code (BT-98 / BT-140)
`reasonText`	`string`	BG-20/BG-27 allowance reason text (BT-97 / BT-139)
`vatCategoryCode`required	`string`	UNCL5305 VAT category code (BT-118, BT-151), e.g. S standard rate, Z zero rated, E exempt, AE reverse charge, K intra-community supply, G free export, O outside scope, L Canary Islands IGIC, M Ceuta and Melilla (plus PINT MY jurisdiction codes). Serialized in JSON as the category code, which is the enum constant name, e.g. "S", "AE".
`vatRate`	`number`	BG-20/BG-27 allowance VAT rate (BT-96)
	`Charge[]`	BG-21 — Document-level charges (fees). Empty if none.
required	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
`percentage`	`number`	BG-21/BG-28 charge percentage (BT-101 / BT-143)
`reasonCode`	`string`	BG-21/BG-28 charge reason code (BT-105 / BT-145)
`reasonText`	`string`	BG-21/BG-28 charge reason text (BT-104 / BT-144)
`vatCategoryCode`required	`string`	UNCL5305 VAT category code (BT-118, BT-151), e.g. S standard rate, Z zero rated, E exempt, AE reverse charge, K intra-community supply, G free export, O outside scope, L Canary Islands IGIC, M Ceuta and Melilla (plus PINT MY jurisdiction codes). Serialized in JSON as the category code, which is the enum constant name, e.g. "S", "AE".
`vatRate`	`number`	BG-21/BG-28 charge VAT rate (BT-103)
`dueDate`	`date`	BT-9 — Payment due date.
	`FacturXExtensions`
`profile`required	`string`	Factur-X / ZUGFeRD 2.x conformance profile, in increasing order of completeness: MINIMUM, BASIC_WL (basic without invoice lines), BASIC, EN16931 (EN 16931 compliant), EXTENDED.
`renderHumanReadablePdf`	`boolean`	Whether to render a human-readable PDF representation of the invoice.
	`FatturaPaExtensions`
`codiceDestinatario`	`string`	Recipient SDI destination code (Codice Destinatario) for routing the invoice through the Sistema di Interscambio.
`codiceFiscaleSender`	`string`	Sender's Italian fiscal code (Codice Fiscale).
	`FatturaPaContractRef`
`codiceCIG`	`string`	Tender identification code (CodiceCIG), mandatory for public-administration invoices.
`codiceCUP`	`string`	Single project code (CodiceCUP), mandatory for public-administration invoices.
`data`required	`date`	Contract date (Data).
`idDocumento`required	`string`	Contract document identifier (IdDocumento).
	`FatturaPaDdtRef`
`dataDdt`required	`date`	Transport document date (DataDDT).
`numeroDdt`required	`string`	Transport document number (NumeroDDT).
`esigibilitaIVA`	`string`	FatturaPA EsigibilitaIVA code list defining the VAT chargeability point: I (immediate), D (deferred), or S (split payment / scissione dei pagamenti).
`modalitaPagamento`	`string`	FatturaPA ModalitaPagamento code list (MP01..MP23) identifying the Italian payment method.
`naturaPerTaxBreakdown`	`string[]`	VAT-exemption nature codes (Natura, N1..N7) applied per tax breakdown line, mandatory when the VAT rate is zero.
`pecDestinatario`	`string`	Recipient certified e-mail address (PEC) used as an alternative delivery channel when no Codice Destinatario applies.
`regimeFiscale`required	`string`	FatturaPA RegimeFiscale code list (RF01..RF19) identifying the sender's Italian tax regime.
`splitPayment`	`boolean`	Whether split payment (scissione dei pagamenti) applies, meaning the buyer pays VAT directly to the tax authority.
`tipoDocumento`required	`string`	FatturaPA TipoDocumento code list (TD01..TD29) identifying the Italian SDI document type. Reference: Agenzia delle Entrate, FatturaPA v1.9 (April 2025).
`invoicedObjectIdentifier`	`string`	BT-18 — Invoiced object identifier.
`issueDate`required	`date`	BT-2 — Credit note issue date.
required	`LineItem[]`	BG-25 — Credit note lines. At least one line is required.
	`Allowance[]`	BG-27 — Invoice line allowances (discounts). Empty if none.
required	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
`percentage`	`number`	BG-20/BG-27 allowance percentage (BT-94 / BT-138)
`reasonCode`	`string`	BG-20/BG-27 allowance reason code (BT-98 / BT-140)
`reasonText`	`string`	BG-20/BG-27 allowance reason text (BT-97 / BT-139)
`vatCategoryCode`required	`string`	UNCL5305 VAT category code (BT-118, BT-151), e.g. S standard rate, Z zero rated, E exempt, AE reverse charge, K intra-community supply, G free export, O outside scope, L Canary Islands IGIC, M Ceuta and Melilla (plus PINT MY jurisdiction codes). Serialized in JSON as the category code, which is the enum constant name, e.g. "S", "AE".
`vatRate`	`number`	BG-20/BG-27 allowance VAT rate (BT-96)
	`NameValue[]`	BG-32 — Item attributes (additional name/value characteristics). Empty if none.
`name`required	`string`	Attribute name / item property name (BT-160)
`value`required	`string`	Attribute value / item property value (BT-161)
`buyerAccountingRef`	`string`	BT-133 — Invoice line buyer accounting reference.
`buyerItemId`	`string`	BT-156 — Buyer's item identifier.
	`Charge[]`	BG-28 — Invoice line charges (fees). Empty if none.
required	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
`percentage`	`number`	BG-21/BG-28 charge percentage (BT-101 / BT-143)
`reasonCode`	`string`	BG-21/BG-28 charge reason code (BT-105 / BT-145)
`reasonText`	`string`	BG-21/BG-28 charge reason text (BT-104 / BT-144)
`vatCategoryCode`required	`string`	UNCL5305 VAT category code (BT-118, BT-151), e.g. S standard rate, Z zero rated, E exempt, AE reverse charge, K intra-community supply, G free export, O outside scope, L Canary Islands IGIC, M Ceuta and Melilla (plus PINT MY jurisdiction codes). Serialized in JSON as the category code, which is the enum constant name, e.g. "S", "AE".
`vatRate`	`number`	BG-21/BG-28 charge VAT rate (BT-103)
`classificationId`	`string`	BT-158 — Item classification identifier (e.g. CPV / UNSPSC).
`countryOfOrigin`	`string`	ISO 3166-1 alpha-2 country code (BT-40, BT-55, BT-159). Serialized in JSON as the two-letter country code, which is the enum constant name, e.g. "LU", "DE", "FR".
	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
`id`required	`string`	BT-126 — Invoice line identifier.
`itemDescription`	`string`	BT-154 — Item description.
`itemName`required	`string`	BT-153 — Item name.
required	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
`note`	`string`	BT-127 — Invoice line note (free text).
`objectIdentifier`	`string`	BT-128 — Invoice line object identifier.
`periodEnd`	`date`	BT-135 — Invoice line period end date.
`periodStart`	`date`	BT-134 — Invoice line period start date.
`priceBaseQuantity`	`number`	BT-149 — Item price base quantity (number of units the price applies to).
`priceBaseQuantityUnit`	`string`	UN/ECE Recommendation 20 unit of measure code (BT-130, BT-150), e.g. C62 piece, HUR hour, KGM kilogram, MTR metre. Serialized in JSON as the Rec 20 code, which is the enum constant name, e.g. "C62", "HUR".
	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
`purchaseOrderLineRef`	`string`	BT-132 — Referenced purchase order line.
`quantity`required	`number`	BT-129 — Invoiced quantity.
`sellerItemId`	`string`	BT-155 — Seller's item identifier.
`standardItemId`	`string`	BT-157 — Item standard identifier (with scheme, e.g. GTIN).
`unitCode`required	`string`	UN/ECE Recommendation 20 unit of measure code (BT-130, BT-150), e.g. C62 piece, HUR hour, KGM kilogram, MTR metre. Serialized in JSON as the Rec 20 code, which is the enum constant name, e.g. "C62", "HUR".
`vatCategoryCode`required	`string`	UNCL5305 VAT category code (BT-118, BT-151), e.g. S standard rate, Z zero rated, E exempt, AE reverse charge, K intra-community supply, G free export, O outside scope, L Canary Islands IGIC, M Ceuta and Melilla (plus PINT MY jurisdiction codes). Serialized in JSON as the category code, which is the enum constant name, e.g. "S", "AE".
`vatRate`required	`number`	BT-152 — Invoiced item VAT rate (percentage).
`note`	`string`	BT-22 — Note (free-text remarks).
`originalInvoiceDate`required	`date`	BT-26 — Preceding invoice issue date (date of the original invoice).
`originalInvoiceNumber`required	`string`	BT-25 — Preceding invoice reference: number of the original invoice this credit note relates to.
	`PaymentInfo`
	`BankAccount[]`	BG-17 credit-transfer bank accounts (BT-84..86); empty when not applicable
`accountName`	`string`	Payment account name (BT-85)
`bic`	`string`	Payment service provider identifier / BIC (BT-86)
`iban`required	`string`	Payment account identifier / IBAN for credit transfer (BT-84)
`paymentMeansCode`required	`string`	UNCL4461 payment means code (BT-81), e.g. 30 credit transfer, 58 SEPA credit transfer, 48 card, 49 direct debit. Serialized in JSON as the enum constant name (e.g. "CREDIT_TRANSFER", "SEPA_CREDIT_TRANSFER"); the numeric code is exposed separately via code().
`paymentMeansText`	`string`	BG-16 payment means text (BT-82)
`remittanceInformation`	`string`	BG-16 remittance / payment reference (BT-83)
`paymentTermsText`	`string`	BT-20 — Payment terms in free text.
	`PeppolExtensions`
`profileIdOverride`	`string`	Optional override for the PEPPOL profile identifier.
`receiverSchemeIdOverride`	`string`	Peppol EAS (Electronic Address Scheme, iso6523-actorid-upis) code list identifying the scheme of a participant's electronic address. Serialized in JSON as the numeric EAS code, e.g. "9938" = LU:VAT, "0211" = IT:IVA, "0235" = AE:TIN, "0088" = GLN; for backward compatibility the enum constant name (colon replaced by underscore, e.g. "LU_VAT") is also accepted on deserialization.
`senderSchemeIdOverride`	`string`	Peppol EAS (Electronic Address Scheme, iso6523-actorid-upis) code list identifying the scheme of a participant's electronic address. Serialized in JSON as the numeric EAS code, e.g. "9938" = LU:VAT, "0211" = IT:IVA, "0235" = AE:TIN, "0088" = GLN; for backward compatibility the enum constant name (colon replaced by underscore, e.g. "LU_VAT") is also accepted on deserialization.
	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
`projectReference`	`string`	BT-11 — Project reference.
`purchaseOrderReference`	`string`	BT-13 — Purchase order reference.
`receivingAdviceReference`	`string`	BT-15 — Receiving advice reference.
`salesOrderReference`	`string`	BT-14 — Sales order reference.
required	`Party`
`additionalLegalInfo`	`string`	BT-33 — Additional legal information about the party (e.g. share capital, legal form).
required	`Address`
`additionalStreet`	`string`	BT-162 / BT-163 — Additional address line.
`city`required	`string`	BT-37 (seller) / BT-52 (buyer) — City / town.
`countryCode`required	`string`	ISO 3166-1 alpha-2 country code (BT-40, BT-55, BT-159). Serialized in JSON as the two-letter country code, which is the enum constant name, e.g. "LU", "DE", "FR".
`countrySubdivision`	`string`	BT-39 (seller) / BT-54 (buyer) — Country subdivision (region / state / province).
`postCode`required	`string`	BT-38 (seller) / BT-53 (buyer) — Post code / ZIP.
`street1`required	`string`	BT-35 (seller) / BT-50 (buyer) — Address line 1 (street and number).
`street2`	`string`	BT-36 / BT-51 — Address line 2.
	`Contact`
`email`	`string`	BT-43 (seller) / BT-58 (buyer) — Contact email address.
`name`	`string`	BT-41 (seller) / BT-56 (buyer) — Contact point name.
`telephone`	`string`	BT-42 (seller) / BT-57 (buyer) — Contact telephone number.
`electronicAddress`required	`string`	BT-34 (seller) / BT-49 (buyer) — Electronic address: the Peppol participant value, paired with electronicAddressSchemeId.
`electronicAddressSchemeId`required	`string`	Peppol EAS (Electronic Address Scheme, iso6523-actorid-upis) code list identifying the scheme of a participant's electronic address. Serialized in JSON as the numeric EAS code, e.g. "9938" = LU:VAT, "0211" = IT:IVA, "0235" = AE:TIN, "0088" = GLN; for backward compatibility the enum constant name (colon replaced by underscore, e.g. "LU_VAT") is also accepted on deserialization.
`identifier`	`string`	BT-29 (seller) / BT-46 (buyer) — Party identifier (with optional scheme).
`legalRegistrationId`	`string`	BT-30 (seller) / BT-47 (buyer) — Legal registration identifier (e.g. commercial register no.).
`name`required	`string`	BT-27 (seller) / BT-44 (buyer) — Party legal name.
`taxRegistration`	`string`	BT-32 — Seller tax registration identifier (where a non-VAT tax number applies).
`tradingName`	`string`	BT-28 (seller) / BT-45 (buyer) — Trading name, if different from the legal name.
`vatId`required	`string`	BT-31 (seller) / BT-48 (buyer) — VAT identifier.
required	`TaxBreakdown[]`	BG-23 — VAT breakdown per category/rate. At least one entry is required.
`categoryCode`required	`string`	UNCL5305 VAT category code (BT-118, BT-151), e.g. S standard rate, Z zero rated, E exempt, AE reverse charge, K intra-community supply, G free export, O outside scope, L Canary Islands IGIC, M Ceuta and Melilla (plus PINT MY jurisdiction codes). Serialized in JSON as the category code, which is the enum constant name, e.g. "S", "AE".
`exemptionReasonCode`	`string`	BT-121 — VAT exemption reason code.
`exemptionReasonText`	`string`	BT-120 — VAT exemption reason text.
`rate`required	`number`	BT-119 — VAT category rate (percentage).
required	`Money`
`amount`required	`number`	Monetary amount. Up to 2 decimals for totals, up to 4 for unit prices / tax bases.
`currency`required	`string`	ISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
`tenderOrLotReference`	`string`	BT-17 — Tender or lot reference.
`typeCode`required	`string`	UN/CEFACT 1001 document type code (BT-3), e.g. 380 commercial invoice, 381 credit note, 384 corrected invoice, 386 prepayment invoice, 389 self-billed invoice. Serialized in JSON as the enum constant name (e.g. "COMMERCIAL_INVOICE", "CREDIT_NOTE"); the numeric code is exposed separately via code().
`vatPointDate`	`date`	BT-7 — VAT point date: the date when VAT becomes accountable.
`vatPointDateCode`	`string`	BT-8 — VAT point date code, when expressed as a code instead of a date.
	`XRechnungExtensions`
`b2gMode`	`boolean`	Whether to enable German B2G mode.
	`LeitwegId`
`value`required	`string`	The Leitweg-ID value, e.g. 04011000-12345-37.
	`JsonApiMeta`	Optional JSON:API meta. Only used by scoped resources (e.g. email templates, notification emails) to declare their ownership scope.
required	`JsonApiScope`
`type`required	`string`	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`	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`	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
	`JsonApiResourceDocumentAcceptedAttributes[]`
	`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).
	`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.
	`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 — either Peppol BIS 3.0 or XRechnung 3.0 (German CIUS) —, validates it asynchronously against the matching Schematron rules (BIS or KoSIT XRechnung), and sends it into the Peppol network.

If the receiver’s SMP capabilities do not include the submitted profile but do include the sibling one (BIS ↔ XRechnung), the document is automatically re-profiled before validation — e.g. a BIS invoice addressed to a German B2G platform that only accepts XRechnung is sent as XRechnung, and vice versa. The rendition’s format attribute (status endpoint) reflects what was actually sent.

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	Description
required	`object`	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).
required	`UblDocumentRequest`	The actual resource fields.
	`EmailDeliveryRequest`	Optional email delivery after successful Peppol transmission
`attachments`	`string[]`	Attachments to include. Valid values: 'pdf', 'xml'. Default: ['pdf']
	`EmailRecipient[]`	BCC recipients (optional)
`address`required	`string`	Email address
`name`	`string`	Display name
`bodyTemplateId`	`uuid`	ID of an email body template owned by the sender. If null, a default body is used.
	`EmailRecipient[]`	CC recipients (optional)
`address`required	`string`	Email address
`name`	`string`	Display name
`context`	`object`	Custom template variables that override or extend variables extracted from the UBL XML. Available in subject and body via {{variableName}} placeholders.
	`EmailRecipient`	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`required	`string`	Email address
`name`	`string`	Display name
`pdfTemplateId`	`uuid`	ID of a PDF template owned by the sender. If null, the default Jasper template is used.
	`EmailRecipient`	Reply-To address. Required if 'from' is not set (since emails default to noreply@bizzlink.lu). Optional if 'from' is provided.
`address`required	`string`	Email address
`name`	`string`	Display name
`subject`	`string`	Email subject with optional {{variable}} placeholders. If empty, a default subject is used: 'Invoice {{invoiceNumber}} from {{sellerName}}'
required	`EmailRecipient[]`	Primary recipients (mandatory, at least one)
`address`required	`string`	Email address
`name`	`string`	Display name
`ublXml`required	`string`	UBL 2.1 Invoice or Credit Note XML content
	`JsonApiMeta`	Optional JSON:API meta. Only used by scoped resources (e.g. email templates, notification emails) to declare their ownership scope.
required	`JsonApiScope`
`type`required	`string`	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`	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`	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
	`JsonApiResourceDocumentAcceptedAttributes[]`
	`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).
	`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.
	`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
  }
}

Download document as UBL XML or PDF

GET /bizzlink/documents/{documentId}

Returns the UBL 2.1 XML content or a generated PDF/A-3b of a document. Use the Accept header to select the format: application/xml or application/pdf. The document must belong to the tenant, or to one of its sub-tenants when the caller is a PARTNER.

Responses

Status	Description
`200`	Document returned
`403`	Document does not belong to the tenant or its sub-tenants
`404`	Document not found
`406`	Requested Accept type not supported

cURL Request

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

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
	`JsonApiResourceDocumentAttributes`
	`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.
	`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`	Processing status. Outbound lifecycle: ACCEPTED → QUEUED_FOR_VALIDATION → VALID/INVALID → QUEUED_FOR_SENDING → SUBMITTED → DELIVERED, or FAILED. Inbound documents use RECEIVED → READY_FOR_PICKUP → PICKED_UP, or INBOUND_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": "documents"
  }
}

Document

List documents

Responses

Response Body — JsonApiListDocumentDocumentAttributes

Send a document from a JSON structure

Request Body

Responses

Response Body — JsonApiListDocumentDocumentAcceptedAttributes

Send a document from an XML file

Request Body

Responses

Response Body — JsonApiListDocumentDocumentAcceptedAttributes

Download document as UBL XML or PDF

Responses

Get document processing status

Responses

Response Body — JsonApiDocumentDocumentAttributes

Response Body — `JsonApiListDocumentDocumentAttributes`

Response Body — `JsonApiListDocumentDocumentAcceptedAttributes`

Response Body — `JsonApiListDocumentDocumentAcceptedAttributes`

Response Body — `JsonApiDocumentDocumentAttributes`