Models

Totals

If not provided, the totals will be calculated from the document lines.

Properties

NameTypeRequiredDescription
linesAmountstring | nullNoThe tax exclusive total amount of all lines. Rounded to 2 decimal places. Example: "21.00"
discountAmountstring | nullNoThe tax exclusive total amount of all discounts. If not provided, this will be calculated automatically. Example: "21.00"
surchargeAmountstring | nullNoThe tax exclusive total amount of all surcharges. If not provided, this will be calculated automatically. Example: "21.00"
taxExclusiveAmountstringYesThe tax exclusive total amount of all lines, discounts and surcharges. Rounded to 2 decimal places. Example: "21.00"
taxInclusiveAmountstringYesThe tax inclusive total amount of all lines, discounts and surcharges. Rounded to 2 decimal places. Example: "21.00"
payableAmountstring | nullNoThe amount to be paid. If not provided, this will be taxInclusiveAmount. Can be used in combination with paidAmount to indicate partial payment or payment rounding. Rounded to 2 decimal places. Example: "21.00"
paidAmountstring | nullNoThe amount paid. If not provided, this will be taxInclusiveAmount - payableAmount. Can be used in combination with payableAmount to indicate partial payment or payment rounding. Rounded to 2 decimal places. Example: "21.00"

On this page