Create Cash Receipt
brc_create_cash_receiptCreates a BRC cash receipt. Accepts either a raw payload object or common flat fields. Customer-ledger receipts require both customerId and acCode resolved for the same customer; neither field alone is sufficient. Analysed receipts may instead supply an analysis allocation without a customer. entryDate defaults to today; procDate defaults to entryDate. The preview shows these resolved dates; carry them into the confirmation call to preserve them if confirming on a later day. VAT rate fields are only sent when the company's VAT on Cash Receipt setting is enabled. 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 | No | ||
| total | No | ||
| acCode | No | Resolved customer account code. Customer-ledger receipts also require customerId for the same customer; analysed receipts can omit both. | |
| ledger | No | ||
| details | No | ||
| payload | No | Raw cash-receipt fields. Customer-ledger mode requires both customerId and acCode for the same resolved customer; analysed mode uses analysis allocation instead. | |
| discount | No | ||
| procDate | No | Processing date; defaults to entryDate and is shown in the preview. | |
| totalNet | No | ||
| totalVAT | No | ||
| totalVat | No | ||
| acEntries | No | ||
| entryDate | No | Entry date; defaults to today and is shown in the preview. | |
| reference | No | Cash receipts do not support reference in the documented BRC API. Use detailCollection for audit or bank-reference text. | |
| vatRateId | No | ||
| vatTypeId | No | ||
| customerId | No | Resolved customer id. Customer-ledger receipts also require acCode for the same customer; analysed receipts can omit both. | |
| percentage | No | ||
| 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. | |
| vatEntries | No | ||
| accountCode | No | ||
| companyName | Yes | Company context name, for example YOUR-COMPANY-NAME. | |
| description | No | ||
| unallocated | No | ||
| 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. | |
| customFields | No | ||
| 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. | |
| vatPercentage | No | ||
| bookTranTypeId | No | ||
| detailCollection | No | ||
| analysisCategoryId | No | ||
| 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. |