Reusable types
Reusable aggregate business-information entities — parties, addresses, taxes, line items, payment means, etc. (XML namespace ram).
Generated reference
These tables are generated from src/lib/models/facturx/reusableTypes.ts and always match the code. See Models for the conceptual overview and a build-an-invoice example.
SpecifiedPeriodType BASIC WL
A time period given by start and end (or a single complete) date-time, such as an invoicing or billing period.
| Property | Type | Required |
|---|---|---|
description | TextType | optional |
startDateTime | DateTimeType | optional |
endDateTime | DateTimeType | optional |
completeDateTime | DateTimeType | optional |
ReferencedDocumentType MINIMUM
A reference to a related document such as an order, contract, despatch advice or supporting attachment, with its identifier, type and optional embedded binary content.
| Property | Type | Required |
|---|---|---|
issuerAssignedID | IDType | optional |
uriID | IDType | optional |
lineID | IDType | optional |
typeCode | DocumentCodeType | optional |
name | TextType[] | optional |
attachmentBinaryObject | BinaryObjectType | optional |
referenceTypeCode | ReferenceCodeType | optional |
formattedIssueDateTime | FormattedDateTimeType | optional |
TradeDeliveryTermsType EXTENDED
The applicable delivery terms, given as an Incoterms-style code and an optional relevant location.
| Property | Type | Required |
|---|---|---|
deliveryTypeCode | DeliveryTermsCodeType | required |
relevantTradeLocation | TradeLocationType | optional |
TradeLocationType EXTENDED
A geographic location, identified by country code and/or name.
| Property | Type | Required |
|---|---|---|
countryID | CountryIDType | optional |
name | TextType | optional |
ProcuringProjectType EN 16931
The procurement project or contract reference the invoice relates to, identified by its identifier and name.
| Property | Type | Required |
|---|---|---|
id | IDType | required |
name | TextType | required |
AdvancePaymentType EXTENDED
An advance (prepaid) payment: its paid amount, receipt date, included VAT and the prepayment invoice it refers to.
| Property | Type | Required |
|---|---|---|
paidAmount | AmountType | required |
formattedReceivedDateTime | FormattedDateTimeType | optional |
includedTradeTax | TradeTaxType[] | required |
invoiceSpecifiedReferencedDocument | ReferencedDocumentType | optional |
FinancialAdjustmentType EXTENDED
A financial adjustment to the settlement, given as a reason and an amount.
| Property | Type | Required |
|---|---|---|
reason | TextType | required |
actualAmount | AmountType | required |
CreditorFinancialAccountType BASIC WL
The payee's receiving bank account, identified by IBAN or a proprietary number, with an optional account name.
| Property | Type | Required |
|---|---|---|
ibanID | IDType | optional |
accountName | TextType | optional |
proprietaryID | IDType | optional |
CreditorFinancialInstitutionType EN 16931
The payee's bank, identified by its BIC.
| Property | Type | Required |
|---|---|---|
bicID | IDType | required |
DebtorFinancialAccountType BASIC WL
The payer's bank account, identified by IBAN, used notably for direct debit.
| Property | Type | Required |
|---|---|---|
ibanID | IDType | required |
accountName | TextType | optional |
DebtorFinancialInstitutionType EXTENDED
The payer's bank, identified by its BIC.
| Property | Type | Required |
|---|---|---|
bicID | IDType | optional |
DocumentContextParameterType MINIMUM
A context parameter carrying the identifier of a guideline or business process.
| Property | Type | Required |
|---|---|---|
id | IDType | required |
NoteType BASIC WL
A free-text note, optionally qualified by subject and content codes.
| Property | Type | Required |
|---|---|---|
contentCode | CodeType | optional |
content | TextType | required |
subjectCode | CodeType | optional |
DocumentLineDocumentType BASIC
Line-level document header: the line number, optional parent line, status code and free-text notes.
| Property | Type | Required |
|---|---|---|
lineID | IDType | required |
parentLineID | IDType | optional |
lineStatusCode | LineStatusCodeType | optional |
lineStatusReasonCode | CodeType | optional |
includedNote | NoteType[] | optional |
TradeTaxType BASIC WL
A VAT breakdown entry for one combination of category and rate: the taxable basis, the resulting tax amount and an optional exemption reason.
| Property | Type | Required |
|---|---|---|
calculatedAmount | AmountType | optional |
typeCode | TaxTypeCodeType | optional |
exemptionReason | TextType | optional |
basisAmount | AmountType | optional |
lineTotalBasisAmount | AmountType | optional |
allowanceChargeBasisAmount | AmountType | optional |
categoryCode | TaxCategoryCodeType | required |
exemptionReasonCode | CodeType | optional |
taxPointDate | DateType | optional |
dueDateTypeCode | TimeReferenceCodeType | optional |
rateApplicablePercent | PercentType | optional |
TradeAddressType MINIMUM
A postal address: street lines, city, post code, ISO 3166-1 country code and country sub-division.
| Property | Type | Required |
|---|---|---|
postcodeCode | CodeType | optional |
lineOne | TextType | optional |
lineTwo | TextType | optional |
lineThree | TextType | optional |
cityName | TextType | optional |
countryID | CountryIDType | required |
countrySubDivisionName | TextType[] | optional |
UniversalCommunicationType BASIC WL
A communication channel, holding either a URI/email address or a phone or fax number.
| Property | Type | Required |
|---|---|---|
uriID | IDType | optional |
completeNumber | TextType | optional |
TradeContactType EN 16931
A contact person for a party: name, department and telephone, fax and email channels.
| Property | Type | Required |
|---|---|---|
personName | TextType | optional |
departmentName | TextType | optional |
typeCode | ContactTypeCodeType | optional |
telephoneUniversalCommunication | UniversalCommunicationType | optional |
faxUniversalCommunication | UniversalCommunicationType | optional |
emailURIUniversalCommunication | UniversalCommunicationType | optional |
LegalOrganizationType MINIMUM
A party's legal registration: its legal identifier, trading name and registered address.
| Property | Type | Required |
|---|---|---|
id | IDType | optional |
tradingBusinessName | TextType | optional |
postalTradeAddress | TradeAddressType | optional |
TaxRegistrationType MINIMUM
A party's tax registration identifier, such as its VAT identifier.
| Property | Type | Required |
|---|---|---|
id | IDType | required |
TradePartyType MINIMUM
A party involved in the trade (seller, buyer, payee, ship-to, tax representative, …): its identifiers, name, role, legal organization, address, contacts and tax registrations.
| Property | Type | Required |
|---|---|---|
id | IDType[] | optional |
globalID | IDType[] | optional |
name | TextType | optional |
roleCode | PartyRoleCodeType | optional |
description | TextType | optional |
specifiedLegalOrganization | LegalOrganizationType | optional |
definedTradeContact | TradeContactType[] | optional |
postalTradeAddress | TradeAddressType | optional |
uriUniversalCommunication | UniversalCommunicationType | optional |
specifiedTaxRegistration | TaxRegistrationType[] | optional |
SupplyChainEventType BASIC WL
A supply-chain event, such as the actual delivery, given by its occurrence date-time.
| Property | Type | Required |
|---|---|---|
occurrenceDateTime | DateTimeType | required |
SupplyChainConsignmentType EXTENDED
A consignment within the delivery, carrying its specified transport movements.
| Property | Type | Required |
|---|---|---|
specifiedLogisticsTransportMovement | LogisticsTransportMovementType[] | optional |
LogisticsTransportMovementType EXTENDED
A transport movement, identified by its mode of transport.
| Property | Type | Required |
|---|---|---|
modeCode | TransportModeCodeType | required |
TradeAccountingAccountType BASIC WL
A buyer accounting reference, such as a cost-centre code, with an optional account type code.
| Property | Type | Required |
|---|---|---|
id | IDType | required |
typeCode | AccountingAccountTypeCodeType | optional |
TradeCurrencyExchangeType EXTENDED
A currency conversion between source and target currencies, with the conversion rate and its date.
| Property | Type | Required |
|---|---|---|
sourceCurrencyCode | CurrencyCodeType | required |
targetCurrencyCode | CurrencyCodeType | required |
conversionRate | RateType | required |
conversionRateDateTime | DateTimeType | optional |
TradeAllowanceChargeType BASIC WL
An allowance (deduction) or charge: a charge indicator, an amount or percentage with its basis, a reason and the applicable VAT category.
| Property | Type | Required |
|---|---|---|
chargeIndicator | IndicatorType | required |
sequenceNumeric | NumericType | optional |
calculationPercent | PercentType | optional |
basisAmount | AmountType | optional |
basisQuantity | QuantityType | optional |
actualAmount | AmountType | required |
reasonCode | AllowanceChargeReasonCodeType | optional |
reason | TextType | optional |
categoryTradeTax | TradeTaxType | optional |
LogisticsServiceChargeType EXTENDED
A logistics service charge, given by its description, amount and applicable tax.
| Property | Type | Required |
|---|---|---|
description | TextType | required |
appliedAmount | AmountType | required |
appliedTradeTax | TradeTaxType[] | optional |
TradePaymentPenaltyTermsType EXTENDED
Late-payment penalty terms: the basis date, period and amount together with the penalty percentage or amount.
| Property | Type | Required |
|---|---|---|
basisDateTime | DateTimeType | optional |
basisPeriodMeasure | MeasureType | optional |
basisAmount | AmountType | optional |
calculationPercent | PercentType | optional |
actualPenaltyAmount | AmountType | optional |
TradePaymentDiscountTermsType EXTENDED
Early-payment discount terms: the basis date, period and amount together with the discount percentage or amount.
| Property | Type | Required |
|---|---|---|
basisDateTime | DateTimeType | optional |
basisPeriodMeasure | MeasureType | optional |
basisAmount | AmountType | optional |
calculationPercent | PercentType | optional |
actualDiscountAmount | AmountType | optional |
TradePaymentTermsType BASIC WL
Payment terms: textual description, due date, direct-debit mandate, partial-payment amount and the applicable penalty and discount terms.
| Property | Type | Required |
|---|---|---|
description | TextType | optional |
dueDateDateTime | DateTimeType | optional |
directDebitMandateID | IDType | optional |
partialPaymentAmount | AmountType | optional |
applicableTradePaymentPenaltyTerms | TradePaymentPenaltyTermsType | optional |
applicableTradePaymentDiscountTerms | TradePaymentDiscountTermsType | optional |
payeeTradeParty | TradePartyType | optional |
TradeSettlementFinancialCardType EN 16931
A payment card used for settlement, identified by a (masked) card number and cardholder name.
| Property | Type | Required |
|---|---|---|
id | IDType | required |
cardholderName | TextType | optional |
TradeSettlementPaymentMeansType BASIC WL
A means of payment: its UNTDID 4461 type code plus the card, debtor/creditor accounts and financial institutions involved.
| Property | Type | Required |
|---|---|---|
typeCode | PaymentMeansCodeType | required |
information | TextType | optional |
applicableTradeSettlementFinancialCard | TradeSettlementFinancialCardType | optional |
payerPartyDebtorFinancialAccount | DebtorFinancialAccountType | optional |
payeePartyCreditorFinancialAccount | CreditorFinancialAccountType | optional |
payerSpecifiedDebtorFinancialInstitution | DebtorFinancialInstitutionType | optional |
payeeSpecifiedCreditorFinancialInstitution | CreditorFinancialInstitutionType | optional |
TradeSettlementHeaderMonetarySummationType MINIMUM
Document-level monetary totals: line, charge and allowance totals, tax basis and VAT amount, grand total, prepaid amount and the amount due for payment.
| Property | Type | Required |
|---|---|---|
lineTotalAmount | AmountType | optional |
chargeTotalAmount | AmountType | optional |
allowanceTotalAmount | AmountType | optional |
taxBasisTotalAmount | AmountType | required |
taxTotalAmount | AmountType[] | optional |
roundingAmount | AmountType | optional |
grandTotalAmount | AmountType | required |
totalPrepaidAmount | AmountType | optional |
duePayableAmount | AmountType | required |
ProductCharacteristicType EN 16931
A product attribute, given as a description and value, optionally with a measured value and type code.
| Property | Type | Required |
|---|---|---|
typeCode | CodeType | optional |
description | TextType | required |
valueMeasure | MeasureType | optional |
value | TextType | required |
ProductClassificationType EN 16931
A product classification, given as a classification code and/or class name.
| Property | Type | Required |
|---|---|---|
classCode | CodeType | optional |
className | TextType | optional |
TradeProductInstanceType EXTENDED
A specific instance of an item, identified by batch and/or supplier-assigned serial number.
| Property | Type | Required |
|---|---|---|
batchID | IDType | optional |
supplierAssignedSerialID | IDType | optional |
TradeCountryType EN 16931
The country of origin of an item, given as an ISO 3166-1 country code.
| Property | Type | Required |
|---|---|---|
id | CountryIDType | optional |
ReferencedProductType EXTENDED
A component or included product, with its identifiers, name, description and unit quantity.
| Property | Type | Required |
|---|---|---|
id | IDType | optional |
globalID | IDType[] | optional |
sellerAssignedID | IDType | optional |
buyerAssignedID | IDType | optional |
industryAssignedID | IDType | optional |
name | TextType | required |
description | TextType | optional |
unitQuantity | QuantityType | optional |
TradeProductType BASIC
The invoiced item: its identifiers, name, description, attributes, classifications, country of origin and manufacturer.
| Property | Type | Required |
|---|---|---|
id | IDType | optional |
globalID | IDType | optional |
sellerAssignedID | IDType | optional |
buyerAssignedID | IDType | optional |
industryAssignedID | IDType | optional |
modelID | IDType | optional |
name | TextType | required |
description | TextType | optional |
batchID | IDType[] | optional |
brandName | TextType | optional |
modelName | TextType | optional |
applicableProductCharacteristic | ProductCharacteristicType[] | optional |
designatedProductClassification | ProductClassificationType[] | optional |
individualTradeProductInstance | TradeProductInstanceType[] | optional |
originTradeCountry | TradeCountryType | optional |
manufacturerTradeParty | TradePartyType | optional |
includedReferencedProduct | ReferencedProductType[] | optional |
TradePriceType BASIC
An item price (gross or net): the price amount, its basis quantity and any applied allowances/charges or included tax.
| Property | Type | Required |
|---|---|---|
chargeAmount | AmountType | required |
basisQuantity | QuantityType | optional |
appliedTradeAllowanceCharge | TradeAllowanceChargeType[] | optional |
includedTradeTax | TradeTaxType | optional |
LineTradeAgreementType BASIC
Line-level trade agreement (price details): the gross and net unit prices and references to the related order, contract and quotation.
| Property | Type | Required |
|---|---|---|
applicableTradeDeliveryTerms | TradeDeliveryTermsType | optional |
sellerOrderReferencedDocument | ReferencedDocumentType | optional |
buyerOrderReferencedDocument | ReferencedDocumentType | optional |
quotationReferencedDocument | ReferencedDocumentType | optional |
contractReferencedDocument | ReferencedDocumentType | optional |
additionalReferencedDocument | ReferencedDocumentType[] | optional |
grossPriceProductTradePrice | TradePriceType | optional |
netPriceProductTradePrice | TradePriceType | optional |
itemSellerTradeParty | TradePartyType | optional |
ultimateCustomerOrderReferencedDocument | ReferencedDocumentType[] | optional |
LineTradeDeliveryType BASIC
Line-level delivery: the billed and packaging quantities, ship-to party, delivery event and despatch/receiving/delivery-note references.
| Property | Type | Required |
|---|---|---|
billedQuantity | QuantityType | optional |
chargeFreeQuantity | QuantityType | optional |
packageQuantity | QuantityType | optional |
perPackageUnitQuantity | QuantityType | optional |
shipToTradeParty | TradePartyType | optional |
ultimateShipToTradeParty | TradePartyType | optional |
actualDeliverySupplyChainEvent | SupplyChainEventType | optional |
despatchAdviceReferencedDocument | ReferencedDocumentType | optional |
receivingAdviceReferencedDocument | ReferencedDocumentType | optional |
deliveryNoteReferencedDocument | ReferencedDocumentType | optional |
TradeSettlementLineMonetarySummationType BASIC
Line-level monetary totals: the net line amount plus any charge, allowance and tax totals.
| Property | Type | Required |
|---|---|---|
lineTotalAmount | AmountType | required |
chargeTotalAmount | AmountType | optional |
allowanceTotalAmount | AmountType | optional |
taxTotalAmount | AmountType | optional |
grandTotalAmount | AmountType | optional |
totalAllowanceChargeAmount | AmountType | optional |
LineTradeSettlementType BASIC
Line-level settlement: the applicable VAT, invoice line period, line allowances/charges, line totals and accounting reference.
| Property | Type | Required |
|---|---|---|
applicableTradeTax | TradeTaxType[] | required |
billingSpecifiedPeriod | SpecifiedPeriodType | optional |
specifiedTradeAllowanceCharge | TradeAllowanceChargeType[] | optional |
specifiedTradeSettlementLineMonetarySummation | TradeSettlementLineMonetarySummationType | optional |
invoiceReferencedDocument | ReferencedDocumentType | optional |
additionalReferencedDocument | ReferencedDocumentType[] | optional |
receivableSpecifiedTradeAccountingAccount | TradeAccountingAccountType[] | optional |
SupplyChainTradeLineItemType BASIC
An invoice line: its line document, the specified item, and the line-level agreement, delivery and settlement.
| Property | Type | Required |
|---|---|---|
associatedDocumentLineDocument | DocumentLineDocumentType | required |
specifiedTradeProduct | TradeProductType | required |
specifiedLineTradeAgreement | LineTradeAgreementType | optional |
specifiedLineTradeDelivery | LineTradeDeliveryType | optional |
specifiedLineTradeSettlement | LineTradeSettlementType | required |