A NEW TODAY IS DAWNING!

Purchase Order XML Format

Posted Sat, 27 Mar 2010 - 04:52 by admin

 

Introduction

The OCS applications allow for purchase orders to be sent to the supplier using XML.

The purchase order XML document conforms to the OCS Purchase order schema. These files may be sent to suppliers using any readily available mechanism such as HTTP, HTTP/S or SMTP.

The OCS application also accepts purchase order responses/acknowledgments from the supplier to confirm the receipt of the purchase order.
 

Purchase Order Format

The OCS XML purchase order conforms to the following schema:

ocspurchaseorder.xsd

The following is a sample of an OCS XML purchase order:

ocspurchaseorder.xml

This table describes each of the purchase order xml elements:

XML Element  Description
Company
Name The name of the company purchasing the goods/services
Address1 First line of the company address
Address2 Second line of the company address
City Company city
State Company state
PostCode Company post code
Phone Company phone number
ACN Company ACN
Fax Company fax number
SalesTaxCertificate Company sales tax exemption number
Supplier
SupplierCode The code for the supplier the goods/services are being purchased from
Name The name of the supplier the goods/services are being purchased from
Address1 First line of the supplier address
Address2 Second line of the supplier address
City Supplier city
State Supplier state
PostCode Supplier post code
Contact Supplier contact
OrderHeader
OrderType The purchase order type

OrderNumber

The purchase order number

OrderDate

Date purchase order was raised on the purchase order header
ReceivingSite The site the purchase order is to be received at
ReceivingWarehouse The warehouse the purchase order is to be received at

Cancelled

 Y/N value to indicate if the purchase order is cancelled

Reprint

Y/N value to indicate if the purchase order is a reprint of an existing order

BuyerName

The name of the buyer responsible for this purchase order

BuyerPhone

Buyer phone number

Currency

Currency the order is based on

PrintDate

The date the order sent (printed, faxed, electronically sent etc.)

DeliveryInstructionCode

The code for the delivery instructions

DeliveryInstructions

Text based delivery instructions

DeliveryLocationCode

The code for the delivery location

DeliveryLocation

Text based delivery location

SpecialInstructionsCode

The code for the special instructions

SpecialInstructions

Text based special instructions

OrderTerms

Text based order terms

Revision

The revision of the purchase order (starting from 0)

Remaks

Text based header remarks
OrderLines
LineNumber The purchase order line number

Action

Used for identifying modified and added lines for revised purchase orders.

Valid values are:

Blank - No Change(or first revision)

Added - For added Lines

Modified - For modified lines

DestinationSite

The destination site

DestinationWarehouse

The destination warehouse

DueDate

The date the purchase order line is due

Agreement

Agreement number

Quantity

The quantity to purchase

UnitPurchase

The unit to purchase the item in

Requisition

Requisition reference number

Status

Either Active or Cancelled

Priority

The priority of the purchase

UnitPrice

The unit price of the item

LineValue

The value of the line (excluding GST)

GSTValue

The GST component of the line

DiscountValue

Any discount to be applied

SalesTaxDescription

The sales tax description

SalesTax Value

Value of any sales tax
GSTExempt Indicates if the item is GST exempt
FreightValue The freight cost for the line
OnCostValue Any other associated costs for the line
StockNumber The OCS stock number for the item
SubStock The OCS sub-stock for the item
ItemDescription Text based item description
PatternedDescription Text based item patterned description
UnpattereneDescription Text base item unpatterned description
Manufacturer The manufacturer code of the item
PartNumber The part number of the item
TBACode "To Be Advised" Code
TBADetails Text based TBA description
LineRemark Text based line remarks
PackingInstructions Text based packing and marking instructions
OrderTotals
FreightTotal The total freight for the purchase order

OnCostTotal

The total of other associated costs for the purchase order

OrderTotal

The total order value

 

Purchase Order Response Format

The  purchase order response must be a valid XML document that has a CustomerPONumber element within the document. This element must have a value that corresponds with the concatenated OrderType and OrderNumber sent in the original order.
 

The following is a sample of an OCS XML purchase order response:

ocspurchaseorderresponse.xml