Tracelink University ## Breadcrumb 1. [Home](/) 2. [Resources](/resources/resource-center) 3. [TraceLink University](/resources/tracelink-university) # CSOS validated purchase order canonical guidelines - [Download PDF](/node/628076/pdf) - [Share](#) - [ LinkedIn ](https://www.linkedin.com/shareArticle?mini=true&url=https://www.tracelink.com/resources/tracelink-university/csos-validated-purchase-order-canonical-guidelines&title=CSOS validated purchase order canonical guidelines&summary=A Controlled substance ordering system (CSOS) Validated Purchase Order is the official, DEA-approved version of an E222 Purchase order for controlled substances without the digital signature. &source=TraceLink "LinkedIn") - [ Facebook ](https://www.facebook.com/share.php?u=https://www.tracelink.com/resources/tracelink-university/csos-validated-purchase-order-canonical-guidelines&t=CSOS validated purchase order canonical guidelines "Facebook") - [ Mail ](mailto:?subject=CSOS validated purchase order canonical guidelines+|+TraceLink&body=https://www.tracelink.com/resources/tracelink-university/csos-validated-purchase-order-canonical-guidelines "Mail") - [ Twitter ](https://twitter.com/intent/tweet?text=CSOS validated purchase order canonical guidelines https://www.tracelink.com/resources/tracelink-university/csos-validated-purchase-order-canonical-guidelines&via=TraceLink "Twitter") #### Table of contents A Controlled substance ordering system (CSOS) Validated Purchase Order is the official, DEA-approved version of an E222 Purchase order for controlled substances without the digital signature. CSOS validated purchase order confirms the order for Schedule II controlled substances that has passed all required regulatory checks and is legally cleared for fulfillment. Generated by the supplier on behalf of the customer who submitted the E222 PO after successful DEA validation, CSOS Validated PO serves as the trigger for the next steps in the supply chain, such as inventory allocation, shipment preparation, and billing. A validated PO retains all original order details, including the purchase order number, buyer DEA number, item list, quantities, and shipping information, ensuring complete traceability and compliance. [![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 canonicalCSOSValidatedPurchaseOrder - Object type/root element. - - - 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. - - - 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 Use Java call-out table CL\_ProcessingFunctionTypeCode.txt. - BEG01 - 00 (ORIGINAL) or - 01 (CANCEL) or - 02 (CREATE) 04 (CHANGE) or - 06 (CONFIRM) or - CO (CORRECTION) Use Java call-out table CL\_ProcessingFunctionTypeCode.txt - purchaseOrderType string Purchase order type in ordering party's ERP system. Valid enumerations include: - `PURCHASEORDER` - `CONSIGNMENTORDER` - `DROPSHIPORDER ` - `SAMPLEORDER ` - `STANDINGORDER` Use Java call-out table CL\_PurchaseOrderType. - BEG02 = Canonical Enumeration: - Details of mappings in enumeration mapping worksheet. Use Java call-out table CL\_PurchaseOrderType. - isAcknowledgmentRequired boolean Purchase order acknowledgment required flag. Valid values: - `True` - PO Acknowledgment required - `False` - (Default) No acknowledgment required - - - 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 include: - `CSOSVALIDATEDPURCHASEORDER` (required) - `PURCHASEORDER` - `CONTRACT` - `DOCUMENT` - `RELEASE ` - `RUSHORDER` - `DEAORDER` - `DEAIDENTIFIER` - `DEAPREVIOUSIDENTIFIER` - `DEAREPLACEMENTIDENTIFIER` - `DEACERTIFICATE` Use Java call-out table CL\_B2BTransactionIdentifierType.txt - - BEG03 maps to CSOSVALIDATEDPURCHASEORDER - BEG04 maps to RELEASE - BEG06 maps to CONTRACT REF01 = - DM (DOCUMENT) or - D1 (DEAORDER) or - DH (DEAIDENTIFIER) or - P2 (DEAPREVIOUSIDENTIFIER) or - QD (DEAREPLACEMENTIDENTIFIER) or - DEA (DEACERTIFICATE) Details in enumeration mapping worksheet . Use Java call-out table CL\_B2BTransactionIdentifierType.txt. - 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 CSOSVALIDATEDPURCHASEORDER transactionDate - epochTransactionDate date Transaction date in epoch date format YYYY-MM-DD. - - - mpcDates array Reference dates at header level. - - - dateType string referenced date type. Valid values include: - `CANCELBY` - `DELIVERYREQUESTED` - `DOCUMENT` - `ESTIMATEDDELIVERY` - `SCHEDULEDDELIVERY` - `SHIPMENTREQUESTED` - - - dateValue date Datetime defined by referenced date type. - - - timeZone string Time zone for referenced dates. - - - mpcCurrency array Currency codes for purchase order. - X12 CUR - currencyCode string Currency code for pricing in price catalog. - Map X12 qualifier, no conversion. - exchangeRateCurrencyCode string Currency code for currency exchange. - - - exchangeRate number Exchange rate for conversion from currencyCode to currencyCodeExchange. - - - validityDate date Validity date for exchange rate. - - - orderCurrencyExchangeRate number Purchase order currency exchange rate between the order currency and the accounting currency. - - - currencyEntityCode string Currency Entity Code. - Map X12 qualifier,noconversion. - shipToLocationInformation - Ship to location party types, identifiers and address information. - N101 = ST - businessName string Business name for ship to party location. - N102 where N101=ST - 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. Valid values include: - `1` - DUNS - `9` - DUNS+4 - `11` - Drug Enforcement Agency registration number - `21` - Health Industry Number - `91` - Company identifier - `92` - Company location identifier - `UL` - Global Location Number - N103 where N101 = RIN103 = Canonical enumerations: - `1` - DUNS - `9` - DUNS4 - `11` - DEA - `21` - HIN - `91` - COMPANYID - `92` - COMPANYSITEID - `UL` - GLN Convert with full enumeration mapping worksheet - companyIdentifierValue string Company identifier value for business partner. - N104 - alternateCompanyLocationIdentifierValue string Alternate company location identifier value. - - address - Manufacturing business party address info. - - 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 - Contact information for party business or location. - Segment PER where PER01 = - OC (Order Contact) or - PM (Product Manager) or - AJ (primary contact) - contactType string Contact type. Valid values: - `PRIMARY` - `ORDERCONTACT` - `PRODUCTMANAGER` - PER01 = - AJ (PRIMARY) or - OC (ORDERCONTACT) or - PM (PRODUCTMANAGER) - contactName string Contact name. - PER02 - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - PER04 where PER03 = TE or PER06 where PER05 = TE - contactEmail string Contact email address. - PER04 where PER03 = EM or PER06 where PER05 = EM - 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. - - - 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 info. - - - 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 - Contact information for party business or location. - - - contactType string Contact type. Valid values: - `PRIMARY` - `ORDERCONTACT` - `PRODUCTMANAGER` - - - 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. - - - supplierBusinessInformation - Supplier business party types, identifiers and address information. - - - businessName string Business name for supplier party. - N102 - additionalBusinessName string Additional business name or overflow of business name. - - - 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. Valid values include: - `1` - DUNS - `9` - DUNS+4 - `11` - Drug Enforcement Agency registration number - `21` - Health Industry Number - `91` - Company identifier - `92` - Company location identifier - `UL` - Global Location Number - N103 where N101 = RIN103 = Canonical Enumeration - `1` - DUNS - `9` - DUNS4 - `11` - DEA - `21` - HIN - `91` - COMPANYID - `92` - COMPANYSITEID - `UL` - GLN Convert with full enumeration mapping worksheet. - companyIdentifierValue string Company identifier value for business partner. - N104 - alternateCompanyLocationIdentifierValue string Company location UUID for partner. - - - address - Manufacturing business party address info. - - - 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 - Contact information for party business or location. - Segment PER where PER01 = - OC (Order Contact) or - PM (Product Manager) or - AJ (primary contact) - contactType string Contact type. Valid values: - `PRIMARY` - `ORDERCONTACT` - `PRODUCTMANAGER` - PER01 = - AJ (PRIMARY) or - OC (ORDERCONTACT) or - PM (PRODUCTMANAGER) - contactName string Contact name. - PER02 - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - PER04 where PER03 = TE or PER06 where PER05 = TE - contactEmail string Contact email address. - PER04 where PER03 = EM or PER06 where PER05 = EM - 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. - - - customerBusinessInformation - Customer business party types, identifiers and address information. - N101 = BY (Buyer) - businessName string Business name for customer or sold to party. - N102 wher N101 = BY - 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. Valid values include: - `1` - DUNS - `9` - DUNS+4 - `11` - Drug Enforcement Agency registration number - `21` - Health Industry Number - `91` - Company identifier - `92` - Company location identifier - `UL` - Global Location Number - N103 where N101 = RIN103 = Canonical enumerations: - `1` - DUNS - `9` - DUNS4 - `11` - DEA - `21` - HIN - `91` - COMPANYID - `92` - COMPANYSITEID - `UL` - GLN Convert with full enumeration mapping worksheet. - companyIdentifierValue string Manufacturing business partner name. - N104 - alternateCompanyLocationIdentifierValue string Company location UUID for partner. - - - address - Manufacturing business party address info. - - - 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 - Contact information for party business or location. - Segment PER where PER01 = - OC (Order Contact) or - PM (Product Manager) or - AJ (primary contact) - contactType string Contact type. Valid values: - `PRIMARY` - `ORDERCONTACT` - `PRODUCTMANAGER` - PER01 = - AJ (PRIMARY) or - OC (ORDERCONTACT) or - PM (PRODUCTMANAGER) - contactName string Contact name. -- PER02 - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - PER04 where PER03 = TE or PER06 where PER05 = TE - contactEmail string Contact email address. - PER04 where PER03 = EM or PER06 where PER05 = EM - 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. - - - 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. Valid values include: - `1` - DUNS - `9` - DUNS+4 - `11` - Drug Enforcement Agency registration number - `21` - Health Industry Number - `91` - Company identifier - `92` - Company location identifier - `UL` - Global Location Number - N103 where N101 = RIN103 = Canonical Enumeration - `1` - DUNS - `9` - DUNS4 - `11` - DEA - `21` - HIN - `91` - COMPANYID - `92` - COMPANYSITEID - `UL` - GLN Convert with full enumeration mapping worksheet. - companyIdentifierValue string Manufacturing business partner name. - N104 - alternateCompanyLocationIdentifierValue string Company location UUID for partner. - - - address - Manufacturing business party address info. - - - 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 - Contact information for party business or location. - Segment PER where PER01 = - OC (Order Contact) or - PM (Product Manager) or - AJ (primary contact) - contactType string Contact type. Valid values: - `PRIMARY` - `ORDERCONTACT` - `PRODUCTMANAGER` - PER01 = - AJ (PRIMARY) or - OC (ORDERCONTACT) or - PM (PRODUCTMANAGER) - contactName string Contact name. - PER02 - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - PER04 where PER03 = TE or PER06 where PER05 = TE - contactEmail string Contact email address. - PER04 where PER03 = EM or PER06 where PER05 = EM - 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. - - - 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 info. - - - 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 - Contact information for party business or location. - - - contactType string Contact type. Valid values: - `PRIMARY` - `ORDERCONTACT` - `PRODUCTMANAGER` - - - 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 info. - - - 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 - Contact information for party business or location. - - - contactType string Contact type. Valid values: - `PRIMARY` - `ORDERCONTACT` - `PRODUCTMANAGER` - - - 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. - N101 = BT (Bill To) - businessName string Business name for bill to party. - N102 where N101 = BT - 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. Valid values include: - `1` - DUNS - `9` - DUNS+4 - `11` - Drug Enforcement Agency registration number - `21` - Health Industry Number - `91` - Company identifier - `92` - Company location identifier - `UL` - Global Location Number - N103 where N101 = RIN103 = Canonical enumerations: - `1` - DUNS - `9` - DUNS4 - `11` - DEA - `21` - HIN - `91` - COMPANYID - `92` - COMPANYSITEID - `UL` - GLN Convert with full enumeration mapping worksheet. - companyIdentifierValue string Manufacturing business partner name - N104 where N101=BT - alternateCompanyLocationIdentifierValue string Company location UUID for partner - - - address - Manufacturing business party address info. - - - 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 - Contact information for party business or location. - Segment PER where PER01 = - OC (Order Contact) or - PM (Product Manager) or - AJ (primary contact) - contactType string Contact type. Valid values: - `PRIMARY` - `ORDERCONTACT` - `PRODUCTMANAGER` - PER01 = - AJ (PRIMARY) or - OC (ORDERCONTACT) or - PM (PRODUCTMANAGER) - contactName string Contact name. - PER02 - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - PER04 where PER03 = TE or PER06 where PER05 = TE - contactEmail string Contact email address. - PER04 where PER03 = EM or PER06 where PER05 = EM - 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. - - - remitToBusinessInformation - Remit to business party types, identifiers and address information. - N101 = RI (Remit to party) - businessName string Business name for remit to party. - 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. Valid values include: - `1` - DUNS - `9` - DUNS+4 - `11` - Drug Enforcement Agency registration number - `21` - Health Industry Number - `91` - Company identifier - `92` - Company location identifier - `UL` - Global Location Number - N103 where N101 = RIN103 = Canonical enumerations: - `1` - DUNS - `9` - DUNS4 - `11` - DEA - `21` - HIN - `91` - COMPANYID - `92` - COMPANYSITEID - `UL` - GLN Convert with full enumeration mapping worksheet. - companyIdentifierValue string Manufacturing business partner name. - N104 where N101 = SN - alternateCompanyLocationIdentifierValue string Company location UUID for partner. - - - address - Manufacturing business party address info. - - - 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 - Contact information for party business or location. - - - contactType string Contact type. Valid values: - `PRIMARY` - `ORDERCONTACT` - `PRODUCTMANAGER` - - - 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. - - - remitToBusinessInformation 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. Valid values include: - `1` - DUNS - `9` - DUNS+4 - `11` - Drug Enforcement Agency registration number - `21` - Health Industry Number - `91` - Company identifier - `92` - Company location identifier - `UL` - Global Location Number - N103 where N101 = RIN103 = Canonical enumerations: - `1` - DUNS - `9` - DUNS4 - `11` - DEA - `21` - HIN - `91` - COMPANYID - `92` - COMPANYSITEID - `UL` - GLN Convert with full enumeration mapping worksheet. - companyIdentifierValue string Manufacturing business partner name. - N104 where N101 = SN - alternateCompanyLocationIdentifierValue string Company location UUID for partner. - - - address - Manufacturing business party address info. - - - 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 - Contact information for party business or location. - Segment PER where PER01 = - OC (Order Contact) or - PM (Product Manager) or - AJ (primary contact) - contactType string Contact type. Valid values: - `PRIMARY` - `ORDERCONTACT` - `PRODUCTMANAGER` - PER01 = - AJ (PRIMARY) or - OC (ORDERCONTACT) or - PM (PRODUCTMANAGER) - contactName string Contact name. - PER02 - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - PER04 where PER03 = TE or PER06 where PER05 = TE - contactEmail string Contact email address. - PER04 where PER03 = EM or PER06 where PER05 = EM - 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. - N101=CA (Carrier) - businessName string Business name for carrier party. - N102 where N101 = CA - 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. Valid values include: - `1` - DUNS - `9` - DUNS+4 - `11` - Drug Enforcement Agency registration number - `21` - Health Industry Number - `91` - Company identifier - `92` - Company location identifier - `UL` - Global Location Number - N103 where N101 = RIN103 = Canonical enumerations: - `1` - DUNS - `9` - DUNS4 - `11` - DEA - `21` - HIN - `91` - COMPANYID - `92` - COMPANYSITEID - `UL` - GLN Convert with full enumeration mapping worksheet. - companyIdentifierValue string Manufacturing business partner name. - N104 where N101=CA - alternateCompanyLocationIdentifierValue string Company location UUID for partner. - - - address - Manufacturing business party address info. - - - 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 Contact information for party business or location. - Segment PER where PER01 = - OC (Order Contact) or - PM (Product Manager) or - AJ (primary contact) - contactType string Contact type. Valid values: - `PRIMARY` - `ORDERCONTACT` - `PRODUCTMANAGER` - PER01 = - AJ (PRIMARY) or - OC (ORDERCONTACT) or - PM (PRODUCTMANAGER) - contactName string Contact name. - PER02 - contactTitle string Title of contact. - - - contactPhone string Contact phone number. - PER04 where PER03 = TE or PER06 where PER05 = TE - contactEmail string Contact email address. - PER04 where PER03 = EM or PER06 where PER05 = EM - 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. - - - companyLocationContactInformation array Contact information for party business or location. - Segment PER where PER01 = - OC (Order Contact) or - PM (Product Manager) or - AJ (primary contact) - contactType string Contact type. Valid values: - `PRIMARY` - `ORDERCONTACT` - `PRODUCTMANAGER` - PER01 = - AJ (PRIMARY) or - OC (ORDERCONTACT) or - PM (PRODUCTMANAGER) - contactName string Contact name. - PER02 - contactTitle string Title of contact. - N/A - contactPhone string Contact phone number. - PER04 where PER03 = TE or PER06 where PER05 = TE - contactEmail string Contact email address. - PER04 where PER03 = EM or PER06 where PER05 = EM - mpcOrganizationList array Organization idenfitiers sent from trading partner's ERP system. - - - organizationType string Organization type. - - - organizationDescription string Description of organization unit. - - - termsOfPayment array Terms of payment looping group. - Not present in sample X12 data. Use the logic in standard PO map. - termsOfPaymentKey string Terms of payment. - - - termsOfPaymentTypeCode Code identifying type of payment terms. Valid values include: - `BASIC` - `DEFERRED` - `ENDOFMONTH` - `FIXEDDATE` - `PROXIMO` - `SPECIALPROXIMO` - ITD01 = Canonical enumerations: - `01` - BASIC - `02` - ENDOFMONTH - `03` - FIXEDDATE - `04` - DEFERRED - `05` - DISCOUNTNOTAPPLICABLE - `06` - MIXED - `07` - EXTENDED - `09` - PROXIMO - `13` - SELLER - `14` - PREVIOUSLYAGREED - `15` - SPECIALPROXIMO - 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. - Not present in sample X12 data. Using logic from standard PO map. - creditChargeKeyType string Key identifies credit or charges as discounts or additional charges. Valid values include: - `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 string Total amount for the payment. - SAC05 - qualifyingAmount string Amount qualifying for cash discount, allowance, promotion, service or charge. - - - creditChargeCurrencyCode string Currency code for credit 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 = 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 string Method of handling for discount or charge. Valid values include: - `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. - Not present in sample X12 data. Using logic from standard PO map. - taxType string Type of tax recorded. List can be extended as required. Valid value: - `VAT` - `HARMONIZEDSALES` - `FEDERALEXCISE` - `STATESALES` - `PROVINCIALSALES` - `CITYSALES` - `COUNTYSALES` - `GOODSANDSERVICES` - `CUSTOMSDUTY` - `SURTAX` - TXI01 = Canonical enumerations: - `CS` - CITYSALES - `CT` - COUNTYSALES - `CG` - CUSTOMSDUTY - `FD` - FEDERALEXCISE - `GS` - GOODSANDSERVICES - `BE` - HARMONIZEDSALES - `PG` - PROVINCIALSALES - `ST` - STATESALES - `AB` - SURTAX - `TX` - ALLTAXES - `VA` - VAT - 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. - TXI02 - taxCurrencyCode string Currency for taxes. - - - taxPercent string Tax rate in percent. - TXI03 - taxRate string Amount used for calculation of tax. - - - vatIndicator string VAT indicator. - - - 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. - 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 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 type code identifying the method or type of transport used for the shipment. TD504 = Canonical enumeration- Details in enum mapping worksheet Use Java call-out for lookup table CL\_TransportMethodType.txt. - 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` - TD512 - ON (OVERNIGHT) or - NM (NEXTMORNING) or - PA (PRIMARYNEXTDAY1030AM) or - SE (SECONDDAY) or 3D (THIRDDAY) or - SP (SATURDAYPICKUP) Not present in sample data. Use existing mapping in standard PO. - processOrderData - Overview of process order data, as required for mapping to extended IDocs provided by customers. - - - processOrderNumber string Process order identifier. - - - orderType string Order type for process order. Pass thru mapping. - - - plantIdentifier string Plant identifier for process order. - - - itemCode string Item code identifier for finished product produced in process order. - - - itemDescription string Description of item produced in process order. - - - supplierLotNumber string Supplier or vendor lot number. - - - expirationDate string Shelf life expiration or best before date for manufactured product in date format YYYYMMDD. - - - 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. - - - adjustedExpirationDate string Expiration date as formatted by date format attribute. - - - quantity number Total quantity for process order. - - - unitOfMeasure string Unit of measure for total order quantity. - - - packageSize string Packaging size for item in process order. - - - packagingType string Type of packaging for item produced through process order. - - - countryCode string Country code for process order. - - - strength string Product strength. - - - dosageForm string Dosage form. - - - articleFamilyCode string Article family code. - - - productionVersion string Production version. - - - description string Production version description. - - - 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) - - - sampleQuantity number Reference sample quantity - - - isSamplingApplicable boolean Boolean determining if reference sampling is applicable. Valid values: - `True` - X - Reference sampling is applicable - `False` - Not mapped (default) - - - stabilitySampleQuantity number - - - - isOngoingStablilitySampling boolean Boolean determining if ongoing stability sampling is applicable. Valid values: - `True` - X - Ongoing stability sampling is applicable - `False` - Not mapped (default) - - - mpcDates array Basic finish and start dates for process order. - - - dateType string Date type for process order. - - - dateValue string Date value for finish or start of production as defined by dateType in date format YYYYMMDD. - - - 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. - - - componentIdentifier string Component item identifier. - - - itemDescription string Description of component item. - - - lotNumber string Lot of batch number for component item. - - - quantity number Quantity of component item required for process order. - - - unitOfMeasure string Unit of measure for total order quantity. - - - shipToLocationInformation - Delivery address for sales order or stock transfer order used to generate process order. - - - 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 Manufacturing business partner name. - - - alternateCompanyLocationIdentifierValue string Company location UUID for partner. - - - address - Manufacturing business party address info. - - - 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 Contact information for party business or location. - - - contactType string Contact type. Valid values: - `PRIMARY` - `ORDERCONTACT` - `PRODUCTMANAGER` - - - 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. - - - orderType string Order type for ship to party in process order. Pass thru mapping. - - - organizationCode string Title of contact. - - - referenceIdentifier string Contact phone number. - - - languageCode string Contact email address. - - - freeTextNote Free text, instructions, notes, descriptions and other free text elements. - X12 - textReferenceCode string Text reference or subject code. Will map whatever is found. - When REF01 = "ZZ" , store X12 qualifier from REF02 - textFunctionCode string Text function code. Will map whatever is found. - REF02 = "ZZ" (not mapped but used to indicate a note) - language string Language of free text. - - - textFormatCode string Format code for free text. - - - freeFormText string Free text array. - 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. - PO101 - 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/acknowledgement from supplier's system - `CANCEL` - Cancel order item - - - 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. - - - itemCategory string Item category. Populated in standard Idoc. - - - netPrice number Net price for item. - - - plantIdentifier string Plant identifier. - - - packingInstructions string Packing Instructions. - - - storageConditions string Conditions for storage of materials. - - - stackabilityLabel string Stack lebel of packaged material. - - - conversionFactorToBaseUnitOfMeasure number Conversation 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. - - - 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. - Product code qualifer followed by identifiers are represented in pairs from PO106 & PO107 through PO124 & PO125.. If qualifier is present, then identifier is required. - productCodeType string Code to qualify product identifier type. Valid values include: - `CUSTOMER` - `VENDOR` - `BUYERITEM` - `GTIN14` - `MANUFACTURER` - `UPC` - PO106 = Canonical Code. Minor differences between versions 4010 and earlier and 5010 and later. See lookup table for details. Use java call-out to lookup table CL\_ProductCodeType - productCodeValue string Product code identifier value. - PO107 - productItemInformation array Product item code information. Only using a subset of all available attributes. - - - productLanguageCode string Language code for product description. - - - productName string Name of product. - 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" - longDescription string Long description for product. - - - itemQuantity array Order quantity at line item level. - - - quantityType string Type of quantity recorded. Values hard coded in map by field context. Valid values include: - `ITEM` - `INNERCONTAINERS` - `PACKAGED` - quantity Types used in Purchase order, hard code, not converted: - `ITEM` - `INNERCONTAINERS` - `PACKAGED` - quantityValue number Quantity of product at PO line item. - PO102 - unitOfMeasure string Unit of measure for quantity value. - PO103 Use Java call-out to lookup table UOM\_TableLookup2.txt - itemVolume array Volume of the ordered product at the line item level. - - - volumeType string Type of volume recorded for ordered product. Valid values include: - `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. - - - 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 purchase order item. Valid value hard coded `UNIT`. - pricingType = UNIT - pricingAmount number Pricing amount for pricing type defined by pricing type enumeration. - PO104 - currencyCode string Currency for pricing amount. - - - priceUOM string Unit of measure used for pricing at the order line item level. - - - unitPriceBasisQuantity number Quantity basis of unit price. - - - 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. - - - weightValue number Weight of product at PO line item. - - - unitOfMeasure string Unit of measure for weight value. - - - mpcDates 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. - - - deliveryScheduleDetails array Delivery schedule by dates and quantities. - - - lineItemNumber string Line item number for purchase document. - - - deliveryScheduleLineItem string Delivery schedule line item number. - - - itemCode string Product item identifier. - - - itemDescription string Description of product item. - - - quantity number Quantity of product in delivery schedule details. - - - unitOfMeasure string Unit of measure for total order quantity. - - - deliveryToleranceDetails - Details of over and under delivery tolerance for purchase order. - - - underDeliveryTolerance string Under delivery tolerance for order. - - - overDeliveryTolerance string Over delivery tolerance for order. - - - description string Description of tolerance. - - - confirmedQuantity number Confirmed quantity for tolerance. - - - shipToLocationInformation - Ship to location 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 - Manufacturing business party address info. - - - 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 - Contact information for party business or location. - - - contactType string Contact type. Valid values: - `PRIMARY` - `ORDERCONTACT ` - `PRODUCTMANAGER` - - - 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. - - - termsOfPayment array Terms of payment looping group. - - - termsOfPaymentKey string Terms of payment. - - - paymentTypeCode - Code identifying type of payment terms. - - - termsOfPaymentDateType string Code identifying the beginning of the terms period. - - - 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. - Not present in sample X12 data. Using logic from standard PO map. - creditChargeKeyType string Key identifies credit or charges as discounts or additional charges. Valid values include: - `ALLOWANCE` - `CHARGE` - `PROMOTION` - SAC01 = Canonical enumeration: - `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 include: - `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. - Not present in sample X12 data. Using logic from standard PO map. - taxType string Type of tax recorded. List can be extended as required. Valid value: - `VAT` - `HARMONIZEDSALES` - `FEDERALEXCISE` - `STATESALES` - `PROVINCIALSALES` - `CITYSALES` - `COUNTYSALES` - `GOODSANDSERVICES` - `CUSTOMSDUTY` - `SURTAX` - TXI01 = Canonical enumerations: - `CS` - CITYSALES - `CT` - COUNTYSALES - `CG` - CUSTOMSDUTY - `FD` - FEDERALEXCISE - `GS` - GOODSANDSERVICES - `BE` - HARMONIZEDSALES - `PG` - PROVINCIALSALES - `ST` - STATESALES - `AB` - SURTAX - `TX` - ALLTAXES - `VA` - VAT - 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. - TXI02 - taxCurrencyCode string Currency for taxes. - - - taxPercent string Tax rate in percent. - TXI03 - taxRate string Amount used for calculation of tax. - - - vatIndicator string VAT indicator. - - - 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. - - - fobTransferLocation string Code specifying the type of location at which the risk of loss for the shipment transfers. - - - 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 fo the item treated as component. - - - freeTextNote - 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 values include: - `NUMBEROFITEMS` - `LINEITEMTOTAL` - `TOTALAMOUNT` - Summary Types in PO: - `NUMBEROFITEMS` - `LINEITEMTOTAL` - `TOTALAMOUNT` - 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