update_statement_adjustments - Qobra public API documentation

Override computed values on one statement, or remove overrides, and recalculate the statement. 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:

get_statement lists the lines’ compensation_id.
get_statement_compensation lists the variables’ id.
list_statement_records lists the records’ record_id and the fields’ id. Only fields with calculated: true can be overridden.

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. Available only where the Qobra write tools beta is enabled. 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

Id of the statement to adjust — the id list_statements returns.

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 per call.

Show object properties

string

required

Id of the statement’s line the variable belongs to, a compensation_id get_statement lists.

string

required

Id of the variable to override: a variable’s id get_statement_compensation lists for that line, or, with record_id, the id of a calculated field list_statement_records lists.

string

Id of the record whose calculated field to override, a record_id list_statement_records returns. Omit it to override a variable of the line itself.

number | string | null

required

The value to set: a number for an amount (in the statement’s calculation currency), a float or a percentage (the ratio, 0.8 for 80%), a text for a text variable. null removes the override and brings the computed value back.

string

Why the value is overridden, one of the adjustment_reasons get_statement lists. Required when that list is not null, refused when it is null: a free-text note goes in comment.

string

A comment kept with the change in the statement’s activity.

Example

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

{
  "statement_id": "66a0b1c2d3e4f50012345678",
  "variable_overrides": [
    {
      "compensation_id": "66a0b1c2d3e4f50012341111",
      "variable_id": "66a0b1c2d3e4f50012342222",
      "value": 1500,
      "reason": "Commercial gesture",
      "comment": "Agreed with the sales director"
    },
    {
      "compensation_id": "66a0b1c2d3e4f50012341111",
      "variable_id": "66a0b1c2d3e4f50012343333",
      "record_id": "66a0b1c2d3e4f50012344444",
      "value": null
    }
  ]
}

Response

Body

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.

Show object properties

object

Show object properties

string

boolean

object

Show object properties

string

boolean

object

The record whose calculated field this is, null for a variable of the line itself.

Show object properties

string

boolean

string

What the call did: created (a new override), updated (another value on an existing override), removed (the override is gone, the computed value is back), annotated (same value, a new reason or comment logged), unchanged (nothing to write: the value is already the one sent, or there was no override to remove). One of: created, updated, removed, annotated, unchanged.

number | string

The value sent; null when it asked for the override to be removed.

​Parameters

​Example

​Response

Parameters

Example

Response