Red by Big Red Cloud

Batch Payments

brc_batch_payments

Destructive

Processes supplier or analysed bank payments in a batch. Results are reported per submitted item and partial success is possible. 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.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "companyName": "<companyName>",
      "items": "<items>",
      "routeToken": "<routeToken>"
    },
    "name": "brc_batch_payments"
  }
}

Input Schema

Name	Required	Description
`items`	Yes	Batch items to process. Maximum 100 items per request.
`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.
`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.
`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.

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedOct 21, 2026

changedInput schema / properties / items / description

Previous value: -"Batch items to process. Maximum 20 items per request."New value: +"Batch items to process. Maximum 100 items per request."

changedInput schema / properties / items / maxItems
```
Previous value: -20New value: +100
```

Changed6 schema fields changedAug 25, 2026

removedInput schema / properties / confirmCrAnalysisCategory

Removed value: -{
-  "description": "Applies to every sales document item in this batch. Set true only after the user confirms a CR (customer) sales analysis account code is intentional for these product lines.",
-  "type": "boolean"
-}

changedInput schema / properties / items / items / additionalProperties
```
Previous value: -{}New value: +false
```

addedInput schema / properties / items / items / properties

Added value: +{
+  "item": {
+    "oneOf": [
+      {
+        "additionalProperties": false,
+        "properties": {
+          "acCode": {
+            "description": "Supplier account code.",
+            "minLength": 1,
+            "type": "string"
+          },
+          "bankAccountCode": {
+            "description": "BRC bank account code.",
+            "minLength": 1,
+            "type": "string"
+          },
+          "bankAccountId": {
+            "description": "BRC bank account id.",
+            "exclusiveMinimum": 0,
+            "maximum": 9007199254740991,
+            "type": "integer"
+          },
+          "bookTranTypeId": {
+            "const": 3,
+            "description": "Payments book transaction type id. Must be 3.",
+            "type": "number"
+          },
+          "discount": {
+            "type": "number"
+          },
+          "entryDate": {
+            "description": "Entry date in ISO format.",
+            "minLength": 1,
+            "type": "string"
+          },
+          "note": {
+            "description": "Payment note.",
+            "minLength": 1,
+            "type": "string"
+          },
+          "procDate": {
+            "description": "Processing date in ISO format.",
+            "minLength": 1,
+            "type": "string"
+          },
+          "reference": {
+            "type": "string"
+          },
+          "supplierId": {
+            "description": "BRC supplier id.",
+            "exclusiveMinimum": 0,
+            "maximum": 9007199254740991,
+            "type": "integer"
+          },
+          "total": {
+            "description": "Positive Payment total.",
+            "exclusiveMinimum": 0,
+            "type": "number"
+          }
+        },
+        "required": [
+          "total",
+          "note",
+          "entryDate",
+          "procDate",
+          "bookTranTypeId",
+          "bankAccountId",
+          "bankAccountCode",
+          "supplierId",
+          "acCode"
+        ],
+        "type": "object"
+      },
+      {
+        "additionalProperties": false,
+        "properties": {
+          "accountCode": {
+            "description": "Payments-book analysis account code for the non-supplier payment.",
+            "minLength": 1,
+            "type": "string"
+          },
+          "analysisCategoryId": {
+            "description": "Payments-book analysis category id for the non-supplier payment.",
+            "exclusiveMinimum": 0,
+            "maximum": 9007199254740991,
+            "type": "integer"
+          },
+          "bankAccountCode": {
+            "description": "BRC bank account code.",
+            "minLength": 1,
+            "type": "string"
+          },
+          "bankAccountId": {
+            "description": "BRC bank account id.",
+            "exclusiveMinimum": 0,
+            "maximum": 9007199254740991,
+            "type": "integer"
+          },
+          "bookTranTypeId": {
+            "const": 3,
+            "description": "Payments book transaction type id. Must be 3.",
+            "type": "number"
+          },
+          "description": {
+            "description": "Description for the payment analysis line.",
+            "minLength": 1,
+            "type": "string"
+          },
+          "discount": {
+            "type": "number"
+          },
+          "entryDate": {
+            "description": "Entry date in ISO format.",
+            "minLength": 1,
+            "type": "string"
+          },
+          "note": {
+            "description": "Payment note.",
+            "minLength": 1,
+            "type": "string"
+          },
+          "procDate": {
+            "description": "Processing date in ISO format.",
+            "minLength": 1,
+            "type": "string"
+          },
+          "reference": {
+            "type": "string"
+          },
+          "total": {
+            "description": "Positive Payment total.",
+            "exclusiveMinimum": 0,
+            "type": "number"
+          }
+        },
+        "required": [
+          "total",
+          "note",
+          "entryDate",
+          "procDate",
+          "bookTranTypeId",
+          "bankAccountId",
+          "bankAccountCode",
+          "analysisCategoryId",
+          "accountCode",
+          "description"
+        ],
+        "type": "object"
+      }
+    ]
+  },
+  "opCode": {
+    "const": 1,
+    "description": "BRC batch create operation code. Must be 1.",
+    "type": "number"
+  }
+}

removedInput schema / properties / items / items / propertyNames
```
Removed value: -{
-  "type": "string"
-}
```
addedInput schema / properties / items / items / required
```
Added value: +[
+  "opCode",
+  "item"
+]
```

removedInput schema / properties / priceBasis

Removed value: -{
-  "description": "Applies to every sales invoice/credit note item in this batch. Required when Gross Price Entry is enabled. Use `gross` when unit prices are VAT-inclusive/gross. Use `net` when unit prices are VAT-exclusive/net.",
-  "enum": [
-    "net",
-    "gross"
-  ],
-  "type": "string"
-}

Changed2 schema fields changedAug 5, 2026

addedInput schema / properties / routeToken

Added value: +{
+  "description": "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.",
+  "minLength": 1,
+  "type": "string"
+}

changedInput schema / required

Previous value: -[
-  "companyName",
-  "items"
-]New value: +[
+  "companyName",
+  "items",
+  "routeToken"
+]

Changed2 schema fields changedAug 4, 2026

removedInput schema / properties / routeToken

Removed value: -{
-  "description": "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.",
-  "minLength": 1,
-  "type": "string"
-}

changedInput schema / required

Previous value: -[
-  "companyName",
-  "items",
-  "routeToken"
-]New value: +[
+  "companyName",
+  "items"
+]

Changed2 schema fields changedAug 4, 2026

addedInput schema / properties / routeToken

Added value: +{
+  "description": "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.",
+  "minLength": 1,
+  "type": "string"
+}

changedInput schema / required

Previous value: -[
-  "companyName",
-  "items"
-]New value: +[
+  "companyName",
+  "items",
+  "routeToken"
+]

First observedJul 30, 2026

TDQS

A4.2/5.0

Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Goes well beyond the annotations: partial success is possible, results are reported per item, placeholder tokens are invalid, preflight is not confirmation, and confirmCounterpartyExplicit is scoped to the currently previewed counterparty. This is exactly the mutation-safety context the destructiveHint annotation cannot convey.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the purpose and partial-success behavior, then layers the token and confirmation rules in short declarative sentences. Slightly repetitive about what the routeToken does not bypass, but nearly every sentence carries distinct gating semantics.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 6-parameter, high-risk batch mutation with no output schema, the description covers the safety and workflow essentials an agent needs to avoid an unintended write. It does not touch the two item shapes or the 100-item cap, but those are fully specified in the schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description still adds semantics the schema lacks in structured form: the routeToken's validity window across lookup/preview/transaction and the explicit 'preflight is not confirmation' rule. Most confirmWrite/confirmCounterpartyExplicit content duplicates the schema descriptions, limiting it below 5.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Processes supplier or analysed bank payments in a batch') and scopes it to two payment kinds, which distinguishes it from brc_batch_purchases and brc_batch_cash_payments. It does not name those siblings explicitly, so an agent must infer the boundary, but the verb+resource is unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives strong workflow gating: a routeToken is required, preview and explicit confirmation are mandatory, and confirmWrite must only be true after a preview plus user confirmation. It tells the agent when NOT to set the flag ('Never set true on the first call'), but it never names an alternative tool for the non-batch path.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Red by Big Red Cloud tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Batch Payments

Tool call template

Input Schema

Schema Changelog

TDQS

Glama MCP Gateway

Resources