FHEAD

This File Type Descriptor identifies a single record at the beginning of the file. Created by the RTLog periodic function, and not found in the temporary file.

File Line Identifier

Number (10)

0000000001

Identifies the line number in the file. Zero-padded. Set to 0000000001 for the FHEAD.

File Type Definition

Character (4)

RTLG

Hard-coded.

File Create Date

Character (14)

System date and time

The date and time when the file was created.

Example: 20190621140400, where 2019 is the year, 06 is the month, 21 is the date, and 140400 is the time.

Business Date

Character (8)

System date

The date when the file was created.

Example: 20190621, where 2019 is the year, 06 is the month, and 21 is the date.

Location Number

Character (10)

Location ID

The location ID assigned in the Sales Audit module. From the Parameter defined for the RTLOG periodic function. If no Parameter was defined, this is the company number.

RTLOG Originating System

Character (3)

OMS

Hard-coded.

THEAD (OPEN transaction)

The first record in the file with a File Type Descriptor of THEAD is an OPEN transaction, and follows the initial FHEAD record in the DAT file created by the RTLOG periodic function.

File Line Identifier

Number (10)

Next sequential number in the file.

Identifies the line number in the file. Ordinarily set to 0000000002, since this line follows the FHEAD record. Zero-padded.

Register

Character (5)

01

Hard-coded.

Transaction Date

Character (14)

System date and time

The date and time when the record was created.

Example: 20190621140400, where 2019 is the year, 06 is the month, 21 is the date, and 140400 is the time.

Transaction Number

Number (10)

Next transaction number in the file.

Zero-padded. Ordinarily set to 0000000002 for the OPEN transaction type.

Transaction Type

Character (6)

OPEN

Hard-coded.

Sub-transaction Type

Character (6)

OSTORE

Hard-coded.

THEAD (SALE or RETURN transaction)

Records with this File Type Descriptor contains the header for each transaction, indicating the date and time generated, the invoice (transaction) number, and whether the transaction was a shipment (SALE) or refund (RETURN). The first THEAD record in the file is an OPEN transaction following the initial FHEAD, and the last THEAD record is a CLOSE transaction at the end of the transactions.

File Line Identifier

Number (10)

Next sequential number

Identifies the line number in the file. Zero-padded.

Register

Character (5)

01

Hard-coded.

Transaction Date

Character (14)

System date and time

The date and time when the INVOIC_OUT job processed the transaction record.

Example: 20190621140400, where 2019 is the year, 06 is the month, 21 is the date, and 140400 is the time.

Transaction Number

Number (10)

Invoice number

The unique number identifying the invoice in Order Management System.

Cashier

Character (10)

Salesman number

The unique number identifying the salesman, if any, associated with the order.

Salesperson

Character (10)

Salesman number

The unique number identifying the salesman, if any, associated with the order.

Transaction Type

Character (6)

SALE or RETURN

Set to SALE if the merchandise was shipped; otherwise, set to RETURN if the merchandise was returned, or if a negative additional charge was applied and express-billed.

Note:  Typically, if the merchandise was shipped, the invoice type is I, but it is possible that negative additional charges, applied through the non-inventory item, could exceed the value of the shipped items. Similarly, if the merchandise is returned, the invoice type is C, but it is possible that positive additional charges could exceed the value of the returned items.

Value Sign

Character (1)

P

Set to P for both sales and credit invoices.

Rounded Amount Sign

Character (1)

P

Set to P for both sales and credit invoices.

Rounded Off Sign

Character (1)

P

Set to P for both sales and credit invoices.

Transaction Processing System

Character (3)

POS or OMS

Passes POS:

•         For a debit invoice, the delivery type for the Order Ship To is P (store pickup) or R (retail pickup), or

•         For a debit invoice, the delivery type is S (ship-for-pickup) and the Payment at POS for Ship for Pickup Orders (L60) SCV is set to Y, or

•         For a credit invoice, the return disposition value matches the Return Disposition Code to Exclude in ORCE Sales Feed (M22), and Suppress Refund = Y.

Otherwise, passes OMS.

TCUST

Records with this File Type Descriptor contains information about the sold-to customer, including customer number and name and address. TCUST records follow THEAD records with File Type Descriptors of SALE or RETURN.

The information in this record type is primarily from the Sold To Customer record.

File Line Identifier

Number (10)

Line number

Identifies the line number in the file. Zero-padded.

Customer ID

Character (16)

Sold-to customer number.

The sold-to customer on the order.

Customer Type ID

Character (6)

CUSTID

Hard-coded.

Customer Name

Character (120)

Customer first name, last name, and company.

Values are concatenated, with spaces between each.

Address 1

Character (240)

First address line

All address and phone number information is for the sold-to customer.

Address 2

Character (240)

Second address line

Blank if no second address line exists. Apartment number is not passed.

City

Character (120)

City

State

Character (12)

State or province code

If blank, spaces are passed.

Zip Code

Character (30)

Zip or postal code

If blank, spaces are passed.

Country

Character (3)

Country code

Two positions.

Home Phone

Character (20)

Day phone

Work Phone

Character (20)

Evening phone

E-mail

Character (100)

Email address

The sold-to customer’s primary email address.

TITEM

Records with this File Type Descriptor contains information about each item sold or returned, including item number, quantity, and pricing, as well as the order number and invoice number.

The information for this record type is primarily from the Invoice Detail table.

File Line Identifier

Number (10)

Line number

Identifies the line number in the file. Zero-padded.

Item Status

Character (6)

ORD or C

Set to ORD if the invoice is for a shipment; otherwise, set to R if the invoice is for a return, or for a negative additional charge that was express-billed.

Item Type

Character (6)

ITEM or NMITEM

Set to NMITEM for the Item for Non-Merchandise Amounts (L39); otherwise, set to ITEM.

Item Number Type

Character (6)

ITEM

Hard-coded.

Item

Character (25)

Item code

The item’s Reference # (retail reference number) from the SKU table.

The Reference # is automatically populated with the item number through Importing Enterprise Foundation Data through Omnichannel Cloud Data Service (OCDS). If for any reason the Reference # is blank, the base item code is passed instead. The item code passed does not include a SKU. SKUs are not supported in the Sales Audit module.

Note:  Each item must map to an item in the Sales Audit module.

Non-Merchandise Item

Character (25)

Non-merchandise item code

From the Item for Non-Merchandise Amounts (L39) system control value. This must be a valid item code in the Sales Audit module.

Quantity Sign

Character (1)

P or N

Typically set to P for a sale invoice; otherwise, set to N for a credit invoice. However, if this is the NMITEM, the Quantity Sign indicates the effect of the charge, for example:

•         If a negative additional charge applies to a sale invoice, the Quantity Sign is set to N.

•         If a positive additional charge applies to a credit invoice, the Quantity Sign is set to P.

Quantity

Number (12)

Shipped or returned unit quantity

Zero-padded with a 4-position implied decimal; for example, a quantity of 2 is passed as 000000020000. Absolute value. Quantity of 1 is passed for the Item for Non-Merchandise Amounts.

Selling Unit of Measure

Character (4)

EA

Hard-coded.

Unit Retail

Number (20)

Pre-discount price

Zero-padded with a 4-position implied decimal; for example, a price of 1.50 is passed as 00000000000000015000. Absolute value.

If the selling price is less than the offer price on a sales transaction, an IDISC record provides details on the discount.

Note:  Ordinarily the same as the Original Unit Retail, except for the following scenarios.

•         When the selling price exceeds the offer price, this is the selling price.

•         When this is a return, this is the actual price credited.

•         When the record is for the Item for Non-Merchandise Amounts, then this field is the net total of the additional charge amount, freight amount, and the handling charge amount.

Override Reason

Character (6)

OMS

Hard-coded.

Original Unit Retail

Number (20)

Offer price from the Order Detail record

The original offer price. Set to 0.00 if no offer price is defined. See Overriding the Item/SKU Offer Price for a discussion of how the offer price for an Order Detail record is determined when offers are not set up, and a price override reason code is used to set the price for the order line.

If the selling price is lower than the original offer price, the Unit Discount Amount specified in the IDISC record indicates the unit amount of the discount.

Taxable Indicator

Character (1)

Y or N

Set to Y, unless:

•         The item is tax exempt; see Working with Item Tax Exemptions (WITX), or

•         This is the Item for Non-Merchandise Amounts.

Item_swiped_ind

Character (1)

N

Hard-coded.

Return Reason Code

Character (6)

Return reason code

The return reason code used for a return of an order line. See Establishing Return Reason Codes (WRTR) for background.

Note:  The return reason codes used MUST map to SARR codes defined in the Sales Audit module.

Salesperson

Character (10)

Salesman number

The unique number identifying the salesman, if any, associated with the order.

Drop Ship Ind

Character (1)

Y or N

Set to Y for a drop ship item on a sale transaction; otherwise, set to N. Set to N for a return.

Uom_qty

Number (12)

Shipped quantity

The shipped quantity on the invoice detail. Zero-padded with a 4-position implied decimal; for example, a quantity of 2 is passed as 000000020000. Absolute value. Quantity of 1 passed for the Item for Non-Merchandise Amounts.

Catchweight_ind

Character (1)

N

Hard-coded.

Total_igtax_amount

Number (21)

Invoice detail tax amount

The total tax for the invoice detail line.

Selling item

Character (25)

Item code

The base item code. Does not include a SKU. SKUs are not supported in the Sales Audit module.

Customer Order Number

Character (48)

Order number

The Order Management System order number. Does not include the ship-to suffix.

Customer Order Date

Character (14)

Order date

The order date from the Order Header. YYYYMMDD format.

Fulfillment Order Number

Character (48)

Invoice number

Included only for sales transactions. Not included for returns.

No Inventory Return

Character (1)

Y or N

Used only for credit invoice records.

Set to Y when inventory was not updated for the transaction creating the invoice detail record (there is no Item Transaction History record, as indicated in Display Inventory Transaction History (DITH)). For example, this flag is selected when a negative additional charge express bills against a closed order.

Otherwise, set to N if inventory was updated, or if this is a non-merchandise item (NMITEM).

Sales Type

Character (1)

E

Hard-coded.

Return Warehouse

Character (10)

Warehouse code

Used only for return records that are not for the non-merchandise item (NMITEM):

•         If inventory updated: If No Inventory Return is set to N and this is a return that affected inventory (that is, not for the NMITEM), the Return Warehouse is the warehouse code from the inventory transaction history record.

•         If inventory not updated: If No Inventory Return is set to Y and this is not for the NMITEM, this is the warehouse defined in the:

•         ReSA Warehouse for Non-Inventory Returns (M56) system control value. If this system control value is blank,

•         Default Warehouse (A04) system control value. Otherwise,

•         Hard-coded to 1.

Note:  Any warehouse codes that might be passed MUST map to Physical Warehouse defined in the Sales Audit module.

Return Disposition

Character (10)

COR

Sent only when No Inventory Return is set to N, or the record is for the NMITEM.

Location Type

Character (2)

Location type identifier

•         ST for a store pickup, retail pickup, or ship-for-pickup order.

•         WH for a delivery order.

•         Blank for any other order type.

Not passed for returns.

Location Number

Character (10)

Code identifying fulfilling or pickup location

•         The pickup location code from the Order Broker record for a store pickup, retail pickup, or ship-for-pickup order.

•         The fulfilling location code from the Order Broker record, for a brokered backorder, if specified.

•         Otherwise, the OCDS RMS Location Identifier (M52).

Not passed for returns.

IDISC

Records with this File Type Descriptor contain discount line information for sales transactions when the selling price is lower than the offer price. These records are not created for returns. Also, if the offer price is lower than the selling price, such as when the offer price is zero, no discount record is created.

This record follows the TITEM record for the discounted item.

The information for this record type is primarily from the Invoice Detail table.

File Line Identifier

Number (10)

Line number

Identifies the line number in the file. Zero-padded.

RMFCS Promotion Number

Character (6)

2000

Hard-coded.

Discount Type

Character (6)

ITEM

Hard-coded.

Quantity Sign

Character (1)

P

Hard-coded. A quantity sign of N is not used, since only sales transactions create these records.

Quantity

Number (12)

Shipped quantity

The shipped quantity on the invoice detail. Zero-padded with a 4-position implied decimal; for example, a quantity of 2 is passed as 000000020000.

Unit Discount Amount

Number (20)

Discount amount divided by shipped quantity

The discount amount shipped quantity on the invoice detail. Zero-padded with a 4-position implied decimal; for example, a unit discount amount of 2.5 is passed as 000000025000.

Uom_qty

Number (12)

Shipped quantity

The shipped quantity on the invoice detail. Zero-padded with a 4-position implied decimal; for example, a quantity of 2 is passed as 000000020000.

Catchweight_ind

Character (1)

N

Hard-coded.

IGTAX

Records with this File Type Descriptor contain item-level tax amounts. This record type follows the IDISC, if any; otherwise, follows the TITEM.

Note:  VAT amounts are not passed in this record type, since they are included in item prices.

File Line Identifier

Number (10)

Line number

Identifies the line number in the file. Zero-padded.

Tax Authority

Character (10)

TOTALTAX

Hard-coded.

Igtax Code

Character (6)

TOTAX

Hard-coded.

Igtax Amount Sign

Character (1)

P or N

Set to P for a sale invoice; otherwise, set to N for a credit invoice.

Igtax Amount

Number (21)

Tax amount

The total tax amount for the invoice detail line, including any GST or PST as well as tax on any special handling or gift wrap for the item. For the NMITEM, includes the total order-level freight tax from the Invoice Payment Method record for all payment methods.

Zero-padded with a 5-position implied decimal; for example, a tax amount of 2.38 is passed as 000000000000000238000.

Absolute value.

TTAX

Records with this File Type Descriptor contain tax amounts.

Note:  VAT amounts are not passed in this record type, since they are included in item prices.

File Line Identifier

Number (10)

Line number

Identifies the line number in the file. Zero-padded.

Tax Code

Character (6)

TOTAX

Hard-coded.

Tax Sign

Character (1)

P or N

Set to P for a sale invoice; otherwise, set to N for a credit invoice.

Tax Amount

Number (20)

Tax amount

The total tax amount for the invoice, including any GST or PST. Zero-padded with a 4-position implied decimal; for example, a tax amount of 2.38 is passed as 00000000000000023800. Absolute value.

TPYMT

Records with this File Type Descriptor contain payment amounts for sales, exclusive of tax, although VAT is not subtracted if the order is subject to VAT.

These records are not created for return or credit transactions.

File Line Identifier

Number (10)

Line number

Identifies the line number in the file. Zero-padded.

Payment Sign

Character (1)

P

Hard-coded. A payment sign of N is not used, since only sales transactions create these records.

Payment Amount

Number (20)

Deposit amount minus tax

The deposit amount for the invoice payment method, exclusive of tax. Zero-padded with a 4-position implied decimal; for example, a payment amount of 37.60 is passed as 00000000000000376000.

TTEND

Records with this File Type Descriptor contain tender information for each transaction.

File Line Identifier

Number (10)

Line number

Identifies the line number in the file. Zero-padded.

Tender Type Group

Character (6)

CHECK or CCARD

Set to CHECK if the payment method is a check pay category; otherwise, set to CCARD if the payment method is a credit card.

Tender Type ID

Number (6)

Pay type code

The pay type code, as set up in Work with Pay Types (WPAY).

Note:  Each pay type must map to a Pay Type in the Sales Audit module.

Tender Sign

Character (1)

P or N

Set to P for a sale invoice; otherwise, set to N for a credit invoice.

Tender Amount

Number (20)

Deposit amount

The deposit amount for the invoice payment method, including tax. Zero-padded with a 4-position implied decimal; for example, a payment amount of 39.98 is passed as 00000000000000399800.

TTAIL

A Type Record Descriptor for the transaction trailer record following each transaction, including an OPEN or CLOSE transaction.

File Line Identifier

Number (10)

Line number

Identifies the line number in the file. Zero-padded.

Transaction Record Counter

Number (10)

Number of records in the transaction

Set to 0000000000 for an OPEN or CLOSE transaction. Zero-padded.

THEAD (CLOSE transaction)

The last record in the file with a File Type Descriptor of THEAD is a CLOSE transaction. This record is followed by the TTAIL and FTAIL records. Created by the RTLog periodic function, and not found in the temporary file.

The CLOSE THEAD record is followed by a TTAIL record, and then the FTAIL record.

File Line Identifier

Number (10)

Next sequential number in the file.

Identifies the line number in the file. Zero-padded.

Register

Character (5)

01

Hard-coded.

Transaction Date

Character (14)

Date and time

The date and time when the RTLOG function created the DAT file.

Transaction Number

Number (10)

Next transaction number in the file.

Identifies the transaction number in the file. Zero-padded.

Transaction Type

Character (6)

DCLOSE

Hard-coded.

Sub-transaction Type

Character (6)

DSTORE

Hard-coded.

FTAIL

The total number of lines in the file. The last entry in the file. Added through the RTLOG periodic function.

File Line Identifier

Number (10)

Next sequential number in the file

Identifies the line number in the file. Zero-padded.

File Record Counter

Number (10)

Next sequential number in the file

Identifies the transaction number in the file. Zero-padded.