list_data_table_records).
A compensation calculates over one or more scopes (a data table filtered to a
perimeter); each scope’s records are frozen into the statement at calculation
time.
There is no compensation argument: a scope belongs to one compensation, so
scope_id alone designates it, and it is valid only on a statement that
carries it. Take both ids from the same statement’s
get_statement_compensation
(re-read it per statement), never a compensation_id or a scope letter.
A record’s values are positional against the result’s fields: the Nth
value is the Nth field, null where the record has none. Amounts are in the
result’s calculation_currency, picklists are labels, users are references
({id, email, name} objects).
Parameters
Body
Body
string
required
The
id of a row of list_statements, or of get_statement, not a user id.string
required
The
id of an entry of scopes of this very statement
(get_statement_compensation, or a line of get_statement). Neither a scope
letter nor a compensation id, and never one read on another statement.string
The whole phrase as a substring, case and accents ignored, matched on the
records’ text fields and the names of their linked records. It also
matches the record’s id in the source CRM and the scope’s name field, even
when that field is hidden from the statement. Omit it for every record.
integer
Rows per page, 1 to 250. Default 50.
integer
Rows to skip. Omit it for the first page, never null or the string ‘None’;
for the next page pass the previous next_offset.
Response
Body
Body
object[]
The scope’s displayable columns (name and type), listed once for the page;
each record’s
values follow their order.string
The currency every AMOUNT value in the records is in. 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.object[]
integer