Skip to main content
Vindicia Knowledge Center

RefundItem Subobject

RefundItem Subobject

RefundItem Subobject

Describes a line item in a Refund that corresponds to a TransactionItem. The table below describes the RefundItem Object Values.

Value

Description

amount

Amount of the requested refund for this item, in the currency of the overall transaction. This amount must not exceed the original TransactionItem amount, minus any discounts and minus the sum of all prior refunds against this item. This field may be left blank if the taxOnly field is set to true.

description

Output only. A description of the TransactionItem, which will be filled in by CashBox from line item description on the original tns:Transaction.

sku

SKU on the original transaction line item (sku need not be passed in if the transactionItemIndexNumber is passed in). If the sku is passed in, and can be used to uniquely identify the transaction item, it will be used, otherwise an error will be returned.

taxes

Read-only array to list the taxes from the original TransactionItem that are being refunded.

taxOnly

If this is true, the amount parameter is ignored and the refund amount will be the total of the as-yet unrefunded taxes for this item.

transactionItemIndexNumber

Sequence number assigned upon creation to a TransactionItem by CashBox. Either the transactionItemIndexNumber, or the sku, must be specified for each RefundItem.

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top