Update Sales Invoice
brc_update_sales_invoiceUpdates a sales invoice. Supplied monetary changes must be explicit and reconciled. 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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Sales invoice id. | |
| note | No | Optional. BRC "Note" field on the sales document (JSON field `note`). Leave blank to default it to the customer name (BRC customer "Name" / JSON `name`). Do not use the product name as the note. Only set this when the user explicitly provides a note. | |
| total | No | ||
| details | No | ||
| procDate | No | Processing date. Historical dates are permitted as an attempted update; BRC may accept or reject them. | |
| totalNet | No | ||
| totalVAT | No | ||
| entryDate | No | Entry date. Historical dates are permitted as an attempted update; BRC may accept or reject them. | |
| reference | No | Optional. BRC "Reference" field (JSON field `reference`). BRC "Our Ref" (JSON `ourReference`) and BRC "Your Ref" (JSON `yourReference`) default to this value when not supplied separately. | |
| saleRepId | No | ||
| vatTypeId | No | ||
| customerId | 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. | |
| companyName | Yes | Company context name, for example YOUR-COMPANY-NAME. | |
| 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. | |
| ourReference | No | ||
| productTrans | No | Complete BRC productTrans collection. Use this when changing invoice lines, quantities, unit prices, VAT or line amounts. | |
| 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. | |
| yourReference | No | ||
| bookTranTypeId | No |