Preview a bulk categorize of bank lines

Bulk categorize, step 1: previews categorizing many bank lines (1 to 50 items) without booking or locking anything. Each item is the body bankTransaction.categorize takes (counterparty_id, account_id or account_code, tax_rule_id or tax_code, memo, optional tags) plus the line's bank_transaction_id, each line once. An empty items, one that is not a list or more than 50 items refuses the whole request with 422 keyed items; a wrong item shape or a duplicate line, keyed items.N.<field>. Every item answers on its own, with its index: ready with the journal the categorize would post (per line the account, debit and credit in the company's currency, the line currency's amounts and the tax rule; for a line in another currency the exchange_rate used), or refused with http_status, code, message and fields exactly as bankTransaction.categorize refuses that line (bank_line_already_booked, bank_line_held_by_booking, bank_line_excluded, supplier_refund_needs_vendor_credit, tags_need_plan, a hidden salary's forbidden, a closed period and so on; a field a message names is keyed items.N.<field>). totals counts the ready and refused items and sums the ready items' debits and credits, in the company's currency and per bank line currency. When any item is ready, confirmation_token binds the ready items for 5 minutes to this caller, client, Idempotency-Key and body; refused items are never booked. Counts as one request toward the rate limit and the daily cap, whatever the number of items. Requires Idempotency-Key (reuse it on the commit), the bank-transactions:action OAuth scope and update_bank_accounts. Answers 503 with Retry-After while bulk categorize is switched off.

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

Proposed values used to preview a bulk categorize of bank lines without persisting changes.

Bulk categorize (MCP agent feedback P5): up to 50 bank lines, each with
the body bankTransaction.categorize takes. An empty items, one that is
not a list or more than 50 items refuses the whole request with 422 keyed
items; a wrong item shape or a duplicate line, keyed items.N.<field>.
What the single categorize refuses for a line (its tags included) is that
item's answer in the preview.

items
array of objects
required
length between 1 and 50

The bank lines to categorize: 1 to 50 items, each line once, each with the body bankTransaction.categorize takes.

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