ZUGFeRD field mapping
These tables show how Kofax AP Essentials maps internal fields with ZUGFeRD 1.0 and ZUGFeRD 2.0.
ZUGFeRD 2.0
| Kofax AP Essentials internal field name | ZUGFeRD 2.0 |
|---|---|
| Buyer fields | |
| Name | BuyerTradeParty/Name |
| Identifier | BuyerTradeParty/GlobalID |
| BuyerVATRegistrationNumber | BuyerTradeParty/SpecifiedTaxRegistration/ID
...where the attribute schemeID=”VA” |
| CorporateGroupNumber | |
| Description | |
| CountryCode | BuyerTradeParty/PostalTradeAddress/CountryID |
| CountryName | |
| BuyerAddressPostalCode | BuyerTradeParty/PostalTradeAddress/PostcodeCode |
| Street | BuyerTradeParty/PostalTradeAddress/LineOne |
| StreetSupplement | BuyerTradeParty/PostalTradeAddress/LineTwo |
| POBox | |
| City | BuyerTradeParty/PostalTradeAddress/CityName |
| TelephoneNumber | BuyerTradeParty/DefinedTradeContact/TelephoneUniversalCommunication/CompleteNumber |
| FaxNumber | BuyerTradeParty/DefinedTradeContact/FaxUniversalCommunication/CompleteNumber |
| BuyerTradeParty/DefinedTradeContact/EmailURIUniversalCommunication/URIID | |
| BuyerTaxNumber1 | |
| BuyerTaxNumber2 | |
| Supplier fields | |
| Name | SellerTradeParty/Name |
| Identifier | SellerTradeParty/GlobalID |
| Description | |
| POBox | |
| Street | SellerTradeParty/PostalTradeAddress/LineOne |
| StreetSupplement | SellerTradeParty/PostalTradeAddress/LineTwo |
| PostalCode | SellerTradeParty/PostalTradeAddress/PostcodeCode |
| City | SellerTradeParty/PostalTradeAddress/CityName |
| CountryCode | SellerTradeParty/PostalTradeAddress/CountryID |
| CountryName | |
| TelephoneNumber | SellerTradeParty/DefinedTradeContact/TelephoneUniversalCommunication/CompleteNumber |
| FaxNumber | SellerTradeParty/DefinedTradeContact/FaxUniversalCommunication/CompleteNumber |
| SupplierVATRegistrationNumber | SellerTradeParty/SpecifiedTaxRegistration/ID where attribute schemeID="VA" |
| SupplierTaxNo1 | SellerTradeParty/SpecifiedTaxRegistration/ID where the attribute schemeID="FC" |
| SupplierTaxNo2 | |
| CorporateGroupNumber | |
| SellerTradeParty/DefinedTradeContact/EmailURIUniversalCommunication/URIID | |
| Standard fields | |
| AddressName | |
| AddressOptionalName | |
| AddressPostalCode | |
| AddressStreet | |
| Barcode | |
| BAT_SupplierAccountNumber | |
| BAT_SupplierAccountNumberType | |
| BAT_SupplierBankClearingNumber | |
| BAT_SupplierBankCodeNumber | |
| BAT_SupplierIBAN | |
| BuyerAddressPostalCode | |
| BuyerContactPersonName | BuyerTradeParty/DefinedTradeContact/PersonName |
| BuyerContactReference | |
| BuyerTaxNumber1 | |
| BuyerTaxNumber2 | |
| BuyerVATRegistrationNumber | |
| DeliveryCost | |
| DeliveryCostInsurance | |
| DeliveryCostPackaging | |
| DeliveryCostPostage | |
| DeliveryCostToll | |
| DeliveryDate | SupplyChainTradeTransaction/ApplicableSupplyChainTradeDelivery/ActualDeliverySupplyChainEvent/OccurrenceDateTime/DateTimeString |
| DeliveryNote | |
| DeliveryTerms | SupplyChainTradeTransaction/SupplyChainTradeTransaction/ApplicableTradeDeliveryTerms |
| EsrAmount | |
| EsrNumber | |
| EsrReference | |
| InvoiceBaselineDate | |
| InvoiceCredit | if
SupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/SpecifiedTradeSettlementMonetarySummation/GrandTotalAmount < 0
then Credit else Debit |
| InvoiceCurrency | SupplyChainTradeTransaction/ApplicableHeaderTradeSettlement/InvoiceCurrencyCode |
| InvoiceDate | ExchangedDocument/IssueDateTime/DateTimeString |
| InvoiceDiscountAmount | SupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/SpecifiedTradePaymentTerms/ApplicableTradePaymentDiscountTerms/ActualDiscountAmount |
| InvoiceDiscountPercent | |
| InvoiceDueDate | SupplyChainTradeTransaction/ApplicableHeaderTradeSettlement/SpecifiedTradePaymentTerms/DueDateDateTime/DateTimeString |
| invoiceNumber | ExchangedDocument/ID |
| InvoiceOrderNumber | SupplyChainTradeTransaction/ApplicableHeaderTradeSettlement/BuyerOrderReferencedDocument/ID |
| InvoicePostingDate | |
| InvoiceTaxAmount1 | |
| InvoiceTaxAmount2 | |
| InvoiceTaxAmount3 | |
| InvoiceTaxAmount4 | |
| InvoiceTotalVATAmount | SupplyChainTradeTransaction/ApplicableHeaderTradeSettlement/ApplicableTradeTax/CalculatedAmount |
| InvoiceTotalVatExcludedAmount | SupplyChainTradeTransaction/ApplicableHeaderTradeSettlement/ApplicableTradeTax/BasisAmount |
| InvoiceTotalVatIncludedAmount | SupplyChainTradeTransaction/ApplicableHeaderTradeSettlement/SpecifiedTradeSettlementHeaderMonetarySummation/GrandTotalAmount |
| InvoiceTotalVatIncludedAmountSpelled | |
| InvoiceTotalVatRatePercent | First instance of:
SupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/ApplicableTradeTax/ApplicablePercent |
| InvoicingPeriodEnd | |
| InvoicingPeriodStart | |
| PaymentReferenceNumber | SupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/PaymentReference |
| PaymentTerms | Taken from:
SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/ SpecifiedTradePaymentTerms/Description Since the text is often long, it is added at the top of the first page of the Invoice Notes page(s). |
| PaymentTermsInterest | SupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/SpecifiedTradePaymentTerms/ApplicableTradePaymentPenaltyTerms/CalculationPercent |
| PaymentType | SupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/SpecifiedTradeSettlementPaymentMeans/TypeCode |
| SupplierAccountNumber1 | |
| SupplierAccountNumber2 | |
| SupplierAccountNumber3 | |
| SupplierAccountNumber4 | |
| SupplierAddressPostalCode | |
| SupplierBankClearingNumber | |
| SupplierBankCodeNumber1 | |
| SupplierBankCodeNumber2 | |
| SupplierBankCodeNumber3 | |
| SupplierBankCodeNumber4 | |
| SupplierIBAN1 |
SupplyChainTradeTransaction/ApplicableHeaderTradeSettlement/SpecifiedTradeSettlementPaymentMeans[1]/PayeePartyCreditorFinancialAccount/IBANID |
| SupplierIBAN2 | SupplyChainTradeTransaction/ApplicableHeaderTradeSettlement/SpecifiedTradeSettlementPaymentMeans[2]/PayeePartyCreditorFinancialAccount/IBANID |
| SupplierIBAN3 | SupplyChainTradeTransaction/ApplicableHeaderTradeSettlement/SpecifiedTradeSettlementPaymentMeans[3]/PayeePartyCreditorFinancialAccount/IBANID |
| SupplierIBAN4 | SupplyChainTradeTransaction/ApplicableHeaderTradeSettlement/SpecifiedTradeSettlementPaymentMeans[4]/PayeePartyCreditorFinancialAccount/IBANID |
| SupplierPhoneNumber1 | |
| SupplierSWIFT1 | SupplyChainTradeTransaction/ApplicableHeaderTradeSettlement/SpecifiedTradeSettlementPaymentMeans[1]/PayeeSpecifiedCreditorFinancialInstitution/BICID |
| SupplierSWIFT2 | SupplyChainTradeTransaction/ApplicableHeaderTradeSettlement/SpecifiedTradeSettlementPaymentMeans[2]/PayeeSpecifiedCreditorFinancialInstitution/BICID |
| SupplierSWIFT3 | SupplyChainTradeTransaction/ApplicableHeaderTradeSettlement/SpecifiedTradeSettlementPaymentMeans[3]/PayeeSpecifiedCreditorFinancialInstitution/BICID |
| SupplierSWIFT4 | SupplyChainTradeTransaction/ApplicableHeaderTradeSettlement/SpecifiedTradeSettlementPaymentMeans[4]/PayeeSpecifiedCreditorFinancialInstitution/BICID |
| SupplierTaxNumber1 | SellerTradeParty/SpecifiedTaxRegistration/ID
...where the attribe schemeID=”VA” |
| SupplierTaxNumber2 | |
| VAT_BaseAmount | |
| VAT_Code | |
| VAT_Currency | |
| VAT_RateAmount | |
| VAT_RatePercent | |
| VAT_TotalAmount | |
| Line-item fields | Note that the ParentNode for these is:
IncludedSupplyChainTradeLineItem |
| LIT_ArticleIdentifier | SpecifiedTradeProduct/GlobalID","SpecifiedTradeProduct/SellerAssignedID |
| LIT_ArticleName | SpecifiedTradeProduct/Name |
| LIT_DeliveredQuantity | SpecifiedLineTradeDelivery/BilledQuantity |
| LIT_DeliveredQuantityUnitCode | SpecifiedLineTradeDelivery/BilledQuantity/@unitCode |
| LIT_DiscountAmount | |
| LIT_DiscountPercent | |
| LIT_OrderNumber | SpecifiedLineTradeSettlement/BuyerOrderReferencedDocument/ID |
| LIT_RowIdentifier | AssociatedDocumentLineDocument/LineID |
| LIT_UnitPriceAmount | SpecifiedLineTradeAgreement/NetPriceProductTradePrice/ChargeAmount |
| LIT_VatAmount | |
| LIT_VatExcludedAmount | SpecifiedLineTradeSettlement/SpecifiedTradeSettlementLineMonetarySummation/LineTotalAmount |
| LIT_VatIncludedAmount | |
| LIT_VatRate | SpecifiedLineTradeSettlement/ApplicableTradeTax/RateApplicablePercent |
| Attachment fields | |
| ID | Not mapped |
| FileName | Not mapped |
| EmbeddedValue | Not mapped |
| EmbeddedInfo | Not mapped |
| DataURI | Not mapped |
| SchemeURI | Not mapped |
| DataType | Not mapped |
| LinkType | Not mapped |
| AdditionalInfo | Not mapped |
| Invoice note field | |
| InvoiceNote | Since the text is often very long, it is put on the note page of the invoice.
Payment Terms are listed first. The value is taken from: SupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/SpecifiedTradePaymentTerms/Description All notes on fields are listed after payment terms, and they are extracted from one or several nodes with this path: HeaderExchangedDocument/IncludeNote/Content |
ZUGFeRD 1.0
| Kofax AP Essentials internal field name | ZUGFeRD 1.0 |
|---|---|
| Buyer fields | |
| Name | BuyerTradeParty/Name |
| Identifier | BuyerTradeParty/GlobalID |
| BuyerVATRegistrationNumber | BuyerTradeParty/SpecifiedTaxRegistration/ID where the attribute schemeID=”VA” |
| CorporateGroupNumber | |
| Description | |
| CountryCode | BuyerTradeParty/PostalTradeAddress/CountryID |
| CountryName | |
| PostalCode | BuyerTradeParty/PostalTradeAddress/PostcodeCode |
| Street | BuyerTradeParty/PostalTradeAddress/LineOne |
| StreetSupplement | BuyerTradeParty/PostalTradeAddress/LineTwo |
| POBox | |
| City | BuyerTradeParty/PostalTradeAddress/CityName |
| TelephoneNumber | BuyerTradeParty/DefinedTradeContact/TelephoneUniversalCommunication/CompleteNumber |
| FaxNumber | BuyerTradeParty/DefinedTradeContact/FaxUniversalCommunication/CompleteNumber |
| BuyerTradeParty/DefinedTradeContact/EmailURIUniversalCommunication/URIID | |
| BuyerTaxNumber1 | |
| BuyerTaxNumber2 | |
| Supplier fields | |
| Name | SellerTradeParty/Name |
| Identifier | SellerTradeParty/GlobalID |
| Description | |
| POBox | |
| Street | SellerTradeParty/PostalTradeAddress/LineOne |
| StreetSupplement | SellerTradeParty/PostalTradeAddress/LineTwo |
| PostalCode | SellerTradeParty/PostalTradeAddress/PostcodeCode |
| City | SellerTradeParty/PostalTradeAddress/CityName |
| CountryCode | SellerTradeParty/PostalTradeAddress/CountryID |
| CountryName | |
| TelephoneNumber | SellerTradeParty/DefinedTradeContact/TelephoneUniversalCommunication/CompleteNumber |
| FaxNumber | SellerTradeParty/DefinedTradeContact/FaxUniversalCommunication/ CompleteNumber |
| SupplierVATRegistrationNumber | SellerTradeParty/SpecifiedTaxRegistration/ID where attribute schemeID="VA" |
| SupplierTaxNo1 | SellerTradeParty/SpecifiedTaxRegistration/ID where the attribute schemeID="FC" |
| SupplierTaxNo2 | |
| CorporateGroupNumber | |
| SellerTradeParty /DefinedTradeContact/EmailURIUniversalCommunication/URIID | |
| Standard fields | |
| AddressName | |
| AddressOptionalName | |
| AddressPostalCode | |
| AddressStreet | |
| Barcode | |
| BAT_SupplierAccountNumber | |
| BAT_SupplierAccountNumberType | |
| BAT_SupplierBankClearingNumber | |
| BAT_SupplierBankCodeNumber | |
| BAT_SupplierIBAN | |
| BuyerAddressPostalCode | |
| BuyerContactPersonName | BuyerTradeParty/DefinedTradeContact/PersonName |
| BuyerContactReference | |
| BuyerTaxNumber1 | |
| BuyerTaxNumber2 | |
| BuyerVATRegistrationNumber | |
| DeliveryCost | |
| DeliveryCostInsurance | |
| DeliveryCostPackaging | |
| DeliveryCostPostage | |
| DeliveryCostToll | |
| DeliveryDate | SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeDelivery/ActualDeliverySupplyChainEvent/OccurrenceDateTime/DateTimeString |
| DeliveryNote | |
| DeliveryTerms | SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeAgreement/ApplicableTradeDeliveryTerms |
| EsrAmount | |
| EsrNumber | |
| EsrReference | |
| InvoiceBaselineDate | |
| InvoiceCredit | If SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/
SpecifiedTradeSettlementMonetarySummation/ GrandTotalAmount < 0
then Credit else Debit |
| InvoiceCurrency | SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/ SpecifiedTradeSettlementMonetarySummation/ GrandTotalAmount/@currencyID |
| InvoiceDate | HeaderExchangedDocument/IssueDateTime/DateTimeString |
| InvoiceDiscountAmount | SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/ SpecifiedTradePaymentTerms/ApplicableTradePaymentDiscountTerms/ActualDiscountAmount |
| InvoiceDiscountPercent | |
| InvoiceDueDate | SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/ SpecifiedTradePaymentTerms/DueDateDateTime/DateTimeString |
| invoiceNumber | HeaderExchangedDocument/ID |
| InvoiceOrderNumber | SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeAgreement/ BuyerOrderReferencedDocument/ID |
| InvoicePostingDate | |
| InvoiceTaxAmount1 | |
| InvoiceTaxAmount2 | |
| InvoiceTaxAmount3 | |
| InvoiceTaxAmount4 | |
| InvoiceTotalVATAmount | SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/SpecifiedTradeSettlementMonetarySummation/TaxTotalAmount |
| InvoiceTotalVatExcludedAmount | SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/SpecifiedTradeSettlementMonetarySummation/TaxBasisTotalAmount |
| InvoiceTotalVatIncludedAmount | SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/SpecifiedTradeSettlementMonetarySummation/GrandTotalAmount |
| InvoiceTotalVatIncludedAmountSpelled | |
| InvoiceTotalVatRatePercent | First instance of:
SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement /ApplicableTradeTax/ApplicablePercent |
| InvoicingPeriodEnd | |
| InvoicingPeriodStart | |
| PaymentReferenceNumber | SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/PamentReference |
| PaymentTerms | Taken from:
SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/ SpecifiedTradePaymentTerms/Description Since the text is often long, it is added at the top of the first page of the Invoice Notes page(s). |
| PaymentTermsInterest | SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/ SpecifiedTradePaymentTerms/ApplicableTradePaymentPenaltyTerms/ CalculationPercent |
| PaymentType | SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/ SpecifiedTradeSettlementPaymentMeans/TypeCode |
| SupplierAccountNumber1 | |
| SupplierAccountNumber2 | |
| SupplierAccountNumber3 | |
| SupplierAccountNumber4 | |
| SupplierAddressPostalCode | |
| SupplierBankClearingNumber | |
| SupplierBankCodeNumber1 | |
| SupplierBankCodeNumber2 | |
| SupplierBankCodeNumber3 | |
| SupplierBankCodeNumber4 | |
| SupplierIBAN1 | CrossIndustryDocument/SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/SpecifiedTradeSettlementPaymentMeans[1]/PayeePartyCreditorFinancialAccount/IBANID |
| SupplierIBAN2 | CrossIndustryDocument/SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/SpecifiedTradeSettlementPaymentMeans[2]/PayeePartyCreditorFinancialAccount/IBANID |
| SupplierIBAN3 | CrossIndustryDocument/SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/SpecifiedTradeSettlementPaymentMeans[3]/PayeePartyCreditorFinancialAccount/IBANID |
| SupplierIBAN4 | CrossIndustryDocument/SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/SpecifiedTradeSettlementPaymentMeans[4]/PayeePartyCreditorFinancialAccount/IBANID |
| SupplierPhoneNumber1 | |
| SupplierSWIFT1 | CrossIndustryDocument/SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/SpecifiedTradeSettlementPaymentMeans[1]/PayeeSpecifiedCreditorFinancialInstitution/BICID |
| SupplierSWIFT2 | CrossIndustryDocument/SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/SpecifiedTradeSettlementPaymentMeans[2]/PayeeSpecifiedCreditorFinancialInstitution/BICID |
| SupplierSWIFT3 | CrossIndustryDocument/SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/SpecifiedTradeSettlementPaymentMeans[3]/PayeeSpecifiedCreditorFinancialInstitution/BICID |
| SupplierSWIFT4 | CrossIndustryDocument/SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/SpecifiedTradeSettlementPaymentMeans[4]/PayeeSpecifiedCreditorFinancialInstitution/BICID |
| SupplierTaxNumber1 | SellerTradeParty/SpecifiedTaxRegistration/ID where the attribe schemeID=”VA” |
| SupplierTaxNumber2 | |
| VAT_BaseAmount | |
| VAT_Code | |
| VAT_Currency | |
| VAT_RateAmount | |
| VAT_RatePercent | |
| VAT_TotalAmount | |
| Line-item fields | Note that the ParentNode for these is:
IncludedSupplyChainTradeLineItem |
| LIT_ArticleIdentifier | /SpecifiedTradeProduct/SellerAssignedID |
| LIT_ArticleName | /SpecifiedTradeProduct/Name |
| LIT_DeliveredQuantity | /SpecifiedSupplyChainTradeDelivery/BilledQuantity |
| LIT_DeliveredQuantityUnitCode | /SpecifiedSupplyChainTradeDelivery/BilledQuantity/@UnitC |
| LIT_DiscountAmount | |
| LIT_DiscountPercent | |
| LIT_OrderNumber | /SpecifiedSupplyChainTradeAgreement/BuyerOrderReferencedDocument/ID |
| LIT_RowIdentifier | /AssociatedDocumentLineDocument/LineID |
| LIT_UnitPriceAmount | /SpecifiedSupplyChainTradeAgreement/NetPriceProductTradePrice/ChargeAmount |
| LIT_VatAmount | |
| LIT_VatExcludedAmount | /SpecifiedSupplyChainTradeAgreement/NetPriceProductTradePrice/ChargeAmount |
| LIT_VatIncludedAmount | |
| LIT_VatRate | /SpecifiedSupplyChainTradeSettlement/ApplicableTradeTax/ApplicablePercent |
| Attachment fields | |
| ID | Not mapped |
| FileName | Not mapped |
| EmbeddedValue | Not mapped |
| EmbeddedInfo | Not mapped |
| DataURI | Not mapped |
| SchemeURI | Not mapped |
| DataType | Not mapped |
| LinkType | Not mapped |
| AdditionalInfo | Not mapped |
| Invoice note field | |
| InvoiceNote | Since the text is often very long, it is put on the note page of the invoice.
Payment Terms are listed first. The value is taken from: SpecifiedSupplyChainTradeTransaction/ApplicableSupplyChainTradeSettlement/ SpecifiedTradePaymentTerms/Description All notes on fields are listed after payment terms, and they are extracted from one or several nodes with this path: HeaderExchangedDocument/IncludeNote/Content |
Field mappings from incoming XML formats only map to standard fields. They do not map to custom fields. Consider using the XML document type if your current document type does not support the field mappings you require.