Skip to main content
Get the full calculated breakdown of one compensation on a statement. A compensation is one commission line of a statement. get_statement returns each line as a minimal row; this returns the whole displayable variable breakdown behind its amount — every variable with its value (and, when an admin overrode it, the value_before_override) — plus the compensation’s plan, periodicity, ranking and its scopes (drill into their frozen records with list_statement_records). Hidden intermediate variables and the calculation rules themselves (formulas, tiers) are not exposed. Identify the statement by statement_id (from list_statements / get_statement), then name the compensation within it. A statement or compensation you can’t access reads exactly like one that doesn’t exist, so the error never reveals anything outside your scope.

​
Parameters

Body

​
statement_id
string
required
The statement’s id, as returned by list_statements or get_statement.
​
compensation
string
required
The compensation to open, matched by its compensation_id (as returned by get_statement) or by name (case-insensitive, exact match preferred over substring).

​
Response

Body

​
compensation_id
string
​
name
string
​
plan_name
string
​
description
string
​
value
number
​
currency
string
One of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RMB, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYI, UYU, UZS, VEF, VND, VUV, WON, WST, XAF, XAG, XAU, XCD, XOF, XPD, XPF, XPT, XSU, YER, ZAR, ZMK, ZWL.
​
overwritten
boolean
​
error
boolean
True when the compensation or its line errored.
​
validated
boolean
​
manual
boolean
​
draw
boolean
​
calculation_frequency
string
How often the compensation is calculated (e.g. EACH_MONTH, EACH_QUARTER, EACH_YEAR).
​
effective_non_financial_reward
string
​
ranking
object
​
scopes
object[]
The compensation’s scopes (its calculation perimeters). Drill into a scope’s frozen records with list_statement_records.
​
variables
object[]
Every displayable variable of the compensation with its value — the full calculated breakdown behind the amount. Hidden (intermediate) variables are excluded.