AlmondTill/G3N API

GiveBackReport

object type

The caller group's give-back standing (the program's merchant-visible transparency surface): the derived tenure clock, the earned tier, the next rung, and the earned ledger. Figures are as of computedThroughMonth — the last CLOSED month the billing engine decided.

Fields

FieldTypeNotes
convertedFromStringNo further notes.
revokedAtStringNo further notes.
revokedReasonStringThe root’s spoken revocation reason (at most 256 characters; present with revokedAt).
tenureMonthsInt Int!REAL consecutive good-standing months (0 = no live streak / nothing evaluated yet).
effectiveTenureMonthsInt Int!Tenure + any switcher clock credit — what the ladder reads.
basisString String!ladder | heritage — how the current tier is earned.
tierBpInt Int!The earned share NOW, basis points (0 = not yet earning).
nextTierAtMonthsIntThe next ladder rung above the current effective months (absent at the top and for a standing heritage 100%).
nextTierBpIntNo further notes.
computedThroughMonthStringThe last CLOSED month the engine decided (absent = no month ever evaluated).
lifetimeGiveBackLifetimeTotal [GiveBackLifetimeTotal!]!Σ every accrued entry PER CURRENCY, minor units, currency-ascending.
accrualsGiveBackAccrualEntry [GiveBackAccrualEntry!]!The earned entries, NEWEST-FIRST + bounded (limit clamps [1,200] default 50; before pages backward by entry id).

Used by