Purchase Order Guidelines (.xml)

See How To Use this Guide before selecting the below fields.

Message Type: PURCHASE_ORDER

Info Exchange Display Name: PO

These fields are sent by the sender to TraceLink.

When sending an element in Date or DateTime format, a valid date must be given. "00" is not a valid day or month value and "0000" is not a valid year value.
Data Element Occurs Format Length Enums Req Description
ns0:TL_XML_PurchaseOrder [1...1] - - - M XML Purchase Order (PO) transaction root element.
  ControlFileHeader [1...1] - - - M XML file control header record.
    txn:Version [1...1] String [1/20] - M Version of XML transaction. *1
    txn:FileSenderNumber [1...1] String [1/20] - M File sender company ID - Customer ID. *2
    txn:FileReceiverNumber [1...1] String [1/20] - M File receiver company ID - Supplier Site ID. *3
    txn:UsageIndicator [1...1] String [0/10] UsageIndicator M Identifies test or production data. *4
    txn:FileTransactionType [1...1] String [1/30] - M File transaction type = PURCHASEORDER. *5
    txn:FileControlNumber [1...1] String [1/20] - M Unique file control ID number. *6
    txn:FileDate [0...1] Date [10/*] - O Date file generated. *7
    txn:FileTime [0...1] Time [8/*] - O Time file generated. *8
  PO_HeaderRecord [1...1] - - - M PO header record.
    txn:PurchaseOrderNumber [1...1] String [1/35] - M PO number. *9
    txn:PurchaseOrderDate [1...1] Date [10/*] - M PO date. *10
    txn:RequestedDeliveryDate [0...1] Date [10/*] - O Requested delivery date. *11
    txn:OrderAcknowledgementRequired [0...1] String [0/5] - O Order acknowledgment flag.
    txn:OrderCurrency [0...1] String [1/3] CurrencyCodeType O Order currency. *12
    txn:ExchangeRate [0...1] String [0/12] - O Exchange rate if foreign currency.
    txn:TermsOfPaymentCode [0...1] String [0/17] - O Terms of payment. *13
    txn:OrderDocumentType [0...1] String [0/10] - O Identifies type of order in file.
    txn:ShippingConditions [0...1] String [0/2] - O Shipping conditions code for whole order.
    txn:ShippingConditionsDescription [0...1] String [0/20] - O Shipping conditions description.
    txn:RecipientNumber [0...1] String [0/80] - O Customer's partner number for order recipient. *14
    txn:SalesOrderNumber [0...1] String [0/35] - O Sales order number.
    txn:SalesOrderDate [0...1] Date [10/*] - O Sales order date.
    txn:SupplierInternalPurchaseOrderNumber [0...1] String [0/35] - O Supplier's internal or alternate PO number. *15
  PO_HeaderPartnerAddressGroup(1) [1...*] - - - M Sold-to customer partner information instance of PO_HHeaderPartnerAddressGroup. txn:PartnerTypeHandlingCode = CUSTOMER maps to --> PartnerTypeHandlingCode = SP.
    txn:PartnerTypeHandlingCode [1...1] String [1/15] PartnerTypeHandlingCode M Partner type qualifier code. *16
    txn:PartnerNumber [0...1] String [0/80] - O Customer ID. *17
    txn:AlternatePartnerNumber [0...1] String [0/80] - O Alternate partner ID.
    txn:PartnerName1 [0...1] String [0/35] - O Name (line 1). *18
    txn:PartnerName2 [0...1] String [0/35] - O Name (line 2).
    txn:PartnerStreetAddress1 [0...1] String [0/35] - O Main street address. *19
    txn:PartnerStreetAddress2 [0...1] String [0/35] - O Street address (line 2).
    txn:PartnerCity [0...1] String [0/35] - O City. *20
    txn:PartnerRegionCode [0...1] String [0/*] - O State, province, or region. *21
    txn:PartnerPostalCode [0...1] String [0/15] - O Postal code. *22
    txn:PartnerCountry [0...1] String [0/*] CountryCode O 2-char ISO country key. *23
    txn:PartnerISOLanguageKey [0...1] String [0/3] - O ISO language key. *24
    txn:PartnerTelephone [0...1] String [0/25] - O Contact telephone number. *25
    txn:PartnerFax [0...1] String [0/25] - O Contact fax number. *26
  PO_HeaderPartnerAddressGroup(2) [1...*] - - - M Supplier partner information instance of PO_HeaderPartnerAddressGroup. txn:PartnerTypeHandlingCode = SUPPLIER maps to --> PartnerTypeHandlingCode = SU.
    txn:PartnerTypeHandlingCode [1...1] String [1/15] PartnerTypeHandlingCode M Partner type qualifier code. *27
    txn:PartnerNumber [0...1] String [0/80] - O Supplier number. *28
    txn:AlternatePartnerNumber [0...1] String [0/80] - O Alternate partner ID. *29
    txn:PartnerName1 [0...1] String [0/35] - O Name (line 1). *30
    txn:PartnerName2 [0...1] String [0/35] - O Name (line 2).
    txn:PartnerStreetAddress1 [0...1] String [0/35] - O Main street address. *31
    txn:PartnerStreetAddress2 [0...1] String [0/35] - O Street address (line 2).
    txn:PartnerCity [0...1] String [0/35] - O City. *32
    txn:PartnerRegionCode [0...1] String [0/*] - O State, province, or region. *33
    txn:PartnerPostalCode [0...1] String [0/15] - O Postal code. *34
    txn:PartnerCountry [0...1] String [0/*] CountryCode O 2-char ISO country key. *35
    txn:PartnerISOLanguageKey [0...1] String [0/3] - O ISO language key. *36
    txn:PartnerTelephone [0...1] String [0/25] - O Contact telephone number. *37
    txn:PartnerFax [0...1] String [0/25] - O Contact fax number. *38
  PO_HeaderPartnerAddressGroup(3) [1...*] - - - M Ship-to customer partner information instance of PO_HeaderPartnerAddressGroup. txn:PartnerTypeHandlingCode = SHIPTO maps to --> PartnerTypeHandlingCode = SH.
    txn:PartnerTypeHandlingCode [1...1] String [1/15] PartnerTypeHandlingCode M Partner type qualifier code. *39
    txn:PartnerNumber [0...1] String [0/80] - O Ship-to party ID. *40
    txn:AlternatePartnerNumber [0...1] String [0/80] - O Alternate partner ID.
    txn:PartnerName1 [0...1] String [0/35] - O Name (line 1). *41
    txn:PartnerName2 [0...1] String [0/35] - O Name (line 2).
    txn:PartnerStreetAddress1 [0...1] String [0/35] - O Main street address. *42
    txn:PartnerStreetAddress2 [0...1] String [0/35] - O Street address (line 2).
    txn:PartnerCity [0...1] String [0/35] - O City. *43
    txn:PartnerRegionCode [0...1] String [0/*] - O State, province or region. *44
    txn:PartnerPostalCode [0...1] String [0/15] - O Postal code. *45
    txn:PartnerCountry [0...1] String [0/*] CountryCode O 2-char ISO country key. *46
    txn:PartnerISOLanguageKey [0...1] String [0/3] - O ISO language key. *47
    txn:PartnerTelephone [0...1] String [0/25] - O Contact telephone number. *48
    txn:PartnerFax [0...1] String [0/25] - O Contact fax number. *49
  PO_HeaderAdditionalDocumentsGroup [0...*] - - - O Group stores additional document type numbers and dates in PO.
    txn:DocumentTypeHandlingCode [1...1] String [1/15] DocumentType M Document type qualifier code. *50
    txn:DocumentNumber [1...1] String [1/35] - M Document ID number. *51
    txn:DocumentLineItem [0...1] String [0/6] - O Document line item number.
    txn:DocumentDate [0...1] Date [10/*] - O Date document issued. *52
  PO_HeaderAdditionalDatesGroup [0...*] - - - O Group records additional date types.
    txn:DateTypeHandlingCode [1...1] String [1/15] DateType M Date type qualifier code. *53
    txn:Date [1...1] Date [10/*] - M Date reported. *54
    txn:Time [0...1] Time [8/*] - O Time reported. *55
  PO_HeaderDeliveryTerms [0...*] - - - O Delivery terms for order.
    txn:DeliveryTypeHandlingCode [1...1] String [0/15] DeliveryTypes M Delivery type qualifier code. *56
    txn:DeliveryTermsCode [0...1] String [0/3] - O Delivery terms code. *57
    txn:DeliveryTermsDescription [0...1] String [0/70] - O Delivery terms code description. *58
    txn:DeliveryPriority [0...1] String [0/2] - O Delivery priority.
  PO_HeaderPaymentTerms [0...*] - - - O Payment terms for order.
    txn:PaymentTermsHandlingCode [1...1] String [0/15] PaymentTerms M Payment terms qualifier code.
    txn:PaymentTermsInDays [0...1] String [0/8] - O Payment terms in number of days.
    txn:PaymentTermsPercent [0...1] String [0/8] - O Payment terms in percent.
    txn:PaymentTermsDescription [0...1] String [0/70] - O Description of payment terms.
  PO_HeaderOrganizationTypeGroup [0...*] - - - O Organization groups, including plant.
    txn:OrganizationTypeHandlingCode [1...1] String [0/15] OrgType M Organization type qualifier code. *59
   

txn:OrganizationType

 [0...1] String [0/35] - O Organization name. *60
  PO_HeaderAdditionalDataGroup [0...*] - - - O Additional data group.
    txn:AdditionalDataHandlingCode [0...1] String [0/15] - O Additional data qualifier code.
    txn:AdditionalData [0...1] String [0/35] - O Additional data element.
    txn:AdditionalDataText [0...1] String [0/40] - O Additional data text.
  PO_HeaderFreeTextGroup [0...*] - - - O -
    txn:FreeTextHandlingCode [0...1] String [0/15] - O Free text record qualifier code. *61
    txn:FreeTextObject [0...1] String [0/10] - O Free text business document object. *62
    txn:FreeTextLanguageKey [0...1] String [0/3] - O ISO language key for text. *63
    txn:FreeTextContents [0...1] String [0/70] - O Free text contents. *64
    txn:FreeTextFormat [0...1] String [0/2] - O Format for text block: continuous text flow (*) or line break (/). *65
  PO_ItemDetails [1...*] - - - M Materials consumed item details records.
    txn:ItemNumber [1...1] String [0/6] - M Line item number. *66
    txn:ItemAction [0...1] String [0/15] ItemActionCode O Identifies action taken on item. Relevant for PO acknowledgment.
    txn:ItemAcknowledgementStatus [0...1] String [0/15] - O Acknowledgment status for item. Relevant for PO acknowledgment.
    txn:AcknowledgementRequired [0...1] String [0/5] - O Acknowledgment of PO required flag.
    txn:CustomerMaterialNumber [1...1] String [0/35] - M Customer material number. *67
    txn:MaterialDescription [1...1] String [0/70] - M Customer material description. *68
    txn:SupplierMaterialNumber [0...1] String [0/35] - O Supplier material number. *69
    txn:CustomerLotNumber [0...1] String [0/35] - O Customer lot or batch number. *70
    txn:ItemQuantity [1...1] - - - M Total quantity ordered in item with UOM.
      txn:TotalItemQuantityOrdered [1...1] String [0/15] - M Total quantity ordered. *71
      txn:TotalQuantityUnitOfMeasure [1...1] String [0/3] UnitOfMeasure M Unit of measure for quantity ordered. *72
    txn:ItemUnitPrice [0...1] String [0/18] - O Unit price for item. *73
    txn:PricingUnitNumerator [0...1] String [0/9] - O Pricing unit per used to calculate item net price. *74
    txn:ItemNetValue [0...1] String [0/18] - O Net value of item. *75
    txn:ItemGrossValue [0...1] String [0/18] - O Gross price for item including surcharges, discounts, and taxes. *76
    txn:ItemCurrency [0...1] String [1/3] CurrencyCodeType O Line item currency. *77
    txn:ItemNetWeight [0...1] - - - O Net weight with UOM.
      txn:NetWeight [0...1] String [0/18] - O Total net weight for item.
      txn:NetWeightUnitOfMeasure [0...1] String [0/3] UnitOfMeasure C Unit of measure for net weight.
Mandatory if ItemNetWeight is populated.
    txn:ItemMaterialClass [0...1] String [0/9] - O Material class or group code for item. *78
    txn:PurchaseOrderNumber [0...1] String [0/35] - O Referenced PO number.
    txn:PurchaseOrderLineItemNumber [0...1] String [0/6] - O Referenced PO line item number.
    txn:RejectionReasonCode [0...1] String [0/2] - O Code identifying reason item was rejected. Only relevant for PO Acknowledgment.
    txn:RejectionReasonCodeDescription [0...1] String [0/40] - O Description of rejection reason code. Only relevant for PO Acknowledgment.
    txn:ItemPlant [0...1] String [0/4] - O Plant ID where item is located. *79
    txn:ItemStorageLoc [0...1] String [0/4] - O Storage location in plant for item. *80
    txn:ItemDeliveryPriority [0...1] String [0/2] - O Priority assigned to delivery of item.
    txn:ItemDeliveryPriorityDescription [0...1] String [0/20] - O Description of delivery priority.
    txn:ItemRoute [0...1] String [0/6] - O Code for route that will be used to deliver item to customer.
    txn:ItemRouteDescription [0...1] String [0/40] - O Description of item route code.
    txn:ShippingReceivingPoint [0...1] String [0/4] - O Shipping/receiving point. *81
    txn:SalesDocumentItemCategory [0...1] String [0/4] - O Sales document item category.
    txn:BillOfMaterialsFlag [0...1] String [0/6] - O Identifies top level item of Bill of Materials.
    txn:BillOfMaterialsLevel [0...1] String [0/6] - O For future use... BOM item level (1,2,3).
    txn:PriceUnitConversionDenominator [0...1] String [0/6] - O Denominator (divisor) for conversion of sales quantity into SKU quantity. *82
    txn:PriceUnitConversionNumerator [0...1] String [0/6] - O Numerator (factor) for conversion of sales quantity into SKU quantity. *83
    txn:NumberPartialDeliveries [0...1] String [0/1] - O Maximum number of partial deliveries for item. *84
    txn:LineItemDetailsGroup [1...1] - - - M Line item details complex type.
      txn:POItemDeliveryScheduleGroup [1...*] - - - M Scheduled quantities and dates for split deliveries.
        txn:DeliveryQuantityOrdered [1...1] - - - M Scheduled delivery quantity ordered with UOM.
          txn:ScheduledDeliveryQuantity [1...1] String [0/15] - M Scheduled delivery quantity. *85
          txn:ScheduledDeliveryUnitOfMeasure [1...1] String [0/3] - M Unit of measure for quantity to be delivered. *86
        txn:ScheduledDeliveryDate [1...1] Date [10/*] - M Date quantity of item to be delivered. *87
      txn:PO_ItemAdditionalMaterialsGroup [0...*] - - - O Additional materials group.
        txn:MaterialTypeHandlingCode [0...1] String [1/15] MaterialsType O Materials type qualifier code. *88
        txn:MaterialLotNumber [0...1] String [0/35] - O Material or batch number of item. *89
        txn:MaterialLotDescription [0...1] String [0/70] - O Description of item. *90
      txn:PO_ItemPricingDiscountGroup [0...*] - - - O Pricing, surcharges, discounts, taxes, and other customer item pricing data.
        txn:AdditionSubtractionIndicator [0...1] String [0/1] - O Identifies pricing record as debit (-) or credit (+).
        txn:PricingDiscountType [0...1] String [0/5] - O Pricing record type code.
        txn:PricingDiscountDescription [0...1] String [0/80] - O Text description for pricing record type.
        txn:PricingDiscountAmount [0...1] String [0/18] - O Fixed total amount in pricing record.
        txn:PricingDiscountUnitPrice [0...1] String [0/18] - O Unit price for pricing record.
        txn:PricingDiscountPricingUnit [0...1] String [0/9] - O Pricing unit used to calculate pricing amount.
        txn:PricingDiscountUnitOfMeasure [0...1] String [0/3] - O Unit of measure used in pricing record.
        txn:PricingDiscountCurrency [0...1] String [1/2] CurrencyCodeType O Pricing record currency.
      txn:PO_ItemAdditionalDocumentsGroup [0...*] - - - O Group stores additional document type numbers and dates in PO at item level.
        txn:DocumentTypeHandlingCode [1...1] String [1/15] DocumentType M Document type qualifier code. *91
        txn:DocumentNumber [1...1] String [1/35] - M Document ID number. *92
        txn:DocumentLineItem [0...1] String [0/6] - O Document line item number. *93
        txn:DocumentDate [0...1] Date [10/*] - O Date document issued. *94
      txn:PO_ItemAdditionalDatesGroup [0...*] - - - O Additional date types at item level.
        txn:DateTypeHandlingCode [1...1] String [1/15] DateType M Date type qualifier code. *95
        txn:Date [0...1] Date [10/*] - O Date reported.
        txn:Time [0...1] Time [8/*] - O Time reported.
      txn:PO_ItemPartnerAddressGroup [0...*] - - - O Ship-to partner ID and address data at item level, if present in transaction.
        txn:PartnerTypeHandlingCode [1...1] String [1/15] - M Partner type qualifier code. *96
        txn:PartnerNumber [0...1] String [0/80] - O Customer ID. *97
        txn:AlternatePartnerNumber [0...1] String [0/80] - O Alternate partner ID.
        txn:PartnerName1 [0...1] String [0/35] - O Name (line 1). *98
        txn:PartnerName2 [0...1] String [0/35] - O Name (line 2).
        txn:PartnerStreetAddress1 [0...1] String [0/35] - O Main street address. *99
        txn:PartnerStreetAddress2 [0...1] String [0/35] - O Street address (line 2).
        txn:PartnerCity [0...1] String [0/35] - O City. *100
        txn:PartnerRegionCode [0...1] String [0/*] - O State, province, or region. *101
        txn:PartnerPostalCode [0...1] String [0/15] - O Postal code. *102
        txn:PartnerCountry [0...1] String [0/*] CountryCode O 2-char ISO country key. *103
        txn:PartnerISOLanguageKey [0...1] String [0/3] - O ISO language key. *104
        txn:PartnerTelephone [0...1] String [0/25] - O Contact telephone number. *105
        txn:PartnerFax [0...1] String [0/25] - O Contact fax number. *106
      txn:PO_ItemDeliveryTerms [0...*] - - - O Delivery terms for order at item level.
        txn:DeliveryTypeHandlingCode [1...1] String [0/15] DeliveryTypes M Delivery type qualifier code. *107
        txn:DeliveryTermsCode [0...1] String [0/3] - O Delivery terms code. *108
        txn:DeliveryTermsDescription [0...1] String [0/70] - O Delivery terms code description. *109
        txn:DeliveryPriority [0...1] String [0/2] - O Delivery priority.
      txn:PO_ItemAdditionalDataGroup [0...*] - - - O Payment terms for order.
        txn:AdditionalDataHandlingCode [0...1] String [0/15] - O Additional data qualifier code.
        txn:AdditionalData [0...1] String [0/35] - O Additional data element.
        txn:AdditionalDataText [0...1] String [0/40] - O Additional data text.
      txn:PO_ItemFreeTextGroup [0...*] - - - O Free text and notes complex type.
        txn:FreeTextHandlingCode [0...1] String [0/15] - O Free text record qualifier code. *110
        txn:FreeTextObject [0...1] String [0/10] - O Free text business document object.
        txn:FreeTextLanguageKey [0...1] String [0/3] - O ISO Language key for text. *111
        txn:FreeTextContents [0...1] String [0/70] - O Free text contents. *112
        txn:FreeTextFormat [0...1] String [0/2] - O Format for text block: continuous text flow (*) or line break (/). *113