XML invoice standard - Kofax ReadSoft Entrance Portal (ESXML)

ESXML is an XML invoice standard that is used internally between the Kofax Invoice Portal and Collector.

COLLECTOR's XML functionality does not retrieve all ESXML elements that are included in received XML documents. It retrieves only those elements that have corresponding field types in Kofax ReadSoft Entrance.

The table below lists all standard Entrance field type names and provides information on the elements in the ESXML document they are extracted from:

Kofax ReadSoft Entrance field Location of element mapped in the XML code
Buyer fields  
CorporategroupNumber /invoiceFile/invoice/buyerParty/buyerAddress/internalReference
Description  
Identifier  
POBox  
StreetSupplement  
Name /invoiceFile/invoice/buyerParty/buyerAddress/addressName
Street /invoiceFile/invoice/buyerParty/buyerAddress/streetAddress
City /invoiceFile/invoice/buyerParty/buyerAddress/cityAddress
CountryCode /invoiceFile/invoice/buyerParty/buyerAddress/countryId
TelephoneNumber /invoiceFile/invoice/buyerParty/buyerAddress/contact/phone
FaxNumber /invoiceFile/invoice/buyerParty/buyerAddress/contact/fax
Email /invoiceFile/invoice/buyerParty/buyerAddress/contact/emailAddress
Supplier fields  
Description  
identifier  
POBox  
StreetSupplement  
Name /invoiceFile/invoice/supplierPartysupplierAddress/addressName   or, if it is empty   /invoiceFile/invoice/supplierParty/legalName
Street /invoiceFile/invoice/supplierPartysupplierAddress/streetAddress
City /invoiceFile/invoice/supplierPartysupplierAddress/cityAddress
CountryCode /invoiceFile/invoice/supplierPartysupplierAddress/countryId
CountryName /invoiceFile/invoice/supplierPartysupplierAddress/country
CorporateGroupNumber /invoiceFile/invoice/supplierPartysupplierAddress/internalReference
TelephoneNumber /invoiceFile/invoice/supplierPartysupplierAddress/contact/phone
FaxNumber /invoiceFile/invoice/supplierPartysupplierAddress/contact/fax
Email /invoiceFile/invoice/supplierPartysupplierAddress/contact/emailAddress
Kofax ReadSoft Entrance Standard Field Types Mapped location in ESXML code
AddressName  
AddressOptionalName  
AddressPostalCity  
AddressPostalCode  
AddressStreet  
AmountRounding /invoiceFile/invoice/invoiceTrailer/roundOffAmount (requires Collector 6-4 HF 22 or later)
Barcode  
BAT_SupplierAccountNumber  
BAT_SupplierAccountNumberType  
BAT_SupplierBankClearingNumber  
BAT_SupplierBankCodeNumber  
BAT_SupplierIBAN  
BuyerAddressPostalCode /invoiceFile/invoice/buyerParty/buyerAddress/zipCode
BuyerContactPersonName /invoiceFile/invoice/buyerParty/buyerAddress/contact/contactName
BuyerContactReference /invoiceFile/invoice/customerProfitCentre
BuyerTaxNumber1 /invoiceFile/invoice/buyerParty/organisationNo
BuyerTaxNumber2  
BuyerVATRegistrationNumber /invoiceFile/invoice/buyerParty/vatNo
DeliveryCost /invoiceFile/invoice/invoiceTrailer/totalCharge
DeliverCostInsurance  
DeliveryCostPackaging  
DeliveryCostPostage  
DeliveryCostToll  
DeliveryDate /invoiceFile/invoice/deliveryDate
DeliveryNote /invoiceFile/invoice/referenceNumber
DeliveryTerms /invoiceFile/invoice/deliveryTerms/deliveryTermsText
EsrAmount  
EsrNumber  
EsrReference  
InvoiceBaselineDate  
InvoiceCredit /invoiceFile/invoice/invoiceTypeId

If=CR then 1, else 0

InvoiceCurrency /invoiceFile/invoice/invoiceCurrencyCode
InvoiceDate /invoiceFile/invoice/invoiceDate
InvoiceDiscountAmount /invoicefile/invoice/invoiceTrailer/totalAllowance
InvoiceDiscountPercent  
InvoiceDueDate /invoiceFile/invoice/dueDate
InvoiceNumber /invoiceFile/invoice/invoiceId
InvoiceOrderNumber /invoiceFile/invoice/customersOrder
InvoicePostingDate  
InvoiceTaxAmount1  
InoviceTaxAmount2  
InvoiceTaxAmount3  
InvoiceTaxAmount4  
InvoiceTotalVATAmount /invoiceFile/invoice/invocieTrailer/invoiceVatTotalAmount
InvoiceTotalVatExcludedAmount /invoiceFile/invoice/invoiceTrailer/taxableAmount
InvoiceTotalVatIncludedAmount /invoiceFile/invoice/invoiceTrailer/invoiceTotalAmount
InvoiceTotalVatIncludedAmountSpelled  
InvoiceTotalVatRatePercent /invoiceFile/invoice/invoiceTrailer/invoiceVat/vatPercentage
InvoicingPeriodEnd /invoiceFile/invoice/invoicePeriodFrom
InvoicingPeriodStart /invoiceFile/invoice/invoicePeriodTo
PaymentReferenceNumber /invoiceFile/invoice/paymentMeans/paymentRef
PaymentTerms /invoiceFile/invoice/paymentTerms
PaymentTermsInterest /invoiceFile/invoice/deleayTerms/penaltyInterestRate
Paymenttype  
SupplierAccountNumber1  
SupplierAccountNumber2  
SupplierAccountNumber3  
SupplierAccountNumber4  
SupplierAddressPostalCode /invoiceFile/invoice/supplierParty/supplierAddress/zipCode
SupplierBankClearingNumber  
SupplierBankCodeNumber1  
SupplierBankCodeNumber2  
SupplierBankCodeNumber3  
SupplierBankCodeNumber4  
SupplierIBAN1  
SupplierIBAN2  
SupplierIBAN3  
SupplierIBAN4  
SupplierPhoneNumber1  
SupplierTaxNumber1 /invoiceFile/invoice/supplierParty/organisationNo
SupplierTaxNumber2  
SupplierVATRegistrationNumber /inoviceFile/invoice/supplierParty/financialInfo/vatNo
VAT_BaseAmount  
VAT_Code  
VAT_Currency  
VAT_RateAmount  
Vat_RatePercent  
VAT_TotalAmount  
Line Item Fields Location of element mapped in the XML code
LIT_ArticleIdentifier /invoiceFile/invoice/invoiceLine/supplierArticleId
LIT_ArticleName /invoiceFile/invoice/invoiceLine/articleDescription
LIT_DeliveredQuantity /invoiceFile/invoice/invoiceLine/invoiceQuantity/quantity
LIT_DeliveredQuantityUnitCode /invoiceFile/invoice/invoiceLine/invoiceQuantity/edifactUnit
LIT_DiscountAmount /invoiceFile/invoice/invoiceLine/discountAmount
LIT_DiscountPercont /invoiceFile/invoice/invoiceLine/discountPercent
LIT_OrderNumber /invoiceFile/invoice/invoiceLine/orderReference/referenceNumber
LIT_RowIdentifier /invoiceFile/invoice/invoiceLine/invoiceLineId
LIT_UnitPriceAmount /invoiceFile/invoice/invoiceLine/price/contractPrice
LIT_VatAmount /invoiceFile/invoice/invoiceLine/vatInfo/taxAmount
LIT_VatExcludedAmount /invoiceFile/invoice/invoiceLine/invoiceLineAmount
LITVatIncludedAmount  
LIT_VatRate /invoiceFile/invoice/invoiceLine/vatInfo/taxPercentage
Attachment fields Location of element mapped in the XML code
ID /invoiceFile/invoice/attachments/attachment/objectId
FileName /invoiceFile/invoice/attachments/attachment/encodedData/filename
EmbeddedValue /ivoiceFile/invoice/attachments/attachment/encodedData
Embeddedinfo  
DataURI  
SchemeuRI  
DataType /invoiceFile/invoice/attachments/attachment/encodedData/format
LinkType  
AdditionalInfo /invoiceFile/invoice/attachments/attachment/encodedData/mimeCode
Invoice note field Mapped location in ESXML code
InvoiceNote /invoiceFile/invoice/invoiceFreeText