Chapter 113: Generic Invoice Download API

The system creates invoice download triggers in the IL Outbound Trigger file when an invoice or credit invoice is created. The Invoice Outbound job in the Working with Integration Layer Processes (IJCT) menu option monitors the IL Outbound file for invoice download triggers to process and generates an Invoice Download XML Message (CWINVOICEOUT) to send to the remote system.

Identifying Invoice Download Triggers

You can view all download triggers in the IL Outbound Trigger file at the Work with Outbound Interface Transactions Screen.

Each trigger in the IL Outbound Trigger file contains a:

• File code: indicating the type of information to download and which IL process job processes the trigger. For invoice download triggers, the File code is IHD.

• Key: indicating the specific record to download. For invoice download triggers, the Key identifies the specific company, order number, and invoice number associated with the invoice download trigger. For example, the Key 555000063970001713 indicates the invoice information is located in company 555 for order number 6397 and invoice number 1713.

• Capture type: indicating the type of activity performed against the record; see Invoice Outbound Trigger Activities.

• A = the invoice was created.

• C = the invoice was updated.

When are Invoice Download Triggers Created?

The Create Generic Invoice Download Trigger Records (I17) system control value controls whether the system creates invoice download triggers in the IL Outbound Trigger file.

• If this system control value is set to Y, certain actions in CWDirect triggers the system to create invoice download triggers in the IL Outbound Trigger file with a File code of IHD. The IL Outbound Trigger file acts as a “to do” list for the invoice information that requires download.

• If this system control value is set to N, the system does not create invoice download triggers in the IL Outbound Trigger file.

You can also create an invoice download trigger for each invoice in your company using the Generating Outbound Interface Triggers (GOIT) menu option. Run this process to initially send invoices to the remote system.

Invoice Download Processing

To generate an Invoice Download XML Message (CWINVOICEOUT), the system:

1. Creates invoice download triggers, based on CWDirect activities that create an invoice. See Invoice Outbound Trigger Activities for a list of the activities that create invoice download triggers.

2. Evaluates the trigger rules defined for the Invoice Outbound job to determine if the invoice download trigger is created. Invoice Outbound Trigger Rules define the criteria the invoice must meet in order for the system to create an invoice download trigger.

3. When active, the trigger monitor defined for the Invoice Outbound job looks for unprocessed invoice download triggers to process at defined intervals, based on the value defined in the Outbound delay time field.

The Invoice Outbound trigger monitor:

• looks for invoice download triggers with the File code IHD and a status of ready (R).

• removes duplicate invoice download triggers. See Invoice Trigger Cleanup.

• determines which invoice to download, based on the Key field for the invoice download trigger. The Key field for invoice download triggers consists of company + order number + invoice number. For example, the Key 555000063970001713 indicates the invoice information is located in company 555 for order number 6397 and invoice number 1713.

• sends each invoice download trigger to the message builder defined for the Invoice Outbound job.

4. For each invoice download trigger, the message builder defined for the Invoice Outbound job determines which elements to include in the invoice download message, based on XML inclusion rules; see Invoice Outbound XML Inclusion.

5. The Invoice Outbound message builder sends the generated invoice download messages to the queues defined for the Invoice Outbound job whose Enabled field is set to Y. See Outbound Interface Queues.

Invoice Outbound Trigger Activities

This table indicates:

• which CWDirect activities create an invoice download trigger.

• which file(s) the invoice download trigger references.

• the type of activity performed against the invoice:

• A = the invoice was created.

• C = the invoice was updated.

Note: Some activities may create duplicate triggers; however, the Invoice Trigger Cleanup will remove any duplicates before generating the Invoice Download XML Message (CWINVOICEOUT).

You can review the invoice download triggers in the IL Outbound Trigger file at the Work with Outbound Interface Transactions Screen.

Change triggers: The system creates a change invoice download trigger only when it consolidates a shipment or credit invoice. The system does not create a change invoice download trigger when:

• the setting of the Consolidated Invoice (B49) or the Consolidated Credit Invoice (K06) system control values prevents the consolidation of an invoice, or

• you settle or reject the deposit for a shipment invoice, or

• you perform any updates against an invoice subject to deferred or installment billing at the Change Invoice Pay Method Screen.

For more information: See Consolidated Invoices for examples of how the system creates invoice download triggers, based on the setting of the Consolidated Invoice (B49) or the Consolidated Credit Invoice (K06) system control values.

Note: The system creates an invoice download trigger for the activities listed below only if the invoice meets the criteria in the Invoice Outbound Trigger Rules.

Activity	Menu Option	Referenced File	Trigger Type
Create a debit invoice during billing for a shipment against the order. Note: • If the Consolidated Invoice (B49) system control value is set to Y, the system can create a single invoice for the shipments against the order on the same date; otherwise, the system creates a separate invoice for each shipment against the order. See Consolidated Invoices. • Pre-billing an item generates the CWInvoiceOut message. See the Pre Billed Amount Item (J72) system control value for a discussion.	Billing async, MCON	Invoice Header Order Header	A
Create a credit invoice during billing for returns, cancellations, and overpayments. If the Consolidated Credit Invoice (K06) system control value is set to Y, the system can create a single credit invoice for the refunds against the order on the same date; otherwise, the system creates a separate credit invoice for each refund against the order. See Consolidated Invoices.	Billing async, WRTA OEOM	Invoice Header Order Header	A
Generate invoice download triggers	GOIT	Invoice Header Order Header	A
Add a line to a debit invoice during billing for an additional shipment if the Consolidated Invoice (B49) system control value is set to Y.	Billing async, MCON	Invoice Header Order Header	C
Add a line to a credit invoice during billing for an additional return, cancellation, or overpayment against the order if the Consolidated Credit Invoice (K06) system control value is set to Y.	Billing async, WRTA OEOM	Invoice Header Order Header	C

Consolidated Invoices

Shipment invoices: The Consolidated Invoice (B49) system control value defines whether you consolidate invoices for shipments. If this system control is set to Y and items that are shipped on the same day are consolidated on the same invoice, then the system creates an add invoice download trigger for the first shipment, and afterward creates a change invoice download trigger for each additional shipment within the same billing cycle.

Otherwise, if the Consolidated Invoice (B49) system control value is set to N or if another factor prevents invoices from consolidating (for example, if you process deposits between shipments), then each shipment creates a separate invoice, and the system creates an add invoice download trigger for each shipment, even if they occur on the same date.

Credit invoices: The Consolidated Credit Invoice (K06) system control value defines whether you consolidate credit invoices for returns. The system uses the same rules to determine whether to create an add invoice download trigger or a change invoice download trigger for credit invoices as for shipment invoices.

Consolidated invoice example: You ship and bill three order lines on order 6456 on the same date.

Order line	Invoice	Invoice Download Trigger
line 1 shipped and billed at noon	System creates invoice 1715	System creates invoice download trigger for Trigger type A: 555000064560001715
line 2 shipped and billed at 3PM	System updates invoice 1715	System creates invoice download trigger for Trigger type C: 555000064560001715
line 3 shipped and billed at 5PM	System updates invoice 1715	System creates invoice download trigger for Trigger type C: 555000064560001715
Note: The Invoice Trigger Cleanup will remove the duplicate change invoice download trigger, keeping the most recent change, before generating an Invoice Download XML Message (CWINVOICEOUT).

Unconsolidated invoice example: You ship and bill three order lines on order 6457 on the same date, but the Consolidated Invoice (B49) system control value is set to N.

Order line	Invoice	Invoice Download Trigger
line 1 shipped and billed at noon	System creates invoice 1716	System creates invoice download trigger for Trigger type A: 555000064570001716
line 2 shipped and billed at 3PM	System creates invoice 1717	System creates invoice download trigger for Trigger type A: 555000064570001717
line 3 shipped and billed at 5PM	System creates invoice 1718	System creates invoice download trigger for Trigger type A: 555000064570001718

Note:

• The same rules apply for credit invoices as for shipment invoices, based on the setting of the Consolidated Credit Invoice (K06) system control value.

• Any factor that prevents a shipment or credit invoice from consolidating produces a situation resembling the second example above. For example, invoices do not consolidate if:

• You run Processing Auto Deposits (SDEP) between billing shipments (or, in the case of credit invoices, you process refunds and then process auto deposits)

• The Invoice Consolidation Method (E29) system control value is set to ORDER SHIP, and the shipments (or returns) were for different order ship-tos

• The Capture Addresses for Invoice (J24) system control value is set to Y, and the shipping or billing address changed between shipments (or between returns)

Invoice Outbound Trigger Rules

Invoice Outbound trigger rules define the criteria an invoice must meet in order for the system to create an invoice download trigger.

• If the invoice meets the Invoice Outbound trigger rule criteria, the system creates an invoice download trigger.

• If the invoice does not meet the Invoice Outbound trigger rule criteria, the system does not create an invoice download trigger.

You can define Invoice Outbound trigger rules for fields in the Invoice Header file and Order Header file that are included in the Invoice Download XML Message (CWINVOICEOUT). If you define more than one criterion, the invoice must meet all of the criteria defined in order to generate a trigger.

Example: You define the following trigger rules for the Invoice Outbound job.

Invoice Outbound Trigger Rules
Invoice Header file criteria	Order Header file criteria	Results
The Company field must equal 135 or 555.		The system creates an invoice download trigger only if the invoice being created is in company 135 or 555.
The Company field must equal 135 or 555. The Invoice type field must equal ’I’ (invoice).		The system generates an invoice download trigger only if the invoice being created is in company 135 or 555 and the type of invoice is I (invoice) and not C (credit invoice).
The Invoice type field must equal ’I’ (invoice).	The Order type is not ’E’ (e-commerce).	The system generates an invoice download trigger only if the type of invoice being created is I (invoice) and not C (credit invoice) and the invoice is not associated with order type E (e-commerce).
no criteria defined	no criteria defined	The system generates an invoice download trigger any time an invoice is created.

You can define trigger rules for the Invoice Outbound job at the Outbound Interface Trigger Rules Screen; see Defining Outbound Interface Trigger Rules.

Note: When you create trigger rules, the system does not validate that your entry is a valid value for the field or is within the maximum field positions. Refer to your Field/File Listing to review field attributes for the Invoice Header file and Order Header file.

Invoice Trigger Cleanup

Before processing the invoice download triggers, the Invoice Outbound job looks for duplicate unprocessed invoice download triggers.

Duplicate invoice download triggers exist if more than one trigger has the same:

• File code IHD

• Capture type (A (add) or C (change))

• Key (company + order number + invoice number)

If duplicate invoice download triggers exist, the system removes duplicates, leaving only the most recent invoice download trigger for that capture type.

Example: The following change invoice download triggers exist in the IL Outbound file.

File	Type	Status	Key	Results
IHD	C	R	555000063970001713	The system deletes 2 of these invoice download triggers, leaving only one change trigger to process.
IHD	C	R	555000063970001713
IHD	C	R	555000063970001713

If both an add (Capture type A) and a change (Capture type C) invoice download trigger exists for the same Key, the system generates an Invoice Download XML Message (CWINVOICEOUT) for both triggers.

Invoice Outbound XML Inclusion

For each invoice download trigger, the Invoice Outbound message builder determines which elements to include in the Invoice Download XML Message (CWINVOICEOUT), based on XML inclusion rules.

You can define Invoice Outbound XML inclusion rules at the Outbound Interface XML Inclusion Screen.

XML inclusion defines which elements to include in the Invoice Download XML Message (CWINVOICEOUT).

• If the element is included, that element and its parents are included in the generated invoice download message.

• If the element is excluded, that element and its children are excluded from the generated invoice download message.

This table indicates which elements in the invoice download message are included, based on which elements you flag to include or exclude.

Include element in XML message?	Element
Y = Include InvoiceHeader N = Exclude InvoiceHeader and all of its children, OrderHeader, CustomerSoldTo, CustomerBillTo, InvoicePaymentMethod, and InvoiceShipTo; the system sends a message with only the Message element and its attributes	InvoiceHeader
Y = Include OrderHeader and its parent, InvoiceHeader N = Exclude OrderHeader		OrderHeader
Y = Include CustomerSoldTo and its parent, InvoiceHeader N = Exclude CustomerSoldTo and its children, Originator and Placer		CustomerSoldTo
Y = Include Originator and its parents, CustomerSoldTo and InvoiceHeader N = Exclude Originator			Originator
Y = Include Placer and its parents, CustomerSoldTo and InvoiceHeader N = Exclude Placer			Placer
Y = Include CustomerBillTo and its parent, InvoiceHeader N = Exclude CustomerBillTo		CustomerBillTo
Y = Include InvoicePaymentMethod and its parent, InvoiceHeader N = Exclude InvoicePaymentMethod		InvoicePaymentMethod
Y = Include InvoiceShipTo and its parent, InvoiceHeader N = Exclude InvoiceShipTo and its children, OrderShipTo, CustomerShipTo, and InvoiceDetail		InvoiceShipTo
Y = Include OrderShipTo and its parents, InvoiceShipTo and InvoiceHeader N = Exclude OrderShipTo and its child OrderMessage			OrderShipTo
Y = Include OrderMessage and its parents, OrderShipTo, InvoiceShipTo, and InvoiceHeader. N = Exclude OrderMessage				OrderMessage
Y = Include CustomerShipTo and its parents, InvoiceShipTo and InvoiceHeader N = Exclude CustomerShipTo			CustomerShipTo
Y = Include InvoiceDetail and its parents, InvoiceShipTo and InvoiceHeader N = Exclude InvoiceDetail and its children, OrderDetail, UPC, InvoiceDetailPayMethod, InvoiceDetailCharge, and InvoiceDetailCost			InvoiceDetail
Y = Include OrderDetail and its parents, InvoiceDetail, InvoiceShipTo, and InvoiceHeader N = Exclude OrderDetail and its child, OrderLineMessage				OrderDetail
Y = Include OrderLineMessage and its parents, OrderDetail, InvoiceDetail, InvoiceShipTo, and InvoiceHeader N = Exclude OrderLineMessage					OrderLineMessage
Y = Include UPC and its parents, InvoiceDetail, InvoiceShipTo, and InvoiceHeader N = Exclude UPC				UPC
Y = Include InvoiceDetailPayMethod and its parents, InvoiceDetail, InvoiceShipTo, and InvoiceHeader N = Exclude InvoiceDetailPayMethod				InvoiceDetailPayMethod
Y = Include InvoiceDetailCharge and its parents, InvoiceDetail, InvoiceShipTo, and InvoiceHeader N = Exclude InvoiceDetailCharge				InvoiceDetailCharge
Y = Include InvoiceDetailCost and its parents, InvoiceDetail, InvoiceShipTo, and InvoiceHeader N = Exclude InvoiceDetailCost				InvoiceDetailCost
Y = Include InvoiceBillingAddress and its parents, InvoiceShipTo and InvoiceHeader N = Exclude InvoiceBillingAddress			InvoiceBillingAddress
Y = Include InvoiceShippingAddress and its parents, InvoiceShipTo and InvoiceHeader N = Exclude InvoiceShippingAddress			InvoiceShippingAddress
Y = Include TrackingNumber and its parents, InvoiceShipTo and InvoiceHeader N = Exclude TrackingNumber			TrackingNumber

CWDirect Setup

Before you can generate invoice download messages, you must perform the necessary CWDirect setup and processing.

Information requiring setup includes:

• System Control Values

• Menu Options

• Periodic Function

System Control Values

System Control Value

Description

Create Generic Invoice Download Trigger Records (I17)

Enter Y in this field to create invoice triggers in the IL Outbound Trigger file for certain actions in CWDirect.

Outbound Interface Trigger File Purge Days (I14)

Enter the number of days to retain records in the IL Outbound Trigger file before purging them. Run the PURGIJT periodic function (program name ILR0026) to delete any records if: Last processed date is less than the current system date by the number of purge days and Status is X.

Example: Today is 2/06 and you have set this value to 1. Any record whose Last processed date is 2/05 or earlier is purged.

Menu Options

Menu Option	Description
Generating Outbound Interface Triggers (GOIT)	Enables you to create an IL outbound trigger record for each invoice in your company. Run this process to initially send invoices to the remote system.
Working with Outbound Interface Transactions (WOIT)	Enables you to review, delete, or re-send IL outbound trigger records.
Working with Integration Layer Processes (IJCT)	When active, the Invoice Outbound job creates an Invoice Download XML Message (CWINVOICEOUT) for each unprocessed invoice trigger in the IL Outbound Trigger file. You can also define: • trigger rules; see Invoice Outbound Trigger Rules. • XML inclusion rules; see Invoice Outbound XML Inclusion. • the queues where the invoice download message is sent; see Work with Integration Layer Process Queues Screen.

Periodic Function

Periodic Function	Description
Purge IJCT Download (program name ILR0026)	Run this periodic function to purge processed IL outbound triggers, based on the days defined in the Outbound Interface Trigger File Purge Days (I14) system control value: Last processed date is less than the current system date by the number of purge days and Status is X

Invoice Download XML Message (CWINVOICEOUT)

The invoice download message contains invoice information to send from CWDirect to another system, such as a retail store or financial system.

Message formatting specific to invoice download:

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

• Decimals in numeric fields are included.

• 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.

For more information: See:

• XML Messages for a table that provides links to the DTD, schema, and a sample XML layout for each XML message.

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

• 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. CWDirect indicates the XML message is from CWDirect.
target	alpha		Identifies the target of the XML message. CWIntegrate indicates the XML message is sent to CWIntegrate.
type	alpha		Identifies the type of information in the XML message. CWINVOICEOUT indicates the message contains invoice download information.
date_created	numeric		The date the XML message was generated, in YYYY-MM-DD format.
time_created	numeric		The time the XML message was generated, in HH:MM:SS format.
InvoiceHeader The InvoiceHeader element is included once 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 CWDirect company where the invoice is located. From the Company field in the Invoice Header file.
ihd_order_nbr	numeric	8	The order number associated with the invoice. From the Order # field in the Invoice Header file.
ihd_invoice_nbr	numeric	7	The invoice number assigned to the customer’s bill or credit. From the Invoice # field in the Invoice Header file.
ihd_invoice_type	alpha	1	Indicates the type of invoice. C (Credit memo) = Invoice credit. I (Invoice) = Invoice debit. From the Invoice type field in the Invoice Header file.
ihd_sj_print_date	numeric	7	The date you printed the sales journal that included the invoice in MMDDYYYY format. From the SJ printed date field in the Invoice Header file.
ihd_invoice_print_ date	numeric	7	The date you printed the invoice in MMDDYYYY format. From the Invoice print date field in the Invoice Header file.
ihd_invoice_currency_code	alpha	3	A code for the currency of the invoice. From the CUR currency code field in the Invoice Currency file.
ihd_invoice_currency_desc	alpha	30	A description of the currency. From the CUR currency description field in the Currency file.
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 field in the Invoice Currency file.
OrderHeader The OrderHeader element and its attributes are included once for each invoice download message.
ohd_reference_order_nbr	alpha	30	The CWDirect order number. From the Order # field in the Order Header file.
ohd_order_status	alpha	1	The status of the order. blank = Open. X = Closed. From the OHD order status field in the Order Header file.
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 field in the Order Header file.
ohd_order_date	numeric	7	The date the order was placed in YYYY-MM-DD format. From the OHD order date field in the Order Header file.
ohd_enter_date	numeric	7	The date the order was entered in YYYY-MM-DD format. From the OHD entered date field in the Order Header file.
ohd_enter_time	numeric	6	The time the order was entered in HH:MM:SS format. From the Entered time field in the Order Header file.
ohd_batch_sequence_nbr	numeric	7	The sequence number assigned to the order batch that includes the order. From the OHD batch sequence # field in the Order Header file.
ohd_user_defined_ date	numeric	7	A user defined date in YYYY-MM-DD format. From the OHD user defined date field in the Order Header file.
ohd_billing_batch_ nbr	numeric	9	The billing batch number assigned to the order. From the OHD billing batch # field in the Order Header file.
ohd_order_channel	alpha	2	Indicates if the order is an e-commerce order. I = Internet (e-commerce) order. C = Cross-channel order (retail pickup or delivery order). From the OHD future use sts 1 field in the Order Header file.
ohd_b2b_order	alpha	1	Indicates if the order is a business-to-business order. Y = The order is a business-to-business order. N = The order is not a business-to-business order. From the OHD future use Y/N 1 field in the Order Header file.
ohd_restock_order	alpha	1	Indicates if the order is a restock order. Y = The order is a restock order. N = The order is not a restock order. From the OHD future use Y/N 2 field in the Order Header file.
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? field in the Order Header file.
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 field in the Order Header file.
ohd_membership_ seq_nbr	numeric	3	The sequence number assigned to the membership program on the order. From the CSM sequence # field in the Order Header file.
ohd_order_batch_nbr	numeric	5	The order batch number assigned to the order. From the OBA batch # field in the Order Header file.
ohd_order_type	alpha	1	A code for the type of order, such as telephone or e-commerce. From the OTY order type field in the Order Header file.
ohd_order_type_ description	alpha	30	A description of the type of order. From the OTY description field in the Order Type file.
ohd_salesman_nbr	numeric	7	A number for the salesman associated with the order. From the SLS salesman # field in the Order Header file.
ohd_salesman_name	alpha	30	The name of the salesman associated with the order. From the SLS name field in the Salesman file.
ohd_invoice_ source_code	alpha	9	The source code defined on the order. From the OHD SRC source code field in the Order Header file.
ohd_invoice_ source_description	alpha	30	A description of the source code. From the SRC description field in the Source file.
ohd_invoice_ division_code	alpha	2	The division associated with the source code on the order. From the Div field in the Source file.
ohd_invoice_division_description	alpha	30	A description of the division. From the Description field in the Division file.
ohd_invoice_entity_ nbr	numeric	3	The entity associated with the source code on the order. From the Entity number field in the Division file.
ohd_invoice_entity_ description	alpha	25	A description of the entity. From the ENT description field in the Entity file.
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 field in the Order Header file.
ohd_customer_class_description	alpha	30	A description of the customer class. From the CCL description field in the Customer Class file.
ohd_originator_ unknown	alpha	1	Indicates if the originator of the order is known. Y = The originator of the order is known. N = The originator of the order is not known. From the OHE originator unknown field in the Order Header Extended file.
ohd_order_email_ address	alpha	50	The email address defined on the order. From the OHE order email address field in the Order Header Extended file.
ohd_order_entry_ wrkstn	alpha	10	The workstation where the order was entered. From the OHD Order entry wrkstn field in the Order Header file.
ohd_freight_charge	numeric	7.2	The total charge for shipping the order, not including additional freight charges. From the Freight charge field in the Order Header file.
ohd_freight_override	alpha	1	Indicates if the freight was overridden on the order. You can override freight by entering an amount in the Freight override field on the Work with Order Ship To Properties screen. From the OHD freight override field in the Order Header file.
ohd_freight_balance	numeric	7.2	The unpaid portion of freight on the order. From the Freight balance field in the Order Header file.
ohd_remit_amount	numeric	9.2	The dollar amount on the associated purchase order invoice. From the OHD remit amount field in the Order Header file.
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 field in the Order Header file.
ohd_cbt_account_nbr	numeric	7.0	The account number of the bill to customer on the order. From the CBT account # field in the Order Header file.
ohd_user_hold_ reason	alpha	2	The user hold reason code assigned to the order. From the OHD OHR usr hold reason field in the Order Header file.
ohd_system_hold_ reason	alpha	2	The system hold reason code assigned to the order. From the OHD OHR sys hold reason field in the Order Header file.
ohd_cst_customer_ nbr	numeric	9.0	The number of the sold to customer on the order. From the Cust # field in the Order Header file.
ohd_usr_user	alpha	10	The user ID of the person currently working with the order. From the User field in the Order Header file.
ohd_entered_by_user	alpha	10	The user ID of the person who entered the order. From the OHD entered by USR user field in the Order Header file.
ohd_ecomm_order_ number	alpha	30	The order number, if any, that was passed in the CWCreateOrder message for an order created through the e-commerce interface. From the OHE E-Comm order number field in the Order Header Extended file.
ohd_ecomm_ip_ address	alpha	15	The ip_addr, if any, in the Inbound Order XML Message (CWORDERIN) for an order received through the generic order API, or in the CWCreateOrder message for an order created through the e-commerce interface. From the E-Commerce IP address field in the Order Header Extended file.
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 # field in the Order Header file.
sold_to_prefix	alpha	3	The sold to customer’s prefix. From the NAM prefix field in the Customer Sold To file.
sold_to_fname	alpha	15	The sold to customer’s first name. From the NAM first name field in the Customer Sold To file.
sold_to_initial	alpha	1	The sold to customer’s middle initial. From the NAM initial field in the Customer Sold To file.
sold_to_lname	alpha	25	The sold to customer’s last name. From the NAM last name field in the Customer Sold To file.
sold_to_suffix	alpha	3	The sold to customer’s suffix. From the NAM suffix field in the Customer Sold To file.
sold_to_company	alpha	30	The sold to customer’s company. From the NAM company name field in the Customer Sold To file.
sold_to_apt	alpha	10	The apartment defined on the sold to customer’s address. From the NAM apartment field in the Customer Sold To file.
sold_to_address1	alpha	32	The sold to customer’s street address. From the NAM street address field in the Customer Sold To file.
sold_to_address2	alpha	32	The second address line defined on the sold to customer’s address. From the NAM address line 2 field in the Customer Sold To file.
sold_to_address3	alpha	32	The third address line defined on the sold to customer’s address. From the Address line 3 field in the Customer Sold To Extended file.
sold_to_address4	alpha	32	The fourth address line defined on the sold to customer’s address. From the Address line 4 field in the Customer Sold To Extended file.
sold_to_city	alpha	25	The city defined on the sold to customer’s address. From the NAM city field in the Customer Sold To file.
sold_to_country	alpha	3	The country defined on the sold to customer’s address. From the RPR country field in the Customer Sold To file.
sold_to_country_ name	alpha	30	The name of the country. From the Description field in the Country file.
sold_to_state	alpha	2	The state defined on the sold to customer’s address. From the NAM state field in the Customer Sold To file.
sold_to_state_name	alpha	25	The name of the state. From the Description field in the State file.
sold_to_zip	alpha	10	The postal code defined on the sold to customer’s address. From the NAM zip field in the Customer Sold To file.
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 field in the Customer Sold To file.
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? field in the Customer Sold To file.
sold_to_email_ address	alpha	50	The sold to customer’s primary email address. From the Email field in the Customer Sold To file.
sold_to_day_phone	numeric	7	The sold to customer’s day phone number. From the Phone field in the Customer Sold To Phone # file for CS# Phone # type D.
sold_to_day_ext	alpha	4	The day phone number extension. From the CS# extension field in the Customer Sold To Phone # file.
sold_to_eve_phone	numeric	7	The sold to customer’s evening phone number. From the Phone field in the Customer Sold To Phone # file for CS# Phone # type E.
sold_to_eve_ext	alpha	4	The evening phone number extension. From the CS# extension field in the Customer Sold To Phone # file.
sold_to_fax_phone	numeric	7	The sold to customer’s third (fax or mobile) number. From the Phone field in the Customer Sold To Phone # file for CS# Phone # type F.
sold_to_fax_ext	alpha	4	The third phone number extension. From the CS# extension field in the Customer Sold To Phone # file.
sold_to_job_title	alpha	25	The sold to customer’s job title. From the Job title field in the Customer Sold To file.
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? field in the Customer Sold To file.
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? field in the Customer Sold To file.
sold_to_rent_email	alpha	1	Not currently implemented. From the CST rent e-mail field in the Customer Sold To file.
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 spool file for other correspondence. O3 (No email) = Do not use email for any correspondence; generate a spool file 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 field in the Customer Sold To file.
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 field in the Customer Sold To file.
sold_to_mail_code_ desc	alpha	40	A description of the mail code. From the MCC mail code description field in the Mail/Call Code file.
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 field in the Customer Sold To file.
sold_to_call_code_ desc	alpha	40	A description of the call code. From the MCC mail code description field in the Mail/Call Code file.
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 field in the Customer Sold To file.
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? field in the Customer Sold To file.
sold_to_type	alpha	3	A code that identifies the type of sold to customer, used to group customers. From the CST customer type field in the Customer Sold To file.
sold_to_inactive	alpha	1	Identifies the sold to customer’s status. Y = Customer is inactive. N = Customer is active. From the CST inactive? field in the Customer Sold To file.
sold_to_commercial	alpha	1	Identifies the sold to customer as commercial (business-to-business) or non-commercial. Y = This is a commercial customer. N = This is a non-commercial customer. From the CST commercial? field in the Customer Sold To file.
sold_to_alternate_id	alpha	15	A code used as an additional way to identify the sold to customer. From the Interface cust code field in the Customer Sold To file.
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 field in the Customer Sold To file.
sold_to_currency_ code	alpha	3	A code that identifies the currency used by the sold to customer. From the Currency code field in the Customer Sold To file.
sold_to_currency_ desc	alpha	30	A description of the currency. From the CUR currency description field in the Currency file.
sold_to_language_ code	alpha	3	A code that identifies the language used by the sold to customer. From the Language code field in the Customer Sold To file.
sold_to_language_ desc	alpha	30	A description of the language. From the Description field in the Language file.
sold_to_cust_ company	alpha	3	A code used to group sold to customers under a single parent company. From the CCM customer company field in the Customer Sold To file.
sold_to_cust_ company_name	alpha	30	A description of the company. From the Company name field in the Customer Company file.
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 field in the Customer Warehouse file.
sold_to_warehouse_ name	alpha	30	The name of the warehouse. From the Name field in the Warehouse file.
Originator An invoice download message can contain one Originator element, indicating the individual associated with the sold to customer who authorized or approved the order. If the message contains an Originator, a Placer must also be defined, indicating the individual who placed the order.
originator_nbr	numeric	3	The number assigned to the sold to customer’s individual who authorized or approved the order. From the CIF customer individual # field in the Customer Individual file.
originator_prefix	alpha	3	The originator’s prefix. From the CIF name prefix field in the Customer Individual file.
originator_fname	alpha	15	The originator’s first name. From the CIF first name field in the Customer Individual file.
originator_initial	alpha	1	The originator’s middle initial. From the CIF middle initial field in the Customer Individual file.
originator_lname	alpha	25	The originator’s last name. From the CIF last name field in the Customer Individual file.
originator_suffix	alpha	3	The originator’s suffix. From the CIF name suffix field in the Customer Individual file.
originator_day_ phone	alpha	14	The originator’s day phone number. From the CIF day phone number field in the Customer Individual file.
originator_day_ext	alpha	4	The day phone number extension. From the CIF day extension field in the Customer Individual file.
originator_eve_ phone	alpha	14	The originator’s evening phone number. From the CIF eve phone number field in the Customer Individual file.
originator_eve_ext	alpha	4	The evening phone number extension. From the CIF eve extension field in the Customer Individual file.
originator_fax_phone	alpha	14	The originator’s third (fax or mobile) number. From the CIF fax phone # field in the Customer Individual file.
originator_fax_ext	alpha	4	The third phone number extension. From the CIF fax extension field in the Customer Individual file.
originator_mail_stop	alpha	32	The originator’s delivery address within the organization. From the CIF mail stop field in the Customer Individual file.
originator_email_ address	alpha	50	The originator’s email address. From the CIF email address field in the Customer Individual file.
originator_mail_ name	alpha	1	Indicates whether the originator receives future catalogs. Y = Mail catalogs to the customer. N = Do not mail catalogs to the customer. From the CIF mail flag field in the Customer Individual file.
originator_rent_name	alpha	1	Indicates whether to include the originator’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 CIF rent flag field in the Customer Individual file.
originator_create_ date	numeric	7	The date the individual was created in YYYY-MM-DD format. From the CIF create date field in the Customer Individual file.
originator_cust_ status	alpha	1	Identifies the originator’s status. I = Customer is inactive. A = Customer is active. From the CIF customer status field in the Customer Individual file.
originator_date_of_ birth	alpha	6	The originator’s birth date in MMDDYY format. From the CIF date of birth field in the Customer Individual file.
originator_user_field1	alpha	10	A user field defined for the originator. From the CIF user field 1 field in the Customer Individual file.
originator_user_field2	alpha	10	A user field defined for the originator. From the CIF user field 2 field in the Customer Individual file.
originator_user_field3	alpha	10	A user field defined for the originator. From the CIF user field 3 field in the Customer Individual file.
originator_user_field4	alpha	10	A user field defined for the originator. From the CIF user field 4 field in the Customer Individual file.
originator_email_ status	alpha	2	Indicates the preferred method of correspondence for the originator’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 spool file for other correspondence. O3 (No email) = Do not use email for any correspondence; generate a spool file 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 CIF opt in/opt out field in the Customer Individual file.
originator_created_ by	alpha	10	The user ID of the person who created the individual’s customer record. From the CIF create user field in the Customer Individual file.
originator_last_ changed_by	alpha	10	The user ID of the person who last changed the individual’s customer record. From the CIF last change user field in the Customer Individual file.
originator_mail_code	alpha	3	A code used to define when and under what conditions you send mail to the originator. From the CIF mail code field in the Customer Individual file.
originator_mail_code_desc	alpha	40	A description of the mail code. From the MCC mail code description field in the Mail/Call Code file.
originator_call_code	alpha	3	A code used to define when and under what conditions you call the originator. From the CIF call code field in the Customer Individual file.
originator_call_code_desc	alpha	40	A description of the call code. From the MCC mail code description field in the Mail/Call Code file.
originator_dept	alpha	3	A code for the originator’s department within the organization. From the CIF department field in the Customer Individual file.
originator_dept_desc	alpha	30	A description of the department. From the IDD description field in the Individual Department file.
originator_position	alpha	3	A code for the originator’s position within the organization. From the CIF position field in the Customer Individual file.
originator_position_ desc	alpha	30	A description of the position. From the IDP description field in the Individual Position file.
Placer An invoice download message can contain one Placer element, indicating the individual associated with the sold to customer who placed the order. If the message contains a Placer, an Originator must also be defined, indicating the individual who authorized or approved the order.
placer_nbr	numeric	3	The number assigned to the sold to customer’s individual who placed the order. From the CIF customer individual # field in the Customer Individual file.
placer_prefix	alpha	3	The placer’s prefix. From the CIF name prefix field in the Customer Individual file.
placer_fname	alpha	15	The placer’s first name. From the CIF first name field in the Customer Individual file.
placer_initial	alpha	1	The placer’s middle initial. From the CIF middle initial field in the Customer Individual file.
placer_lname	alpha	25	The placer’s last name. From the CIF last name field in the Customer Individual file.
placer_suffix	alpha	3	The placer’s suffix. From the CIF name suffix field in the Customer Individual file.
placer_day_phone	alpha	14	The placer’s day phone number. From the CIF day phone number field in the Customer Individual file.
placer_day_ext	alpha	4	The day phone number extension. From the CIF day extension field in the Customer Individual file.
placer_eve_phone	alpha	14	The placer’s evening phone number. From the CIF eve phone number field in the Customer Individual file.
placer_eve_ext	alpha	4	The evening phone number extension. From the CIF eve extension field in the Customer Individual file.
placer_fax_phone	alpha	14	The placer’s third (fax or mobile) number. From the CIF fax phone # field in the Customer Individual file.
placer_fax_ext	alpha	4	The third phone extension. From the CIF fax extension field in the Customer Individual file.
placer_mail_stop	alpha	32	The placer’s delivery address within the organization. From the CIF mail stop field in the Customer Individual file.
placer_email_address	alpha	50	The placer’s email address. From the CIF email address field in the Customer Individual file.
placer_mail_name	alpha	1	Indicates whether the placer receives future catalogs. Y = Mail catalogs to the customer. N = Do not mail catalogs to the customer. From the CIF mail flag field in the Customer Individual file.
placer_rent_name	alpha	1	Indicates whether to include the placer’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 CIF rent flag field in the Customer Individual file.
placer_create_date	numeric	7	The date the individual was created in MMDDYYYY format. From the CIF create date field in the Customer Individual file.
placer_cust_status	alpha	1	Identifies the placer’s status. I = Customer is inactive. A = Customer is active. From the CIF customer status field in the Customer Individual file.
placer_date_of_birth	alpha	6	The placer’s birth date in MMDDYY format. From the CIF date of birth field in the Customer Individual file.
placer_user_field1	alpha	10	A user field defined for the placer. From the CIF user field 1 field in the Customer Individual file.
placer_user_field2	alpha	10	A user field defined for the placer. From the CIF user field 1 field in the Customer Individual file.
placer_user_field3	alpha	10	A user field defined for the placer. From the CIF user field 1 field in the Customer Individual file.
placer_user_field4	alpha	10	A user field defined for the placer. From the CIF user field 1 field in the Customer Individual file.
placer_email_status	alpha	2	Indicates the preferred method of correspondence for the placer’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 spool file for other correspondence. O3 (No email) = Do not use email for any correspondence; generate a spool file 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 CIF opt in/opt out field in the Customer Individual file.
placer_created_by	alpha	10	The user ID of the person who created the individual’s customer record. From the CIF create user field in the Customer Individual file.
placer_last_changed_by	alpha	10	The user ID of the person who last changed the individual’s customer record. From the CIF last change user field in the Customer Individual file.
placer_mail_code	alpha	3	A code used to define when and under what conditions you send mail to the placer. From the CIF mail code field in the Customer Individual file.
placer_mail_code_ desc	alpha	40	A description of the mail code. From the MCC mail code description field in the Mail/Call Code file.
placer_call_code	alpha	3	A code used to define when and under what conditions you call the placer. From the CIF call code field in the Customer Individual file.
placer_call_code_ desc	alpha	40	A description of the call code. From the MCC mail code description field in the Mail/Call Code file.
placer_dept	alpha	3	A code for the placer’s department within the organization. From the CIF department field in the Customer Individual file.
placer_dept_desc	alpha	30	A description of the department. From the IDD description field in the Individual Department file.
placer_position	alpha	3	A code for the placer’s position within the organization. From the CIF position field in the Customer Individual file.
placer_position_desc	alpha	30	A description of the position. From the IDP description field in the Individual Position file.
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 # field in the Customer Bill To file.
bill_to_prefix	alpha	3	The bill to customer’s prefix. From the Prefix field in the Customer Bill To file.
bill_to_fname	alpha	15	The bill to customer’s first name. From the First name field in the Customer Bill To file.
bill_to_initial	alpha	1	The bill to customer’s middle initial. From the Initial field in the Customer Bill To file.
bill_to_lname	alpha	25	The bill to customer’s last name. From the Last name field in the Customer Bill To file.
bill_to_suffix	alpha	3	The bill to customer’s suffix. From the Suffix field in the Customer Bill To file.
bill_to_company	alpha	30	The bill to customer’s company. From the Company name field in the Customer Bill To file.
bill_to_apt	alpha	10	The apartment number defined for the bill to customer’s address. From the Apartment field in the Customer Bill To file.
bill_to_address1	alpha	32	The bill to customer’s street address. From the Street address field in the Customer Bill To file.
bill_to_address2	alpha	32	The second address line defined on the bill to customer’s address. From the Address line 2 field in the Customer Bill To file.
bill_to_address3	alpha	32	The third address line defined on the bill to customer’s address. From the Address line 3 field in the Customer Bill To Extended file.
bill_to_address4	alpha	32	The fourth address line defined on the bill to customer’s address. From the Address line 4 field in the Customer Bill To Extended file.
bill_to_city	alpha	25	The city defined on the bill to customer’s address. From the City field in the Customer Bill To Extended file.
bill_to_country	alpha	3	The country defined on the bill to customer’s address. From the RPR country field in the Customer Bill To file.
bill_to_country_ name	alpha	30	The name of the country. From the Description field in the Country file.
bill_to_state	alpha	2	The state defined on the bill to customer’s address. From the State field in the Customer Bill To file.
bill_to_state_name	alpha	25	The name of the state. From the Description field in the State file.
bill_to_zip	alpha	10	The postal code defined on the bill to customer’s address. From the Zip field in the Customer Bill To file.
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 field in the Customer Bill To file.
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? field in the Customer Bill To file.
bill_to_email_ address	alpha	50	The bill to customer’s email address. From the CBT email address field in the Customer Bill To file.
bill_to_day_phone	numeric	7	The bill to customer’s day phone number. From the Phone field in the Customer Bill To Phone # file for CB# Phone # type D.
bill_to_day_ext	alpha	4	The day phone number extension. From the CB# extension field in the Customer Bill To Phone # file.
bill_to_eve_phone	numeric	7	The bill to customer’s evening phone number. From the Phone field in the Customer Bill To Phone # file for CB# Phone # type E.
bill_to_eve_ext	alpha	4	The evening phone number extension. From the CB# extension field in the Customer Bill To Phone # file.
bill_to_fax_phone	numeric	7	The bill to customer’s third (fax or mobile) number. From the Phone field in the Customer Bill To Phone # file for CB# Phone # type F.
bill_to_fax_ext	alpha	4	The third number extension. From the CB# extension field in the Customer Bill To Phone # file.
bill_to_print_ statement	alpha	1	Indicates whether the system prints a statement on open balances, and open and paid receipts for the bill to customer. Y = Print an accounting statement. N = Do not print an accounting statement. From the CBT print statement? field in the Customer Bill To file.
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 spool file for other correspondence. O3 (No email) = Do not use email for any correspondence; generate a spool file 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 field in the Customer Bill To file.
bill_to_currency_ code	alpha	3	A code for the currency used by the bill to customer. From the Currency code field in the Customer Bill To file.
bill_to_currency_ desc	alpha	30	A description of the currency. From the CUR currency description field in the Currency file.
bill_to_language_ code	alpha	3	A code for the language used by the bill to customer. From the Language code field in the Customer Bill To file.
bill_to_language_ desc	alpha	30	A description of the language. From the Description field in the Language file.
bill_to_terms_code	numeric	2	A code for the payment terms for the bill to customer’s account. From the APT code field in the Customer Bill To file.
bill_to_terms_desc	alpha	30	A description of the payment terms. From the Description field in the Terms file.
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 # field in the Invoice Payment Method file.
ipm_pay_type	numeric	2	A code that represents the method of payment associated with the invoice. From the PAY Pay type field in the Order Payment Method file.
ipm_pay_type_desc	alpha	30	A description of the pay type associated with the invoice. From the PAY description field in the Pay Type file.
ipm_pay_category	alpha	1	The category of the pay type. 1 = Cash/Check 2 = Credit Card 3 = A/R 4 = COD 5 = Coupon/Credit From the Pay category field in the Invoice Payment Method file.
ipm_merchandise_ amt	numeric	9.2	The merchandise amount assigned to the invoice payment method. From the IPM merch field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
ipm_freight_amt	numeric	7.2	The freight charge amount assigned to the invoice payment method. From the Freight field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
ipm_addl_freight_ amt	numeric	7.2	The additional freight amount assigned to the invoice payment method. From the Add’l frt field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
ipm_addl_charge_ amt	numeric	7.2	The additional charge amount assigned to the invoice payment method. From the Add’l chg field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
ipm_hand_charge_ amt	numeric	7.2	The handling charge amount assigned to the invoice payment method. From the Handling field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
ipm_tax_amt	numeric	10.5	The tax amount assigned to the invoice payment method. From the IPM tax field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
ipm_gst_amt	numeric	10.5	The GST amount assigned to the invoice payment method. From the IPM GST field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
ipm_pst_amt	numeric	10.5	The PST amount assigned to the invoice payment method. From the IPM PST field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
ipm_ord_lvl_frt_amt	numeric	7.2	The freight charges that apply to the total order. From the IPM order lvl frt field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
ipm_deposit_ created_date	numeric	7.0	The date the deposit was created. From the IPM deposit created date field in the Invoice Payment Method file.
ipm_auth_number	alpha	10	The number used to authorize the credit card payment associated with the invoice. From the IPM auth # field in the Invoice Payment Method file.
ipm_auth_date	numeric	7.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 field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
ipm_invoice_date	numeric	7.0	The date the invoice was created, in YYYY-MM-DD format. From the IPM invoice date field in the Invoice Payment Method file.
ipm_nbr_of_ installments	numeric	3	The total number of installments assigned to the invoice payment method. Installment billing enables 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 field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
ipm_deposit_ release_date	numeric	7.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 field in the Invoice Payment Method file.
ipm_credit_card_ nbr	alpha	20	The credit card number the customer used on the order. If you use credit card tokenization, this number may be a token rather than the actual credit card number. For a Bill Me Later payment method, the credit card number represents the customer’s Bill Me Later account number. If you use credit card encryption, the system decrypts the credit card number before sending it to an external system. From the IPM credit card # field in the Invoice Payment Method file.
ipm_cc_expiration_ date	numeric	4.0	The date the credit card expires. From the IPM CC expiration date field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
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 field in the Invoice Payment Method file.
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 # field in the Invoice Ship To file.
ins_invoice_date	numeric	7	The date the invoice was created, in YYYY-MM-DD format. From the Invoice date field in the Invoice Ship To file.
ins_merchandise_ amt	numeric	9.2	The merchandise amount assigned to the invoice for the ship to customer. From the Merchandise field in the Invoice Ship To file.
ins_freight_amt	numeric	7.2	The freight charge amount assigned to the invoice for the ship to customer. From the Freight field in the Invoice Ship To file.
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 field in the Invoice Ship To file.
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 field in the Invoice Ship To file.
ins_hand_charge_ amt	numeric	7.2	The handling charge amount assigned to the invoice for the ship to customer. From the Handling field in the Invoice Ship To file.
ins_tax_amt	numeric	7.2	The tax amount assigned to the invoice for the ship to customer. From the Tax field in the Invoice Ship To file.
ins_gst_amt	numeric	7.2	The GST amount assigned to the invoice for the ship to customer. From the GST field in the Invoice Ship To file.
ins_pst_amt	numeric	7.2	The PST amount assigned to the invoice for the ship to customer. From the PST field in the Invoice Ship To file.
ins_cost_amt	numeric	9.2	The actual cost of the merchandise billed on the invoice for the ship to customer. From the Cost field in the Invoice Ship To file.
ins_hidden_frt_amt	numeric	7.2	The hidden freight amount assigned to the invoice for the ship to customer. From the Hidden freight field in the Invoice Ship To file.
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 field in the Invoice Ship To file.
ins_ocr_b_number	alpha	30	The PkMS pick control number associated with the invoice for the ship to customer. From the OCR B number field in the Invoice Ship To file. Set to the next available number in the PkMS Pick # (A42) number assignment value.
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_ship_via_code	numeric	2	A code indicating the shipper used to deliver the merchandise to the ship to customer. From the Ship via field in the Order Ship To file.
ost_ship_via_ description	alpha	30	A description of the shipper. From the VIA shipper name field in the Ship Via file.
ost_status	alpha	1	The status of the ship to order. blank = Open. A = Archived. C = Cancelled. H = Held. S = Suspended. X = Closed. From the OST order status field in the Order Ship To file.
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 field in the Order Ship To file.
ost_contact_name	alpha	30	The name of the person who should receive the order at the shipping destination. From the OST contact name field in the Order Ship To file.
ost_fedex_nbr	alpha	10	The number of the customer’s account with Federal Express. From the OST federal express # field in the Order Ship To file.
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 field in the Order Ship To file.
ost_resale_ exempt_nbr	alpha	15	A number that identifies the customer as exempt from taxes on purchases. From the OST resale/exempt # field in the Order Ship To file.
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 field in the Order Ship To file.
ost_line_of_ business_desc	alpha	40	A description of the line of business. From the LOB description field in the Line Of Business file.
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 field in the Order Ship To file.
ost_geographic_ zone_desc	alpha	30	A description of the geographic zone. From the GZF description field in the Geographic Zone file.
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; not included for express billed orders. From the OST # of shipments field in the Order Ship To file.
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 field in the Order Ship To file.
ost_additional_ charge	numeric	7.2	The total additional charges for the order ship to. From the OST add’l charges field in the Order Ship To file.
ost_additional_ charge_balance	numeric	7.2	The unpaid portion of additional charges. From the OST add’l chg balance field in the Order Ship To file.
ost_arrival_date	numeric	7.0	The date the customer expects to receive the order. From the OST arrival date field in the Order Ship To file.
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 field in the Order Ship To file.
ost_cancel_date	numeric	7.0	The date the customer wants the order cancelled if it has not been shipped. From the OST cancel date field in the Order Ship To file.
ost_estimated_freight	numeric	7.2	The estimated charge for shipping the order. From the OST estimated freight field in the Order Ship To file.
ost_freight	numeric	7.2	The actual charge for shipping the order. From the OST freight field in the Order Ship To file.
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 field in the Order Ship To file.
ost_freight_balance	numeric	7.2	The unpaid portion of the freight. From the OST freight balance field in the Order Ship To file.
ost_handling	numeric	7.2	The cost of any special handling on the order, including any duty charge. From the OST handling field in the Order Ship To file.
ost_handling_balance	numeric	7.2	The unpaid portion of the handling charge and/or duty charge. From the OST handling balance field in the Order Ship To file.
ost_last_pick_ print_date	numeric	7.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 field in the Order Ship To file.
ost_last_ reservation_date	numeric	7.0	The most recent reservation date for the order ship to, in YYYY-MM-DD format. From the OST last reservation date field in the Order Ship To file.
ost_merchandise	numeric	9.2	The total dollar value of merchandise for the order ship to. From the OST merch field in the Order Ship To file.
ost_merchandise_ balance	numeric	9.2	The unpaid portion of the merchandise total. From the OST merch balance field in the Order Ship To file.
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 field in the Order Ship To file.
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 field in the Order Ship To file.
ost_tax_balance	numeric	7.2	The unpaid portion of the taxes. From the OST tax balance field in the Order Ship To file.
ost_gst	numeric	7.2	The Canadian Federal Goods and Services tax that applies to the order ship to. From the OST GST field in the Order Ship To file.
ost_gst_balance	numeric	7.2	The unpaid portion of the Canadian Federal Goods and Services tax. From the OST GST balance field in the Order Ship To file.
ost_pst	numeric	7.2	The Canadian Provincial Services tax that applies to the order ship to. From the OST PST field in the Order Ship To file.
ost_pst_balance	numeric	7.2	The unpaid portion of the Canadian Provincial Services tax. From the OST PST balance field in the Order Ship To file.
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 field in the Order Ship To file.
ost_purchase_ order_nbr	alpha	15	The purchase order number under which the order was placed. From the Purchase order # field in the Order Ship To file.
ost_number_of_ lines	numeric	3	The number of order lines for the order ship to. From the # of lines field in the Order Ship To file.
ost_additional_ freight	numeric	7.2	The total dollar amount for freight charges exceeding the base freight charge. From the Add’l freight field in the Order Ship To file.
ost_additional_ freight_balance	numeric	7.2	The unpaid portion of additional freight charges. From the Add’l frt bal field in the Order Ship To file.
ost_discount_pct	numeric	5.2	A flat discount percentage applied to discountable merchandise only for the order ship to. From the Disc % field in the Order Ship To file.
ost_calculate_freight	alpha	1	Indicates whether the system calculates and adds freight charges, service charges by ship via, and C.O.D. charges to the order ship to. Y = The system calculates freight based on the freight method defined for the source code. N = The system does not calculate freight. From the Calculate freight field in the Order Ship To file.
ost_order_ combination_type	alpha	10	The long SKU class code assigned to the items on the order. The system updates this field if the Order Combination Pick Selection Type (G47) system control value is set to L/S CLASS. If the order includes items assigned to different long SKU classes, this field is 9999. From the OST future use code 1 field in the Order Ship To file.
ost_cst_customer_ nbr	numeric	9.0	The sold to customer number associated with the order ship to. From the OST CST customer # field in the Order Ship To file.
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 # field in the Order Ship To file.
ost_ohr_hold_ reason	alpha	2	The order hold reason code assigned to the order ship to. From the OST OHR hold reason field in the Order Ship To file.
ost_whs_warehouse	numeric	3.0	A code for the warehouse from where the merchandise on the order will ship. From the Whs field in the Order Ship To file.
ost_warehouse_ name	alpha	30	The name of the warehouse. From the Name field in the Warehouse file.
ost_broker_delivery_ type	alpha	1	Set to R if this is a retail pickup order, and set to D if this is a delivery order. Included only for retail pickup or delivery orders fulfilled through the integration with the Order Broker module in Locate 5.1 or higher. See Fulfilling Retail Pickup and Delivery Orders in CWDirect for more information. Available in XML version: 4.0 in release 18.0 of CWDirect.
OrderMessage The OrderMessage element and its attributes repeat for each order message defined on the order header.
order_msg_seq_ nbr	numeric	3	The sequence number assigned to the order line message. From the OMS seq # field in the Order Message file.
order_message_text	alpha	60	The order line message. From the OMS message field in the Order Message file.
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? field in the Order Message file.
order_message_ date	numeric	7	The date the message was entered, in YYYY-MM-DD format. From the OMS date field in the Order Message file.
order_message_ user	alpha	10	The user ID of the person who entered the message. From the User field in the Order Message file.
CustomerShipTo The CustomerShipTo element and its attributes are included 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 file. 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 file. 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 file. 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 # field in the Order Ship To file.
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 field is the associated sold to customer number. From the CSH ship to # field in the Customer Ship To file.
ship_to_prefix	alpha	3	The ship to customer’s prefix. From the: • Permanent ship to: NAM prefix field in the Customer Ship To file. • Recipient sold to customer: NAM prefix field in the Customer Sold To file.
ship_to_fname	alpha	15	The ship to customer’s first name. From the: • Permanent ship to: NAM first name field in the Customer Ship To file. • Recipient sold to: NAM first name field in the Customer Sold To file.
ship_to_initial	alpha	1	The ship to customer’s middle initial. From the: • Permanent ship to: NAM initial field in the Customer Ship To file. • Recipient sold to: NAM initial field in the Customer Sold To file.
ship_to_lname	alpha	25	The ship to customer’s last name. From the: • Permanent ship to: NAM last name field in the Customer Ship To file. • Recipient sold to: NAM last name field in the Customer Sold To file.
ship_to_suffix	alpha	3	The ship to customer’s suffix. From the: • Permanent ship to: NAM suffix field in the Customer Ship To file. • Recipient sold to: NAM suffix field in the Customer Sold To file.
ship_to_company	alpha	30	The ship to customer’s company. From the: • Permanent ship to: NAM company name field in the Customer Ship To file. • Recipient sold to: NAM company name field in the Customer Sold To file.
ship_to_apt	alpha	10	The ship to customer’s apartment. From the: • Permanent ship to: NAM apartment field in the Customer Ship To file. • Recipient sold to: NAM apartment field in the Customer Sold To file.
ship_to_address1	alpha	32	The ship to customer’s street address. From the: • Permanent ship to: NAM street address field in the Customer Ship To file. • Recipient sold to: NAM street address field in the Customer Sold To file.
ship_to_address2	alpha	32	The second address line defined on the ship to customer’s address. From the: • Permanent ship to: NAM address line 2 field in the Customer Ship To file. • Recipient sold to: NAM address line 2 field in the Customer Sold To file.
ship_to_address3	alpha	32	The third address line defined on the ship to customer’s address. From the: • Permanent ship to: Address line 3 field in the Customer Ship To Extended file. • Recipient sold to: Address line 3 field in the Customer Sold To Extended file.
ship_to_address4	alpha	32	The fourth address line defined on the ship to customer’s address. From the: • Permanent ship to: Address line 4 field in the Customer Ship To Extended file. • Recipient sold to: Address line 4 field in the Customer Sold To Extended file.
ship_to_city	alpha	25	The city defined on the ship to customer’s address. From the: • Permanent ship to: NAM city field in the Customer Ship To file. • Recipient sold to: NAM city field in the Customer Sold To file.
ship_to_country	alpha	3	The country defined on the ship to customer’s address. From the: • Permanent ship to: RPR country field in the Customer Ship To file. • Recipient sold to: RPR country field in the Customer Sold To file.
ship_to_country_ name	alpha	30	The name of the country. From the Description field in the Country file.
ship_to_state	alpha	2	The state defined on the ship to customer’s address. From the: • Permanent ship to: NAM state field in the Customer Ship To file. • Recipient sold to: NAM state field in the Customer Sold To file.
ship_to_state_name	alpha	25	The name of the state. From the Description field in the State file.
ship_to_zip	alpha	10	The postal code defined on the ship to customer’s address. From the: • Permanent ship to: NAM zip field in the Customer Ship To file. • Recipient sold to: NAM zip field in the Customer Sold To file.
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 field in the Customer Ship To file. • Recipient sold to: NAM delivery code field in the Customer Sold To file.
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? field in the Customer Ship To file. • Recipient sold to: NAM PO box? field in the Customer Sold To file.
ship_to_email_ address	alpha	50	The ship to customer’s email address. From the: • Permanent ship to: Email address field in the Customer Ship To file. • Recipient sold to: Email address field in the Customer Sold To file.
ship_to_day_phone	alpha	14	The ship to customer’s day phone number. From the: • Permanent ship to: Phone field in the Customer Ship To Phone # file for phone type D. • Recipient sold to: Email address field in the Customer Sold to Phone # file for phone type D.
ship_to_day_ext	alpha	4	The day phone number extension. From the: • Permanent ship to: CT# extension field in the Customer Ship To Phone # file. • Recipient sold to: CT# extension field in the Customer Sold to Phone # file.
ship_to_eve_phone	alpha	14	The ship to customer’s evening phone number. From the: • Permanent ship to: Phone field in the Customer Ship To Phone # file for phone type E. • Recipient sold to: Phone field in the Customer Sold to Phone # file for phone type E.
ship_to_eve_ext	alpha	4	The evening phone number extension. From the: • Permanent ship to: CT# extension field in the Customer Ship To Phone # file. • Recipient sold to: CT# extension field in the Customer Sold to Phone # file.
ship_to_fax_phone	alpha	14	The ship to customer’s third (fax or mobile) phone number. From the: • Permanent ship to: Phone field in the Customer Ship To Phone # file for phone type F. • Recipient sold to: Phone field in the Customer Sold to Phone # file for phone type F.
ship_to_fax_ext	alpha	4	The third phone number extension. From the: • Permanent ship to: CT# extension field in the Customer Ship To Phone # file. • Recipient sold to: CT# extension field in the Customer Sold to Phone # file.
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? field in the Customer Ship To file. • Recipient sold to: Rent name? field in the Customer Sold To file.
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 field in the Customer Ship To file. • Recipient sold to: Mail code field in the Customer Sold To file.
ship_to_mail_ code_desc	alpha	40	A description of the mail code. From the MCC mail code description field in the Mail/Call Code file.
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 field in the Customer Ship To file. • Recipient sold to: Call code field in the Customer Sold To file.
ship_to_call_ code_desc	alpha	40	A description of the call code. From the MCC mail code description field in the Mail/Call Code file.
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 field in the Customer Ship To file. • Recipient sold to: Language code field in the Customer Sold To file.
ship_to_language_ desc	alpha	30	A description of the language. From the Description field in the Language file.
ship_to_match_code	alpha	15	A code made up of selected characters from the permanent ship-to customer’s name and address, used to eliminate duplicate customer records. From the Match code field in the Customer Ship To file. Available in XML version: 3.0 in CWDirect 10.5 or later.
ship_to_record_ extended	alpha	1	Indicates if there is an associated record in the Customer Ship To Extended file. The information in the Customer Ship To Extended file consists of additional address lines (lines 3 and 4). Valid values are: Y = There is a Customer Ship To Extended record for the ship-to customer. N = There is not a Customer Ship To Extended record for the ship-to customer. Available in XML version: 3.0 in CWDirect 10.5 or later.
ship_to_postal_code_scan	alpha	10	The first few (typically 5) positions of the ship-to customer’s postal code, used for scanning purposes. See Postal Code Scan Length (F61) for a discussion. From the Postal Code Scan field in the Customer Ship To file. Available in XML version: 3.0 in CWDirect 10.5 or later.
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 field in the Customer Sold To file.
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? field in the Customer Sold To file.
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 spool file for other correspondence. O3 (No email) = Do not use email for any correspondence; generate a spool file 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 field in the Customer Sold To file.
ship_to_rent_email	alpha	1	Not currently implemented. From the CST rent e-mail field in the Customer Sold To file.
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 field in the Customer Sold To file.
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? field in the Customer Sold To file.
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 field in the Customer Sold To file.
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? field in the Customer Sold To file.
ship_to_commercial	alpha	1	Identifies the sold to customer as commercial (business-to-business) 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? field in the Customer Sold To file.
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 field in the Customer Sold To file.
ship_to_cross_ref_ nbr	pack	9.0	A code that represents the customer on another system. From the CST customer nbr xref field in the Customer Sold To file.
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 field in the Customer Sold To file.
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 field in the Currency file.
ship_to_cust_ company	alpha	3	A code used to group sold to customers under a single parent company. Not included for an order ship to address or permanent ship to address. Recipient sold to: From the CCM customer company field in the Customer Sold To file.
ship_to_cust_ company_name	alpha	30	A description of the company. Not included for an order ship to address or permanent ship to address. From the Company name field in the Customer Company file.
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 field in the Customer Warehouse file.
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 field in the Warehouse file.
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 file.
order_ship_to_ prefix	alpha	3	The order ship to customer’s prefix. From the NAM prefix field in the Order Ship To Address file.
order_ship_to_ fname	alpha	15	The order ship to customer’s first name. From the NAM first name field in the Order Ship To Address file.
order_ship_to_ initial	alpha	1	The order ship to customer’s middle initial. From the NAM initial field in the Order Ship To Address file.
order_ship_to_ lname	alpha	25	The order ship to customer’s last name. From the NAM last name field in the Order Ship To Address file.
order_ship_to_ suffix	alpha	3	The order ship to customer’s suffix. From the NAM suffix field in the Order Ship To Address file.
order_ship_to_ company	alpha	30	The order ship to customer’s company. From the NAM company name field in the Order Ship To Address file.
order_ship_to_apt	alpha	10	The order ship to customer’s apartment. From the NAM apartment field in the Order Ship To Address file.
order_ship_to_ address1	alpha	32	The order ship to customer’s street address. From the NAM street address field in the Order Ship To Address file.
order_ship_to_ address2	alpha	32	The order ship to customer’s second address line. From the NAM address line 2 field in the Order Ship To Address file.
order_ship_to_ address3	alpha	32	The order ship to customer’s third address line. From the NAM address line 3 field in the Order Ship To Address file.
order_ship_to_ address4	alpha	32	The order ship to customer’s fourth address line. From the NAM address line 4 field in the Order Ship To Address file.
order_ship_to_city	alpha	25	The city for the order ship to customer’s address. From the NAM city field in the Order Ship To Address file.
order_ship_to_ country	alpha	3	The country for the order ship to customer’s address. From the RPR country field in the Order Ship To Address file.
order_ship_to_ country_name	alpha	30	The name of the country. From the Description field in the Country file.
order_ship_to_state	alpha	2	The state for the order ship to customer’s address. From the NAM state field in the Order Ship To Address file.
order_ship_to_ state_name	alpha	25	The name of the state. From the Description field in the State file.
order_ship_to_zip	alpha	10	The postal code for the order ship to customer’s address. From the NAM zip field in the Order Ship To Address file.
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 field in the Order Ship To Address file.
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 field in the Order Ship To Address file.
order_ship_to_ email_address	alpha	50	The order ship to customer’s email address. From the Email address field in the Order Ship To Address file.
InvoiceBillingAddress This element is included only if a record exists in the Invoice Address file. The system saves the billing address in this file when it bills a shipment only if the Capture Addresses for Invoice (J24) system control value was set to Y. 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. Available in XML version: 2.0 (version 9.5 of CWDirect).
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_deliver_code	alpha	1	Available in XML version: 3.0 in release 10.5 of CWDirect.
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 file.The system saves the shipping address in this file when it bills a shipment only if the Capture Addresses for Invoice (J24) system control value was set to Y. For more information: See the Display Invoice Address Screen (Shipping Address) for more information on the invoice shipping address. Available in XML version: 2.0 (version 9.5 of CWDirect).
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 # field in the Invoice Detail file.
idt_line_nbr	numeric	3	The invoice detail line number. From the IDT line # field in the Invoice Detail file.
idt_control_nbr	numeric	7	The pick control number assigned to the invoice detail line. From the Control # field in the Invoice Detail file.
idt_ship_date	numeric	7	The date the item on the invoice line was shipped in YYYY-MM-DD format. From the IDT date shipped field in the Invoice Detail file.
idt_return_date	numeric	7	The most recent date that the customer returned any quantity of the item against the invoice line in MMDDYYYY format. From the IDT date returned field in the Invoice Detail file.
idt_shipped_qty	numeric	5	The shipped quantity for the item on the invoice line. From the IDT qty shipped field in the Invoice Detail file.
idt_return_qty	numeric	5	The quantity of the item on the invoice line that the customer returned. From the IDT qty returned field in the Invoice Detail file.
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 field in the Invoice Detail file.
idt_actual_price	numeric	7.2	The actual unit price of the shipped item. From the IDT price field in the Invoice Detail file.
idt_discount_amt	numeric	9.2	The total extended discount amount applied to the item on the invoice line. From the Discount amount field in the Invoice Detail file.
idt_freight_amt	numeric	7.2	The freight amount applied to the item on the invoice line. From the IDT freight field in the Invoice Detail file.
idt_tax_amt	numeric	10.5	The tax amount applied to the item on the invoice line. From the IDT tax field in the Invoice Detail file.
idt_gst_amt	numeric	10.5	The GST amount applied to the item on the invoice line. From the IDT GST field in the Invoice Detail file.
idt_pst_amt	numeric	10.5	The PST amount applied to the item on the invoice line. From the IDT PST field in the Invoice Detail file.
idt_handling_amt	numeric	7.2	The handling charge amount applied to the item on the invoice line. From the IDT handling field in the Invoice Detail file.
idt_cost_amt	numeric	11.4	The cost of the item. From the Cost field in the Invoice Detail file.
OrderDetail
odt_ordered_qty	numeric	5.0	The number of units ordered on the order line. From the ODT qty ordered field in the Order Detail file.
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 field in the Order Detail file.
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 field in the Order Detail file.
odt_cancelled_qty	numeric	5.0	The number of units on the order line that have been cancelled. From the ODT qty cancelled field in the Order Detail file.
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. From the ODT qty sold out field in the Order Detail file.
odt_shipped_qty	numeric	5.0	The number of units on the order line that have shipped. From the ODT qty shipped field in the Order Detail file.
odt_returned_qty	numeric	5.0	The number of units on the order line that the customer has returned. From the ODT qty returned field in the Order Detail file.
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 field in the Order Detail file.
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 field in the Order Detail file.
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 field in the Order Detail file.
odt_item	alpha	12	The code for the item on the order line. From the ITM number field in the Order Detail file.
odt_sku	alpha	14	A code for the SKU, such as color, size, or style, of the item. From the SKU code field in the Order Detail file.
odt_short_sku	numeric	7	The short SKU code for the item on the order line. From the Short SKU field in the SKU file.
odt_retail_ref_nbr	numeric	15	The retail reference number for the item on the order line. From the SKU retail x-ref # field in the SKU file.
odt_offer	alpha	3	The offer code assigned to the order line. From the Offer number field in the Order Detail file.
odt_alias	alpha	12	A code used as an additional way to identify the item on the order line. From the Alias field in the Order Detail file.
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 field in the Order Detail file.
odt_page_nbr	numeric	5	The page on which the item on the order line is advertised in the offer. From the Page# field in the Order Detail file.
odt_sub_set	alpha	1	From the ODT sub set? field in the Order Detail file.
odt_sub_set_seq_ nbr	numeric	3	From the ODT sub set sequence # field in the Order Detail file.
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? field in the Order Detail file.
odt_source_code	alpha	9	A code that identifies the source code assigned to the order line. From the ODT SRC source code field in the Order Detail file.
odt_source_ description	alpha	30	A description of the source code. From the SRC description field in the Source file.
odt_division_code	alpha	2	A code that identifies the division associated with the source code on the order line. From the Div field in the Source file.
odt_division_ description	alpha	30	A description of the division. From the Description field in the Division file.
odt_entity_nbr	numeric	3	A code that identifies the entity associated with the source code on the order line. From the Entity number field in the Division file.
odt_entity_ description	alpha	25	A description of the entity. From the ENT description field in the Entity file.
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 field in the Order Detail file.
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 field in the Order Detail file.
odt_second_choice_ status	alpha	1	Not currently implemented. From the ODT second choice status field in the Order Detail file.
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 field in the Order Detail file.
odt_arrival_date	numeric	7.0	The date the customer requested delivery of the item, in YYYY-MM-DD format. From the ODT arrival date field in the Order Detail file.
odt_bo_level	numeric	2.0	A number that controls the priority of order fulfillment on a backordered item. From the ODT BO level field in the Order Detail file.
odt_cancel_date	numeric	7.0	The last date on which the customer will accept receipt of the item, in YYYY-MM-DD format. From the ODT cancel date field in the Order Detail file.
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 field in the Order Detail file.
odt_date_printed	numeric	7.0	The date on which a pick slip for the order line was printed, in YYYY-MM-DD format. From the ODT date printed field in the Order Detail file.
odt_date_reserved	numeric	7.0	The date when units on the order line were reserved, in YYYY-MM-DD format. From the ODT date reserved field in the Order Detail file.
odt_discount	numeric	5.2	The amount of the discount applied to the item. Not currently implemented. From the ODT discount field in the Order Detail file.
odt_expected_ ship_date	numeric	7.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 field in the Order Detail file.
odt_freight_charge	numeric	7.2	The charge for shipping the item. From the ODT freight charge field in the Order Detail file.
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 field in the Order Detail file.
odt_next_bo_ card_date	numeric	7.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 field in the Order Detail file.
odt_original_price	numeric	7.2	The offer price of the item before any discount is applied. From the ODT original price field in the Order Detail file.
odt_price	numeric	7.2	The price the customer is charged for a single unit of the item. From the ODT price field in the Order Detail file.
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 field in the Order Detail file.
odt_special_ handling_dollars	numeric	7.2	The charge for special handling the item. From the ODT special handling $ field in the Order Detail file.
odt_tax	numeric	10.5	Sales tax charged for the item on the order line; this is the extended tax amount. From the ODT tax field in the Order Detail file.
odt_gst	numeric	10.5	The Canadian Goods and Services tax for the order line. From the ODT GST field in the Order Detail file.
odt_pst	numeric	10.5	The Provincial Services tax for the order line. From the ODT PST field in the Order Detail file.
odt_time_reserved	numeric	6.0	The time the item on the order line was reserved. From the ODT time reserved field in the Order Detail file.
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 field in the Order Detail file.
odt_upsell_cross_ sell	alpha	1	Indicates if an upsell/cross-sell promotion has been applied against the order line. A = Affinity add on sale. C = Coordinate cross sale. P = Net Perception add on. N = No promotion. T = Telemarketing special. Y = Upsell/cross-sell promotion. From the Upsell/cross-sell field in the Order Detail file.
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 field in the Order Detail file.
odt_cost_override	numeric	11.4	The override to the item’s cost from order entry or maintenance. From the Cost override field in the Order Detail file.
odt_entered_date	numeric	7.0	The date on which the order line was entered, in YYYY-MM-DD format. From the Entered date field in the Order Detail file.
odt_entered_time	numeric	6.0	The time on which the order line was entered, in HH:MM:SS format. From the Entered time field in the Order Detail file.
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 field in the Order Detail file.
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 field in the Order Detail file.
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 field in the Order Detail file.
odt_freight_ additional	numeric	7.2	The additional freight charges for the order line. From the Freight additional field in the Order Detail file.
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 field in the Order Detail file.
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 field in the Order Detail file.
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 field in the Order Detail file.
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? field in the Order Detail file.
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 field in the Order Detail file.
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 field in the Order Detail file.
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 # field in the Order Detail file.
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 field in the Order Detail file.
odt_coupon_dollar_ override	numeric	7.2	The coupon dollar amount subtracted from the order line price. From the Coupon $ override field in the Order Detail file.
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 field in the Order Detail file.
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 # field in the Order Detail file.
odt_pre_discount	numeric	7.2	The price of the item before any discounts were applied. From the ODT pre-discount field in the Order Detail file.
odt_duty	numeric	7.2	The amount of duty charged for the item. From the ODT duty field in the Order Detail file.
odt_upsell_type	alpha	1	A code indicating the type of upsell promotion applied to the order line. From the ODT upsell type field in the Order Detail file.
odt_need_by_date	numeric	7.0	Not currently implemented. From the ODT need by date field in the Order Detail file.
odt_pickup_type	alpha	2	Not implemented through the Generic Invoice Download API.
odt_tax_override	alpha	1	If this flag is Y, the order was received from an external system and a tax, GST, or PST amount was defined, indicating the tax amount from the external system should be retained on the order line. From the ODT future use Y/N 1 field in the Order Detail file.
odt_sh_exclude_tax	alpha	1	Indicates if special handling charges were excluded from tax. From the ODT future use Y/N 2 field in the Order Detail file.
odt_pickup_ location_id	alpha	10	Not implemented through the Generic Invoice Download API.
odt_location_ system_id	alpha	10	Not implemented through the Generic Invoice Download API.
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 field in the Order Detail file.
odt_whs_warehouse	numeric	3.0	A code for the warehouse in which the item was reserved. From the ODT WHS warehouse field in the Order Detail file.
odt_whs_ warehouse_name	alpha	30	The name of the warehouse. From the Name field in the Order Detail file.
odt_cancel_ reason_code	numeric	2.0	A code indicating the reason the order line was cancelled. From the CNR cancel reason code field in the Order Detail file.
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 field in the Order Detail file.
odt_ship_via_ description	alpha		A description of the shipper. From the VIA shipper name field in the Ship Via file.
odt_second_ choice_sku_item	alpha	12	From the ODT second choice SKU ITM field in the Order Detail file.
odt_second_ choice_sku_sku	alpha	14	From the ODT second choice SKU SKU field in the Order Detail file.
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 field in the Order Detail file.
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 field in the Order Detail file.
odt_backorder_ warehouse_name	alpha	30	The name of the backorder warehouse. From the Name field in the Warehouse file.
odt_aoc_addon_ code	alpha	3	Not currently implemented. From the ODT AOC add-on code field in the Order Detail file.
OrderLineMessage The OrderLineMessages element and its attributes repeat for each order line message defined 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 # field in the Order Line Messages file.
line_message_text	alpha	60	The order line message. From the OLM message field in the Order Line Messages file.
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? field in the Order Line Messages file.
line_message_date	numeric	7	The date the message was entered. From the Entry date field in the Order Line Messages file.
line_message_user	alpha	10	The user ID of the person who entered the message. From the User field in the Order Line Messages file.
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 field in the Item UPC file.
upc_nbr	numeric	14	The UPC code defined for the item on the order line. From the UPC field in the Item UPC file.
upc_vendor_nbr	numeric	7	A code for the supplier who sells you merchandise. From the UPC VND vendor nbr field in the Item UPC file.
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 # field in the Invoice Detail Pay Method file.
idp_merchandise_ amt	numeric	9.2	The merchandise amount assigned to the invoice payment method. From the Merch field in the Invoice Detail Pay Method file.
idp_merchandise_ balance_amt	numeric	9.2	The unpaid portion of the merchandise amount assigned to the invoice payment method. From the Merch balance field in the Invoice Detail Pay Method file.
idp_freight_amt	numeric	7.2	The freight amount assigned to the invoice payment method. From the Freight field in the Invoice Detail Pay Method file.
idp_freight_ balance_amt	numeric	7.2	The unpaid portion of the freight amount assigned to the invoice payment method. From the Freight balance field in the Invoice Detail Pay Method file.
idp_hand_ charge_amt	numeric	7.2	The handling charge amount assigned to the invoice payment method. From the Handling field in the Invoice Detail Pay Method file.
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 field in the Invoice Detail Pay Method file.
idp_tax_amt	numeric	10.5	The tax amount assigned to the invoice payment method. From the Tax field in the Invoice Detail Pay Method file.
idp_tax_balance_ amt	numeric	10.5	The unpaid portion of the tax amount assigned to the invoice payment method. From the Tax balance field in the Invoice Detail Pay Method file.
idp_gst_amt	numeric	10.5	The GST amount assigned to the invoice payment method. From the GST field in the Invoice Detail Pay Method file.
idp_gst_balance_amt	numeric	10.5	The unpaid portion of the GST amount assigned to the invoice payment method. From the GST balance field in the Invoice Detail Pay Method file.
idp_pst_amt	numeric	10.5	The PST amount assigned to the invoice payment method. From the PST field in the Invoice Detail Pay Method file.
idp_pst_balance_ amt	numeric	10.5	The unpaid portion of the PST amount assigned to the invoice payment method. From the PST balance field in the Invoice Detail Pay Method file.
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 field in the Invoice Detail Charge file.
idc_charge_amt	numeric	11.2	The amount of the charge assigned to the item on the invoice line. From the IDC amount field in the Invoice Detail Charge file.
idc_unit_amt	numeric	7.2	The flat rate the system used to calculate the duty amount. From the Unit amount field in the Invoice Detail Charge file.
idc_duty_pct	numeric	5.2	The percentage the system used the calculate the duty amount. From the Duty percent field in the Invoice Detail Charge file.
InvoiceDetailCost The InvoiceDetailCost element and its attributes are included once per item on an 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 # field in the Invoice Detail Cost file.
ivc_fifo_date	numeric	7	The date the FIFO layer was created. From the IVC FIFO date field in the Invoice Detail Cost file.
ivc_fifo_cost	numeric	11.4	The unit cost of the item derived from the FIFO layer. From the IVC FIFO cost field in the Invoice Detail Cost file.
ivc_quantity	numeric	7	The unit quantity of the item taking its cost from the FIFO layer. From the IVC quantity field in the Invoice Detail Cost file.
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 field in the Invoice Detail Cost file.
TrackingNumber The TrackingNumber element and its attributes are included for each separate shipment for which you have packing tracking information. The Consolidated Invoice (B49) system control value controls whether multiple shipments that occur on the same date are included in a single invoice. The information in these attributes is derived from the Manifest Upload Audit file (FLMUAU). Available in XML version: 3.0 (version 10.0 of CWDirect).
pick_nbr	numeric	7	The pick control number that identifies the pick slip for the shipment.
pick_label_nbr	numeric	3	The number of the label scanned at the manifesting station to confirm the shipment.
tracking_nbr	alpha	18	The shipment tracking number provided by the shipper.