value
(and value_before_override when overridden).
Identify the statement by statement_id (a row’s id from
list_statements or
get_statement, not a user id), then
the line within it by compensation_id. A compensation_id is valid only
on a statement whose lines carry it: re-read each statement and take the id
from that response, never from a colleague’s statement.
Amounts here stay in the line’s calculation currency, named by currency,
unlike get_statement, which
converts them. Hidden intermediate variables and the calculation rules
(formulas, tiers) are not returned. A scope’s records come from
list_statement_records,
with the scope’s id.
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
Body
Response
Body
Body
string
Deep link that opens this line in the Qobra web app — its statement, with
this compensation selected.
string
string
object
string
number
The line’s amount, in
currency: never converted, unlike get_statement’s
lines.string
The statement’s calculation currency, that of
value and of the amounts of
variables. 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.boolean
True when a value behind this line (a variable of the line, of one of its
records, or the line itself) was corrected by hand, through
update_statement_adjustments or in the web app. A line entered by hand is
manual instead.boolean
True when the compensation or its line errored.
boolean
boolean
True on a line entered by hand: a manual payment, or the draw when
draw is
true too.boolean
True on the draw line (the recoverable advance);
manual tells whether its
amount was set by hand.string
How often the compensation is calculated, on the company’s fiscal calendar.
EACH_MONTH every month; EACH_MONTH_EXCEPT_END_OF_QUARTER every month but the
one each quarter closes on; EACH_QUARTER, EACH_SEMESTER and EACH_YEAR at
each period’s close; Q1-Q4 once a year, at that quarter’s close only. A
compensation bounded to a window is calculated at most once: on the
statement closing the period of its cadence that holds the window’s last
day, and never when its cadence does not calculate on that period.
string
object
object[]
The compensation’s scopes (calculation perimeters) the statement displays; a
hidden one is left out. A scope’s
id is the scope_id of
list_statement_records.object[]
Every displayable variable of the compensation with its value, the breakdown
behind the amount. Hidden (intermediate) variables are left out.