- Add a line without a
payment_id. - Change a line with the
payment_idget_statementlists on it. - Remove a line with
value: null.
get_company_settings reports.
A draw cannot be set to 0 by hand: send value: null to go back to the
automatic one. Setting a draw by hand also rewrites the balance carried by the
empty statements that follow, locked and paid ones included, as in the Qobra
web app.
The call is all or nothing. An unknown payment_id, a new line without a label
or a value, 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 change 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. Qobra
notifies the user of each change, as from the web app.
The statement’s total and balance are up to date when the call returns; no
recalculation is needed. To override a computed value instead, use
update_statement_adjustments.
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
Body
Manual payment lines to add, change or remove, at most 50. Omit it to leave
the lines as they are.
The draw to set by hand on this statement;
value: null goes back to the
automatic draw. Omit it to leave the draw as it is.Example
Add a manual payment line, remove another one and set the draw by hand:Response
Body
Body
Net amount to be paid out after the call, in
currency: lines, manual
payments and draw together.The statement’s calculation currency, that of every amount here and in the
call. 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.