AlmondTill/G3N API

ReferralReport

object type

Your referral program at a glance: counts by standing, lifetime totals by kind (SIGNED like the ledger: earned ≥ 0 · applied/clawback ≤ 0), the spendable credit, the NEWEST 12 months that carry entries, and one page of referred businesses with their figures.

Fields

FieldTypeNotes
referredCountInt Int!Every business that signed up with your code — gone ones included.
pendingCountInt Int!No further notes.
approvedCountInt Int!No further notes.
deniedCountInt Int!No further notes.
goneCountInt Int!Referred businesses that no longer exist on the platform (their rows read blank — no code, no standing).
earningCountInt Int!Referred businesses with at least one earning entry (accrue or usage).
earnedUsdCentsInt Int!Lifetime Σ accrue + usage (USD cents, ≥ 0).
appliedUsdCentsInt Int!Lifetime Σ applied — your own base fees credit-settled from earnings (USD cents, ≤ 0).
clawbackUsdCentsInt Int!Lifetime Σ clawback — dispute reversals (USD cents, ≤ 0).
spendableUsdCentsIntYour wallet's spendable referral credit (USD cents). Null when the group holds no wallet.
monthsReferralMonth [ReferralMonth!]!The NEWEST 12 months that carry entries, NEWEST-first.
referralsReferralPerformance [ReferralPerformance!]!One page of your referred businesses, NEWEST-first by the referred group's id (limit clamps [1,200] default 50; before = a strict id upper bound — the affiliateAccruals grammar).

Used by