  

 

Tracelink University

 ## Breadcrumb

1. [Home](/)
2. [Resources](/resources/resource-center)
3. [TraceLink University](/resources/tracelink-university)
 
  

 

 

# Invoice canonical guidelines

 

 

 

 

 

 

 

 

- [Download PDF](/node/628121/pdf)
- [Share](#)
    - [ LinkedIn ](https://www.linkedin.com/shareArticle?mini=true&url=https://www.tracelink.com/resources/tracelink-university/invoice-canonical-guidelines&title=Invoice canonical guidelines&summary=Invoices allow companies to exchange billing amounts and payment terms with upstream and downstream supply chain trade partners for finished goods and services without giving these trade partners access to their serialization system of record.&source=TraceLink "LinkedIn")
    - [ Facebook ](https://www.facebook.com/share.php?u=https://www.tracelink.com/resources/tracelink-university/invoice-canonical-guidelines&t=Invoice canonical guidelines "Facebook")
    - [ Mail ](mailto:?subject=Invoice canonical guidelines+|+TraceLink&body=https://www.tracelink.com/resources/tracelink-university/invoice-canonical-guidelines "Mail")
    - [ Twitter ](https://twitter.com/intent/tweet?text=Invoice canonical guidelines https://www.tracelink.com/resources/tracelink-university/invoice-canonical-guidelines&via=TraceLink "Twitter")
 
 

 

 

 

 

#### Table of contents

 

 

 

Invoices allow companies to exchange billing amounts and payment terms with upstream and downstream supply chain trade partners for finished goods and services without giving these trade partners access to their serialization system of record.

[![Closed](/sites/default/files/tech_comms/mpl/Skins/Default/Stylesheets/Images/transparent.gif)Canonical guidelines](#)               Canonical Element Type Definition Description IDoc mapping  X12 mapping EDIFACT mapping     data – Object type/root element. – – –     controlFileHeader – Canonical control file header to store data for control segments of IDocs and TL XML transactions, and EDI envelopes for X12 and EDIFACT. – – –     messageBody – Payload for Invoice canonical. – – –       canonicalInvoiceHeader – Invoice header information. IDOC/EDEK01 – –         processingFunctionTypeCode string Invoice processing function code.

Valid values include:

- `ORIGINAL`
- `CREATE`
- `CHANGE`
- `CONFIRM`
- `CANCEL`
 
  – – –         invoiceTermsOfPaymentKey string Terms of payment key. E1EDK01/ZTERM – –         vatRegistrationNumber string VAT registration identifier. E1EDK01/KUNDEUINR – –         alternateVATRegistrationNumber string Alternate registration identifier for VAT. E1EDK01/EIGENUINR – –         invoiceDocumentType string Invoice document type. E1EDK01/BSART – –         invoiceListType string Invoice list type (for billing). E1EDK01/FKART\_RL – –         billingCategory string Billing category. E1EDK01/FKTYP – –         additionalPONumber string Additional purchase order identifier. E1EDK01/BSTZD – –         shippingConditions string Shipping conditions. E1EDK01/VSART – –         shippingConditionsDescription string Description of shipping conditions. E1EDK01/VSART\_BEZ – –         recipientIdentifier string Invoice recipient identifier. E1EDK01/RECIPNT\_NO – –         isDropShipment boolean Drop ship invoice flag.

Valid values:

- `True` - Drop ship invoice
- `False` - Not drop ship invoice (default)
 
  – – –         invoiceType string Invoice type.

Valid value is `DROPSHIP` - DEBIT.

 Note: Temporary. Creating full enumeration list for 2025.3.0. Will only use drop ship and debit for EP July release.

  – BIG07 =

- DO (DROPSHIP)
- DI (DEBIT)
 
See CL\_InvoiceType tab for all conversions Note: For EP release 2025.2.1.

            localCurrency string Local currency code. HWAER – –         transactionReferenceIdentifiers array Transaction references for deliveries at header level. – – –           b2bTransactionIdentifierType string Referenced document type.

Valid values include:

- `INVOICE` (required)
- `PURCHASEORDER` (required)
- `DELIVERY`
- `SUPPLIERORDER`
- `ASSIGNMENT`
- `SHIPMENT`
- `PRECEDINGDOCUMENT`
- `TRACKINGNUMBER`
- `BILLINGREFERENCE`
- `RELEASE`
 
  E1EDK02/QUALF =

- 009 (INVOICE) or
- 001 (PURCHAEORDER) or
- 002 (SUPPLYORDER) or
- 012 (DELIVERY)
- 017 (ASSIGNMENT)
- 016 (PRECEDINGDOCUMENT)
- 087 (BILLINGREFERENCE)
 
  – RFF01-010 =

- CT (CONTRACT) Or
- BC (CUSTOMERCONTRACT) Or
- DM (DOCUMENT) Or
- DQ (DELIVERY) Or
- IV (INVOICE) Or
- ON (PURCHASEORDER) Or
- RE (RELEASE) Or
- VC (SUPPLIERCONTRACT) Or
- VN (SUPPLIERORDER)
 
            b2bTransactionIdentifierValue string Reference order identifier value for invoice identified by transactionReferenceIdentifierType. E1EDK01/BELNR and E1EDK02/BELNR when b2bTransactionIdentifierType = INVOICE

 E1EDK02/BELNR when b2bTransactionIdentifierType =

- INVOICE or
- PURCHASEORDER or
- SUPPLIERORDER or
- DELIVERY or
- ASSIGNMENT or
- PRECEDINGDOCUMENT or
- BILLINGREFERENCE
 
  - BIG02 when b2bTransactionIdentifierType = INVOICE (required)
- BIG04 when b2bTransactionIdentifierType = PURCHASEORDER
- BIG05 when b2bTransactionIdentifierType = RELEASE
 
  BGM02-010 when

- b2bTransactionIdentifierType = INVOICE (required) RFF01-020 when
- b2bTransactionIdentifierType other then INVOICE
 
            lineItemNumber string Line item number in transaction reference. Line item level only. – – –           transactionDate string Date transaction created. E1EDK02/DATUM and UZEIT BIG01 when b2bTransactionIdentifierType = INVOICE

BIG03 when b2bTransactionIdentifierType = PURCHASEORDER

  DTM01-020 with DTM01-010 as 137 and DTM01-030 as 102 when b2bTransactionIdentifierType = INVOICE           epochTransactionDate integer Date transaction created in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. – – –         transactionReferenceInformation array Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents. – REF segment –           transactionReferenceType string Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. HDA mapping.

Valid value is `ACCOUNTSRECEIVABLE` - Accounts Receivable.

  – REF01 = AP (ACCOUNTSRECEIVABLE) Use Java call-out to enum lookup table CL\_TransactionReferenceType –           transactionReferenceIdentifier string Transaction reference identifier value as defined by enumeration in transactionReferenceType. Pass thru X12 mapping. – REF02 –           description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). – REF03 –           transactionReferenceDate string Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. – – –           epochTransactionReferenceDate integer Transaction reference date and time in EPOCH date time format. – – –         invoiceDates array Invoice dates at header level. – – –           dateType string referenced date type.

Valid values include:

- `SHIPPED`
- `DELIVERY `
- `BILLING`
- `DUEDAT`E
- `DOCUMENT`
- `INVOICE`
- `PRICING`
- `MESSAGE`
- `PURCHASEORDER`
- `FIXEDVALUE`
- `SUPPLIERORDER`
- `CREATEDON`
- `SERVICESRENDERED `
- `CANCELBY`
- `DELIVERYREQUESTED`
- `ESTIMATEDDELIVERY`
- `EXPIRATION`
- `PO_RECEIVED`
- `SHIPMENTREQUESTED `
- `SHIPPED`
- `EXCHANGERATE`
 
  E1EDK03/IDDAT =

- 001 (DELIVERY) or
- 011 (MESSAGE) or
- 012 (DOCUMENT) or
- 022 (PURCHASEORDER) or
- 023 (PRICING) or
- 024 (FIXEDVALUE) or
- 026 (BILLING) or
- 028 (DUEDATE) or
- 029 (SUPPLIERORDER) or
- 025 (CREATEDON) or
- 027 (SERVICESRENDERED) or
- 048 (EXCHANGERATE)
 
  DTM01 =

- CANCELBY (177) or
- DELIVERYREQUESTED (002) or
- ESTIMATEDDELIVERY (017) or
- EXPIRATION (036) or
- INVOICE (003) or
- PO\_RECEIVED (008) or
- DOCMENT (102) or
- PURCHASEORDER (004) or
- SHIPMENTREQUESTED (010) or
- SHIPPED (011)
 
  DTM01-010 =

- 46 (CANCELBY) Or
- 2 (DELIVERYREQUESTED) Or
- 69 (ESTIMATEDDELIVERY) Or
- 36 (EXPIRATION) Or
- 149 (INVOICE) Or
- 4 (PURCHASEORDER) Or
- 318 (SHIPMENTREQUESTED) Or
- 10 (SHIPPED)
- 137 (DOCUMENT)
 
Populate this 137 intance only if it has not populated from transactionDate.

            dateValue string Date defined by referenced date type. E1EDK03/DATUM DTM02 DTM01-020           epochDateValue integer Date defined by referenced date type generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. – – –           timeZone string Time zone for referenced dates. – – –         invoiceCurrency array Currency codes for invoice. – – CUX           currencyCode string Currency code for pricing in price catalog. E1EDK01/CURCY CUR02 CUX01.2 when CUX01.1 = 2           exchangeRateCurrencyCode string Currency code for currency exchange. – – –           exchangeRate number Exchange rate for conversion from currencyCode to currencyCodeExchange. E1EDK01/WKURS – CUX03           validityDate string Validity date for exchange rate. – – –           epochValidityDate integer Validity date for exchange rate generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. – – –           currenctyEntityCode string Currency entity code. – CUR01 –         remitToBusinessInformation   Remit to partner business information. E1EDKA1 where PARVW = "RS" N101 = "RI" NAD01 = "RE"           businessName string Business name for partner or location. E1EDKA1/NAME1 N102 NAD040-010           additionalBusinessName string Additional business name or overflow of business name. NAME2 – –           mpcCompanyLocationIdentifierList array Identifier list for business party. – – –             isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –             companyIdentifierType string Company identifier type for business partner.

Valid values:

- `DUNS`
- `DUNS4`
- `DEA`
- `HIN`
- `COMPANYID`
- `COMPANYSITEID`
- `GLN`
 
  – N103 X12 codes for N103:

- `DUNS` - 1
- `DUNS4` - 9
- `DEA` - 11
- `HIN` - 21
- `COMPANYID` - 91
- `COMPANYSITEID` - 92
- `US_340B_ID` - PI PHARMACY\_PROCESSOR\_
- `NUMBER` - PP
- `GLN` - UL
 
  NAD020-030 EDIFACT supported codes:

- `DUNS` - 16
- `DEA` - 164
- `HIN` - 21
- `COMPANYID` - 91
- `COMPANYSITEID` - 92
 
              companyIdentifierValue string Company identifier value for business partner. PARTN where companyIdentifierType = COMPANYID N104 NAD020-010             alternateCompanyLocationIdentifierValue string Alternate company location identifier value. LIFNR – –           address   Party address information. – – –             address1 string Main street address. STRAS N301 NAD050-010             address2 string Supplemental street address. STRS2 N302 NAD050-020             city string City ORT01 N401 NAD060             district string District – – –             state string State or region code REGIO N402 NAD070-010             postalCode string Postal code PSTLZ N403 NAD080             country string Country code LAND1 N404 NAD090             telephone string Telephone number TELF1 – –             fax string Fax number TELFX – –             url string Website URL – – –             buildingNumber string Building number – – –             plantNumber string Plant number – – –             floorNumber string Floor number in building – – –             lscAddressIdentifier string LSC address identifier – – –             village string Village name – – –             houseNumber string House number – – –             township string Township – – –             premisesCode string Premises code – – –           companyLocationContactInformation   Company contact information – Hard code PER01 to "AJ" primary contact Hard code CTA010 to "RP" responsible person             contactName string Contact name – PER02 CTA020-020             contactTitle string Contact title – – –             contactEmail string Contact email address – PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"             contactPhone string Contact phone number – PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM"           mpcAdditionalAddressInformation   Additional address information that is not included in addressTypeDefinition. – – –             externalERPUserName string External ERP system user name for user who generated message. BNAME – –             organizationCode string Code for organization responsible for generating the message. PAORG – –             organizationDescription string Description of the organization responsible for generating the message. – – –             groupCode string Code identifying group responsible for generating the message. – – –             language string Language key for message. SPRAS – –             languageCode string ISO language code for message. SPRAS\_ISO – –             referenceIdentifier string Partner reference identifier. IHREZ – –         customerBusinessInformation   Customer or buyer party business information. E1EDKA1 where PARVW = "AG" N101 = "BY" NAD01 = "BY"           businessName string Business name for partner or location. E1EDKA1/NAME1 N102 NAD040-010           additionalBusinessName string Additional business name or overflow of business name. NAME2 – –           mpcCompanyLocationIdentifierList array Identifier list for business party. – – –             isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –             companyIdentifierType string Company identifier type for business partner.

Valid values:

- `DUNS`
- `DUNS4`
- `DEA`
- `HIN`
- `COMPANYID`
- `COMPANYSITEID`
- `GLN`
 
  – N103 X12 codes for N103:

- `DUNS` - 1
- `DUNS4` - 9
- `DEA` - 11
- `HIN` - 21
- `COMPANYID` - 91
- `COMPANYSITEID` - 92
- `US_340B_ID` - PI PHARMACY\_PROCESSOR\_
- `NUMBER` - PP
- `GLN` - UL
 
  NAD020-030 EDIFACT supported codes:

- `DUNS` - 16
- `DEA` - 164
- `HIN` - 21
- `COMPANYID` - 91
- `COMPANYSITEID` - 92
 
              companyIdentifierValue string Company identifier value for business partner. PARTN where companyIdentifierType = COMPANYID N104 NAD020-010             alternateCompanyLocationIdentifierValue string Alternate company location identifier value. LIFNR – –           address   Party address information. – – –             address1 string Main street address. STRAS N301 NAD050-010             address2 string Supplemental street address. STRS2 N302 NAD050-020             city string City ORT01 N401 NAD060             district string District – – –             state string State or region code REGIO N402 NAD070-010             postalCode string Postal code PSTLZ N403 NAD080             country string Country code LAND1 N404 NAD090             telephone string Telephone number TELF1 – –             fax string Fax number TELFX – –             url string Website URL – – –             buildingNumber string Building number – – –             plantNumber string Plant number – – –             floorNumber string Floor number in building – – –             lscAddressIdentifier string LSC address identifier – – –             village string Village name – – –             houseNumber string House number – – –             township string Township – – –             premisesCode string Premises code – – –           companyLocationContactInformation – Company contact information. – Hard code PER01 to "AJ" primary contact Hard code CTA010 to "RP" responsible person             contactName string Contact name – PER02 CTA020-020             contactTitle string Contact title – – –             contactEmail string Contact email address – PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"             contactPhone string Contact phone number – PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM"           mpcAdditionalAddressInformation – Additional address information that is not included in addressTypeDefinition. – – –             externalERPUserName string External ERP system user name for user who generated message. BNAME – –             organizationCode string Code for organization responsible for generating the message. PAORG – –             organizationDescription string Description of the organization responsible for generating the message. – – –             groupCode string Code identifying group responsible for generating the message. – – –             language string Language key for message. SPRAS – –             languageCode string ISO language code for message. SPRAS\_ISO – –             referenceIdentifier string Partner reference identifier. IHREZ – –         billToBusinessInformation – Bill to party business information. E1EDKA1 where PARVW = "RE" N101 = "BT" NAD01 = "BT"           businessName string Business name for partner or location. E1EDKA1/NAME1 N102 NAD040-010           additionalBusinessName string Additional business name or overflow of business name. NAME2 – –           mpcCompanyLocationIdentifierList array Identifier list for business party. – – –             isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –             companyIdentifierType string Company identifier type for business partner.

Valid values:

- `DUNS`
- `DUNS4`
- `DEA`
- `HIN`
- `COMPANYID`
- `COMPANYSITEID`
- `GLN`
 
    N103 X12 codes for N103:

- `DUNS` - 1
- `DUNS4` - 9
- `DEA` - 11
- `HIN` - 21
- `COMPANYID` - 91
- `COMPANYSITEID` - 92
- `US_340B_ID` - PI PHARMACY\_PROCESSOR\_
- `NUMBER` - PP
- `GLN` - UL
 
  NAD020-030 EDIFACT supported codes:

- `DUNS` - 16
- `DEA` - 164
- `HIN` - 21
- `COMPANYID` - 91
- `COMPANYSITEID` - 92
 
              companyIdentifierValue string Company identifier value for business partner. PARTN where companyIdentifierType = COMPANYID N104 NAD020-010             alternateCompanyLocationIdentifierValue string Alternate company location identifier value. LIFNR – –           address – Party address information. – – –             address1 string Main street address. STRAS N301 NAD050-010             address2 string Supplemental street address. STRS2 N302 NAD050-020             city string City ORT01 N401 NAD060             district string District                   state string State or region code REGIO N402 NAD070-010             postalCode string Postal code PSTLZ N403 NAD080             country string Country code LAND1 N404 NAD090             telephone string Telephone number TELF1 – –             fax string Fax number TELFX – –             url string Website URL – – –             buildingNumber string Building number – – –             plantNumber string Plant number – – –             floorNumber string Floor number in building – – –             lscAddressIdentifier string LSC address identifier – – –             village string Village name – – –             houseNumber string House number – – –             township string Township – – –             premisesCode string Premises code – – –           companyLocationContactInformation – Company contact information – Hard code PER01 to "AJ" primary contact Hard code CTA010 to "RP" responsible person             contactName string Contact name – PER02 CTA020-020             contactTitle string Contact title – – –             contactEmail string Contact email address – PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"             contactPhone string Contact phone number – PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM"           mpcAdditionalAddressInformation – Additional address information that is not included in addressTypeDefinition. – – –             externalERPUserName string External ERP system user name for user who generated message. BNAME – –             organizationCode string Code for organization responsible for generating the message. PAORG – –             organizationDescription string Description of the organization responsible for generating the message. – – –             groupCode string Code identifying group responsible for generating the message. – – –             language string Language key for message. SPRAS – –             languageCode string ISO language code for message. SPRAS\_ISO – –             referenceIdentifier string Partner reference identifier. IHREZ – –         billToShipToBusinessInformation – Bill to party business information. – N101 = "BS" NAD01 = "BS"           businessName string Business name for partner or location. – N102 NAD040-010           additionalBusinessName string Additional business name or overflow of business name. – – –           mpcCompanyLocationIdentifierList array Identifier list for business party. – – –             isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –             companyIdentifierType string Company identifier type for business partner.

Valid values:

- `DUNS`
- `DUNS4`
- `DEA`
- `HIN`
- `COMPANYID`
- `COMPANYSITEID`
- `GLN`
 
  – N103 X12 codes for N103:

- `DUNS` - 1
- `DUNS4` - 9
- `DEA` - 11
- `HIN` - 21
- `COMPANYID` - 91
- `COMPANYSITEID` - 92
- `US_340B_ID` - PI PHARMACY\_PROCESSOR\_
- `NUMBER` - PP
- `GLN` - UL
 
  NAD020-030 EDIFACT supported codes:

- `DUNS` - 16
- `DEA` - 164
- `HIN` - 21
- `COMPANYID` - 91
- `COMPANYSITEID` - 92
 
              companyIdentifierValue string Company identifier value for business partner. – N104 NAD020-010             alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –           address – Party address information. – – –             address1 string Main street address. – N301 NAD050-010             address2 string Supplemental street address. – N302 NAD050-020             city string City – N401 NAD060             district string District – – –             state string State or region code – N402 NAD070-010             postalCode string Postal code – N403 NAD080             country string Country code – N404 NAD090             telephone string Telephone number – – –             fax string Fax number – – –             url string Website URL – – –             buildingNumber string Building number – – –             plantNumber string Plant number – – –             floorNumber string Floor number in building – – –             lscAddressIdentifier string LSC address identifier – – –             village string Village name – – –             houseNumber string House number – – –             township string Township – – –             premisesCode string Premises code – – –           companyLocationContactInformation – Company contact information. – Hard code PER01 to "AJ" primary contact Hard code CTA010 to "RP" responsible person             contactName string Contact name – PER02 CTA020-020             contactTitle string Contact title – – –             contactEmail string Contact email address. – PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"             contactPhone string Contact phone number. – PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM"         invoicePayerBusinessInformation – Payor party. The customer or party remitting the payment to the supplier. E1EDKA1 where PARVW = "RG" N101 = "PR" NAD01 = "PR"           businessName string Business name for partner or location. E1EDKA1/NAME1 N102 NAD040-010           additionalBusinessName string Additional business name or overflow of business name. NAME2 – –           mpcCompanyLocationIdentifierList array Identifier list for business party. – – –             isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –             companyIdentifierType string Company identifier type for business partner.

Valid values:

- `DUNS`
- `DUNS4`
- `DEA`
- `HIN`
- `COMPANYID`
- `COMPANYSITEID`
- `GLN`
 
  – N103 X12 codes for N103:

- `DUNS` - 1
- `DUNS4` - 9
- `DEA` - 11
- `HIN` - 21
- `COMPANYID` - 91
- `COMPANYSITEID` - 92
- `US_340B_ID` - PI PHARMACY\_PROCESSOR\_
- `NUMBER` - PP
- `GLN` - UL
 
  NAD020-030 EDIFACT supported codes:

- `DUNS` - 16
- `DEA` - 164
- `HIN` - 21
- `COMPANYID` - 91
- `COMPANYSITEID` - 92
 
              companyIdentifierValue string Company identifier value for business partner. PARTN where companyIdentifierType = COMPANYID N104 NAD020-010             alternateCompanyLocationIdentifierValue string Alternate company location identifier value. LIFNR – –           address – Party address information. – – –             address1 string Main street address. STRAS N301 NAD050-010             address2 string Supplemental street address. STRS2 N302 NAD050-020             city string City ORT01 N401 NAD060             district string District – – –             state string State or region code REGIO N402 NAD070-010             postalCode string Postal code PSTLZ N403 NAD080             country string Country code LAND1 N404 NAD090             telephone string Telephone number TELF1 – –             fax string Fax number TELFX – –             url string Website URL – – –             buildingNumber string Building number – – –             plantNumber string Plant number – – –             floorNumber string Floor number in building – – –             lscAddressIdentifier string LSC address identifier – – –             village string Village name – – –             houseNumber string House number – – –             township string Township – – –             premisesCode string Premises code – – –           companyLocationContactInformation – Company contact information. – Hard code PER01 to "AJ" primary contact Hard code CTA010 to "RP" responsible person             contactName string Contact name – PER02 CTA020-020             contactTitle string Contact title – – –             contactEmail string Contact email address. – PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"             contactPhone string Contact phone number. – PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM"           mpcAdditionalAddressInformation – Additional address information that is not included in addressTypeDefinition. – – –             externalERPUserName string External ERP system user name for user who generated message. BNAME – –             organizationCode string Code for organization responsible for generating the message. PAORG – –             organizationDescription string Description of the organization responsible for generating the message. – – –             groupCode string Code identifying group responsible for generating the message. – – –             language string Language key for message. SPRAS – –             languageCode string ISO language code for message. SPRAS\_ISO – –             referenceIdentifier string Partner reference identifier. IHREZ – –         supplerBusinessInformation – Supplier party business identifiers and address. – N101 = "SU" NAD01 = "SU"           businessName string Business name for partner or location. – N102 NAD040-010           additionalBusinessName string Additional business name or overflow of business name. – – –           mpcCompanyLocationIdentifierList array Identifier list for business party. – – –             isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –             companyIdentifierType string Company identifier type for business partner.

Valid values:

- `DUNS`
- `DUNS4`
- `DEA`
- `HIN`
- `COMPANYID`
- `COMPANYSITEID`
- `GLN`
 
  – N103 X12 codes for N103:

- `DUNS` - 1
- `DUNS4` - 9
- `DEA` - 11
- `HIN` - 21
- `COMPANYID` - 91
- `COMPANYSITEID` - 92
- `US_340B_ID` - PI PHARMACY\_PROCESSOR\_
- `NUMBER` - PP
- `GLN` - UL
 
  NAD020-030 EDIFACT supported codes:

- `DUNS` - 16
- `DEA` - 164
- `HIN` - 21
- `COMPANYID` - 91
- `COMPANYSITEID` - 92
 
              companyIdentifierValue string Company identifier value for business partner – N104 NAD020-010             alternateCompanyLocationIdentifierValue string Alternate company location identifier value – – –           address – Party address information – – –             address1 string Main street address – N301 NAD050-010             address2 string Supplemental street address – N302 NAD050-020             city string City – N401 NAD060             district string District – – –             state string State or region code – N402 NAD070-010             postalCode string Postal code – N403 NAD080             country string Country code – N404 NAD090             telephone string Telephone number – – –             fax string Fax number – – –             url string Website URL – – –             buildingNumber string Building number – – –             plantNumber string Plant number – – –             floorNumber string Floor number in building – – –             lscAddressIdentifier string LSC address identifier – – –             village string Village name – – –             houseNumber string House number – – –             township string Township – – –             premisesCode string Premises code – – –           companyLocationContactInformation – Company contact information. – Hard code PER01 to "AJ" primary contact Hard code CTA010 to "RP" responsible person             contactName string Contact name – PER02 CTA020-020             contactTitle string Contact title – – –             contactEmail string Contact email address. – PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"             contactPhone string Contact phone number. – PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM"         shipFromLocationInformation – Ship from party business location identifiers and address. – – –           businessName string Business name for partner or location. – N102 NAD040-010           additionalBusinessName string Additional business name or overflow of business name. – – –           mpcCompanyLocationIdentifierList array Identifier list for business party. – – –             isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –             companyIdentifierType string Company identifier type for business partner.

Valid values:

- `DUNS`
- `DUNS4`
- `DEA`
- `HIN`
- `COMPANYID`
- `COMPANYSITEID`
- `GLN`
 
  – – –             companyIdentifierValue string Company identifier value for business partner. – – –             alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –           address – Party address information. – – –             address1 string Main street address. – – –             address2 string Supplemental street address. – – –             city string City – – –             district string District – – –             state string State or region code – – –             postalCode string Postal code – – –             country string Country code – – –             telephone string Telephone number – – –             fax string Fax number – – –             url string Website URL – – –             buildingNumber string Building number – – –             plantNumber string Plant number – – –             floorNumber string Floor number in building – – –             lscAddressIdentifier string LSC address identifier – – –             village string Village name – – –             houseNumber string House number – – –             township string Township – – –             premisesCode string Premises code – – –           companyLocationContactInformation – Company contact information. – – –             contactName string Contact name – – –             contactTitle string Contact title – – –             contactEmail string Contact email address. – – –             contactPhone string Contact phone number. – – –         companyCodeBusinessInformation – Company code business information. E1EDKA1 where PARVW = "BK" – –           businessName string Business name for partner or location. E1EDKA1/NAME1 N102 NAD040-010           additionalBusinessName string Additional business name or overflow of business name. NAME2 – –           mpcCompanyLocationIdentifierList array Identifier list for business party. – – –             isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –             companyIdentifierType string Company identifier type for business partner.

Valid values:

- `DUNS`
- `DUNS4`
- `DEA`
- `HIN`
- `COMPANYID`
- `COMPANYSITEID`
- `GLN`
 
  – – –             companyIdentifierValue string Company identifier value for business partner. PARTN where companyIdentifierType = COMPANYID – –             alternateCompanyLocationIdentifierValue string Alternate company location identifier value. LIFNR – –           address   Party address information. – – –             address1 string Main street address. STRAS – –             address2 string Supplemental street address. STRS2 – –             city string City. ORT01 – –             state string State or region code REGIO – –             postalCode string Postal code PSTLZ – –             country string Country code LAND1 – –             telephone string Telephone number TELF1 – –             fax string Fax number TELFX – –             url string Website URL – – –             buildingNumber string Building number – – –             plantNumber string Plant number – – –             floorNumber string Floor number in building – – –             lscAddressIdentifier string LSC address identifier – – –             village string Village name – – –             houseNumber string House number – – –             township string Township – – –             premisesCode string Premises code – – –           companyLocationContactInformation – Company contact information. – – –             contactName string Contact name – – –             contactTitle string Contact title – – –             contactEmail string Contact email address. – – –             contactPhone string Contact phone number. – – –         shipToLocationInformation – Ship to party business location identifiers and address. E1EDKA1 where PARVW = "WE" N101 = "ST" NAD01 = "ST"           businessName string Business name for partner or location. E1EDKA1/NAME1 N102 NAD040-010           additionalBusinessName string Additional business name or overflow of business name. NAME2 – –           mpcCompanyLocationIdentifierList array Identifier list for business party. – – –             isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –             companyIdentifierType string Company identifier type for business partner.

Valid values:

- `DUNS`
- `DUNS4`
- `DEA`
- `HIN`
- `COMPANYID`
- `COMPANYSITEID`
- `GLN`
 
  – N103 X12 codes for N103:

- `DUNS` - 1
- `DUNS4` - 9
- `DEA` - 11
- `HIN` - 21
- `COMPANYID` - 91
- `COMPANYSITEID` - 92
- `US_340B_ID` - PI PHARMACY\_PROCESSOR\_
- `NUMBER` - PP
- `GLN` - UL
 
  NAD020-030 EDIFACT supported codes:

- `DUNS` - 16
- `DEA` - 164
- `HIN` - 21
- `COMPANYID` - 91
- `COMPANYSITEID` - 92
 
              companyIdentifierValue string Company identifier value for business partner. PARTN where companyIdentifierType = COMPANYID N104 NAD020-010             alternateCompanyLocationIdentifierValue string Alternate company location identifier value. LIFNR – –           address – Party address information. – – –             address1 string Main street address. STRAS N301 NAD050-010             address2 string Supplemental street address. STRS2 N302 NAD050-020             city string City ORT01 N401 NAD060             district string District – – –             state string State or region code REGIO N402 NAD070-010             postalCode string Postal code PSTLZ N403 NAD080             country string Country code LAND1 N404 NAD090             telephone string Telephone number TELF1 – –             fax string Fax number TELFX – –             url string Website URL – – –             buildingNumber string Building number – – –             plantNumber string Plant number – – –             floorNumber string Floor number in building – – –             lscAddressIdentifier string LSC address identifier – – –             village string Village name – – –             houseNumber string House number – – –             township string Township – – –             premisesCode string Premises code – – –           companyLocationContactInformation – Company contact information. – Hard code PER01 to "AJ" primary contact Hard code CTA010 to "RP" responsible person             contactName string Contact name – PER02 CTA020-020             contactTitle string Contact title – – –             contactEmail string Contact email address – PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"             contactPhone string Contact phone number – PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM"         storeNumberBusinessInformation – Store Number business location identifiers and address. – – –           businessName – – – – –           mpcCompanyLocationIdentifierList array Identifier list for business party. – – –             isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –             companyIdentifierType string Company identifier type for business partner.

Valid values:

- `DUNS`
- `DUNS4`
- `DEA`
- `HIN`
- `COMPANYID`
- `COMPANYSITEID`
- `GLN`
 
  – – –             companyIdentifierValue string Company identifier value for business partner. – – –             alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –           address – Party address information. – – –             address1 string Main street address. – – –             address2 string Supplemental street address. – – –             city string City – – –             district string District – – –             state string State or region code – – –             postalCode string Postal code – – –             country string Country code – – –             telephone string Telephone number – – –             fax string Fax number – – –             url string Website URL – – –             buildingNumber string Building number – – –             plantNumber string Plant number – – –             floorNumber string Floor number in building – – –             lscAddressIdentifier string LSC address identifier – – –             village string Village name – – –             houseNumber string House number – – –             township string Township – – –             premisesCode string Premises code – – –           companyLocationContactInformation – Company contact information – – –             contactName string Contact name – – –             contactTitle string Contact title – – –             contactEmail string Contact email address – – –             contactPhone string Contact phone number – – –         siteLocationInformation – Site Location business information. – – –           businessName string Business name for partner or location. – – –           additionalBusinessName string Additional business name or overflow of business name. – – –           mpcCompanyLocationIdentifierList array Identifier list for business party. – – –             isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –             companyIdentifierType string Company identifier type for business partner.

Valid values:

- `DUNS`
- `DUNS4`
- `DEA`
- `HIN`
- `COMPANYID`
- `COMPANYSITEID`
- `GLN`
 
  – – –             companyIdentifierValue string Company identifier value for business partner. – – –             alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –           address – Party address information. – – –             address1 string Main street address. – – –             address2 string Supplemental street address. – – –             city string City – – –             district string District – – –             state string State or region code – – –             postalCode string Postal code – – –             country string Country code – – –             telephone string Telephone number – – –             fax string Fax number – – –             url string Website URL – – –             buildingNumber string Building number – – –             plantNumber string Plant number – – –             floorNumber string Floor number in building – – –             lscAddressIdentifier string LSC address identifier – – –             village string Village name – – –             houseNumber string House number – – –             township string Township – – –             premisesCode string Premises code – – –           companyLocationContactInformation – Company contact information. – – –             contactName string Contact name – – –             contactTitle string Contact title – – –             contactEmail string Contact email address. – – –             contactPhone string Contact phone number. – – –           mpcAdditionalAddressInformation – Additional address information that is not included in addressTypeDefinition. – – –             externalERPUserName string External ERP system user name for user who generated message. – – –             organizationCode string Code for organization responsible for generating the message. – – –             organizationDescription string Description of the organization responsible for generating the message. – – –             groupCode string Code identifying group responsible for generating the message. – – –             language string Language key for message. – – –             languageCode string ISO language code for message. – – –             referenceIdentifier string Partner reference identifier. – – –         soldToBusinessInformation – Sold to party business identifiers and address. – N101 = "SO" NAD01 = "SO"           businessName string Business name for partner or location. – N102 NAD040-010           additionalBusinessName string Additional business name or overflow of business name. – – –           mpcCompanyLocationIdentifierList array Identifier list for business party. – – –             isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –             companyIdentifierType string Company identifier type for business partner.

Valid values:

- `DUNS`
- `DUNS4`
- `DEA`
- `HIN`
- `COMPANYID`
- `COMPANYSITEID`
- `GLN`
 
  – N103 X12 codes for N103:

- `DUNS` - 1
- `DUNS4` - 9
- `DEA` - 11
- `HIN` - 21
- `COMPANYID` - 91
- `COMPANYSITEID` - 92
- `US_340B_ID` - PI PHARMACY\_PROCESSOR\_
- `NUMBER` - PP
- `GLN` - UL
 
  NAD020-030 EDIFACT supported codes:

- `DUNS` - 16
- `DEA` - 164
- `HIN` - 21
- `COMPANYID` - 91
- `COMPANYSITEID` - 92
 
              companyIdentifierValue string Company identifier value for business partner. – N104 NAD020-010             alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –           address – Party address information. – – –             address1 string Main street address. – N301 NAD050-010             address2 string Supplemental street address. – N302 NAD050-020             city string City – N401 NAD060             district string District – – –             state string State or region code – N402 NAD070-010             postalCode string Postal code – N403 NAD080             country string Country code – N404 NAD090             telephone string Telephone number – – –             fax string Fax number – – –             url string Website URL – – –             buildingNumber string Building number – – –             plantNumber string Plant number – – –             floorNumber string Floor number in building – – –             lscAddressIdentifier string LSC address identifier – – –             village string Village name – – –             houseNumber string House number – – –             township string Township – – –             premisesCode string Premises code – – –           companyLocationContactInformation – Company contact information. – Hard code PER01 to "AJ" primary contact Hard code CTA010 to "RP" responsible person             contactName string Contact name – PER02 CTA020-020             contactTitle string Contact title – – –             contactEmail string Contact email address. – PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"             contactPhone string Contact phone number. – PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM"         invoiceOrganization array Organization identifiers sent from trading partner's ERP system. – – –           organizationType string Organization type.

Valid values includes:

- `SALESORG`
- `DISTRIBUTIONCHANNEL`
- `DIVISION`
- `COMPANYCODE`
- `SALESGROUP`
- `SALESOFFICE`
- `PROFITCENTER`
- `PURCHASINGGROUP`
- `PURCHASINGORGANIZATION`
 
  E1EDK14/QUALF =

- 006 (DIVISION) or
- 007 (DISTRIBUTIONCHANNEL) or
- 008 (SALESORG) or
- 009 (PURCHASINGGROUP) or
- 010 (SALESGROUP) or
- 011 (COMPANYCODE) or
- 014 (PURCHASINGORGANIZATION) or
- 016 (SALESOFFICE)
 
  – –           organizationValue string Organization identifier value. E1EDK14/ORGID – –         termsOfPayment array Terms of payment looping group. E1EDK18 – PYT           termsOfPaymentKey string Terms of payment. E1EDK18/QUALF =

- 001 or
- 002 or
- 005
 
  – –           termsOfPaymentTypeCode string Code identifying type of payment terms.

Valid values:

- `BASIC`
- `DEFERRED`
- `DISCOUNTNOTAPPLICABLE`
- `ENDOFMONTH EXTENDED`
- `FIXEDDATE`
- `MIXED`
- `PREVIOUSLYAGREED`
- `PROXIMO`
- `SELLER`
 
  – ITD01 =

- 01 (BASIC) or
- 04 (DEFERRED) or
- 05 (DISCOUNTNOTAPPLICABLE) or
- 02 (ENDOFMONTH) or
- 07 (EXTENDED) or
- 03 (FIXEDDATE) or
- 06 (MIXED) or
- 14 (PREVIOUSLYAGREED) or
- 15 (PROXIMO) or
- 13 (SELLER) or
 
  PYT010 =

- 1 (BASIC) or
- 4 (DEFERRED) or
- 5 (DISCOUNTNOTAPPLICABLE) or
- 2 (ENDOFMONTH) or
- 7 (EXTENDED) or
- 6 (MIXED) or
- 18 (PREVIOUSLYAGREED) or
- 9 (PROXIMO) or
- 13 (SELLER)
 
            termsOfPaymentDateBasis string Code identifying the beginning of the terms period.

Valid values:

- `DELIVERYDATE` - Delivery date
- `EFFECTIVEDATE` - Effective date
- `INVOICEDATE` - Invoice date
- `INVOICERECEIPTDATE` - Invoice receipt date
- `PURCHASEORDERDATE` - Purchase order date
- `SHIPDATE` - Shipping date
- `GOODSRECEIPTDATE` - Goods Receipt Date
 
  – ITD02 =

- 1 (SHIPDATE) or
- 2 (DELIVERYDATE) or
- 3 (INVOICEDATE) or
- 5 (INVOICERECEIPTDATE) or
- 7 (EFFECTIVEDATE) or
- 09 (PURCHASEORDERDATE) or
- 15 (GOODSRECEIPTDATE)
 
  –           numberOfDays string Terms of payment: number of days. E1EDK18/TAGE ITD07 –           discountDueNumberOfDays number Terms Discount Days Due. Number of days in the terms discount period by which payment is due if terms discount is earned. – ITD05 –           termsOfPaymentPercent string Terms of payment: percentage. E1EDK18/PRZNT ITD03 PYT/PCD/PCD010-020 when PCD010-010 = 122           invoicePayablePercent string Percentage of invoice payable. – ITD11 –           discountDueDate string Discount due date in string date format YYYY-MM-DD. – ITD04 –           epochDiscountDueDate integer Discount due date in epoch integer date format.

Each string date recorded will have an epoch date format generated by a java exit.

  – – –           paymentDueDate string Due date for payment. – ITD06 –           paymentDeferredToDate string Date deferred payment or percent of invoice payable is due. – ITD09 –           epochPaymentDueDate integer Due date for payment generated in epoch integer date format.

Each string date recorded will have an epoch date format generated by a java exit.

  – – –           epochPaymentDeferredToDate integer Date deferred payment or percent of invoice payable is due generated in epoch integer date format.

Each string date recorded will have an epoch date format generated by a java exit.

  – – –           paymentDeferredDueAmount string Deferred amount due for payment. – ITD10 –           description string Terms of payment description. E1EDK18/ZTERM\_TXT ITD12 PYT020-040           totalTermDiscountAmount integer Terms of payment discount amount. Total amount of terms discount. – – –           dayOfMonth integer The numeric value of the day of the month between 1 and the maximum day of the month being referenced. – ITD13 –         creditsAndCharges array Credits and charges on invoice including invoice total, discounts, allowances, promotions, services, and others. – segment loop 2030 SAC in loop 1600 CDD –           creditChargeKeyType string Key identifies credit or charges as discounts or additional charges.

Valid values:

- `ALLOWANCE`
- `CHARGE`
- `PROMOTION`
- `REQUESTALLOWANCE`
 
  – SAC01 =

- A (ALLOWANCE) or
- C (CHARGE) or
- N (NONE) or
- R (REQUESTALLOWANCE)
 
  –           creditChargeType string Code representing type of credit or charge. – SAC02 Refer enum link for X12 values –           creditChargeAmount string Total amount for the payment. – SAC05 –           qualifyingAmount string Amount qualifying for cash discount, allowance, promotion, service or charge. – – –           creditChargePercentRate string Percentage rate for cash discount, allowance, promotion, service or charge. – SAC07 –           percentRateBasisTypeCode string Code indicating basis that allowance or charge percent is calculated. – SAC06 –           creditChargeCurrencyCode string Currency code for credit or charge. – – –           creditChargeHandlingCode   Method of handling for discount or charge.

Valid values:

- `ADVANCE`
- `CANCELALLOWANCE`
- `COLLECT`
- `CREDITCUSTOMER`
- `GROSSINVOICED`
- `INFORMATION`
- `PREPAID`
- `RESELLERALLOWANCE`
- `VENDORPAID`
 
  – SAC12 Refer enumeration link for X12 values –           description string Description of credit or charge. – SAC15 –           unitPriceAmount string Unit price amount. – – –           unitPriceBasisQuantity string Quantity basis for the unit price. – – –           itemQuantity string Item quantity. – – –           unitOfMeasure string Base unit of measure or UOM for quantity of item in pack.

- `CA` - Case
- `CP` - Crate
- `CT` - Carton
- `DS` - Display
- `DZ` - Dozen
- `EA` - Each
- `PC` - Piece
- `PF` - Pallet
- `PK` - Package
- `T3` - Thousand Pieces
- `TH` - Thousand
- `TY` - Tray
- `UN` - Unit
 
  – – –           baseValue string – – – –           creditChargeConditionType string Credit charge condition type. – – –         taxes array Tax information and amounts. Header level. Tax amounts reported at header reflect totals for invoice. E1EDK04 – –           taxType string Type of tax recorded. List can be extended as required.

Valid value:

- `VAT`
- `HARMONIZEDSALES`
- `FEDERALEXCISE`
- `STATESALES`
- `PROVINCIALSALES`
- `CITYSALES`
- `COUNTYSALES`
- `GOODSANDSERVICES`
- `CUSTOMSDUTY`
- `SURTAX`
- `STATEEXCISE`
 
  – TXI01 =

- CS (CITYSALES) Or
- CT (COUNTYSALES) Or
- CG (CUSTOMSDUTY) Or
- FD (FEDERALEXCISE) Or
- GS (GOODSANDSERVICES) Or
- BE (HARMONIZEDSALES) Or
- PG (PROVINCIALSALES) Or
- ST (STATESALES) Or
- AB (SURTAX) Or
- VA (VAT) or
- SE (STATEEXCISE)
 
  TAX020-010 =

- LOC (CITYSALES) Or
- NA (COUNTYSALES) Or
- IMP (CUSTOMSDUTY) Or
- NA (FEDERALEXCISE) Or
- TOT (GOODSANDSERVICES) Or
- NA (HARMONIZEDSALES) Or
- NA (PROVINCIALSALES) Or
- STT (STATESALES) Or
- OTH (SURTAX) Or
- VAT (VAT)
 
when TAX01 = 7 in OB map taxType to target only if vatIndicator is missing

            country string Country for which taxes are recorded. – – –           taxRegistration string Tax registration number. – – –           taxJurisdictionCode string Tax jurisdiction code. – TXI05 –           taxJurisdictionProvenance string It identifies the source of the data used in tax jurisdiction code. – TXI04 –           taxExemptCode string Tax exempt code. – TXI06 –           taxAmount string Total amount of tax in invoice. E1EDK04/MWSBT TXI02 TAX/MOA/MOA010-020 when MOA010-010 = 124           taxCurrencyCode string Currency for taxes. – – –           taxPercent string Tax rate in percent. – – –           taxRate string Amount used for calculation of tax. E1EDK04/MSATZ – TAX/TAX050-040           vatIndicator string VAT indicator. E1EDK04/MWSKZ – TAX020-010 (only for OB map)         bankInfo array Bank information. E1EDK28/ – –           country string Bank country code. E1EDK28/BCOUN – –           city string City where bank is located. E1EDK28/BALOC – –           bankIdentifier string Bank identifier code. E1EDK28/BRNUM – –           bankName string Name of bank. E1EDK28/BNAME – –           accountNumber string Bank account number. E1EDK28/ACNUM – –           accountHolderName string Name of bank account holder. E1EDK28/ACNAM – –           internationalBankAccountNumber string International Bank Account Number (IBAN). E1EDK28/BIBAN – –         deliveryTerms array Terms of delivery, transport or inco terms looping group. E1EDK17 – –           description string Description for inco term. E1EDK17/LKTEXT – –           deliveryTermsConditionCode string Delivery Terms condition code. E1EDK17 / LKOND – –           deliveryChargePaymentMethodType string Method of payment for delivery.

 Valid values:

- `ADVANCECOLLECT`
- `ADVANCEPREPAID `
- `BUYER`
- `BUYERSELLERDEFINED`
- `COLLECT`
- `COLLECTDELIVERY`
- `COSTFREIGHT`
- `MIXED`
- `NOCHARGESERVICEFREIGHT`
- `PICKUP`
- `PREPAIDCUSTOMER`
- `PREPAIDONLY`
- `PREPAIDSELLER`
- `SELLER`
 
  – – –           fobTransferLocation string Code specifying the type of location at which the risk of loss for the shipment transfers.

Valid values:

- `CITY`
- `PLANT`
- `SHIPPINGDESTINATION `
- `SHIPPINGORIGIN`
 
  – – –           deliveryTermsCode string Delivery terms condition code.

Valid values include:

- `INCO1` = INCOTERMS part 1
- `INCO2` = INCOTERMS part 2
 
  E1EDK17/QUALF – –         invoiceWeight array Order weight at invoice header level – – –           weightType string Type of weight recorded.

Valid value is

`GROSSWEIGHT` - NETWEIGHT

 Note: weight measurement in X12 and EDIFACT at header level within general measurement qualifiers.

  – – –           weightValue Number Weight of product at invoice header level. E1EDK01/NTGEW if weightType =NETWEIGHT E1EDK01/BRGEW if weightType =GROSSWEIGHT – –           unitOfMeasure string Weight unit of measure in master data for product. E1EDK01/GEWEI – –         foreignTradeHeaderInformation array Foreign trade header information. E1EDK29 – –           foreignTradeIdentifier string Foreign trade identifier. E1EDK29/EXNUM – –           exportDepartureCountryCode string Country code for country of departure for export. E1EDK29/ALAND – –           exportAlternateDepartureCountryCode string Alternate country code for country of departure for export. E1EDK29/ALANA – –           exportDepartureCountryDescription string Full name description of export country. E1EDK29/ALANX – –           foreignTradeTransportMode string Mode of transport for foreign trade. E1EDK29/EXPVZ – –           foreignTradeTransportModeDescription string Description of mode of transport for foreign trade. E1EDK29/EXPVZTX – –           foreignTradeCustomsEntryExitOfficeCode string Office code for customs entry/exit office for foreign trade. E1EDK29/ZOLLA – –           foreignTradeCustomsEntryExitOfficeDescription string Description of customs entry/exit office for foreign trade. E1EDK29/ZOLLATX – –           foreignTradeCurrency string Currency for foreign trade. E1EDK29/GRWCU – –           importingCountryCode string Country code for importing country. E1EDK29/LAND1 – –           importingCountryName string Full name of importing country. E1EDK29/LANDX – –           importingAlternateCountryCode string Alternate country code for importing country. E1EDK29/LANDA – –           soldtoPartyAlternateCountryCode string Alternate country code for sold to party. E1EDK29/ALSCH – –           freeTradeAreaCode string Free trade area for legal control identifier for importing country.

Valid values:

- `ASEAN` - 1
- `EFTA` - 2
- `NAFTA` - 3
- `MERCOSUR` - 4
 
  E1EDK29/FREIH =

- 1 (ASEAN) or
- 2 (EFTA) or
- 3 (NAFTA) or
- 4 (MERCOSUR)
 
  – –           freeTradeAreaDescription string Description of free trade area code E1EDK29/FREIHTX – –           countryCodeForJapanCustomsDeclaration string Country code for Japan customs declaration E1EDK29/JAP05 – –           countryDirectoryCurrencyCode string Country directory currency code E1EDK29/ALSRE – –           domesticModeOfTransport string Domestic mode of transport E1EDK29/IEVER – –           domesticModeOfTransportDescription string Description of domestic mode of transport E1EDK29/IEVER\_TX – –           exportCustomsOfficeCode string Export customs office code E1EDK29/AZOLL – –           exportCustomsOfficeDescription string Description for export customs office E1EDK29/AZOLLTX – –           associationForForeignTradeIndicator string Indicator identifying association for Foreign Trade. Mapping whatever we find.

Values may include:

- `1` - Seller and buyer are associated - price is not influenced
- `2` - Seller and buyer are associated - price is influenced Not populated or
- `0`- Seller and buyer are not associated
 
  E1EDK29/FTVBD – –         invoiceCarrierInformation   Invoice related carrier information – – –           carrierCode string Carrier code for shipper – CAD04 –           equipmentPrefix string Prefix or alphabetic part of an equipment unit's identifying number. – – –           equipmentIdentifier string Sequencing or serial part of an equipment unit's identifying number. – – –           transportMethod string Transport method type.

Valid values include:

- `TRUCK` - Truck
- `RAIL` - Shipped by train
- `SEA` - By sea
- `AIR` - By air
- `LTL` - Less than truckload
- `AIREXPRESS` - Air express
- `CONTAINERSEA` - Container by ship
- `SUPPLIERTRUCK` - Supplier truck
 
  – – –           routingDescription string Routing Description. – CAD05 –           orderStatusCode string Order or shipment status code. – – –           transactionReferenceIdentifiers array Transaction references for invoice carrier at header level. – – –             b2bTransactionIdentifierType string Referenced document type.

Valid values include:

- `BOL` - Bill of Lading Number
- `CARRIERREFERENCE` - Carrier reference number
 
  – – –             b2bTransactionIdentifierValue string Reference order identifier value for invoice identified by transactionReferenceIdentifierType. – CAD08 when b2bTransactionIdentifierType = BOL  –             lineItemNumber string Line item number in transaction reference. Line item level only. – – –             transactionDate string Date transaction created. – – –             epochTransactionDate integer Date transaction created in epoch integer date format.

Each string date recorded will have an epoch date format generated by a java exit.

  – – –         invoiceShipmentSummary array Shipment details into Invoice. – – –           quantityType string Type of quantity recorded.

Valid value is `UNIT`.

  – – –           quantityValue string Quantity of product at delivery header level. – ISS01, when quantityType = UNIT –           quantityUOM string Quantity unit of measure in master data for product. – ISS02 –           weightType string Type of weight recorded in shipment.

Valid values include:

- `GROSSWEIGHT`
- `NETWEIGHT`
- `BILLED` - Billed weight
- `LEGAL` - Legal weight
- `EXCESS` - Excel weight over maximum
- `SHIPPER` - Shipper's weight
- `AVERAGE` - Average weight
- `FREIGHT` - Freight weight
 
  – – –           weightValue string Weight of product at delivery header level – ISS03 –           weightUOM string Weight unit of measure in master data for product.

Valid values

- `LB`
- `KG`
 
  – ISS04 –           volumeType string Type of weight recorded.

Valid values include:

- `CONTAINER` - Volume of container
- `CUBICCENTIMETERS` - Cubic centimeters
- `CUBICFEET` - Cubic feet
- `CUBICINCHES` - Cubic inches
- `CUBICMETERS` - Cubic meters
- `GALLONS` - Gallons
- `LITER` - Liter
- `LOADING` - Total volume of load
 
  – – –           volumeValue Number Volume for delivery. – ISS05 –           volumeUOM string Volume unit of measure. – ISS06 –         freeTextNote array Free text, instructions, notes, descriptions and other free text elements. – – –           textReferenceCode string Text reference or subject code. Will map whatever is found. E1EDKT1/TDID – –           textFunctionCode string Text function code. Will map whatever is found. E1EDKT1/DOBJECT – –           language string Language key for message. E1EDKT1/TSSPRAS – –           languageCode string ISO language code for message. E1EDKT1/TSSPRAS\_ISO – –           textFormatCode string Format code for free text. E1EDKT2/TDFORMAT – –           freeText string, array Free text array. E1EDKT2/TDLINE – –       canonicalInvoiceItemDetails array Invoice items details. – – –         lineItemNumber number Line item number. E1EDP01/POSEX IT101 LIN01         itemFunctionCode string Item level function for invoice message. – – –         itemCategory string Item category sent by partner's ERP system. E1EDP01/PSTYV – –         packingUnits number Number of packing units at line item. – PO401 –         innerPackCount String Inner Pack count within a container. – PO414 –         plantIdentifier string Plant identifier. E1EDP01 / WERKS – –         shipToAccountIdentifier string Ship to Account identifier. – – –         conversionFactor string Conversation factor from one of unit of measurement into another unit of measurement. – – –         deliveryType string Delivery Type. – – –         isQuantityReturnToStock string For qty return stock (Y= qty return to stock, N= no qty return to stock). – – –         stockMovementIndicator boolean Indicator identifying movement of stock.

Values may include:

- `1` - Return Order
- `0` - Not return Order
 
  – – –         isSoldToCustomer boolean To identify if stocks are sold to customer.

Values may include:

- `True` - Sold to customer
- `False` - Not sold to customer
 
  – – –         supplierBillOfMaterialsIdentifier string Vendor's bills of materials identifier. – – –         clientBillOfMaterialsIdentifier string Customer bills of materials identifier. – – –         purchaseOrderType string Type of purchase order, against which INVOICE is created. – – –         reasonCode string Type of reason code. – – –         locationIdentifier string Location identifier. – – –         vendorOrderType string Type of vendor order, against which INVOICE is created. – – –         deliveredProductCode string Product code delivered. – – –         laboratoryProductCode string Laboratory product code. – – –         marketReference string Market reference for a region to verify the invoic and cost into that reason. – – –         groupCode string Market Group code. – – –         groupName string Market Group Name. – – –         salesType string Sales Type. – – –         invoiceOrganization array Organization identifiers sent from trading partner's ERP system. – – –           organizationType string Organization type.

Valid values includes:

- `SALESAREA `
- `SALESORG `
- `DISTRIBUTIONCHANNEL`
- `SALESGROUP`
- `SALESOFFICE`
- `PROFITCENTER`
- `PURCHASINGGROUP`
- `PURCHASINGORGANIZATION`
 
  – – –           organizationValue string Organization identifier value. – – –         productCodesIdentifiers array Internal material identifier in the backend/ERP systems for the product. In the delivery this will be the supplier, although the customer and other identifiers may also be present. – – –           productCodes – Internal material identifier in the backend/ERP systems for the product. In the delivery this will be the supplier, although the customer and other identifiers may also be present. E1EDP01/E1EDP19 if lotNumber present and multiple productCodesIdentifiers are present, start mapping first productCodesIdentifiers to IT108/09, and continue map next set productCodesIdentifier to consecutive set of IT1 Product/Service ID andProduct/Service ID Qualifier               productCodeType string Code to qualify product identifier type.

Some valid product types include:

- `BUYERITEM`
- `CUSTOMER`
- `GTIN14`
- `MANUFACTURERPART`
- `UPC`
- `VENDOR`
- `VENDORPART`
 
  E1EDP19/QUALF =

- 001 (CUSTOMER) or
- 002 (VENDOR) or
- 003 (GTIN14) or
- 004 (MANUFACTURER)
 
Note - One of these required

  IT106 or IT108 LIN030-020 =

- ON (CUSTOMER) or
- VN (VENDOR) or
- SA (GTIN14)
- MF (MANUFACTURER)
 
Note - One of these required

              productCodeValue string Product code identifier value. E1EDP19/IDTNR IT107 or IT109 LIN030-010             productItemCodeType string Product item code type. – – –         productItemInformation array Regulatory product description list. Defined as array to enable descriptions in multiple languages. – – –           productLanguageCode string Language for product description. – – –           productName string Name of product. E1EDP19/KTEXT IT1/PID05 –           genericName string Generic name for product. – – –           productDescription string Description of the product defined by the current product identifier. – IT1/PID05 LIN/IMD/IMD030-040 when IMD010 = F         lotNumber string Lot or batch identifier (customer). – IT107 when IT106 = LT LIN/PIA/PIA020-010 when PIA020-020 = BB         expirationDate string Expiration date for lot in string date format YYYYMMDD. – IT1/DTM02when DTM01 = 208 LIN/DTM010-020 when DTM010-010 = 36         epochExpirationDate integer Expiration date for lot generated in epoch integer date format.

Each string date recorded will have an epoch date format generated by a java exit.

  – – –         additionalItemInformation array Additional item information including status of units shipped. – – –           numberOfUnitsShipped number Number of units shipped. – IT1/IT301 –           unitOfMeasure string Unit or Basis for Measurement Code. Quantity UOM's include:

- `CA` - Case
- `CP`- Crate
- `CT`- Carton
- `DS` - Display
- `DZ` - Dozen
- `EA` - Each
- `PC` - Piece
- `PF` - Pallet
- `PK` - Package
- `T3` - Thousand Pieces
- `TH` - Thousand
- `TY` - Tray
- `UN` - Unit
 
  – IT1/IT302 Refer enum link for X12 values –           statusCodeForShipmentOrOrder string Status code for the order or shipment. X12 pass thru. Enumerations may be added later. – IT1/IT303 –           quantityDifference number Numeric value of variance between ordered and shipped quantities. – IT1/IT304 –           agencyCode String Agency defines the codes for item / products. – IT1/PID03 –           productDescriptionType String Item / Product description code type. – IT1/PID04 –         itemQuantity array Order quantity at line item level. –   –           quantityType string Type of quantity recorded.

Valid value:

- `INVOICE`
- `ORDER`
- `ITEM`
 
  – – LIN/QTY010-010 Refer enum link for EDIFACT values           quantityValue number Quantity of product in delivery. E1EDP01/MENGE when quantityType = "INVOICE" IT102 when quantityType = "INVOICE" LIN/QTY010-020           unitOfMeasure string Unit of measure for quantity value. E1EDP01/MENEE when quantityType = "INVOICE" IT103 when quantityType = "INVOICE" LIN/QTY010-030         destinationLocationQuantity array Records quantity invoiced by location details. Typically used to report invoiced quantity at multiple locations.

For example, Walmart or CVS may report quantity for the invoiced item at multiple store locations. Corresponds to X12 SDQ segment.

  – – –           unitOfMeasure string Unit of measure for destination location quantity. – – –           companyIdentifierType string Identifier type for quantity destination location. – – –           locationQuantitySequence01 – Location quantity sequence identifying location and quantity sent to that location. – – –             locationIdentifier string This quantity is the sum of all quantity per location and per line. – – –             destinationQuantity Number This quantity is the sum of all quantity per location and per line. – – –           locationQuantitySequence02 – Location quantity sequence identifying location and quantity sent to that location. – – –             locationIdentifier string This quantity is the sum of all quantity per location and per line. – – –             destinationQuantity Number This quantity is the sum of all quantity per location and per line. – – –           locationQuantitySequence03 – Location quantity sequence identifying location and quantity sent to that location. – – –             locationIdentifier string This quantity is the sum of all quantity per location and per line. – – –             destinationQuantity Number This quantity is the sum of all quantity per location and per line. – – –           locationQuantitySequence04 – Location quantity sequence identifying location and quantity sent to that location. – – –             locationIdentifier string This quantity is the sum of all quantity per location and per line. – – –             destinationQuantity Number This quantity is the sum of all quantity per location and per line. – – –           locationQuantitySequence05 – Location quantity sequence identifying location and quantity sent to that location. – – –             locationIdentifier string This quantity is the sum of all quantity per location and per line. – – –             destinationQuantity Number This quantity is the sum of all quantity per location and per line. – – –           locationQuantitySequence06 – Location quantity sequence identifying location and quantity sent to that location. – – –             locationIdentifier string This quantity is the sum of all quantity per location and per line. – – –             destinationQuantity Number This quantity is the sum of all quantity per location and per line. – – –           locationQuantitySequence07 – Location quantity sequence identifying location and quantity sent to that location. – – –             locationIdentifier string This quantity is the sum of all quantity per location and per line. – – –             destinationQuantity Number This quantity is the sum of all quantity per location and per line. – – –           locationQuantitySequence08 – Location quantity sequence identifying location and quantity sent to that location. – – –             locationIdentifier string This quantity is the sum of all quantity per location and per line. – – –             destinationQuantity Number This quantity is the sum of all quantity per location and per line. – – –           locationQuantitySequence09 – Location quantity sequence identifying location and quantity sent to that location. – – –             locationIdentifier string This quantity is the sum of all quantity per location and per line. – – –             destinationQuantity Number This quantity is the sum of all quantity per location and per line – – –           locationQuantitySequence10 – Location quantity sequence identifying location and quantity sent to that location. – – –             locationIdentifier string This quantity is the sum of all quantity per location and per line. – – –             destinationQuantity Number This quantity is the sum of all quantity per location and per line. – – –         invoicePricing array Invoice price amounts for item. – – –           pricingType string Pricing type for invoice item.

Valid pricing types include:

- `AVERAGE`
- `UNIT`
- `NET`
- `STANDARD`
- `WHOLESALE`
- `GROSS`
- `INVOICE`
- `EXTENDED`
- `QUALIFYFORDISCOUNT`
- `STATISTICALVALUE`
- `SUBTOTAL1`
- `SUBTOTAL2`
- `SUBTOTAL3`
- `INFORMATION`
 
  E1EDP26/QUALF =

- 001 (GROSS) or
- 002 (NET) or
- 004 (QUALIFYFORDISCOUNT) or
- 009 (STATISTICALVALUE) or
- 010 (SUBTOTAL1) or
- 011 (SUBTOTAL2) or
- 012 (SUBTOTAL3)
 
  IT105 =

- AW (AVERAGE) Or
- PE (UNIT) Or
- NT (NET) Or
- ST (STANDARD) Or
- WE (WHOLESALE)
 
  PRI010-010 =

- AAD (AVERAGE) Or
- AAF (EXTENDED) Or
- AAB (GROSS) Or
- INF (INFORMATION) Or
- INV (INVOICE) Or
- INF(UNIT) Or
- AAA (NET)
 
            pricingAmount string Pricing amount for pricing type defined by pricing type enumeration. E1EDP26/VPREI IT104 PRI010-020           currencyCode string Currency for pricing amount. – – –           priceUOM string Unit of measure used for pricing at the order line item level. – – –           unitPriceBasisQuantity string Quantity basis of unit price, ie, if unit price per one item, the basis is 1. If unit price based on 12, the basis is 12. – – –           altUOMDenominator string Denominator is used to convert from an alternate unit of measure, ie KG, to a base unit of measure, ie EA.

The denominator is the number of units of the alternative UOM (KG) that corresponds to the number of units of the base UOM (EA).

 If 5 KG = 3 EA, 1 KG = 3/5 EA. 5 is the denominator. In most cases, this value will be 1.

  – – –           altUOMNumerator string Numerator is used to convert from an alternate unit of measure, ie, KG to a base unit of measure, ie, EA.

The numerator is the number of units of the base UOM (EA) that corresponds to the number of units of the alternative UOM (KG).

If 5 KG = 3 EA, 1 KG = 3/5 EA. 3 is the numerator. In most cases, this value will be 1.

  – – –           numberOfUnitsInPriceUOM number Number of units of measure on which the price is based, ie, 10 liters of oil cost $12.00. The price unit is 10. – – –           totalStockValue number Total pricing amount for that line item – – –           isCreditorDebit boolean Credit or debit boolean. Only populated if identified. HDA optional value.

 Valid values:

- `True` - Credit
- `False` - Debit Not populated (default)
 
  – – –         creditsAndCharges array Credits and charges on invoice including invoice total, discounts, allowances, promotions, services, and others – – –           creditChargeKeyType string Key identifies credit or charges as discounts or additional charges.

Valid values include:

- `ALLOWANCE`
- `CHARGE`
- `PROMOTION`
- `INCREASE`
- `DECREASE`
- `NONE`
- `ADDITIONALALLOWANCES`
- `REQUESTALLOWANCE`
 
  E1EDP05/ALCKZ =

- \+ (INCREASE) or
- \- (DECREASE)
 
  IT1/SAC01 =

- A (ALLOWANCE) or
- C (CHARGE) or
- N (NONE) or
- R (REQUESTALLOWANCE)
 
  LIN/ALC010 =

- J (ADJUSTMENT) Or
- D (ADVANCEALLOWANCE) Or
- C (BOLCHARGE) Or
- D (ADVANCEALLOWANCE) Or
- Q (DISCOUNT) Or
- X (MAXIMUMCHARGE)
 
            creditChargeType string Code representing type of credit or charge – IT1/SAC02 Refer enum link for X12 values –           creditChargeSubType string Code representing sub type of credit or charge – – –           creditChargeAmount string Total amount for the payment E1EDP05/BETRG IT1/SAC05 LIN/ALC020-010           qualifyingAmount string Amount qualifying for cash discount, allowance, promotion, service or charge – – –           discountQualifyingLeadTimeType string Discount Qualifying lead time to define the number of days within which discount or any other allowances are applicable.

Valid values are:

- `DAYS` - Additional discount, if paid within mentioned number of days
- `WEEKS` - Additional discount, if paid within mentioned number of weeks
- `MONTH` - Additional discount, if paid within mentioned number of months
 
  – – –           creditChargePercentRate string Percentage rate for cash discount, allowance, promotion, service or charge. – IT1/SAC07             percentRateBasisTypeCode string Code indicating basis that allowance or charge percent is calculated. – IT1/SAC06             creditChargeCurrencyCode string Currency code for credit or charge. E1EDP05/KOEIN – –           creditChargeHandlingCode – Method of handling for discount or charge. Valid values include:

- `ADVANCE`
- `CANCELALLOWANCE`
- `COLLECT`
- `CREDITCUSTOMER`
- `GROSSINVOICED`
- `INFORMATION`
- `PREPAID `
- `RESELLERALLOWANCE `
- `VENDORPAID`
 
  – IT1/SAC12 Refer enumeration link for X12 values –           description string Description of credit or charge. E1EDP05/KOTXT IT1/SAC15             unitPriceAmount string Unit price amount. E1EDP05/KRATE – –           unitPriceBasisQuantity string Unit price basis quantity. E1EDP05/UPRBS – –           itemQuantity string Quantity of product for credits or charges. – – –           unitOfMeasure string Unit of measure for item quantity. E1EDP05/MEAUN – –           baseValue string Base value for credit or charge. E1EDP05/KOBAS – –           creditChargeConditionType string Credit charge condition type. – – –         taxes array Tax information and amounts. Header level. Tax amounts reported at line item level reflect totals for line item quantity only. E1EDP04 – –           taxType string Type of tax recorded. List can be extended as required.

Valid value:

- `VAT`
- `HARMONIZEDSALES`
- `FEDERALEXCISE`
- `STATESALES`
- `PROVINCIALSALES`
- `CITYSALES`
- `COUNTYSALES`
- `GOODSANDSERVICES`
- `CUSTOMSDUTY`
- `SURTAX`
- `STATEEXCISE`
 
  – IT1/TXI01 =

- CS (CITYSALES) Or
- CT (COUNTYSALES) Or
- CG (CUSTOMSDUTY) Or
- FD (FEDERALEXCISE) Or
- GS (GOODSANDSERVICES) Or
- BE (HARMONIZEDSALES) Or
- PG (PROVINCIALSALES) Or
- ST (STATESALES) Or
- AB (SURTAX) Or
- VA (VAT) or
- SE (STATEEXCISE)
 
  TAX020-010 =

- LOC (CITYSALES) Or
- NA (COUNTYSALES) Or
- IMP (CUSTOMSDUTY) Or
- NA (FEDERALEXCISE) Or
- TOT (GOODSANDSERVICES) Or
- NA (HARMONIZEDSALES) Or
- NA (PROVINCIALSALES) Or
- STT (STATESALES) Or
- OTH (SURTAX) Or
- VAT (VAT)
 
 when TAX01 = 7 in OB map taxType to target only if vatIndicator is missing

            country string Country for which taxes are recorded. – – –           taxRegistration string Tax registration number. – – –           taxJurisdictionCode string Tax jurisdiction code. – IT1/TXI05 –           taxJurisdictionProvenance string It identifies the source of the data used in tax jurisdiction code. – IT1/TXI04 –           taxExemptCode string Tax exempt code. – IT1/TXI06 –           taxAmount string Total amount of tax in invoice. E1EDP04/MWSBT IT1/TXI02 TAX/MOA/MOA010-020 when MOA010-010 = 124           taxCurrencyCode string Currency for taxes. – – –           taxPercent string Tax rate in percent. – – –           taxRate string Amount used for calculation of tax. E1EDP04/MSATZ – TAX/TAX050-040           vatIndicator string VAT indicator. E1EDP04/MWSKZ – TAX020-010 (only for OB map)           additionalTaxRate string Additional Tax rate. – – –           vatPercentage string VAT percentage. – – –         itemWeight array Order weight at invoice item level. – – –           weightType string Type of weight recorded.

Valid values include:

- `GROSSWEIGHT`
- `NETWEIGHT`
 
  – – –           weightValue number Weight of product at invoice item level. E1EDP01/NTGEW when weightType = NETWEIGHT E1EDP01/BRGEW when weightType = GROSSWEIGHT – –           unitOfMeasure string Unit of measure used for item weight at invoice line item level. E1EDP01/GEWEI – –         transactionReferenceIdentifierList array Transaction references for deliveries at header level. – – –           b2bTransactionIdentifierType string Referenced document type.

Valid values include:

- `INVOICE `
- `PURCHASEORDER`
- `SUPPLIERORDER`
- `DELIVERY`
- `ASSIGNMEN`T
- `PRECEDINGDOCUMENT`
- `BILLINGREFERENCE`
- `CONTRACT`
- `CUSTOMERCONTRACT`
- `DOCUMENT`
- `RELEASE`
- `SUPPLIERCONTRACT`
 
  E1EDP02/QUALF =

- 009 (INVOICE) or
- 001 (PURCHAEORDER) or
- 002 (SUPPLYORDER) or
- 012 (DELIVERY)
- 017 (ASSIGNMENT)
- 016 (PRECEDINGDOCUMENT)
- 087 (BILLINGREFERENCE)
 
  – LIN/REF010-010 =

- CT (CONTRACT) Or
- BC (CUSTOMERCONTRACT) Or
- DM (DOCUMENT) Or
- DQ(DELIVERY) Or
- IV (INVOICE) Or
- ON (PURCHASEORDER) Or
- RE (RELEASE) Or
- VC (SUPPLIERCONTRACT) Or
- VN (SUPPLIERORDER)
 
            b2bTransactionIdentifierValue string Reference order identifier value for Dispatch advice transaction type identified by transactionReferenceIdentifierType E1EDP02/BELNR   LIN/REF020-010           transactionDate string Date transaction created – – –           epochTransactionDate integer Date transaction created in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. E1EDP02/DATUM and UZEIT – –           lineItemNumber string Line item number in transaction reference. Line item level only. E1EDP02/ZEILE – –         invoiceDates array Invoice reference dates at line item level. – – –           dateType string referenced date type.

Valid values include:

- `SHIPPED`
- `DELIVERY`
- `BILLING`
- `DUEDATE`
- `DOCUMENT`
- `INVOICE`
- `PRICING`
- `MESSAGE`
- `PURCHASEORDER`
- `FIXEDVALU`E
- `SUPPLIERORDE`R
- `CREATEDON`
- `SERVICESRENDERED`
- `PO_RECEIVED`
- `EXPIRATION`
- `ESTIMATEDDELIVERY`
- `DELIVERYREQUESTED `
- `CANCELBY`
- `SHIPMENTREQUESTED`
 
  E1EDP03/IDDAT =

- 001 (DELIVERY) or
- 011 (MESSAGE) or
- 012 (DOCUMENT) or
- 022 (PURCHASEORDER) or
- 023 (PRICING) or
- 024 (FIXEDVALUE) or
- 026 (BILLING) or
- 028 (DUEDATE) or
- 029 (SUPPLIERORDER) or
- 025 (CREATEDON) or
- 027 (SERVICESRENDERED)
 
  IT1/DTM01 =

- CANCELBY (177) or
- DELIVERYREQUESTED (002) or
- ESTIMATEDDELIVERY (017) or
- EXPIRATION (036) or
- INVOICE (003) or
- PO\_RECEIVED (008) or
- DOCMENT (102) or
- PURCHASEORDER (004) or
- SHIPMENTREQUESTED (010) or SHIPPED (011)
 
  DTM01-010 =

- 46 (CANCELBY) Or
- 2 (DELIVERYREQUESTED) Or
- 69 (ESTIMATEDDELIVERY) Or
- 36 (EXPIRATION) Or
- 149 (INVOICE) Or
- 4 (PURCHASEORDER) Or
- 318 (SHIPMENTREQUESTED) Or
- 10 (SHIPPED)
 
            dateValue string Date defined by referenced date type. E1EDP03/DATUM IT1/DTM02 DTM01-020           epochDateValue integer Date defined by referenced date type generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. – – –           timeZone string Time zone for referenced dates. E1EDP03/UZEIT IT1/DTM03 –         accountAssignmentForInvoice array Account assignment for invoice. E1EDP30 – –           accountAssignmentType string Account assignment type.

Valid values:

- `COSTCENTER`
- `PROFITCENTER`
- `WBSOBJECT `
- `PROFITABILITYSEGMENT`
- `BUSINESSAREA`
- `PURCHASINGGROUP`
 
  E1EDP30/QUALF =

- 045 (COSTCENTER) or
- 048 (PROFITCENTER) or
- 047 (WBSOBJECT) or
- 046 (PROFITABILITYSEGMENT) or
- 049 (BUSINESSAREA) or
- 057 (PURCHASINGGROUP)
 
  – –           accountIdentifier string Account identifier value defined by account assignment type. E1EDP30/IVKON – –         foreignTradeItemDetailsInformation array Foreign trade item details information. E1EDP28 – –           foreignTradeIdentifier string Foreign trade identifier. E1EDP28/EXNUM – –           foreignTradeLineItemNumber string Line item number for foreign trade info. E1EDP28/EXPOS – –           exportImportProcedureCode string Export/import procedure code. E1EDP28/EXPRF – –           exportImportAlternateProcedureCode string Alternate export/import procedure code. E1EDP28/VERFA – –           exportImportProcedureDescription string Description of export/import procedure. E1EDP28/EXPRF\_TX – –           foreignTradeBusinessTransactionType string Foreign trade business transaction type. E1EDP28/EXART – –           foreignTradeBusinessTransactionDescription string Description of foreign trade business transaction. E1EDP28/EXART\_TX – –           productCountryOfOrigin string Country of origin for product. E1EDP28/HERKL – –           productRegionOfOrigin string Region of origin for product. E1EDP28/HERKR – –           productAlternateCountryOfOrigin string Alternate country of origin for product. E1EDP28/HERTA – –           productCountryOfOriginDescription string Country of origin full name description for product. E1EDP28/HERTI – –           productGrossWeight string Gross weight for product. E1EDP28/BRULO – –           productNetWeight string Net weight for product. E1EDP28/NETLO – –           unitOfMeasure string Unit of measure for product. E1EDP28/VEMEH – –           regionOfProductManufacture string Region where product was manufactured. E1EDP28/HERBL – –           countryOfDispatchForTrade string Country of dispatch for trade. E1EDP28/VERLD – –           countryOfDispatchDescription string Description of country of dispatch for trade. E1EDP28/VERLD\_TX – –           exemptionCertificateForTrade string Exemption certificate: Indicator for legal control.

Valid values:

- `A` - Applied for
- `B` - Accepted
- `C` - Request rejected
 
If not populated or element empty, not relevant.

  E1EDP28/PRENC – –           exemptionCertificateForLegalControl string Exemption certificate for legal control. E1EDP28/PRENO – –           exemptionCertificateIssueDate string Date exemption certificate issued. E1EDP28/PREND – –           epochExemptionCertificateIssueDate integer Date exemption certificate issued generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. – – –           regionForPlant string State, province or region where plant is located. E1EDP28/WKREG – –         shipToLocationInformation array Optional ship to party business location identifiers and address if not present at header or if invoice line items delivered to different ship-to locations. E1EDPA1 where PARVW = "WE" – –           businessName string Business name for partner or location. E1EDPA1/NAME1 N102 NAD040-010           additionalBusinessName string Additional business name or overflow of business name. NAME2 – –           mpcCompanyLocationIdentifierList array Identifier list for business party. – – –             isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –             companyIdentifierType string Company identifier type for business partner.

Valid values:

- `DUNS`
- `DUNS4`
- `DEA`
- `HIN`
- `COMPANYID`
- `COMPANYSITEID`
- `GLN`
 
  – – –             companyIdentifierValue string Company identifier value for business partner. PARTN where companyIdentifierType = COMPANYID – –             alternateCompanyLocationIdentifierValue string Alternate company location identifier value. LIFNR – –           address – Party address information. – – –             address1 string Main street address. STRAS – –             address2 string Supplemental street address. STRS2 – –             city string City ORT01 – –             state string State or region code REGIO – –             postalCode string Postal code PSTLZ – –             country string Country code LAND1 – –             telephone string Telephone number TELF1 – –             fax string Fax number TELFX – –             url string Website URL – – –             buildingNumber string Building number – – –             plantNumber string Plant number – – –             floorNumber string Floor number in building. – – –             lscAddressIdentifier string LSC address identifier. – – –             village string Village name – – –             houseNumber string House number HAUSN – –             township string Township – – –             premisesCode string Premises code – – –           companyLocationContactInformation – Company contact information. – – –             contactName string Contact name – – –             contactTitle string Contact title – – –             contactEmail string Contact email address. – – –             contactPhone string Contact phone number. – – –           mpcAdditionalAddressInformation – Additional address information that is not included in addressTypeDefinition. – – –             externalERPUserName string External ERP system user name for user who generated message. BNAME – –             organizationCode string Code for organization responsible for generating the message. PAORG – –             organizationDescription string Description of the organization responsible for generating the message. – – –             groupCode string Code identifying group responsible for generating the message. – – –             language string Language key for message. SPRAS – –             languageCode string ISO language code for message. SPRAS\_ISO – –             referenceIdentifier string Partner reference identifier. IHREZ – –         freeTextNote array Free text, instructions, notes, descriptions and other free text elements. – – –           textReferenceCode string Text reference or subject code. Will map whatever is found.. E1EDPT1/TDID – –           textFunctionCode string Text function code. Will map whatever is found. E1EDPT1/TDOBJECT – –           language string Language key for message. E1EDPT1/TSSPRAS – –           languageCode string ISO language code for message. E1EDPT1/TSSPRAS\_ISO – –           textFormatCode string Format code for free text. E1EDPT2/TDFORMAT – –           freeFormText string Free text array. E1EDPT2/TDLINE – LIN/FTX040-010 when FTX010 =AAI       canonicalInvoiceSummary array Summary totals in invoice. – – –         summaryType (1) string Type of summary.

Valid values include:

- `AMOUNTQUALIFYINGFORDISCOUNT`
- `BILLEDVALUE`
- `NUMBEROFITEMS`
- `TOTALNETVALUE`
- `TOTALSALESTAX`
- `TOTALAMOUNT`
 
  E1EDS01/SUMID – UNH/MOA010-010 =

- 128 (TOTALAMOUNT) Or
- 124 (TOTALSALESTAX) Or
- 125 (TOTALNETVALUE) Or
- 129 (AMOUNTQUALIFYINGFORDISCOUNT)
 
          summaryType (2) string Type of summary.

 Valid values include:

- `VAT` - Value Added Tax
- `GOODSANDSERVICES` - Total Tax
- `STATESALES` - State/provincial sales tax
- `CITYSALES` - Local Sales Tax
- `CUSTOMSDUTY` - Import Tax
- `SURTAX` - Other Taxes
 
  – – UNH/TAX020-010 =

- VAT (VAT) Or
- TOT (GOODSANDSERVICES) Or
- STT (STATESALES) Or
- LOC (CITYSALES) Or
- IMP (CUSTOMSDUTY) Or
- OTH (SURTAX)
 
          summaryValue (1) string Value in summary to map it to summary total amounts or tax. E1EDS01/SUMME TDS01 when summaryType = TOTALAMOUNT UNH/MOA010-020 when summaryType = TOTALAMOUNT or TOTALSALESTAX or TOTALNETVALUE or AMOUNTQUALIFYINGFORDISCOUNT         summaryValue (2) string Value in summary to map it to tax segments. – – UNH/TAX/MOA010-020 when summaryType =

- VAT or
- GOODSANDSERVICES or
- STATESALES or
- CITYSALES or
- CUSTOMSDUTY or
- SURTAX
 
UNH/TAX/MOA010-010 = 124

          summaryValue (3) – Value in summary to map it to segment count. – CTT01 when summaryType = NUMBEROFITEMS UNH/CNT01-020 when summaryType = NUMBEROFITEMS         summaryUnit string Unit of measure or currency or other unit for summary value. E1EDS01/SUNIT – UNH/TAX050.040    

 

 



 

 

 

 

#### Table of contents