Invoice Download XML Message (CWInvoiceOut)

 

The invoice download message contains invoice information to send from Order Management System to another system, such as a retail store or financial system. See Generic Invoice Download API for an overview.

Message formatting specific to invoice download:

• A separate message is generated for each debit or credit invoice you create.

• Decimal points are included in numeric fields.

• All dates are in YYYY-MM-DD format.

• All times are in HH:MM:SS format.

• If you exclude the element InvoiceHeader and all of its children (using the Invoice Outbound XML Inclusion rules), the system sends an invoice download message including only the Message element and its attributes:

See Generic Download Message Formatting for more information on how the system formats all download messages.

Invoice download message: See Invoice Download Message: Sample XML for a sample message.

Attribute Name

Type

Length

Comments

Message

One Message element is required.

source

alpha

 

Identifies the source of the XML message.

target

alpha

 

Identifies the target of the XML message.

type

alpha

 

Identifies the type of information in the XML message. CWINVOICEOUT indicates the message contains invoice download information.

date_created

numeric

10

The date the XML message was generated, in YYYY-MM-DD format.

time_created

numeric

8

The time the XML message was generated, in HH:MM:SS format.

InvoiceHeader

There is one InvoiceHeader element for each invoice download message. For example, if you create 2 invoices, the system generates a separate invoice download message for each invoice.

ihd_transaction_

type

alpha

1

Indicates the type of invoice information being downloaded.

A (add): new invoice.

C (change): updated invoice.

ihd_company

numeric

3

The Order Management System company where the invoice is located.

From the Company in the Invoice Header table.

ihd_order_nbr

numeric

8

The order number associated with the invoice.

From the Order # in the Invoice Header table.

ihd_invoice_nbr

numeric

7

The invoice number assigned to the customer’s bill or credit.

From the Invoice # in the Invoice Header table.

ihd_invoice_type

alpha

1

Indicates the type of invoice.

C (Credit memo) = Invoice credit.

I (Invoice) = Invoice debit.

From the Invoice type in the Invoice Header table.

ihd_sj_print_date

numeric

8

The date you printed the sales journal that included the invoice in MMDDYYYY format.

From the SJ printed date in the Invoice Header table.

ihd_invoice_print_date

numeric

8

The date you printed the invoice in MMDDYYYY format.

From the Invoice print date in the Invoice Header table.

ihd_invoice_

currency_code

alpha

3

A code for the currency of the invoice.

From the CUR currency code in the Invoice Currency table.

ihd_invoice_

currency_desc

alpha

30

A description of the currency.

From the CUR currency description in the Currency table.

ihd_invoice_

currency_rate

numeric

11.7

The currency rate for the currency at the time the order was placed.

From the ICF billing currency rate in the Invoice Currency table.

CompanyAddress

There is one CompanyAddress element for each invoice download message.

company_

description

alpha

30

The Description from the Company table.

company_

address1

alpha

32

The first address line from the Company Address table.

company_

address2

alpha

32

The second address line from the Company Address table.

company_city

alpha

25

The City from the Company Address table.

company_state

alpha

2

The State from the Company Address able.

company_state_

name

alpha

25

The Description from the State table.

company_zip

alpha

10

The Zip from the Company Address table.

company_country

alpha

3

The Country from the Company Address table.

company_country_name

alpha

30

The Description from the Country table.

company_phone

alpha

14

The Phone number from the Company Address table.

company_fax

alpha

14

The Fax number from the Company Address table.

OrderHeader

There is one OrderHeader element for each invoice download message.

ohd_reference_

order_nbr

alpha

30

The Order Management System order number.

From the Order # in the Order Header table.

ohd_order_status

alpha

1

The status of the order.

blank = Open.

X = Closed.

From the OHD order status in the Order Header table.

ohd_nbr_of_

recipients

numeric

3

The number of recipients on the order. Every order has at least one recipient.

From the OHD # of recipients in the Order Header table.

ohd_order_date

numeric

10

The date the order was placed in YYYY-MM-DD format.

From the OHD order date in the Order Header table.

ohd_enter_date

numeric

10

The date the order was entered in YYYY-MM-DD format.

From the OHD entered date in the Order Header table.

ohd_enter_time

numeric

8

The time the order was entered in HH:MM:SS format.

From the Entered time in the Order Header table.

ohd_batch_

sequence_nbr

numeric

7

The sequence number assigned to the order batch that includes the order.

From the OHD batch sequence # in the Order Header table.

ohd_user_defined_date

numeric

10

A user-defined date in YYYY-MM-DD format.

From the OHD user defined date in the Order Header table.

ohd_billing_batch_nbr

numeric

9

The billing batch number assigned to the order.

From the OHD billing batch # in the Order Header table.

ohd_order_

channel

alpha

2

Indicates if the order is an e-commerce order.

I = Internet (e-commerce) order.

From the OHD future use sts 1 in the Order Header table.

ohd_master_

carton_label

alpha

1

Indicates whether the system prints a master pick slip for the order.

Y = The system prints a master pick slip for the order.

N = The system does not print a master pick slip for the order.

From the OHD master carton label? in the Order Header table.

ohd_membership_id

alpha

12

A code that identifies the membership program assigned to the sold to customer on the order.

From the MEM membership ID in the Order Header table.

ohd_membership_seq_nbr

numeric

3

The sequence number assigned to the membership program on the order.

From the CSM sequence # in the Order Header table.

ohd_order_batch_nbr

numeric

5

The order batch number assigned to the order.

From the OBA batch # in the Order Header table.

ohd_order_type

alpha

1

A code for the type of order, such as telephone or e-commerce.

From the OTY order type in the Order Header table.

ohd_order_type_

description

alpha

30

A description of the type of order.

From the OTY description in the Order Type table.

ohd_salesman_

nbr

numeric

7

A number for the salesman associated with the order.

From the SLS salesman # in the Order Header table.

ohd_salesman_

name

alpha

30

The name of the salesman associated with the order.

From the SLS name in the Salesman table.

ohd_invoice_

source_code

alpha

9

The source code on the order.

From the OHD SRC source code in the Order Header table.

ohd_invoice_

source_

description

alpha

30

A description of the source code.

From the SRC description in the Source table.

ohd_invoice_

division_code

alpha

2

The division associated with the source code on the order.

From the Div in the Source table.

ohd_invoice_

division_

description

alpha

30

A description of the division.

From the Description in the Division table.

ohd_invoice_

entity_nbr

numeric

3

The entity associated with the source code on the order.

From the Entity number in the Division table.

ohd_invoice_

entity_description

alpha

25

A description of the entity.

From the ENT description in the Entity table.

ohd_customer_

class

alpha

2

A code assigned to the sold to customer used to categorize the consumer environment at a high level.

From the CCL customer class in the Order Header table.

ohd_customer_

class_description

alpha

30

A description of the customer class.

From the CCL description in the Customer Class table.

ohd_order_email_

address

alpha

50

The email address for the order.

From the OHE order email address in the Order Header Extended table.

ohd_order_entry_

wrkstn

alpha

10

The workstation where the order was entered.

From the OHD Order entry wrkstn in the Order Header table.

ohd_freight_

charge

numeric

7.2

The total charge for shipping the order, not including additional freight charges.

From the Freight charge in the Order Header table.

ohd_freight_

override

alpha

1

Indicates if the freight was overridden on the order. You can override freight by entering a Freight override amount on the Work with Order Ship To Properties screen.

From the OHD freight override in the Order Header table.

ohd_freight_

balance

numeric

7.2

The unpaid portion of freight on the order.

From the Freight balance in the Order Header table.

ohd_remit_

amount

numeric

9.2

The dollar amount on the associated purchase order invoice.

From the OHD remit amount in the Order Header table.

ohd_email_

confirm_date

numeric

8

The date, in MMDDYYYY format, when the system generated an automatic email confirmation for the order.

From the OHD future use date 1 in the Order Header table.

ohd_cbt_account_nbr

numeric

7.0

The account number of the bill to customer on the order.

From the CBT account # in the Order Header table.

ohd_user_hold_

reason

alpha

2

The user hold reason code assigned to the order.

From the OHD OHR usr hold reason in the Order Header table.

ohd_system_hold_reason

alpha

2

The system hold reason code assigned to the order.

From the OHD OHR sys hold reason in the Order Header table.

ohd_cst_

customer_nbr

numeric

9.0

The number of the sold to customer on the order.

From the Cust # in the Order Header table.

ohd_usr_user

alpha

10

The user ID of the person currently working with the order.

From the User in the Order Header table.

ohd_entered_by_user

alpha

10

The user ID of the person who entered the order.

From the OHD entered by USR user in the Order Header table.

ohd_ecomm_

order_number

alpha

30

The order number, if any, that was passed in the CWOrderIn message for an order created through the e-commerce interface (order API).

From the OHE E-Comm order number in the Order Header Extended table.

ohd_ecomm_ip_

address

alpha

15

The ip_addr, if any, in the Inbound Order XML Message (CWORDERIN) for an order received through the e-commerce interface (order API).

From the E-Commerce IP address in the Order Header Extended table.

ohd_originating_

store

alpha

10

The store number assigned to the order.

Store numbers are defined in and validated against the Store Cross Reference table; see WSCR.

Note: The store number defined for the order does not have to be associated with the salesrep defined on the Order Header.

From Originating Store in the Order Header table.

Available in: 3.0 (release 3.5 of Order Management System).

CustomerSoldTo

Each invoice download message contains one CustomerSoldTo element, indicating the sold to customer on the order. The name and address provided in the message are the current information from the time the message is generated, but are not necessarily identical to the name and address when the invoice itself was generated. See the InvoiceBillingAddress and the InvoiceShippingAddress for more information.

sold_to_nbr

numeric

9

The number assigned to the sold to customer on the order.

From the Cust # in the Order Header table.

sold_to_prefix

alpha

3

The sold to customer’s prefix.

From the NAM prefix in the Customer Sold To table.

sold_to_fname

alpha

15

The sold to customer’s first name.

From the NAM first name in the Customer Sold To table.

sold_to_initial

alpha

1

The sold to customer’s middle initial.

From the NAM initial in the Customer Sold To table.

sold_to_lname

alpha

25

The sold to customer’s last name.

From the NAM last name in the Customer Sold To table.

sold_to_suffix

alpha

3

The sold to customer’s suffix.

From the NAM suffix in the Customer Sold To table.

sold_to_company

alpha

30

The sold to customer’s company.

From the NAM company name in the Customer Sold To table.

sold_to_apt

alpha

10

The apartment for the sold to customer’s address.

From the NAM apartment in the Customer Sold To table.

sold_to_address1

alpha

32

The sold to customer’s street address.

From the NAM street address in the Customer Sold To table.

sold_to_address2

alpha

32

The second address line for the sold to customer’s address.

From the NAM address line 2 in the Customer Sold To table.

sold_to_address3

alpha

32

The third address line for the sold to customer’s address.

From the Address line 3 in the Customer Sold To Extended table.

sold_to_address4

alpha

32

The fourth address line for the sold to customer’s address.

From the Address line 4 in the Customer Sold To Extended table.

sold_to_city

alpha

25

The city for the sold to customer’s address.

From the NAM city in the Customer Sold To table.

sold_to_country

alpha

3

The country on the sold to customer’s address.

From the RPR country in the Customer Sold To table.

sold_to_country_

name

alpha

30

The name of the country.

From the Description in the Country table.

sold_to_state

alpha

2

The state on the sold to customer’s address.

From the NAM state in the Customer Sold To table.

sold_to_state_

name

alpha

25

The name of the state.

From the Description in the State table.

sold_to_zip

alpha

10

The postal code on the sold to customer’s address.

From the NAM zip in the Customer Sold To table.

sold_to_delivery_

code

alpha

1

Identifies the address as a business or residential address.

B = Business address.

R = Residential address.

N = No distinction between business and residence.

From the NAM delivery code in the Customer Sold To table.

sold_to_po_box

alpha

1

Identifies the customer’s delivery address as a post office box.

Y = The address is a post office box.

N = The address is not a post office box.

From the NAM PO box? in the Customer Sold To table.

sold_to_email_

address

alpha

50

The sold to customer’s primary email address.

From the Email in the Customer Sold To table.

sold_to_day_

phone

numeric

7

The sold to customer’s day phone number.

From the Phone in the Customer Sold To Phone # table for CS# Phone # type D.

sold_to_day_ext

alpha

4

The day phone number extension.

From the CS# extension in the Customer Sold To Phone # table.

sold_to_eve_

phone

numeric

7

The sold to customer’s evening phone number.

From the Phone in the Customer Sold To Phone # table for CS# Phone # type E.

sold_to_eve_ext

alpha

4

The evening phone number extension.

From the CS# extension in the Customer Sold To Phone # table.

sold_to_fax_

phone

numeric

7

The sold to customer’s third (fax or mobile) number.

From the Phone in the Customer Sold To Phone # table for CS# Phone # type F.

sold_to_fax_ext

alpha

4

The third phone number extension.

From the CS# extension in the Customer Sold To Phone # table.

sold_to_job_title

alpha

25

The sold to customer’s job title.

From the Job title in the Customer Sold To table.

sold_to_rent_

name

alpha

1

Indicates whether to include the sold to customer’s name in lists you sell to other companies for their own catalog mailings.

Y = Sell the customer’s name to another company.

N = Do not sell the customer’s name to another company.

From the CST rent name? in the Customer Sold To table.

sold_to_mail_

name

alpha

1

Indicates whether the customer receives future catalogs.

Y = Mail catalogs to the customer.

N = Do not mail catalogs to the customer.

From the CST mail name? in the Customer Sold To table.

sold_to_rent_

email

alpha

1

This field is not currently implemented.

From the CST rent e-mail in the Customer Sold To table.

sold_to_email_

status

alpha

2

Indicates the preferred method of correspondence for the sold to customer’s primary email address.

O1 (Email) = Email is the preferred method of correspondence.

O2 (Order-only email) = Use email for order-related correspondence only; generate a document for other correspondence.

O3 (No email) = Do not use email for any correspondence; generate a document instead.

O4 (Do not ask customer) = Do not ask the customer for an email address; the customer has already been asked and has declined to provide it.

From the CST email status in the Customer Sold To table.

sold_to_mail_

code

alpha

3

A code that specifies how often, and under what conditions, you will send mail to the customer.

From the CST mail code in the Customer Sold To table.

sold_to_mail_

code_desc

alpha

40

A description of the mail code.

From the MCC mail code description in the Mail/Call Code table.

sold_to_call_code

alpha

3

A code used to indicate when and under what circumstances to call or send mail to the customer.

From the CST call code in the Customer Sold To table.

sold_to_call_code_desc

alpha

40

A description of the call code.

From the MCC mail code description in the Mail/Call Code table.

sold_to_tax_

status

alpha

1

The tax status of the sold to customer.

E (Exempt) = The customer is not required to pay tax on purchases.

G (GST only) = The customer is a Canadian customer and subject to the Goods and Services Tax on purchases only; not PST.

N (Non-taxable) = The customer will not be taxed on purchases.

P (PST only) = The customer is a Canadian customer and subject to the Provincial Services Tax only; not GST.

R (Resale) = The customer is a reseller and not subject to tax.

T (Taxable) = The customer is subject to all taxes. Canadian customers are subject to both GST and PST tax.

From the Tax exempt status (Tax code) in the Customer Sold To table.

sold_to_associate

alpha

1

Identifies the sold to customer as an associate or member who is eligible to receive special pricing on merchandise.

Y = The customer is an associate customer.

N = The customer is not an associate customer.

From the CST associate customer? in the Customer Sold To table.

sold_to_type

alpha

3

A code that identifies the type of sold to customer, used to group customers.

From the CST customer type in the Customer Sold To table.

sold_to_inactive

alpha

1

Identifies the sold to customer’s status.

Y = Customer is inactive.

N = Customer is active.

From the CST inactive? in the Customer Sold To table.

sold_to_commercial

alpha

1

Identifies the sold to customer as commercial or non-commercial.

Y = This is a commercial customer.

N = This is a non-commercial customer.

From the CST commercial? in the Customer Sold To table.

sold_to_alternate_id

alpha

15

A code used as an additional way to identify the sold to customer.

From the Interface cust code in the Customer Sold To table.

sold_to_cross_ref_nbr

numeric

3

A code used as an additional way to identify the sold to customer.

From the CST customer nbr xref in the Customer Sold To table.

sold_to_currency_code

alpha

3

A code that identifies the currency used by the sold to customer.

From the Currency code in the Customer Sold To table.

sold_to_currency_desc

alpha

30

A description of the currency.

From the CUR currency description in the Currency table.

sold_to_language_code

alpha

3

A code that identifies the language used by the sold to customer.

From the Language code in the Customer Sold To table.

sold_to_language_desc

alpha

30

A description of the language.

From the Description in the Language table.

sold_to_

warehouse

numeric

3

A code used to identify the warehouse (store location) where you replenish stock for this customer (store).

From the Whs in the Customer Warehouse table.

sold_to_

warehouse_name

alpha

30

The name of the warehouse.

From the Name in the Warehouse table.

CustomerBillTo

Each invoice download message can contain one CustomerBillTo element, indicating the bill to customer, if any, associated with the sold to customer on the order. The name and address provided in the message are the current information from the time the message is generated, but are not necessarily identical to the name and address when the invoice itself was generated. See the InvoiceBillingAddress for more information.

bill_to_nbr

pack

9

The number assigned to the bill to customer on the order.

From the CBT account # in the Customer Bill To table.

bill_to_prefix

alpha

3

The bill to customer’s prefix.

From the Prefix in the Customer Bill To table.

bill_to_fname

alpha

15

The bill to customer’s first name.

From the First name in the Customer Bill To table.

bill_to_initial

alpha

1

The bill to customer’s middle initial.

From the Initial in the Customer Bill To table.

bill_to_lname

alpha

25

The bill to customer’s last name.

From the Last name in the Customer Bill To table.

bill_to_suffix

alpha

3

The bill to customer’s suffix.

From the Suffix in the Customer Bill To table.

bill_to_company

alpha

30

The bill to customer’s company.

From the Company name in the Customer Bill To table.

bill_to_apt

alpha

10

The apartment number for the bill to customer’s address.

From the Apartment in the Customer Bill To table.

bill_to_address1

alpha

32

The bill to customer’s street address.

From the Street address in the Customer Bill To table.

bill_to_address2

alpha

32

The second address line on the bill to customer’s address.

From the Address line 2 in the Customer Bill To table.

bill_to_address3

alpha

32

The third address line on the bill to customer’s address.

From the Address line 3 in the Customer Bill To Extended table.

bill_to_address4

alpha

32

The fourth address line on the bill to customer’s address.

From the Address line 4 in the Customer Bill To Extended table.

bill_to_city

alpha

25

The city on the bill to customer’s address.

From the City in the Customer Bill To Extended table.

bill_to_country

alpha

3

The country on the bill to customer’s address.

From the RPR country in the Customer Bill To table.

bill_to_country_

name

alpha

30

The name of the country.

From the Description in the Country table.

bill_to_state

alpha

2

The state on the bill to customer’s address.

From the State in the Customer Bill To table.

bill_to_state_

name

alpha

25

The name of the state.

From the Description in the State table.

bill_to_zip

alpha

10

The postal code on the bill to customer’s address.

From the Zip in the Customer Bill To table.

bill_to_deliver_

code

alpha

1

Identifies the address as a business or residential address.

B = Business address.

R = Residential address.

N = No distinction between business and residence.

From the Delivery code in the Customer Bill To table.

bill_to_po_box

alpha

1

Identifies the customer’s delivery address as a post office box.

Y = The address is a post office box.

N = The address is not a post office box.

From the PO box? in the Customer Bill To table.

bill_to_email_

address

alpha

50

The bill to customer’s email address.

From the CBT email address in the Customer Bill To table.

bill_to_day_

phone

numeric

7

The bill to customer’s day phone number.

From the Phone in the Customer Bill To Phone # table for CB# Phone # type D.

bill_to_day_ext

alpha

4

The day phone number extension.

From the CB# extension in the Customer Bill To Phone # table.

bill_to_eve_phone

numeric

7

The bill to customer’s evening phone number.

From the Phone in the Customer Bill To Phone # table for CB# Phone # type E.

bill_to_eve_ext

alpha

4

The evening phone number extension.

From the CB# extension in the Customer Bill To Phone # table.

bill_to_fax_phone

numeric

7

The bill to customer’s third (fax or mobile) number.

From the Phone in the Customer Bill To Phone # table for CB# Phone # type F.

bill_to_fax_ext

alpha

4

The third phone number extension.

From the CB# extension in the Customer Bill To Phone # table.

bill_to_print_

statement

alpha

1

Not implemented.

bill_to_email_

status

alpha

2

Indicates the preferred method of correspondence for the bill to customer’s email address.

O1 (Email) = Email is the preferred method of correspondence.

O2 (Order-only email) = Use email for order-related correspondence only; generate a document for other correspondence.

O3 (No email) = Do not use email for any correspondence; generate a document instead.

O4 (Do not ask customer) = Do not ask the customer for an email address; the customer has already been asked and has declined to provide it.

From the CBT opt in/opt out in the Customer Bill To table.

bill_to_currency_code

alpha

3

A code for the currency used by the bill to customer.

From the Currency code in the Customer Bill To table.

bill_to_currency_desc

alpha

30

A description of the currency.

From the CUR currency description in the Currency table.

bill_to_language_code

alpha

3

A code for the language used by the bill to customer.

From the Language code in the Customer Bill To table.

bill_to_language_desc

alpha

30

A description of the language.

From the Description in the Language table.

bill_to_terms_

code

numeric

2

A code for the payment terms for the bill to customer’s account.

From the APT code in the Customer Bill To table.

bill_to_terms_

desc

alpha

30

A description of the payment terms.

From the Description in the Terms table.

InvoicePaymentMethod

The InvoicePaymentMethod element and its attributes repeat for each payment method associated with the invoice.

ipm_seq_nbr

numeric

2

The sequence number assigned to the invoice payment method.

From the OPM seq # in the Invoice Payment Method table.

ipm_pay_type

numeric

2

A code that represents the method of payment associated with the invoice.

From the PAY Pay type in the Order Payment Method table.

ipm_pay_type_

desc

alpha

30

A description of the pay type.

From the PAY description in the Pay Type table.

ipm_pay_

category

alpha

1

The category of the pay type.

• 1 = Cash/Check

• 2 = Credit Card

From the Pay category in the Invoice Payment Method table.

ipm_merchandise_amt

numeric

9.2

The merchandise amount assigned to the invoice payment method.

From the IPM merch in the Invoice Payment Method table.

ipm_merchandise_balance_amt

numeric

9.2

The unpaid portion of the merchandise amount assigned to the invoice payment method.

From the IPM merch balance in the Invoice Payment Method table.

ipm_freight_amt

numeric

7.2

The freight charge amount assigned to the invoice payment method.

From the Freight in the Invoice Payment Method table.

ipm_freight_

balance_amt

numeric

7.2

The unpaid portion of the freight charge amount assigned to the invoice payment method.

From the Freight balance in the Invoice Payment Method table.

ipm_addl_freight_amt

numeric

7.2

The additional freight amount assigned to the invoice payment method.

From the Add’l frt in the Invoice Payment Method table.

ipm_addl_freight_balance_amt

numeric

7.2

The unpaid portion of the additional freight amount assigned to the invoice payment method.

From the Add’l freight balance in the Invoice Payment Method table.

ipm_addl_charge_amt

numeric

7.2

The additional charge amount assigned to the invoice payment method.

From the Add’l chg in the Invoice Payment Method table.

ipm_addl_charge_balance_amt

numeric

7.2

The unpaid portion of the additional charge amount assigned to the invoice payment method.

From the Add’l charge balance in the Invoice Payment Method table.

ipm_hand_charge_amt

numeric

7.2

The handling charge amount assigned to the invoice payment method.

From the Handling in the Invoice Payment Method table.

ipm_hand_charge_balance_amt

numeric

7.2

The unpaid portion of the handling charge amount assigned to the invoice payment method.

From the Handling balance in the Invoice Payment Method table.

ipm_tax_amt

numeric

10.5

The tax amount assigned to the invoice payment method.

From the IPM tax in the Invoice Payment Method table.

ipm_tax_balance_amt

numeric

10.5

The unpaid portion of the tax amount assigned to the invoice payment method.

From the IPM tax balance in the Invoice Payment Method table.

ipm_gst_amt

numeric

10.5

The GST amount assigned to the invoice payment method.

From the IPM GST in the Invoice Payment Method table.

ipm_gst_balance_amt

numeric

10.5

The unpaid portion of the GST amount assigned to the invoice payment method.

From the IPM GST balance in the Invoice Payment Method table.

ipm_pst_amt

numeric

10.5

The PST amount assigned to the invoice payment method.

From the IPM PST in the Invoice Payment Method table.

ipm_pst_balance_amt

numeric

10.5

The unpaid portion of the PST amount assigned to the invoice payment method.

From the IPM PST balance in the Invoice Payment Method table.

ipm_ord_lvl_frt_

amt

numeric

7.2

The freight charges that apply to the total order.

From the IPM order lvl frt in the Invoice Payment Method table.

ipm_ord_lvl_frt_

balance_amt

numeric

7.2

The unpaid portion of the order level freight charges.

From the IPM order lvl frt bal in the Invoice Payment Method table.

ipm_ord_lvl_frt_

tax_amt

numeric

7.2

The total tax amount assigned to the invoice payment method.

From the IPM order lvl frt tax in the Invoice Payment Method table.

ipm_ord_lvl_frt_

tax_bal_amt

numeric

7.2

The unpaid portion of the total tax amount assigned to the invoice payment method.

From the IPM order lvl frt tax bal in the Invoice Payment Method table.

ipm_deposit_

created_date

numeric

10.0

The date the deposit was created in the YYYY-MM-DD.

From the IPM deposit created date in the Invoice Payment Method table.

ipm_auth_number

alpha

10

The number used to authorize the credit card payment associated with the invoice.

From the IPM auth # in the Invoice Payment Method table.

ipm_auth_date

numeric

10.0

The date you manually authorize a payment method, or the date the payment method receives an authorization from the service bureau, in YYYY-MM-DD format.

From the IPM auth date in the Invoice Payment Method table.

ipm_cc_credit_

status

alpha

1

Indicates the credit status of the return. Included only if the invoice payment method is associated with a return or exchange.

P = Refund pending. You performed a return or exchange in order entry, order maintenance, or through Work with Return Authorizations and have not yet processed the refund.

R = Refund processed/ready. You processed the refund in Process Refunds.

blank = Refund deposited.

From the IPM C/C credit status in the Invoice Payment Method table.

ipm_payment_

option_type

alpha

1

The type of pay plan on the order.

D = Deferred billing pay plan.

I = Installment billing pay plan.

Included only if the credit card payment method is associated with a pay plan.

From the IPM payment option type in the Invoice Payment Method table.

ipm_invoice_date

numeric

10.0

The date the invoice was created, in YYYY-MM-DD format.

From the IPM invoice date in the Invoice Payment Method table.

ipm_nbr_of_

installments

numeric

3

The total number of installments assigned to the invoice payment method. Installment billing allows you to break the payment evenly into installments (for example, 3 payments on the 1st of each month).

Included only if the credit card payment method is associated with a pay plan.

From the IPM # of installments in the Invoice Payment Method table.

ipm_nbr_

installments_

remain

numeric

3

The number of installments remaining. This number reduces by 1 each time an installment is sent for deposit.

Included only if the credit card payment method is associated with a pay plan.

From the IPM # of installment remain in the Invoice Payment Method table.

ipm_installment_

interval

numeric

3

The number of days between installments. The system uses this interval number to determine the next deposit release date if you are basing installment dates on intervals, for example, 3 installments in 30 day intervals.

Included only if the credit card payment method is associated with a pay plan.

From the IPM installment interval in the Invoice Payment Method table.

ipm_fix_install_

bill_day

numeric

3

The day of the month when an installment is billed. For example, if the fix installment date is 15, each installment would be due on the 15th of every month.

Included only if the credit card payment method is associated with a pay plan.

From the IPM fix install bill day in the Invoice Payment Method table.

ipm_deposit_

release_date

numeric

10.0

The date when the invoice is eligible for deposit, in YYYY-MM-DD format. The system updates this field when a deposit is confirmed with the next deposit release date if there is a remaining amount to deposit, for example, in installment billing.

For regular orders, the deposit release date is the same as the invoice date. The deposit is eligible for processing immediately after billing.

From the IPM deposit release date in the Invoice Payment Method table.

ipm_credit_card_nbr

alpha

20

Not implemented.

ipm_cc_expiration_date

numeric

4.0

Not implemented.

ipm_deposit_

amount

numeric

13.2

The total amount to deposit in order for the invoice to be completely deposited.

From the IPM deposit amount in the Invoice Payment Method table.

ipm_total_deposit_to_date

numeric

13.2

The total amount deposited to date. When a deposit is confirmed, the system updates this field by the deposit amount.

From the IPM total deposit to date in the Invoice Payment Method table.

ipm_prepaid_

amount

numeric

13.2

The amount prepaid against the pay method, for example, the customer’s credit card was rejected and the customer decides to send a check instead.

From the IPM prepaid amount in the Invoice Payment Method table.

ipm_suppress_

deposit

alpha

1

Indicates whether the system will include the credit card payment method when you process deposits.

Y = The system will not attempt to deposit the credit card payment method. Once you bill the payment method, the system resets this flag to N.

N = The credit card payment method will be included when you process deposits.

ipm_card_start_

date

numeric

4.0

The first date when the card is effective.

From the Card start date in the Invoice Payment Method table.

ipm_deposit_

adjust_amount

numeric

15.2

The amount of the deposit that has been changed or is in transition. This amount includes:

• written off deposits

• debit and credit netting amounts

• deposits pending

From the IPM deposit adjust amount in the Invoice Payment Method table.

ipm_prepaid_pay_method

numeric

2.0

A code that represents the pre-paid payment method. This must be a cash/check pay type.

From the IPM prepaid pay method in the Invoice Payment Method table.

ipm_fpo_payment_code

alpha

5

The payment plan code associated with the credit card pay type on the order.

From the IPM FPO payment code in the Invoice Payment Method table.

ipm_spv_hidden_tax_amt

numeric

20.5

The hidden tax billed or refunded.

This tag is included only when all of the following are true:

• The Tax Included in Price (E70) system control value is selected.

• The Remove Stored Value Card Number After Activation (J22) system control value is not selected.

• The payment method being billed or credited was a stored value card with the Voucher Type set to Single-Use.

• The stored value card voucher was created on an order subject to VAT in Order Management System Cloud Service.

• The CWInvoiceOut message version 4.0 is or higher.

Determining the hidden tax amount: The INVOICE_OUT job determines the hidden tax amount based on the hidden tax amount charged when the original voucher was billed. This amount was passed at that time in the odt_second_choice_sku_item in the CWInvoiceOut message.

For example, a single-use voucher for 100.00 had a hidden tax amount of 20.00 for a rate of 20%. If 50.00 of the single-use voucher is redeemed, the ipm_spv_hidden_tax_amt passed is 20% of 50.00, or 10.00.

Available in: Version 4.0 in Order Management System Cloud Service Release 19.0 or later.

InvoiceShipTo

The InvoiceShipTo element and its attributes repeat for each ship to customer associated with the invoice. The name and address provided in the message are the current information from the time the message is generated, but are not necessarily identical to the name and address when the invoice itself was generated. See the InvoiceShippingAddress for more information.

ins_ship_to_nbr

numeric

3

The ship to customer number associated with the invoice.

From the Ship to # in the Invoice Ship To table.

ins_invoice_date

numeric

10

The date the invoice was created, in YYYY-MM-DD format.

From the Invoice date in the Invoice Ship To table.

ins_merchandise_amt

numeric

9.2

The merchandise amount assigned to the invoice for the ship to customer.

From the Merchandise in the Invoice Ship To table.

ins_freight_amt

numeric

7.2

The freight charge amount assigned to the invoice for the ship to customer.

From the Freight in the Invoice Ship To table.

ins_addl_freight_amt

numeric

7.2

The additional freight amount assigned to the invoice for the ship to customer.

From the Add’l freight in the Invoice Ship To table.

ins_addl_charge_amt

numeric

7.2

The additional charge amount assigned to the invoice for the ship to customer.

From the Add’l charges in the Invoice Ship To table.

ins_hand_charge_amt

numeric

7.2

The handling charge amount assigned to the invoice for the ship to customer.

From the Handling in the Invoice Ship To table.

ins_tax_amt

numeric

7.2

The tax amount assigned to the invoice for the ship to customer.

From the Tax in the Invoice Ship To table.

ins_gst_amt

numeric

7.2

The GST amount assigned to the invoice for the ship to customer.

From the GST in the Invoice Ship To table.

ins_pst_amt

numeric

7.2

The PST amount assigned to the invoice for the ship to customer.

From the PST in the Invoice Ship To table.

ins_cost_amt

numeric

9.2

The actual cost of the merchandise billed on the invoice for the ship to customer.

From the Cost in the Invoice Ship To table.

ins_hidden_frt_

amt

numeric

7.2

The hidden freight amount assigned to the invoice for the ship to customer.

From the Hidden freight in the Invoice Ship To table.

ins_discount_amt

numeric

9.2

The difference between the actual price charged for the items and the offer prices. A negative amount indicates a charge greater than the original offer price.

From the Discount amount in the Invoice Ship To table.

ins_ocr_b_

number

alpha

30

Not currently implemented.

OrderShipTo

The name and address provided in the message are the current information from the time the message is generated, but are not necessarily identical to the name and address when the invoice itself was generated. See the InvoiceBillingAddress and the InvoiceShippingAddress for more information.

ost_additional_

charge

numeric

7.2

The total additional charges for the order ship to.

From the OST add’l charges in the Order Ship To table.

ost_additional_

charge_balance

numeric

7.2

The unpaid portion of additional charges.

From the OST add’l chg balance in the Order Ship To table.

ost_additional_

freight

numeric

7.2

The total dollar amount for freight charges exceeding the base freight charge.

From the Add’l freight in the Order Ship To table.

ost_additional_

freight_balance

numeric

7.2

The unpaid portion of additional freight charges.

From the Add’l frt bal in the Order Ship To table.

ost_arrival_date

numeric

10.0

The date the customer expects to receive the order in the format YYYY-MM-DD.

From the OST arrival date in the Order Ship To table.

ost_broker_

delivery_type

alpha

1

Indicates the type of an order received from or sent to the Order Broker. Possible settings are:

R = retail pickup order: a store location requests the Order Management System distribution center transfer the requested merchandise to the originating store for customer pickup

D = delivery order: a store location requests the Order Management System distribution center ship the order directly to the customer

S = ship-for-pickup: Order Management System ships the merchandise to a designated store location for customer pickup

This information is stored in the Order Ship To table, and is included only if the order is a retail pickup, delivery, or ship-for-pickup order being fulfilled through integration with the Order Broker. Orders that include items that are backordered in Order Management System and sent to the Order Broker for fulfillment (brokered backorders) do not have an ost_broker_delivery_type. See the Order Broker Integration for a discussion.

Available in: Version 2.0 in Order Management System 2.5 or later.

ost_calculate_

freight

alpha

1

Indicates whether the system calculates and adds freight charges and service charges by ship via to the order ship to.

Y = The system calculates freight based on the freight method for the source code.

N = The system does not calculate freight.

From the Calculate freight in the Order Ship To table.

ost_cancel_bo

alpha

1

Indicates whether items that are unavailable (backordered) should be cancelled automatically with the first shipment on the order.

Y = Cancel backordered items with the first shipment.

N = Do not cancel backordered items.

From the OST cancel BO in the Order Ship To table.

ost_cancel_date

numeric

10.0

The date the customer wants the order cancelled if it has not been shipped in the format YYYY-MM-DD.

From the OST cancel date in the Order Ship To table.

ost_contact_

name

alpha

30

The name of the person who should receive the order at the shipping destination.

From the OST contact name in the Order Ship To table.

ost_csh_ship_to_nbr

numeric

3.0

The ship to customer number associated with the order ship to.

From the OST CSH ship to # in the Order Ship To table.

ost_cst_customer_nbr

numeric

9.0

The sold to customer number associated with the order ship to.

From the OST CST customer # in the Order Ship To table.

ost_destination_

store

alpha

12

The store number identifying the destination for a ship-for-pickup order, as set up through Work with Store Cross Reference (WSCR) and stored in the Order Ship To Address table. Included only for ship-for-pickup orders sent to the Order Broker. See the Order Broker Integration for a discussion.

Available in: Version 2.0 in Order Management System 2.5 or later.

ost_discount_pct

numeric

5.2

A flat discount percentage applied to discountable merchandise only for the order ship to.

From the Disc % in the Order Ship To table.

ost_estimated_

freight

numeric

7.2

The estimated charge for shipping the order.

From the OST estimated freight in the Order Ship To table.

ost_fedex_nbr

alpha

10

The number of the customer’s account with the carrier.

From the OST federal express # in the Order Ship To table.

ost_freight

numeric

7.2

The actual charge for shipping the order.

From the OST freight in the Order Ship To table.

ost_freight_

balance

numeric

7.2

The unpaid portion of the freight.

From the OST freight balance in the Order Ship To table.

ost_freight_

override

alpha

1

Indicates if the freight charges on the order were overridden in order entry or order maintenance.

Y = The freight charge was overridden.

N = The freight charge was not overridden.

From the OST freight override in the Order Ship To table.

ost_geographic_

zone

alpha

3

A code used to identify the geographic zone where the ship to destination is located.

From the OST GZF geographic zone in the Order Ship To table.

ost_geographic_

zone_desc

alpha

30

A description of the geographic zone.

From the GZF description in the Geographic Zone table.

ost_gift_flag

alpha

1

Indicates if the ship to order is a gift order.

Y = The ship to order is a gift order.

N = The ship to order is not a gift order.

From the OST gift order in the Order Ship To table.

ost_gst

numeric

7.2

The Canadian Federal Goods and Services tax that applies to the order ship to.

From the OST GST in the Order Ship To table.

ost_gst_balance

numeric

7.2

The unpaid portion of the Canadian Federal Goods and Services tax.

From the OST GST balance in the Order Ship To table.

ost_handling

numeric

7.2

The cost of any special handling on the order, including any duty charge.

From the OST handling in the Order Ship To table.

ost_handling_

balance

numeric

7.2

The unpaid portion of the handling charge and/or duty charge.

From the OST handling balance in the Order Ship To table.

ost_last_pick_

print_date

numeric

10.0

The most recent date when a pick slip was printed for the order ship to, in YYYY-MM-DD format.

From the OST last pick print date in the Order Ship To table.

ost_last_

reservation_date

numeric

10.0

The most recent reservation date for the order ship to, in YYYY-MM-DD format.

From the OST last reservation date in the Order Ship To table.

ost_line_of_

business

alpha

3

A code used to identify the line of business, or business unit, assigned to the order ship to.

From the OST line of business in the Order Ship To table.

ost_line_of_

business_desc

alpha

40

A description of the line of business.

From the LOB description in the Line Of Business table.

ost_merchandise

numeric

9.2

The total dollar value of merchandise for the order ship to.

From the OST merch in the Order Ship To table.

ost_merchandise_balance

numeric

9.2

The unpaid portion of the merchandise total.

From the OST merch balance in the Order Ship To table.

ost_ohr_hold_

reason

alpha

2

The order hold reason code assigned to the order ship to.

From the OST OHR hold reason in the Order Ship To table.

ost_order_

combination_type

alpha

10

The long SKU class code assigned to the items on the order. Informational-only; not updated by the system.

From the OST future use code 1 in the Order Ship To table.

ost_originating_

store

alpha

12

The store number identifying the store location where a retail pickup or delivery order originated, as set up through Work with Store Cross Reference (WSCR) and stored in the Order Message table. Included only for retail pickup and delivery orders received from the Order Broker. See the Order Broker Integration for a discussion.

Available in: Version 2.0 in Order Management System 2.5 or later.

ost_nbr_of_picks_out

numeric

3.0

The number of pick slips that have been printed for the order ship to, but have not yet shipped.

From the OST # of picks outstand in the Order Ship To table.

ost_nbr_of_

shipments

numeric

3.0

The number of shipments made to each ship to address. Included only if items on the order have been picked and billed; no number included for express billed orders.

From the OST # of shipments in the Order Ship To table.

ost_number_of_

lines

numeric

3

The number of order lines for the order ship to.

From the # of lines in the Order Ship To table.

ost_pst

numeric

7.2

The Canadian Provincial Services tax that applies to the order ship to.

From the OST PST in the Order Ship To table.

ost_pst_balance

numeric

7.2

The unpaid portion of the Canadian Provincial Services tax.

From the OST PST balance in the Order Ship To table.

ost_priority

numeric

1.0

The priority for order fulfillment on a backordered item for the order ship to. Priority codes range from 0 - 9, where 0 is the lowest priority and 9 is the highest priority.

From the OST priority in the Order Ship To table.

ost_purchase_

order_nbr

alpha

15

The purchase order number under which the order was placed.

From the Purchase order # in the Order Ship To table.

ost_resale_

exempt_nbr

alpha

30

A number or code that identifies the customer as exempt from taxes on purchases.

From the OST resale/exempt # (Tax identification) in the Order Ship To table.

ost_ship_

complete

alpha

1

Indicates if all items on the order must ship together.

Y = Ship all items on the order in one shipment.

N = Items on the order ship as soon as they are reserved.

From the OST ship complete in the Order Ship To table.

ost_ship_via_

code

numeric

2

A code indicating the shipper used to deliver the merchandise to the ship to customer.

From the Ship via in the Order Ship To table.

ost_ship_via_

description

alpha

30

A description of the shipper.

From the VIA shipper name in the Ship Via table.

ost_status

alpha

1

The status of the ship to order.

blank = Open.

A = Archived. This option is not currently implemented.

C = Cancelled.

H = Held.

S = Suspended.

X = Closed.

From the OST order status in the Order Ship To table.

ost_tax

numeric

7.2

The total sales tax that applies to the order for the order ship to. This total does not include any hidden tax.

From the OST tax in the Order Ship To table.

ost_tax_balance

numeric

7.2

The unpaid portion of the taxes.

From the OST tax balance in the Order Ship To table.

ost_tax_code

alpha

2

The tax status of the ship to customer.

E (Exempt) = The customer is not required to pay tax on purchases.

G (GST only) = The customer is a Canadian customer and subject to the Goods and Services Tax on purchases only; not PST.

N (Non-taxable) = The customer will not be taxed on purchases.

P (PST only) = The customer is a Canadian customer and subject to the Provincial Services Tax only; not GST.

R (Resale) = The customer is a reseller and not subject to tax.

T (Taxable) = The customer is subject to all taxes. Canadian customers are subject to both GST and PST tax.

From the Tax code in the Order Ship To table.

ost_whs_

warehouse

numeric

3.0

A code for the warehouse from where the merchandise on the order will ship.

From the Whs in the Order Ship To table.

ost_warehouse_

name

alpha

30

The name of the warehouse.

From the Name in the Warehouse table.

OrderMessage

The OrderMessage element and its attributes repeat for each order message on the order header.

order_msg_seq_

nbr

numeric

3

The sequence number assigned to the order line message.

From the OMS seq # in the Order Message table.

order_message_

text

alpha

60

The order line message.

From the OMS message in the Order Message table.

order_message_

print

alpha

1

Indicates whether, and where, the message prints.

P = Print the message on the pick slip.

I = Print the message on the invoice.

B = Print the message on the pick slip and invoice.

From the OMS print? in the Order Message table.

order_message_

date

numeric

7

The date the message was entered, in YYYY-MM-DD format.

From the OMS date in the Order Message table.

order_message_

user

alpha

10

The user ID of the person who entered the message.

From the User in the Order Message table.

Certificate

Not implemented.

certificate_

amount

numeric

7.2

Not implemented.

certificate_

number

alpha

40

Not implemented.

transaction_id

alpha

40

Not implemented.

redeemed_

amount

numeric

7.2

Not implemented.

OrderAdditionalCharge

The OrderAdditionalCharge element and its attributes repeat for each order additional charge applied to the order that has been billed (is associated with an invoice date). This element and its attributes are included on debit and credit invoices.

Additional charges are user-defined types of charges that you can add to an order for any reason. These additional charges are order-level charges, and are not associated with any particular item. See Adding Miscellaneous Charges or Credits in Order Entry for more information.

Note: The additional charges defined here may not tie out to the additional charges defined for the invoice payment method, invoice ship to, or order ship to.

Available in: 3.0 (release 3.5 of Order Management System).

oac_addl_charge_

amt

numeric

7.2

The dollar amount of the additional charge. A negative sign displays if the amount is a negative (credit) amount.

Additional charges may include:

• Additional source charge: An additional charge for services that apply to the source code or offer. These charges apply if you have set up a service charge table for the source code or offer. The system applies the additional charge to the order based on the total dollar value of the merchandise.

• Additional shipper/item charge: An additional charge that applies to the item, depending on the shipper you select to deliver the item. Such charges may apply when the item exceeds established shipping rate charges. For example, delivery of an oversized item may incur an additional shipper/item charge. Additional shipper/item charges apply when defined for the shipper.

• Ad hoc charge: An additional charge, such as a charge for a gift box, that you assign at order entry. You initially define ad hoc charges in the Additional Charges table.

• Dollar discount: An additional charge (credit) that is applied based on the total dollar value of the merchandise.

From the Add’l charges field in the Order Additional Charge table.

Available in: 3.0 (release 3.5 of Order Management System).

oac_addl_charge_

code

alpha

2

A code that represents the additional charge.

From the Add’l chg code field in the Order Additional Charge table.

Available in: 3.0 (release 3.5 of Order Management System).

oac_addl_charge_

inv_date

numeric

7

The date the invoice associated with the additional charge was billed, in CYYMMDD format. The system includes only additional charges that have been billed.

From the Date invoiced field in the Order Additional Charge table.

Available in: 3.0 (release 3.5 of Order Management System).

CustomerShipTo

The CustomerShipTo element and its attributes indicate if the recipient is someone other than the sold to customer.

You can send a shipment to:

• a permanent ship to customer assigned to the sold to customer. The permanent ship to address values are from the Customer Ship To table. Each attribute for the CustomerShipTo element is prefixed with ship. For example, Ship_to_prefix.

• a recipient sold to customer. The recipient ship to address values are from the Customer Sold To table. Each attribute for the CustomerShipTo element is prefixed with ship. For example, Ship_to_prefix.

• an order ship to address. The order ship to address values are from the Order Ship To Address table. Each attribute for the CustomerShipTo element is prefixed with order. For example, Order_ship_to_prefix.

The name and address provided in the message are the current information from the time the message is generated, but are not necessarily identical to the name and address when the invoice itself was generated. See the InvoiceShippingAddress for more information.

ship_to_customer_nbr

numeric

9

The number assigned to the ship to customer on the order.

Included only if you are shipping to a permanent ship to customer or recipient sold to customer.

From the OST CST customer # in the Order Ship To table.

permanent_ship_

to_nbr

numeric

3

The number assigned to the permanent ship to customer on the order.

Included only if you are shipping to a permanent ship to customer for the sold to customer on the order. If you are shipping to a permanent ship to customer, the Ship_to_customer_nbr is the associated sold to customer number.

From the CSH ship to # in the Customer Ship To table.

ship_to_prefix

alpha

3

The ship to customer’s prefix. From the:

• Permanent ship to: NAM prefix in the Customer Ship To table.

• Recipient sold to customer: NAM prefix in the Customer Sold To table.

ship_to_fname

alpha

15

The ship to customer’s first name. From the:

• Permanent ship to: NAM first name in the Customer Ship To table.

• Recipient sold to: NAM first name in the Customer Sold To table.

ship_to_initial

alpha

1

The ship to customer’s middle initial. From the:

• Permanent ship to: NAM initial in the Customer Ship To table.

• Recipient sold to: NAM initial in the Customer Sold To table.

ship_to_lname

alpha

25

The ship to customer’s last name. From the:

• Permanent ship to: NAM last name in the Customer Ship To table.

• Recipient sold to: NAM last name in the Customer Sold To table.

ship_to_suffix

alpha

3

The ship to customer’s suffix. From the:

• Permanent ship to: NAM suffix in the Customer Ship To table.

• Recipient sold to: NAM suffix in the Customer Sold To table.

ship_to_company

alpha

30

The ship to customer’s company. From the:

• Permanent ship to: NAM company name in the Customer Ship To table.

• Recipient sold to: NAM company name in the Customer Sold To table.

ship_to_apt

alpha

10

The ship to customer’s apartment. From the:

• Permanent ship to: NAM apartment in the Customer Ship To table.

• Recipient sold to: NAM apartment in the Customer Sold To table.

ship_to_address1

alpha

32

The ship to customer’s street address. From the:

• Permanent ship to: NAM street address in the Customer Ship To table.

• Recipient sold to: NAM street address in the Customer Sold To table.

ship_to_address2

alpha

32

The second address line on the ship to customer’s address. From the:

• Permanent ship to: NAM address line 2 in the Customer Ship To table.

• Recipient sold to: NAM address line 2 in the Customer Sold To table.

ship_to_address3

alpha

32

The third address line on the ship to customer’s address. From the:

• Permanent ship to: Address line 3 in the Customer Ship To Extended table.

• Recipient sold to: Address line 3 in the Customer Sold To Extended table.

ship_to_address4

alpha

32

The fourth address line on the ship to customer’s address. From the:

• Permanent ship to: Address line 4 in the Customer Ship To Extended table.

• Recipient sold to: Address line 4 in the Customer Sold To Extended table.

ship_to_city

alpha

25

The city on the ship to customer’s address. From the:

• Permanent ship to: NAM city in the Customer Ship To table.

• Recipient sold to: NAM city in the Customer Sold To table.

ship_to_country

alpha

3

The country on the ship to customer’s address. From the:

• Permanent ship to: RPR country in the Customer Ship To table.

• Recipient sold to: RPR country in the Customer Sold To table.

ship_to_country_name

alpha

30

The name of the country.

From the Description in the Country table.

ship_to_state

alpha

2

The state on the ship to customer’s address. From the:

• Permanent ship to: NAM state in the Customer Ship To table.

• Recipient sold to: NAM state in the Customer Sold To table.

ship_to_state_

name

alpha

25

The name of the state.

From the Description in the State table.

ship_to_zip

alpha

10

The postal code on the ship to customer’s address. From the:

• Permanent ship to: NAM zip in the Customer Ship To table.

• Recipient sold to: NAM zip in the Customer Sold To table.

ship_to_delivery_code

alpha

1

Identifies the address as a business or residential address.

B = Business address.

R = Residential address.

N = No distinction between business and residence.

From the:

• Permanent ship to: NAM delivery code in the Customer Ship To table.

• Recipient sold to: NAM delivery code in the Customer Sold To table.

ship_to_po_box

alpha

1

Identifies the customer’s delivery address as a post office box.

Y = The address is a post office box.

N = The address is not a post office box.

From the:

• Permanent ship to: NAM PO box? in the Customer Ship To table.

• Recipient sold to: NAM PO box? in the Customer Sold To table.

ship_to_email_

address

alpha

50

The ship to customer’s email address. From the:

• Permanent ship to: Email address in the Customer Ship To table.

• Recipient sold to: Email address in the Customer Sold To table.

ship_to_day_

phone

alpha

14

The ship to customer’s day phone number. From the:

• Permanent ship to: Phone in the Customer Ship To Phone # table for phone type D.

• Recipient sold to: Email address in the Customer Sold to Phone # table for phone type D.

ship_to_day_ext

alpha

4

The day phone number extension. From the:

• Permanent ship to: CT# extension in the Customer Ship To Phone # table.

• Recipient sold to: CT# extension in the Customer Sold to Phone # table.

ship_to_eve_

phone

alpha

14

The ship to customer’s evening phone number. From the:

• Permanent ship to: Phone in the Customer Ship To Phone # table for phone type E.

• Recipient sold to: Phone in the Customer Sold to Phone # table for phone type E.

ship_to_eve_ext

alpha

4

The evening phone number extension. From the:

• Permanent ship to: CT# extension in the Customer Ship To Phone # table.

• Recipient sold to: CT# extension in the Customer Sold to Phone # table.

ship_to_fax_

phone

alpha

14

The ship to customer’s third (fax or mobile) number. From the:

• Permanent ship to: Phone in the Customer Ship To Phone # table for phone type F.

• Recipient sold to: Phone in the Customer Sold to Phone # table for phone type F.

ship_to_fax_ext

alpha

4

The third phone number extension. From the:

• Permanent ship to: CT# extension in the Customer Ship To Phone # table.

• Recipient sold to: CT# extension in the Customer Sold to Phone # table.

ship_to_rent_

name

alpha

1

Indicates whether to include the ship to customer’s name on a mailing list that you rent.

Y = Rent the customer’s name.

N = Do not rent the customer’s name.

From the:

• Permanent ship to: Rent name? in the Customer Ship To table.

• Recipient sold to: Rent name? in the Customer Sold To table.

ship_to_mail_

code

alpha

3

A code used to identify when, and under what conditions, you send mail to the customer.

From the:

• Permanent ship to: Mail code in the Customer Ship To table.

• Recipient sold to: Mail code in the Customer Sold To table.

ship_to_mail_

code_desc

alpha

40

A description of the mail code.

From the MCC mail code description in the Mail/Call Code table.

ship_to_call_code

alpha

3

A code that identifies when, and under what conditions, you call the customer. From the:

• Permanent ship to: Call code in the Customer Ship To table.

• Recipient sold to: Call code in the Customer Sold To table.

ship_to_call_code_desc

alpha

40

A description of the call code.

From the MCC mail code description in the Mail/Call Code table.

ship_to_language_code

alpha

3

A code that identifies the language used by the ship to customer. From the:

• Permanent ship to: Language code in the Customer Ship To table.

• Recipient sold to: Language code in the Customer Sold To table.

ship_to_language_desc

alpha

30

A description of the language.

From the Description in the Language table.

ship_to_job_title

alpha

25

The sold to customer’s job title.

Not included for an order ship to address or permanent ship to address.

Recipient sold to: From the Job title in the Customer Sold To table.

ship_to_mail_

name

alpha

1

Indicates whether the customer receives future catalogs.

Y = Mail catalogs to the customer.

N = Do not mail catalogs to the customer.

Not included for an order ship to address or permanent ship to address.

Recipient sold to: From the Mail name? in the Customer Sold To table.

ship_to_email_

status

alpha

2

Indicates the preferred method of correspondence for the sold to customer’s primary email address.

O1 (Email) = Email is the preferred method of correspondence.

O2 (Order-only email) = Use email for order-related correspondence only; generate a document for other correspondence.

O3 (No email) = Do not use email for any correspondence; generate a document instead.

O4 (Do not ask customer) = Do not ask the customer for an email address; the customer has already been asked and has declined to provide it.

Not included for an order ship to address or permanent ship to address.

Recipient sold to: From the CST email status in the Customer Sold To table.

ship_to_rent_

email

alpha

1

This field is currently not implemented.

From the CST rent e-mail in the Customer Sold To table.

ship_to_tax_

status

alpha

1

The tax status of the sold to customer.

E (Exempt) = The customer is not required to pay tax on purchases.

G (GST only) = The customer is a Canadian customer and subject to the Goods and Services Tax on purchases only; not PST.

N (Non-taxable) = The customer will not be taxed on purchases.

P (PST only) = The customer is a Canadian customer and subject to the Provincial Services Tax only; not GST.

R (Resale) = The customer is a reseller and not subject to tax.

T (Taxable) = The customer is subject to all taxes. Canadian customers are subject to both GST and PST tax.

Not included for an order ship to address or permanent ship to address.

Recipient sold to: From the Tax exempt status (Tax code) in the Customer Sold To table.

ship_to_associate

alpha

1

Identifies the sold to customer as an associate or member who is eligible to receive special pricing on merchandise.

Y = The customer is an associate customer.

N = The customer is not an associate customer.

Not included for an order ship to address or permanent ship to address.

Recipient sold to: From the CST associate customer? in the Customer Sold To table.

ship_to_type

alpha

3

A code that identifies the type of sold to customer, used to group customers.

Not included for an order ship to address or permanent ship to address.

Recipient sold to: From the CST customer type in the Customer Sold To table.

ship_to_inactive

alpha

1

Identifies the sold to customer’s status.

Y = Customer is inactive.

N = Customer is active.

Not included for an order ship to address or permanent ship to address.

Recipient sold to: From the CST inactive? in the Customer Sold To table.

ship_to_

commercial

alpha

1

Identifies the sold to customer as commercial or non-commercial.

Y = This is a commercial customer.

N = This is a non-commercial customer.

Not included for an order ship to address or permanent ship to address.

Recipient sold to: From the CST commercial? in the Customer Sold To table.

ship_to_

alternate_id

alpha

15

A code used as an additional way to identify the sold to customer.

Not included for an order ship to address or permanent ship to address.

Recipient sold to: From the Interface cust code in the Customer Sold To table.

ship_to_cross_

ref_nbr

pack

9.0

A code that represents the customer on another system.

From the CST customer nbr xref in the Customer Sold To table.

ship_to_currency_code

alpha

3

A code that identifies the currency used by the sold to customer.

Not included for an order ship to address or permanent ship to address.

Recipient sold to: From the Currency code in the Customer Sold To table.

ship_to_currency_desc

alpha

30

A description of the currency.

Not included for an order ship to address or permanent ship to address.

From the CUR currency description in the Currency table.

ship_to_

warehouse

numeric

3

A code used to identify the warehouse (store location) where you replenish stock for this customer (store).

Not included for an order ship to address or permanent ship to address.

Recipient sold to: From the Whs in the Customer Warehouse table.

ship_to_

warehouse_name

alpha

30

The name of the warehouse.

Not included for an order ship to address or permanent ship to address.

From the Name in the Warehouse table.

The following fields prefixed with order_ship_to represents an order ship to address. The order ship to address values are from the Order Ship To Address table.

order_ship_to_

prefix

alpha

3

The order ship to customer’s prefix.

From the NAM prefix in the Order Ship To Address table.

order_ship_to_

fname

alpha

15

The order ship to customer’s first name.

From the NAM first name in the Order Ship To Address table.

order_ship_to_

initial

alpha

1

The order ship to customer’s middle initial.

From the NAM initial in the Order Ship To Address table.

order_ship_to_

lname

alpha

25

The order ship to customer’s last name.

From the NAM last name in the Order Ship To Address table.

order_ship_to_

suffix

alpha

3

The order ship to customer’s suffix.

From the NAM suffix in the Order Ship To Address table.

order_ship_to_

company

alpha

30

The order ship to customer’s company.

From the NAM company name in the Order Ship To Address table.

order_ship_to_apt

alpha

10

The order ship to customer’s apartment.

From the NAM apartment in the Order Ship To Address table.

order_ship_to_

address1

alpha

32

The order ship to customer’s street address.

From the NAM street address in the Order Ship To Address table.

order_ship_to_

address2

alpha

32

The order ship to customer’s second address line.

From the NAM address line 2 in the Order Ship To Address table.

order_ship_to_

address3

alpha

32

The order ship to customer’s third address line.

From the NAM address line 3 in the Order Ship To Address table.

order_ship_to_

address4

alpha

32

The order ship to customer’s fourth address line.

From the NAM address line 4 in the Order Ship To Address table.

order_ship_to_

city

alpha

25

The city for the order ship to customer’s address.

From the NAM city in the Order Ship To Address table.

order_ship_to_

country

alpha

3

The country for the order ship to customer’s address.

From the RPR country in the Order Ship To Address table.

order_ship_to_

country_name

alpha

30

The name of the country.

From the Description in the Country table.

order_ship_to_

state

alpha

2

The state for the order ship to customer’s address.

From the NAM state in the Order Ship To Address table.

order_ship_to_

state_name

alpha

25

The name of the state.

From the Description in the State table.

order_ship_to_zip

alpha

10

The postal code for the order ship to customer’s address.

From the NAM zip in the Order Ship To Address table.

order_ship_to_

delivery_code

alpha

1

Identifies the address as a business or residential address.

B = Business address.

R = Residential address.

N = No distinction between business and residence.

Maps to the NAM delivery code in the Order Ship To Address table.

order_ship_to_

po_box

alpha

1

Indicates if the customer’s delivery address is a post office box.

Y = The address is a post office box.

N = The address is not a post office box.

From the NAM PO box in the Order Ship To Address table.

order_ship_to_

email_address

alpha

50

The order ship to customer’s email address.

From the Email address in the Order Ship To Address table.

InvoiceBillingAddress

This element is included only if a record exists in the Invoice Address table. The system saves the billing address in this table when it bills a shipment only if the Capture Addresses for Invoice (J24) system control value was selected. The billing address indicated here is based on the bill-to account, if any, associated with the order; otherwise, it is based on the sold-to customer.

For more information: See the Display Invoice Address Screen (Billing Address) for more information on the invoice billing address.

iba_ship_to_nbr

numeric

3

 

iba_prefix

alpha

3

 

iba_fname

alpha

15

 

iba_initial

alpha

1

 

iba_lname

alpha

25

 

iba_suffix

alpha

3

 

iba_company

alpha

30

 

iba_apt

alpha

10

 

iba_address1

alpha

32

 

iba_address2

alpha

32

 

iba_address3

alpha

32

 

iba_city

alpha

25

 

iba_country

alpha

3

 

iba_country_

name

alpha

30

 

iba_state

alpha

2

 

iba_state_name

alpha

25

 

iba_zip

alpha

10

 

InvoiceShippingAddress

This element is included only if a record exists in the Invoice Address table.The system saves the shipping address in this table when it bills a shipment only if the Capture Addresses for Invoice (J24) system control value was selected.

See the Display Invoice Address Screen (Shipping Address) for more information on the invoice shipping address.

isa_ship_to_nbr

numeric

3

 

isa_prefix

alpha

3

 

isa_fname

alpha

15

 

isa_initial

alpha

1

 

isa_lname

alpha

25

 

isa_suffix

alpha

3

 

isa_company

alpha

30

 

isa_apt

alpha

10

 

isa_address1

alpha

32

 

isa_address2

alpha

32

 

isa_address3

alpha

32

 

isa_city

alpha

25

 

isa_country

alpha

3

 

isa_country_

name

alpha

30

 

isa_state

alpha

2

 

isa_state_name

alpha

25

 

isa_zip

alpha

10

 

isa_deliver_code

alpha

1

 

InvoiceDetail

The InvoiceDetail element and its attributes repeat for each item associated with the invoice.

idt_seq_nbr

numeric

5

The sequence number assigned to the invoice detail.

From the Seq # in the Invoice Detail table.

idt_line_nbr

numeric

3

The invoice detail line number.

From the IDT line # in the Invoice Detail table.

idt_control_nbr

numeric

7

The pick control number assigned to the invoice detail line.

From the Control # in the Invoice Detail table.

idt_ship_date

numeric

10

The date the item on the invoice line was shipped in YYYY-MM-DD format.

From the IDT date shipped in the Invoice Detail table.

idt_return_date

numeric

10

The most recent date that the customer returned any quantity of the item against the invoice line in YYYY-MM-DD format.

From the IDT date returned in the Invoice Detail table.

idt_shipped_qty

numeric

5

The shipped quantity for the item on the invoice line.

From the IDT qty shipped in the Invoice Detail table.

idt_return_qty

numeric

5

The quantity of the item on the invoice line that the customer returned.

From the IDT qty returned in the Invoice Detail table.

idt_credited_qty

numeric

5

The quantity of the item on the invoice line for which you have credited the customer.

From the Qty credited in the Invoice Detail table.

idt_actual_price

numeric

7.2

The actual unit price of the shipped item.

From the IDT price in the Invoice Detail table.

idt_discount_amt

numeric

9.2

The total extended discount amount applied to the item on the invoice line.

From the Discount amount in the Invoice Detail table.

idt_freight_amt

numeric

7.2

The freight amount applied to the item on the invoice line.

From the IDT freight in the Invoice Detail table.

idt_tax_amt

numeric

10.5

The tax amount applied to the item on the invoice line.

If a tax override amount is defined for the order line and you process multiple shipments against the line, the system prorates the tax override amount across the units shipped on the order line to determine the new tax override amount and the tax amount to apply to each shipment. Example: If the tax override amount for the order line is 9.00 and the order quantity is 3, the system charges 3.00 if you ship 1 unit of the item and then charges 6.00 if you ship the remaining 2 units of the item.

From the IDT tax in the Invoice Detail table.

idt_gst_amt

numeric

10.5

The GST amount applied to the item on the invoice line.

From the IDT GST in the Invoice Detail table.

idt_pst_amt

numeric

10.5

The PST amount applied to the item on the invoice line.

From the IDT PST in the Invoice Detail table.

idt_handling_amt

numeric

7.2

The handling charge amount applied to the item on the invoice line.

From the IDT handling in the Invoice Detail table.

idt_cost_amt

numeric

11.4

The cost of the item.

From the Cost in the Invoice Detail table.

OrderDetail

odt_ordered_qty

numeric

5.0

The number of units ordered on the order line.

From the ODT qty ordered in the Order Detail table.

odt_reserved_qty

numeric

5.0

The number of units on the order line for which stock has been reserved.

From the ODT qty reserved in the Order Detail table.

odt_printed_qty

numeric

5.0

The number of units on the order line for which pick slips have been printed.

From the ODT qty printed in the Order Detail table.

odt_cancelled_qty

numeric

5.0

The number of units on the order line that have been cancelled.

From the ODT qty cancelled in the Order Detail table.

odt_sold_out_qty

numeric

5.0

The number of units on the order line that are sold out and are no longer available to ship.

Note: This number is updated only if a sold out reason code has been assigned to the item and the shipped quantity does not match the order quantity; this number is not updated when you sell out immediately.

From the ODT qty sold out in the Order Detail table.

odt_shipped_qty

numeric

5.0

The number of units on the order line that have shipped.

From the ODT qty shipped in the Order Detail table.

odt_returned_qty

numeric

5.0

The number of units on the order line that the customer has returned.

From the ODT qty returned in the Order Detail table.

odt_credited_qty

numeric

5.0

The number of returned units on the order line for which a credit was issued.

From the Qty credited in the Order Detail table.

odt_line_status

alpha

1

The status of the order line.

blank = Open.

C = Cancelled.

H = Held.

S = Suspended.

X = Closed.

From the ODT line status in the Order Detail table.

odt_drop_ship

alpha

1

Indicates if the item on the order line is a drop ship item.

Y = The item is a drop ship item.

N = The item is not a drop ship item.

From the ODT drop ship flag in the Order Detail table.

odt_item

alpha

12

The code for the item on the order line.

From the ITM number in the Order Detail table.

odt_item_

description

alpha

40

The description of the item.

From the Description in the Item table.

odt_sku

alpha

14

A code for the SKU, such as color, size, or style, of the item.

From the SKU code in the Order Detail table.

odt_short_sku

numeric

7

The short SKU code for the item on the order line.

From the Short SKU in the SKU table.

odt_sku_

description

alpha

40

The description of the SKU, if this is a SKU’d item.

From the Description in the SKU table.

odt_retail_ref_nbr

numeric

15

The retail reference number for the item on the order line.

From the SKU retail x-ref # in the SKU table.

odt_offer

alpha

3

The offer code assigned to the order line.

From the Offer number in the Order Detail table.

odt_alias

alpha

12

A code used as an additional way to identify the item on the order line.

From the Alias in the Order Detail table.

odt_page_letter

alpha

6

The page on which the item on the order line is advertised in the offer and the letter that identifies the item on the page.

From the Page letter in the Order Detail table.

odt_page_nbr

numeric

5

The page on which the item on the order line is advertised in the offer.

From the Page# in the Order Detail table.

odt_sub_set

alpha

1

From the ODT sub set? in the Order Detail table.

odt_sub_set_seq_nbr

numeric

3

From the ODT sub set sequence # in the Order Detail table.

odt_warranty_

item

alpha

1

Indicates if the item on the order line is a warranty item.

Y = The item is a warranty item.

N = The item is not a warranty item.

From the ODT warranty item? in the Order Detail table.

odt_source_code

alpha

9

A code that identifies the source code assigned to the order line.

From the ODT SRC source code in the Order Detail table.

odt_source_

description

alpha

30

A description of the source code.

From the SRC description in the Source table.

odt_division_

code

alpha

2

A code that identifies the division associated with the source code on the order line.

From the Div in the Source table.

odt_division_

description

alpha

30

A description of the division.

From the Description in the Division table.

odt_entity_nbr

numeric

3

A code that identifies the entity associated with the source code on the order line.

From the Entity number in the Division table.

odt_entity_

description

alpha

25

A description of the entity.

From the ENT description in the Entity table.

odt_discount_

applied

alpha

1

Indicates if a discount was applied against the order line.

Y = A discount was applied against the order line.

N = A discount was not applied against the order line.

From the Discount applied in the Order Detail table.

odt_no_charge

alpha

1

Indicates if the item is sold at no charge.

Y = The item is sold at no charge.

N = The item is sold for a price.

From the ODT no charge in the Order Detail table.

odt_second_

choice_status

alpha

1

This field is not currently implemented.

From the ODT second choice status in the Order Detail table.

odt_affect_

inventory

alpha

1

Controls whether the system reserves the item on the order line and reduces inventory after shipment.

Y = Reserve the item and reduce inventory.

N = Do not affect inventory.

From the ODT affect inventory in the Order Detail table.

odt_arrival_date

numeric

10.0

The date the customer requested delivery of the item, in YYYY-MM-DD format.

From the ODT arrival date in the Order Detail table.

odt_bo_level

numeric

2.0

A number that controls the priority of order fulfillment on a backordered item.

From the ODT BO level in the Order Detail table.

odt_cancel_date

numeric

10.0

The last date on which the customer will accept receipt of the item, in YYYY-MM-DD format.

From the ODT cancel date in the Order Detail table.

odt_coordinate_

group

numeric

3.0

A number assigned to 2 or more order lines to ensure that they ship together.

From the ODT coordinate group in the Order Detail table.

odt_date_printed

numeric

10.0

The date on which a pick slip for the order line was printed, in YYYY-MM-DD format.

From the ODT date printed in the Order Detail table.

odt_date_

reserved

numeric

10.0

The date when units on the order line were reserved, in YYYY-MM-DD format.

From the ODT date reserved in the Order Detail table.

odt_discount

numeric

5.2

The amount of the discount applied to the item. This field is not currently implemented.

From the ODT discount in the Order Detail table.

odt_expected_

ship_date

numeric

10.0

For backordered items, this is the date a purchase order containing the backordered item is expected, in YYYY-MM-DD format.

From the ODT expected ship date in the Order Detail table.

odt_freight_

charge

numeric

7.2

The charge for shipping the item.

From the ODT freight charge in the Order Detail table.

odt_future_order

alpha

1

Indicates that the arrival date for the item is too far in the future to reserve stock. The item is reserved whenever the current date reaches the requested arrival date minus lead days for picking and shipping.

Y = This is a future order; do not reserve inventory.

N = This is not a future order and is eligible for inventory reservation.

From the ODT future order in the Order Detail table.

odt_next_bo_card_date

numeric

10.0

The most recent date the system generated a backorder notice, in YYYY-MM-DD format. A backorder notice is sent to the customer regarding a shipment delay on an item.

From the ODT next BO card date in the Order Detail table.

odt_original_price

numeric

7.2

The offer price of the item before any discount is applied.

From the ODT original price in the Order Detail table.

odt_price

numeric

7.2

The price the customer is charged for a single unit of the item.

From the ODT price in the Order Detail table.

odt_bypass_

reservation

alpha

1

Indicates whether the item bypasses immediate reservation, requiring you to manually reserve the item.

Y = Bypass immediate reservation.

N = Do not bypass reservation.

From the Bypass res in the Order Detail table.

odt_special_

handling_dollars

numeric

7.2

The charge for special handling the item.

From the ODT special handling $ in the Order Detail table.

odt_tax

numeric

10.5

Sales tax charged for the item on the order line.

If a tax override amount is defined for the order line and you process multiple shipments against the line, the system prorates the tax override amount across the units shipped on the order line to determine the new tax override amount and the tax amount to apply to each shipment. Example: If the tax override amount for the order line is 9.00 and the order quantity is 3, the system charges 3.00 if you ship 1 unit of the item and then charges 6.00 if you ship the remaining 2 units of the item.

From the ODT tax in the Order Detail table.

odt_gst

numeric

10.5

The Canadian Goods and Services tax for the order line.

From the ODT GST in the Order Detail table.

odt_pst

numeric

10.5

The Provincial Services tax for the order line.

From the ODT PST in the Order Detail table.

odt_time_

reserved

numeric

8.0

The time the item on the order line was reserved in the format HH:MM:SS.

From the ODT time reserved in the Order Detail table.

odt_units_

confirmed

numeric

5.0

The number of units on the order line that have been confirmed for shipment.

From the ODT units confirmed in the Order Detail table.

odt_upsell_cross_sell

alpha

1

Indicates if an upsell/cross-sell promotion has been applied against the order line.

C = Coordinate cross sale.

P = Net Perception add on.

N = No promotion.

Y = Upsell/cross-sell promotion.

From the Upsell/cross-sell in the Order Detail table.

odt_gift_wrap

alpha

1

Indicates whether the item is gift wrapped.

Y = Gift wrap the item.

N = Do not gift wrap the item.

From the Gift wrap in the Order Detail table.

odt_cost_override

numeric

11.4

The override to the item’s cost from order entry or maintenance.

From the Cost override in the Order Detail table.

odt_entered_date

numeric

10.0

The date on which the order line was entered, in YYYY-MM-DD format.

From the Entered date in the Order Detail table.

odt_entered_time

numeric

8.0

The time on which the order line was entered, in HH:MM:SS format.

From the Entered time in the Order Detail table.

odt_priority

numeric

1

A number that controls the priority of order fulfillment on a backordered item. Priority codes range from 0 - 9, where 0 is the lowest priority and 9 is the highest priority.

From the Priority in the Order Detail table.

odt_backorder_

reason

alpha

1

A code that represents the reason the item is on backorder.

blank = The item is not backordered.

D = The item is a drop ship item that is not kept in inventory.

F = The item is a future order.

R = Item/Warehouse reservation freeze.

I = No Item/Warehouse record.

W = No warehouse specified.

N = Non-allocatable warehouse.

O = Not enough inventory available to fulfill the entire order quantity.

S = Not selected batch reservation.

B = Reservation bypassed.

L = SKU reserve limit exceeded.

U = Interactive unreserve.

Z = Zoned reservation.

From the Backorder reason in the Order Detail table.

odt_freight_

override

alpha

1

Indicates if the freight was overridden for the order line.

Y = The freight was overridden for the order line.

N = The fright was not overridden for the order line.

From the Freight override in the Order Detail table.

odt_freight_

additional

numeric

7.2

The additional freight charges for the order line.

From the Freight additional in the Order Detail table.

oft_offer_price

numeric

7.2

The offer price of the item on the order line before any discount is applied.

From the Offer price in the Order Detail table.

odt_price_method

alpha

1

The method the system used to calculate the price of an item, but before applying an order-level discount.

1 = Coupon item price

2 = Customer discount%

3 = Contract price

4 = Special source price

5 = Column price

6 = Quantity break price

C = Item cost

D = Regular plus reprice

E = Price codes

I = Repriced (quantity break by item)

N = No charge/cost tracking

O = No charge/no cost tracking

P = Regular hierarchy

Q = Repriced (quantity break by offer)

R = Price override

V = Volume discount

From the Price method in the Order Detail table.

odt_allow_

repricing

alpha

1

Indicates whether repricing is allowed for the order line.

Y = Repricing is allowed for the order line.

N = Repricing is not allowed for the order line.

From the Allow repricing in the Order Detail table.

odt_promotion_

used

alpha

1

Indicates if a promotion was applied against the order line.

Y = A promotion was applied against the order line.

N = A promotion was not applied against the order line.

From the Promo used? in the Order Detail table.

odt_freight_unit_

charge

numeric

7.2

The amount of freight charged for each unit of the item on the order line.

From the ODT freight unit charge in the Order Detail table.

odt_set_main_

item

alpha

1

Indicates if the item on the order line is a set master item.

Y = The item is a set master item.

N = The item is not a set master item.

From the Set main item in the Order Detail table.

odt_set_seq_nbr

numeric

3.0

The sequence number assigned to a set item, allowing you to group all components of a set.

From the Set seq # in the Order Detail table.

odt_coupon

alpha

1

Indicates if a coupon has been applied to the order line.

Y = A coupon has been applied to the order line.

N = A coupon has not been applied to the order line.

From the Coupon in the Order Detail table.

odt_coupon_

dollar_override

numeric

7.2

The coupon dollar amount subtracted from the order line price.

From the Coupon $ override in the Order Detail table.

odt_ft_purchase_date

numeric

7.0

The fast track purchase date entered at the Enter Fast Track window to add an item to the order in place of the representative fast track item.

From the F/T purch in the Order Detail table.

odt_ft_serial_nbr

numeric

9.0

The fast track serial number entered at the Enter Fast Track window to add an item to the order in place of the representative fast track item.

From the F/T ser # in the Order Detail table.

odt_pre_discount

numeric

7.2

The price of the item before any discounts were applied.

From the ODT pre-discount in the Order Detail table.

odt_duty

numeric

7.2

The amount of duty charged for the item.

From the ODT duty in the Order Detail table.

odt_upsell_type

alpha

1

A code indicating the type of upsell promotion applied to the order line.

From the ODT upsell type in the Order Detail table.

odt_need_by_

date

numeric

 

This field is currently not implemented.

From the ODT need by date in the Order Detail table.

odt_pickup_type

alpha

2

Not currently implemented.

odt_tax_override

alpha

1

If this flag is Y, the order was received from an external system that specified a tax, GST, or PST amount, indicating the tax amount from the external system should be retained on the order line.

From the ODT future use Y/N 1 in the Order Detail table.

odt_sh_exclude_

tax

alpha

1

Indicates if special handling charges were excluded from tax.

From the ODT future use Y/N 2 in the Order Detail table.

odt_pickup_

location_id

alpha

10

Not currently implemented.

odt_location_

system_id

alpha

10

Not currently implemented.

odt_additional_

charge_code

alpha

2

The code that represents the type of special handling that applies to the item.

From the ADD add’l chg code in the Order Detail table.

odt_whs_

warehouse

numeric

3.0

A code for the warehouse in which the item was reserved.

From the ODT WHS warehouse in the Order Detail table.

odt_whs_

warehouse_name

alpha

30

The name of the warehouse.

From the Name in the Order Detail table.

odt_cancel_

reason_code

numeric

2.0

A code indicating the reason the order line was cancelled.

From the CNR cancel reason code in the Order Detail table.

odt_via_ship_via_code

numeric

2.0

A code for the shipper assigned to the order line.

From the ODT VIA ship via code in the Order Detail table.

odt_ship_via_

description

alpha

 

A description of the shipper.

From the VIA shipper name in the Ship Via table.

odt_second_

choice_sku_item

alpha

12

From the ODT second choice SKU ITM in the Order Detail table.

Note: This field contains the hidden tax amount from the order detail line if the order is subject to VAT.

odt_second_

choice_sku_sku

alpha

14

From the ODT second choice SKU SKU in the Order Detail table.

odt_price_

override_code

alpha

1

A code that represents the reason for overriding the item price or giving the item to the customer at no charge.

From the POR price override code in the Order Detail table.

odt_backorder_

warehouse

numeric

3.0

A code that identifies the warehouse from which a backordered item will be shipped.

From the ODT B/O warehouse in the Order Detail table.

odt_backorder_

warehouse_name

alpha

30

The name of the backorder warehouse.

From the Name in the Warehouse table.

odt_aoc_addon_

code

alpha

3

This field is not currently implemented.

From the ODT AOC add-on code in the Order Detail table.

OrderLineMessage

The OrderLineMessages element and its attributes repeat for each order line message for the item on the order line.

line_msg_seq_

nbr

numeric

3

The sequence number assigned to the order line message.

From the Seq # in the Order Line Messages table.

line_message_

text

alpha

60

The order line message.

From the OLM message in the Order Line Messages table.

line_message_

print

alpha

1

Indicates whether, and where, the message prints.

P = Print the message on the pick slip.

I = Print the message on the invoice.

B = Print the message on the pick slip and invoice.

From the OLM print? in the Order Line Messages table.

line_message_

date

numeric

10

The date the message was entered in the format YYYY-MM-DD.

From the Entry date in the Order Line Messages table.

line_message_

user

alpha

10

The user ID of the person who entered the message.

From the User in the Order Line Messages table.

OrderDetailCoupon

The OrderDetailCoupon element and its attributes repeat for each coupon applied to the order line. See Entering Coupon Promotions on an Order for more information on applying coupons to an order or order line on the order.

Available in: 3.0 (release 3.5 of Order Management System).

odc_coupon_

code

alpha

6

The code that identifies the coupon applied to the order or order detail line.

From the Coupon Code field in the Order Detail Coupon table.

Available in: 3.0 (release 3.5 of Order Management System).

odc_coupon_type

alpha

1

Indicates whether this is an order-level or detail-level coupon. Valid values are:

O = applies to all applicable items on the order. Note: Order-level coupons display for each eligible order line on the order.

D = applies only to the specific item on the order.

From the Coupon Type field in the Order Detail Coupon table.

Available in: 3.0 (release 3.5 of Order Management System).

odc_post_

discount_price

numeric

7.2

The price of the item after the coupon has been applied. This is the unit price of the item, not the extended price of the order line.

From the Pre-Discount Price field in the Order Detail Coupon table.

Available in: 3.0 (release 3.5 of Order Management System).

odc_pre_discount_price

numeric

7.2

The price of the item before the coupon has been applied. This is the unit price of the item, not the extended price of the order line.

From the Post-Discount Price field in the Order Detail Coupon table.

Available in: 3.0 (release 3.5 of Order Management System).

StoredValueCard

The StoredValueCard element and its attribute repeats for each stored value card number assigned to the stored value card item on the order line. A unique stored value card number must be assigned to each stored value card ordered; for example, if you order two stored value cards, you must assign a unique number to each card. See Assigning a Stored Value Card Number for more information on assigning a number to a stored value card.

Available in: 3.0 (release 3.5 of Order Management System).

svc_card_nbr

alpha

20

The number assigned to the stored value card on the order line. The system masks this number in the MQ Log.

Note:

• The system includes activated and unactivated card numbers.

• The system includes all stored value card numbers for the order line associated with a return on a credit invoice, including the stored value cards that have not been returned.

From the SVC Card # field in the Stored Value Card table.

Available in: 3.0 (release 3.5 of Order Management System).

UPC

The UPC element and its attributes repeat for each UPC code defined for the item on the invoice line.

upc_type

alpha

3

The type of UPC code, identifying the type of validation the system performs against the UPC code.

E13 = EAN-13 validation.

E8 = EAN-8 validation.

UA = UPC-A validation.

UE = UPC-E validation.

From the UPC type in the Item UPC table.

upc_nbr

alpha

14

The UPC code defined for the item on the order line.

From the UPC in the Item UPC table.

upc_vendor_nbr

numeric

7

A code for the supplier who sells you merchandise.

From the UPC VND vendor nbr in the Item UPC table.

InvoiceDetailPayMethod

The InvoiceDetailPayMethod element and its attributes repeat for each pay type assigned to the invoice.

idp_opm_seq_nbr

numeric

5

The sequence number assigned to the invoice detail payment method.

From the Seq # in the Invoice Detail Pay Method table.

idp_merchandise_amt

numeric

9.2

The merchandise amount assigned to the invoice payment method.

From the Merch in the Invoice Detail Pay Method table.

idp_merchandise_balance_amt

numeric

9.2

The unpaid portion of the merchandise amount assigned to the invoice payment method.

From the Merch balance in the Invoice Detail Pay Method table.

idp_freight_amt

numeric

7.2

The freight amount assigned to the invoice payment method.

From the Freight in the Invoice Detail Pay Method table.

idp_freight_

balance_amt

numeric

7.2

The unpaid portion of the freight amount assigned to the invoice payment method.

From the Freight balance in the Invoice Detail Pay Method table.

idp_hand_charge_amt

numeric

7.2

The handling charge amount assigned to the invoice payment method.

From the Handling in the Invoice Detail Pay Method table.

idp_hand_charge_balance_amt

numeric

7.2

The unpaid portion of the handling charge amount assigned to the invoice payment method.

From the Handling balance in the Invoice Detail Pay Method table.

idp_tax_amt

numeric

10.5

The tax amount assigned to the invoice payment method.

From the Tax in the Invoice Detail Pay Method table.

idp_tax_balance_amt

numeric

10.5

The unpaid portion of the tax amount assigned to the invoice payment method.

From the Tax balance in the Invoice Detail Pay Method table.

idp_gst_amt

numeric

10.5

The GST amount assigned to the invoice payment method.

From the GST in the Invoice Detail Pay Method table.

idp_gst_balance_amt

numeric

10.5

The unpaid portion of the GST amount assigned to the invoice payment method.

From the GST balance in the Invoice Detail Pay Method table.

idp_pst_amt

numeric

10.5

The PST amount assigned to the invoice payment method.

From the PST in the Invoice Detail Pay Method table.

idp_pst_balance_amt

numeric

10.5

The unpaid portion of the PST amount assigned to the invoice payment method.

From the PST balance in the Invoice Detail Pay Method table.

InvoiceDetailCharge

The InvoiceDetailCharges element and its attributes repeat for each additional charge assigned to the item on the invoice line.

idc_charge_type

alpha

1

Identifies the type of charge assigned to the item on the invoice line.

D = Duty charge.

S = Shipper/item charge.

V = VAT/hidden tax charge.

From the IDC type of charge in the Invoice Detail Charge table.

idc_charge_amt

numeric

11.2

The amount of the charge assigned to the item on the invoice line.

From the IDC amount in the Invoice Detail Charge table.

idc_unit_amt

numeric

7.2

The flat rate the system used to calculate the duty amount.

From the Unit amount in the Invoice Detail Charge table.

idc_duty_pct

numeric

5.2

The percentage the system used the calculate the duty amount.

From the Duty percent in the Invoice Detail Charge table.

InvoiceDetailCost

There is one InvoiceDetailCost element and its attributes for each invoice line.

ivc_fifo_seq_nbr

numeric

7

The sequence number of the FIFO cost layer that provided the unit cost.

From the IVC FIFO seq # in the Invoice Detail Cost table.

ivc_fifo_date

numeric

10

The date the FIFO layer was created in the YYYY-MM-DD format.

From the IVC FIFO date in the Invoice Detail Cost table.

ivc_fifo_cost

numeric

11.4

The unit cost of the item derived from the FIFO layer.

From the IVC FIFO cost in the Invoice Detail Cost table.

ivc_quantity

numeric

7

The unit quantity of the item taking its cost from the FIFO layer.

From the IVC quantity in the Invoice Detail Cost table.

ivc_unit_balance

numeric

7

The total unit quantity of the item from the FIFO layer that has not been returned by the customer.

From the IVC unit balance in the Invoice Detail Cost table.

Invoice Download Message: Sample XML

A sample of the Invoice Download XML Message (CWInvoiceOut) is presented below.

<Message date_created="2006-12-21" source="OROMS" target="cwi" time_created="16:30:18" type="CWINVOICEOUT">

<InvoiceHeader ihd_company="45" ihd_invoice_nbr="502" ihd_invoice_type="I" ihd_order_nbr="2614" ihd_transaction_type="A">

<CompanyAddress company_address1="24 PRIME PARK WAY" company_city="NATICK" company_country="USA" company_country_name="UNITED STATES OF AMERICA" company_description="CommercialWare" company_state="MA" company_state_name="MASSACHUSETTS" company_zip="01760" />

<OrderHeader ohd_cst_customer_nbr="12879" ohd_ecomm_order_number="WEB-12345-ORDER" ohd_email_confirm_date="2006-05-02" ohd_enter_date="2006-04-28" ohd_enter_time="20:03:31" ohd_entered_by_user="SBROWN" ohd_freight_override="N" ohd_invoice_division_code="01" ohd_invoice_division_description="CORE LINE" ohd_invoice_entity_description="WIDGETS GALORE" ohd_invoice_entity_nbr="100" ohd_invoice_source_code="A123" ohd_invoice_source_description="SPRING 2006 BUYERS" ohd_nbr_of_recipients="1" ohd_order_channel="I" ohd_order_date="2006-04-28" ohd_order_email_address="sbrown@commercialware.com" ohd_order_status="X" ohd_order_type="P" ohd_order_type_description="WEB STORE" ohd_reference_order_nbr="2614" />

<CustomerSoldTo sold_to_address1="257 EXAMPLE STREET" sold_to_alternate_id="646" sold_to_associate="N" sold_to_city="WORCESTER" sold_to_country="USA" sold_to_country_name="UNITED STATES OF AMERICA" sold_to_day_phone="5085550101" sold_to_delivery_code="R" sold_to_email_address="sbrown@example.com" sold_to_email_status="O1" sold_to_eve_phone="1234567890" sold_to_fax_phone="2345678901" sold_to_fname="SARAH" sold_to_lname="BROWN" sold_to_mail_code="BC" sold_to_mail_code_desc="REPEAT CUSTOMER" sold_to_mail_name="Y" sold_to_nbr="12879" sold_to_po_box="N" sold_to_rent_name="Y" sold_to_state="MA" sold_to_state_name="MASSACHUSETTS" sold_to_zip="01602" />

<InvoicePaymentMethods>

<InvoicePaymentMethod ipm_cc_expiration_date="808" ipm_credit_card_nbr="CHANGEDBYLOGGER" ipm_deposit_amount="2.33" ipm_deposit_release_date="2006-11-01" ipm_invoice_date="2006-11-01" ipm_merchandise_amt="2.33" ipm_merchandise_balance_amt="2.33" ipm_pay_category="2" ipm_pay_type="4" ipm_pay_type_desc="VISA" ipm_seq_nbr="1" />

</InvoicePaymentMethods>

<InvoiceShipTos>

<InvoiceShipTo ins_invoice_date="2006-11-01" ins_merchandise_amt="2.33" ins_ship_to_nbr="1">

<OrderShipTo ost_arrival_date="2006-04-28" ost_calculate_freight="Y" ost_cancel_bo="N" ost_freight_override="N" ost_gift_flag="N" ost_last_pick_print_date="2006-11-01" ost_merchandise="2.33" ost_nbr_of_shipments="1" ost_number_of_lines="1" ost_order_combination_type="0910" ost_ship_complete="N" ost_ship_via_code="1" ost_ship_via_description="UPS" ost_status="X" ost_tax_code="N" />

<CustomerShipTo ship_to_address1="257 EXAMPLE STREET" ship_to_alternate_id="646" ship_to_associate="N" ship_to_city="WORCESTER" ship_to_country="USA" ship_to_country_name="UNITED STATES OF AMERICA" ship_to_customer_nbr="12879" ship_to_day_phone="5085550106" ship_to_delivery_code="R" ship_to_email_address="sbrown@example.com" ship_to_email_status="O1" ship_to_eve_phone="1234567890" ship_to_fax_phone="2345678901" ship_to_fname="SARAH" ship_to_lname="BROWN" ship_to_mail_code="BC" ship_to_mail_code_desc="REPEAT CUSTOMER" ship_to_mail_name="Y" ship_to_po_box="N" ship_to_rent_name="Y" ship_to_state="MA" ship_to_state_name="MASSACHUSETTS" ship_to_zip="01602" />

<InvoiceDetails>

<InvoiceDetail idt_actual_price="2.33" idt_control_nbr="1569" idt_line_nbr="1" idt_seq_nbr="1" idt_ship_date="2006-11-01" idt_shipped_qty="1">

<OrderDetail odt_affect_inventory="Y" odt_allow_repricing="Y" odt_arrival_date="2006-04-28" odt_bypass_reservation="N" odt_coupon="N" odt_date_printed="2006-11-01" odt_date_reserved="2006-04-28" odt_division_code="01" odt_division_description="CORE LINE" odt_entered_date="2006-04-28" odt_entered_time="20:03:29" odt_entity_description="WIDGETS GALORE" odt_entity_nbr="100" odt_freight_override="N" odt_future_order="N" odt_gift_wrap="N" odt_item="BD1001" odt_item_description="WIDGETS" odt_line_status="X" odt_offer="001" odt_offer_price="2.33" odt_ordered_qty="1" odt_original_price="2.33" odt_pre_discount="2.33" odt_price="2.33" odt_price_method="6" odt_set_main_item="N" odt_shipped_qty="1" odt_short_sku="532" odt_sku=" " odt_source_code="A123" odt_source_description="SPRING 2006 BUYERS" odt_time_reserved="20:06:25" odt_warranty_item="N" />

<UPCs>

<UPC upc_nbr="1234567890" upc_type="E13" upc_vendor_nbr="100" />

</UPCs>

<InvoiceDetailPayMethods>

<InvoiceDetailPayMethod idp_merchandise_amt="2.33" idp_merchandise_balance_amt="2.33" idp_opm_seq_nbr="1" />

</InvoiceDetailPayMethods>

</InvoiceDetail>

</InvoiceDetails>

</InvoiceShipTo>

</InvoiceShipTos>

</InvoiceHeader>

</Message>

ST01_05 OMSCS 19.0 December 2019 OHC