Skip to main content
objectSalesInvoicePaymentBalance

Fields

salesInvoiceId
ID!

The ID of the sales invoice.

currencyCode
String!

The currency of the amounts (ISO 4217).

grossAmount
Decimal!

The gross amount of the invoice.

creditedAmount
Decimal!

The gross amount of its invoice corrections.

amountDue
Decimal!

What the customer has to pay: the gross amount minus the credited amount; for a cancelled invoice 0 minus the credited amount.

paidAmount
Decimal!

What counts as paid: the payments of the invoice and of its invoice corrections, including cash discount write-offs and payouts (negative). Payments towards the dunning fee do not count; see 'openDunningFee'.

openAmount
Decimal!

'amountDue' minus 'paidAmount'. Negative while an invoice correction has not been paid out.

paymentStatus

How far the invoice is paid. A cancelled invoice counts as paid.

paidAt
DateTime

When the invoice became fully paid. Empty while it is not fully paid.

paymentDueDate
DateTime

The date by which the invoice is to be paid.

dunningFee
Decimal!

The dunning fee charged with the latest dunning notice, 0 when there is none.

openDunningFee
Decimal!

The part of the dunning fee that is not paid yet.