Effective credit limit (effective_credit_limit)

Projection that resolves, at a given date, the credit limit actually applicable to a buyer from candidate limits.

Role

Projection that resolves, at a given date, the credit limit actually applicable to a buyer from candidate limits.

This page describes the canonical functional concept. Detailed endpoints, HTTP parameters, and response formats belong in the API & events.

Nature in the model

Projection This view is calculated from current state. It has no identifier of its own and must not be treated as an independent persisted resource.

Key fields

The fields below capture the most important functional distinctions of the object.

ChampTypeRole
buyer_idstringBuyer for whom the limit is resolved.
currencystringCurrency of the effective limit.
atdateDate at which resolution is evaluated.
strategymaximum | minimum | cumulativeAggregation strategy for candidate limits.
basisexcluding_tax | including_taxCalculation basis used to compare limit and exposure.
amountintegerEffective amount retained in minor units.
selected_credit_limit_id(s)string | string[]Canonical limit or limits selected by resolution.
candidatesobject[]Candidates evaluated to produce the result.

Relationships

ObjetRelationSignification
companyBuyerThe projection is resolved for a specific `buyer_id`.
credit_limitCandidate limitsThe result exposes the selected limits among applicable `credit_limit` resources.

Invariants

  • An `effective_credit_limit` projection has no identifier of its own and is not a new persisted limit.
  • The result explicitly depends on date, currency, strategy, and calculation basis.
  • `selected_credit_limit_ids` provide traceability to the `credit_limit` resources that justify the effective amount.