Skip to content

Cross Industry Invoice

The top-level document and its header aggregates (XML namespace rsm). Start from CrossIndustryInvoiceType.

Generated reference

These tables are generated from src/lib/models/facturx/crossIndustryInvoice.ts and always match the code. See Models for the conceptual overview and a build-an-invoice example.

ExchangedDocumentContextType MINIMUM

Business context of the invoice, naming the Factur-X guideline (profile) it conforms to and the business process it belongs to.

PropertyTypeRequired
testIndicatorIndicatorTypeoptional
businessProcessSpecifiedDocumentContextParameterDocumentContextParameterTypeoptional
guidelineSpecifiedDocumentContextParameterDocumentContextParameterTyperequired

ExchangedDocumentType MINIMUM

Document-level header of the invoice: its number, UNTDID 1001 type code, issue date and optional name, notes and language.

PropertyTypeRequired
idIDTyperequired
nameTextTypeoptional
typeCodeDocumentCodeTyperequired
issueDateTimeDateTimeTyperequired
copyIndicatorIndicatorTypeoptional
languageIDIDType[]optional
includedNoteNoteType[]optional
effectiveSpecifiedPeriodSpecifiedPeriodTypeoptional

HeaderTradeAgreementType MINIMUM

Document-level trade agreement covering the seller and buyer, their tax representatives and agents, and references to the order, contract, quotation and procuring project.

PropertyTypeRequired
buyerReferenceTextTypeoptional
sellerTradePartyTradePartyTyperequired
buyerTradePartyTradePartyTyperequired
salesAgentTradePartyTradePartyTypeoptional
buyerTaxRepresentativeTradePartyTradePartyTypeoptional
sellerTaxRepresentativeTradePartyTradePartyTypeoptional
productEndUserTradePartyTradePartyTypeoptional
applicableTradeDeliveryTermsTradeDeliveryTermsTypeoptional
sellerOrderReferencedDocumentReferencedDocumentTypeoptional
buyerOrderReferencedDocumentReferencedDocumentTypeoptional
quotationReferencedDocumentReferencedDocumentTypeoptional
contractReferencedDocumentReferencedDocumentTypeoptional
additionalReferencedDocumentReferencedDocumentType[]optional
buyerAgentTradePartyTradePartyTypeoptional
specifiedProcuringProjectProcuringProjectTypeoptional
ultimateCustomerOrderReferencedDocumentReferencedDocumentType[]optional

HeaderTradeDeliveryType MINIMUM

Document-level delivery information stating where and when the goods or services are delivered: ship-to/ship-from parties, the actual delivery event and despatch, receiving and delivery-note references.

PropertyTypeRequired
relatedSupplyChainConsignmentSupplyChainConsignmentTypeoptional
shipToTradePartyTradePartyTypeoptional
ultimateShipToTradePartyTradePartyTypeoptional
shipFromTradePartyTradePartyTypeoptional
actualDeliverySupplyChainEventSupplyChainEventTypeoptional
despatchAdviceReferencedDocumentReferencedDocumentTypeoptional
receivingAdviceReferencedDocumentReferencedDocumentTypeoptional
deliveryNoteReferencedDocumentReferencedDocumentTypeoptional

HeaderTradeSettlementType MINIMUM

Document-level settlement covering invoice and VAT accounting currencies, payee/payer parties, payment means, the VAT breakdown, document-level allowances and charges, payment terms and the monetary totals.

PropertyTypeRequired
creditorReferenceIDIDTypeoptional
paymentReferenceTextTypeoptional
taxCurrencyCodeCurrencyCodeTypeoptional
invoiceCurrencyCodeCurrencyCodeTyperequired
invoiceIssuerReferenceTextTypeoptional
invoicerTradePartyTradePartyTypeoptional
invoiceeTradePartyTradePartyTypeoptional
payeeTradePartyTradePartyTypeoptional
payerTradePartyTradePartyTypeoptional
taxApplicableTradeCurrencyExchangeTradeCurrencyExchangeTypeoptional
specifiedTradeSettlementPaymentMeansTradeSettlementPaymentMeansType[]optional
applicableTradeTaxTradeTaxType[]required
billingSpecifiedPeriodSpecifiedPeriodTypeoptional
specifiedTradeAllowanceChargeTradeAllowanceChargeType[]optional
specifiedLogisticsServiceChargeLogisticsServiceChargeType[]optional
specifiedTradePaymentTermsTradePaymentTermsType[]optional
specifiedTradeSettlementHeaderMonetarySummationTradeSettlementHeaderMonetarySummationTyperequired
specifiedFinancialAdjustmentFinancialAdjustmentType[]optional
invoiceReferencedDocumentReferencedDocumentType[]optional
receivableSpecifiedTradeAccountingAccountTradeAccountingAccountType[]optional
specifiedAdvancePaymentAdvancePaymentType[]optional

SupplyChainTradeTransactionType MINIMUM

The trade transaction bundling the invoice line items with the document-level agreement, delivery and settlement headers.

PropertyTypeRequired
includedSupplyChainTradeLineItemSupplyChainTradeLineItemType[]optional
applicableHeaderTradeAgreementHeaderTradeAgreementTyperequired
applicableHeaderTradeDeliveryHeaderTradeDeliveryTyperequired
applicableHeaderTradeSettlementHeaderTradeSettlementTyperequired

CrossIndustryInvoiceType MINIMUM

Root of a Factur-X / UN/CEFACT CII invoice, bundling the document context, the document header and the trade transaction.

PropertyTypeRequired
exchangedDocumentContextExchangedDocumentContextTyperequired
exchangedDocumentExchangedDocumentTyperequired
supplyChainTradeTransactionSupplyChainTradeTransactionTyperequired

Released under the MIT License.