Commission summary
Company-wide commission totals for a period — paid (earned), pending, and processing — in the company base currency, plus payment + deal counts. Use this for ‘how much commission is owed/earned this period’. This is commission MONEY; for commission RULES use getCommissionReport. Defaults to the current year; pass a period or start_date+end_date. Money is in whole currency units of currency_code.
Authorizations
API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".
Query Parameters
Reporting period (resolved to a date range server-side). Defaults to current_year. Ignored when start_date + end_date are both supplied.
current_year, last_year, current_quarter, last_quarter, current_month, last_month, last_30_days, last_90_days, last_6_months, last_12_months ISO date for a custom range start (use with end_date).
ISO date for a custom range end (use with start_date).
Limit to one partner type; omit to include all partners.
referral, reseller, distributor For referral partners, which lead direction to count.
received, sent, all Restrict to these partnerships (uuids). Pass a single uuid for one partner's scorecard.
Restrict to partners in these categories (uuids).
Restrict to partners in these tiers (uuids).
Restrict to partners in these partnership stages (uuids).
Max rows for list/leaderboard endpoints (default per endpoint).
1 <= x <= 100Response
Default Response
Commission paid out (completed) in base currency.
Commission owed but not yet paid.
Commission mid-payout.
All commission across states.
-9007199254740991 <= x <= 9007199254740991Payments excluded from the totals because their currency has no conversion rate to the base currency.
-9007199254740991 <= x <= 9007199254740991Currency codes that lack a rate to the base currency.