Tracelink University ## Breadcrumb 1. [Home](/) 2. [Resources](/resources/resource-center) 3. [TraceLink University](/resources/tracelink-university) # Purchase order canonical guidelines - [Download PDF](/node/628506/pdf) - [Share](#) - [ LinkedIn ](https://www.linkedin.com/shareArticle?mini=true&url=https://www.tracelink.com/resources/tracelink-university/purchase-order-canonical-guidelines-0&title=Purchase order canonical guidelines&summary=Purchase orders allow companies to exchange data about requests to purchase goods and services with upstream and downstream supply chain trade partners 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/purchase-order-canonical-guidelines-0&t=Purchase order canonical guidelines "Facebook") - [ Mail ](mailto:?subject=Purchase order canonical guidelines+|+TraceLink&body=https://www.tracelink.com/resources/tracelink-university/purchase-order-canonical-guidelines-0 "Mail") - [ Twitter ](https://twitter.com/intent/tweet?text=Purchase order canonical guidelines https://www.tracelink.com/resources/tracelink-university/purchase-order-canonical-guidelines-0&via=TraceLink "Twitter") #### Table of contents Purchase orders allow companies to exchange data about requests to purchase goods and services with upstream and downstream supply chain trade partners without giving these trade partners access to their serialization system of record. These purchase orders can be used to request specific products and quantities from their Partners and confirm that partners have the requested product and quantities on hand and intend to fulfill the request via a purchase order acknowledgment. [![Closed](/sites/default/files/tech_comms/mpl-canonical/Skins/Default/Stylesheets/Images/transparent.gif)Canonical guidelines](#) Canonical Element Type Definition Description IDoc mapping X12 mapping EDIFACT mapping canonicalPurchaseOrder - Object type/root element. - - - networkNodeId - Identifies network node Id of application owner. - - - reportHeader - Control header for canonical. These elements will not be mapped. - - - eventCorrelationIdentifier string Identifier that associates transition message event to data mesh fact message event. - - - B2BTransactionType string B2B transaction type for the canonical message instance. Enumerations to come. - - - eventDateTime datetime Date file created in XML datetime format YYYY-MM-DDTHH:MM:SS.sssz. - - - canonicalControlFileHeader - 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 purchase order canonical. - - - base64DecodedData string Attribute to store base64 string decoded from a binary input file, digital signature, etc. - MSG01 appended to ST … SE loop in map - customFields array Name value pairs for mapping pass through elements that will not be processed in TL system at different level. - - - name string Name of mapped field. - - - value string Value in named field. - - - canonicalPurchaseOrderHeader - Purchase order business partner lists. - - - processingFunctionTypeCode string Purpose of purchase order. Tells receiving system function of purchase. Valid values: - `CREATE` - Create new customer PO in supplier's system - `CHANGE` - Change existing customer PO in supplier's system - `CONFIRM` - Purchase Order confirmation/acknowledgement from supplier's system - `CANCEL` - Cancel purchase order - `CORRECTION` - Correction to purchase order Valid values: - `000 (NONE)` - E1EDK01/ACTION - `001` - (REVERSE) - `002` - (CHANGE) - `003` - (CHANGES TO ITEMS) - `004` - (CHANGES TO HEADER AND ITEMS) Valid values BAK01: - `00` - (ORIGINAL) or - `01` - (CANCEL) or - `02` - (CREATE) - `04` - (CHANGE) or - `06` - (CONFIRM) or - `CO` - (CORRECTION) Valid values BGM03: - `1` - (CANCEL) or - `4` - (CHANGE) or - `6` - (CONFIRM) or - `9` - (CREATE) purchaseOrderType string Purchase order type in ordering party's ERP system. Valid values: - `BLANKETORDER` - Blanket order - `CATALOGORDER` - Catalog order - `CONSIGNMENTORDER` - Consignment order - `CONTRACT` - Contract - `DROPSHIPORDER` - Drop ship order - `PURCHASEORDER` - Standard purchase order - `PURCHASEREQUISITION` - Purchase requisition - `REPAIR` - Repair order - `REQUESTFORQUOTATION` - Request for quotation (RFQ) - `SAMPLEORDER` - Sample order - `SCHEDULINGAGREEMENT` - Scheduling agreement - `SPOTORDER` - Spot order - `STANDINGORDER` - Standing order - `SALESORDER` - Sales order - Valid values: BEG02 - Canonical Enumeration: - `BK` - BLANKETORDER - `CO` - CATALOGORDER - `CN` - CONSIGNMENTORDER - `KC` - CONTRACT - `DS` - DROPSHIPORDER - `LS` - LEASE - `NE` - NEWORDER - `KN` - PURCHASEORDER - `RR` - REPAIR - `SP` - SAMPLEORDER - `SA` - STANDALONEORDER - `ST` - STANDINGORDER - acknowledgmentRequired boolean Purchase order acknowledgment required flag. Valid values: - `True` - PO Acknowledgment required . - `False` - No acknowledgment required .(default) - - - orderStatusCode string Purchase order status code. Valid values: - `ALLOCATED` - `BLOCKED` - `CANCELLED` - `CLAIMED` - `BOOKED` - - - isShipmentCancelled boolean Shipment canceled flag. Valid values: - `True`- shipment is canceled - `False` - shipment is not cancelled (default) - - - lastChangeDate string Date of last change to purchase order as a whole in date format YYYY-MM-DD. - - - epochLastChangeDate integer Date of last change to purchase order as a whole in epoch date time format. - - - warehouseIdentifier string Warehouse identifier. - - - shipmentClosureStatus string Shipment closure status. Valid values: - `CLOSEDCODE` - `CLOSEDFORINVOICE` - `CLOSED` - `OPEN` - `FINALLYCLOSED` - ` CLOSEDFORRECEIVING` - - - transactionReferenceIdentifierList array Transaction references for purchase orders and PO change, and PO confirmations at header level. - X12 mapping - b2bTransactionIdentifierType string Referenced document type. Valid values: - `PURCHASEORDER` (required) - `CONTRACT` - `DOCUMENT` - `RELEASE` - `SALESORDER` - `DEAORDER` - `DEAIDENTIFIER` - `DEAPREVIOUSIDENTIFIER` - `DEAREPLACEMENTIDENTIFIER` - `DEACERTIFICATE ` - `SUPPLIERNUMBER` - Valid values: - BEG03 maps to PURCHASEORDER - BEG04 maps to RELEASE - BEG06 maps to CONTRACT - REF01 - `DM` - (DOCUMENT) or - `D1` - (DEACSOSORDER) or - `DH` - (DEAIDENTIFIER) or - `P2` - (DEAPREVIOUSIDENTIFIER) or - `QD` - DEAREPLACEMENTIDENTIFIER) or - `DEA` - (DEACERTIFICATE) - `VR` - (SUPPLIERNUMBER) - b2bTransactionIdentifierValue string Reference order identifier value. - - - lineItemNumber string Line item number in customer purchase order. Line item level only. - - - transactionDate date Transaction date in canonical date format YYYY-MM-DD. - BEG05 maps to PURCHASEORDER transactionDate - epochTransactionDate date Transaction date in epoch date format YYYY-MM-DD. - - - purchaseOrderDates array Reference dates at header level. - - - dateType string Referenced date type. Valid values: - `CANCELBY` - `DELIVERYREQUESTED` - `DOCUMENT` - `ESTIMATEDDELIVERY` - `SCHEDULEDDELIVERY` - `SHIPMENTREQUESTED` - - - dateValue date Date time defined by referenced date type. - - - timeZone string Time zone for referenced dates. - - - mpcCurrency array Currency codes for purchase order. E1EDK01 X12 CUR - currencyCode string Currency code for pricing in price catalog. CURCY Map X12 qualifier, no conversion. - exchangeRateCurrencyCode string Currency code for currency exchange. - - - exchangeRate number Exchange rate for conversion from currencyCode to currencyCodeExchange. WKURS - - validityDate date Validity date for exchange rate. - - - orderCurrencyExchangeRate number Purchase order currency exchange rate between the order currency and the accounting currency. WKURS\_M - - currencyEntityCode string Currency Entity Code. - Map X12 qualifier, noconversion. - companyLocationContactInformation array Contact information for party business or location. - - - contactCode string Contact code. Valid values: - `EDICOORDINATOR` - EDI coordinator - `BUYER` - Buyer Name or Department - Valid values PER01: - `BD` - (BUYER) or - `EA` - (EDICOORDINATOR) - contactName string Contact name. - PER02 - contactTitle string Title of contact. - N/A - contactPhone string Contact phone number. - PER04 - contactEmail string Contact email address. - PER06 - manufacturerBusinessInformation - Manufacturing business party types, identifiers and address information. - - - businessName string Business name for manufacturing party. - - - additionalBusinessName string Additional business name or overflow of business name. - - - mpcCompanyLocationIdentifierList array List of identifiers and identifier types for the business party. - - - companyIdentifierType string Company identifier type for business partner. - - - companyIdentifierValue string Company identifier value for business partner. - - - alternateCompanyLocationIdentifierValue string Company location UUID for partner. - - - address - Manufacturing business 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 array Contact information for party business or location. - - - contactName string Contact name. - - - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - - - contactEmail string Contact email address. - - - mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. E1EDKA1 - - 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. ORGTX - - groupCode string Code identifying group responsible for generating the message. PAGRU - - language string Language key for message. SPRAS - - languageCode string ISO language code for message. SPRAS\_ISO - - referenceIdentifier string Partner reference identifier. IHREZ - - supplierBusinessInformation - Supplier business party types, identifiers and address information. E1EDKA1 PARVW - LF - - businessName string Business name for supplier party. NAME1 N102 - additionalBusinessName string Additional business name or overflow of business name. NAME2 - - mpcCompanyLocationIdentifierList array List of identifiers and identifier types for the business party. - N101-SU(Supplier) Or VN(Vendor) - companyIdentifierType string Company identifier type for business partner. - N103 where N101-SU or VN N103 - Canonical Enumeration - `1` - DUNS - `9` - DUNS4 - `11` - DEA - `21` - HIN - `91` - COMPANYID - `92` - COMPANYSITEID - `UL` - GLN - companyIdentifierValue string Company identifier value for business partner. PARTN N104 - alternateCompanyLocationIdentifierValue string Company location UUID for partner. LIFNR - - address - Manufacturing business party address information. - - - address1 string Main street address. STREET N301 - address2 string Supplemental street address. - N302 - city string City. CITY1 N401 - district string District. - - - state string State or region code. - N402 - postalCode string Postal code. POST\_CODE1 N403 - country string Country code. COUNTRY N404 - telephone string Telephone number. TELF1 - - 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. HOUSE\_NUM1 - - township string Township. - - - premisesCode string Premises code. - - - companyLocationContactInformation array Contact information for party business or location. - - - contactName string Contact name. - - - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - - - contactEmail string Contact email address. - - - mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. E1EDKA1 - - 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. ORGTX - - groupCode string Code identifying group responsible for generating the message. PAGRU - - language string Language key for message. SPRAS - - languageCode string ISO language code for message. SPRAS\_ISO - - referenceIdentifier string Partner reference identifier. IHREZ - - customerBusinessInformation - Customer business party types, identifiers and address information. E1EDKA1 PARVW - AG N101 - BY (Buyer) - businessName string Business name for customer or sold to party. NAME1 N102 wher N101 - BY - additionalBusinessName string Additional business name or overflow of business name. NAME2 - - mpcCompanyLocationIdentifierList array List of identifiers and identifier types for the business party. - - - companyIdentifierType string Company identifier type for business partner. - N103 where N101-BY N103 - Canonical Enumeration - `1` - DUNS - `9` - DUNS4 - `11` - DEA - `21` - HIN - `91` - COMPANYID - `92` - COMPANYSITEID - `UL` - GLN - companyIdentifierValue string Manufacturing business partner name. PARTN N104 - alternateCompanyLocationIdentifierValue string Company location UUID for partner. LIFNR - - address - Manufacturing business party address information. - - - address1 string Main street address. STREET N301 - address2 string Supplemental street address. - N302 - city string City. CITY1 N401 - district string District. - - - state string State or region code. - N402 - postalCode string Postal code. POST\_CODE1 N403 - country string Country code. COUNTRY N404 - telephone string Telephone number. TELF1 - - 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. HOUSE\_NUM1 - - township string Township. - - - premisesCode string Premises code. - - - companyLocationContactInformation array Contact information for party business or location. - X12 PER where PER01 - `OC` - (Order Contact) or - `PM` - (Product Manager) - contactName string Contact name. - PER02 - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - PER04 where PER04 - TE - contactEmail string Contact email address. - PER06 where PER06 - EM - mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. E1EDKA1 - 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. ORGTX - - groupCode string Code identifying group responsible for generating the message. PAGRU - - language string Language key for message. SPRAS - - languageCode string ISO language code for message. SPRAS\_ISO - - referenceIdentifier string Partner reference identifier. IHREZ - - shipFromLocationInformation - Ship from location party types, identifiers and address information. - N101-SF (Ship From) - businessName string Business name for ship from party location. - N102 where N101 - SF - additionalBusinessName string Additional business name or overflow of business name. - - - mpcCompanyLocationIdentifierList array List of identifiers and identifier types for the business party. - - - companyIdentifierType string Company identifier type for business partner. - N103 where N101-SF N103 - Canonical Enumeration - `1` - DUNS - `9` - DUNS4 - `11` - DEA - `21` - HIN - `91` - COMPANYID - `92` - COMPANYSITEID - `UL` - GLN - companyIdentifierValue string Manufacturing business partner name. - N104 - alternateCompanyLocationIdentifierValue string Company location UUID for partner. - - - address - Manufacturing business party address information. - - - address1 string Main street address. - N301 - address2 string Supplemental street address. - N302 - city string City. - N401 - district string District. - - - state string State or region code. - N402 - postalCode string Postal code. - N403 - country string Country code. - N404 - 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 array Contact information for party business or location. - - - contactName string Contact name. - - - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - - - contactEmail string Contact email address. - - - 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. - - - shipToLocationInformation - Ship to location party types, identifiers and address information. E1EDKA1 PARVW = WE N101 = ST - businessName string Business name for ship to party location. NAME1 N102 where N101=ST - additionalBusinessName string Additional business name or overflow of business name. NAME2 - - mpcCompanyLocationIdentifierList array List of identifiers and identifier types for the business party. - - - companyIdentifierType string Company identifier type for business partner. - N103 where N101=ST N103 = Canonical Enumeration - `1` - DUNS - `9` - DUNS4 - `11` - DEA - `21` - HIN - `91` - COMPANYID - `92` - COMPANYSITEID - `UL` - GLN - companyIdentifierValue string Manufacturing business partner name. PARTN N104 - alternateCompanyLocationIdentifierValue string Company location UUID for partner. LIFNR - - address - Manufacturing business party address information. - - - address1 string Main street address. STREET N301 - address2 string Supplemental street address. N/A N302 - city string City. CITY1 N401 - district string District. - - - state string State or region code. - N402 - postalCode string Postal code. POST\_CODE1 N403 - country string Country code. COUNTRY N404 - telephone string Telephone number. TELF1 - - 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. HOUSE\_NUM1 - - township string Township. - - - premisesCode string Premises code. - - - companyLocationContactInformation array Contact information for party business or location. - - - contactName string Contact name. - - - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - - - contactEmail string Contact email address. - - - mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. E1EDKA1 - 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. ORGTX - - groupCode string Code identifying group responsible for generating the message. PAGRU - - language string Language key for message. SPRAS - - languageCode string ISO language code for message. SPRAS\_ISO - - referenceIdentifier string Partner reference identifier. IHREZ - - endCustomerBusinessInformation - End customer business party types, identifiers and address information. - - - businessName string Business name for end customer party. - - - additionalBusinessName string Additional business name or overflow of business name. - - - mpcCompanyLocationIdentifierList array List of identifiers and identifier types for the business party. - - - companyIdentifierType string Company identifier type for business partner. - - - companyIdentifierValue string Manufacturing business partner name. - - - alternateCompanyLocationIdentifierValue string Company location UUID for partner. - - - address - Manufacturing business 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 array Contact information for party business or location. - - - contactName string Contact name. - - - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - - - contactEmail string Contact email address. - - - 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. - - - distributorBusinessInformation - Distributor business party types, identifiers and address information. - - - businessName string Business name for distributor party. - - - additionalBusinessName string Additional business name or overflow of business name. - - - mpcCompanyLocationIdentifierList array List of identifiers and identifier types for the business party. - - - companyIdentifierType string Company identifier type for business partner. - - - companyIdentifierValue string Manufacturing business partner name. - - - alternateCompanyLocationIdentifierValue string Company location UUID for partner. - - - address - Manufacturing business 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 array Contact information for party business or location. - - - contactName string Contact name. - - - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - - - contactEmail string Contact email address. - - - 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. - - - billToBusinessInformation - Bill to business party types, identifiers and address information. E1EDKA1 PARVW = RE N101 = BT (Bill To) - businessName string Business name for bill to party. NAME1 N102 where N101 = BT - additionalBusinessName string Additional business name or overflow of business name. NAME2 - - mpcCompanyLocationIdentifierList array List of identifiers and identifier types for the business party. - - - companyIdentifierType string Company identifier type for business partner. - N103 where N101=BT N103 = Canonical Enumeration - `1` - DUNS - `9` - DUNS4 - `11` - DEA - `21` - HIN - `91` - COMPANYID - `92` - COMPANYSITEID - `UL` - GLN - companyIdentifierValue string Manufacturing business partner name. PARTN N104 where N101=BT - alternateCompanyLocationIdentifierValue string Company location UUID for partner. LIFNR - - address - Manufacturing business party address information. - - - address1 string Main street address. STREET N301 - address2 string Supplemental street address. - N302 - city string City. CITY1 N401 - district string District. - - - state string State or region code. - N402 - postalCode string Postal code. POST\_CODE1 N403 - country string Country code. COUNTRY N404 - telephone string Telephone number. TELF1 - - 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. HOUSE\_NUM1 - - township string Township. - - - premisesCode string Premises code. - - - companyLocationContactInformation array Contact information for party business or location. - - - contactName string Contact name. - - - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - - - contactEmail string Contact email address. - - - mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. E1EDKA1 - - 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. ORGTX - - groupCode string Code identifying group responsible for generating the message. PAGRU - - language string Language key for message. SPRAS - - languageCode string ISO language code for message. SPRAS\_ISO - - referenceIdentifier string Partner reference identifier. IHREZ - - remitToBusinessInformation - Remit to business party types, identifiers and address information. E1EDKA1 PARVW = RS - - businessName string Business name for remit to party. NAME1 - - additionalBusinessName string Additional business name or overflow of business name. NAME2 - - mpcCompanyLocationIdentifierList array List of identifiers and identifier types for the business party. - - - companyIdentifierType string Company identifier type for business partner. - - - companyIdentifierValue string Manufacturing business partner name. PARTN - - alternateCompanyLocationIdentifierValue string Company location UUID for partner. LIFNR - - address - Manufacturing business party address information. - - - address1 string Main street address. STREET - - address2 string Supplemental street address. - - - city string City. CITY1 - - district string District. - - - state string State or region code. - - - postalCode string Postal code. POST\_CODE1 - - country string Country code. COUNTRY - - telephone string Telephone number. TELF1 - - 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. HOUSE\_NUM1 - - township string Township. - - - premisesCode string Premises code. - - - companyLocationContactInformation array Contact information for party business or location. - - - contactName string Contact name. - - - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - - - contactEmail string Contact email address. - - - mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. E1EDKA1 - - 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. ORGTX - - groupCode string Code identifying group responsible for generating the message. PAGRU - - language string Language key for message. SPRAS - - languageCode string ISO language code for message. SPRAS\_ISO - - referenceIdentifier string Partner reference identifier. IHREZ - - storeNumberBusinessInformation - Remit to business party types, identifiers and address information. - N101 = SN (Store Number) - businessName string Business name for store location. - N102 where N101 = SN - additionalBusinessName string Additional business name or overflow of business name. - - - mpcCompanyLocationIdentifierList array List of identifiers and identifier types for the business party. - - - companyIdentifierType string Company identifier type for business partner. - N103 where N101=SN N103 = Canonical Enumeration - `1` - DUNS - `9` - DUNS4 - `11` - DEA - `21` - HIN - `91` - COMPANYID - `92` - COMPANYSITEID - `UL` - GLN - companyIdentifierValue string Manufacturing business partner name. - N104 where N101 = SN - alternateCompanyLocationIdentifierValue string Company location UUID for partner. - - - address - Manufacturing business party address information. - - - address1 string Main street address. - N301 - address2 string Supplemental street address. - N302 - city string City. - N401 - district string District. - - - state string State or region code. - N402 - postalCode string Postal code. - N403 - country string Country code. - N404 - 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 array Contact information for party business or location. - - - contactName string Contact name. - - - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - - - contactEmail string Contact email address. - - - 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. - - - carrierInformation array Carrier business party types, identifiers and address information. E1EDKA1 PARVW = SP N101=CA (Carrier) - businessName string Business name for carrier party. NAME1 N102 where N101 = CA - additionalBusinessName string Additional business name or overflow of business name. NAME2 - - mpcCompanyLocationIdentifierList array List of identifiers and identifier types for the business party. - - - companyIdentifierType string Company identifier type for business partner. - N103 where N101=CA N103 = Canonical Enumeration - `1` - DUNS - `9` - DUNS4 - `11` - DEA - `21` - HIN - `91` - COMPANYID - `92` - COMPANYSITEID - `UL` - GLN - companyIdentifierValue string Manufacturing business partner name. PARTN N104 where N101=CA - alternateCompanyLocationIdentifierValue string Company location UUID for partner. LIFNR - - address - Manufacturing business party address information. - - - address1 string Main street address. STREET N301 - address2 string Supplemental street address. N/A N302 - city string City. CITY1 N401 - district string District. - - - state string State or region code. - N402 - postalCode string Postal code. POST\_CODE1 N403 - country string Country code. COUNTRY N404 - telephone string Telephone number. TELF1 - - 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. HOUSE\_NUM1 - - township string Township. - - - premisesCode string Premises code. - - - companyLocationContactInformation array Contact information for party business or location. - - - contactName string Contact name. - - - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - - - contactEmail string Contact email address. - - - mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. E1EDKA1 - - 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. ORGTX - - groupCode string Code identifying group responsible for generating the message. PAGRU - - 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 and ship to business party types, identifiers and address information. - N101 - BS (Bill To Ship To) - businessName string Business name for Bill to and Ship To party. - N102 where N101 = BS - additionalBusinessName string Additional business name or overflow of business name. - - - mpcCompanyLocationIdentifierList array List of identifiers and identifier types for the business party. - - - companyIdentifierType string Company identifier type for business partner. - N103 where N101=BT N103 = Canonical Enumeration - `1` - DUNS - `9` - DUNS4 - `11` - DEA - `21` - HIN - `91` - COMPANYID - `92` - COMPANYSITEID - `UL` - GLN - companyIdentifierValue string Company identifier value for business partner. - N104 where N101=BS - alternateCompanyLocationIdentifierValue string Company location UUID for partner. - - - address - Bill and ship To business party address information. - - - address1 string Main street address. - N301 - address2 string Supplemental street address. - N302 - city string City. - N401 - district string District. - - - state string State or region code. - N402 - postalCode string Postal code. - N403 - country string Country code. - N404 - 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 array Contact information for party business or location. - - - contactName string Contact name. - - - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - - - contactEmail string Contact email address. - - - 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. - - - orderedByBusinessInformation - Ordered by business party types, identifiers and address information. - N101 = OB (Ordered By) - businessName string Business name for ordered by party. - N102 where N101 = OB - additionalBusinessName string Additional business name or overflow of business name. - - - mpcCompanyLocationIdentifierList array List of identifiers and identifier types for the business party. - - - companyIdentifierType string Company identifier type for business partner. - N103 where N101=OB N103 = Canonical Enumeration - `1` - DUNS - `9` - DUNS4 - `11` - DEA - `21` - HIN - `91` - COMPANYID - `92` - COMPANYSITEID - `UL` - GLN - companyIdentifierValue string Company identifier value for business partner. - N104 where N101=OB - alternateCompanyLocationIdentifierValue string Company location UUID for partner. - - - address - Ordered by business party address information. - - - address1 string Main street address. - N301 - address2 string Supplemental street address. - N302 - city string City. - N401 - district string District. - - - state string State or region code. - N402 - postalCode string Postal code. - N403 - country string Country code. - N404 - 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 array Contact information for party business or location. - - - contactName string Contact name. - - - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - - - contactEmail string Contact email address. - - - 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. - - - siteLocationInformation - Site Location business party types, identifiers and address information. - - - businessName string Business name for ordered by party. - - - additionalBusinessName string Additional business name or overflow of business name. - - - mpcCompanyLocationIdentifierList array List of identifiers and identifier types for the business party. - - - companyIdentifierType string Company identifier type for business partner. - - - companyIdentifierValue string Company identifier value for business partner. - - - alternateCompanyLocationIdentifierValue string Company location UUID for partner. - - - address - Business Site location 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 array Contact information for party business or location. - - - contactName string Contact name. - - - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - - - contactEmail string Contact email address. - - - 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. - - - purchaseOrderOrganization array Organization identifiers sent from trading partner's ERP system. E1EDK14 - - organizationType string Organization type. Valid values: - `DIVISION` = Division - `DISTRIBUTIONCHANNEL` - Distribution Channel - `SALESORG` - Sales Organization - `PURCHASINGGROUP` - Purchasing Group: OB from customer system - `SALESGROUP` - Sales Group - `COMPANYCODE` - Company Code - `PURCHASEORDERTYPE` - Purchase order type - `PURCHASINGORGANIZATION` - Purchasing Organization - `SALESOFFICE` - Sales office Valid values QUALF = - `003` - (DELIVERINGCOMPANYCODE) or - `004` - (PLANT) or - `006` - (DIVISION) or - `007` - (DISTRIBUTIONCHANNEL) or - `008` - (SALESORG) or - `009` - (PURCHASINGGROUP) or - `010` - (SALESGROUP) or - `011` - (COMPANYCODE) or - `013` - (PURCHASEORDERTYPE) or - `014` - (PURCHASINGORGANIZATION) or - `015` - (BILLINGTYPE) or - `016` - (SALESOFFICE) - - organizationDescription string Description of organization unit. ORGID - - termsOfPayment array Terms of payment looping group. - - - termsOfPaymentKey string Terms of payment. - - - termsOfPaymentTypeCode - Code identifying type of payment terms. Valid values: - `BASIC` - `DEFERRED` - `DISCOUNTNOTAPPLICABLE` - `ENDOFMONTH EXTENDED` - `FIXEDDATE` - `MIXED` - `PREVIOUSLYAGREED` - `PROXIMO` - `SELLER` - ITD01 = Canonical Enumeration - `01` - BASIC - `02` - ENDOFMONTH - `03` - FIXEDDATE - `04` - DEFERRED - `05` - DISCOUNTNOTAPPLICABLE - `06` - MIXED - `07` - EXTENDED - `13` - SELLER - `14` - PREVIOUSLYAGREED - `15` - PROXIMO - termsOfPaymentDateBasis string Code identifying the beginning of the terms period. Valid values: - `DELIVERYDATE` - `EFFECTIVEDATE` - `INVOICEDATE` - `INVOICERECEIPTDATE` - `PURCHASEORDERDATE` - `SHIPDATE` - ITD02 = Canonical Enumerations - `1` - SHIPDATE - `2` - DELIVERYDATE - `3` - INVOICEDATE - `5` - INVOICERECEIPTDATE - `7` - EFFECTIVEDATE - `09` - PURCHASEORDERDATE - numberOfDays string Terms of payment: number of days. - ITD07 - termsOfPaymentPercent string Terms of payment: percentage. - ITD03 - invoicePayablePercent string Percentage of invoice payable. - ITD11 - paymentDueDate date Due date for payment. - ITD06 - store in canonical in date format \[YYYY-MM-DD\] - paymentDeferredToDate date Date deferred payment or percent of invoice payable is due. - ITD09 - store in canonical in date format \[YYYY-MM-DD\] - paymentDeferredDueAmount number Deferred amount due for payment. - ITD10 - description string Terms of payment description. - ITD12 - discountDueDate string Discount due date. - ITD04 - store in canonical in date format \[YYYY-MM-DD\] - discountDueNumberOfDays number Discount due number of days. - ITD05 - dayOfMonth string Day of month. - ITD13 - creditsAndCharges array Credits and charges on PO including invoice total, discounts, allowances, promotions, services, and others. - SAC - creditChargeKeyType string Key identifies credit or charges as discounts or additional charges. Valid values: - `ALLOWANCE ` - `CHARGE` - `PROMOTION` - SAC01 - Canonical Enumerations - `A` - ALLOWANCE - `C` - CHARGE - `N` - NONE - creditChargeType string Code representing type of credit or charge. - SAC02 See note for Conversion Table - creditChargeAmount number Total amount for the payment. - SAC05 - qualifyingAmount number Amount qualifying for cash discount, allowance, promotion, service or charge. - - - creditChargeCurrencyCode string Currency code for credit or charge. - - - creditChargePercentRate number Percentage rate for cash discount, allowance, promotion, service or charge. - SAC07 - percentRateBasisTypeCode string Code indicating basis that allowance or charge percent is calculated. - SAC06 = Canonical Enumerations - `0` - GROSS - `1` - ITEMLIST - `2` - ITEMNET - `3` - DISCOUNTGROSS - `4` - DISCOUNTNET - `5` - BASEUNITPRICE - `6` - BASEPRICE - `7` - BASEPRICELESSDISCOUNT - `8` - NETMONTHLYPASTDUE - `9` - LATEPAYMENT - `B` - ITEMTOTAL - `C` - ITEMUNIT - `D` - TOTAL - creditChargeHandlingCode - Method of handling for discount or charge. Valid values: - `ADVANCE` - `CANCELALLOWANCE` - `COLLECT` - `CREDITCUSTOMER` - `GROSSINVOICED` - `INFORMATION` - `PREPAID` - `RESELLERALLOWANCE` - `VENDORPAID` - SAC12 = Canonical Enumerations - `01` - BILLBACK - `02` - OFFINVOICE - `04` - CREDITCUSTOMER - `05` - VENDORPAID - `06` - CUSTOMERPAID - `07` - OPTIONAL - `08` - GROSSINVOICED - `09` - VENDORALLOWANCE - `10` - RESELLERALLOWANCE - `11` - VENDORDENIED - `12` - CANCELALLOWANCE - `15` - INFORMATION - `18` - TAXNONPAYABLE - `25` - ADVANCE - `CA` - CALCULATE - `CC` - COLLECT - `PP` - PREPAID - description string Description of credit or charge. - - - 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 values: - `VAT` - `HARMONIZEDSALES` - `FEDERALEXCISE` - `STATESALES` - `PROVINCIALSALES ` - `CITYSALES` - `COUNTYSALES` - `GOODSANDSERVICES` - `CUSTOMSDUTY` - `SURTAX` TAX020-010 valid values: - `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 vat Indicator is missing TXI01 = Canonical enumeration - `CS` - CITYSALES - `CT` - COUNTYSALES - `CG` - CUSTOMSDUTY - `FD` - FEDERALEXCISE - `GS` - GOODSANDSERVICES - `BE` - HARMONIZEDSALES - `PG` - PROVINCIALSALES - `ST` - STATESALES - `AB` - SURTAX - `TX` - ALLTAXES - `VA` - VAT Valid values 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 vat Indicator is missing country string Country for which taxes are recorded. - - - taxRegistration string Tax registration number. - - - taxJurisdictionCode string Tax jurisdiction code. - TXI05 - 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. - TXI03 - 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) deliveryTerms array Terms of delivery, transport or inco terms looping group. - - - deliveryTermCode string Inco term code. - FOB04 - description string Description for inco term. - FOB03 - deliveryChargePaymentMethodType string Method of payment for delivery. NON-ENUMATED attribute . Valid values: - `ADVANCECOLLECT` - `ADVANCEPREPAID` - `BUYER` - `BUYERSELLERDEFINED` - `COLLECT` - `COLLECTDELIVERY` - `COSTFREIGHT` - `MIXED` - `NOCHARGESERVICEFREIGHT` - `PICKUP` - `PREPAIDCUSTOMER` - `PREPAIDONLY` - ` PREPAIDSELLER SELLER` - FOB01 - maps X12 Qualifier.No conversion - fobTransferLocation string Code specifying the type of location at which the risk of loss for the shipment transfers. Valid values: - `CITY PLANT` - `SHIPPINGDESTINATION` - `SHIPPINGORIGIN` - FOB02 = Canonical Enumerations - `CI` - CITY - `DE` - SHIPPINGDESTINATION - `OR` - SHIPPINGORIGIN - `PL` - PLANT - transportationInformation array Transportation information for purchase order. - - - companyIdentifierType string Company identifier type for business partner . Note: Need to create lookup fille for java exits for companyIdentifierType. - - - routingSequenceCode string Sequence code for routing. - - - transportMethod string Transportation method. Valid values: - `TRUCK` - `RAIL` - `SEA` - `AIR` - `LTL` - `AIREXPRESS` - TD504 = Canonical Enumerations - `A` - AIR - `AE` - AIREXPRESS - `H` - CUSTOMERPICKUP - `D` - GROUND - `M` - TRUCK - `R` - RAIL - `S` - SEA - `SR` - SUPPLIERTRUCK - `K` - SUPPLIERTRUCK - `X` - MULTIMODAL - shipmentOrderStatusCode string Shipment Order Status Code. - - - companyIdentifierValue string Company identifier value for business partner. - - - serviceLevelCode string Service level code. Indicates the level of transportation service or the billing service offered by the transportation carrier, including how quickly the order is to be shipped. Valid values (map rules): - `OVERNIGHT` - `NEXTMORNING` - `PRIMARYNEXTDAY1030AM` - `SECONDDAY` - `THIRDDAY` - `SATURDAYPICKUP` - Valid values TD512 : - `ON` - (OVERNIGHT) or - `NM` - (NEXTMORNING) or - `PA` - (PRIMARYNEXTDAY1030AM) or - `SE` - (SECONDDAY) or - `3D` - (THIRDDAY) or - `SP` - (SATURDAYPICKUP) - processOrderData - Overview of process order data, as required for mapping to extended IDocs provided by customers. E1EDK01/ZPROORD - - processOrderNumber string Process order identifier. AUFNR - - orderType string Order type for process order. Pass thru mapping. AUART - - plantIdentifier string Plant identifier for process order. WERKS - - itemCode string Item code identifier for finished product produced in process order. PLNBEZ - - itemDescription string Description of item produced in process order. MAKTX - - supplierLotNumber string Supplier or vendor lot number. ZLICHA - - expirationDate string Shelf life expiration or best before date for manufactured product in date format YYYYMMDD. VFDAT - - epochExpirationDate number Shelf life expiration or best before date for manufactured product in epoch date format. - - - dateFormat string Date format for formatted expiration date. Pass thru mapping. ZEXPFM - - adjustedExpirationDate string Expiration date as formatted by date format attribute. VFDATTXT - - quantity number Total quantity for process order. GAMNG - - unitOfMeasure string Unit of measure for total order quantity. Quantity UOMs include: - `EA` - Thousand eaches - `CA` - Case - `CP`- Crate - `CT`- Carton - `DS` - Display - `DZ` - Dozen - `EA` - Each - `PH` - Pack - `PC` - Piece - `PF` - Pallet - `PK` - Package - `T3` - Thousand Pieces - `TH` - Thousand - `TY` - Tray - `UN` - Unit GMEIN - - packageSize string Packaging size for item in process order. MA\_PACKAGING\_SIZE - - packagingType string Type of packaging for item produced through process order. MA\_PACKAGING\_TYPE - - countryCode string Country code for process order. MA\_COUNTRY\_MAT - - strength string Product strength. MA\_STRENGTH - - dosageForm string Dosage form. MA\_DOSAGE\_FORM - - articleFamilyCode string Article family code. MA\_PROD\_FAM - - productionVersion string Production version. VERID - - description string Production version description. TEXT1 - - isSerialized boolean Boolean identifying if serialization is relevant to the item in the process order. Valid values: - `True` - X - serialization is relevant - `False` - not mapped (default) ZZSERIALIZATION\_REL - - sampleQuantity number Reference sample quantity ZZREFSAMPLEQTY - - isSamplingApplicable boolean Boolean determining if reference sampling is applicable. Valid values: - `True` - X - reference sampling is applicable - `False` - not mapped (default) ZZREFSAMPLAPPL - - stabilitySampleQuantity number - ZZSTABSAMPLEQTY - - isOngoingStablilitySampling boolean Boolean determining if ongoing stability sampling is applicable. Valid values: - `True` - X - Ongoing stability sampling is applicable - `False` - Not mapped (default) ZZSTABSAMPLAPPL - - mpcDates array Basic finish and start dates for process order. - DTM - dateType string Date type for process order. Valid values: - `BASICFINISH` - `BASICSTART` - `DELIVERYREQUESTED` - `PURCHASEORDER` - `SHIPMENTREQUESTED` - `SHIPPED` - `ESTIMATEDDELIVERY` - `AVAILABILITY` - `EXPIRATION` - `CANCELBY` dateType - BASICFINISH or BASICSTART DTM01 - Canonical Enumerations - `002` - DELIVERYREQUESTED - `004` - PURCHASEORDER - `010` - SHIPMENTREQUESTED - `011` - SHIPPED - `017` - ESTIMATEDDELIVERY - `018` - AVAILABILITY - `036` - EXPIRATION - `061` - CANCELBY - dateValue string Date value for finish or start of production as defined by dateType in date format YYYYMMDD. GLTRP - BASICFINISH GSTRP - BASICSTART DTM02 Date stored in format \[YYYY-MM-DDTHH:MM:SS.nnnZ.\] or \[YYYY-MM-DD\] - epochDateValue number Date value for finish or start of production in Epoch date format. - - - timeZone string Time zone for dates reported. - - - processOrderComponentList array List of components used to produce finished item in process order. ZPROORD/ZPOCOMP - - componentIdentifier string Component item identifier. MATNR - - itemDescription string Description of component item. MAKTX - - lotNumber string Lot of batch number for component item. CHARG - - quantity number Quantity of component item required for process order. BDMNG - - unitOfMeasure string Unit of measure for total order quantity. Quantity UOMs include: - `CA` - Case - `CP` - Crate - `CT` - Carton - `DS` - Display - `DZ` - Dozen - `EA`- Each - `PH` - Pack - `PC` - Piece - `PF` - Pallet - `PK` - Package - `T3` - Thousand Pieces - `TH` - Thousand - `TY` - Tray - `UN` - Unit MEINS - - shipToLocationInformation - Delivery address for sales order or stock transfer order used to generate process order. ZPROORD/ZSHIPTO - - businessName string Business name for ship to party location. NAME1 - - additionalBusinessName string Additional business name or overflow of business name. NAME2 - - mpcCompanyLocationIdentifierList array List of identifiers and identifier types for the business party. - - - companyIdentifierType string Company identifier type for business partner. - - - companyIdentifierValue string Manufacturing business partner name. - - - alternateCompanyLocationIdentifierValue string Company location UUID for partner. - - - address - Manufacturing business party address information. - - - address1 string Main street address. STREET - - address2 string Supplemental street address. N/A - - city string City. CITY1 - - district string District. N/A - - state string State or region code. N/A - - postalCode string Postal code. POST\_CODE1 - - country string Country code. COUNTRY - - telephone string Telephone number. TELF1 - - 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. HOUSE\_NUM1 - - township string Township. - - - premisesCode string Premises code. - - - companyLocationContactInformation array Contact information for party business or location. - - - contactName string Contact name. - - - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - - - contactEmail string Contact email address. - - - mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. ZPROORD/ZSHIPTO - - orderType string Order type for ship to party in process order. Pass thru mapping. AUART - - organizationCode string Title of contact. - - - referenceIdentifier string Contact phone number. - - - languageCode string Contact email address. - - - freeTextNote array Free text, instructions, notes, descriptions and other free text elements. Segment E1EDKT1 & E1EDKT2 X12 - textReferenceCode string Text reference or subject code. Will map whatever is found. /E1EDKT1 / TDID When REF01 - "ZZ" , store X12 qualifier from REF02 - textFunctionCode string Text function code. Will map whatever is found. /E1EDKT1 / TDOBJECT REF02 - "ZZ" (not mapped but used to indicate a note) - language string Language of free text. /E1EDKT1 / TSSPRAS\_ISO - - textFormatCode string Format code for free text. E1EDKT2 / TDFORMAT - - freeFormText string Free text array. E1EDKT2 / TDLINE When REF01 - "ZZ" , store value from REF03 Also mapps from N9/MSG01 - customFields array Name value pairs for mapping pass through elements that will not be processed in TL system at different level. - - - name string Name of mapped field. - - - value string Value in named field. - - - canonicalPurchaseOrderItemDetails array Purchase order product details array. - - - lineItemNumber string Line item number for ordered product. E1EDP01 / POSEX PO101 LIN010 processingFunctionTypeCode string Purpose of purchase order, item level. Element may appear at header or item level or both. Tells receiving system function of purchase. Valid values: - `CREATE` - Create new customer PO in supplier's system. - `CHANGE` - Change existing customer PO in supplier's system. - `CONFIRM` - Purchase order confirmation/acknowledgment from supplier's system. - `CANCEL` - Cancel order item. Valid values E1EDP01 / ACTION: - `001` - (ITEMADDED) - `002` - (ITEMCHANGED) - `003` - (CANCEL) - `004` - (ITEMNOTCHANGED) - `005` - (ITEMLOCKED) - `091` - (RECEIPT) - `093` - (RETURN) - `094` - (CONSIGNMENT) - `095` - (DAMAGEDINTRANSIT) - `096` - (CORRECTION) - - isAcknowledgmentRequired boolean Purchase order acknowledgment required at line item level flag. Valid values: - `True` - PO Acknowledgment required for item - `False` - (Default) No acknowledgment required for item - - - maximumPartialDeliveries string Maximum number of partial deliveries allowed per item - - - materialClass string Material class E1EDP01 / MATKL - - itemCategory string Item category. Populated in standard Idoc. E1EDP01 / PSTYP - - netPrice number Net price for item E1EDP01 / NETWR - - plantIdentifier string Plant identifier E1EDP01 / WERKS - - packingInstructions string Packing Instructions - - - storageConditions string Conditions for storage of materials - - - stackabilityLabel string Stack label of packaged material - - - conversionFactorToBaseUnitOfMeasure number Conversion factor for base unit of measure - - - itemCategory string Item category. Populated in standard Idoc. - - - consumptionPeriod string Allow consumption period for ordered product - - - superiorItemInHierarchy string Parent line item number in an item hierarchy HIPOS - - billToAccountIdentifier string Bill to account ID - - - shipToAccountIdentifier string Ship to account ID - - - packagingIdentifier string Packaging Identifier - - - purchaseOrderType string Purchase order type in ordering party's ERP system. Valid enumerations include: - `BLANKETORDER` - `CATALOGORDER` - `CONSIGNMENTORDER` - `CONTRACT` - `SAMPLEORDER` - `STANDALONEORDER` - `STANDINGORDER` - `SALESORDER` - - - orderLineItemStatusCode string Order Line Item Status Code - - - isBlocked boolean Blocking Reason. Valid Values: - `True` - Blocked Customer by system - `False` - Block customer manually in the system - - - isReminded boolean Reminder Management. Valid Values. - `True` - Send Reminder - `False` - No action - - - lineItemStatus string Order Line Item Status - - - isShipmentCancelled boolean Shipment cancelled flag. Valid values: - `True` - shipment is cancelled - `False` - shipment is not cancelled (default) - - - shipmentOrderStatusCode string Shipment order status code. - - - lastChangeDate string Date of last change to purchase order line item in date format YYYY-MM-DD. - - - epochLastChangeDate integer Date of last change to purchase order line item in epoch date time format. - - - warehouseIdentifier string Warehouse identifier. - - - shipmentClosureStatus string Shipment closure status. Valid values: - `CLOSEDCODE` - `CLOSEDFORINVOICE` - `CLOSED` - `OPEN` - `FINALLYCLOSED` - `CLOSEDFORRECEIVING` - - - freightTerms string Freight terms. Valid value: - `TRUCK` - `RAIL` - `SEA` - `AIR` - `LTL` - `AIREXPRESS` - - - 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. Segment E1EDP19 Product code qualifer followed by identifiers are represented in pairs from PO106 & PO107 through PO124 & PO125.. If qualifier is present, then identifier is required. Segment LIN to handle product identifiers. Product identifier details can be present in LIN and PIA segments productCodeType string Code to qualify product identifier type: - `NTIN ` - `VENDORPARTNUM` - `UPC` - `SKU` - `CUSTOMER` - `SUPPLIER` - `MANUFACTURER` Valid values E1EDP19 / QUALF -: - `001` - (CUSTOMER) or - `002` - (VENDOR) or - `003` - (GTIN14) or - `004` - (MANUFACTURER) PO106 - Canonical Code: - `VN` - SUPPLIER - `VC` - VENDOR - `UK` - GTIN14 - `PI`- CUSTOMER - `N4` - US\_NDC542 - `FN` - CA\_DIN - `UP` - UPC - `MF or MG` - MANUFACTURER - `N1` - US\_NDC442 - `N2` - US\_NDC532 - `N3` - US\_NDC541 - `SK` - SKU - `BP or IN` - BUYER Valid values LIN030-20 -: - `VN` - (SUPPLIER or VENDOR) or - `IN` - (CUSTOMER) or - `BP` - (BUYER) or - `UP` - (UPC) or - `MF` - (MANUFACTURER) productCodeValue string Product code identifier value. E1EDP19 / IDTNR PO107 LIN030-10 productItemInformation array Product item code information. Only using a subset of all available attributes. - - - productLanguageCode string Language for product description. - - - productName string Name of product. E1EDP19 / KTEXT PID05, where PID - "F" - genericName string Generic name for product. - - - productDescription string Description of the product defined by the current product identifier. - PID05 where PID01 - "F" IMD030-40, hardcode "F" to IMD010 longDescription string Long description for product. - - - itemQuantity array Order quantity at line item level. - - - quantityType string Type of quantity recorded. Valid values: - `ORDERQUANTITY` - `PRICINGUNIT` - `FIXED ` - `BASE` - `COMPONENT` - `COMPONENTBASE` - `MODELBASE` - quantity Types used in Purchase order: ITEM INNERCONTAINERS PACKAGED - quantityValue number Quantity of product at PO line item. - PO102 - unitOfMeasure string Unit of measure for quantity value. - PO103store X12 qualifier in canonical. - itemVolume array Volume of the ordered product at the line item level. - - - volumeType string Type of volume recorded for ordered product. Valid vales: - `ALLOWED` - `ALLOWEDPACKAGING` - `LOADING` - `TARE` - `TOTAL` - `TOTALPACKAGING` - - - volumeValue number Volume of the ordered product at the line item level. - - - unitOfMeasure string Unit of measure for quantity value. Use Java call-out to lookup table UOM\_TableLookup2.txt. - - - 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. - - - regulatoryLocationIdentifierType string Identifier type for quantity destination location - - - regulatoryIdentifierValue string Regulatory identifier for location - - - locationQuantityValue number This quantity is the sum of all quantity per location and per line - - - unitOfMeasure string Unit of measure for destination location quantity - - - orderPricing array Purchase order price amounts. - - - pricingType string Pricing type for invoice item. Valid pricing types include: - `UNIT` - `GROSS` - `NET` - `INVOICE` - `EXTENDED` - `RETAIL` - `TOTAL` - Pricing Types used in Purchase order: UNIT - pricingAmount number Pricing amount for pricing type defined by pricing type enumeration. - PO104 - currencyCode string Currency for pricing amount - - - priceUnitOfMeasure string Unit of measure used for pricing at the order line item level. - - - unitPriceBasisQuantity number 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. - - - itemWeight array Order weight at line item level. - - - weightType string Type of weight recorded. Valid values: - `NETWEIGHT` - `GROSSWEIGHT` - - - weightValue number Weight of product at PO line item. - - - unitOfMeasure string Unit of measure for weight value. - - - purchaseOrderDates array Purchase order dates at the item level. - - - dateType string referenced date type. Valid value is BILLING PRICING. - - - dateValue date Date defined by referenced date type. - - - timeZone string Time. - - - transactionReferenceIdentifiers array Transaction references for purchase orders and PO change, and PO confirmations at line item detail level. - - - transactionReferenceIdentifierType string Referenced document type. Valid values: - `PURCHASEORDER` - `SUPPLIERORDER` - `RELEASE` - - - transactionReferenceIdentifierValue string Reference order identifier value. - - - transactionLineItemNumber string Line item number in customer purchase order. Line item level only. - - - transactionDate date Date order created. - - - transactionTime date Time order created. - - - deliverySchedule array Delivery schedule by dates and quantities. - - - scheduledQuantity number Quantity of product to be delivered on delivery date. - - - previouslyScheduledQuantity number Quantity of product that was previously scheduled to be delivered on the delivery date. Relevant for PO acknowledgment. - - - scheduledDate date Scheduled date for delivery of scheduled quantity. - - - deliveryPriority string Delivery Priority. - - - deliveryScheduleDetails array Delivery schedule by dates and quantities. ZCMOE1EDP01 - - lineItemNumber string Line item number for purchase document. EBELP - - deliveryScheduleLineItem string Delivery schedule line item number. EBELE - - itemCode string Product item identifier. MATNR - - itemDescription string Description of product item. MAKTX - - quantity number Quantity of product in delivery schedule details. MENGE - - unitOfMeasure string Unit of measure for total order quantity. Quantity UOMs include: - `CA` - Case - `CP` - Crate - `CT` - Carton - `DS` - Display - `DZ` - Dozen - `EA` - Each - `PH` - Pack - `PC` - Piece - `PF` - Pallet - `PK` - Package - `T3` - Thousand Pieces - `TH` - Thousand - `TY` - Tray - `UN` - Unit MEINS - - deliveryToleranceDetails - Details of over and under delivery tolerance for purchase order. ZCMOE1EDP01\_2 - - underDeliveryTolerance string Under delivery tolerance for order. UNTTO - - overDeliveryTolerance string Over delivery tolerance for order. UEBTO - - description string Description of tolerance. BVTEXT - - confirmedQuantity number Confirmed quantity for tolerance. CONF\_QTY - - shipToLocationInformation - Ship to location party types, identifiers and address information. E1EDPA1 - - businessName string Business name for ship to party location. NAME1 - - additionalBusinessName string Additional business name or overflow of business name. NAME2 - - mpcCompanyLocationIdentifierList array List of identifiers and identifier types for the business party. - - - companyIdentifierType string Company identifier type for business partner. - - - companyIdentifierValue string Company location identifier for business partner. PARTN - - alternateCompanyLocationIdentifierValue string Company location UUID for partner. LIFNR - - address - Bill to business party address information. - - - address1 string Main street address. STREET - - address2 string Supplemental street address. - - - city string City. CITY1 - - district string District. - - - state string State or region code. - - - postalCode string Postal code. POST\_CODE1 - - country string Country code. COUNTRY - - telephone string Telephone number. TELF1 - - 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. HOUSE\_NUM1 - - township string Township. - - - premisesCode string Premises code. - - - companyLocationContactInformation array Contact information for party business or location. - - - contactName string Contact name. - - - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - - - contactEmail string Contact email address. - - - mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. E1EDKA1 - - 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. ORGTX - - groupCode string Code identifying group responsible for generating the message. PAGRU - - language string Language key for message. SPRAS - - languageCode string ISO language code for message. SPRAS\_ISO - - referenceIdentifier string Partner reference identifier. IHREZ - - address3 string Supplemental street address. - - - billToBusinessInformation - Bill to business party types, identifiers and address information. - - - businessName string Business name for ship to party location. - - - additionalBusinessName string Additional business name or overflow of business name. - - - mpcCompanyLocationIdentifierList array List of identifiers and identifier types for the business party. - - - companyIdentifierType string Company identifier type for business partner. - - - companyIdentifierValue string Company location identifier for business partner. - - - alternateCompanyLocationIdentifierValue string Company location UUID for partner. - - - address - Bill to business 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 array Contact information for party business or location. - - - contactName string Contact name. - - - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - - - contactEmail string Contact email address. - - - 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. - - - address3 string Supplemental street address. - - - termsOfPayment array Terms of payment looping group. - - - termsOfPaymentKey string Terms of payment. - - - paymentTypeCode - Code identifying type of payment terms. Valid values: - `BASIC` - `DEFERRED` - `DISCOUNTNOTAPPLICABLE` - `ENDOFMONTH` - `EXTENDED` - `FIXEDDATE` - `MIXED` - `PREVIOUSLYAGREED` - `PROXIMO` - `SELLER` - - - termsOfPaymentDateType string Code identifying the beginning of the terms period. Valid values: - `DELIVERYDATE` - `EFFECTIVEDATE` - `INVOICEDATE` - `INVOICERECEIPTDATE` - `PURCHASEORDERDATE` - `SHIPDATE` - - - numberOfDays string Terms of payment: number of days. - - - termsOfPaymentPercent string Terms of payment: percentage. - - - invoicePayablePercent string Percentage of invoice payable. - - - paymentDueDate date Due date for payment. - - - paymentDeferredToDate date Date deferred payment or percent of invoice payable is due. - - - paymentDeferredDueAmount number Deferred amount due for payment. - - - description string Terms of payment description. - - - creditsAndCharges array Credits and charges on PO including invoice total, discounts, allowances, promotions, services, and others. - - - creditChargeKeyType string Key identifies credit or charges as discounts or additional charges. Valid values: - `ALLOWANCE` - `CHARGE` - `PROMOTION` - SAC01 - Canonical Enumerations: - `A`- ALLOWANCE - `C`- CHARGE - `N` - NONE - creditChargeType string Code representing type of credit or charge. - SAC02 See note for Conversion Table - creditChargeAmount number Total amount for the payment. - SAC05 - qualifyingAmount number Amount qualifying for cash discount, allowance, promotion, service or charge. - - - creditChargeCurrencyCode string Currency code for credit or charge. - - - creditChargePercentRate number Percentage rate for cash discount, allowance, promotion, service or charge. - SAC07 - percentRateBasisTypeCode string Code indicating basis that allowance or charge percent is calculated. - SAC06 - Canonical Enumerations: - `0` - GROSS - `1` - ITEMLIST - `2` - ITEMNET - `3` - DISCOUNTGROSS - `4` - DISCOUNTNET - `5` - BASEUNITPRICE - `6` - BASEPRICE - `7` - BASEPRICELESSDISCOUNT - `8` - NETMONTHLYPASTDUE - `9` - LATEPAYMENT - `B` - ITEMTOTAL - `C` - ITEMUNIT - `D` - TOTAL - creditChargeHandlingCode - Method of handling for discount or charge. Valid values: - `ADVANCE` - `CANCELALLOWANCE` - `COLLECT` - `CREDITCUSTOMER` - `GROSSINVOICED` - `INFORMATION` - `PREPAID` - `RESELLERALLOWANCE` - `VENDORPAID` - SAC12 - Canonical enumerations: - `01` - BILLBACK - `02` - OFFINVOICE - `04` - CREDITCUSTOMER - `05` - VENDORPAID - `06` - CUSTOMERPAID - `07` - OPTIONAL - `08` - GROSSINVOICED - `09` - VENDORALLOWANCE - `10` - RESELLERALLOWANCE - `11` - VENDORDENIED - `12` - CANCELALLOWANCE - `15` - INFORMATION - `18` - TAXNONPAYABLE - `25` - ADVANCE - `CA` - CALCULATE - `CC` - COLLECT - `PP` - PREPAID - description string Description of credit or charge. - - - 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` - `EXCLUDINGVAT` - TXI01 - Canonical Enum - `CS` - CITYSALES - `CT` - COUNTYSALES - `CG` - CUSTOMSDUTY - `FD` - FEDERALEXCISE - `GS` - GOODSANDSERVICES - `BE` - HARMONIZEDSALES - `PG` - PROVINCIALSALES - `ST` - STATESALES - `AB` - SURTAX - `TX` - ALLTAXES - `VA` - VAT Valid values 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 vat Indicator is missing. country string Country for which taxes are recorded. - - - taxRegistration string Tax registration number. - - - taxJurisdictionCode string Tax jurisdiction code. - TXI05 - 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. - TXI03 - 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) qualifyingAmount string Qualifying amount excluding VAT. - - - deliveryTerms array Terms of delivery, transport or inco terms looping group. - - - deliveryTermCode string Inco term code. - - - description string Description for inco term. - - - 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` - - - componentProducts array Component product information. - - - customerProductCode string Customer product code identifier for component. - - - lotNumber string Lot number for component product. - - - quantity number Quantity of the component product. - - - unitOfMeasure string Unit of measure for the quantity of the component product. Use Java call-out to lookup table UOM\_TableLookup2.txt. - - - componentItemType string Type of component Item. - - - componentItemTypeDescription string Description of the item treated as component. - - - freeTextNote array Free text, instructions, notes, descriptions and other free text elements. - - - textReferenceCode string Text reference or subject code. Will map whatever is found. - - - textFunctionCode string Text function code. Will map whatever is found. - - - language string Language of free text. - - - textFormatCode string Format code for free text. - - - freeText string, array Free text array. - - - itemExtensions array Name value pairs to allow trading partners to send custom data not accommodated in canonical schema. - - - name string Name of extension field from trading partner. - - - value string Value of extension field. - - - customFields array Name value pairs for mapping pass through elements that will not be processed in TL system at different level. - - - name string Name of mapped field. - - - value string Value in named field. - - - canonicalPurchaseOrderSummary array PO transaction summaries. - - - summaryType string Type of summary. Valid value is `NETDOCUMENTVALUE`. - Summary Types in PO: - `NUMBEROFITEMS` - `LINEITEMTOTAL` - `TOTALAMOUN`T - summaryValue string Value in summary. - CTT01 for NUMBEROFITEMS - AMT02 for LINEITEMTOTAL when AMT01 - 1 - AMT02 for TOTALAMOUNT when AMT01 - TT - summaryValueUnit string Unit of measure or currency or other unit for summary value. - - - #### Table of contents ##### Related Content [ ![Related content](https://www.tracelink.com/sites/default/files/2024-09/cloud.svg) ](/resources/tracelink-university/forecast-plan-idoc) ##### Forecast plan (IDoc) Forecasting APIs allow companies to exchange data about anticipated product demand and supply availability with upstream supply chain Partners without giving these Partners access to their serialization system of record. [View More](/resources/tracelink-university/forecast-plan-idoc) [ ![Related content](https://www.tracelink.com/sites/default/files/2024-09/cloud.svg) ](/resources/tracelink-university/forecast-plan-x12) ##### Forecast plan (X12) Forecasting APIs allow companies to exchange data about anticipated product demand and supply availability with upstream supply chain Partners without giving these Partners access to their serialization system of record. [View More](/resources/tracelink-university/forecast-plan-x12) [ ![Related content](https://www.tracelink.com/sites/default/files/2024-09/cloud.svg) ](/resources/tracelink-university/forecast-plan-response-idoc) ##### Forecast plan response (IDoc) Forecasting APIs allow companies to exchange data about anticipated product demand and supply availability with downstream supply chain Partners without giving these Partners access to their serialization system of record. [View More](/resources/tracelink-university/forecast-plan-response-idoc)