Import - Customer Order Specifications for Sales and Purchases

Description

This document explains each Tag format and function required to provide a well-formed XML Customer sale/Purchase order as input to WMS.

Orders can also be described as Purchases or Sale Orders and acronyms such as PO, SO.

Detail Steps

tREMOTETransHeader

Sales Order header information

TAG NAME	TAG EXAMPLE	Description	Details	Size	Type	Usage
NewDataSet		Required SCHEMA formatting for a Sale Order	Tag should be closed at end of file data			R
tREMOTETransHeader						R
DTD	EdifactV2	The document encoding type	Required for Edifact users requiring response codes	50	NVARCHAR	O
RevisionNumber	1	PO always Revision 1	fix to 1	3	INT	R
Company_ID	DATAPEL	Value must be DATAPEL	Required. Set to “DATAPEL”	7	NVARCHAR	R
StoreCode	SYD	Location Ship From Code	Required but can be blank. Assigned as default location from WMS configuration	50	NVARCHAR	R
PostingDate	2009-04-29T10:12:20+	DateTime of Transaction	Order Date. Suggested format YYYY-MM-DDTHH:MM:SS+ where T and + are separators and terminators		INT	R
TransID	164101	Invoice Number	Can be Blank for WMS to allocate next INV number	8	NVARCHAR	R
TransDate	2009-04-29T10:12:20+	DateTime of Transaction	Promised Date Suggested format YYYY-MM-DDTHH:MM:SS+ where T and + are separators and terminators		INT	R
Salesperson	Long	Salesperson ID	Last name of Salesperson or card Identification. If “DEFAULT”, substituted with default Salesperson	52	NVARCHAR	O
CustomerID	2	Customer ID	MYOB CARD RECORD ID		INT	O
CardIdentification	CUS0000001	MYOB Card Identification or MYOB Tax ID	Required if CustomerID not present. Card Identification of Billing Customer.	16	NVARCHAR	O
MYOBCardName	The Shoe Shop	Card Name exactly as stored in MYOB/WMS	Required if CustomerID not populated/unmatched or CardIdentification of Billing Customer not populated/unmatched.	50	NVARCHAR	O
SHIPCustomerID	2	Customer ID	Optional MYOB CARD RECORD ID		INT	O
SHIPCardIdentification	CUS0000001	MYOB Card Identification or MYOB Tax ID	Optional. Card Identification of Receiving Customer.		INT	O
SaleType	S	Type is S - Sale O - Order Q - Quote R- Blind Return X- Exchange	S and O for import as order, Q to import as Quote, response file example STDs = R will be a blind return and creates a Goods Inward (as per Sales return workflow), X will create a Sale Order with pick lines - no goods inward and is recommended for workflows where the stock is immediately returned into inventory.	1	NVARCHAR	R
Status	O	NOT RELEVANT IF REMOTE SALE IMPORT AUTO PICK/PACK is SET	O - default Order A - PICK (Sale Type must be Order/Invoice) picks available inventory D- picks packs and Ships if all stock available.	1	NVARCHAR	O
Allocate	Y	Allocates whole order regardless of availability (Does not split allocate)	"Y" OR "T" If Used then AllocateDate is set to Imported dated	1	NVARCHAR	0
Special2	2000	Customers Purchase Order No.		50	NVARCHAR	O
Notes			“Comment” field in Sale Order	255	NVARCHAR	O
SaleNote		WMS Field Sale Notes	Optional	2500	NVARCHAR	O
ShipNote			“Ship Note” field in WMS Sale Order	200	NVARCHAR	O
TERMS			Terms - (attempts Match)if unused/blank then default on card	30	NVARCHAR	O
Priority		Maps to WMS Order Priority HIGH, HOLD, LOW or as a number (0-3)	Optional	1	INT	O
ShippingMethod			“Name of Method” or “Default” will use customer default shipping method	255	NVARCHAR	O
ConNote		ConNote - Consignment Number	(ASSIGNED IF ALLOCATE SELECTED OR AUTOPICK SET OTHERWISE IGNORED)	50	NVARCHAR	O
Sent2HostDateTime	2008-04-30T17:02:11	Optional DateTime of XML Emit	Optional. Used for logging		INT	O
ReferralSource		ReferralSource - mapped to MYOB/WMS referral source descriptions	Optional	32	NVARCHAR	O
UDF1	a1b2text	Custom Data Field	Optional (STD usage = Advertisement Date)	200	NVARCHAR	O
UDF2	a1b2text	Custom Data Field	Optional (STD usage = Dept/Zone)	200	NVARCHAR	O
UDF3	a1b2text	Custom Data Field	Optional (STD usage = Department / Zone Description)	200	NVARCHAR	O
OriginalTransID	164101		Internal ref maps to SAL_EDItransid	50	NVARCHAR	O
SuppressKits	False	Set to True, Yes, False or No	Setting this tag in the XML Sale Header (not done per line) will cause any KIT item to be ignored and imported as a standard item code with the assigned pricing or price by host. (useful when you want to import the kit as a whole not just the kit header)	5	NVARCHAR	O
/tREMOTETransHeader

Usage = R - Required, O - Optional, N - Not In Use

tREMOTETransHeader/Company_ID - Please put “DATAPEL” for all orders to identify the processing process model for WMS.
tREMOTETransHeader/TaxInclusive - Order processed as tax inclusive in WMS, please put “TRUE”, else leave blank.
If there is a shipping method/cost involved you can specify using the following tags, the shipping method and cost will come through to WMS as separated order line within the order.
tREMOTETransHeader/ShippingCost - Shipping cost, tax inclusive.

tREMOTETransSaleLines

Sale Order line information (multiple allowed)

TAG NAME	TAG Example	Description	Detail	Size	Type	Usage
tREMOTETransSaleLines			Require SCHEMA formatting for each sale line
SKU	320	Product Number / Barcode	Required. Use same item number or Barcode (normally CF1,CF2,CF3 or UDF1) as specified in MYOB, any line with item that cannot be identified cause the entire order to be OnHold and Item number to be entered with “\c” code	50	NVARCHAR	R
HOSKU	32102	Product Number / Barcode	If the is not found it will try for HOSKU if populated	50	NVARCHAR	O
SaleQty	1	Quantity Sold	Required (unless is populated). as Quantity Sold (eg. Piece)		INT	R
SaleUnitQty	1	Unit Sold	Required (unless is populated. as Unit Sold (eg. Box)		INT	R
SaleUnitAmountIncTax	9.95	Sale Unit Price	Required if . as per Agreed Unit Sale Price Inc Tax - field takes presidence over if populated		Float	R
SaleUnitAmountExcTax	9.95	Sale Unit Price	Required if is Blank or NULL. as per Agreed Unit Sale Price Excl Tax		Float	R
SaleTaxByHost	Y	Tax code and amount to be set By the WMS	If Null then next check is	3	NVARCHAR	O
SaleTaxCode	N-T	Tax Code	if N or NULL then, sets exact Tax Code on sale but is required for kit headers in all cases	3	NVARCHAR	O
SaleTaxRate	10.00	Tax Rate (in Percent value e.g 10.00%)	Ignored if match is found. if N and VAT<\TaxCode> <> existing Tax Code in MYOB or BOTH NULL then(10.00 for GST, 0 for N-T)(Auto calculates unit price = SaleUnitAmountIncTax / (1+(SaleTaxRate/100)) )		Float	O
SaleTaxUnitAmount	0.90	Tax Amount	If > 0, automatically changes Tax to GST for line item		Float	O
SKUDescription	Clown Dots	Product Description	If blank allocates default item description (You may also add line Promised Date (not after date) here in the format of #D27/08/2014 it must be at the end of the line description)	255	NVARCHAR	O
LineNote	May We have Blue Please	Additional Product Description		200	NVARCHAR	O
JobCode	JobCode	Job Code (Must already be in the Job Code List to apply/ no new additions)		50	NVARCHAR	O
JobNote	JobCodeNote	Additional Text Field	Delivery Store ID for Multi Delivery Orders	250	NVARCHAR	O
SaleUnitDiscount	25.50	Discount - This is the discount percentage.			Float	O
SaleRRP	9.95	RRP Unit Price	Optional. Recommended Unit Retail Sale Price Inc Tax			N
SalePriceByHost	Y	Y = Price Set By WMS N = Price Set by Import File	Optional - Price set by import file for NULLS	3	NVARCHAR	O
CurrencyCode	A	Set to A				N
SaleLineNo	1				INT	O
Cost	0.0000	Set to 0.0000			Float	O
/tREMOTETransSaleLines		End Sale Line				R

Usage = R - Required, O - Optional, N - Not in Use

tREMOTETransSaleTenders

Sale Order Payment / Tender information

IMPORTANT: Does not create payment in WMS. Add a line to notify user of payment amount and method.Up to user to then verify, create payment in WMS order and delete line item.

TAG NAME	TAG Example	Description	Details	Size	Type	Usage
tREMOTETransSaleTenders		ONLY ONE NODE supported
TenderType	Securepay	Payment Method	Required. Accounting Payment Methods e.g. Credit Card, PayPal. The payment type matching a payment method in the MYOB/WMS database. If no match is found a new comment line will be created within the order to specify the payment type and amount, and users will need to process it in their system manually	50	NVARCHAR	O
TenderAmount	9.95	Payment Amount	Required. Tax Inclusive Payment Total		Float	O
CurrencyCode	A	Set to A	Optional			O
ForeignTenderAmount	0.0000	Set to 0.0000	Optional			O
TenderLine	1		Optional.			O
tREMOTETransSaleTenders		-	Schema End			R

IMPORTANT: If users need to process the payment information as single payment applied directly to the sale order then set Tools > Preferences > Adaptors > Process Payment Information from Remote Sales, as checked, otherwise all payment information will be appear as a comment line in the order by default and is manually reconciled.

tREMOTETransCustomer

Sale Order Customer / Shipping Information

TAG NAME	TAG Example	Description	Details	Size	Type	Usage
tREMOTETransCustomer		–	Schema Format Node
ShipToName	gtp test	SHIP TO Customer Name	Company or Last Name of Customer			O
ShipToAddress1	174 Hampden Road	SHIP TO Address Line 1				O
ShipToAddress2		Address Line 2				O
ShipToSuburb	NEDLANDS	SHIP TO Suburb				O
ShipToPostCode	6009	SHIP TO Post Code				O
FaxNo		Fax				O
PhoneNo1	1300 856 533 1300 856 533	Phone Contact	Optional			O
PhoneNo2		Phone Contact				O
EmailAddress	[email protected]	Email Address	When populated and if UDF3 is null or "" then data within this field will populate UDF3			O
Sent2HostDateTime	2009-04-29T10:12:20	Optional DateTime of XML Emit	Optional. Used for logging			O
/tREMOTETransCustomer			Schema Node End			R

IMPORTANT: Use TransCustomer to manually allocate shipping address. Primary billing information is assigned by CardIdentification in TransSaleHeader.

Related Information

XML Text Encoding Rules

Preferred encoding UTF-8

The fields in the xml file should not use cdata and should not contain any of the following characters without encoding ~ < > & TAB CR LF ( ascii 10 / 13)

Special Characters

Characters used in programming should be encoded as below.

~ - ~tl~
< - ~lt~
”>” - ~gt~
& - ~am~
Chr(9) - ~09~
Chr(10) - ~10~
Chr(13) - ~13~
' Single quotes do not require any encoding.

Import Sales TSV

Invoice Date for Sales Order

Advanced Shipping Notice / Invoice

Customer sale & Purchase Order Update/Change

Purchase Order Acknowledgement