Generic Customer Download API

Generic Customer Download API

Purpose: Use the generic customer download API to download new, changed, and deleted customer information to an external system, such as a point-of-sale system.

Customer information flow:

Mass customer download API: You can also use Mass Customer Download to create a batch file that contains a Mass Customer Download XML Message (CWCustomerDownload) for each sold to customer whose customer class matches the customer class defined in the MASS_CUSTDWNLD_CUSTOMER_CLASSES property. See Mass Customer Download for an overview.

In this chapter:

• Customer Download Process

- Identifying Customer Download Triggers

- When are Customer Download Triggers Created?

- Customer Download Processing

- Customer Outbound Trigger Activities

- Customer Outbound Trigger Rules

- Customer Trigger Cleanup

- Processing Customer Delete Triggers

- Customer Outbound XML Inclusion

• Order Management System Setup for the Customer Download API

- System Control Values

- Menu Options

- Periodic Functions

• Customer Download XML Message (CWCustomerDownload)

• Customer Download Message: Sample XML Messages

Customer Download Process

The system creates customer download triggers in the IL Outbound Trigger table when a customer is created, changed, or deleted. The Customer Outbound job in the Working with Integration Layer Processes (IJCT) menu option monitors the IL Outbound table for customer download triggers to process and generates a Customer Download XML Message (CWCustomerDownload) to send to the remote system.

Identifying Customer Download Triggers

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

Each trigger in the IL Outbound Trigger table has a:

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

• Key: indicating the specific record to download. For customer download triggers, the Key identifies the specific company and customer associated with the customer download trigger. For example, the Key 012000014776 indicates the customer information is located under company 12 for customer 14776.

• Capture type: indicating the type of activity performed against the record:

- A = the customer was created.

- C = the customer was updated. Note: The system removes any duplicate change triggers; see Customer Trigger Cleanup.

- D = the customer was deleted. Note: The system processes delete triggers immediately; see Processing Customer Delete Triggers.

When are Customer Download Triggers Created?

The Create Generic Customer Download Triggers (L12) system control value controls whether the system creates customer download triggers in the IL Outbound Trigger table.

• If this system control value is selected, certain actions in Order Management System triggers the system to create customer download triggers in the IL Outbound Trigger table with a File code of CST. The IL Outbound Trigger table acts as a “to do” list for the customer information that requires download. See Customer Outbound Trigger Activities for a list of activities that create triggers.

• If this system control value is unselected, the system does not create customer download triggers.

Customer Download Processing

To generate a customer download message:

1. The system creates customer download triggers, based on Order Management System activities that create, change, or delete customers who qualify based on the Customer Outbound Trigger Rules. See Customer Outbound Trigger Activities for a list of the activities that create the customer download triggers.

2. When the Customer Outbound job is active, it monitors the IL Outbound Trigger table for unprocessed customer download triggers. At the interval defined in the Outbound delay time, the job:

- checks for customer download triggers whose File code is CST and whose status is ready (R).

- removes duplicate customer download triggers. See Customer Trigger Cleanup.

- identifies the customer by the Key field for the customer download trigger. This field consists of company + customer code. For example, the Key 012000014776 indicates the vendor information is located in company 12 for customer 14776.

- generates the Customer Download XML Message (CWCustomerDownload).

- determines which elements to include in the customer download message, based on XML inclusion rules; see Customer Outbound XML Inclusion.

Note: The system creates a customer download message for customer outbound triggers with a delete (D) Capture type immediately, regardless of whether the Customer Outbound job is active or inactive; see Processing Customer Delete Triggers.

- sends the generated customer download message to each Customer Outbound queue whose Enabled field is selected. See Outbound Interface Queues.

Customer Outbound Trigger Activities

The table below indicates:

• which Order Management System activities create a customer download trigger

• which table the customer download trigger references

• the type of activity performed against the customer:

- A = the customer was created.

- C = the customer was updated.

- D = the customer was deleted.

The system creates a customer download trigger if the transaction updates any of the fields associated with the customer, regardless of whether the updated field is included in the customer download message.

Note: Some activities may create duplicate triggers; however, the Customer Trigger Cleanup removes any duplicates before generating the Customer Download XML Message (CWCustomerDownload).

Bill-to updates: Updating the bill-to customer assigned to a sold-to customer does not generate a customer download trigger; however, updating the sold-to customer generates a CWCustomerDownload message that includes all of the updated bill-to customer’s information, unless prohibited by the XML Inclusion rules for the CUST_OUT process.

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

Note: The system creates a customer download trigger for the activities listed below only if the customer meets the criteria from the Customer Outbound Trigger Rules.

Activity	Menu Option	Referenced Table	Trigger Type
Creating a Customer
Create a customer in customer maintenance	WCST	Customer Sold To Customer Sold To Extended Cust Sold To User Field Customer Sold To Phone # Customer Sold to Xref Customer Sold To Email Customer Ship To Customer Ship To Extended Customer Ship To Phone # Customer Tax Customer Notes Customer Profile	A
Create a customer through the Customer API	IJCT, WCAI	Customer Sold To Customer Sold To Extended Cust Sold To User Field Customer Sold To Phone # Customer Sold to Xref Customer Sold To Email Customer Profile	A
Create a customer through Order Entry/Maintenance	OEOM	Customer Sold To Customer Sold To Extended Cust Sold To User Field Customer Sold To Phone # Customer Sold to Xref Customer Sold To Email Customer Ship To Customer Ship To Extended Customer Ship To Phone # Customer Profile	A
Create a customer through the Order API	IJCT	Customer Sold To Customer Sold To Extended Cust Sold To User Field Customer Sold To Phone # Customer Sold to Xref Customer Sold To Email Customer Ship To Customer Ship To Extended Customer Ship To Phone # Customer Profile	A
Create a customer by creating a catalog request	WCAT, WCRU	Customer Sold To Customer Sold To Extended Customer Sold To Phone # Customer Sold To Email	A
Create a customer when creating a customer membership	WWCM	Customer Sold To Customer Sold To Extended Cust Sold To User Field Customer Sold To Phone # Customer Sold to Xref Customer Sold To Email Customer Ship To Customer Ship To Extended Customer Ship To Phone # Customer Tax Customer Notes Customer Profile	A
Note: Creating a customer through the activities listed above can create both an Add (A) and Change (C) trigger record if the activity also creates a record in a supporting table, such as the Customer Ship To. If there is both an Add and a Change trigger ready for processing when you start the CUST_OUT job, the job combines them and generates a single CWCustomerDownload message.
Changing a Customer
Change a customer in customer maintenance	WCST	Customer Sold To Customer Sold To Extended Cust Sold To User Field Customer Sold To Phone # Customer Sold to Xref Customer Sold To Email Customer Ship To Customer Ship To Extended Customer Ship To Phone # Customer Tax Customer Notes Customer Profile Customer Tax Customer Notes	C
Change a customer through the Customer API	IJCT WCAI	Customer Sold To Customer Sold To Extended Cust Sold To User Field Customer Sold To Phone # Customer Sold to Xref Customer Sold To Email Customer Profile	C
Change a customer through Order Entry/Maintenance	OEOM	Customer Sold To Customer Sold To Extended Cust Sold To User Field Customer Sold To Phone # Customer Sold to Xref Customer Sold To Email Customer Ship To Customer Ship To Extended Customer Ship To Phone # Customer Profile	C
Change a customer through the Order API	IJCT	Customer Sold To Customer Sold To Extended Cust Sold To User Field Customer Sold To Phone # Customer Sold to Xref Customer Sold To Email Customer Ship To Customer Ship To Extended Customer Ship To Phone # Customer Profile	C
Process a customer address change	PACS	Customer Sold To	C
Perform merge/purge and save the source customer as a ghost	MMCS	Customer Sold To Customer Sold To Extended Cust Sold To User Field Customer Sold To Phone # Customer Sold to Xref Customer Sold To Email Customer Ship To Customer Ship To Extended Customer Ship To Phone # Customer Tax Customer Notes Customer Profile Customer Tax Customer Notes	C
Deleting a Customer
Delete a customer through customer maintenance	WCST	Customer Sold To Customer Sold To Extended Cust Sold To User Field Customer Sold To Phone # Customer Sold to Xref Customer Sold To Email Customer Ship To Customer Ship To Extended Customer Ship To Phone # Customer Tax Customer Notes Customer Profile Customer Tax Customer Notes	D
Perform a merge/purge and delete the customer	MMCS	Customer Sold To Customer Sold To Extended Cust Sold To User Field Customer Sold To Phone # Customer Sold to Xref Customer Sold To Email Customer Ship To Customer Ship To Extended Customer Ship To Phone # Customer Tax Customer Notes Customer Profile Customer Tax Customer Notes	D

Customer Outbound Trigger Rules

Customer Outbound trigger rules define the criteria a customer must meet in order for the system to create a customer download trigger.

You can define Customer Outbound trigger rules based on:

• Company

• Customer class

• Inactive? flag

• Country

If you define more than one criterion, the customer must meet all of the criteria in order to generate a trigger.

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

Customer Outbound Trigger Rules
Customer table criteria	Results
The Company field must equal 12. The Customer Class field must equal ’PS’ (Port Supply).	The system generates a customer download trigger only if the customer being created, updated, or deleted is in company 12 and the customer class is PS (Port Supply).
The Inactive field is not equal to ’Yes’.	The system generates a customer download trigger only for active customers.
The Country field is equal to ’USA’.	The system generates a customer download trigger only if the customer is from the United States.
no criteria defined	The system generates a customer download trigger any time a customer is created, updated, or deleted.

You can define trigger rules for the Customer 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 Database Field Listing to review field attributes for the Customer table.

Customer Trigger Cleanup

Before processing the customer download triggers, the Customer Outbound job looks for duplicate unprocessed customer download triggers.

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

• File code CST

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

• Key (company + customer code)

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

Example: The following change customer download triggers exist in the IL Outbound table.

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

Note: If both an add (Capture type A) and a change (Capture type C) customer download trigger exists for the same Key, the system generates a Customer Download XML Message (CWCustomerDownload) for both triggers.

Processing Customer Delete Triggers

The system creates a customer download message for customer download triggers in the IL Outbound Trigger table with a delete (D) Capture type immediately, regardless of whether the Customer Outbound job is active or inactive.

The system immediately:

• updates the Original process date field and Original process time field.

• updates the Status field to X (closed).

• generates the Customer Download XML Message (CWCustomerDownload). The customer download message for delete transactions only contains the Customer element and its attributes.

However, if one or more unprocessed customer download triggers exist in the IL Outbound Trigger table for the same Key, the system:

• if one of the matching customer download triggers is an add (A) Capture type: does not create the delete customer download trigger and removes any other matching customer download triggers (add and change). Since the remote system never received the add trigger, you do not want to send a delete trigger or any other triggers.

Note: However, if an Original processed date and time exist for the add customer download trigger (indicating the trigger was previously downloaded and then reset to reprocess again), the system generates a customer download message for the delete customer trigger and removes any other matching customer download triggers (add and change). Since the remote system previously received the add customer download trigger, you want to send a delete notification to the system.

• if the matching customer download trigger is a change (C) Capture type: generates a customer download message for the delete customer download trigger and removes any other matching change customer download triggers. Since the remote system is receiving a delete trigger, you do not need to send any change triggers.

Example 1: When the system processes the delete customer download trigger, an unprocessed add and change customer download trigger exists in the IL Outbound table.

Customer Key	Type	Status	Results
012000014784	A	R	Since the customer has never been downloaded, the system does not create the delete customer download trigger and instead removes the add and change triggers from the IL Outbound Trigger table.
012000014784	C	R

Example 2: When the system processes the delete customer download trigger, a change customer download trigger exists that has not been processed.

Vendor Key	Type	Status	Results
012000014784	C	R	The system immediately generates a vendor download message for the delete vendor download trigger. The system removes the change vendor download trigger from the IL Outbound Trigger table (don’t bother sending the change since the customer has now been deleted).

You can review customer download triggers at the Work with Outbound Interface Transactions Screen.

Customer Outbound XML Inclusion

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

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

XML inclusion defines which elements to include in the Customer Download XML Message (CWCustomerDownload).

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

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

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

Include element in XML message?	Element
Selected = Include Customer Sold To Unselected = Exclude Customer Sold To and all of its children, Customer Bill To, Customer Bill To Note, Customer Ship To, Customer Tax, Customer Notes, Customer Profile; the system sends a message with only the Message element and its attributes	Customer Sold To
Selected = Include Customer Bill To and its parent, Customer Sold To Unselected = Exclude Customer Bill To		Customer Bill To
Selected = Include Customer Bill To Note and its parent, Customer Sold To Unselected = Exclude Customer Bill To Note		Customer Bill To Note
Selected = Include Customer Ship To and its parent, Customer Sold To Unselected = Exclude Customer Ship To		Customer Ship To
Selected = Include Customer Tax and its parent, Customer Sold To Unselected = Exclude Customer Tax		Customer Tax
Selected = Include Customer Notes and its parent, Customer Sold To Unselected = Exclude Customer Notes		Customer Notes
Selected = Include Customer Profile and its parent, Customer Sold To Unselected = Exclude Customer Profile		Customer Profile

Order Management System Setup for the Customer Download API

Before you can generate customer download messages, you must perform the necessary Order Management System setup and processing.

Information requiring setup includes:

• System Control Values

• Menu Options

• Periodic Functions

System Control Values

System Control Value	Description
Create Generic Customer Download Triggers (L12)	Select this field to create customer triggers in the IL Outbound Trigger table when you create, change, or delete a customer.
Outbound Interface Trigger File Purge Days (I14)	Enter the number of days to retain records in the IL Outbound Trigger table 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. You can also use the Purge option at the Work with Outbound Interface Transactions Screen to purge records. Example: Today is 5/10 and you have set this value to 1. Any record whose Last processed date is 5/10 or earlier is purged.

System Control Value

Description

Create Generic Customer Download Triggers (L12)

Select this field to create customer triggers in the IL Outbound Trigger table when you create, change, or delete a customer.

Outbound Interface Trigger File Purge Days (I14)

Enter the number of days to retain records in the IL Outbound Trigger table 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. You can also use the Purge option at the Work with Outbound Interface Transactions Screen to purge records.

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

Menu Options

Menu Option	Description
Working with Outbound Interface Transactions (WOIT)	Use to review, delete, or resend IL outbound trigger records.
Working with Integration Layer Processes (IJCT)	When active, the Customer Outbound job creates a Customer Download XML Message (CWCustomerDownload) for each unprocessed customer trigger in the IL Outbound Trigger table. You can also define: • trigger rules; see Customer Outbound Trigger Rules • XML inclusion rules; see Customer Outbound XML Inclusion • the queues where the customer download message is sent; see Work with Integration Layer Process Queues Screen

Menu Option

Description

Working with Outbound Interface Transactions (WOIT)

Use to review, delete, or resend IL outbound trigger records.

Working with Integration Layer Processes (IJCT)

When active, the Customer Outbound job creates a Customer Download XML Message (CWCustomerDownload) for each unprocessed customer trigger in the IL Outbound Trigger table.

You can also define:

• trigger rules; see Customer Outbound Trigger Rules

• XML inclusion rules; see Customer Outbound XML Inclusion

• the queues where the customer download message is sent; see Work with Integration Layer Process Queues Screen

Periodic Functions

Periodic Function	Description
Start CUST_OUT IJCT Job (program name ILSTRCSTOT)	Run this periodic function to start the CUST_OUT IJCT job and generate outbound triggers.
End CUST_OUT IJCT Job (program name ILENDCSTOT)	Run this periodic function to end the CUST_OUT IJCT job.
Purge IJCT Download (program name ILR0026)	Run this periodic function to purge processed IL outbound triggers, based on 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

Customer Download XML Message (CWCustomerDownload)

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

Message formatting specific to customer download:

• A separate message is generated for each customer you create, change, or delete.

• Delete transactions contain only the Customer element, the program that performed the deletion, and the company. See Sample Customer Download Message: Deletion for an example.

• If you exclude the element CustomerSoldTo element and all of its children (using the Customer Outbound XML Inclusion rules), the system sends a customer download message including only the Message element and its attributes.

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

Samples: See Customer Download Message: Sample XML Messages for sample messages.

Attribute Name	Type	Length	Comments
Message
source	alpha	10	OROMS
target	alpha	11
type	alpha	18	CWCustomerDownload
date_created	numeric	8	YYYY-MM-DD format
time_created	numeric	6	HH:MM:SS format
version	alpha	3.1	The outbound version, such as 1.0, specified for the CUST_OUT process through Working with Integration Layer Processes (IJCT).
CustSoldTo Each message includes one CustSoldTo element. The information in this element is available for review and update through customer maintenance. See Creating and Updating Sold-to Customers (WCST) for more information.
cst_action_type	alpha	1	A = Add: the customer was created C = Change: the customer was updated D = Delete: the customer was deleted
captured_by	alpha	7	The name of the function that generated the customer add, change, or delete trigger. See Customer Outbound Trigger Activities for information on activities that generate customer download triggers.
cst_company	numeric	3	The code identifying the company associated with the customer. Not zero-filled (company 6 is passed as 6 rather than 006). See Setting Up Companies (WCMP) for background on companies.
cst_cust_nbr	numeric	9	A unique number assigned by the system to identify the customer.
cst_prefix	alpha	3	A title (such as “Mrs.” or “Dr.”) that precedes the customer's name. The prefix prints on labels and forms.
cst_fname	alpha	15	The customer’s first name.
cst_minitial	alpha	1	The customer’s middle initial.
cst_lname	alpha	25	The customer’s last name. The last name is required if there is no company name specified for the customer.
cst_suffix	alpha	3	An addition to the customer's full name (such as “M.D.,” “Fr.,” or “III”).
cst_company_name	alpha	30	The name of the company that places orders with your company. Required if there is no customer last name.
cst_street_addr	alpha	30	The customer's street address.
cst_addr_line_2 through cst_addr_line_4	alpha	30	Additional address lines for the customer.
cst_apt	alpha	10	The apartment or suite number for the customer’s address.
cst_city	alpha	25	The city where the customer lives or receives mail or shipments.
cst_state	alpha	2	The two-position code for the state or province where the customer lives or receives mail or shipments. State codes are defined in and validated against the State table, accessible through the Work with Countries menu option; see Setting Up the Country Table (WCTY).
cst_zip	alpha	10	The postal or zip code for this customer.
cst_country	alpha	3	The three-position code identifying the country where the customer loves or receives mail or shipments. Country codes are defined in and validated against the State table, accessible through the Work with Countries menu option; see Setting Up the Country Table (WCTY).
cst_delivery_code	alpha	1	Identifies a business (commercial) or residential address. Used to calculate shipping charges for shippers that use rate tables (such as UPS). Valid values: • B = business rate table determines shipping charges • R = residential rate table determines shipping charges • N = no distinction between business and residence
cst_po_box	alpha	1	A flag that identifies the customer's delivery address as a Post Office box. Whenever you identify an address as a PO box, orders must ship by Parcel Post. Valid values are: • Y = The address is a Post Office box. The system automatically selects the PO box field when you enter the text PO box or P.O. box in the Street field in order entry or through the order API. However, the system does not automatically unselect the PO box field when you remove PO box or P.O.box from the Street field. • N (default) = The address is not a Post Office box.
cst_hold_bypass_fraud	alpha	1	Controls how to perform credit checking for the customer during order entry. Valid values are: • H = Hold: The system places the customer's orders on hold automatically so you can review, then manually release each order. • B = Bypass: Orders for the customer are not included in the credit check function in order entry; however, the customer is still subject to other fraud-checking, as described in for the Fraud Checking (A68) system control value. • F = Fraud: The system places the customer's orders on “fraud” hold automatically so you can review each order and release it as needed.
cst_orig_mail_type	alpha	1	This code identifies the source of the customer based on how you and the customer first established contact (Original mail type) and whether the customer then purchased merchandise from you (Current mail type). Valid values are: • B = Buyer: a customer who places an order (the “sold-to” customer). • C = Catalog request: a person who requested a catalog. • R = Recipient: the customer who receives the order (also known as the Ship To customer). • S = Suspect: a customer whose name you acquired through a telemarketing effort or a public or industry listing, or a customer who places an order that is not accepted. See the Mail type (Current, Original) for a discussion.
cst_tax_exempt	alpha	1	The tax status of this customer. Valid values are: E = Exempt: The customer is not required to pay tax on purchases. If the order is shipping to a Canadian address, it is exempt from both GST and PST. 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 system determines the customer’s tax status in order entry based on whether you enter a Resale/Exempt # and on the shipping address. 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. If the order is shipping to a Canadian address, it is exempt from both GST and PST. T = Standard Tax: The customer is subject to all taxes. Canadian customers are subject to both GST and PST tax. See the Tax exempt for a discussion.
cst_exempt_certificate	alpha	15	The resale or exempt certificate number assigned to a customer who is identified as tax exempt (E) or as a reseller (R).
cst_exempt_expiry	numeric	8	The date the customer's exempt or reseller certificate expires. YYYY-MM-DD format. In evaluating the customer's tax status, either at the customer level or for a specific state, the system validates that any date entered in this field has not passed, or that this date is blank. See Working with Customer Tax Status for a complete description of how customer tax information defaults in order entry.
est_associate	alpha	1	Identifies whether the customer as an associate or member who is eligible to receive special pricing on merchandise. Valid values: Y = the customer is an associate N = the customer is not an associate
cst_auto_cancel_bo	alpha	1	Indicates whether to automatically cancel backordered items with the first shipment on an order. Valid values are: Y = cancel backordered items automatically with the first order shipment N = do not cancel backordered items
cst_commercial	alpha	1	Identifies whether the customer is commercial for reporting purposes. Valid values are: Y = this is a commercial customer N = this is a non-commercial customer
cst_cust_type	alpha	3	A user-defined code to identify a group of customers further for reporting purposes.
cst_discount_pct	numeric	5.2	The discount applied automatically to the regular offer price for items on each order the customer places. Note: If the customer has a Price discount % and is also flagged as an Associate (see above), then the system applies the Price discount % to the regular offer price, not to the associate price.
cst_entry_date	numeric	8	The date you create the customer record. YYYY-MM-DD format.
cst_ghost	alpha	1	A customer number that remains in the system after you merge duplicate customer records. When you use Working with Merge/Purge Sold-to Names (MMCS), you have the option to retain the source customer as a ghost customer. Valid values: Y = the customer record is a ghost N = the customer record is not a ghost
cst_inactive	alpha	1	Identifies the customer's status. You can still place orders for inactive customers. This information is useful for exception reporting you might conduct on your house list. Valid values are: Y = customer is inactive N = customer is active
cst_match_code	alpha	15	A code used to identify duplicate customers based on a match on the customer's address. See Setting Up Match Codes (MMCH) for background.
cst_bypass_reservation	alpha	1	Controls when to reserve items for the customer. Valid values are: Y = the customer bypasses reservation; you need to use Working with Interactive Reservation (MIRV) to reserve items for the customer N = the system reserves inventory in the normal way for all orders for this customer
cst_mail_name	alpha	1	Controls whether the customer receives future catalogs. Valid values are: Y = mail catalogs to the customer N = do not mail catalogs to the customer
cst_rent_name	alpha	1	Controls whether to include the customer's name in lists you sell to other companies for their own catalog mailings. Valid values are: Y = you can sell the customer's name to another company N = do not sell the customer's name to another company
cst_seed_name	alpha	1	Identifies a customer name that you “plant” in a list to ensure that the company buying the list pays you for each use. Valid values are: Y = this customer is a seed N = this customer is not a seed
cst_rent_email	alpha	1	Not currently implemented.
cst_interface_cust_nbr	alpha	15	An additional way to identify a customer, such as a serial number or customer or membership number in another system.
cst_new_add_chg	alpha	1	Initially set to A when you create the customer record, and then reset to C when you update the record.
cst_catalog_req	alpha	1	Indicates whether the customer has ever requested a catalog: Y = the customer has requested a catalog N = the customer has never requested a catalog
cst_last_chg_date	numeric	8	The last date when you entered an order for the customer, changed information in the Customer Sold To table, or selected Change for a customer in customer maintenance. YYYY-MM-DD format.
cst_last_chg_date_name_addr	numeric	8	The last date when you processed a name or address update for the customer. YYYY-MM-DD format.
cst_email_opt_in	alpha	2	Indicates the preferred method of correspondence for the primary email address. Valid values are: O1 (Email) = Email is the preferred method of correspondence. O2 (Order-only email) = Use email for order-related correspondence only; generate a document for other correspondence. O3 (No email) = Do not use email for any correspondence; generate a document instead. O4 (Do not ask the customer) = Do not ask the customer for his/her email address; the customer has already been asked and has declined to provide it. The system does not generate any email correspondence to the customer, even if an email address is specified. The above values use the letter O, not the number 0 (zero). See Opt in/Opt out for background.
cst_vat_nbr	numeric	20	The customer's VAT (value-added tax) exemption number. Included only if the customer has a VAT exemption.
cst_email_addr	alpha	50	The customer's primary email address. See Working with Customer Email Addresses for an overview.
cst_job_title	alpha	26	The customer's job title. Informational.
cst_do_not_fax	alpha	1	Not currently implemented.
cst_deliverable	alpha	1	Not currently implemented.
cst_account_nbr	numeric	7	The bill-to account assigned this customer. If a sold-to customer is assigned a bill-to customer in this field, that bill-to customer is added to each new order for the customer. See Creating and Updating Bill-to Customers (WCBT) for background.
cst_cust_class	alpha	2	A code that categorizes customers at a high level for reporting purposes. See Setting Up the Customer Class Table (WCCL) on working with customer classes.
cst_cust_class_desc	alpha	30	The description of the customer class.
cst_orig_source	alpha	7	A code that identifies how you first acquired the customer. The system retains the source code used on a new customer's first order or catalog request, depending on how you first acquired the customer. See Working with Source Codes (WSRC) for background.
cst_curr_source	alpha	7	The source code used by the customer on the most recent order. See Working with Source Codes (WSRC) for background.
cst_curr_source_desc	alpha		The description of the current source code.
cst_salesman_nbr	numeric	7	A number that identifies a sales representative, if any, assigned to the customer. You can use Salesrep information for tracking and reporting sales activity and commissions. Salesrep numbers are defined in and validated against the Salesrep table. See Working with Sales Representatives (WSLS).
cst_salesman_name	alpha	30	The name of the sales rep.
cst_mail_code	alpha	3	Specifies how often, and under what conditions, you send mail to the customer. You can use this code to indicate the customer's mail preferences with more precision than the Mail flag permits. Mail codes are defined in and validated against the Mail/Call Code table. See Working with Mail/Call Codes (WMCC).
cst_mail_code_desc	alpha	40	The description of the mail code.
cst_call_code	alpha	3	Specifies how often, and under what conditions, you can call the customer. Call codes are defined in and validated against the Mail/Call Code table. See Working with Mail/Call Codes (WMCC).
cst_call_code_desc	alpha	40	The description of the call code.
cst_change_user	alpha	10	The user ID identifying the user who last changed the customer record. An ID such as ORDERIN indicates that the record was changed by a system process or message.
cst_create_user	alpha	10	The user ID identifying the user who created the customer. An ID such as ORDERIN indicates that the record was created by a system process or message.
cst_currency	alpha	3	The currency code, if any, specified for the customer. Defined in and validated against the Currency Code table; see Working with Currency (WCUR). Informational only.
cst_currency_desc	alpha	30	The description of the currency.
cst_language	alpha	3	The language code, if any, specified for the customer. Defined in and validated against the Language table; see Working with Language Codes (WLAN), Informational only.
cst_language_desc	alpha	30	The description of the language.
cst_active_cust_for_ghost	numeric	9	If this customer is flagged as a ghost, this indicates the customer record that the ghost record was merged into.
cst_price_group	alpha	4	The customer price group to use for quantity price matrix pricing, customer price group pricing, or as a qualifier for a promotion. Customer price groups are defined in and validated against the Customer Price Group table. See Working with Customer Price Groups (WCPG) for more information.
cst_reserve_whs	numeric	3	The warehouse code to default to the Order Header for new orders created for this sold-to customer. In this situation, the system reserves inventory for the order from this warehouse only.
cst_van_route	alpha	4	The van route assigned to the sold to customer, indicating the customer qualifies for van delivery on orders that contain the Reserve warehouse. See Van Delivery Processing for an overview.
cst_van_route_seq	numeric	4	The sequence number assigned to the van route in order to route the van deliveries. Informational only.
cst_user_field_1 through cst_user_field_4	alpha	10	Four additional fields you can use to enter any type of information about the customer. These are the fields displayed at the second Create/Change/Display Customer Sold To screen in Creating and Updating Sold-to Customers (WCST).
CustSoldToUserField A CustSoldToUserField element with a type of CST is included for each customer user-defined field that exists for the customer. See Work with User Fields Screen for an overview.
cst_user_field_text	alpha	30	The text entered for this customer. Included only for a text-based user-defined field.
cst_user_field_nbr	numeric	16	The number entered for this customer. Included only for a numeric user-defined field.
cst_user_field_date	numeric	8	The date that was entered for this customer. Included only for a date user-defined field. YYYY-MM-DD format.
cst_user_field_display_seq_nbr	numeric		A value assigned to a field at the Create User Defined Field Detail Screen to control its placement on the screen. Typically, you would assign a sequence number of 10 to the field that should appear first, a sequence number of 20 to the field that should appear second, and so on.
cst_user_defined_file_code	alpha	3	Set to CST.
cst_user_defined_seq_nbr	numeric	3	A unique number to identify the user-defined field.
cst_user_defined_field_seq_nbr	numeric	3	A unique number to identify this user-defined field record for this sold-to customer.
CustSoldToPhoneNbr A CustSoldToPhoneNbr element is included if you have a daytime, evening, or fax phone number for the customer.
cst_day_phone	alpha	14	The customer’s daytime phone number, using the formatting set up for the country; see Work with Telephone Number Format Screen for more information.
cst_day_ext	alpha	4	The extension for the daytime phone number.
cst_eve_phone	alpha	14	The customer’s evening phone number, using the formatting set up for the country; see Work with Telephone Number Format Screen for more information.
cst_eve_ext	alpha	4	The extension for the evening phone number.
cst_fax_phone	alpha	14	The customer’s third (fax or mobile) number, using the formatting set up for the country; see Work with Telephone Number Format Screen for more information.
cst_fax_ext	alpha	4	The extension for the third (fax or mobile) number.
CustSoldToCrossReference A CustSoldToCrossReference element is included for each existing alternate customer number for the customer. See Working with Alternate Customer Number Cross-References for an overview.
cst_alternate_cust_nbr	alpha	15	An additional way to identify a customer, such as a serial number or customer or membership number in another system.
CustSoldToEmail A CustSoldToEmail element is included for each existing email address for the customer. See Working with Customer Email Addresses for an overview.
cst_email_seq_nbr	numeric	3	A unique number assigned by the system to identify this email address for the customer.
cst_email_addr	alpha	50	The customer’s email address.
cst_email_status	alpha	2	The opt-in/out code identifying the customer’s contact preferences for this email address. See cst_email_opt_in for more information.
cst_email_format	alpha	1	The customer’s preference for email format. Valid values are: T = text H = HTML Informational.
cst_email_display_name	alpha	50	The name of the customer as displayed in email correspondence. Informational.
cst_email_create_date	numeric	8	The date when the email address record was created. YYYY-MM-DD format.
cst_email_create_time	numeric	6	The time when the email address record was created. HH:MM:SS format.
cst_email_create_source	alpha	2	The source of the email address. Valid values are: CA = customer API: You received the email address through the Generic Customer API. CE = customer email: You entered the address at the Create Email Address Screen. CM = customer maintenance: You entered the address at a screen in customer maintenance or received it through a catalog request. OE = order entry: You received the email while processing a new order (including orders created through the order API), through an e-commerce address update, or entered it for a customer membership recipient.
cst_email_change_date	numeric	8	The most recent date when you changed the Email address, Display name, Opt in/out field, or Format. YYYY-MM-DD format.
cst_email_change_time	numeric	6	The most recent time when you changed the Email address, Display name, Opt in/out field, or Format. HH:MM:SS format.
cst_email_last_primary_date	numeric	8	The most recent date when the email address was flagged as the primary address. The system flags an email address as the primary address when it is created through customer maintenance or a catalog request, or if it is the first email address for the customer. YYYY-MM-DD format.
cst_last_used_by_cust	numeric	8	The last date when this email address was used by the customer. YYYY-MM-DD format. The system updates this field for the primary email address when you: • create an order for the customer • create a catalog request for the customer • maintain an order for the customer The above updates take place regardless of how the information was received. For example, the system updates this field if you receive an order through the order API or create it through Generating Membership Orders (EGMO). The system also updates this field when you: • receive an email from the customer assign an unrouted email to the customer (if the email address on the unrouted email matched this email address for the customer)
cst_last_used_by_system	numeric	8	The last date when the system generated an email to this address. YYYY-MM-DD format. The system updates this field for the primary email address when you generate a notice such as a: • backorder notice email through Generate Backorder Notices (GBOC) • soldout notification email through Generating Soldout Notifications (MSON) • shipment confirmation email through Sending Internet Order Ship Confirmation (ESCF) • credit card credit email through Processing Refunds (MREF) See When Does the System Generate an Email Notification? for a listing of system-generated emails.
cst_email_primary	alpha	1	Indicates whether this is the customer’s primary email address. The primary address is the one that defaults in order entry; it also defaults in catalog requests. Valid values are: Y = this is the primary email address N = this is not the primary email address
CustShipTo A CustShipTo element is included for each existing permanent ship-to address for the customer. See Creating and Updating Ship-to Customers (WCST) for an overview.
csh_shipto_nbr	numeric	3	A unique number to identify this ship-to address for the sold-to customer.
csh_prefix	alpha	3	A title that belongs before the customer's name (such as “Mrs.” or “Dr.”).
csh_fname	alpha	15	The customer’s first name.
csh_minitial	alpha	1	The customer’s middle initial.
csh_lname	alpha	25	The customer’s last name.
csh_suffix	alpha	3	An addition to the customer's full name, such as (“M.D.”, “Fr.”, or “III”).
csh_company_name	alpha	30	The name of the customer’s company. Either a last name or a company name is required.
csh_street_addr	alpha	32	The customer’s delivery address.
csh_addr_line_2 through csh_addr_line_4	alpha	32	Three additional address lines.
csh_apt	alpha	10	The customer’s apartment or suite number.
csh_city	alpha	25	The city for the customer’s delivery address.
csh_state	alpha	2	The state for the customer’s delivery address.
csh_zip	alpha	10	The postal or zip code.
csh_country	alpha	3	The three-position code identifying the customer’s country. Country codes are defined in and validated against the Country table; see Setting Up the Country Table (WCTY).
csh_delivery_code	alpha	1	Identifies a business (commercial) or residential address. Used to calculate shipping charges for shippers that use rate tables (such as UPS). Valid values: • B = business rate table determines shipping charges • R = residential rate table determines shipping charges • N = no distinction between business and residence
csh_po_box	alpha	1	Identifies the address as a post office box. Valid values are: • Y = this is a post office box address • N = this is not a post office box address
csh_email_addr	alpha	50	The email address associated with the ship-to address.
csh_match_code	alpha	15	A code used to identify duplicate customers based on a match on the customer's address. See Setting Up Match Codes (MMCH) for background.
csh_rent_name	alpha	1	Indicates whether to include the 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
csh_mail_code	alpha	3	This code further defines when and under what conditions you send mail to this customer. Defined in and validated against the Mail/Call Codes table; see Working with Mail/Call Codes (WMCC).
csh_mail_code_desc	alpha	30	The description of the mail code.
csh_call_code	alpha	3	This code further defines when and under what conditions you call this customer. Defined in and validated against the Mail/Call Codes table; see Working with Mail/Call Codes (WMCC).
csh_call_code_desc	alpha	30	The description of the call code.
csh_language	alpha	3	The language code, if any, specified for the ship-to customer. Defined in and validated against the Language table; see Working with Language Codes (WLAN), Informational only.
csh_language_desc	alpha	30	The description of the language code.
csh_reserve_whs	numeric	3	The warehouse code to default to the Order Header for new orders created for this customer. In this situation, the system reserves inventory for the order from this warehouse only. Warehouse codes are defined in and validated against the Warehouse table. See Creating and Maintaining Warehouses (WWHS).
csh_van_route	alpha	4	The van route assigned to the ship to customer, indicating the customer qualifies for van delivery on orders that contain the Reserve warehouse. See Van Delivery Processing for an overview.
csh_van_route_seq	numeric	4	The sequence number assigned to the van route in order to route the van deliveries. Informational only.
CustShipToPhoneNbr A CustShipToPhoneNbr element is included if the customer ship-to has a daytime, evening, or fax phone number.
csh_day_phone	alpha	14	The ship-to customer’s daytime phone number.
csh_day_ext	alpha	4	The extension associated with the daytime phone number.
csh_eve_phone	alpha	14	The ship-to customer’s evening phone number.
csh_eve_ext	alpha	4	The extension associated with the evening phone number.
csh_fax_phone	alpha	14	The ship-to customer’s fax number.
csh_fax_ext	alpha	4	The extension associated with the fax number.
CustBillTo The message includes a CustBillTo element if a bill-to customer number is assigned to the sold-to customer. See the Bill-to field at the Second Create Customer Sold To Screen for background.
cbt_account_nbr	numeric	7	A unique number assigned by the system to identify the bill-to customer.
cbt_prefix	alpha	3	A title (such as “Mrs.” or “Dr.”) that belongs before the customer's name.
cbt_fname	alpha	15	The bill-to customer’s first name.
cbt_minitial	alpha	1	The bill-to customer’s middle initial.
cbt_lname	alpha	25	The bill-to customer’s last name.
cbt_suffix	alpha	3	An addition to the customer's full name (such as “M.D.”, “Fr.”, or “III”).
cbt_company_name	alpha	30	The name of the bill-to customer’s company. The record must have either a last name or a company name.
cbt_street_addr	alpha	32	The customer's street address or the number of the customer's post office box (entered as P.O. Box ###). This is the primary delivery address.
cbt_addr_line_2 to cbt_addr_line_4	alpha	32	Three additional address fields.
cbt_apt	alpha	10	The apartment or suite number.
cbt_city	alpha	25	The bill-to customer’s city.
cbt_state	alpha	2	The bill-to customer’s state.
cbt_zip	alpha	10	The bill-to customer’s postal or zip code.
cbt_country	alpha	3	The code identifying the bill-to customer’s country. Country codes are defined in and validated against the Country table; see Setting Up the Country Table (WCTY).
cbt_delivery_code	alpha	1	Identifies a business (commercial) or residential address. Used to calculate shipping charges for shippers that use rate tables (such as UPS). Valid values: • B = business rate table determines shipping charges • R = residential rate table determines shipping charges • N = no distinction between business and residence
cbt_po_box	alpha	1	Identifies the address as a post office box. Valid values are: • Y = this is a post office box address • N = this is not a post office box address
cbt_credit_limit	numeric	7.0	The credit limit set for the customer's account. The Credit Check program refers to this field when you process an order or change an order total.
cbt_match_code	alpha	15	A code used to identify duplicate customers based on a match on the customer's address. See Setting Up Match Codes (MMCH) for background.
cbt_hold_bypass_fraud	alpha	1	Controls how to perform credit checking for the customer during order entry. Valid values are: • H = Hold: The system places the customer's orders on hold automatically so you can review, then manually release each order. • B = Bypass: Orders for the customer are not included in the credit check function in order entry; however, the customer is still subject to other fraud-checking, as described in for the Fraud Checking (A68) system control value. • F = Fraud: The system places the customer's orders on “fraud” hold automatically so you can review each order and release it as needed.
cbt_print_statement	alpha	1	Not implemented.
cbt_fax_flag	alpha	1	Not currently implemented.
cbt_edi_flag	alpha	1	Not currently implemented.
cbt_email_addr	alpha	50	The email address where the system sends purchase orders. See Purchase Order Emails for more information.
cbt_optin_optout	alpha	2	Indicates the preferred method of correspondence for the bill-to email address. Not currently implemented for bill-to customers’ email addresses. See the cst_email_opt_in attribute for valid values.
cbt_d_and_b_date	numeric	8	Not implemented.
cbt_d_and_b_rating	alpha	3	Not implemented.
cbt_language	alpha	3	The language code, if any, specified for the bill-to customer. Defined in and validated against the Language table; see Working with Language Codes (WLAN), Informational only.
cbt_language_desc	alpha	30	The description of the language.
cbt_currency	alpha	3	The currency code, if any, specified for the bill-to customer. Defined in and validated against the Currency Code table; see Working with Currency (WCUR). Informational only.
cbt_currency_code_desc	alpha	30	The description of the currency.
CustBillToUserField A CustBillToUserField element with a type of CBT is included for each user-defined field that exists for the bill-to customer associated with the sold-to customer. See Work with User Fields Screen for an overview.
cbt_user_field_text	alpha	30	The text entered for this bill-to customer. Included only for a text-based user-defined field.
cbt_user_field_number	numeric	16	The number entered for this bill-to customer. Included only for a numeric user-defined field.
cbt_user_field_date	numeric	8	The date that was entered for this bill-to customer. Included only for a date user-defined field. YYYY-MM-DD format.
cbt_user_field_display_seq_nbr	numeric	3	A value assigned to a field at the Create User Defined Field Detail Screen to control its placement on the screen. Typically, you would assign a sequence number of 10 to the field that should appear first, a sequence number of 20 to the field that should appear second, and so on.
cbt_user_defined_file_code	alpha	3	Set to CBT.
cbt_user_defined_seq_nbr	numeric	3	A unique number to identify the user-defined field.
cbt_user_field_seq_nbr	numeric	3	A unique number to identify this user-defined field record for the bill-to customer.
CustBillToPhoneNbr A CustBillToPhoneNbr element is included if there are any phone numbers identified for the bill-to customer associated with the sold-to customer. See Work with Bill To Phone Numbers Screen for information on entering phone numbers for a bill-to customer.
cbt_day_phone	alpha	14	The bill-to customer’s daytime phone number.
cbt_day_ext	alpha	4	The extension for the daytime phone number.
cbt_eve_phone	alpha	14	The bill-to customer’s evening phone number.
cbt_eve_ext	alpha	14	The extension for the evening phone number.
cbt_fax_phone	alpha	4	The bill-to customer’s fax number.
cbt_tax_ext	alpha	14	The extension for the fax number.
CustBillToNote The message includes a CustBillToNote element for each note entered for the bill-to customer associated with the sold-to customer. See Work with Bill To Notes Screen for background.
cbt_note_seq_nbr	numeric	3	A unique number assigned by the system to identify the note.
cbt_note	alpha	60	The text of the note.
cbt_note_entry_date	numeric	8	The date when the note was created. YYYY-MM-DD format.
cbt_note_user	alpha	10	The user ID of the person who entered the note.
CustTax A CustTax element is included for each existing exemption or certificate for the customer in a particular state or province. See Working with Customer Tax Status for background.
cst_tax_country	alpha	3	The country where the customer has a reseller or other tax exemption. Country codes are defined in and validated against the Country table; see Setting Up the Country Table (WCTY).
cst_tax_state	alpha	2	The state or province where the customer has a reseller or other tax exemption. State codes are defined in and validated against the State table, which is accessible through the Work with Countries menu option; see Setting Up the Country Table (WCTY).
cst_tax_code	alpha	1	The tax status of the customer in the state. Valid values are: • Exempt = The customer is exempt from paying any taxes, including VAT, in this state or province. • GST Only = Not currently implemented at the state or province level. To flag a customer as eligible for Goods and Services tax only, use the Tax exempt setting at the customer level. • Non-Tax = Not currently implemented. • PST Only = Not currently implemented at the state or province level. To flag a customer as eligible for Provincial Sales Tax only, use the Tax exempt setting at the customer level. • Resale = The customer is a reseller and exempt from paying any taxes, including VAT, in this state or province. • Standard = The customer is subject to tax. Although you can create tax records using any of the codes above, retrieving tax status for any tax code but Resale or Exempt is not currently implemented.
cst_tax_resale_exempt_nbr	alpha	15	A number that the state issues to identify a customer who is not subject to taxes on purchases. This number applies only if there is no Exempt certificate set up at the customer level.
cst_tax_expiration_date	numeric	8	The date the customer's exempt or reseller certificate expires in this state. This expiration date applies only if there is not an Exempt expiry (Tax exempt certificate expiration date) specified at the customer level.
CustNote A CustNote element is included for each existing informational message about the customer. Operators can enter customer notes, or they can be written by the system for actions such as address updates. See Edit Customer Notes Screen for background.
cst_note_seq_nbr	numeric	3	A unique number assigned by the system to identify the customer note.
cst_note_type	alpha	1	Indicates the type, if any, used identify a type of note. You can use note types to make the note display automatically in a pop-up window in order entry or order maintenance, or default into the Notes field. See Working with Customer Note Types (WNTY) for background.
cst_note	alpha	60	The text of the note.
cst_note_entry_date	numeric	8	The date the note was created. YYYY-MM-DD format.
cst_note_user	alpha	10	The user or system process that created the note.
CustProfile A CustProfile element is included for each existing profile data entry for the customer. See Work with Customer Profile Screen for an overview on capturing demographic data for customers, and see Setting Up Customer Profiles (WPFL) for setup information.
cst_profile_code	numeric	3	Identifies the type of demographic information captured, such as gender.
cst_profile_code_desc	alpha	30	The description of the profile code.
cst_profile_data_code	alpha	1	Identifies the demographic response from the customer, such as female.
cst_profile_data_code_desc	alpha	30	The description of the response.