Skip to main content

CustomerInvoiceSummary

Invoices-screen KPI tiles + server-computed available credit.

type CustomerInvoiceSummary {
  availableCredit: Float
  buckets: [CustomerInvoiceKpiBucket!]!
  creditCurrency: String!
  creditLimitEnabled: Boolean!
  creditUnlimited: Boolean!
  onAccountAvailable: Boolean!
}

Fields​

CustomerInvoiceSummary.availableCredit ● Float scalar​

Server-computed: creditLimit − Σ open SALES-invoice outstanding. NULL when the customer's credit is unlimited (creditUnlimited) — never 0.

CustomerInvoiceSummary.buckets ● [CustomerInvoiceKpiBucket!]! non-null object​

The figures, one entry per currency.

CustomerInvoiceSummary.creditCurrency ● String! non-null scalar​

The currency of the customer's credit.

CustomerInvoiceSummary.creditLimitEnabled ● Boolean! non-null scalar​

False when the org runs with credit limits switched off. availableCredit is then 0 by convention, so clients hide credit UI on THIS flag rather than rendering a zero as 'no credit left'.

CustomerInvoiceSummary.creditUnlimited ● Boolean! non-null scalar​

True when the customer has no credit limit (creditLimit <= 0 = unlimited) on an org that enforces limits. availableCredit is then null; clients show 'Unlimited' and never disable On account on it.

CustomerInvoiceSummary.onAccountAvailable ● Boolean! non-null scalar​

False when this buyer cannot order On account (their payment term was retired, or the tenant default is not a credit term). Clients hide the On account row on it; checkout refuses it with ON_ACCOUNT_UNAVAILABLE.

Returned By​

customerInvoiceSummary query