Create Cash Payment
brc_create_cash_paymentCreates a cash payment in supplier-ledger, bank-lodgement or analysed-expense mode. Requires a valid routeToken issued for the matching action workflow. The token remains valid through lookup, preview and the permitted transaction. Placeholder tokens are invalid. A routeToken does not bypass preview or explicit-confirmation requirements. A call without confirmWrite: true returns confirmation_required and a payload preview. confirmWrite: true applies the previewed change after explicit confirmation. Passing preflight is not confirmation. Requires confirmCounterpartyExplicit: true; confirmation is scoped to the counterparty selected for the current preview.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | Yes | ||
| total | Yes | ||
| acCode | No | Supplier account code for ledger payments. | |
| ledger | No | Ledger amount; must equal total for supplier payments. | |
| discount | No | ||
| procDate | No | Processing date in ISO format. Defaults to entryDate. | |
| entryDate | No | Entry date in ISO format. Defaults to today. | |
| lodgement | No | Lodgement amount; must equal total when lodging to bank. | |
| routeToken | Yes | Opaque routeToken from brc_route_request for this action workflow. Required for transactional tools. Routing permission only — does not replace preview-before-posting or confirmWrite. | |
| supplierId | No | Supplier id for ledger payments. | |
| accountCode | No | Analysis account code matching analysisCategoryId, for example CP01. | |
| companyName | Yes | Company context name, for example YOUR-COMPANY-NAME. | |
| description | No | Analysis line description. | |
| confirmWrite | No | Must be true only after a plain-English preview before posting has been shown in the current conversation and the user explicitly confirmed posting (for example yes, create it / post it now / confirm). Never set true on the first call or because the user initially asked to create something. Nothing is written to Big Red Cloud until you confirm. | |
| bankAccountId | No | Bank account id for lodgements. | |
| connectionRef | No | Opaque Red connection reference returned by brc_confirm_company_connection. Pass this exact value on every later tool call when the MCP client rotates session ids (for example Vibe/Mistral). Keep reusing the same connectionRef after successful tool calls — do not start a new connection because a lookup returned empty or partial data. It is not an API key and does not contain credentials. | |
| bookTranTypeId | No | Cash Payment book transaction type id. | |
| bankAccountCode | No | Bank account code for lodgements. | |
| analysisCategoryId | No | Cash Payments analysis category id (categoryTypeId 1391170). | |
| confirmCounterpartyExplicit | No | Must be true only after the user explicitly named or confirmed the customer, supplier, or other counterparty in the current conversation. Never set true because a customer or supplier appeared in an earlier preview, was inferred from context, or was filled in without the user's explicit choice in this conversation. |