Skip to main content
Override computed values on one statement, or remove overrides, then recalculate it. An override replaces the value the compensation computed, for this statement only. It applies to a variable of one of the statement’s lines (a KPI, an intermediate result, the line’s amount) or to a calculated field of one of the records the line counts. Only the overrides sent are written. An override left out keeps its value, and value: null removes one, bringing the computed value back. Read the ids first: Amounts are in the statement’s calculation currency, and a percentage is the ratio (0.8 for 80%). Only amount, float, percentage and text values can be overridden. A record’s field read from its data table cannot: change it on the record with update_record. The call is all or nothing. An unknown id, a value of the wrong kind or a missing reason refuses the whole call before anything is written. A locked statement is refused. When the company requires a reason for statement adjustments, each override cites one of the adjustment_reasons get_statement lists. When the company requires none (adjustment_reasons is null), a reason is refused: put a free-text note in comment instead. When a value changes, Qobra launches the statement’s recalculation. Its amounts are stale until get_statement reports calculation_status ready. Only this statement is recalculated: when later months build on it (a carried balance, a year-to-date total), call recalculate_statements on them. Every write to the live environment is recorded in the audit trail as the Qobra MCP agent; writes to a sandbox are not audited.

Parameters

Body

string
required
The id of a row of list_statements, not a user id.
object[]
required
The values to override, each on a variable of one of the statement’s lines or on a calculated field of one of its records. At most 50.

Example

Override a line’s amount and remove the override on a record’s calculated field:

Response

Body

string
string
Deep link to the statement in the Qobra web app.
boolean
True when a value changed and the statement’s recalculation was launched: its amounts are stale until get_statement reports calculation_status ready.
object[]
One row per override sent, in the order sent.