list_statements - Qobra public API documentation

List the statements you can see, with simple filters and pagination. You only see the statements you have access to. Each row exposes a resource_url that opens that single statement. The result also carries a list-level application_url that reopens the statements board on the queried period, with the chosen saved view selected when view is passed — the link round-trips the exact view the caller selected. It is always set because period is required.

Parameters

Body

string

required

Period in YYYY-MM format (e.g. 2026-03). Required.

string

Free-text filter matched against the statement’s user (name or email), same matching as list_users search.

string

Status filter. One of ongoing (open / not yet locked), locked (frozen but not paid), paid (sent to payroll), or error (the calculation errored out). The error condition is bundled into this single field.

boolean

If True, only statements with at least one manual amount adjustment (overwritten).

boolean

If True, only statements that have at least one linked request you can access.

string

Compensation plan, matched either by name (a case-insensitive substring of the plan name) or by ObjectId.

string

Saved statement view to apply, by name (case- and accent-insensitive substring) or ObjectId. Narrows the results to the users that view exposes — a filtering aid, it never widens what you can see. Discover the views you can pass from get_identity (the views of your statement access). An unknown or inaccessible view raises an error listing the views you can choose.

string

Narrow to this manager’s team — everyone below them in the hierarchy (all levels, not just direct reports). Match the manager by name or email (case-insensitive substring) or by ObjectId. It only filters within what you can already see — a teammate outside your access stays hidden.

string

Which currency each total_payment is converted into and labelled with: ‘payment’ (default) — the currency the user is paid in; ‘calculation’ — the currency the plan computes in; ‘company’ — the company’s global currency. The amount and its currency always agree. One of: company, payment, calculation.

integer

Page size, between 1 and 250. Defaults to 50.

integer

Row offset into the result set — the number of rows to skip before this page. Pass the next_offset returned by the previous call, or None for the first page.

Response

Body

object[]

Show object properties

string

Deep link to open this statement in the Qobra web app.

object

Show object properties

string

Overall processing state: error (calculation failed), ongoing (open, not yet locked), locked (frozen, not yet paid), paid (sent to payroll). A paid statement is always frozen too. Distinct from the per-period reporting stage of list_statement_periods. One of: error, ongoing, locked, paid.

number

Net amount to be paid out on this statement, expressed in currency — already reflects draw and manual payments, so it is not just the sum of the compensation lines.

string

The ISO currency code that total_payment is expressed 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.

string

When the statement last finished computing and was up to date; null if it never reached that state.

object[]

Show object properties

string

object

Show object properties

string

object

Show object properties

string

integer

string

Deep link that reproduces this list in the web app — the statements board opened on the queried period, with the chosen saved view selected when a view was passed. Always present, since period is required.

​Parameters

​Response

Parameters

Response