Invoice Request

Complete field reference for the InvoiceDocument schema.

The InvoiceDocument schema (@type = "InvoiceDocument") is used with the Send a document from a JSON structure endpoint.

InvoiceDocument

FieldTypeDescription
accountingCurrencystringISO 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".
additionalIdentifiersobjectEscape-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.
businessProcessTypestringBT-23 — Business process type the invoice belongs to.
requiredParty
buyerAccountingReferencestringBT-19 — Buyer accounting reference (e.g. accounting cost / GL account).
buyerReferencestringBT-10 — Buyer reference (e.g. cost centre); often mandatory for B2G.
contractReferencestringBT-12 — Contract reference.
currencyrequiredstringISO 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
despatchAdviceReferencestringBT-16 — Despatch advice reference.
documentIdrequiredstringBT-1 — Invoice number. Unique identifier of the invoice from the sender.
Allowance[]BG-20 — Document-level allowances (discounts). Empty if none.
Charge[]BG-21 — Document-level charges (fees). Empty if none.
dueDatedateBT-9 — Payment due date.
FacturXExtensions
FatturaPaExtensions
invoicedObjectIdentifierstringBT-18 — Invoiced object identifier.
issueDaterequireddateBT-2 — Invoice issue date.
requiredLineItem[]BG-25 — Invoice lines. At least one line is required.
notestringBT-22 — Invoice note (free-text remarks).
PaymentInfo
paymentTermsTextstringBT-20 — Payment terms in free text.
PeppolExtensions
precedingInvoiceDatedateBT-26 — Preceding invoice issue date.
precedingInvoiceReferencestringBT-25 — Preceding invoice reference (the invoice number this one corrects/relates to).
Money
projectReferencestringBT-11 — Project reference.
purchaseOrderReferencestringBT-13 — Purchase order reference.
receivingAdviceReferencestringBT-15 — Receiving advice reference.
salesOrderReferencestringBT-14 — Sales order reference.
requiredParty
requiredTaxBreakdown[]BG-23 — VAT breakdown per category/rate. At least one entry is required.
tenderOrLotReferencestringBT-17 — Tender or lot reference.
typeCoderequiredstringUN/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().
vatPointDatedateBT-7 — VAT point date: the date when VAT becomes accountable.
vatPointDateCodestringBT-8 — VAT point date code, when the VAT point is expressed as a code instead of a date.
XRechnungExtensions

Party

BG-7 — Buyer (Cessionario / Committente).
FieldTypeDescription
additionalLegalInfostringBT-33 — Additional legal information about the party (e.g. share capital, legal form).
requiredAddress
Contact
electronicAddressrequiredstringBT-34 (seller) / BT-49 (buyer) — Electronic address: the Peppol participant value, paired with electronicAddressSchemeId.
electronicAddressSchemeIdrequiredstringPeppol 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.
identifierstringBT-29 (seller) / BT-46 (buyer) — Party identifier (with optional scheme).
legalRegistrationIdstringBT-30 (seller) / BT-47 (buyer) — Legal registration identifier (e.g. commercial register no.).
namerequiredstringBT-27 (seller) / BT-44 (buyer) — Party legal name.
taxRegistrationstringBT-32 — Seller tax registration identifier (where a non-VAT tax number applies).
tradingNamestringBT-28 (seller) / BT-45 (buyer) — Trading name, if different from the legal name.
vatIdrequiredstringBT-31 (seller) / BT-48 (buyer) — VAT identifier.

LineItem

BG-25 — Invoice lines. At least one line is required.
FieldTypeDescription
Allowance[]BG-27 — Invoice line allowances (discounts). Empty if none.
NameValue[]BG-32 — Item attributes (additional name/value characteristics). Empty if none.
buyerAccountingRefstringBT-133 — Invoice line buyer accounting reference.
buyerItemIdstringBT-156 — Buyer's item identifier.
Charge[]BG-28 — Invoice line charges (fees). Empty if none.
classificationIdstringBT-158 — Item classification identifier (e.g. CPV / UNSPSC).
countryOfOriginstringISO 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
idrequiredstringBT-126 — Invoice line identifier.
itemDescriptionstringBT-154 — Item description.
itemNamerequiredstringBT-153 — Item name.
requiredMoney
notestringBT-127 — Invoice line note (free text).
objectIdentifierstringBT-128 — Invoice line object identifier.
periodEnddateBT-135 — Invoice line period end date.
periodStartdateBT-134 — Invoice line period start date.
priceBaseQuantitynumberBT-149 — Item price base quantity (number of units the price applies to).
priceBaseQuantityUnitstringUN/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
purchaseOrderLineRefstringBT-132 — Referenced purchase order line.
quantityrequirednumberBT-129 — Invoiced quantity.
sellerItemIdstringBT-155 — Seller's item identifier.
standardItemIdstringBT-157 — Item standard identifier (with scheme, e.g. GTIN).
unitCoderequiredstringUN/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".
vatCategoryCoderequiredstringUNCL5305 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".
vatRaterequirednumberBT-152 — Invoiced item VAT rate (percentage).