4 Accounting Setup
Working with Entities (WENT)
Purpose: Use the Entities function to add or maintain entities, their descriptions, and override settings such as email options. Entities are an important component of the Order Management System sales reporting hierarchy, and can represent the business units within your company (for example, mail order, retail, wholesale). Every sale, return, exchange, discount, and write-off is attributed to an entity. Entities should represent any organization within your company that is held accountable for sales performance.
You must create at least one entity.
Email options: You can set entity-level or order type/entity-level overrides for email notifications generated by the system, including the text of the email template, the “from” email address, and whether to generate the Outbound Email XML Message (CWEmailOut) or an actual email directly to the customer.
For more information see the Web Services Guide on My Oracle Support (ID 2149144.1)
You can also set up system control value overrides at the entity level.
In this topic:
Order Management System Sales Reporting Hierarchy

Related System Control Values and Settings
Purpose: These system control values allow you to define additional settings related to the use of entity in your company.
-
Display Entity Description (F84): If this system control value is selected, the entity related to an order displays in order inquiry and at the Customer Selection Screen in order entry. An entity is related to an order through the source code on the order header; when you create a source code, you must associate it with a division, and each division points to an entity. See the Order Management System Sales Reporting Hierarchy chart for an illustration.
Note:
Only the first five characters of the entity description display on the CTI Customer Selection screen. -
Track Customer History at Entity Level (F89): If this system control value is selected, the system tracks each customer's order history separately based on the entity associated with the source code on the order header. You might choose to break out customer history by entity if you have multiple catalogs with distinct identities, yet sharing the same customer list and inventory.
Work with Entities Screen
Purpose: Use this screen to review the entities in your company, or to create, change, delete, or display an entity.
How to display this screen: Enter WENT in the Fast Path field at the top of any menu or select Work with Entities from a menu.
Field | Description |
---|---|
Entity |
A code that represents the entity. Numeric, 3 positions; optional. |
Description |
The description of the entity code. Alphanumeric, 25 positions; optional. |
Screen Option | Procedure |
---|---|
Create a new entity code |
Select Create to advance to the Create Entity Screen. |
Change entity information |
Select Change for an entity to advance to the Change Entity screen. At this screen you can change anything but the entity code. See Create Entity Screen for field descriptions. |
Delete entity information |
Select Delete for an entity to delete it. The system does not display an additional warning if you have taken orders for this entity; use care in deleting. |
Display entity information |
Select Display for an entity to advance to the Display Entity screen. You cannot change any information on this screen. See Create Entity Screen for field descriptions. |
Work with system control value overrides by entity |
Select Control Value Overrides for an entity to advance to the Work with Entity SCV Overrides Screen. |
Enter or change the return address for printing on customer return labels from the web storefront |
Select Return address for an entity to advance to the Work with Entity Return Address Screen. |
Work with entity-level or entity/order type-level overrides for email notifications |
Select Email overrides for an entity to advance to the Work with Entity Email Overrides Screen. |
Work with user defined fields |
Select User Field for an entity to advance to the Work with User Fields Screen. |
Create Entity Screen
Purpose: Use this screen to create an entity code.
How to display this screen: Select Create at the Work with Entities Screen.
Field | Description |
---|---|
Entity |
A code that represents an entity. Entities are an important component of the Order Management System sales reporting hierarchy. Entities can represent the business units within your company (for example, mail order, retail, wholesale). Every sale, return, exchange, discount, and write-off is attributed to an entity. Entities should represent any organization within your company that is held accountable for sales performance. You must create at least one entity. Numeric, 3 positions. Create screen: required. Change screen: display-only. |
Description |
The description of the entity. Alphanumeric, 25 positions; required. |
The following address fields may appear on printed forms if your unique printing programs support it. |
N/A |
Name |
The name of the entity. Alphanumeric, 30 positions; optional. |
Address |
Two lines of address information. You must enter at least one line of address information if you complete any of the remaining address fields. Alphanumeric, 32 positions each; required if you complete any of the address fields. |
City |
The city where the entity is located. Alphanumeric, 25 positions; required if you complete any of the address fields. |
State |
The state where the entity is located. The system validates that this is a valid state associated with the Country you enter. See Setting Up the Country Table (WCTY). Alphanumeric, 2 positions; required if you complete any of the address fields. |
Zip |
The zip or postal code where the entity is located. Your entry is not validated against the Postal Code table, and no formatting is applied. Alphanumeric, 10 positions; required if you complete any of the address fields. |
Country |
The country where the entity is located. Your entry is validated against the Country table; see Setting Up the Country Table (WCTY). Alphanumeric, 3 positions; required if you complete any of the address fields. |
Phone #/Extension |
The phone number and extension. You can define a telephone number format to map to the phone numbers operators enter into the system. Telephone number formats are defined by arranging numbers and special characters such as hyphens and parenthesis in the same order and position as the numbers in a phone number would display. When an operator enters a phone number, the system compares the number of numeric characters in the phone number with the telephone number formats you have defined. In order to match a format, the phone number must have the same number of numeric positions as a telephone number format. If the system cannot find a match, the phone number does not map to a telephone number format and is saved as it was entered by the operator. Telephone Number Format Examples An operator enters a phone number containing 10 numbers: 5085550100 The telephone number format used in the United States to represent an area code, local exchange and local phone number is: (508) 555-0100 When an operator enters a phone number containing 10 numbers (as in the example), the phone number displays so that the first 3 positions are in parenthesis and a hyphen is between the sixth and seventh numbers, regardless of how the operator entered it into the system. If an operator enters a phone number containing 6 numbers, for example 5550100 and no format exists for 6 numbers, the phone number would display as it was entered (4293197). See Setting Up the Zip/City/State (Postal Code) Table (WZIP). Alphanumeric, 14 positions (phone number) and 4 positions (phone extension); optional. |
Retail Brand |
The retail brand associated with the entity. Retail brands are used for integration with Order Broker’s Drop Ship Manager to identify the retail brand for a drop shipment. A retail brand may be associated with one or more entities. Retail brands are defined in and validated against the Retail Brand table. See Working with Retail Brands (WRBD). This field is enterable only if the Use OROB Drop Shipping (H13) system control value is selected. Alphanumeric, 3 positions; required. |
Work with Entity SCV Overrides Screen
Purpose: Use this screen to work with overrides to System Control table settings based on entity.
Available SCV overrides: Pricing values are available for override at the entity level; see Edit Pricing Values Screen.
How to display this screen: Select Control Value Overrides for an entity at the Work with Entities Screen.
Field | Description |
---|---|
Entity |
The entity you selected at the Work with Entities screen. Numeric, 3 positions; display-only. |
Description |
The description of the selected entity. Alphanumeric, 25 positions; display-only. |
SCV |
A number that identifies the system control value to the system. This is an internal code that programs reference when checking a specific system control value. Alphanumeric, 3 positions; optional. |
App (Application area) |
The application area (for example, Order Entry or O/E) to which this system control value belongs. Application areas are used to categorize similar control values, secured features, and menu options by functional area. Once an application area has been assigned to a control value, it cannot be changed. Alphanumeric, 3 positions; optional. |
Grp (Application group) |
The application group to which this system value relates. Application groups further define functions within an application area and are used to categorize similar control values, secured features, and menu options. Examples of application groups with the Order Entry application area are pricing (PRI) and tax. Alphanumeric, 3 positions; optional. |
Description-value |
The description of the system control value. Alphanumeric, 60 positions; display-only. |
Active |
This field indicates whether the Active override flag for the entity-level system control value has been selected. If you select this flag, the system updates the Entity System Control Value table. Also, the entity-level settings will override your company-wide entries in the System Control table for any activity within this entity. Valid values are:
|
Screen Option | Procedure |
---|---|
Change an entity-level system control value setting |
Select Change for system control value to advance to the Edit Pricing Values Screen. |
Display an entity-level system control value setting |
Select Display for a system control value to advance to the Edit Pricing Values Screen. |
View the history of changes to system control value overrides for this entity |
Select View History to advance to the Display All System Control Value History Screen. See Display System Control Value History Screen for a discussion of the System Control Value History table. |
Edit Pricing Values Screen
Purpose: Use this screen to work with entity-level overrides to your company-wide pricing values in the System Control table. Pricing values control how the system determines item price in order entry and order maintenance.
How to display this screen: Select Change for the Pricing Values system control value at the Work with Entity SCV Overrides Screen.
Note:
Each of the pricing values are described under Pricing Values (B31).Field | Description |
---|---|
Entity |
The entity you selected at the Work with Entities screen. Numeric, 3 positions; display-only. |
Application code |
The application area (for example, Order Entry or O/E) to which this system control value belongs. Application areas are used to categorize similar control values, secured features, and menu options by functional area. Once an application area has been assigned to a control value, it cannot be changed. Alphanumeric, 3 positions; display-only. |
Active override |
If you select this flag, the system updates the Entity System Control Value table. Also, the entity-level settings will override your company-wide entries in the System Control table for any activity within this entity. Valid values are:
|
Application group |
The application group to which this system value relates. Application groups further define functions within an application area and are used to categorize similar control values, secured features, and menu options. Examples of application groups with the Order Entry application area are pricing (PRI) and tax. Alphanumeric, 3 positions; display-only. |
Instructions:
-
Select the Active override flag to have the entity-level pricing values override the company-wide settings.
-
Optionally, complete each of the pricing values. See Pricing Values (B31).
How the system determines how to price orders: When you enter an order, the system determines how to select prices at the time you complete the order header information, including the source code. The system checks the Active override setting for the entity associated with the division specified for this source code. If the Active override flag is selected, the system uses the entity-level pricing values to determine the price of each item on the order. If the Active override flag is unselected, the system uses the company-wide pricing levels from the System Control table.
Work with Entity Return Address Screen
Purpose: Use this screen to create or edit the entity address to print on return labels. The system uses this address only if your web storefront supports printing these labels for return authorizations when customers enter returns on the storefront. See the E-Commerce Interface for more information.
If there is no entity return address: The system uses the address you specify for the company at the Work with Company Return Address Screen if you do not define a return address for the entity associated with an order. An order is associated with an entity through the division assigned to the source code on the order header.
If there is no entity or company return address: If a return address is not specified for the entity associated with the order or for the company, the system uses the address for the Default Warehouse (A04).
How to display this screen: Select Return address for an entity at the Work with Entities Screen.
Completing this screen: Enter the address to appear on return labels for use when customers enter returns through your web storefront. See the Work with Company Return Address Screen for field descriptions. To delete the return address, select Delete.
Work with Entity Email Overrides Screen
Purpose: Use this screen to review and work with email notification overrides for an entity. You can override the “from” email alias, the boilerplate text to print above and below the items, or the XML only? checkbox. You can also set up order type/entity overrides for certain notification types.
Note:
An entity-level override is not available for the purchase order email, as the purchase order is not related to a specific entity.For more information: See Email Setup within Order Management System and Working with E-Mail Notification Templates (WEMT).
How to display this screen: Select Email overrides for an entity at the Work with Entities Screen.
Field | Description |
---|---|
Entity |
The entity you selected at the Work with Entities Screen. The description of the entity is to the right. Entity: numeric, 3 positions; display-only. Description: alphanumeric, 30 positions; display-only. |
Type |
The email notification type to use the “from” email alias specified for the Directory address and the template text. Email notification types are:
Note: All notification types available at the entity level are listed, regardless of whether you use the notification in this entity or in your company. The purchase order email template is available only at the company level, since the purchase order is not related to a specific entity.Alphanumeric, 27 positions; display-only. |
From email alias |
The alias to display with the “from” address for emails, for example, My Email Alias <no-reply-omni@oraclecloud.com>. The actual “from” address is set by Oracle and cannot be changed. Alphanumeric, 50 positions; optional. |
Option | Procedure |
---|---|
Create or change the entity-level override of the “from” email alias and/or template and XML only? setting for an email notification type |
Select Change for an email notification type to advance to the Change Email Override Screen. Note: There is no Create option at this screen; use the Change option to create a new template. |
Display the entity-level override of the “from” email alias and/or template and XML only? setting for an email notification type |
Select Display for an email notification type to advance to the Display Email Override screen. See the Change Email Override Screen for field descriptions. |
Delete an email template at the entity level |
Select Change for a template to advance to the Change Email Override Screen, where you can delete the contents of the template. |
Work with order type/entity email overrides for the order, shipment, order cancel, or order line cancel notifications |
Select Order Type to advance to the Entity Email Override by Order Type Screen. |
Change Email Override Screen
Purpose: Use this screen to enter, change, or delete entity-level email override information. See Email Text Templates and “From” Email Alias for a discussion.
How to display this screen: Select Change for an email notification type at the Work with Entity Email Overrides Screen.
Field | Description |
---|---|
Entity |
The entity you selected at the Work with Entities Screen. The description of the entity is to the right. Entity: numeric, 3 positions; display-only. Description: alphanumeric, 30 positions; display-only. |
Notice type |
The email notification type to use the “from” email alias specified for the Directory address and the template text. Email notification types are:
Note: All notification types available at the entity level are listed, regardless of whether you use the notification in this entity or in your company. However, the purchase order email template is available only at the company level, since the purchase order is not related to a specific entity.Alphanumeric, 27 positions; display-only. |
XML only |
Indicates whether to generate the Outbound Email XML Message (CWEmailOut) rather than an actual email notification for notices generated for this entity. This XML message includes additional information that is not included in the standard email notice. You might choose to generate the XML message so that you can use the additional information to produce a reformatted HTML email that includes promotional material. For more information see the Web Services Guide on My Oracle Support (ID 2149144.1) Valid values are:
For more information see the Web Services Guide on My Oracle Support (ID 2149144.1) Note:
See Outbound Email API for an overview, and see HTML Email or Outbound Email XML Message? for a discussion of when the system uses this setting as an override at the entity level. For more information see the Web Services Guide on My Oracle Support (ID 2149144.1) |
From email alias |
The alias to display with the “from” address for emails, for example, My Email Alias <no-reply@omni.retail.oraclecloud.com>. The actual “from” address is set by Oracle and cannot be changed. The system uses the following hierarchy in selecting the “from” email alias:
Alphanumeric, 50 positions; optional. |
Text to print above items |
The standard text to include in each email above the information specific to the order. See the HTML Format Notification Samples and Contents and the Simple Format Notification Sample. See Email Text Templates for information on the hierarchy that determines which text template to use. Setting a “from” email alias override works independently from the email template override. For example, you can override the “from” email alias and not the template, or vice versa. Alphanumeric, ten 60-position lines; optional. |
Text to print below items |
The standard text to include in each email below the information specific to the order. See the HTML Format Notification Samples and Contents and the Simple Format Notification Sample. Alphanumeric, three 60-position lines; optional. |
Completing this screen:
-
Create a new template:
-
Optionally, select the XML only? flag to Outbound Email XML Message (CWEmailOut) rather than an actual email notification.
For more information see the Web Services Guide on My Oracle Support (ID 2149144.1)
-
Optionally, enter a From email alias to use an override email alias at the entity level.
-
Enter the Text to print above items.
-
Optionally, enter the Text to print below items.
-
Click OK when you are done to save your changes, or click Exit to exit without saving.
-
-
Change an existing template:
-
Optionally, change the setting of the XML only? flag indicating whether to generate the actual email or the Outbound Email XML Message (CWEmailOut).
For more information see the Web Services Guide on My Oracle Support (ID 2149144.1)
-
Optionally, enter a From email alias to use an override email alias at the entity level.
-
Optionally, change the Text to print above items or the Text to print below items, or enter additional text.
-
Click OK when you are done to save your changes, or click Exit to exit without saving.
-
-
Delete an existing template:
-
Delete each line of text in the Text to print above items and Text to print below items.
-
Click OK when you are done to delete the template, or click Exit to exit without deleting.
-
Entity Email Override by Order Type Screen
Purpose: Use this screen to work with entity/order type email text templates, including the “from” email alias and the XML only? settings, for the order, shipment, order cancellation, and order line cancellation notifications.
Overrides other templates: If you set up an email override here, it overrides all other email setup at the entity, order type, or order level. See Email Setup within Order Management System for background on the hierarchies that apply to generating email or the Outbound Email XML Message (CWEmailOut).
For more information see the Web Services Guide on My Oracle Support (ID 2149144.1)
How to display this screen: Select Order Type at the Work with Entity Email Overrides Screen.
Note:
When you first advance to this screen, it does not display any entity/order type email overrides; you need to use the Create option to create each record.Column sort: You can sort on any column on this screen by clicking on the column name. An arrow pointing up displays next to the field when the values for the field display in ascending sequence; an arrow pointing down displays next to the field when the values for the field display in descending sequence.
Field | Description |
---|---|
Order type |
An order type to generate the email override. Order types are defined in and validated against the Order Type file. See Establishing Order Types (WOTY) for more information. Alphanumeric, 1 position; display-only. Note: The order type description is not displayed. |
Notification type |
The type of notification for the override. Possible notification types are:
You cannot set up overrides for any other notification types at the entity/order type level. |
Option | Procedure |
---|---|
Create an entity/order type email override |
Select Create to advance to the Create Entity Order Type Template Screen. |
Change an entity/order type email override |
Select Change for an existing override to advance to the Change Entity Order Type Template Screen. |
Display an entity/order type email override |
Select Display for an existing override to advance to the Display Entity Email Override Template Screen. |
Delete an entity/order type email override. |
Select Delete for an existing override to delete it. At the Confirm Delete window, select Yes to delete the record; otherwise, select No. |
Create Entity Order Type Template Screen
Purpose: Use this screen to create a new entity/order type email override by entering the template text to use for the order, shipment, order cancellation, or order line cancellation notification. You can also specify the “from” email alias and the XML only? settings.
Overrides other templates: If you set up an email override here, it overrides all other email setup at the entity, order type, or order level. See Email Setup within Order Management System for background on the hierarchies that apply to generating email or XML notifications.
How to display this screen: Select Create at the Entity Email Override by Order Type Screen.
Field | Description |
---|---|
Entity |
The code for the entity you selected at the Work with Entities Screen. Number: numeric, 3 positions; display-only. |
Description |
A description of the entity. Description: alphanumeric, 25 positions; display-only. |
Order Type |
Select the type of order to receive the notification for orders in the selected entity. Only order types whose Email notification flag is selected are available for selection. Note: The order type code is not displayed.Description: alphanumeric, 30 positions; required. |
Notification Type |
Select the type of notification you are creating for the entity/order type override. Available notice types are:
Required. |
XML Only? |
Indicates whether to generate the Outbound Email XML Message (CWEmailOut) rather than an actual email notification for notices generated for this order type and entity. This XML message includes additional information that is not included in the standard email notice. You might choose to generate the XML message so that you can use the additional information to produce a reformatted HTML email that includes promotional material. For more information see the Web Services Guide on My Oracle Support (ID 2149144.1)Valid values are:
Note: This setting applies only if this is the email text template used to generate the notification, as described under HTML Email or Outbound Email XML Message?See Outbound Email API for an overview, and see HTML Email or Outbound Email XML Message? for a discussion of when the system uses this setting as an override at the entity level. For more information see the Web Services Guide on My Oracle Support (ID 2149144.1) |
From Email Alias |
The alias to display with the “from” address for emails, for example, My Email Alias <no-reply@omni.retail.oraclecloud.com>. The actual “from” address is set by Oracle and cannot be changed. The system uses the following hierarchy in selecting the “from” email alias: uses the following hierarchy in selecting the “from” email alias:
You can enter an email alias in upper and lower case. See Email Address Validation for information on how the system verifies that your entry is formatted correctly. Default:
Alphanumeric, 50 positions; optional. |
Text To Print Above Items |
The standard text to include in each email above the information specific to the order; the system allows your entry in upper and lower case. See the HTML Format Notification Samples and Contents and the Simple Format Notification Sample. See Email Text Templates for information on the hierarchy that determines which text template to use. Setting a “from” email alias override works independently from the email template override. For example, you can override the “from” email alias and not the template, or vice versa. Alphanumeric, ten 60-position lines; optional. |
Text To Print Below Items |
The standard text to include in each email below the information specific to the order; the system allows your entry in upper and lower case. See the HTML Format Notification Samples and Contents and the Simple Format Notification Sample. Alphanumeric, three 60-position lines; optional. |
Completing this screen: To create an email override at the entity/order type level:
-
Select an Order Type.
-
Select a Notification Type.
-
Optionally, select the XML Only? flag to generate the Outbound Email XML Message (CWEmailOut) rather than an actual email notification.
For more information see the Web Services Guide on My Oracle Support (ID 2149144.1)
-
Optionally, enter a From Email Alias.
-
Optionally, enter the Text To Print Above Items and the Text To Print Below Items.
Note:
When you copy the text from the company-level or entity-level template, it overrides any text currently entered at the entity/order type level. If you then click OK, the system overwrites the previous entity/order type-level text. To restore the text, you need to enter it again.See the field descriptions above for more information.
Screen Option | Procedure |
---|---|
Default the email alias defined at the company level to the From Email Alias |
Select Dflt Frm Comp. |
Default the email alias defined at the entity level to the From Email Alias |
Select Dflt Frm Ent. |
Change Entity Order Type Template Screen
Purpose: Use this screen to change an existing entity/order type notification override that you set up through the Create Entity Order Type Template Screen.
Available options are:
-
change the setting of the XML Only? flag
-
enter, change, or delete the From Email Alias
-
change or delete the Text To Print Above Items or Text To Print Below Items. You can also edit the copied text as needed.
Note:
When you copy the text from the company-level or entity-level template, it overrides any text currently entered at the entity/order type level. If you then click OK, the system overwrites the previous entity/order type-level text. To restore the text, you need to enter it again.For more information: See the Create Entity Order Type Template Screen for field descriptions.
How to display this screen: Select Change for an existing notification override at the Entity Email Override by Order Type Screen.
Display Entity Email Override Template Screen
Purpose: Use this screen to review an existing entity/order type notification override that you set up through the Create Entity Order Type Template Screen.
You cannot change any information on this screen. See the Create Entity Order Type Template Screen for field descriptions.
How to display this screen: Select Display for an existing template at the Entity Email Override by Order Type Screen.
Working with Divisions (WDIV)
Purpose: You can use the Divisions function to:
-
add or maintain divisions and their descriptions
-
assign a division to an entity
Divisions are an important component of the Order Management System sales reporting hierarchy. Divisions can represent groups within business units (for example, winter, spring, summer, fall, and holiday within a business unit called Mail Order). If you are interested in grouping sales within an entity, create divisions. You must create at least one division per entity.
In this topic:
Example: Within a business unit called Mail Order, you want to keep sales information separate for employees and each of your 5 seasons. Set up 6 divisions: 1 division for employees and 5 divisions to represent each of your seasons.

Work with Divisions Screen
How to display this screen: Enter WDIV in the Fast Path field or select Work with Divisions from a menu.
Field | Description |
---|---|
Div (Division) |
A code that represents a division. Alphanumeric, 2 positions; optional. |
Description |
The description of the division code. Alphanumeric, 30 positions; optional. |
Screen Option | Procedure |
---|---|
Create a new division code |
Select Create to advance to the Create Division Screen. |
Change division information |
Select Change for a division to advance to the Change Division screen. At this screen you can change any information except the division code. See Create Division Screen for field descriptions. |
Delete a division |
Select Delete for a division to delete it. |
Display a division |
Select Display for a division to advance to the Display Division screen. You cannot change any information on this screen. See Create Division Screen for field descriptions. Select Dsp Div History to advance to the Display Division History Screen. |
Review division history |
Select History for a division to advance to the Display Division History Screen. |
Work with user defined fields |
Select User Field for a division to advance to the Work with User Fields Screen |
Create Division Screen
Purpose: Use this screen to create a division for an entity in your company.
How to display this screen: At the Work with Divisions Screen, select Create.
Field | Description |
---|---|
Division |
A code that represents a division. Alphanumeric, 2 positions. Create screen: required. Change screen: display-only. |
Description |
The description of the division. Alphanumeric, 30 positions; required. |
Entity |
The entity code to which this division is assigned. Validated against the Entity table; see Working with Entities (WENT). Numeric, 3 positions; required. |
Bank code |
The bank code used by this division. The system uses this bank code when it creates refund records. If you process orders in multiple currencies, each currency is associated with a unique bank; as a result, you must be sure to associate each division with a bank of the correct currency. See Working with Currency (WCUR), for a discussion on how to use the bank code when setting up your company for multi-currency orders. Alphanumeric, 3 positions; required. |
Display Division History Screen
Purpose: Use this screen to review performance statistics for a division. You cannot change or update any information on this screen.
How to display this screen:
-
select History for a division code at the Work with Divisions Screen
-
select Display Division History at the Change Division screen or the Display Division screen
Field | Description |
---|---|
Division |
A code that represents a division. Numeric, 2 positions; display-only. |
Sales to date |
Number of sales (invoices) for this division. This is a life-to-date figure. If the Consolidated Invoice (B49) system control value is selected, the system creates 1 invoice record for all items on an order that ship on a single day regardless of the number of picks associated with that order. Note: An order with multiple recipients (several ship-to addresses) has 1 order number. For an order with multiple recipients, 1 invoice record is created for all packages shipped in a single day. If the Consolidated Invoice system control value is unselected, then Order Management System creates an invoice record for every pick on an order that shipped on a single day. Note: In Order Management System 21.0 or higher, you cannot select the Consolidated Invoice system control value if it is not already selected. If the system control value is currently selected (set to Y) and you deselect it (change it to N or blank), you cannot then change it back to selected. The option to consolidate invoices will be removed at a later date.Numeric, 7 positions; display-only. |
Value sales to date |
Dollars in sales for this division. This is a life-to-date figure. Numeric, 20 positions with a 2-place decimal; display-only. |
Returns to date |
Number of returns and/or exchanges for this division. This is a life-to-date figure. Numeric, 7 positions; display-only. |
Value retrns to date (Value returns to date) |
Dollars in returns and/or exchanges for this division. This is a life-to-date figure. Numeric, 20 positions with a 2-place decimal; display-only. |
Sales today |
Number of sales (invoices) for this division since the last time you ran Daily Periodic Processing. Numeric, 7 positions; display-only. |
Value sales today |
Dollars in sales for this division since the last time you ran Daily Periodic Processing. Numeric, 20 positions with a 2-place decimal; display-only. |
Returns today |
Number of returns and/or exchanges for this division since the last time you ran Daily Periodic Processing. Numeric, 7 positions; display-only. |
Value retrns today (Value returns today) |
Dollars in returns and/or exchanges for this division since the last time you ran Daily Periodic Processing. Numeric, 20 positions with a 2-place decimal; display-only. |
Year |
Year in which the sales period occurs. Numeric, 2 positions, optional. |
Period |
The sales period within a specified year. Numeric, 2 positions, optional. |
Sales |
Number of sales (invoices) for this division for the year and period displayed. Numeric, 7 positions; display-only. |
Value sales |
Monetary value in sales for this division for the year and period displayed. Numeric, 20 positions with a 2-place decimal; display-only. |
Returns |
Number of returns and/or exchanges for this division for the year and period displayed. Numeric, 7 positions; display-only. |
Value retrns (Value returns) |
Monetary value in returns and/or exchanges for this division for the year and period displayed. Numeric, 20 positions with a 2-place decimal; display-only. |
Working with Pay Types (WPAY)
Working with Pay Types (WPAY)
Purpose: Use this option to perform the following for stored value card (gift card) or cash/check payment methods:
-
add or maintain these payment methods and their descriptions
-
specify an alternate refund pay type if your company allows you to change the method by which you refund the customer
-
indicate the minimum dollar value and the maximum dollar amounts for which your company will produce a refund
-
specify the characteristics of credit cards that your company accepts as a method of payment including the limits, if any, for reauthorizing a credit card order and the authorization and deposit services
-
specify the financial conditions under which an order will go on hold (for example, dollar amount limits, balance due)
-
specify the cross-reference for a ChannelAdvisor marketplace, so that orders originating in that marketplace are assigned the matching payment method, and specify whether to calculate tax and shipping at the item level or the order level.
Card number layout: You can also use this option define the format for displaying card numbers on screens and reports in Order Management System.
Note:
You cannot use the Work with Pay Types option for creating or changing credit card or wallet pay types; instead, you need to use the Payment Configurations options in Modern View. See the Modern View online help for more information. However, you can display existing credit card or wallet types.Pay type versus pay category: A pay type defines a specific method of payment such as check, cash, Visa, Mastercard, American Express, etc. Each pay type is assigned to a pay category.
Valid pay categories are:
-
Cash/Check
-
Credit Card (used for stored value cards)
Charging against pay types: When billing each pay type on a multi-paytype order, the system automatically assigns charge sequences to different payment categories as follows:
Payment Method | Pay Category | Default Charge Sequence |
---|---|---|
Cash or check |
Cash/Check |
1 |
Stored value card |
Credit Card |
2 |
Credit card (any Card type besides a stored value card) |
Credit Card |
3 |
In addition, the system assigns the charge sequence for the “catch-all” payment method the highest charge sequence. For example, if the charge sequence for a check is 10, the system updates the charge sequence for the credit card on the order to 11 (provided the credit card is the “catch-all”).
In this topic:
Work with Pay Types Screen
How to display this screen: Enter WPAY in the Fast path field at the top of any menu or select Work with Pay Types from a menu.
Field | Description |
---|---|
Type |
A code that represents the pay type. Numeric, 2 positions; optional. |
Description |
The description of the pay type. Alphanumeric, 30 positions; optional. |
Category |
A code for a category of pay type. Valid values:
Optional. |
Screen Option | Procedure |
---|---|
Create a pay type code |
Select Create to advance to the Create Pay Type Screen. You can create only cash/check or stored value card pay types through this screen. Use the Payment Configurations option in Modern View to create credit card, debit card, or wallet pay types. |
Change pay type information |
Select Change for a pay type to advance to the Change Pay Type screen. At this screen you can change any information except the pay type code. See the Create Pay Type Screen for field descriptions. You can change only cash/check or stored value card pay types through this screen. Use the Payment Configurations option in Modern View to change credit card, debit card, or wallet pay types. |
Delete pay type information |
Select Delete for a pay type to delete it. You can delete only cash/check or stored value card pay types through this screen. Use the Payment Configurations option in Modern View to delete credit card, debit card, or wallet pay types. |
Display pay type information |
Select Display for a pay type to advance to the Display Pay Type screen. You can display any pay type; however, you cannot update any information on this screen. See Create Pay Type Screen for field descriptions. |
Work with credit card number format |
Select CC # Format for a Credit Card pay category pay type to advance to the Credit Card Number Format. An error message indicates if the pay
type is not a Credit Card pay category pay type: |
Work with user defined fields |
Select User Field for a pay type to advance to the Work with User Fields Screen. |
Create Pay Type Screen
Purpose: Use this screen to create a cash/check or stored value card (gift card) pay type code.
How to display this screen: At the Work with Pay Types Screen, select Create.
Field | Description |
---|---|
Pay type |
A code that represents a pay type, such as a check, credit card, or stored value card. Numeric, 2 positions. Create screen: required. Change screen: display-only. |
Desc (Description) |
The description of the pay type. Alphanumeric, 30 positions; required. |
Category |
The category of the pay type. Valid values are:
Required. |
Alt refund type (Alternate refund type) |
The pay type to use for refunds to this pay type. Complete this field only if the pay type for refunds is different from the pay type used on the order. The system checks the appropriate values defined for the alternate refund pay type, not the original pay type, when generating refunds. The alternate refund type must be a pay
category of Cash/Check or Stored Value Card for Card type Stored
Value. The system displays an error message if you enter an invalid
alternate refund type: Numeric, 2 positions; optional. |
Alt refund category (Alternate refund category) |
The pay category to which the system-generated refund can be charged during refund maintenance. Valid values are:
When you define an alternate refund category for a pay type, you give yourself the option of changing the refund to the type that corresponds to this category. The alternate refund category must be a pay category of Cash/Check. Optional. |
Authorization service |
A code for the service bureau that authorizes or declines credit card charges. Alphanumeric, 3 positions; optional. |
Credit card length |
The required length of the stored value card number. You can require any length up to 20 positions. Note: The system does not validate the credit card length if you enter a 0 in this field.Numeric, 2 positions; optional. |
Deposit service |
A code for the service bureau that performs stored value card deposits for this pay type. Alphanumeric, 3 positions; optional. |
Leading digits |
The first digits numbers of a valid stored value card number. You can enter up to 4 leading digits. Numeric, 4 positions; optional. |
Reauthorization days |
The number of days before a stored value card authorization expires. Note: If online authorization is enabled, you should specify this number of days for a payment method in order to prevent repeated, unnecessary authorization requests. If this field is blank for a stored value card pay type, the authorization expires immediately. Also, if the order is submitted to Order Broker for fulfillment, there will be unsuccessful authorization attempts.The REAUTH periodic function uses this date to determine when to attempt to reauthorize an expired authorization. Only pay types that have this field set to a number greater than 0 are eligible for reauthorization attempts. See Reauthorizing Expired Authorizations for more information. Numeric, 3 positions; optional. |
Modulus check |
This setting indicates if the system performs a calculation against the digits of the stored card number to ensure that the card is valid. Valid values are:
If you enter MU in this field, the system uses the program
name from the User Defined Modulus Check Program (E94) system
control value. An error message indicates if a program name has not
been defined: Note: The system cannot perform a modulus check against the number if the number includes spaces; for example: 4111 1111 1111 1111. To perform a modulus check, you must enter the number without any spaces between the numbers; for example: 4111111111111111.Optional. |
Require start date |
Indicates whether to require a start date when the customer uses this stored value card pay type. For example, you might use a start date for a stored value card to indicate the first date when the card is effective. If a start date is required but not entered, the system displays an error message in order entry or maintenance:
The start date is a four-position date in MMYY format, similar to the expiration date. Select this flag if you want to require a start date for this pay type. This is a valid selection only if the pay type is a stored value card. Do not select this field if you do not want to require a start date for the pay type. Note:
|
Card type |
Indicates the type of credit card. The only valid value for a credit card pay type is Stored Value: Stored Value Card (see Stored Value Card Overview and Setup). You cannot enter a card type for a cash/check pay type. You can define a credit card number format to specify how the credit card number should display on Order Management System screens and reports for all card types; see Credit Card Number Format for instructions. Required for stored value card pay types. |
Require expiration date |
Indicates whether to require an expiration date when the customer uses this stored value card pay type. If an expiration date is required but not entered, the system displays an error message in order entry or maintenance:
The expiration date is a four-position date in MMYY format.
|
Send reversal |
Defines whether the REVERSE Send Reversals for Expired Authorizations (program name PFR0133) periodic function processes all open Authorization History records for this pay type that are eligible for authorization reversal.
See the REVERSE Send Reversals for Expired Authorizations periodic function for processing information. Note: This setting does not affect Stored Value Card Reversal with the External Payment Service. |
Require issue # |
Indicates whether to require an issue number when the customer uses this credit card pay type. Some banks assign an incremental issue number when they replace a card because it is lost or stolen. Select this flag if you want to require an issue number for this pay type. This is a valid selection only if the pay type is a credit card. Do not select this flag if you do not want to require an issue number for the pay type. If an issue number is required but not entered in order entry or order maintenance, the system displays an error message:
Note:
|
Notify of installments |
CyberSource:
Indicates whether to send a Important: To determine how to set this flag if you offer deferred or installment billing and use CyberSource, you need to confirm the information that the end processor requires for deferred or installment payment plans for each payment type. Possible settings are:
External Payment Service: Indicates whether to send a
For more information: See: Note: You need to verify that the end processor supports the selected option. |
Bal due $ limit (Balance due dollar limit) |
If a customer short pays an order by an amount equal to or greater than this amount, the system places the order automatically on BD (Balance Due) hold. Note: Orders are evaluated for Bal due $ limit (Balance due dollar limit) and Bal due % limit (Balance due percentage limit). Balance due % limit takes precedence over balance due $ limit, so the system puts the order on hold when it is underpaid by the percentage even if it not underpaid by the dollar amount. When you apply a cash/check payment method:
Example: A customer underpays a $1,250.00 order by $25.00. The Balance due $ limit is $5.00; however, the Balance due % limit is 5%. Five percent of this order is $62.50. This order will not go on hold. The customer has underpaid by more than the Balance due $ limit but less than the Balance due % limit. Note: If the underpaid amount is less than the amount specified here (and there is no Bal due % limit specified), the order does not go on hold. The system creates a balance due record (negative refund record) and puts this record into a write-off pending status. These refund write-off amounts accumulate for the sold-to customer, and can be applied to a subsequent order as an additional charge. The Default Additional Charge Code (C45) to be used in these instances is specified in the System Control table.Numeric, 13 positions with a 2-place decimal; optional. |
Order $ limit (Order dollar limit) |
If the order total meets or exceeds this dollar amount, the system places the order on dollar hold, regardless of the pay category (cash/check or credit card). Multi-pay orders: If there is more than one payment method on the order, the system places the order on hold if the order total meets or exceeds the Order $ limit for any pay type. Example: The order total is $200.00, and the customer sends a $50.00 check and puts the balance on a credit card. The Order $ limit for the check pay type is $150.00, and the Order $ limit for the credit card is $250.00. The system places the order on hold, because the order total of $200.00 meets or exceeds the Order $ limit of $150.00 for the check pay type (even though the check payment amount is less than the Order $ limit). Cash/check orders: The system evaluates both Order $ limit and Hold days. Order $ limit takes priority over Hold days. Example: The order total is $350.00 and the customer pays by check. Order $ limit is $225.00; Hold days is 5. Six days pass; this order will still be on hold. This customer order meets the value specified in Hold days but still exceeds the Order $ limit specified in this table. The system does not check this setting if:
Numeric, 13 positions with a 2-place decimal; optional. |
Bal due % limit (Balance due percentage limit) |
If a customer underpays on an order by a percentage equal to or greater than this amount, the system places the order on hold. Note: Orders are evaluated for both Bal due $ limit (Balance due dollar limit) and Balance due % limit. Balance due % limit takes priority over balance due $ limit. See the Bal due $ limit (Balance due dollar limit) for a discussion.Numeric, 13 positions with a 2-place decimal; optional. |
Hold days |
The number of days to hold an order while waiting for a check to clear the bank. The system releases the order from hold automatically through Daily Periodic Processing once the number specified here has passed. Note: Cash/check orders are evaluated for both Order $ limit (Order dollar limit) and Hold days. Order $ limit takes priority over Hold days.Numeric, 3 positions; optional. |
Ref chk min (Refund check minimum) |
The minimum dollar amount for which you issue a refund. Refunds less than this amount are put in a write-off pending status. These write-off amounts accumulate in the Customer Sold-to table and can be used as an order credit on a subsequent order. The Default Cash Pay Type (C07) to be used in these instances is indicated in the System Control table. If a pay type has an alternate refund type, the system checks the refund check minimum for the alternate refund type. Numeric, 13 positions with a 2-place decimal; optional. |
Ref chk max (Refund check maximum) |
The maximum dollar amount for automatic refund creation. Any refund exceeding this dollar amount is put on hold. For example, if you leave this field blank for a credit card alternate refund type, all refunds will go on hold because they exceed the blank (zero) amount. If a pay type has an alternate refund type, the system checks the refund check minimum for the alternate refund type. Numeric, 13 positions with a 2-place decimal; optional. |
Release days |
The number of days to hold a refund from processing. The system changes the status of the refund to “open” when you process the refund if the release days have passed. This feature ensures that the customer's check for the order clears before you print a refund check for the overpayment. If a pay type has an alternate refund type, the system checks the refund check minimum for the alternate refund type. Numeric, 3 positions; optional. |
Store tender |
A cross-reference to the corresponding tender code in a point-of-sale system. This field is available only if you specify a Default Location for ORCE Integration (K69). This code is passed in the POSLog integration to Customer Engagement as the tender ID, which can be used as a loyalty qualifier. Alphanumeric, 4 positions; optional. |
CA cross reference # |
A cross-reference to a ChannelAdvisor marketplace, set up through Work with ChannelAdvisor Offers Screen, from which you receive orders:
If more than one pay type has the same matching cross-reference, the periodic function selects the pay type with the highest pay type code. Cash/check category: If a CA cross reference # is specified, the pay type Category must be Cash/Check. See ChannelAdvisor Integration Overview and ChannelAdvisor Setup. This field is available only if the ChannelAdvisor Order Type (L90) system control value specifies an order type. If you enter a value in this field, then the CA type field is required. Alphanumeric, 40 positions; optional. |
CA type |
Controls how the CAORDUP periodic function calculates shipping and tax, and how refund amounts are passed when Submitting Refunds for ChannelAdvisor Orders. If this field is set to:
This field is available only if the ChannelAdvisor Order Type (L90) system control value specifies an order type. If a CA cross reference # is specified for the pay type, then this field is required. |
Credit Card Number Format
Credit card number formats allow you to specify which digits of a credit card number are masked on Order Management System screens and reports using a special character, such as an asterisk (*). For example, you may wish to mask all but the last 4 digits of a 16-digit credit card number: ************1111.
Data security: You should set up a masking format for all credit cards. See Guidelines for Data Security in the Security document for a checklist of recommended data security settings.
Tokenization: If you use credit card tokenization, the number that is masked is a token, rather than the actual credit card number.
Defining a format: You can use the Credit Card Number Layout Screen to define which digits of the credit card number on Order Management System screens and reports are masked. You can define a separate credit card number format for each Credit Card pay category pay type and also define a default format to use for those Credit Card pay category pay types that do not have a credit card number format defined.
When a credit card number displays on a screen or report, the system looks at the pay type associated with the credit card number to determine which digits of the credit card number are masked. If the system cannot determine the pay type associated with the credit card number, the credit card number displays in the default credit card number format.
When is the credit card number masked?
-
Order Management System masks the credit card number using the specified credit card number format on all Order Management System screens if you do not have authority to the Display Full Credit Card Number (B14) secured feature.
-
Order Management System masks the credit card number using the specified credit card number format on all Order Management System reports, regardless of your authority to the Display Full Credit Card Number (B14) secured feature.
When is the credit card number unmasked? Even if a credit card number format is defined, the credit card number will display unmasked, meaning the entire number displays, in the following places:
-
All Order Management System XML messages. The full credit card number must display because the number is being sent to or received from an external system. However, for credit card numbers in the Outbound Email XML Message (CWEmailOut), all but the last four positions of the credit card number are replaced with asterisks (*), regardless of any credit card number masking defined.
For more information see the Web Services Guide on My Oracle Support (ID 2149144.1).
-
The Order Management System database (tables). However, if you use credit card encryption and data security, the credit card number will be encrypted in the Order Management System database, providing additional security of credit card data.
-
Stored Value Card Notification Email. This email is generated when you purchase a virtual stored value card or send an early notification email with the card number. For virtual stored value cards, this email is the only notification that a stored value card has been activated for a customer. The customer must be able to view the entire stored value card number in order to use the card on a future purchase.
-
The Stored value card number field on the Stored Value Card Assignment Screen, since you are in the process of entering the stored value card numbers for activation.
Credit card numbers in the database: Regardless of whether you use credit card encryption, the system masks the credit card number in the Order Management System database, storing it in varBinary format. If you use credit card encryption to encrypt the credit card number in the Order Management System database, you cannot unmask the credit card number in the database to view it.
Credit card encryption: Credit card encryption allows you to encrypt credit card numbers in the Order Management System database to provide additional security for credit card data. You can define a credit card number format, regardless of whether you are using credit card encryption and data security. If you enable credit card encryption, the system encrypts the credit card number in the Order Management System database, providing additional security of credit card data. In order to display the encrypted credit card number on Order Management System screens and reports, the system must first decrypt the credit card number and then apply the credit card number format. See the Data Security and Encryption Manual on My Oracle Support (1988467.1) for an overview.
Which Cards are Eligible for Credit Card Number Formatting?
Eligible cards: You can define a credit card number format for the following types of Credit Card pay category pay types:
-
Credit card (Card type Credit)
-
Debit (Switch) card (Card type Debit)
-
Stored value card (Card type Stored Value)
Ineligible cards: You receive the error
message Not available for this pay type
if you
try to define a credit card number format for any non-pay category
Credit Card pay type.
Credit card number scan screens: You can scan on credit card number at the following Order Management System screens:
However, if you have defined a credit card number format, the credit card numbers that display on the bottom half of the scan screen will be masked by the associated credit card number format.
In addition, if you have credit card encryption enabled, the system will not find a credit card number match unless you enter the full credit card number in the scan field. The credit card number you entered in the scan field is display-only at the top of the screen and the credit cards that display at the bottom of the screen are masked by the associated credit card number format.
Note:
If you use credit card tokenization, you will not be able to scan on the full credit card number on these screens since the credit card number has been replaced with a token. Instead, you can scan on the last four digits of the credit card number on these screens; the system advances you to the Scan By CC Last 4 screen, where you can review orders that contain a credit card payment whose CC Last 4 field in the Order Payment Method table matches the last four digits of the credit card number that you entered in the scan field.Secured Features
The Display Full Credit Card Number (B14) secured feature controls whether the full credit card number displays on Order Management System screens.
-
If you allow access to this feature, you can view the full credit card number on Order Management System screens, regardless if a credit card number format has been defined at the Credit Card Number Layout Screen. If you use credit card tokenization, the number that displays is a token, rather than the actual credit card number.
-
If you prohibit access to this feature (default setting), the credit card number displays in the credit card number format specified at the Credit Card Number Layout Screen for the specified pay type. If a credit card number format is not defined for the pay type, the number displays in the default credit card number format. However, if a credit card number format has not been defined for the pay type and a default credit card number format is not defined, the full credit card number will display on Order Management System screens. If you use credit card tokenization, the number that displays is a token, rather than the actual credit card number.
Reports: Regardless of a user’s authority to the Display Full Credit Card Number (B14) secured feature, the system masks the credit card number in the credit card number format specified at the Credit Card Number Layout Screen for the specified pay type on all Order Management System reports.
Restrict access to credit cards in OIOM: Regardless of the setting of this secured feature, if you do not have authority to the Restrict Access to Credit Card Numbers in OI and OM (A88) secured feature, the credit card number and expiration date will not display in order entry, order maintenance, or standard or streamlined order inquiry.
Setting Up a Credit Card Number Format
Use the Unformatted credit card number positions field on the Credit Card Number Layout Screen as a layout of the number of positions in the Credit card number field. There are 20 positions available in a credit card number that you can select to display or mask with a special character.
Note:
Even if a credit card number only includes 16 digits, you will still be required to enter a value in positions 17-20 of the credit card number format. Enter17, 18, 19
, and 20
in the respective fields if you do not want a special
character to display.
To create or change:
-
At the Work with Pay Types Screen, select CC# Format for a Credit Card pay category pay type to advance to the Credit Card Number Layout Screen.
-
In the Formatted credit card number positions fields, decide which digits of the credit card number you wish to display and enter the digit number in the appropriate field. For example, if you wish to display the last 4 digits of a 16-digit credit card number, enter 13 in field 13, 14 in field 14, 15 in field 15, and 16 in field 16.
-
In the Formatted credit card number positions fields, decide which digits of the credit card number you wish to mask and enter a special character in the appropriate field. You can enter any special character, such as an asterisk (*) or a number sign (#) as well as any letter, such as C. However, you cannot use a number to mask a credit card number. For example, if you wish to mask all but the last 4 digits of a 16 digit credit card number using an asterisk, enter * in fields 1-12 and enter 13, 14, 15, and 16 in the respective fields.
Note:
You cannot mask the digits of a credit card number using a number. If you enter a number between 1 - 20 in any of the Formatted credit card number positions fields, the system will display that digit of the credit card number in the position specified. For example, if you enter 9 in field 1, the system will display the 9th digit of the credit card number in position 1 and not the number 9. You will receive an error if you enter a number greater than 20:Only one character or number 1-20 allowed per position.
-
Select OK to validate your entries. You must enter a number between 1and 20 or a special character in each of the Formatted credit card number positions fields.
To delete: To delete a credit card number format, clear the data in all of the Formatted credit card number positions fields and select OK.
If you delete a credit card number format, but still have a default credit card number format defined, the credit card number will display in the default format on Order Management System screens and reports.
Creating a Default Credit Card Number Format
If you wish to assign most of your Credit Card pay category pay types to the same credit card number format, you can create the format and select the Set as default format field. Any Credit Card pay category pay type that does not have a credit card number format defined, will use the default credit card number format.
You can create only 1 default credit card number format. If you flag a credit card number format as the default and then create a new credit card number format and flag it also as the default, the system advances you to the Override Default window, where you must confirm that you wish to change the default credit card number format.
Select Accept to change the default credit card number format; otherwise, select Exit to keep the current default credit card number format.
If you wish to create a default credit card number format, but
still display the entire credit card number for one of your Credit
Card pay category pay types, create a credit card number format for
that pay type and enter all of the credit card digits in the Formatted credit card
number positions fields: 1 2 3 4 5 6 7 8 9 10
11 12 13 14 15 16 17 18 19 20
. The system will display the
entire credit card number on Order Management System screens
and reports.
If you do not define a default credit card number format, and a format has not been defined for a Credit Card pay category pay type, the system displays the full credit card number for that pay type on Order Management System screens and reports.
Credit Card Number Format Examples
The table below displays examples of credit card number formats.
Credit Card Format | Formatted credit card number positions fields | Credit Card Display |
---|---|---|
Mask the credit card number using the number sign. |
# # # # # # # # # # # # # # # # # # # # |
If the number is 4111111111111111, it displays as: #################### |
Display the full credit card number. |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 Note: You may wish to define this format if you have also defined a default credit card number format and you want to display the full credit card number for this pay type. For example, you may wish to display all stored value card numbers. |
If the number is 4111111111111111, it displays as: 4111111111111111. |
Only display the last 4 digits of a 16-digit credit card number. For all other digits, display an asterisk. |
* * * * * * * * * * * * 13 14 15 16 17 18 19 20 |
If the number is 4111111111111111, it displays as: ************1111 |
Display all but the last 4 digits of a 16-digit credit card number. For all other digits, display an asterisk. |
1 2 3 4 5 6 7 8 9 10 11 12 * * * * 17 18 19 20 |
If the number is 4111111111111111, it displays as: 411111111111**** |
Only display the first 4 digits and the last 4 digits of a 16-digit credit card number. For all other digits, display an asterisk. |
1 2 3 4 * * * * * * * * 13 14 15 16 17 18 19 20 |
If the number is 4111111111111111, it displays as: 4111********1111 |
Display all of the digits in a 16-digit credit card number, but display the first 4 digits in the last 4 positions and the last 4 digits in the first 4 positions. |
13 14 15 16 5 6 7 8 9 10 11 12 1 2 3 4 17 18 19 20 |
If the number is 4788250000121443, it displays as: 1111111111114111 |
Credit Card Number Layout Screen
Use this screen to create a credit card number format; see Credit Card Number Format for an overview and setup instructions.
How to display this screen: Select CC# Format for a Credit Card pay category pay type at the Work with Pay Types Screen.
Field | Description |
---|---|
Pay type |
The code and description of the credit card pay type assigned to the credit card number layout. Pay type code: Numeric, 2 positions; display-only. Description: Alphanumeric, 30 positions; display-only. |
Set as default format |
Indicates if you wish to set this credit card number format as the default format. Any Credit Card pay category pay type that does not have a credit card number format defined, will use this format.
If you select this flag and a default credit card number format already exists, the system advances you to the Override Default Window, where you can confirm that you wish to change the default credit card number format. Note: If you do not define a default credit card number format, and a format has not been defined for a Credit Card pay category pay type, the system displays the full credit card number for that pay type on Order Management System screens and reports. |
Unformatted credit card number positions |
Displays the number of positions available to format in a credit card number. Use this field as a reference when creating the credit card number format in the Formatted credit card number positions field. Alphanumeric, 20 positions; display-only. |
Formatted credit card number positions |
The position and format of each of the credit card digits to display on Order Management System screens and reports. For example, to display only the last 4 digits of a 16 digit credit card number, enter a special character, such as an asterisk (*) in fields 1 - 12. Enter the digit number in fields 13 - 20.
If the credit card number is 411111111111111,
the system displays Note: You must enter either a digit number (1-20) or a single position special character in each field or an error message displays:Only one character or number 1-20 allowed per position. See Setting Up a Credit Card Number Format for setup instructions and examples. Numeric, 20 positions; required. |
Working with Banks (WBNK)
Purpose: Use the Banks function to:
-
add or maintain bank codes and their descriptions
-
indicate the transit number associated with the bank
-
define the currency for the bank, if you process orders in multiple currencies
-
define the inbound and outbound reconciliation programs, if you send and receive refund check information to and from a bank
If using multiple currencies by offer: The bank code is key to your setup if you process orders in multiple currencies. The system determines that you intend to process orders in multiple currencies if the Multi Currency by Offer (E03) system control value is selected.
When processing orders in multiple currencies, you must create a separate bank for each currency you intend to use, including your local currency.

Processing refunds: Each time you create a refund record, the system associates the refund with the appropriate bank.

For more information:
-
working with currency codes: Working with Currency (WCUR)
-
working with refunds: Working with Refunds, Writeoffs and Balances Due (WREF)
-
Multi Currency by Offer (E03) system control value
In this topic:
Work with Banks Screen
How to display this screen: Enter WBNK in the Fast Path field at the top of any menu or select Work with Banks from a menu.
Field | Description |
---|---|
Bank |
A code that represents the bank. Alphanumeric, 3 positions; optional. |
Description |
The description of the bank code. Alphanumeric, 30 positions; optional. |
Transit# |
The transit number, provided by the bank. Numeric, 25 positions; optional. |
Screen Option | Procedure |
---|---|
Create bank codes |
Select Create to advance to the Create Bank Screen. |
Change bank information |
Select Change for a bank to advance to the Change Bank screen. At this screen you can change any information except the bank code. See Create Bank Screen for field descriptions. |
Delete a bank |
Select Delete for a bank to delete it. |
Display bank information |
Select Display for a bank to advance to the Display Bank screen. You cannot update any information on this screen. See Create Bank Screen for field descriptions. |
Create Bank Screen
Purpose: Use this screen to create a bank.
How to display this screen: At the Work with Banks Screen, select Create.
Field | Description |
---|---|
Bank # |
A code that represents the bank. Numeric, 3 positions. Create screen: required. Change screen: display-only. |
Description |
The description of the bank code. This is commonly the name of the bank. Alphanumeric, 30 positions; required. |
Transit # |
The transit number, provided by the bank. Numeric, 25 positions; required. |
Account # |
Your account number with the bank. Numeric, 12 positions; optional. |
Last check # |
The last refund check number printed. When you process refund checks for this bank, the system suggests the next sequential number after the value here. When refund check generation is complete, the system updates this field with the last number used. Numeric, 9 positions; required. |
Phone number |
The phone number for the bank. Numeric, 14 positions; optional. |
Currency code |
The code representing the currency to be processed by this bank. This field displays only if the Multi Currency by Offer (E03) system control value is selected. See Working with Currency (WCUR). Alphanumeric, 3 positions; required if using multiple currencies. |
Country |
The code representing the country where the bank is located. The bank code from the Default Country for Customer Address (B17) system control value defaults. Alphanumeric, 3 positions; optional. |
Working with Accounting Periods (WACP)
Purpose: Use the Accounting Periods function to define your fiscal calendar. Specifically, use this function to:
-
add or maintain accounting periods and their descriptions
-
assign accounting periods to a year
-
indicate the start date and end date of the period
Transactions post to the accounting period in which they occur, even if your accounting department has not closed the previous accounting period.
In this topic:
Work with Accounting Periods Screen
How to display this screen: Select Work with Accounting Periods from a menu or enter WACP in the Fast Path field at the top of any menu.
Field | Description |
---|---|
Year |
Year when the accounting period occurs. Numeric, 2 positions (YY); optional. |
Period |
A 2-position code that represents the accounting period. Alphanumeric, 30 positions; optional. |
Desc (Description) |
The description of the accounting period. Alphanumeric, 3 positions; optional. |
Start |
The date when the accounting period begins. Numeric, 6 positions (in user date format); optional. |
End |
The date when the accounting period ends. Numeric, 6 positions (in user date format); optional. |
Note:
The options on this screen function somewhat differently from other screens. See the table below for details.Screen Option | Procedure |
---|---|
Create an accounting period |
Select Create to advance to the Create/Change/Display Accounting Period Screen in create mode. |
Change accounting period information |
Select Change from the Action column on the left to advance to the Create/Change/Display Accounting Period Screen in change mode. |
Delete an accounting period |
Select Delete from the Action column on the left to delete an accounting period. |
Display an accounting period |
Select Display from the Action column on the left to advance to the Create/Change/Display Accounting Period Screen in display mode. |
Create/Change/Display Accounting Period Screen
Purpose: Use this screen to create, change, or display an accounting period.
How to display this screen: Select Create at the Work with Accounting Periods Screen, or select Change or Display from the Action column on the left. See Changing Accounting Periods and Displaying Accounting Periods for information on available options in change and display modes.
Field | Description |
---|---|
Year |
The year when the accounting period occurs. Numeric, 2 positions (YY). Create mode: required. Change mode: display-only. |
Period |
A 2-position code that represents the accounting period. Numeric, 2 positions. Create mode: required. Change mode: display-only. |
Description |
The description of the accounting period (e.g., JAN, FEB, Q1, Q2). Alphanumeric, 3 positions; required. |
Start date |
The date the accounting period begins. Numeric, 6 positions (in user date format); required. |
End date |
The date the accounting period ends. Numeric, 6 positions (in user date format); required. |
Changing Accounting Periods
To change: Select Change for an accounting period from the Action column on the left at the Work with Accounting Periods Screen to advance to the Create/Change/Display Accounting Period screen in change mode. You cannot change the year or period fields.
Displaying Accounting Periods
To display: Select Display for an accounting period from the Action column on the left at the Work with Accounting Periods Screen to advance to the Create/Change/Display Accounting Period screen in display mode. You cannot update any information.
Working with Currency (WCUR)
Purpose: Use the Currency table to define currencies and their conversion rates.
The system uses this information when:
-
you create purchase orders, to convert your currency rate to your vendor's currency rate
-
you receive against a purchase order, to convert your vendor's currency rate to your currency rate
-
you bill orders, if the Customer Sold To on the order is from a foreign country
-
you enter orders, bill orders, or process refunds, if you track multi-currency by offer
Note:
If you track currency conversion rates at the time of order billing in the Invoice Currency table, you must use the same code to identify a country and its currency. You must also have the Track Invoice Currency (D68) field in the System Control table selected. See Setting Up the Country Table (WCTY) for more information on country codes.Multiple Currencies by Offer: You can accept orders in various currencies by defining the currency to be used for each offer. You must set the Multi Currency by Offer (E03) system control value to Y. Setting up multiple currencies by offer enables you to take orders in a foreign currency, but track demand in your local currency.
Default decimal separator and thousand separator for currency: The system uses the following values to determine the default decimal separator and thousand separator of Order Management System.
-
The DECIMAL_SEPARATOR property defines the character used to indicate the decimal place in a number.
-
The THOUSAND_SEPARATOR property defines the character used to separate groups of thousands.
The supported thousand and decimal separators are displayed below.
Default Thousand Separator | Default Decimal Separator | Results |
---|---|---|
, (comma) |
. (period) |
4,294,967,295.00 |
. (period) |
, (comma) |
4.294.967.295,00 |
See Regional Settings for an overview and see Setting the Default Decimal and Thousand Separator Formats for more information on how numbers display in different areas of the application.
In this topic:
Work with Currency Screen
How to display this screen: Enter WCUR in the Fast path field at the top of any menu or select Work with Currency from a menu.
Field | Description |
---|---|
Code |
A code that represents the currency. Alphanumeric, 3 positions; optional. |
Description |
The description of the currency code. Alphanumeric, 30 positions; optional. |
Last update |
The date that a conversion rate was most recently updated. Numeric, 6 positions; optional. |
Conversion rate |
The rate at which this currency is converted to the local currency. Should be set to 1.00 for the Local Currency Code (A55). Numeric, 13 positions with a 7-place decimal; display-only. |
Screen Option | Procedure |
---|---|
Create currency codes |
Select Create to advance to the Create Currency Screen. |
Change currency information |
Select Change for a currency code to advance to the Change Currency screen. At this screen you can change any information except the currency code. See Create Currency Screen for field descriptions. |
Delete currency information |
Select Delete for a currency code to delete it. |
Display currency information |
Select Display for a currency code to advance to the Display Currency screen. You cannot update any information on this screen. See Create Currency Screen for field descriptions. |
Create Currency Screen
Purpose: Use this screen to create a currency code.
How to display this screen: At the Work with Currency Screen, select Create.
Field | Description |
---|---|
Currency code |
A code that represents a type of currency. Alphanumeric, 3 positions. Create screen: required. Change screen: display-only. |
Description |
The description of the currency code. Alphanumeric, 30 positions; required. |
Date of last update |
The most recent date on which the conversion rate was updated. Note: The system does not update this field.Numeric, 6 positions (in user date format); required. |
Conversion rate |
The rate at which this currency is converted to the local currency in purchase order maintenance and receipts. The system divides the amount in the foreign currency by the conversion rate to determine the amount in your local currency; for example, if you set the conversion rate for Canadian dollars at 1.3, the system would convert $10.00 to $7.69 in your local currency, dividing 10 by 1.3. Should be set to 1.00 for the Local Currency Code (A55). Currency conversion settings for purchase order maintenance and receiving are defined in the Vendor table. See Working with Vendors (WVEN) for more information. Note: This field does not support a number with more than four positions in front of the decimal point; otherwise, your entry will be truncated. For example, if you enter 12345.1234567, it will be truncated to 2345.1234567.Numeric, 13 positions with a 7-place decimal; required. |
Shadow entity |
This field displays only if the Multi Currency by Offer (E03) system control value is selected; it is required for all currencies except your local currency, as defined in the Local Currency Code (A55) field in the System Control table. Entity codes are defined in and validated against the Entity table; see Working with Entities (WENT). Numeric, 3 positions; required. |
Working with Sales Representatives (WSLS)
Purpose: Use the Sales Representatives function to create or maintain sales representative information:
-
the name and email address of your sales representatives
-
the sales representative numbers that you assign to them
-
the centers to which your sales representatives are assigned (for example, regional centers or product line groups)
-
the commission and bonus structure for your sales representatives.
Uploading sales representatives: You can also create or update records in the Salesman table by uploading them from an external system; see Salesman Associate Upload for instructions.
In this topic:
Work with Salesrep Screen
How to display this screen: Enter WSLS in the Fast path field at the top of any menu or select Work with Salesreps from a menu.
Field | Description |
---|---|
SLS# (Sales representative number) |
A code that represents the sales representative. Numeric, 7 positions; optional. |
Name |
The name of the sales representative. Alphanumeric, 30 positions; optional. |
Center |
A code that represents the center to which this sales representative is assigned. Center codes can be used to group sales representatives (for example, region or product line). Alphanumeric, 4 positions; required. |
Screen Option | Procedure |
---|---|
Create sales representative codes |
Select Create to advance to the Create Salesrep Screen. |
Change sales representative information |
Select Change for a salesrep to advance to the Change Salesrep screen. At this screen you can change any information except the sales representative code. See Create Salesrep Screen for field descriptions |
Delete sales representative information |
Select Delete for a salesrep to delete it. |
Display sales representative information |
Select Display for a salesrep to advance to the Display Salesrep screen. You cannot change any information on this screen. See Create Salesrep Screen for field descriptions. |
Create Salesrep Screen
Purpose: Use this screen to create a new sales representative.
How to display this screen: Select Create on the Work with Salesrep Screen.
Field | Description |
---|---|
Salesrep # |
A code that represents a sales representative. The system performs a modulus 10 check against the salesrep number on the Create or Change Salesrep screen when the Modulus 10 Check on Salesrep Number (E88) system control value is selected. An error message indicates if the salesrep number fails the modulus 10 check: Salesman# is invalid or missing. Numeric, 7 positions. Create screen: required. Change screen: display-only. |
Name |
The description of the sales representative code. This is commonly the name of the sales representative. Alphanumeric, 30 positions; required. |
Email Address |
The salesrep’s email address. The system verifies that:
If the email address does not meet these criteria, the system does not let you create it. For example, the system would not let you create an email address such as:
The system does not confirm that your entry represents a valid email address, that the domain name (such as “example” in example.com) exists, or that the extension (such as “com” in example.com) exists. Alphanumeric, 50 positions; optional. |
Active |
Defines whether the salesrep is active.
The system validates that the salesrep is active when you define the salesrep on the Work with Order Screen in Order Entry or receive an order through the Generic Order Interface (Order API) that contains a salesrep. For more information see the Web Services Guide on My Oracle Support (ID 2149144.1) Note: Searching for an order based on salesrep in Contact Center is available only if the salesrep is currently flagged as active. |
Home Store |
The code identifying the default store location for the salesrep. Validated against the Store Cross Reference table; see Work with Store Cross Reference (WSCR). If the Store Cross Reference record is flagged as Active and the order is not fulfilled through the Order Broker integration, the store’s code, description, address, and phone number are included in the OriginatingStore element in the Outbound Email XML Message (CWEmailOut). See the OriginatingStore element for more information. For more information see the Web Services Guide on My Oracle Support (ID 2149144.1) Numeric, 10 positions; optional. |
Center code |
A code that represents the center to which this sales representative is assigned. Center codes can be used to group sales representatives (for example, region or product line). Alphanumeric, 4 positions; required. |
Additional bonus |
The additional bonus that the sales representative receives if the value from Over quota break is met or exceeded. Additional bonus works in conjunction with Over quota break. Numeric, 5 positions; required. |
Over quota break |
The quota, in dollars, that the sales representative must meet or exceed to receive an additional bonus. Over quota break works in conjunction with Additional bonus. Over quota break and Additional bonus are in addition to Quota and Commission % as incentives to your sales representatives. Numeric, 5 positions; required. |
Quota |
A sales goal, in dollars, that the sales representative must meet or exceed to receive a commission. Quota works in conjunction with Commission %. Numeric, 7 positions; required. |
Commission % |
The percentage of sales earned by the sales representative if the value from Quota is met or exceeded. Commission % works in conjunction with Quota. Numeric, 5 positions with a 2-place decimal; required. |
Phone |
The phone number where the salesrep can be reached. You can define a telephone number format for each country to map to the phone numbers operators enter into the system. See Setting Up the Country Table (WCTY). Alphanumeric, one 14-position field (phone number) and one 4-position field (phone extension); optional. |
User field 1 |
This field is informational only. Alphanumeric, 2 positions; optional. |
User field 2 |
This field is informational only. Alphanumeric, 2 positions; optional. |
User field 3 |
This field is informational only. Alphanumeric, 2 positions; optional. |
User field 4 |
This field is informational only. Alphanumeric, 2 positions; optional. |
Number of sales life-to-date |
The number of sales for this sales representative. This figure is cumulative across years. This field is a count of orders shipped. If back orders result in multiple shipments, Order Management System updates this field with each shipment. Numeric, 5 positions; display-only. |
Number of returns life-to-date |
The number of return transactions for this sales representative. This figure is cumulative across years. This field is neither a count of units nor a count of orders. Each time items from an existing order are returned -- regardless of the quantity returned or the number of lines affected by the return -- Order Management System considers this 1 return transactions and this field is updated. Order Management System updates this field if you use a return reason code in Order Maintenance or Return Authorization. If an order has multiple returns, Order Management System updates this field for each return transaction. Numeric, 5 positions; display-only. |
Number of exchanges life-to-date |
The number of exchange transactions for this sales representative. This figure is cumulative across years. This field is neither a count of units nor a count of orders. Each time items from an existing order are exchanged -- regardless of the quantity exchanged or the number of lines affected by the exchange -- Order Management System considers this 1 exchange transaction and this field is updated. Order Management System updates this field if you use an exchange reason code in Order Maintenance or Return Authorization. If an order has multiple exchanges, Order Management System updates this field for each exchange transaction. Numeric, 5 positions; display-only. |
Sales $ life-to-date |
The dollars associated with all sales for this sales representative. This figure is cumulative across years. Numeric, 20 positions with a 2-place decimal; display-only. |
Returns $ life-to-date |
The dollars associated with all return transactions for this sales representative. This figure is cumulative across years. Numeric, 20 positions with a 2-place decimal; display-only. |
Exchanges $ life-to-date |
The dollars associated with all exchange transactions for this sales representative. This figure is cumulative across years. Numeric, 20 positions with a 2-place decimal; display-only. |