CustomerAccountInfo
The customer's account figures.
type CustomerAccountInfo {
availableCredit: Float
companyName: String!
creditLimit: Float!
creditLimitEnabled: Boolean!
creditUnlimited: Boolean!
currentBalance: Float!
customFields: JSON
onAccountAvailable: Boolean!
overdueDays: Int!
partnerCode: String
partnerId: ID!
paymentTerm: BuyerPaymentTerm
paymentTerms: String
totalOrders: Int!
}
Fields
CustomerAccountInfo.availableCredit ● Float scalar
creditLimit − Σ open SALES-invoice outstanding, never negative. NULL when the customer's credit is unlimited (creditLimit <= 0, see creditUnlimited) — never 0, which would read as 'no credit left'. 0 by convention when creditLimitEnabled is false.
CustomerAccountInfo.companyName ● String! non-null scalar
The name of the customer's company.
CustomerAccountInfo.creditLimit ● Float! non-null scalar
The credit limit.
CustomerAccountInfo.creditLimitEnabled ● Boolean! non-null scalar
Whether this org enforces credit limits (Organization.creditLimitEnabled, default true). When false, creditLimit and availableCredit are 0 BY CONVENTION and must not be read as 'no credit left' — the credit module is simply off. Clients gate credit UI on this, never on a zero amount.
CustomerAccountInfo.creditUnlimited ● Boolean! non-null scalar
True when the org enforces credit limits AND this customer has no limit (creditLimit <= 0 = unlimited, the confirm gate's own rule). availableCredit is then null: render 'Unlimited' and never cap On account.
CustomerAccountInfo.currentBalance ● Float! non-null scalar
The current balance.
CustomerAccountInfo.customFields ● JSON scalar
The organization's own fields on this record that buyers may see, keyed by field key. Null when the row was read without them.
CustomerAccountInfo.onAccountAvailable ● Boolean! non-null scalar
False when this buyer cannot order On account: their payment term was retired by the tenant, or (with no term of their own) the tenant default is not a credit term. Clients hide On account on this flag; checkout refuses it with ON_ACCOUNT_UNAVAILABLE either way.
CustomerAccountInfo.overdueDays ● Int! non-null scalar
How many days the account is overdue.
CustomerAccountInfo.partnerCode ● String scalar
The customer code.
CustomerAccountInfo.partnerId ● ID! non-null scalar
The ID of the partner.
CustomerAccountInfo.paymentTerm ● BuyerPaymentTerm object
The buyer's payment term as the seller labels it (the customer's own term, else the organization default), with its credit days and whether it is still offered. Display only: On account eligibility stays on onAccountAvailable. Null when payment terms are unavailable.
CustomerAccountInfo.paymentTerms ● String scalar
The payment terms agreed with the customer.
CustomerAccountInfo.totalOrders ● Int! non-null scalar
How many orders the customer placed.
Returned By
customerAccountInfo query