Preview booking a bank line to a director's or shareholder's Owner's Money

Shows how a bank or cash line will be booked to the person's Owner's Money personal account (the app's "paid for a director" action): a payment out raises what they owe the company (Dr Loans to directors or shareholders), money in raises what the company owes them, never with VAT and without a supplier or customer. Body: transaction_id. A line with no live booking needs nothing else, even when it still shows an account or a contact (what bankTransaction.booking.undo leaves on a bank-feed line, or a rule's prefill): the commit replaces them. A salary line the caller may not see is refused with 403 first. Without replace_booking_id the refusals are 422 with their code in error.code and the sentence in the message: related_party_reconcile_line_has_booking (another booking still holds the line, even one sent back for review on a line that shows no account), related_party_reconcile_line_still_posted (no booking holds the line, but a journal for it is still posted), related_party_reconcile_currency (base currency only), related_party_not_director_or_shareholder, related_party_reconcile_not_bank_line, related_party_reconcile_line_changed, and at the commit period_locked (the line's date is in a closed period or on or before the VAT lock date). A line already booked by a plain categorization (for example to Loans to directors with a placeholder supplier, which reaches the ledger but not the personal account) needs replace_booking_id, the id of that booking: the commit undoes it exactly as the app's undo does (its journal is removed) and books the line to the personal account in the same transaction; effects.replaced_booking shows what is undone. Without replace_booking_id a booked line is refused with related_party_reconcile_line_booked, naming the booking in error.fields.booked_transaction_ids. Refusals with replace_booking_id name their code in error.code and at the start of the message: related_party_reclassify_booking_mismatch (422, not a booking of this line), related_party_reclassify_not_plain_booking (a bill or invoice match, transfer, split or fee: undo it, then book the line without replace_booking_id), related_party_reclassify_dividend_payment (a dividend paid through Dividends: undo a matched payment on the bank line in Cybooks, which the public API cannot do; for the cash line Dividends made, void the dividend in Dividends; a plain categorization to Dividend disbursed or Dividends payable moves like any other), related_party_reclassify_withholding_remittance (withheld dividend tax paid to the Tax Department: a plain categorization to an SDC or GHS withholding payable, or Reconcile's booking against the dividend's withholding), related_party_reclassify_already_related_party, related_party_reclassify_manual_line (a line entered in Cybooks, which undo deletes), related_party_reclassify_currency (base currency only), related_party_reclassify_period_locked, related_party_reclassify_vat_filed (both named before any refusal that says to undo the booking). With replace_booking_id the caller also needs what bankTransaction.booking.undo needs: the update_bank_accounts permission and the bank-transactions:action scope (403 otherwise). Writes nothing. Requires Idempotency-Key: send the same key again on the commit, which also needs If-Match = the related party's current ETag from relatedParty.show. 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

Proposed values used to preview booking a bank line to a director's or shareholder's owner's money without persisting changes.

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
Headers
string
required
length ≤ 191

Required operation-specific request key. This requirement does not imply durable public API response replay.

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
*/*