Automation MCP Server Features Blog Pricing Contact

CII Creation API Reference

Technical reference for generating UN/CEFACT Cross Industry Invoice (CII) D16B documents from a structured JSON request. Submit seller, buyer and line items, totals and the tax breakdown are calculated automatically. The API returns a CII XML validated against the EN 16931 Schematron rules before delivery, ready for standalone XML delivery, ERP import, or embedding inside a ZUGFeRD or Factur-X PDF/A-3.

POST /v1/create/cii

Quickstart

A minimal request, copy, paste, get a compliant invoice back.

curl -X POST https://api.invoicexml.com/v1/create/cii \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -o invoice-cii.xml \
  -d '{
  "invoice": {
    "invoiceNumber": "INV-2025-001",
    "issueDate": "2025-07-01",
    "currency": "EUR",
    "seller": {
      "name": "Acme GmbH",
      "vatIdentifier": "DE123456789",
      "legalRegistration": { "identifier": "HRB98765" },
      "postalAddress": {
        "line1": "Musterstr. 1",
        "city": "Berlin",
        "postCode": "10115",
        "country": "DE"
      }
    },
    "buyer": {
      "name": "Example Corp",
      "postalAddress": {
        "line1": "12 Rue de Rivoli",
        "city": "Paris",
        "postCode": "75001",
        "country": "FR"
      }
    },
    "paymentDetails": {
      "paymentAccountIdentifier": "DE89370400440532013000"
    },
    "lines": [
      {
        "quantity": 10,
        "priceDetails": { "netPrice": 150.00 },
        "vatInformation": { "rate": 19 },
        "item": { "name": "Consulting Services" }
      }
    ]
  },
  "options": {
    "language": "en"
  }
}'

That's the whole request, the API fills in the rest.

  • invoice.totals and invoice.vatBreakdowns are calculated from line items.
  • invoice.typeCode defaults to 380 (commercial invoice), specificationId is set per standard.
  • The options object is optional. Every field has a sensible default, see Options below.

Try it out online, no coding required

Fill in the form and download a compliant invoice instantly, right in your browser.

Try It Online

Request body

Send invoice data as application/json. The body has two top-level keys: invoice (required) and options (optional). Browse the fields below; toggle Required only for the minimal payload, or filter by name.

POST /v1/create/cii Request body
invoiceobjectrequired22 fields · 6 requiredThe invoice document. Holds all business terms and groups defined by EN 16931.
invoiceNumberstringrequiredBT-1Unique invoice identifier.
issueDatedaterequiredBT-2Date the invoice was issued, in YYYY-MM-DD format.
currencystringrequiredBT-5ISO 4217 currency code (e.g. EUR, USD, GBP).
buyerReferencestringoptionalBT-10Free-text reference used by the buyer's accounting system.
sellerobjectrequired10 fields · 2 requiredBG-4The party issuing the invoice.
namestringrequiredBT-27Legal business name.
vatIdentifierstringoptionalBT-31VAT identification number, including country prefix (e.g. DE123456789). At least one seller identifier (this, legalRegistration.identifier, or an identifiers[] entry) is required by EN 16931 BR-CO-26.
line1stringoptionalBT-35Street address, line 1.
citystringoptionalBT-37City name.
postCodestringoptionalBT-38Postal or ZIP code.
countrystringrequiredBT-40ISO 3166-1 alpha-2 country code (e.g. DE, FR).
line2stringoptionalBT-36Address line 2.
line3stringoptionalBT-162Address line 3.
countrySubdivisionstringoptionalBT-39Region or state (e.g. Bayern).
namestringoptionalBT-41Contact person's name.
phonestringoptionalBT-42Contact phone number.
emailstringoptionalBT-43Contact email address.
identifierstringoptionalBT-34Endpoint identifier (email, GLN, VAT number, etc.).
schemeIdstringoptionalBT-34-1Peppol Electronic Address Scheme (EAS) code. Common values: 9930 (German VAT), 0204 (German Leitweg-ID), 0088 (GS1 GLN), 0192 (Norwegian Organisasjonsnummer), 9957 (French VAT). The full set is large and country-specific, so see the official EAS code list for every value.
identifierstringoptionalBT-30Registration number (e.g. HRB98765). Required when legalRegistration is present.
schemeIdstringoptionalBT-30-1Scheme code for the registration number (e.g. 0002 SIRENE, 0007 Sweden Bolagsverket).
tradingNamestringoptionalBT-28Trading name, if different from the legal business name.
taxRegistrationIdentifierstringoptionalBT-32National tax registration ID, when distinct from the VAT ID.
additionalLegalInformationstringoptionalBT-33Free-text additional legal information (e.g. share capital, registration court).
identifierstringoptionalBT-29Identifier value. Required when an identifiers entry is included.
schemeIdstringoptionalBT-29-1Scheme code for the identifier (e.g. 0088 GLN, 0060 DUNS).
buyerobjectrequired8 fields · 2 requiredBG-7The party receiving the invoice.
namestringrequiredBT-44Legal business name.
vatIdentifierstringoptionalBT-48Buyer VAT ID. Required for EU cross-border and reverse-charge invoices.
line1stringoptionalBT-50Street address, line 1.
citystringoptionalBT-52City name.
postCodestringoptionalBT-53Postal or ZIP code.
countrystringrequiredBT-55ISO 3166-1 alpha-2 country code.
line2stringoptionalBT-51Address line 2.
line3stringoptionalBT-163Address line 3.
countrySubdivisionstringoptionalBT-54Region or state.
identifierstringoptionalBT-49Endpoint identifier.
schemeIdstringoptionalBT-49-1Peppol EAS scheme code. See seller.electronicAddress.schemeId for common values and the full EAS code list.
tradingNamestringoptionalBT-45Trading name, if different from the legal name.
identifierstringoptionalBT-47Registration number. Required when legalRegistration is present.
schemeIdstringoptionalBT-47-1Scheme code for the registration number.
identifierstringoptionalBT-46Identifier value.
schemeIdstringoptionalBT-46-1Scheme code for the identifier.
namestringoptionalBT-56Contact person's name.
phonestringoptionalBT-57Contact phone number.
emailstringoptionalBT-58Contact email address.
paymentDetailsobjectoptional8 fieldsBG-16Payment instructions for the buyer. Defaults to a SEPA credit transfer.
paymentAccountIdentifierstringoptionalBT-84IBAN or other account identifier (e.g. DE89370400440532013000).
paymentMeansCodestringoptionalBT-81UNTDID 4461 payment means code. Defaults to 30 (credit transfer). Common values: 30 (credit transfer), 58 (SEPA credit transfer), 59 (SEPA direct debit), 48 (bank card), 49 (direct debit), 10 (cash). Accepts any code from the UNTDID 4461 code list; the readable names (e.g. CreditTransfer) also work.
paymentMeansTextstringoptionalBT-82Free-text description of the payment means.
remittanceInformationstringoptionalBT-83Remittance reference shown on the bank transfer.
paymentAccountNamestringoptionalBT-85Account holder name.
bicstringoptionalBT-86BIC / SWIFT code.
mandateReferencestringoptionalBT-89SEPA direct debit mandate reference.
paymentTermsstringoptionalBT-20Free-text payment terms (e.g. Net 30 days).
linesobject[]required14 fields · 4 requiredBG-25Invoice line items. At least one line is required (rule BR-16). Each line is independently VAT-categorised.
quantitydecimalrequiredBT-129Invoiced quantity. Negative values are allowed, e.g. a returned item or a credit note line.
namestringrequiredBT-153Item name shown on the invoice.
descriptionstringoptionalBT-154Longer item description (e.g. a components list).
sellerIdentifierstringoptionalBT-155Item identifier in the seller's catalogue.
buyerIdentifierstringoptionalBT-156Item identifier in the buyer's catalogue.
countryOfOriginstringoptionalBT-159ISO 3166-1 alpha-2 country code.
identifierstringoptionalBT-157Identifier value (e.g. a GTIN).
schemeIdstringoptionalBT-157-1Scheme code (e.g. 0160 for GTIN).
identifierstringoptionalBT-158Classification code value.
schemeIdstringoptionalBT-158-1Classification scheme (e.g. TST).
schemeVersionstringoptionalBT-158-2Scheme version.
netPricedecimalrequiredBT-146Net unit price, excluding VAT.
discountAmountdecimaloptionalBT-147Discount applied to the unit price.
grossPricedecimaloptionalBT-148Unit price before discount.
priceBaseQuantitydecimaloptionalBT-149Quantity the unit price refers to (e.g. price per 100 units). Defaults to 1.
priceBaseUnitstringoptionalBT-150Unit-of-measure code for the base quantity. Same UN/ECE Rec 20 values as unitCode.
ratedecimalrequiredBT-152VAT rate as a percentage (e.g. 19 for 19%, 0 for zero-rated).
Allowed values
SStandard rated
ZZero rated
EExempt from VAT
AEReverse charge
KIntra-Community supply (EU)
GExport outside the EU
ONot subject to VAT
lineIdstringoptionalBT-126Line identifier. Auto-generated as 1, 2, … when omitted.
lineNotestringoptionalBT-127Free-text note shown on the invoice line.
unitCodestringoptionalBT-130UN/ECE Rec 20 unit-of-measure code. Defaults to C62 (piece). Common values: C62 (piece), HUR (hour), DAY (day), KGM (kilogram), MTR (metre), LTR (litre). The list runs to several hundred codes, so see the official UN/ECE Rec 20 code list for every value.
lineNetAmountdecimaloptionalBT-131Line total before VAT. Auto-calculated when omitted as quantity × priceDetails.netPrice, plus any line charges and minus any line allowances.
buyerOrderLineReferencestringoptionalBT-132Buyer purchase order line reference.
lineBuyerAccountingReferencestringoptionalBT-133Buyer's accounting cost-centre reference for this line.
identifierstringoptionalBT-128Identifier value.
schemeIdstringoptionalBT-128-1Scheme code for the identifier.
startDatedateoptionalBT-134Line period start date, YYYY-MM-DD.
endDatedateoptionalBT-135Line period end date, YYYY-MM-DD.
amountdecimaloptionalBT-136Allowance amount. Required when an allowances entry is included.
baseAmountdecimaloptionalBT-137Base amount the percentage is calculated from.
percentagedecimaloptionalBT-138Allowance as a percentage of the base amount.
reasonstringoptionalBT-139Free-text reason for the allowance.
reasonCodestringoptionalBT-140UNTDID 5189 allowance reason code.
amountdecimaloptionalBT-141Charge amount. Required when a charges entry is included.
baseAmountdecimaloptionalBT-142Base amount the percentage is calculated from.
percentagedecimaloptionalBT-143Charge as a percentage of the base amount.
reasonstringoptionalBT-144Free-text reason for the charge.
reasonCodestringoptionalBT-145UNTDID 7161 charge reason code.
paidAmountdecimaloptionalBT-113Amount already paid, e.g. a deposit, down payment or prepaid amount. Carries no VAT and is subtracted from the grand total to give the amount due. A deposit belongs here, not in the lines.
roundingAmountdecimaloptionalBT-114Rounding adjustment added to the grand total when computing the amount due.
sumOfLineNetAmountsdecimaloptionalBT-106Sum of all line net amounts.
sumOfAllowancesdecimaloptionalBT-107Sum of document-level allowances.
sumOfChargesdecimaloptionalBT-108Sum of document-level charges.
taxBasisTotalAmountdecimaloptionalBT-109Total without VAT: line nets minus allowances plus charges.
taxTotalAmountdecimaloptionalBT-110Total VAT amount across all breakdowns.
taxTotalAmountInAccountingCurrencydecimaloptionalBT-111Total VAT in the accounting currency, when taxCurrency differs from currency.
grandTotalAmountdecimaloptionalBT-112Total with VAT: tax basis plus total VAT.
duePayableAmountdecimaloptionalBT-115Amount due: grand total minus paidAmount plus roundingAmount.
taxableAmountdecimaloptionalBT-116Net amount taxed at this category and rate.
taxAmountdecimaloptionalBT-117VAT charged on the taxable amount.
Allowed values
SStandard rated
ZZero rated
EExempt from VAT
AEReverse charge
KIntra-Community supply (EU)
GExport outside the EU
ONot subject to VAT
ratedecimaloptionalBT-119VAT rate as a percentage.
exemptionReasonTextstringoptionalBT-120Reason the amount is exempt or zero-rated. Auto-filled for non-standard categories.
exemptionReasonCodestringoptionalBT-121Coded exemption reason (e.g. VATEX-EU-AE). Auto-resolved from the category.
dueDatedateoptionalBT-9Payment due date, YYYY-MM-DD. Defaults to issue date + 30 days.
Allowed values
380Commercial invoice (default)
381Credit note
384Corrected invoice
389Self-billed invoice
875Partial construction invoice
876Partial final construction invoice
specificationIdstringoptionalBT-24EN 16931 specification identifier. Auto-set per standard, override only if you know what you are doing.
taxCurrencystringoptionalBT-6VAT accounting currency, if different from currency.
businessProcessTypestringoptionalBT-23Business process identifier (e.g. urn:fdc:peppol.eu:2017:poacc:billing:01:1.0).
purchaseOrderReferencestringoptionalBT-13Buyer purchase order reference.
notesstring[]optionalBT-22Free-text invoice notes. 0..n entries.
startDatedateoptionalBT-73Period start date, YYYY-MM-DD.
endDatedateoptionalBT-74Period end date, YYYY-MM-DD.
referencestringoptionalBT-25Preceding invoice number. Required when an entry is included.
issueDatedateoptionalBT-26Issue date of the preceding invoice, YYYY-MM-DD.
amountdecimaloptionalBT-92Allowance amount. Required when an allowances entry is included.
Allowed values
SStandard rated
ZZero rated
EExempt from VAT
AEReverse charge
KIntra-Community supply (EU)
GExport outside the EU
ONot subject to VAT
vatRatedecimaloptionalBT-96VAT rate as a percentage (e.g. 19). Required when the category is S.
baseAmountdecimaloptionalBT-93Base amount the percentage is calculated from.
percentagedecimaloptionalBT-94Allowance as a percentage of the base amount.
reasonstringoptionalBT-97Free-text reason for the allowance.
reasonCodestringoptionalBT-98UNTDID 5189 allowance reason code.
amountdecimaloptionalBT-99Charge amount. Required when a charges entry is included.
Allowed values
SStandard rated
ZZero rated
EExempt from VAT
AEReverse charge
KIntra-Community supply (EU)
GExport outside the EU
ONot subject to VAT
vatRatedecimaloptionalBT-103VAT rate as a percentage (e.g. 19). Required when the category is S. Usually matches the rate of the goods being shipped.
baseAmountdecimaloptionalBT-100Base amount the percentage is calculated from.
percentagedecimaloptionalBT-101Charge as a percentage of the base amount.
reasonstringoptionalBT-104Free-text reason for the charge, e.g. Shipping. Shown as the line label on the PDF.
reasonCodestringoptionalBT-105UNTDID 7161 charge reason code (e.g. FC for freight).
receiverNamestringoptionalBT-70Deliver-to party name.
locationIdentifierstringoptionalBT-71Deliver-to location identifier (e.g. GLN).
actualDeliveryDatedateoptionalBT-72Actual delivery date, YYYY-MM-DD.
line1stringoptionalBT-75Street address, line 1.
citystringoptionalBT-77City name.
postCodestringoptionalBT-78Postal or ZIP code.
countrystringoptionalBT-80ISO 3166-1 alpha-2 country code.
line2stringoptionalBT-76Address line 2.
line3stringoptionalBT-165Address line 3.
countrySubdivisionstringoptionalBT-79Region or state.
optionsobjectoptional1 fieldsBehaviour switches that change how the output is built. Every field has a sensible default, so the whole object is optional.
Allowed values
enEnglish
deGerman
frFrench

Headers

Header Value
Authorization * Bearer YOUR_API_KEY
Content-Type application/json

Response

200 Generated PDF

The invoice was generated. The response body is the PDF, returned as a binary download.

Content-Type: application/pdf

400 Model validation error

One or more request fields are missing or invalid, so generation never started.

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errorCode": 4002,
  "valid": false,
  "detail": "The request failed validation with 1 error(s).",
  "errors": [
    {
      "rule": null,
      "line": null,
      "message": "The Name field is required.",
      "btCodes": ["BT-27"],
      "fields": ["seller.name"],
      "raw": null
    }
  ],
  "warnings": []
}

400 Schematron validation error

The request was well-formed, but the generated invoice failed EN 16931 Schematron business rules.

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "XML Validation Failed",
  "status": 400,
  "detail": "The generated invoice contains 2 validation error(s).",
  "errors": [
    {
      "rule": "BR-CO-15",
      "line": null,
      "message": "The invoice total with VAT does not match. Expected 1500.00 + 285.00 = 1785.00.",
      "btCodes": ["BT-112"],
      "fields": ["totals.grandTotalAmount"],
      "raw": "[BR-CO-15] EN16931: Invoice total amount with VAT = 1785.00 expected 1500.00 + 285.00. (at /*:CrossIndustryInvoice/*:SupplyChainTradeTransaction/*:ApplicableHeaderTradeSettlement)"
    },
    {
      "rule": "BR-S-08",
      "line": null,
      "message": "The VAT breakdown for Standard rate must have a positive taxable amount and the correct rate. Check the tax breakdown.",
      "btCodes": ["BT-116", "BT-117"],
      "fields": ["taxBreakdown[0].taxableAmount"],
      "raw": "[BR-S-08] EN16931: VAT category tax amount must equal category basis × rate. (at /*:CrossIndustryInvoice/*:SupplyChainTradeTransaction/*:ApplicableHeaderTradeSettlement/*:ApplicableTradeTax)"
    }
  ],
  "warnings": [
    {
      "rule": "BR-CL-25",
      "line": null,
      "message": "The seller country code should be a valid ISO 3166-1 alpha-2 value.",
      "btCodes": ["BT-40"],
      "fields": ["seller.postalAddress.country"],
      "raw": "[BR-CL-25] EN16931: Country codes should follow ISO 3166-1 alpha-2. (at /*:CrossIndustryInvoice/*:SupplyChainTradeTransaction/*:ApplicableHeaderTradeAgreement/*:SellerTradeParty)"
    }
  ],
  "traceId": "00-54efc3135dd95c21098f45b67ae2b5ab-c894e992bbcccfd7-00",
  "errorCode": 4001
}

Error Reference

Errors are returned as RFC 7807 ProblemDetails. The errorCode field indicates the error category.

errorCode Meaning errors key
4001 XML validation, the generated XML violates EN 16931 Schematron rules. errors is a flat array of finding objects, each with rule, line, message, btCodes, fields, and raw. A parallel warnings array carries non-blocking advisory findings of the same shape. errors[]  warnings[]
4002 Model validation, one or more request fields are missing or invalid. Returned as the same flat errors array of finding objects as 4001, with fields pointing at the offending input. errors[]
4000 General error, check detail for more information. none

Useful resources

Companion material for integrating against the API.

Frequently Asked Questions

Which guideline identifier does the output declare?

By default the document declares urn:cen.eu:en16931:2017 in its GuidelineSpecifiedDocumentContextParameter (BT-24), the plain EN 16931 identifier that the Factur-X and ZUGFeRD EN 16931 profiles also use. The document is validated against the EN 16931 rule set before delivery, so the declared identifier matches what was checked.

Can I embed the output in a ZUGFeRD or Factur-X PDF?

Yes. The generated CII D16B XML is structurally identical to the XML embedded in ZUGFeRD 2.x and Factur-X documents. You can attach it to a PDF/A-3 container in your own pipeline. Alternatively, use /v1/create/zugferd or /v1/create/facturx to receive the complete hybrid PDF in a single API call.

What is the difference between /create/cii and /create/zugferd?

/create/cii returns a standalone CII XML file, ideal for ERP import, direct transmission, or manual PDF/A-3 embedding. /create/zugferd returns a complete ZUGFeRD-compliant PDF/A-3 with the CII XML already embedded, ready for direct B2B exchange in Germany.

How does CII differ from UBL?

Both are valid EN 16931 syntaxes. CII (UN/CEFACT) is the format used by ZUGFeRD and Factur-X and is the dominant choice in Germany and France. UBL (OASIS) is the native format of the Peppol network. Use CII when your recipient expects ZUGFeRD, Factur-X, or a CII-based integration. Use /v1/create/ubl for Peppol-destined invoices.

Is the output validated automatically?

Yes. Every generated CII document is validated against EN 16931 Schematron business rules before delivery. If validation fails (e.g. mismatched totals or missing mandatory fields), the API returns a 400 response with errorCode 4001 and the violated rules as findings with rule id, layer, and field paths.

Why is the request a JSON body and not multipart/form-data?

The /create endpoints accept a nested JSON document modelled directly on the EN 16931 semantic model (business terms and groups). This keeps deep structures like postal addresses, line price details, and VAT information clean to express, and matches what most modern HTTP clients expect. Set Content-Type: application/json.