To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
A single priced line item on an invoice, quote or purchase order, such as a product, fee or service charge. Held in a list on PaymentListBean, and used to calculate the sub-total, tax and total of the payment list it belongs to.
Properties
| Property | Returns | Description |
|---|---|---|
| accountCode | String | The accounting code this line item is booked against, if the connected accounting system uses one. |
| amount | BigDecimal | Calculates the total charge for this line item, being the sub-total (after any discount) plus tax. |
| description | String | A description of the line item, shown to the customer on the invoice, quote or purchase order. |
| discountRate | BigDecimal | The discount applied to this line item, as a percentage such as 10 for 10 percent off. |
| lineItemCode | String | A code identifying this line item, distinct from the sku, used by some accounting integrations. |
| productSku | ProductSku | The product sku this line item is for, if any. Not persisted with the line item. |
| quantity | BigDecimal | The quantity of the item being charged for. |
| sku | String | The stock-keeping unit code for the line item, if it corresponds to a product. |
| subTotal | BigDecimal | Calculates the ex-tax amount for this line item: unit price multiplied by quantity, with the discount rate applied. |
| supplier | BaseEntity | The entity supplying this line item's product or service, if any. Not persisted with the line item. |
| taxAmount | BigDecimal | Calculates the tax charged on this line item, being the sub-total multiplied by the tax rate. |
| taxRate | BigDecimal | The tax rate applied to this line item, stored as a percentage, so 12 percent is stored as 12, not 0.12. |
| taxType | String | The name of the tax that applies to this line item, such as a GST or VAT category, as understood by the connected accounting system. |
| unitPrice | BigDecimal | The price per unit, excluding tax. |
Methods
getDescription() · getAccountCode() · getSku() · getLineItemCode() · getQuantity() · getDiscountRate() · getUnitPrice() · getAmount() · getSubTotal() · getTaxAmount() · getTaxRate() · getTaxType() · getProductSku() · getSupplier()
getDescription()
Returns: String
A description of the line item, shown to the customer on the invoice, quote or purchase order.
getAccountCode()
Returns: String
The accounting code this line item is booked against, if the connected accounting system uses one.
getSku()
Returns: String
The stock-keeping unit code for the line item, if it corresponds to a product.
getLineItemCode()
Returns: String
A code identifying this line item, distinct from the sku, used by some accounting integrations.
getQuantity()
Returns: BigDecimal
The quantity of the item being charged for.
getDiscountRate()
Returns: BigDecimal
The discount applied to this line item, as a percentage such as 10 for 10 percent off.
getUnitPrice()
Returns: BigDecimal
The price per unit, excluding tax.
getAmount()
Returns: BigDecimal
Calculates the total charge for this line item, being the sub-total (after any discount) plus tax.
getSubTotal()
Returns: BigDecimal
Calculates the ex-tax amount for this line item: unit price multiplied by quantity, with the discount rate applied.
getTaxAmount()
Returns: BigDecimal
Calculates the tax charged on this line item, being the sub-total multiplied by the tax rate.
getTaxRate()
Returns: BigDecimal
The tax rate applied to this line item, stored as a percentage, so 12 percent is stored as 12, not 0.12.
getTaxType()
Returns: String
The name of the tax that applies to this line item, such as a GST or VAT category, as understood by the connected accounting system.
getProductSku()
Returns: ProductSku
The product sku this line item is for, if any. Not persisted with the line item.
getSupplier()
Returns: BaseEntity
The entity supplying this line item's product or service, if any. Not persisted with the line item.
© 2025 Kademi Ltd