Book a bank line to a director's or shareholder's Owner's Money

Commits a reconciliation previewed with relatedParty.reconcile.preview: send the same body (transaction_id, and replace_booking_id when the preview had one), the preview's confirmation_token, the SAME Idempotency-Key the preview was sent with (the token is bound to it: another key is refused with 422) and, as If-Match, the related party's ETag from relatedParty.show (MCP: response.etag of cybooks_get_related_party). That ETag advances with every reconcile and settlement of the person, so for the next line use the ETag this commit returns (or read the person again); a stale one is refused with 412. One transaction books Dr/Cr the personal account's chart account against the bank account, writes the personal account movement and tags the line with the person; with replace_booking_id the old categorization is undone first, so the ledger total of the account it was booked to moves only by what changed. A line, booking or person that changed since the preview is refused with 412 (a booking undone or replaced since then with 422 related_party_reclassify_booking_mismatch); a closed or filed VAT period with related_party_reclassify_period_locked / related_party_reclassify_vat_filed. The result names the bank booking (id) and replaced_booked_transaction_id. With replace_booking_id it also requires update_bank_accounts and the bank-transactions:action scope. Requires the related-parties:action OAuth scope with related-parties.update, owner-money.view and owner-money.settle.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Confirmed values used to book a bank line to a director's or shareholder's owner's money, including the confirmation token returned by relatedParty.reconcile.preview.

uuid
required
uuid | null

The bank line's current booking (a plain categorization) to undo
and replace with the Owner's Money classification, in one
transaction. Omit it for an uncategorized line.

string
required
length ≤ 8192
Headers
string
required
length ≤ 191

Required unique key whose request hash and terminal response are stored durably for 24 hours.

string

Required. ETag from the latest representation; a stale value returns 412 precondition_failed. Send this header, not the standard If-Match: some HTTP intermediaries evaluate a standard If-Match themselves and can answer 412 even though the change was applied. Never send both; both with different ETags returns 400 conflicting_precondition_headers.

string
deprecated

Accepted with the same value and meaning as Cybooks-If-Match, but do not send it: an intermediary can answer 412 to it after the change was applied. Send Cybooks-If-Match instead.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*