To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
A list of priced line items with billing and delivery addresses, forming the shared base for invoices, quotes and purchase orders. Holds the line items, addresses and reference information common to any payment document, and calculates sub-total, tax and total from its line items. Subclassed by InvoiceBean for invoice-specific fields such as status and due date.
Properties
| Property | Returns | Description |
|---|---|---|
| billingAddress | PaymentAddress | The billing address for this payment list. |
| cartId | Long | The id of the shopping cart this payment list was generated from, if any. |
| deliveryAddress | PaymentAddress | The delivery address for this payment list. |
| description | String | A longer free-text description of the payment list. |
| extraField1 | String | A general-purpose free-text field for additional, integration-specific information. |
| extraField2 | String | A second general-purpose free-text field for additional, integration-specific information. |
| extraField3 | String | A third general-purpose free-text field for additional, integration-specific information. |
| issuedDate | Date | The date the payment list was issued. |
| lineItemAttachments | List<PaymentListLineItemAttachment> | Files attached to the payment list's line items, such as supporting documents. |
| lineItems | List<PaymentLineItemBean> | The priced line items making up this payment list. |
| number | String | The unique document number for this payment list, such as an invoice or quote number. |
| paymentTaxType | PaymentTaxType | How tax is represented on the amounts in this payment list: not taxed, tax-inclusive or tax-exclusive. |
| reference | String | A free-text customer or purchase order reference for this payment list. |
| subTotal | BigDecimal | Calculates the ex-tax total of this payment list, being the sum of the sub-total of each line item. |
| tax | BigDecimal | Calculates the total tax on this payment list, being the sum of the tax amount of each line item. |
| title | String | A short title for the payment list, shown to the customer. |
| total | BigDecimal | Calculates the grand total of this payment list, being the sum of the total amount (including tax) of each line item. |
Methods
getNumber() · getTitle() · getDescription() · getLineItems() · getReference() · getLineItemAttachments() · getIssuedDate() · getSubTotal() · getTax() · getTotal() · getBillingAddress() · getDeliveryAddress() · getExtraField1() · getExtraField2() · getExtraField3() · getCartId() · getPaymentTaxType()
getNumber()
Returns: String
The unique document number for this payment list, such as an invoice or quote number.
getTitle()
Returns: String
A short title for the payment list, shown to the customer.
getDescription()
Returns: String
A longer free-text description of the payment list.
getLineItems()
Returns: List<PaymentLineItemBean>
The priced line items making up this payment list.
getReference()
Returns: String
A free-text customer or purchase order reference for this payment list.
getLineItemAttachments()
Returns: List<PaymentListLineItemAttachment>
Files attached to the payment list's line items, such as supporting documents.
getIssuedDate()
Returns: Date
The date the payment list was issued.
getSubTotal()
Returns: BigDecimal
Calculates the ex-tax total of this payment list, being the sum of the sub-total of each line item.
getTax()
Returns: BigDecimal
Calculates the total tax on this payment list, being the sum of the tax amount of each line item.
getTotal()
Returns: BigDecimal
Calculates the grand total of this payment list, being the sum of the total amount (including tax) of each line item.
getBillingAddress()
Returns: PaymentAddress
The billing address for this payment list.
getDeliveryAddress()
Returns: PaymentAddress
The delivery address for this payment list.
getExtraField1()
Returns: String
A general-purpose free-text field for additional, integration-specific information.
getExtraField2()
Returns: String
A second general-purpose free-text field for additional, integration-specific information.
getExtraField3()
Returns: String
A third general-purpose free-text field for additional, integration-specific information.
getCartId()
Returns: Long
The id of the shopping cart this payment list was generated from, if any.
getPaymentTaxType()
Returns: PaymentTaxType
How tax is represented on the amounts in this payment list: not taxed, tax-inclusive or tax-exclusive.
© 2025 Kademi Ltd