Package com.blockchyp.client.dto
Class TransactionDisplayItem
java.lang.Object
com.blockchyp.client.dto.TransactionDisplayItem
An item category in a transaction display. Groups combine if their descriptions match.
Calculated subtotal amounts are rounded to two decimal places of precision. Quantity
is a floating point number that is not rounded at all.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds a are displayed under their corresponding item.Gets an international description code of the item.Gets a description of the line item.Gets how tax was applied to discounted items.Gets are displayed under their corresponding item.Gets an item category in a transaction display.getId()Gets a unique value identifying the item.getPrice()Gets the price of the line item.Gets a merchant-defined description code of the item.floatGets the quantity of the line item.Gets the amount of any value added taxes which apply to the item.Gets the tax rate as a percentage.Gets an alphanumeric code for units of measurement as used in international trade.voidsetCommodityCode(String value) Sets an international description code of the item.voidsetDescription(String value) Sets a description of the line item.voidsetDiscountCode(String value) Sets how tax was applied to discounted items.voidSets are displayed under their corresponding item.voidsetExtended(String value) Sets an item category in a transaction display.voidSets a unique value identifying the item.voidSets the price of the line item.voidsetProductCode(String value) Sets a merchant-defined description code of the item.voidsetQuantity(float value) Sets the quantity of the line item.voidsetTaxAmount(String value) Sets the amount of any value added taxes which apply to the item.voidsetTaxRate(String value) Sets the tax rate as a percentage.voidsetUnitCode(String value) Sets an alphanumeric code for units of measurement as used in international trade.
-
Constructor Details
-
TransactionDisplayItem
public TransactionDisplayItem()
-
-
Method Details
-
setId
Sets a unique value identifying the item.- Parameters:
value- a unique value identifying the item. This is not required, but recommended since it is required to update or delete line items.
-
getId
Gets a unique value identifying the item.- Returns:
- a unique value identifying the item. This is not required, but recommended since it is required to update or delete line items.
-
setDescription
Sets a description of the line item.- Parameters:
value- a description of the line item.
-
getDescription
Gets a description of the line item.- Returns:
- a description of the line item.
-
setPrice
Sets the price of the line item.- Parameters:
value- the price of the line item.
-
getPrice
Gets the price of the line item.- Returns:
- the price of the line item.
-
setQuantity
public void setQuantity(float value) Sets the quantity of the line item.- Parameters:
value- the quantity of the line item.
-
getQuantity
public float getQuantity()Gets the quantity of the line item.- Returns:
- the quantity of the line item.
-
setExtended
Sets an item category in a transaction display.- Parameters:
value- an item category in a transaction display. Groups combine if their descriptions match. Calculated subtotal amounts are rounded to two decimal places of precision. Quantity is a floating point number that is not rounded at all.
-
getExtended
Gets an item category in a transaction display.- Returns:
- an item category in a transaction display. Groups combine if their descriptions match. Calculated subtotal amounts are rounded to two decimal places of precision. Quantity is a floating point number that is not rounded at all.
-
setUnitCode
Sets an alphanumeric code for units of measurement as used in international trade.- Parameters:
value- an alphanumeric code for units of measurement as used in international trade.
-
getUnitCode
Gets an alphanumeric code for units of measurement as used in international trade.- Returns:
- an alphanumeric code for units of measurement as used in international trade.
-
setCommodityCode
Sets an international description code of the item.- Parameters:
value- an international description code of the item.
-
getCommodityCode
Gets an international description code of the item.- Returns:
- an international description code of the item.
-
setProductCode
Sets a merchant-defined description code of the item.- Parameters:
value- a merchant-defined description code of the item.
-
getProductCode
Gets a merchant-defined description code of the item.- Returns:
- a merchant-defined description code of the item.
-
setDiscounts
Sets are displayed under their corresponding item.- Parameters:
value- are displayed under their corresponding item.
-
getDiscounts
Gets are displayed under their corresponding item.- Returns:
- are displayed under their corresponding item.
-
setTaxAmount
Sets the amount of any value added taxes which apply to the item.- Parameters:
value- the amount of any value added taxes which apply to the item.
-
getTaxAmount
Gets the amount of any value added taxes which apply to the item.- Returns:
- the amount of any value added taxes which apply to the item.
-
setTaxRate
Sets the tax rate as a percentage.- Parameters:
value- the tax rate as a percentage. Example: '8.5' for 8.5% tax rate.
-
getTaxRate
Gets the tax rate as a percentage.- Returns:
- the tax rate as a percentage. Example: '8.5' for 8.5% tax rate.
-
setDiscountCode
Sets how tax was applied to discounted items.- Parameters:
value- how tax was applied to discounted items. '0' = no discount, '1' = tax calculated after discount, '2' = taxcalculated before discount.
-
getDiscountCode
Gets how tax was applied to discounted items.- Returns:
- how tax was applied to discounted items. '0' = no discount, '1' = tax calculated after discount, '2' = taxcalculated before discount.
-
addDiscount
Adds a are displayed under their corresponding item.- Parameters:
value- are displayed under their corresponding item.
-