Skip to main content

CreditExposureResult

A customer's credit exposure: what they owe, what is committed, and the headroom left under their credit limit.

type CreditExposureResult {
  baseCurrency: String!
  currentExposure: Float!
  enabled: Boolean!
  headroom: Float
  invoiceExposure: Float!
  limit: Float!
  side: String!
  uninvoicedCommitment: Float!
  unlimited: Boolean!
}

Fields​

CreditExposureResult.baseCurrency ● String! non-null scalar​

Currency code the amounts are expressed in: the organization's base currency.

CreditExposureResult.currentExposure ● Float! non-null scalar​

invoiceExposure + uninvoicedCommitment

CreditExposureResult.enabled ● Boolean! non-null scalar​

False when the org's credit-limit module is disabled — exposure figures above are still real (not zeroed), but no limit is enforced

CreditExposureResult.headroom ● Float scalar​

limit - currentExposure; null when unlimited

CreditExposureResult.invoiceExposure ● Float! non-null scalar​

Σ open invoice base outstanding

CreditExposureResult.limit ● Float! non-null scalar​

Base-currency credit limit; 0 when unlimited/unset

CreditExposureResult.side ● String! non-null scalar​

SALES (customer A/R) or PURCHASE (vendor A/P)

CreditExposureResult.uninvoicedCommitment ● Float! non-null scalar​

Σ committed credit-terms order not-yet-invoiced base value

CreditExposureResult.unlimited ● Boolean! non-null scalar​

True when no positive limit is configured

Returned By​

creditExposure query