Item

Added On: 03/27/12

SQL Table: ITEM

Module: UniCharge

Type: Entity Status: Hidden

Java Class: Item

Represents an item (product or service) for which a payment is collected (or refunded).

All credit card transactions, that are to be qualified as level 3, must supply full item detail information for each transactions sent. The information can optionally be provided for other transaction types and levels.

Available Fields:

Code
Commodity Code
Credit Indicator
Description
Discount Amount

Discount Rate
Id
Item Number
Merchant Account Code
Quantity

Tax Amount
Tax Code
Tax Indicator CL
Tax Rate
Total Amount

Unit Cost Amount
Unit Measure

Code

Added On: 03/27/12

SQL Column: CODE

Java Field: code

Status: Active

SQL Type: varchar(12)

Java Type: String

Attributes:

Unique identifier assigned to this item in submitter's (merchant's) front-end system or inventory catalog.

Commodity Code

Added On: 03/27/12

SQL Column: COMMODITY_CODE

Java Field: commodityCode

Status: Active

SQL Type: varchar(12)

Java Type: String

Attributes:

Acquirer designated standardized code that classifies this item.

Credit Indicator

Added On: 03/27/12

SQL Column: CREDIT_INDICATOR

Java Field: creditIndicator

Status: Active

SQL Type: tinyint(1)

Java Type: Boolean

Attributes: Default:false

Indicates whether this item was purchased or refunded as part of the transaction.

A value of 0, indicates that the item was purchased and a value of 1 indicates that the item was refunded.

Note: even if the item was refunded, the transaction might be a sale (purchase) transaction, since it may contain several other items.

Description

Added On: 03/27/12

SQL Column: DESCRIPTION

Java Field: description

Status: Active

SQL Type: varchar(35)

Java Type: String

Attributes:

Short description of the item

Discount Amount

Added On: 03/27/12

SQL Column: DISCOUNT_AMOUNT

Java Field: discountAmount

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Total amount of discount applied on this item

Discount Rate

Added On: 03/27/12

SQL Column: DISCOUNT_RATE

Java Field: discountRate

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Rate of discount that was applied (if any) on this item

Added On: 03/27/12

SQL Column: ID

Java Field: id

Status: Active

SQL Type: bigint(20)

Java Type: Long

Identifier / Primary Key

Attributes: Unique, Required, CreateOnly, ReadOnly

Identifier of the object used for references; auto-incremented integer value.

Item Number

Added On: 12/31/14

SQL Column: ITEM_NUMBER

Java Field: itemNumber

Status: Active

SQL Type: varchar(20)

Java Type: String

Attributes:

Unique identifier of the item assigned by POS system.

Merchant Account Code

Added On: 03/27/12

SQL Column: MERCHANT_ACCOUNT_CODE

Java Field: merchantAccountCode

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes: Required, CreateOnly

Code of Merchant Account to which instance of this object is attributed to. Depending on the context, Merchant Account Code field may contain either Merchant Code or Merchant Account Code.
The field is primarily used for data partitioning and data management, to make it easy to determine the ownership of a record within the database.

Quantity

Added On: 03/27/12

SQL Column: QUANTITY

Java Field: quantity

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Quantity of the item units purchased/refunded as part of the transaction.

The value is stored as decimal with 4 significant digits.

For example:

10000 = 1 unit
100 = 0.01 unit
1 = 0.0001 unit

Tax Amount

Added On: 03/27/12

SQL Column: TAX_AMOUNT

Java Field: taxAmount

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Amount of tax charged for this item

Tax Code

Added On: 03/27/12

SQL Column: TAX_CODE

Java Field: taxCode

Status: Active

SQL Type: varchar(4)

Java Type: String

Attributes:

Acquirer designated value classifying the tax that was charged for this item

Tax Indicator CL

Added On: 03/27/12

SQL Column: TAX_INDICATOR_CL

Java Field: taxIndicatorCl

Status: Active

SQL Type: varchar(1)

Java Type: String

References Tax Indicator Classifier

Attributes:

Enumeration of possible values of tax indicators in the system.

Tax Rate

Added On: 03/27/12

SQL Column: TAX_RATE

Java Field: taxRate

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Rate of the tax (if any) charged on this item

Total Amount

Added On: 03/27/12

SQL Column: TOTAL_AMOUNT

Java Field: totalAmount

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Total amount paid for the item (including tax and discount).

The value is stored in cents.

For example:

100 = $1
1 = 1 cent

Unit Cost Amount

Added On: 03/27/12

SQL Column: UNIT_COST_AMOUNT

Java Field: unitCostAmount

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Cost of a single unit of the item.

The value is stored as decimal with 4 significant digits.

For example:

10000 = $1
100 = 1 cent
1 = 0.01 cent

Unit Measure

Added On: 03/27/12

SQL Column: UNIT_MEASURE

Java Field: unitMeasure

Status: Active

SQL Type: varchar(12)

Java Type: String

Attributes:

Unit of measure used to quantify the items purchased/refunded (e.g. g, kg, lb, inch)