  

 

Tracelink University

 ## Breadcrumb

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

 

 

# Purchase order change requests canonical guidelines

 

 

 

 

 

 

 

 

- [Download PDF](/node/630361/pdf)
- [Share](#)
    - [ LinkedIn ](https://www.linkedin.com/shareArticle?mini=true&url=https://www.tracelink.com/resources/tracelink-university/purchase-order-change-requests-canonical-guidelines&title=Purchase order change requests canonical guidelines&summary=The Purchase Order Change Request is an electronic transaction that a buyer uses to communicate updates to a previously submitted purchase order. &source=TraceLink "LinkedIn")
    - [ Facebook ](https://www.facebook.com/share.php?u=https://www.tracelink.com/resources/tracelink-university/purchase-order-change-requests-canonical-guidelines&t=Purchase order change requests canonical guidelines "Facebook")
    - [ Mail ](mailto:?subject=Purchase order change requests canonical guidelines+|+TraceLink&body=https://www.tracelink.com/resources/tracelink-university/purchase-order-change-requests-canonical-guidelines "Mail")
    - [ Twitter ](https://twitter.com/intent/tweet?text=Purchase order change requests canonical guidelines https://www.tracelink.com/resources/tracelink-university/purchase-order-change-requests-canonical-guidelines&via=TraceLink "Twitter")
 
 

 

 

 

 

#### Table of contents

 

 

 

The Purchase Order Change Request is an electronic transaction that a buyer uses to communicate updates to a previously submitted purchase order. It enables supply chain partners to revise and align order details after the original order has been issued.

[![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     canonicalPurchaseOrderChangeRequest – 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. – – –     canonicalPurchaseOrderChangeRequestHeader – Purchase order business partner lists. E1EDK01 BCH BGM       processingFunctionTypeCode string Purpose of purchase order. Tells receiving system function of purchase.

Valid values:

- `CHANGE` - Change existing customer PO in supplier's system
- `REPLACE` - Purchase Order confirmation/acknowledgment from supplier's system
- `CANCEL` - Cancel purchase order
- `COMPLETION` - Correction to purchase order
 
  E1EDK01/ACTION =

- 000 (NONE)
- 001 (REVERSE)
- 002 (CHANGE)
- 003 (CHANGESTOITEMS)
- 004 (CHANGESTOHEADERANDITEMS)
 
  BCH01 BGM030       purchaseOrderType string Purchase order type.

Valid values include:

- `PURCHASEORDERCHANGE`
- `PURCHASEORDER`
- `PROMOTION`
- `MUTUALLYDEFINED`
 
  – BCH02 BGM01.1 = 230       transactionFunctionType string Code identifying the functional context of the transaction type. – BCH15 –       transactionReferenceIdentifierList(1) array Instance 1 transaction reference identifier list mapping for the purchase order number mapping to TL internal transaction type

`PURCHASEORDERCHANGEREQUEST`. Required value.

  E1EDK01 &amp; E1EDK02 BCH BGM &amp; DTM         b2bTransactionIdentifierType string Referenced document type. Valid value: - `PURCHASEORDERCHANGEREQUEST` - required If b2bTransactionIdentifierType = PURCHASEORDERCHANGEREQUEST E1EDK02/QUALF = 022 b2bTransactionIdentifierType = PURCHASEORDERCHANGEREQUEST If b2bTransactionIdentifierType = PURCHASEORDERCHANGEREQUEST BGM01.1 = 230         b2bTransactionIdentifierValue string Reference order identifier value. E1EDK01/BELNR E1EDK02/BELNR where QUALF = 001 BCH03 BGM02.1         lineItemNumber string Line item number in customer purchase order. Line item level only. – – –         transactionDate date Transaction date in canonical date format YYYY-MM-DD. E1EDK02/DATUM + UZEIT (if present) BCH06 DTM01.2 where DTM01.1 = 137         epochTransactionDate date Transaction date in epoch date format YYYY-MM-DD. – – –       transactionReferenceIdentifierList(1) array Instance 2 transaction reference identifier list mapping for the purchase order number. Required value. E1EDK01 &amp; E1EDK02 BCH BGM &amp; DTM         b2bTransactionIdentifierType string Referenced document type.

Valid value `PURCHASEORDER`.

  If b2bTransactionIdentifierType = PURCHASEORDERCHANGEREQUEST E1EDK02/QUALF = 022 b2bTransactionIdentifierType = PURCHASEORDERCHANGEREQUEST If b2bTransactionIdentifierType = PURCHASEORDERCHANGEREQUEST BGM01.1 = 230         b2bTransactionIdentifierValue string Reference order identifier value. E1EDK01/BELNR E1EDK02/BELNR where QUALF = 001 BCH03 BGM02.1         lineItemNumber string Line item number in customer purchase order. Line item level only. – – –         transactionDate date Transaction date in canonical date format YYYY-MM-DD. E1EDK02/DATUM + UZEIT (if present) BCH06 DTM01.2 where DTM01.1 = 137         epochTransactionDate date Transaction date in epoch date format YYYY-MM-DD. – – –       mpcDates1) – Instance 1 mpcDates with purchase order change request dates at header level: Date of PO change request. – BCH –         dateType string Referenced dates at purchase order header.

Valid values include `PURCHASEORDERCHANGEREQUEST`.

  – dateType = PURCHASEORDERCHANGEREQUEST –         dateValue date Date time defined by referenced date type. – BCH11 –         timeZone string Time zone for referenced dates. – – –       transactionReferenceInformation array Transaction reference information for mapping to X12 REF segment. E1EDK02 REF RFF         transactionReferenceType string Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier.

Valid values include:

- `VENDORNUMBER`
- `VENDORORDER`
- `INTERNALVENDORNUMBER`
- `ORDERNUMBER`
- `DEPARTMENT`
 
  QUALF REF01 RFF01.1         transactionReferenceIdentifier string Transaction reference identifier value. BELNR REF02 RFF02         description string Identifier or description. – REF03 –         transactionReferenceDate string Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. DATUM + UZEIT (if present) – –         epochTransactionReferenceDate integer Transaction reference date and time in EPOCH date time format. – – –       mpcDates(2) array Instance 2 mpcDates for all other date types at header level mapped to header DTM. E1EDK03 DTM –         dateType string Referenced dates at purchase order header.

Valid values include:

- `CANCELAFTER`
- `DELIVERYREQUESTED`
- `PROMOTIONSTART`
- `PURCHASEORDER`
 
  IDDAT DTM01 –         dateValue date Datetime defined by referenced date type. DATUM + UZEIT (if present) DTM02 –         timeZone string Time zone for referenced dates. – – –       companyLocationContactInformation array Contact information for party business or location. – PER –         contactType string Contact code identifying type of contact.

Valid values include:

- `BUYER`
- `ORDERCONTACT`
- `SUPPLIER`
 
  – PER01 –         contactName string Contact name. – PER02 –         contactTitle string Title of contact. – – –         contactPhone string Contact phone number. – PER04 or PER05 based on communications qualifier in PER03 or PER05 –         contactEmail string Contact email address. – PER04 or PER05 based on communications qualifier in PER03 or PER05 –       deliveryTerms array Delivery terms with transportation instructions for shipment of the order. – FOB –         deliveryChargePaymentMethodType string Method of payment for shipment.  – FOB01 –         fobTransferLocation string Location qualifier identifying type of location.

Valid values include:

- `CI` - City
- `DE` - Destination (Shipping)
- `OR` - Origin (Shipping Point)
- `PL` - Plant
 
  – FOB02 –         description string Description of location for shipment of order. – FOB03 –       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`
- `NONE`
 
  – SAC01 –         creditChargeType string Code representing type of credit or charge.

Valid values include:

- `ADJUSTMENT`
- `ADVANCE`
- `BASE`
- `DISCOUNT`
- `FREIGHT`
 
  – SAC02 –         creditChargeAmount string Total amount for the payment. – SAC05 –         itemQuantity string Allowance or charge quantity. – SAC10 –         unitOfMeasure string Unit of measure for the allowance or charge item quantity. – SAC09 –         qualifyingAmount string Amount qualifying for cash discount, allowance, promotion, service or charge. – – –         unitPriceAmount string Allowance or charge rate per unit. – SAC08 –         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.

Valid values include:

- `GROSS`
- `ITEMNET `
- `DISCOUNTNET`
- `BASEPRICE`
- `NETMONTHLYPASTDUE`
 
  – SAC06 –         creditChargeHandlingCode – Method of handling for discount or charge.

Valid values include:

- `BILLBACK`
- `OFFINVOICE`
- `CREDITCUSTOMER`
- `VENDORPAID`
- `CUSTOMERPAID`
 
  – SAC12 –         description string Description of credit or charge. – SAC15 –         allowanceOrChargeCode string Allowance or charge code identifying the type of allowance or charge. – – –         creditChargeIdentifier string Identifier number for allowance or charge. – SAC13 –         basisAmountForPercent number Base amount to be used in the percentage calculation of the allowance, charge, or tax. – – –         creditChargeDescriptions array Credits, charges, allowances, discounts descriptions. Multiple descriptions are possible. – – –           description string Descriptions of credits or charges. – – –       termsOfPayment array Terms of payment looping group. – ITD –         termsOfPaymentKey string Terms of payment. – – –         termsOfPaymentTypeCode – Terms of sale type code. Identifies type of payment code.

Valid values include:

- `BASIC`
- `ENDOFMONTH`
- `FIXEDDATE`
- `DEFERRED`
 
  – ITD01 Use if statement to convert –         termsOfPaymentDateBasis string Terms of sale basis code. Identifies beginning of the terms of payment code.

Valid values include:

- `PURCHASEORDERDATE`
- `SHIPDATE `
- `DELIVERYDATE`
- `EFFECTIVEDATE`
 
  – ITD02 Use if statement to convert –         numberOfDays string Terms of payment: number of days. – ITD07 –         termsOfPaymentPercent string Terms of payment: discount percentage. – ITD03 –         invoicePayablePercent string Percentage of invoice payable. – ITD11 –         paymentDueDate string Due date for payment. – ITD06 –         paymentDeferredToDate string Date deferred payment or percent of invoice payable is due. – ITD09 –         paymentDeferredDueAmount number Deferred amount due for payment. – – –         description string Terms of payment description. – ITD12 –         discountDueDate string Discount due date. – ITD04 –         discountDueNumberOfDays number Discount due number of days. – ITD05 –         dayOfMonth string Day of month. – – –       partnerBusinessInformation array Business party types, identifiers, address and other related information. E1EDKA1 N1 NAD         partnerEntityType string Partner entity type defines the partner type in the group.

Valid values include:

- `BILLTO`
- `SHIPTO`
- `VENDOR`
- `SUPPLIER `
- `CUSTOMER`
 
  PARVW N101  NAD01         businessName string Business name for manufacturing party. NAME1 N102 NAD04.1         additionalBusinessName string Additional business name or overflow of business name. NAME2 N201 NAD04.2         mpcCompanyLocationIdentifierList array List of identifiers and identifier types for the business party. E1EDKA1 N1 NAD           companyIdentifierType string Company identifier type for business partner.

Valid values include:

- `GLN`
- `DUNS`
- `DUNS4`
- `COMPANYID`
- `COMPANYSITEID`
 
  – N103 NAD02.3           companyIdentifierValue string Company identifier value for business partner. PARTN N104 NAD02.1           alternateCompanyLocationIdentifierValue string Company location UUID for partner. – – –           agencyCode string Responsible agency code for identifier types. – – –         address – Manufacturing business party address information. E1EDKA1 N3/N4 NAD           address1 string Main street address. STRAS N301 NAD05.1           address2 string Supplemental street address. STRS2 N302 NAD05.2           city string City ORT01 N401 NAD03           state string State or region code. REGIO N402 NAD07.1           postalCode string Postal code PSTLZ N403 NAD08           country string Country code LAND1 N404 NAD09           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 – – –         mpcAdditionalAddressInformation – Manufacturing business party address information. – – NAD           address3 string Street address 3 if present. – – –           address4 string Street address 4 if present. – – –           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. – – –           orderType string Order type. – – –           country string Additional country code or name. – – –           countrySubDivisionCode string Additional state, province or other country subdivision code. – – –           postalArea string Postal area. – – –           timeZone string Time zone of business partner or location. – – –           telephone string Additional telephone number. – – –           emailAddress string Email address. – – –           vatRegistrationNumber string VAT (Valuie Added Tax) registration identifier for business partner or location. – – –           taxExemptCode string Tax exempt code. – – –           locationType string Location type. – – –           locationIdentifier string Location identifier. – – –           formOfAddress string Form of address. – – –           customsBrokerLicenseIdentifier string Customs broker license identifier. – – –           transportMethod string Transportation method code identifying the type of transport used for the shipment.

Valid values include:

- `TRUCK `
- `RAIL`
- `SEA`
- `AIR`
- `LTL`
 
  – N1/TD504 –         companyLocationContactInformation – Company lor location contact information. – N1/PER NAD/CTA/COM           contactType string Contact type.

Valid values:

- `PRIMARY `
- `ORDERCONTACT`
- `PRODUCTMANAGER`
 
  – PER01 CTA010 =

- AC (PRIMARY) or
- OC (ORDERCONTACT) or
- PM (PRODUCTMANAGER)
 
            contactName string Contact name. – PER02 CTA020-020           contactTitle string Title of contact. – – –           contactPhone string Contact phone number. – PER04 where PER03 = TE or PER06 where PER05 = TE COM010-010 where COM010-020 = "TE"           contactEmail string Contact email address. – PER04 where PER03 = TE or PER06 where PER05 = TE COM010-010 where COM010-020 = "EM"       transportationInformation array Transportation information for purchase order.. – – –         companyIdentifierType string Company identifier type for business partner. – – –         routingSequenceCode string Sequence code for routing. – – –         transportMethod string Transportation method.

Valid values include:

- `TRUCK `
- `RAIL`
- `SEA`
- `AIR`
- `LTL`
- `AIREXPRESS`
 
  – N1/TD504 –         shipmentChargePaymentMethodType string Method of payment for delivery.

Valid values include:

- `COLLECT`
- `BUYER `
- `BUYERSELLERDEFINED`
- `PREPAIDONLY`
- `SELLER`
 
  – – –         unitLoadOptionCode string Code identifying loading or unloading options for a shipment.  – – –         routingDescription string Free form routing description. – – –         fobTransferLocation string Code specifying the type of location at which the risk of loss for the shipment transfers.

Valid values:

- `CITY`
- `PLANT `
- `SHIPPINGDESTINATION`
- `SHIPPINGORIGIN`
 
  – – –         fobPointName – Name of FOBtransfer location point. – – –       freeTextNote array Free text, instructions, notes, descriptions and other free text elements. – – –         textReferenceCode string Text reference or subject code. – – –         textFunctionCode string Text function code. – – –         language string Language of free text. – – –         textFormatCode string Format code for free text. – – –         freeFormText string Free text array. – – –       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. – – –     canonicalPurchaseOrderChangeRequestItemDetails array Purchase order product details array. E1EDP01 POC –       lineItemNumber string Line item number for ordered product. E1EDP01 / POSEX POC01 If no line item number in IB X12, generate one. Begin at 1 and increment by 1 for each loop of POC. –       processingFunctionTypeCode string Purpose of purchase order, item level. Element may appear at header or item level or both. Tells receiving system function of purchase. E1EDP01 / ACTION =

- 001 (ITEMADDED)
- 002 (ITEMCHANGED)
- 003 (CANCEL)
- 004 (ITEMNOTCHANGED)
- 005 (ITEMLOCKED)
- 091 (RECEIPT)
- 093 (RETURN)
- 094 (CONSIGNMENT)
- 095 (DAMAGEDINTRANSIT)
- 096 (CORRECTION)
 
  – –       adjustmentTypeCode string Code specifying granular changes to the PO at the line item level.

Valid values include:

- `ADDITEM `
- `CHANGE`
- `CHANGEDATE`
- `DELETEITEMS`
- `REPLACEDATES`
 
  – POC02 –       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
 
  – – –       itemCategory string Item category. Populated in standard Idoc. E1EDP01 / PSTYP – –       netPrice number Net priuce for item. E1EDP01 / NETWR – –       plantIdentifier string Plant identifier. E1EDP01 / WERKS – –       unitPriceTypeCode string Basis of unit price code.

Valid values include:

- `CATALOG`
- `CONTRACT`
- `DEALER `
- `PROMOTION`
 
  – POC07         itemUnitPrice number Unit price for the product at the line item level. – POC06         productCodesIdentifiers array Instance 1 product code identifiers mapping to UPC case code. Optional value. – POC           productCodeType string Code to qualify product identifier type:

Valid values:

- `VENDOR`
- `GTIN14`
- `CUSTOMER`
- `MANUFACTURER`
- `PURCHASERITEM`
 
  – - POC08
- POC10
- POC12
- POC14
- POC16
- POC18
 
  –         productCodeValue string Product code identifier value. – POC09 POC11 POC13 POC15 POC17 POC19 –       productItemInformation array Product item code information. Only using a subset of all available attributes. – POC/PID –         productLanguageCode string Language for product description. – – –         productName string Name of product. E1EDP19 / KTEXT PID05 –         remarks string Free text remarks. Using field to map to and from PID01. – PID01 –         genericName string Generic name for product. – – –         productDescription string Description of the product defined by the current product identifier. – – –         longDescription string Long description for product. – – –       orderPricing array Order pricing for purchase order change request. – PAM –         amountType string Amount type.

Valid values include:

- `LINEITEMTOTAL`
- `CONTRACT`
- `TAX`
- `NET`
 
  – PAM04 –         pricingAmount number Unit price amount mapping to POC06. – PAM05 –         priceUOM string Price unit of measure.  –   –         currencyCode string Currency for pricing amount. –   –       additionalItemDetails array – – POC/PO3 –         additionalItemChangeReasonCode string Code specifying change or reason code in quantity or price.

Valid values include:

- `ESTIMATEDQUANTITY`
- `PRICEBASEDQUANTITY`
- `MUTUALLYDEFINED`
 
  – P0301 –         dateValue string Provision to provide date change. – PO302 –         quantityValue string Product quantity or unit price basis quantity. – P0306 –         unitOfMeasure string Unit or Basis for Measurement Code.

Unit of entry UOM's include: relates to quantity value `UN` - Unit.

  – PO307 –         pricingType string Instance 1 pricing type for invoice item mapped to POC03.

Valid values include:

- `UNIT`
- `NET`
- `WHOLESALE`
 
  – PO303 –         itemUnitPrice number Additional item unit price – P0304 –         unitPriceTypeCode string Basis of unit price quantity defined in quantityValue, ie, if unit price Rs 100 is per 10 item, the unit basis is "Price per Ten". If unit price Rs 200 per 12 unit, the basis of unit is "Price per Dozen".

Valid values include:

- `CATALOG`
- `CONTRACT`
- `DEALER`
- `DISCOUNT `
- `PROMOTION`
 
  – PO305 –         description string Additional item change description. – – –       itemQuantity(1) – Instance 1 itemQuantity mapping to POC03 for order quantity. – POC –         quantityType string Type of quantity recorded.

Valid values include `ITEM`.

  – quantityType = ITEM –         quantityValue number Quantity of product at PO line item. – POC03 –         unitOfMeasure string Unit of measure for quantity value.  – POC05  –       itemQuantity(2) – Instance 2 itemQuantity mapping to POC04 for remaining quantity still to be received. – POC –         quantityType string Type of quantity recorded.

Valid value `REMAINING`.

  – quantityType = REMAINING –         quantityValue number Quantity of product that remains to be received. 0 is a valid value to map to X12 POC04. – POC04 –         unitOfMeasure string Unit of measure for quantity value. – – –       itemQuantity(3) – Instance 3 itemQuantity mapping to PO402 for the size of the supplier units in a pack. – POC/PO4 –         quantityType string Type of quantity recorded.

Valid value `PACKAGED`.

  – quantityType = PACKAGED –         quantityValue number Quantity of product at PO line item. – PO401 –         unitOfMeasure string Unit of measure for quantity value. – – –       itemQuantity(4) – Instance 4 itemQuantity mapping to PO401 for number of inner containers per pack or, if no packs, number of eaches per inner container. Same instance of PO4 as for PACKAGED. – POC/PO4 –         quantityType string Type of quantity recorded.

 Valid value is

`INNERCONTAINERS`.

If second instance of itemQuantity exists with the number of eaches per innercontainer, map to the same instance of X12 PO4 created by itemQuantity PACKAGED and INNERCONTAINERS.

  – quantityType = INNERCONTAINERS –         quantityValue number Quantity of product at PO line item. – PO414 –         unitOfMeasure string Unit of measure for quantity value. – PO403 –       itemQuantity(5) – Instance 5 itemQuantity mapping to PO415 for the number of eaches per inner container. Same instance of PO4 as for PACKAGED. – POC/PO4 –         quantityType string Type of quantity recorded. Valid value: - UNITS If second instance of itemQuantity exists with the number of eaches per innercontainer, map to the same instance of X12 PO4 created by itemQuantity PACKAGED and INNERCONTAINERS. – quantityType = UNITS –         quantityValue number Quantity of product at PO line item. – PO402 –         unitOfMeasure string Unit of measure for quantity value. – PO403 –       itemWeight array Gross weight for product mapped to PO4. – POC/PO4 –         weightType string Weight type.

Valid value is `GROSSWEIGHT`.

  – PO405 –         weightValue string Weight value. – PO406 –         unitOfMeasure string Unit of measure for gross weight. – PO407 –       packagingDimensions array Packaging dimensions group. – POC/PO4 –         packagingLength number Package length. – PO410 –         packagingWidth number Package width. – PO412 –         packagingHeight number Package height. – PO412 –         unitOfMeasure string Unit of measure for packaging dimensions. – PO413 –       companyLocationContactInformation array Company for location contact information.

  – POC/PER NAD/CTA/COM         contactType string Contact code identifying type of contact.

Valid values include:

- `BUYER`
- `ORDERCONTACT`
- `SUPPLIER`
 
  – PER01 CTA010 =

- AC (PRIMARY) or
- OC (ORDERCONTACT) or
- PM (PRODUCTMANAGER)
 
          contactName string Contact name. – PER02 CTA020-020         contactTitle string Title of contact. – – –         contactPhone string Contact phone number. – PER04 where PER03 = TE or PER06 where PER05 = TE COM010-010 where COM010-020 = "TE"         contactEmail string Contact email address. – PER04 where PER03 = TE or PER06 where PER05 = TE COM010-010 where COM010-020 = "EM"       transactionReferenceInformation array Transaction references for purchase orders and PO change, and PO confirmations at line item detail level. E1EDP02 POC/REF –         transactionReferenceType string Referenced identifier type.

Valid values include:

- `INTERNALVENDORNUMBER`
- `ORDERNUMBER`
- `DEPARTMENT`
 
  QUALF REF01 –         transactionReferenceIdentifier string Referenced identifier. BELNR REF02 –         description string Description. ZEILE REF03 –         transactionReferenceDate date Referenced identifier date. DATUM + UZEIT if present – –       deliveryTerms array Delivery terms with transportation instructions for shipment of the order. – POC/FOB –         deliveryChargePaymentMethodType string Method of payment for shipment. Pass thru mapping. – FOB01 –         fobTransferLocation string Location qualifier identifying type of location.

Valid values include:

- `CI` - City
- `DE` - Destination (Shipping)
- `OR` - Origin (Shipping Point)
- `PL` - Plant
 
  – FOB02 If statement to check for DE or OR

- DE - SHIPPINGDESTINATION
- OR - SHIPPINGORIGIN
 
  –         description string Description of location for shipment of order. – FOB03 –       shipToLocationInformation – Ship to location party types, identifiers and address information. E1EDPA1 – –         partnerEntityType string Partner entity type defines the partner type in the group.

Valid values include `SHIPTO`.

  – – –         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 – – –       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. – POC/SAC –         creditChargeKeyType string Key identifies credit or charges as discounts or additional charges.

Valid values:

- `ALLOWANCE`
- `CHARGE `
- `NONE`
 
  – POC/SAC01 –         creditChargeType string Code representing type of credit or charge.

Valid values include:

- `ADJUSTMENT`
- `ADVANCE`
- `BASE`
- `DISCOUNT`
- `FREIGHT`
 
  – POC/SAC02 –         creditChargeAmount string Total amount for the payment. – POC/SAC05 –         itemQuantity string Allowance or charge quantity. – POC/SAC10 –         unitOfMeasure string Unit of measure for the allowance or charge item quantity. – POC/SAC09 –         qualifyingAmount string Amount qualifying for cash discount, allowance, promotion, service or charge. – – –         unitPriceAmount string Allowance or charge rate per unit. – POC/SAC08 –         creditChargeCurrencyCode string Currency code for credit or charge. –   –         creditChargePercentRate string Percentage rate for cash discount, allowance, promotion, service or charge. – POC/SAC07 –         percentRateBasisTypeCode string Code indicating basis that allowance or charge percent is calculated.

Valid values include:

- `GROSS`
- `ITEMNET`
- `DISCOUNTNET`
- `BASEPRICE`
- `NETMONTHLYPASTDUE`
 
  – POC/SAC06 –         creditChargeHandlingCode – Method of handling for discount or charge.

Valid values include:

- `BILLBACK`
- `OFFINVOICE`
- `CREDITCUSTOMER`
- `VENDORPAID`
- `CUSTOMERPAID`
 
  – POC/SAC12 –         description string Description of credit or charge. – POC/SAC15 –         allowanceOrChargeCode string Allowance or charge code identifying the type of allowance or charge. – – –         creditChargeIdentifier string Identifier number for allowance or charge. – POC/SAC13 –         basisAmountForPercent number Base amount to be used in the percentage calculation of the allowance, charge, or tax. – – –         creditChargeDescriptions array Credits, charges, allowances, discounts descriptions. Multiple descriptions are possible. – – –           description string Descriptions of credits or charges. – – –       freeTextNote array Free text, instructions, notes, descriptions and other free text elements. – – –         textReferenceCode string Text reference or subject code. – – –         textFunctionCode string Text function code.  – – –         language string Language of free text. – – –         textFormatCode string Format code for free text. – – –         freeText string, array Free text array. – – –       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. – – –     canonicalPurchaseOrderChangeRequestSummary array Purchase order change request message summary.  – CTT –       summaryType string Type of summary.

Valid values include:

- `LINEITEMTOTAL`
- `TOTALQUANTITY`
- `TOTALWEIGHT`
- `TOTALVOLUME`
 
  –  Logic:

 If summaryType = LINEITEMTOTAL, map to/from

CTT01 summaryType =TOTALQUANTITY,map to/from

CTT02 summaryType = TOTALWEIGHT, map to/from

CTT03 summaryType = TOTALVOLUME, map to/from

CTT05 summaryType = LINEITEMTOTAL, map to/from

AMT02 summaryType = TOTALAMOUNT, map to/from AMT02

  –       summaryValue string Value in summary. – CTT01

CTT02

CTT03

CTT05

  –       summaryValueUnit string Unit of measure for summary value as defined by suymmaryTyipe. – CTT04 for TOTALWEIGHT

 CTT06 for TOTALVOLUME

  –    

 

 



 

 

 

 

#### 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)