Call this server's tools from your browser. Nothing to install.
https://red.bigredcloud.com/mcp
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
brc_batch_cash_payments Destructive
Processes cash payments in supplier-ledger, bank-lodgement or analysed-expense mode. 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.
Batch items to process. Maximum 100 items per request.
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.
Company context name, for example YOUR-COMPANY-NAME.
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.
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.
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.
The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.
Tools (159)
brc_batch_cash_payments
Processes cash payments in supplier-ledger, bank-lodgement or analysed-expense mode. 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.
destructive
Argument
Type
Description
items*
array
Batch items to process. Maximum 100 items per request.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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
string
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
boolean
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"items",
"routeToken"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"opCode",
"item"
],
"properties": {
"item": {
"oneOf": [
{
"type": "object",
"required": [
"total",
"note",
"entryDate",
"procDate",
"bookTranTypeId",
"supplierId",
"acCode",
"ledger"
],
"properties": {
"note": {
"type": "string",
"minLength": 1,
"description": "Cash Payment note."
},
"total": {
"type": "number",
"description": "Positive Cash Payment total.",
"exclusiveMinimum": 0
},
"acCode": {
"type": "string",
"minLength": 1,
"description": "Supplier account code."
},
"ledger": {
"type": "number",
"description": "Supplier-ledger amount; must equal total.",
"exclusiveMinimum": 0
},
"discount": {
"type": "number"
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Processing date in ISO format."
},
"entryDate": {
"type": "string",
"minLength": 1,
"description": "Entry date in ISO format."
},
"supplierId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC supplier id.",
"exclusiveMinimum": 0
},
"bookTranTypeId": {
"type": "number",
"const": 2,
"description": "Cash Payment book transaction type id. Must be 2."
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"total",
"note",
"entryDate",
"procDate",
"bookTranTypeId",
"bankAccountId",
"bankAccountCode",
"lodgement"
],
"properties": {
"note": {
"type": "string",
"minLength": 1,
"description": "Cash Payment note."
},
"total": {
"type": "number",
"description": "Positive Cash Payment total.",
"exclusiveMinimum": 0
},
"discount": {
"type": "number"
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Processing date in ISO format."
},
"entryDate": {
"type": "string",
"minLength": 1,
"description": "Entry date in ISO format."
},
"lodgement": {
"type": "number",
"description": "Bank lodgement amount; must equal total.",
"exclusiveMinimum": 0
},
"bankAccountId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC bank account id receiving the lodgement.",
"exclusiveMinimum": 0
},
"bookTranTypeId": {
"type": "number",
"const": 2,
"description": "Cash Payment book transaction type id. Must be 2."
},
"bankAccountCode": {
"type": "string",
"minLength": 1,
"description": "BRC bank account code receiving the lodgement."
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"total",
"note",
"entryDate",
"procDate",
"bookTranTypeId",
"analysisCategoryId",
"accountCode",
"description"
],
"properties": {
"note": {
"type": "string",
"minLength": 1,
"description": "Cash Payment note."
},
"total": {
"type": "number",
"description": "Positive Cash Payment total.",
"exclusiveMinimum": 0
},
"discount": {
"type": "number"
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Processing date in ISO format."
},
"entryDate": {
"type": "string",
"minLength": 1,
"description": "Entry date in ISO format."
},
"accountCode": {
"type": "string",
"minLength": 1,
"description": "Cash Payments analysis account code."
},
"description": {
"type": "string",
"minLength": 1,
"description": "Analysis-line description."
},
"bookTranTypeId": {
"type": "number",
"const": 2,
"description": "Cash Payment book transaction type id. Must be 2."
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Cash Payments analysis category id.",
"exclusiveMinimum": 0
}
},
"additionalProperties": false
}
]
},
"opCode": {
"type": "number",
"const": 1,
"description": "BRC batch create operation code. Must be 1."
}
},
"additionalProperties": false
},
"maxItems": 100,
"minItems": 1,
"description": "Batch items to process. Maximum 100 items per request."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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": {
"type": "boolean",
"description": "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."
}
}
}
brc_batch_cash_receipts
Processes a batch of BRC cash receipts. Maximum 100 items per batch request. 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.
destructive
Argument
Type
Description
items*
array
Batch items to process. Maximum 100 items per request.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
brc_batch_customers
Processes a batch of customers using explicit identity, VAT classification, and optional contact fields. Maximum 100 items per batch request. 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.
destructive
Argument
Type
Description
items*
array
Batch items to process. Maximum 100 items per request.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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
brc_batch_payments
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.
destructive
Argument
Type
Description
items*
array
Batch items to process. Maximum 100 items per request.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
brc_batch_products
Processes a batch of products using explicit product type, VAT classification, price, and description fields. Maximum 100 items per batch request. 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.
destructive
Argument
Type
Description
items*
array
Batch items to process. Maximum 100 items per request.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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
brc_batch_purchases
Processes purchases in a batch using structured generated-reference purchase items. 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.
destructive
Argument
Type
Description
items*
array
Batch items to process. Maximum 100 items per request.
priceBasis
string
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.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
brc_batch_quotes
Processes a batch of quotes using either verified flat creator fields or a complete nested BRC Quote payload. Maximum 100 items per batch request. 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.
destructive
Argument
Type
Description
items*
array
Batch items to process. Maximum 100 items per request.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
brc_batch_sales_credit_notes
Processes sales credit notes in a batch using reconciled product, VAT and Sales-analysis lines. 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.
destructive
Argument
Type
Description
items*
array
Batch items to process. Maximum 100 items per request.
priceBasis
string
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.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
brc_batch_sales_entries
Processes sales entries with positive, zero or negative amounts and multiple VAT lines. The optional batchSize is a per-request limit. An omitted value uses the sales-entry configuration, then the general batch configuration, then fallback 20. The hard ceiling is 100, with no automatic splitting. Maximum 100 items per batch request. 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.
destructive
Argument
Type
Description
items*
array
Batch items to process. Maximum 100 items per request.
batchSize
integer
Maximum item count for this request, not an automatic chunk size. If omitted: BRC_SALES_ENTRY_BATCH_SIZE, then BRC_MAX_BATCH_ITEMS, then fallback 20. Hard ceiling 100. RED never auto-splits requests; preview/confirm each submitted set.
routeToken*
string
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*
string
brc_batch_sales_invoices
Processes sales invoices in a batch using reconciled product, VAT and Sales-analysis lines. 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.
destructive
Argument
Type
Description
items*
array
Batch items to process. Maximum 100 items per request.
priceBasis
string
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.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
brc_batch_sales_reps
Processes a batch of sales representatives using explicit code and name fields. Maximum 100 items per batch request. 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.
destructive
Argument
Type
Description
items*
array
Batch items to process. Maximum 100 items per request.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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
string
brc_batch_suppliers
Processes a batch of suppliers using explicit identity, VAT classification, and optional contact fields. Maximum 100 items per batch request. 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.
destructive
Argument
Type
Description
items*
array
Batch items to process. Maximum 100 items per request.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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
brc_check_transaction_settings
Returns processing-setting warnings for one specified transaction workflow. It does not provide an overall company-readiness score.
read-only
Argument
Type
Description
workflow*
string
The workflow to check against the company processing settings.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"workflow"
],
"properties": {
"workflow": {
"enum": [
"sales_invoice",
"purchase",
"cash_receipt",
"statement"
],
"type": "string",
"description": "The workflow to check against the company processing settings."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_clear_all_company_api_keys
Clears all connection credentials for all company contexts from MCP server memory.
destructive
Argument
Type
Description
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_clear_audit_log
Clear the Red audit log for this MCP server session. 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.
destructive
Argument
Type
Description
confirmClear
boolean
Must be true to confirm that the session audit log should be cleared.
confirmWrite
boolean
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
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"confirmClear": {
"type": "boolean",
"default": false,
"description": "Must be true to confirm that the session audit log should be cleared."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
}
}
}
brc_clear_company_api_key
Clears the API key for a named company context from MCP server memory.
destructive
Argument
Type
Description
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_close_quote
Closes a BRC quote. 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.
Argument
Type
Description
id*
any
Quote id.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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
string
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.
brc_company_readiness_check
Returns overall company readiness across connection, financial year, reference data, VAT, analysis categories and settings.
read-only
Argument
Type
Description
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_confirm_company_connection
Confirms a short-lived company-connection code and returns the connected companies plus a reusable opaque connection reference. Connection credentials are not returned.
Argument
Type
Description
code*
string
The connection code from the secure Red connection page success message.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"code"
],
"properties": {
"code": {
"type": "string",
"minLength": 1,
"description": "The connection code from the secure Red connection page success message."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_create_accrual
Creates an accrual after returning an unconfirmed payload preview. 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.
destructive
Argument
Type
Description
total*
number
Accrual total amount.
acCode*
string
Nominal account code, for example 4000.
procDate*
string
Processing date, for example 2024-03-15T00:00:00.
entryDate*
string
Entry date, for example 2024-03-01T00:00:00.
reference*
string
Accrual reference, for example ACC0001.
routeToken*
string
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.
brc_create_bank_account
Creates a bank account after an unconfirmed preview. confirmCreate applies the previewed creation. 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.
Argument
Type
Description
acCode
string
Bank account code, for example 1603.
address
array
balance
number
Opening/current starting balance.
details
string
Bank account description/name.
lastChq
string
Last cheque number, for example 000001.
payload
object
Optional raw bank account payload.
sortCode
string
categoryId
integer
Bank Payments category type id from brc_list_category_types.
routeToken*
string
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.
brc_create_cash_payment
Creates 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.
destructive
Argument
Type
Description
note*
string
total*
number
acCode
string
Supplier account code for ledger payments.
ledger
number
Ledger amount; must equal total for supplier payments.
discount
number
procDate
string
Processing date in ISO format. Defaults to entryDate.
entryDate
string
Entry date in ISO format. Defaults to today.
brc_create_cash_receipt
Creates 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.
destructive
Argument
Type
Description
note
string
total
number
acCode
string
Resolved customer account code. Customer-ledger receipts also require customerId for the same customer; analysed receipts can omit both.
ledger
number
details
string
brc_create_customer
Creates a BRC customer from explicit code and name fields. Optional address, contact, credit and VAT fields are omitted when absent. Opening-balance fields are not posted. 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.
Argument
Type
Description
payload*
object
Raw BRC-compatible payload for this endpoint.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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
string
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.
brc_create_nominal_journal_batch
Creates a nominal journal batch after returning an unconfirmed payload preview. 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.
destructive
Argument
Type
Description
total*
number
Total journal amount.
procDate*
string
Processing date, for example 2024-01-15T00:00:00.
entryDate*
string
Entry date, for example 2024-01-15T00:00:00.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
Must be true only after the user explicitly confirms creating this Nominal Journal Batch.
brc_create_payment
Creates a bank payment in supplier or analysed-account 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.
destructive
Argument
Type
Description
note*
string
total*
number
acCode
string
Supplier account code for supplier payments.
discount
number
procDate
string
Processing date in ISO format. Defaults to entryDate.
entryDate
string
Entry date in ISO format. Defaults to today.
reference
string
routeToken
brc_create_prepayment
Creates a prepayment after returning an unconfirmed payload preview. 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.
destructive
Argument
Type
Description
total*
number
Prepayment total amount.
acCode*
string
Nominal account code, for example 4000.
procDate*
string
Processing date, for example 2024-03-15T00:00:00.
entryDate*
string
Entry date, for example 2024-03-01T00:00:00.
reference*
string
Prepayment reference, for example PRE0001.
routeToken*
string
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.
brc_create_product
Creates a BRC product using a raw BRC payload. 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.
Argument
Type
Description
payload*
object
Raw BRC-compatible payload for this endpoint.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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
string
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.
brc_create_purchase
Creates a purchase with a caller-supplied reference when manual purchase references are configured. 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.
destructive
Argument
Type
Description
note*
string
Purchase note.
acCode*
string
Supplier account code, for example SUP001.
procDate*
string
Processing date in ISO format.
entryDate*
string
Entry date in ISO format.
netAmount*
number
Net amount before VAT.
reference
string
Required when the company is configured for manual purchase references.
brc_create_purchase_gen_ref
Creates a purchase using the company's generated-reference configuration. 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.
destructive
Argument
Type
Description
note*
string
acCode*
string
procDate*
string
entryDate*
string
netAmount*
number
vatRateId*
integer
routeToken*
string
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.
brc_create_quote
Creates a quote with a caller-supplied reference and reconciled product, VAT and Sales-analysis lines. 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.
Argument
Type
Description
acCode*
string
comments*
string
ddNumber
string
poNumber
string
procDate*
string
quantity*
number
tranNote*
string
companyId*
integer
brc_create_quote_gen_ref
Creates a quote using generated references and reconciled product, VAT and Sales-analysis lines. 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.
Argument
Type
Description
acCode*
string
comments*
string
ddNumber
string
poNumber
string
procDate*
string
quantity*
number
tranNote*
string
companyId*
integer
brc_create_sales_credit_note
Creates a sales credit note with a caller-supplied reference and reconciled negative document amounts. 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.
destructive
Argument
Type
Description
note*
string
acCode*
string
procDate*
string
quantity*
number
entryDate*
string
netAmount*
number
productId*
integer
brc_create_sales_credit_note_gen_ref
Creates a sales credit note using generated references and reconciled negative document amounts. 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.
destructive
Argument
Type
Description
payload*
object
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
brc_create_sales_entry
Creates one BRC sales entry with positive, zero or negative net values and multiple VAT lines. Legacy single-VAT fields remain supported. Zero entries may omit analysis and VAT allocations. 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.
destructive
Argument
Type
Description
note*
string
total
number
acCode*
string
procDate*
string
totalNet
number
totalVAT
number
vatLines
array
Separate VAT allocations; net amounts must sum to netAmount. Legacy vatRateId/vatPercentage remain supported.
brc_create_sales_invoice
Creates a sales invoice with a caller-supplied reference and reconciled product, VAT and Sales-analysis lines. Missing customer contact values remain absent. 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.
destructive
Argument
Type
Description
note
string
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.
acCode*
string
procDate*
string
quantity*
integer
entryDate*
string
netAmount*
brc_create_sales_invoice_gen_ref
Creates a sales invoice using generated references and reconciled product, VAT and Sales-analysis lines. Missing customer contact values remain absent. 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.
destructive
Argument
Type
Description
payload*
object
Raw BRC payloads for multi-line sales invoices must use `productTrans[]` (one object per product line). Each product line must include its own nested `acEntries[]` for Sales analysis posting — do not send a top-level `acEntries` array on the invoice. Required header fields include customerId, acCode, entryDate, procDate, saleRepId, saleRepCode, bookTranTypeId, totalNet, totalVAT, total, and unpaid. Red validates line amounts, nested analysis values, qty × unit price (using useTaxInclusiveUnitPrice), and header totals before posting, and returns all validation issues together when the payload does not reconcile. Preview-before-posting still shows what Red will post and waits for confirmation before anything is written to Big Red Cloud.
priceBasis
string
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.
routeToken*
brc_create_sales_rep
Creates a BRC sales rep using structured MCP fields. 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.
Argument
Type
Description
code*
string
Sales rep code.
name*
string
Sales rep name.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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
string
brc_create_supplier
Creates a BRC supplier using a raw BRC payload. Does not create or update opening balance transactions. Opening-balance fields are not posted by this tool; supplier opening balances are entered directly in Big Red Cloud. 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.
Argument
Type
Description
payload*
object
Raw BRC-compatible payload for this endpoint.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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
string
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.
brc_delete_accrual
Deletes an accrual using its current concurrency timestamp. 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.
destructive
Argument
Type
Description
id*
integer
Parent accrual id.
timestamp*
string
Base64 timestamp returned by the accrual, for example K94UQIbL3gg=.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
Must be true only after the user explicitly confirms deleting this accrual.
connectionRef
string
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.
brc_delete_allocation_resolver
Reverses or deletes the specified allocation after returning an unconfirmed preview. 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.
destructive
Argument
Type
Description
id*
integer
Allocation resolver id to reverse/delete.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
Must be true only after the user explicitly confirms reversing/deleting this allocation.
connectionRef
string
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.
brc_delete_bank_account
Deletes the specified bank account after explicit confirmation. 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.
destructive
Argument
Type
Description
id*
any
bank account id.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
confirmDelete
boolean
brc_delete_cash_payment
Deletes a BRC cash payment by id. 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.
destructive
Argument
Type
Description
id*
any
cash payment id.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
confirmDelete
boolean
brc_delete_cash_receipt
Deletes a BRC cash receipt by id. 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.
destructive
Argument
Type
Description
id*
any
cash receipt id.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
confirmDelete
boolean
brc_delete_customer
Deletes a BRC customer by id. 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.
destructive
Argument
Type
Description
id*
any
customer id.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
confirmDelete
boolean
connectionRef
brc_delete_nominal_journal_batch
Deletes a nominal journal batch using its current concurrency timestamp. 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.
destructive
Argument
Type
Description
id*
integer
Nominal Journal Batch id.
timestamp*
string
Base64 timestamp returned by the Nominal Journal Batch, for example 7aIZQIbL3gg=.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
Must be true only after the user explicitly confirms deleting this Nominal Journal Batch.
connectionRef
string
brc_delete_payment
Deletes a BRC payment by id. 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.
destructive
Argument
Type
Description
id*
any
payment id.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
confirmDelete
boolean
connectionRef
brc_delete_prepayment
Deletes a prepayment using its current concurrency timestamp. 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.
destructive
Argument
Type
Description
id*
integer
Parent prepayment id.
timestamp*
string
Base64 timestamp returned by the prepayment, for example bgUcQIbL3gg=.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
Must be true only after the user explicitly confirms deleting this prepayment.
connectionRef
string
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.
brc_delete_product
Deletes a BRC product by id. 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.
destructive
Argument
Type
Description
id*
any
product id.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
confirmDelete
boolean
connectionRef
brc_delete_purchase
Deletes a BRC purchase by id using timestamp confirmation. Historical purchases are not automatically blocked because they belong to an earlier financial year. The BRC endpoint determines whether the historical deletion is supported. 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.
destructive
Argument
Type
Description
id*
any
Purchase id.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
confirmDelete
brc_delete_quote
Deletes a BRC quote by id using timestamp confirmation. Loads the quote once to obtain its timestamp and to preview id, reference, customer, total, open or closed state, any linked sales invoice, and timestamp before asking for confirmation. A successful delete is the result; if a later lookup by quote id returns an unexpected error, treat that check as inconclusive rather than as a failed delete. Confirm remaining quotes from the quote list by quote id — quote references are not necessarily unique. 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.
destructive
Argument
Type
Description
id*
any
Quote id.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
brc_delete_sales_credit_note
Deletes a BRC sales credit note by id using timestamp confirmation. 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.
destructive
Argument
Type
Description
id*
any
Sales credit note id.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
confirmDelete
boolean
brc_delete_sales_entry
Deletes a BRC sales entry by id using timestamp confirmation. 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.
destructive
Argument
Type
Description
id*
integer
Sales entry id.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
confirmDelete
boolean
brc_delete_sales_invoice
Deletes a BRC sales invoice by id using timestamp confirmation. 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.
destructive
Argument
Type
Description
id*
any
Sales invoice id.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
confirmDelete
boolean
brc_delete_sales_rep
Deletes a BRC sales rep by id using timestamp confirmation. 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.
destructive
Argument
Type
Description
id*
any
Sales rep id.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
confirmDelete
boolean
brc_delete_supplier
Deletes a BRC supplier by id. 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.
destructive
Argument
Type
Description
id*
any
supplier id.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
confirmDelete
boolean
connectionRef
brc_find_help_resources
Searches Big Red Cloud customer help across Freshdesk support articles, customer documentation, recorded webinar videos and upcoming webinars. Returns a synthesized answer, ordered guidance and public source metadata. Read-only and available without a connected company.
read-only
Argument
Type
Description
source
string
Optional source filter: freshdesk, customer_docs, recorded_webinar, youtube_video, upcoming_webinar, or all.
category
string
Optional help category filter, for example bank_feeds or sales.
question*
string
Plain-English help question, for example how do bank feeds work or how do I reconcile my bank account.
maxResults
integer
Maximum number of matching resources to return. Defaults to 5.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"question"
],
"properties": {
"source": {
"enum": [
"freshdesk",
"customer_docs",
"recorded_webinar",
"youtube_video",
"upcoming_webinar",
"all"
],
"type": "string",
"description": "Optional source filter: freshdesk, customer_docs, recorded_webinar, youtube_video, upcoming_webinar, or all."
},
"category": {
"type": "string",
"description": "Optional help category filter, for example bank_feeds or sales."
},
"question": {
"type": "string",
"minLength": 1,
"description": "Plain-English help question, for example how do bank feeds work or how do I reconcile my bank account."
},
"maxResults": {
"type": "integer",
"maximum": 10,
"minimum": 1,
"description": "Maximum number of matching resources to return. Defaults to 5."
}
}
}
brc_generate_sales_invoice_from_quote
Generates a sales invoice from a BRC quote. Preview-before-posting shows the exact POST /v1/quotes/generateSaleInvoice body (quoteId and optional entryDate/procDate only). Nothing is written until you confirm. 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.
destructive
Argument
Type
Description
quoteId*
integer
Quote id.
procDate
string
Optional invoice processing date in ISO format.
entryDate
string
Optional invoice entry date in ISO format.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
brc_generate_support_report
Returns a downloadable support diagnostic and a concise summary for the current session.
read-only
Argument
Type
Description
companyName*
string
Currently connected company to include in the diagnostic report.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"companyName": {
"type": "string",
"minLength": 1,
"description": "Currently connected company to include in the diagnostic report."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_accrual
Returns information about a single parent Accrual by id. Child accruals are not exposed by the public API.
read-only
Argument
Type
Description
id*
integer
Parent accrual id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Parent accrual id.",
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_bank_account
Gets one BRC bank account by id.
read-only
Argument
Type
Description
id*
any
Bank account id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Bank account id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_cash_payment
Gets one BRC cash payment by id.
read-only
Argument
Type
Description
id*
any
Cash payment id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Cash payment id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_cash_receipt
Gets one BRC cash receipt by id.
read-only
Argument
Type
Description
id*
any
Cash receipt id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Cash receipt id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_company_api_key_status
Returns company connection-status metadata without returning API keys or other credentials.
read-only
Argument
Type
Description
companyName
string
Optional company context name. If omitted, summarises all contexts.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"companyName": {
"type": "string",
"minLength": 1,
"description": "Optional company context name. If omitted, summarises all contexts."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_company_logo
Gets the company logo from BRC.
read-only
Argument
Type
Description
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_company_processing_settings
Returns company processing settings that affect VAT-sensitive accounting workflows.
read-only
Argument
Type
Description
includeRaw
boolean
If true, includes the raw BRC settings record for operator review. Customer-facing responses should normally leave this false.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"includeRaw": {
"type": "boolean",
"default": false,
"description": "If true, includes the raw BRC settings record for operator review. Customer-facing responses should normally leave this false."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_company_reference_settings
Returns quote and transaction reference settings. An Unknown quote-reference setting does not establish automatic reference generation.
read-only
Argument
Type
Description
includeRaw
boolean
If true, includes the raw BRC company setup record for operator review. Customer-facing responses should normally leave this false.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"includeRaw": {
"type": "boolean",
"default": false,
"description": "If true, includes the raw BRC company setup record for operator review. Customer-facing responses should normally leave this false."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_company_setup_config
Gets full BRC company setup configuration, including general details, financial year, reference settings, and processing options.
read-only
Argument
Type
Description
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_customer
Gets one BRC customer by id.
read-only
Argument
Type
Description
id*
any
Customer id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Customer id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_customer_opening_balance
Gets a customer's opening balance.
read-only
Argument
Type
Description
itemId*
string
Customer item id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"itemId"
],
"properties": {
"itemId": {
"type": "string",
"description": "Customer item id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_deployment_policy
Returns the deployment capability and permission summary, including enabled action groups and development-mode status.
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_help_resource_details
Returns detailed public help-resource content, ordered instruction blocks, signed screenshot links, source metadata and optional image content. Read-only and available without a connected company.
read-only
Argument
Type
Description
question
string
Optional customer question used to select the matching Freshdesk workflow screenshots, for example an existing-customer opening balance question versus adding a new customer.
maxImages
integer
Maximum Freshdesk screenshots to return. Defaults to 5. Hard maximum 8.
resourceId*
string
Resource ID from brc_red_help or brc_find_help_resources, for example customer_docs:bank-reconciliation or freshdesk:1001.
includeImages
boolean
When true, Freshdesk articles may include screenshot presentation. Defaults to true.
imagePresentation
string
How to present Freshdesk screenshots. Defaults to links (signed Markdown links only). Use inline for MCP image blocks, or both for Markdown plus image blocks.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"resourceId"
],
"properties": {
"question": {
"type": "string",
"minLength": 1,
"description": "Optional customer question used to select the matching Freshdesk workflow screenshots, for example an existing-customer opening balance question versus adding a new customer."
},
"maxImages": {
"type": "integer",
"maximum": 8,
"minimum": 1,
"description": "Maximum Freshdesk screenshots to return. Defaults to 5. Hard maximum 8."
},
"resourceId": {
"type": "string",
"minLength": 1,
"description": "Resource ID from brc_red_help or brc_find_help_resources, for example customer_docs:bank-reconciliation or freshdesk:1001."
},
"includeImages": {
"type": "boolean",
"description": "When true, Freshdesk articles may include screenshot presentation. Defaults to true."
},
"imagePresentation": {
"enum": [
"links",
"inline",
"both"
],
"type": "string",
"description": "How to present Freshdesk screenshots. Defaults to links (signed Markdown links only). Use inline for MCP image blocks, or both for Markdown plus image blocks."
}
}
}
brc_get_nom_ac_ledger_by_ids
Returns nominal-account ledgers for supplied account IDs. Monthly values represent movements rather than monthly balances.
read-only
Argument
Type
Description
ids*
string
Comma-separated nominal account ids.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"ids"
],
"properties": {
"ids": {
"type": "string",
"description": "Comma-separated nominal account ids."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_nominal_account_ledger_by_id
Returns one nominal account ledger and its period movements. Monthly values represent movements rather than monthly balances.
read-only
Argument
Type
Description
id*
any
Nominal account id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Nominal account id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_nominal_journal_batch
Returns information about a single Nominal Journal Batch by id.
read-only
Argument
Type
Description
id*
integer
Nominal Journal Batch id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Nominal Journal Batch id.",
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_payment
Gets one BRC payment by id.
read-only
Argument
Type
Description
id*
any
Payment id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Payment id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_prepayment
Returns information about a single parent Prepayment by id. Child prepayments are not exposed by the public API.
read-only
Argument
Type
Description
id*
integer
Parent prepayment id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Parent prepayment id.",
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_product
Gets one BRC product by id.
read-only
Argument
Type
Description
id*
any
Product id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Product id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_purchase
Gets one BRC purchase by id.
read-only
Argument
Type
Description
id*
any
Purchase id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Purchase id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_quote
Gets one BRC quote by id. List and get may not return the same fields (for example note or analysis account codes); treat those as representation differences, not as create or update failures.
read-only
Argument
Type
Description
id*
any
Quote id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Quote id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_sales_credit_note
Gets one BRC sales credit note by id.
read-only
Argument
Type
Description
id*
any
Sales credit note id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Sales credit note id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_sales_entry
Gets one BRC sales entry by id.
read-only
Argument
Type
Description
id*
any
Sales entry id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Sales entry id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_sales_invoice
Gets one BRC sales invoice by id.
read-only
Argument
Type
Description
id*
any
Sales invoice id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Sales invoice id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_sales_rep
Gets one BRC sales rep by id.
read-only
Argument
Type
Description
id*
any
Sales rep id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Sales rep id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_supplier
Gets one BRC supplier by id.
read-only
Argument
Type
Description
id*
any
Supplier id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Supplier id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_get_supplier_opening_balance
Gets a supplier's opening balance.
read-only
Argument
Type
Description
itemId*
string
Supplier item id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"itemId"
],
"properties": {
"itemId": {
"type": "string",
"description": "Supplier item id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_grouped_nominal_accounts_report
Returns a grouped nominal-account report with period movements rather than monthly balances.
read-only
Argument
Type
Description
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_list_accounts
Lists BRC accounts.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
brc_list_accruals
Returns a list of the company's Accruals. Supports optional OData filtering by entryDate. Supports optional ordering by id.
read-only
Argument
Type
Description
top
integer
Optional page size.
skip
integer
Optional number of records to skip.
filter
string
Optional OData filter. Filtering is allowed by entryDate, for example: entryDate ge 2024-03-01T00:00:00.
orderBy
string
Optional OData order by. Ordering is allowed by id, for example: id desc.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Optional page size.",
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Optional number of records to skip."
},
"filter": {
"type": "string",
"description": "Optional OData filter. Filtering is allowed by entryDate, for example: entryDate ge 2024-03-01T00:00:00."
},
"orderBy": {
"type": "string",
"description": "Optional OData order by. Ordering is allowed by id, for example: id desc."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_list_allocated_transactions
Returns existing transaction allocations and their identifiers.
read-only
Argument
Type
Description
bookTranId*
integer
Book transaction id to allocate from, for example 1001.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"bookTranId"
],
"properties": {
"bookTranId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Book transaction id to allocate from, for example 1001.",
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_list_allocation_resolvers
Returns receiver transactions eligible for allocation updates.
read-only
Argument
Type
Description
bookTranId*
integer
Book transaction id to allocate from, for example 1001.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"bookTranId"
],
"properties": {
"bookTranId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Book transaction id to allocate from, for example 1001.",
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_list_analysis_categories
Returns company analysis categories and their book context. Customer-control categories are distinct from Sales analysis categories.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
brc_list_audit_log
Returns current-session audit entries scoped to currently connected companies. Entries from other sessions, connections or companies are excluded.
read-only
Argument
Type
Description
connectionRef
string
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.
includeTechnicalDetails
boolean
Only set this to true if the user asks for technical details. Sensitive values are still redacted.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"connectionRef": {
"type": "string",
"description": "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."
},
"includeTechnicalDetails": {
"type": "boolean",
"default": false,
"description": "Only set this to true if the user asks for technical details. Sensitive values are still redacted."
}
}
}
brc_list_bank_accounts
Lists BRC bank accounts.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
brc_list_book_tran_types
Lists BRC book transaction types.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
brc_list_cash_payments
Lists BRC cash payments.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
brc_list_cash_receipts
Lists BRC cash receipts. entryDate is the accounting period date; procDate is the transaction/processing date. Customer and procDate filters use a complete bounded local scan (10,000 records), not upstream OData; narrow entryDate when needed.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter using entryDate only. Other fields are unsupported.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
customerId
integer
procDateTo
string
Inclusive transaction date YYYY-MM-DD; local filtering.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
brc_list_category_types
Lists BRC category types.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
brc_list_company_contexts
Returns connected-company contexts and connection-expiry metadata, including duration, remaining time and timezone details. Connection credentials are not returned.
read-only
Argument
Type
Description
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_list_company_settings
Lists BRC company settings.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
brc_list_customer_account_trans
Returns customer account transactions. Transaction IDs and types are endpoint- and company-specific.
read-only
Argument
Type
Description
itemId*
string
Customer item id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"itemId"
],
"properties": {
"itemId": {
"type": "string",
"description": "Customer item id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_list_customer_op_bal_trans
Gets a customer's opening balance transaction list.
read-only
Argument
Type
Description
itemId*
string
Customer item id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"itemId"
],
"properties": {
"itemId": {
"type": "string",
"description": "Customer item id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_list_customer_quotes
Gets quotes for a specific customer.
read-only
Argument
Type
Description
itemId*
string
Customer item id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"itemId"
],
"properties": {
"itemId": {
"type": "string",
"description": "Customer item id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
Unsupported: BRC customers forbid $filter. List with pagination and match locally.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
customerCode
string
Exact case-sensitive code; bounded local filtering, no fuzzy match.
connectionRef
string
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.
brc_list_customers_without_dormant
Lists BRC customers without dormant records.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
brc_list_nominal_accounts
Returns nominal accounts and period movements. Monthly values represent movements rather than monthly balances.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
brc_list_nominal_journal_batches
Returns nominal journal batches with identifiers and concurrency timestamps.
read-only
Argument
Type
Description
top
integer
Optional page size.
skip
integer
Optional number of records to skip.
filter
string
Optional OData filter. Filtering is allowed by entryDate, for example: entryDate ge 2024-01-01T00:00:00
orderBy
string
Optional OData order by. Ordering is allowed by id, for example: id desc.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Optional page size.",
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Optional number of records to skip."
},
"filter": {
"type": "string",
"description": "Optional OData filter. Filtering is allowed by entryDate, for example: entryDate ge 2024-01-01T00:00:00"
},
"orderBy": {
"type": "string",
"description": "Optional OData order by. Ordering is allowed by id, for example: id desc."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_list_owner_type_groups
Lists BRC owner type groups.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
brc_list_owner_types
Lists BRC owner types.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
brc_list_payments
Lists BRC payments.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
brc_list_prepayments
Returns a list of the company's Prepayments. Supports optional OData filtering by entryDate. Supports optional ordering by id.
read-only
Argument
Type
Description
top
integer
Optional page size.
skip
integer
Optional number of records to skip.
filter
string
Optional OData filter. Filtering is allowed by entryDate, for example: entryDate ge 2024-03-01T00:00:00.
orderBy
string
Optional OData order by. Ordering is allowed by id, for example: id desc.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Optional page size.",
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Optional number of records to skip."
},
"filter": {
"type": "string",
"description": "Optional OData filter. Filtering is allowed by entryDate, for example: entryDate ge 2024-03-01T00:00:00."
},
"orderBy": {
"type": "string",
"description": "Optional OData order by. Ordering is allowed by id, for example: id desc."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_list_product_types
Lists BRC product types.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
brc_list_products
Lists BRC products.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
brc_list_products_without_dormant
Lists BRC products without dormant records.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
brc_list_purchases
Lists BRC purchases.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
brc_list_quotes
Lists BRC quotes. List and get may not return the same fields (for example note or analysis account codes); treat those as representation differences, not as create or update failures. Quote references are not necessarily unique — identify a quote by id.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
brc_list_sales_credit_notes
Lists BRC sales credit notes.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
brc_list_sales_entries
Lists BRC sales entries.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
brc_list_sales_invoices
Lists BRC sales invoices.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
brc_list_sales_reps
Lists BRC sales reps.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
brc_list_supplier_account_trans
Returns supplier account transactions. Transaction IDs and types are endpoint- and company-specific.
read-only
Argument
Type
Description
itemId*
string
Supplier item id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"itemId"
],
"properties": {
"itemId": {
"type": "string",
"description": "Supplier item id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_list_supplier_op_bal_trans
Gets a supplier's opening balance transaction list.
read-only
Argument
Type
Description
itemId*
string
Supplier item id.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"itemId"
],
"properties": {
"itemId": {
"type": "string",
"description": "Supplier item id."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_list_suppliers
Lists BRC suppliers.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
brc_list_user_defined_fields
Lists BRC user defined fields.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
brc_list_vat_analysis_types
Lists BRC VAT analysis types.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
brc_list_vat_categories
Returns company VAT categories and their Sales or Purchase context.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
brc_list_vat_rates
Returns company VAT rates and their associated category identifiers.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
brc_list_vat_types
Lists BRC VAT types.
read-only
Argument
Type
Description
top
integer
page
integer
skip
integer
filter
string
Optional OData $filter expression, only if this endpoint supports filtering.
orderBy
string
Optional OData $orderby expression, only if this endpoint supports ordering.
pageSize
integer
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
Input schema (JSON)
brc_multi_company_nom_ac_report
Returns a multi-company nominal-account report with period movements rather than monthly balances.
read-only
Argument
Type
Description
companyNames*
array
The company names to report on.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyNames"
],
"properties": {
"companyNames": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"minItems": 1,
"description": "The company names to report on."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_open_edu_admin
Returns the protected education-administration URL. Access requires Microsoft Entra sign-in and does not bypass authentication. The response contains no upload secret or bypass parameter.
read-only
No arguments.
Input schema (JSON)
{
"type": "object",
"properties": {}
}
brc_process_vat_category_rates
Processes VAT rates for VAT categories via POST /v1/vatCategories/vatRates. Requires a full vatCategoryRates array and confirmProcess=true. 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.
destructive
Argument
Type
Description
payload
object
Deprecated. Use vatCategoryRates instead of a raw payload object.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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
brc_red_help
Returns Big Red Cloud help and manual Big Red Cloud instructions for how-to questions, including how do I queries and tutorials. Covers topics including sales invoices, purchases, customers, suppliers, banking, VAT, reports and company setup. Searches Freshdesk, YouTube, BRC Edu, webinars and screenshots. Read-only and available without a connected company.
read-only
Argument
Type
Description
query*
string
Text after the red-help command, for example how do I add a sales invoice or add a customer manually.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"query"
],
"properties": {
"query": {
"type": "string",
"minLength": 1,
"description": "Text after the red-help command, for example how do I add a sales invoice or add a customer manually."
}
}
}
brc_reopen_quote
Reopens a BRC quote. 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.
Argument
Type
Description
id*
any
Quote id.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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
string
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.
brc_resolve_book_transaction_type
Resolves a company-specific bookTranTypeId against live transaction-type reference data. Descriptions and numeric IDs are not globally stable.
read-only
Argument
Type
Description
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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*
integer
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"bookTranTypeId"
],
"properties": {
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}
brc_route_request
Classifies a supplied request as help, action, correction or unsupported. Classification covers read, create, update, delete, correct, undo, reverse, email and batch actions, including creating a sales invoice or add a customer, plus help wording such as how do I. Compatible mode supports existing unsigned clients without claiming verified authorship. Strict mode requires host-signed original-message metadata and binds the routeToken to that request, company and workflow; missing or mismatched provenance returns no write permission in strict mode. Help and correction results do not issue transactional route tokens.
read-only
Argument
Type
Description
message*
string
The user's complete original message to classify, for example add a customer or how do I add a customer.
companyName
string
Optional selected company; binds the issued routeToken to that exact company. Legacy calls without it bind on first transactional use.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"message"
],
"properties": {
"message": {
"type": "string",
"minLength": 1,
"description": "The user's complete original message to classify, for example add a customer or how do I add a customer."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Optional selected company; binds the issued routeToken to that exact company. Legacy calls without it bind on first transactional use."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_send_email_statement
Sends a customer-statement email to the customer address or an explicit recipient override. An unconfirmed call returns an email preview; confirmSend applies the send. 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.
destructive
Argument
Type
Description
sendMode
string
How to handle multiple recipients. Use separate only when the user explicitly asks to send separate individual emails.
toPeriod
string
Statement period end (ISO date-time, e.g. 2026-05-31T00:00:00).
toAddress
string
Optional single recipient override. If omitted or empty, BRC uses the customer's email address.
customerId*
integer
BRC field: customerId.
fromPeriod
string
Statement period start (ISO date-time, e.g. 2026-01-01T00:00:00).
minBalance
number
Minimum balance threshold for transactions included on the statement.
routeToken*
string
brc_send_quote_email
Sends a quote email to the customer address or an explicit recipient override. An unconfirmed call returns an email preview; confirmSend applies the send. 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.
destructive
Argument
Type
Description
quoteId*
integer
BRC field: quoteId.
sendMode
string
How to handle multiple recipients. Use separate only when the user explicitly asks to send separate individual emails.
toAddress
string
Optional single recipient override. If omitted or empty, BRC uses the customer's email address.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmSend
boolean
Must be true only after the user has reviewed the email preview and explicitly confirmed sending.
brc_send_sales_invoice_email
Sends a sales-invoice email to the customer address or an explicit recipient override. An unconfirmed call returns an email preview; confirmSend applies the send. 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.
destructive
Argument
Type
Description
sendMode
string
How to handle multiple recipients. Use separate only when the user explicitly asks to send separate individual emails.
toAddress
string
Optional single recipient override. If omitted or empty, BRC uses the customer's email address.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmSend
boolean
Must be true only after the user has reviewed the email preview and explicitly confirmed sending.
fromAddress
string
Optional sender address override.
brc_start_company_connection
Starts the secure Red / Big Red Cloud connection flow and returns a one-time connection page URL and confirmation code. The secure page supports one or multiple companies, including CSV upload, and keeps API credentials outside chat. Available without an existing company connection.
Argument
Type
Description
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
brc_update_accrual
Updates an accrual using its current concurrency timestamp. 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.
destructive
Argument
Type
Description
id*
integer
Parent accrual id.
total*
number
Accrual total amount.
acCode*
string
Nominal account code, for example 4000.
procDate*
string
Processing date, for example 2024-03-15T00:00:00.
entryDate*
string
Entry date, for example 2024-03-01T00:00:00.
reference*
string
Accrual reference, for example ACC0001.
timestamp*
string
brc_update_allocations
Updates transaction allocations using eligible receiver transactions and an unconfirmed payload preview. 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.
destructive
Argument
Type
Description
bookTranId*
integer
Book transaction id to allocate from, for example 1001.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
Must be true only after the user explicitly confirms posting the allocation update.
connectionRef
string
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.
brc_update_bank_account
Updates a BRC bank account using merged fields. An unconfirmed call returns a plain-English change preview. Explicit confirmation is required before the update is applied. 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.
destructive
Argument
Type
Description
id*
any
Bank account id.
payload
object
Alias for updates.
updates
object
Fields to merge into the existing record.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
brc_update_cash_payment
Updates an existing Cash Payment by merging supplied fields onto the current record. Fields that can be merged include total, entryDate, procDate, supplierId, acCode, note, ledger, discount, bankAccountId, bankAccountCode, lodgement, analysisCategoryId, accountCode, and description. This update flow is a verified action on the existing record. 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.
destructive
Argument
Type
Description
id*
any
Cash payment id.
payload
object
Alias for updates.
updates
object
Fields to merge into the existing record.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
brc_update_cash_receipt
Updates a BRC cash receipt using merged fields. 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.
destructive
Argument
Type
Description
id*
any
Cash receipt id.
payload
object
Alias for updates.
updates
object
Fields to merge into the existing record.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
brc_update_customer
Updates a BRC customer using merged fields. 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.
destructive
Argument
Type
Description
id*
any
Customer id.
payload
object
Alias for updates.
updates
object
Fields to merge into the existing record.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
brc_update_nominal_journal_batch
Updates a nominal journal batch using its current concurrency timestamps. 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.
destructive
Argument
Type
Description
id*
integer
Nominal Journal Batch id.
total*
number
procDate*
string
Date/time string, for example 2024-01-15T00:00:00.
entryDate*
string
Date/time string, for example 2024-01-15T00:00:00.
timestamp*
string
Base64 timestamp for the nominal journal batch.
routeToken*
string
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.
brc_update_payment
Updates a BRC payment using merged fields. 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.
destructive
Argument
Type
Description
id*
any
Payment id.
payload
object
Alias for updates.
updates
object
Fields to merge into the existing record.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
brc_update_prepayment
Updates a prepayment using its current concurrency timestamp. 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.
destructive
Argument
Type
Description
id*
integer
Parent prepayment id.
total*
number
Prepayment total amount.
acCode*
string
Nominal account code, for example 4000.
procDate*
string
Processing date, for example 2024-03-15T00:00:00.
entryDate*
string
Entry date, for example 2024-03-01T00:00:00.
reference*
string
Prepayment reference, for example PRE0001.
timestamp*
brc_update_product
Updates a BRC product using merged fields. 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.
destructive
Argument
Type
Description
id*
any
Product id.
payload
object
Alias for updates.
updates
object
Fields to merge into the existing record.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
brc_update_purchase
Updates a BRC purchase using structured MCP fields. Historical transaction dates are not automatically blocked. Existing historical purchases may support text, monetary, date and delete operations; the BRC endpoint is the source of truth. When changing monetary values, preserve the existing unpaid/unallocated state and allow BRC to recalculate allocation fields where required. 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.
destructive
Argument
Type
Description
id*
any
Purchase id.
note
string
acCode
string
procDate
string
entryDate
string
netAmount
number
vatRateId
integer
brc_update_quote
Updates a BRC quote's manual reference only. Quote.note is not persisted by this update and is not accepted here. Loads the current quote, preserves all other fields (including timestamp, product lines, analysis entries, totals, customer, sales rep, dates, comments, and closed state), applies the new reference, then PUTs the full record. Manual quote references must be 6 characters or fewer because Big Red Cloud truncates longer references. 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.
destructive
Argument
Type
Description
id*
any
Quote id.
reference
string
Optional manual quote reference, max 6 characters. Required when quote references are manual, or when the quote reference setting is unknown. Quote reference must be 6 characters or fewer because Big Red Cloud truncates longer references.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
brc_update_sales_credit_note
Updates a sales credit note while preserving the existing BRC unpaid value. 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.
destructive
Argument
Type
Description
id*
any
Sales credit note id.
note
string
total
number
details
string
procDate
string
Processing date. Historical dates may be attempted; BRC determines whether the update is permitted.
totalNet
number
totalVAT
number
entryDate
string
Entry date. Historical dates may be attempted; BRC determines whether the update is permitted.
brc_update_sales_entry
Updates a sales entry while preserving the existing BRC unpaid value. 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.
destructive
Argument
Type
Description
id*
any
Sales Entry id, normally the bookTranId returned by customer account transactions.
note
string
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
number
New gross total. For monetary edits this must equal totalNet + totalVAT.
acCode
string
Customer account code.
details
string
Sales Entry details/description field.
procDate
string
Processing date in ISO format. Historical dates may be attempted; BRC determines whether the change is permitted.
brc_update_sales_invoice
Updates 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.
destructive
Argument
Type
Description
id*
any
Sales invoice id.
note
string
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
number
details
string
procDate
string
Processing date. Historical dates are permitted as an attempted update; BRC may accept or reject them.
totalNet
number
totalVAT
number
brc_update_sales_rep
Updates a BRC sales rep using structured MCP fields. 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.
destructive
Argument
Type
Description
id*
any
Sales rep id.
code
string
name
string
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
brc_update_supplier
Updates a BRC supplier using merged fields. 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.
destructive
Argument
Type
Description
id*
any
Supplier id.
payload
object
Alias for updates.
updates
object
Fields to merge into the existing record.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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.
brc_validate_transaction_date
Checks whether a proposed transaction date is inside the connected BRC company's current financial year.
read-only
Argument
Type
Description
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
connectionRef
string
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.
transactionDate*
string
Date to validate in YYYY-MM-DD format.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"transactionDate"
],
"properties": {
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
},
"transactionDate": {
"type": "string",
"description": "Date to validate in YYYY-MM-DD format."
}
}
}
connectionRef
string
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
boolean
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"items",
"routeToken"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"opCode",
"item"
],
"properties": {
"item": {
"oneOf": [
{
"type": "object",
"required": [
"total",
"note",
"entryDate",
"procDate",
"bookTranTypeId",
"acEntries"
],
"properties": {
"note": {
"type": "string",
"minLength": 1,
"description": "Cash Receipt note."
},
"total": {
"type": "number",
"description": "Positive Cash Receipt total.",
"exclusiveMinimum": 0
},
"discount": {
"type": "number"
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Processing date in ISO format."
},
"acEntries": {
"type": "array",
"items": {
"type": "object",
"required": [
"accountCode",
"analysisCategoryId",
"description",
"value"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"value": {
"type": "number",
"description": "Positive portion of the receipt total assigned to this analysis entry.",
"exclusiveMinimum": 0
},
"accountCode": {
"type": "string",
"minLength": 1,
"description": "Cash Receipts analysis account code."
},
"description": {
"type": "string",
"minLength": 1,
"description": "Analysis-line description."
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Cash Receipts analysis category id.",
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"minItems": 1
},
"entryDate": {
"type": "string",
"minLength": 1,
"description": "Entry date in ISO format."
},
"reference": {
"type": "string",
"description": "Cash receipts do not support reference in the documented BRC API. Use detailCollection for audit or bank-reference text."
},
"vatEntries": {
"type": "array",
"items": {
"type": "object",
"required": [
"vatRateId",
"percentage",
"amount"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"amount": {
"type": "number",
"description": "Positive portion of the receipt total assigned to this VAT rate; this is not the VAT amount.",
"exclusiveMinimum": 0
},
"vatRateId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC VAT rate id.",
"exclusiveMinimum": 0
},
"percentage": {
"type": "number",
"description": "VAT percentage."
}
},
"additionalProperties": false
},
"minItems": 1,
"description": "Optional manual VAT split. Removed before transmission when Enable VAT on Cash Receipts is disabled."
},
"bookTranTypeId": {
"type": "number",
"const": 1,
"description": "Cash Receipt book transaction type id. Must be 1."
},
"detailCollection": {
"type": "array",
"items": {
"type": "string"
},
"description": "Cash Receipt detail lines, including audit or bank-reference text. An empty array clears the lines."
}
},
"additionalProperties": false
},
{
"oneOf": [
{
"type": "object",
"required": [
"total",
"note",
"entryDate",
"procDate",
"bookTranTypeId",
"analysisCategoryId",
"accountCode",
"description"
],
"properties": {
"note": {
"type": "string",
"minLength": 1,
"description": "Cash Receipt note."
},
"total": {
"type": "number",
"description": "Positive Cash Receipt total.",
"exclusiveMinimum": 0
},
"discount": {
"type": "number"
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Processing date in ISO format."
},
"entryDate": {
"type": "string",
"minLength": 1,
"description": "Entry date in ISO format."
},
"reference": {
"type": "string",
"description": "Cash receipts do not support reference in the documented BRC API. Use detailCollection for audit or bank-reference text."
},
"accountCode": {
"type": "string",
"minLength": 1,
"description": "Cash Receipts analysis account code."
},
"description": {
"type": "string",
"minLength": 1,
"description": "Analysis-line description."
},
"bookTranTypeId": {
"type": "number",
"const": 1,
"description": "Cash Receipt book transaction type id. Must be 1."
},
"detailCollection": {
"type": "array",
"items": {
"type": "string"
},
"description": "Cash Receipt detail lines, including audit or bank-reference text. An empty array clears the lines."
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Cash Receipts analysis category id.",
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"total",
"note",
"entryDate",
"procDate",
"bookTranTypeId",
"analysisCategoryId",
"accountCode",
"description",
"vatRateId",
"vatPercentage"
],
"properties": {
"note": {
"type": "string",
"minLength": 1,
"description": "Cash Receipt note."
},
"total": {
"type": "number",
"description": "Positive Cash Receipt total.",
"exclusiveMinimum": 0
},
"discount": {
"type": "number"
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Processing date in ISO format."
},
"entryDate": {
"type": "string",
"minLength": 1,
"description": "Entry date in ISO format."
},
"reference": {
"type": "string",
"description": "Cash receipts do not support reference in the documented BRC API. Use detailCollection for audit or bank-reference text."
},
"vatRateId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC VAT rate id.",
"exclusiveMinimum": 0
},
"accountCode": {
"type": "string",
"minLength": 1,
"description": "Cash Receipts analysis account code."
},
"description": {
"type": "string",
"minLength": 1,
"description": "Analysis-line description."
},
"vatPercentage": {
"type": "number",
"description": "VAT percentage. Must be supplied with vatRateId."
},
"bookTranTypeId": {
"type": "number",
"const": 1,
"description": "Cash Receipt book transaction type id. Must be 1."
},
"detailCollection": {
"type": "array",
"items": {
"type": "string"
},
"description": "Cash Receipt detail lines, including audit or bank-reference text. An empty array clears the lines."
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Cash Receipts analysis category id.",
"exclusiveMinimum": 0
}
},
"additionalProperties": false
}
]
},
{
"type": "object",
"required": [
"total",
"note",
"entryDate",
"procDate",
"bookTranTypeId",
"customerId",
"acCode",
"ledger"
],
"properties": {
"note": {
"type": "string",
"minLength": 1,
"description": "Cash Receipt note."
},
"total": {
"type": "number",
"description": "Positive Cash Receipt total.",
"exclusiveMinimum": 0
},
"acCode": {
"type": "string",
"minLength": 1,
"description": "Customer account code."
},
"ledger": {
"type": "number",
"description": "Customer-ledger amount; must equal total.",
"exclusiveMinimum": 0
},
"discount": {
"type": "number"
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Processing date in ISO format."
},
"entryDate": {
"type": "string",
"minLength": 1,
"description": "Entry date in ISO format."
},
"reference": {
"type": "string",
"description": "Cash receipts do not support reference in the documented BRC API. Use detailCollection for audit or bank-reference text."
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC customer id.",
"exclusiveMinimum": 0
},
"bookTranTypeId": {
"type": "number",
"const": 1,
"description": "Cash Receipt book transaction type id. Must be 1."
},
"detailCollection": {
"type": "array",
"items": {
"type": "string"
},
"description": "Cash Receipt detail lines, including audit or bank-reference text. An empty array clears the lines."
}
},
"additionalProperties": false
}
]
},
"opCode": {
"type": "number",
"const": 1,
"description": "BRC batch create operation code. Must be 1."
}
},
"additionalProperties": false
},
"maxItems": 100,
"minItems": 1,
"description": "Batch items to process. Maximum 100 items per request."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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": {
"type": "boolean",
"description": "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."
}
}
}
string
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.
detailedResponse
boolean
Return full payload and BRC response for audit inspection. Default is compact.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"items",
"routeToken"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"opCode",
"item"
],
"properties": {
"item": {
"type": "object",
"required": [
"code",
"name",
"vatType",
"vatAnalysisTypeId"
],
"properties": {
"fax": {
"type": "string",
"description": "Optional fax number. Blank values are accepted and omitted by the existing builder."
},
"code": {
"type": "string",
"maxLength": 8,
"minLength": 1,
"description": "BRC account code, maximum eight characters."
},
"name": {
"type": "string",
"minLength": 1,
"description": "Customer or supplier name."
},
"email": {
"type": "string",
"description": "Optional email address. Blank values are accepted and omitted by the existing builder."
},
"phone": {
"type": "string",
"description": "Optional phone number. Blank values are accepted and omitted by the existing builder."
},
"mobile": {
"type": "string",
"description": "Optional mobile number. Blank values are accepted and omitted by the existing builder."
},
"vatReg": {
"type": "string",
"description": "Optional VAT registration number. Blank values are accepted and omitted by the existing builder."
},
"address": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional address lines."
},
"contact": {
"type": "string",
"description": "Optional contact name. Blank values are accepted and omitted by the existing builder."
},
"vatType": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC VAT type integer. Resolve the intended value from the connected company's VAT reference data.",
"exclusiveMinimum": 0
},
"creditTerms": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Optional credit terms in days."
},
"vatRegistered": {
"type": "boolean",
"description": "Whether the owner is VAT registered."
},
"additionalEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional additional email addresses."
},
"vatAnalysisTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "BRC VAT analysis type id."
},
"businessIdentifierCode": {
"type": "string",
"description": "Optional BIC. Blank values are accepted and omitted by the existing builder."
},
"internationalBankAccountNumber": {
"type": "string",
"description": "Optional IBAN. Blank values are accepted and omitted by the existing builder."
}
},
"additionalProperties": false
},
"opCode": {
"type": "number",
"const": 1,
"description": "BRC batch create operation code. Must be 1."
}
},
"additionalProperties": false
},
"maxItems": 100,
"minItems": 1,
"description": "Batch items to process. Maximum 100 items per request."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
},
"detailedResponse": {
"type": "boolean",
"description": "Return full payload and BRC response for audit inspection. Default is compact."
}
}
}
connectionRef
string
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
boolean
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"items",
"routeToken"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"opCode",
"item"
],
"properties": {
"item": {
"oneOf": [
{
"type": "object",
"required": [
"total",
"note",
"entryDate",
"procDate",
"bookTranTypeId",
"bankAccountId",
"bankAccountCode",
"supplierId",
"acCode"
],
"properties": {
"note": {
"type": "string",
"minLength": 1,
"description": "Payment note."
},
"total": {
"type": "number",
"description": "Positive Payment total.",
"exclusiveMinimum": 0
},
"acCode": {
"type": "string",
"minLength": 1,
"description": "Supplier account code."
},
"discount": {
"type": "number"
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Processing date in ISO format."
},
"entryDate": {
"type": "string",
"minLength": 1,
"description": "Entry date in ISO format."
},
"reference": {
"type": "string"
},
"supplierId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC supplier id.",
"exclusiveMinimum": 0
},
"bankAccountId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC bank account id.",
"exclusiveMinimum": 0
},
"bookTranTypeId": {
"type": "number",
"const": 3,
"description": "Payments book transaction type id. Must be 3."
},
"bankAccountCode": {
"type": "string",
"minLength": 1,
"description": "BRC bank account code."
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"total",
"note",
"entryDate",
"procDate",
"bookTranTypeId",
"bankAccountId",
"bankAccountCode",
"analysisCategoryId",
"accountCode",
"description"
],
"properties": {
"note": {
"type": "string",
"minLength": 1,
"description": "Payment note."
},
"total": {
"type": "number",
"description": "Positive Payment total.",
"exclusiveMinimum": 0
},
"discount": {
"type": "number"
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Processing date in ISO format."
},
"entryDate": {
"type": "string",
"minLength": 1,
"description": "Entry date in ISO format."
},
"reference": {
"type": "string"
},
"accountCode": {
"type": "string",
"minLength": 1,
"description": "Payments-book analysis account code for the non-supplier payment."
},
"description": {
"type": "string",
"minLength": 1,
"description": "Description for the payment analysis line."
},
"bankAccountId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC bank account id.",
"exclusiveMinimum": 0
},
"bookTranTypeId": {
"type": "number",
"const": 3,
"description": "Payments book transaction type id. Must be 3."
},
"bankAccountCode": {
"type": "string",
"minLength": 1,
"description": "BRC bank account code."
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Payments-book analysis category id for the non-supplier payment.",
"exclusiveMinimum": 0
}
},
"additionalProperties": false
}
]
},
"opCode": {
"type": "number",
"const": 1,
"description": "BRC batch create operation code. Must be 1."
}
},
"additionalProperties": false
},
"maxItems": 100,
"minItems": 1,
"description": "Batch items to process. Maximum 100 items per request."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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": {
"type": "boolean",
"description": "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."
}
}
}
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"items",
"routeToken"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"opCode",
"item"
],
"properties": {
"item": {
"type": "object",
"required": [
"stockCode",
"details",
"productTypeId",
"vatRateId",
"vatAnalysisTypeId",
"unitPrice",
"grossUnitPrice",
"hasDefaultVatRate"
],
"properties": {
"details": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"description": "One or more non-empty product description lines."
},
"stockCode": {
"type": "string",
"minLength": 1,
"description": "BRC product code. BRC may enforce additional server-side code limits."
},
"unitPrice": {
"type": "number",
"minimum": 0,
"description": "Product unit price. Zero is valid for products whose price is supplied at transaction time."
},
"vatRateId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC VAT rate id. Select the intended VAT rate explicitly.",
"exclusiveMinimum": 0
},
"productTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC product type id. Select the intended product type explicitly.",
"exclusiveMinimum": 0
},
"grossUnitPrice": {
"type": "boolean",
"description": "Whether unitPrice is VAT-inclusive."
},
"hasDefaultVatRate": {
"type": "boolean",
"description": "Whether the product uses its selected default VAT rate."
},
"vatAnalysisTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "BRC product VAT analysis type id."
}
},
"additionalProperties": false
},
"opCode": {
"type": "number",
"const": 1,
"description": "BRC batch create operation code. Must be 1."
}
},
"additionalProperties": false
},
"maxItems": 100,
"minItems": 1,
"description": "Batch items to process. Maximum 100 items per request."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
}
}
}
boolean
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
string
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.
confirmCrAnalysisCategory
boolean
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.
confirmCounterpartyExplicit
boolean
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"items",
"routeToken"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"item"
],
"properties": {
"item": {
"type": "object",
"required": [
"supplierId",
"acCode",
"bookTranTypeId",
"entryDate",
"procDate",
"description",
"note",
"accountCode",
"analysisCategoryId",
"netAmount",
"vatPercentage",
"vatRateId"
],
"properties": {
"note": {
"type": "string",
"description": "Purchase note."
},
"total": {
"type": "number",
"description": "Optional caller-calculated gross total; RED recalculates it."
},
"acCode": {
"type": "string",
"description": "Supplier account code."
},
"unpaid": {
"type": "number",
"description": "Optional caller-calculated unpaid amount; RED recalculates it."
},
"procDate": {
"type": "string",
"description": "Purchase processing date in ISO format."
},
"totalNet": {
"type": "number",
"description": "Optional caller-calculated net total; RED recalculates it from netAmount."
},
"totalVAT": {
"type": "number",
"description": "Optional caller-calculated VAT total; RED recalculates it from netAmount and vatPercentage."
},
"entryDate": {
"type": "string",
"description": "Purchase entry date in ISO format."
},
"netAmount": {
"type": "number",
"description": "Net amount before VAT.",
"exclusiveMinimum": 0
},
"vatRateId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC VAT rate id.",
"exclusiveMinimum": 0
},
"vatTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Optional purchase VAT type; the current builder emits Domestic VAT type 1.",
"exclusiveMinimum": 0
},
"supplierId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC supplier id.",
"exclusiveMinimum": 0
},
"accountCode": {
"type": "string",
"description": "Nominal account code for the analysis entry."
},
"description": {
"type": "string",
"description": "Purchase analysis-line description."
},
"vatPercentage": {
"type": "number",
"description": "VAT percentage."
},
"bookTranTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Purchase book transaction type id; use 4.",
"exclusiveMinimum": 0
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Purchases analysis category id.",
"exclusiveMinimum": 0
}
},
"description": "Structured purchase input matching brc_create_purchase_gen_ref and the batch purchase builder."
},
"opCode": {
"type": "number",
"const": 1,
"default": 1,
"description": "BRC batch operation code. Use 1 to create a purchase."
}
}
},
"maxItems": 100,
"minItems": 1,
"description": "Batch items to process. Maximum 100 items per request."
},
"priceBasis": {
"enum": [
"net",
"gross"
],
"type": "string",
"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."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
},
"confirmCrAnalysisCategory": {
"type": "boolean",
"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."
},
"confirmCounterpartyExplicit": {
"type": "boolean",
"description": "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."
}
}
}
connectionRef
string
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.
confirmCrAnalysisCategory
boolean
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.
confirmCounterpartyExplicit
boolean
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"items",
"routeToken"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"opCode",
"item"
],
"properties": {
"item": {
"oneOf": [
{
"type": "object",
"required": [
"companyId",
"customerOwnerId",
"acCode",
"customerOwnerName",
"comments",
"entryDate",
"procDate",
"saleRepId",
"saleRepCode",
"productId",
"productCode",
"quantity",
"unitPrice",
"vatRateId",
"vatPercentage",
"tranNote",
"analysisCategoryId",
"accountCode"
],
"properties": {
"acCode": {
"type": "string",
"minLength": 1,
"description": "Customer account code."
},
"comments": {
"type": "string",
"minLength": 1,
"description": "Quote comments."
},
"ddNumber": {
"type": "string"
},
"poNumber": {
"type": "string"
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Processing date in ISO format."
},
"quantity": {
"type": "number",
"exclusiveMinimum": 0
},
"tranNote": {
"type": "string",
"minLength": 1,
"description": "Quote product-line note."
},
"companyId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC company id.",
"exclusiveMinimum": 0
},
"entryDate": {
"type": "string",
"minLength": 1,
"description": "Entry date in ISO format."
},
"productId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC product id; placeholder ids 0 and 1 are prohibited.",
"exclusiveMinimum": 0
},
"reference": {
"type": "string",
"maxLength": 6,
"description": "Optional manual quote reference, maximum six characters."
},
"saleRepId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC sales representative id.",
"exclusiveMinimum": 0
},
"unitPrice": {
"type": "number",
"exclusiveMinimum": 0
},
"vatRateId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC VAT rate id.",
"exclusiveMinimum": 0
},
"vatTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC VAT type id.",
"exclusiveMinimum": 0
},
"deliveryTo": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"layoutType": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Quote layout type id.",
"exclusiveMinimum": 0
},
"accountCode": {
"type": "string",
"minLength": 1,
"description": "Sales analysis account code."
},
"productCode": {
"type": "string",
"minLength": 1,
"description": "BRC product code."
},
"saleRepCode": {
"type": "string",
"minLength": 1,
"description": "BRC sales representative code."
},
"vatPercentage": {
"type": "number"
},
"customerOwnerId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC customer owner id.",
"exclusiveMinimum": 0
},
"customerOwnerName": {
"type": "string",
"minLength": 1,
"description": "Customer name."
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Sales analysis category id.",
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"companyId",
"customerOwnerId",
"vatTypeId",
"saleRepId",
"saleRepCode",
"entryDate",
"procDate",
"customerOwnerName",
"comments",
"layoutType",
"total",
"totalVat",
"totalNet",
"note",
"acCode",
"productTrans",
"customFields"
],
"properties": {
"note": {
"type": "string"
},
"total": {
"type": "number",
"exclusiveMinimum": 0
},
"acCode": {
"type": "string",
"minLength": 1,
"description": "Customer account code."
},
"comments": {
"type": "string",
"minLength": 1,
"description": "Quote comments."
},
"ddNumber": {
"type": "string"
},
"poNumber": {
"type": "string"
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Processing date in ISO format."
},
"totalNet": {
"type": "number",
"exclusiveMinimum": 0
},
"totalVat": {
"type": "number",
"minimum": 0
},
"companyId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC company id.",
"exclusiveMinimum": 0
},
"entryDate": {
"type": "string",
"minLength": 1,
"description": "Entry date in ISO format."
},
"reference": {
"type": "string",
"maxLength": 6,
"description": "Optional manual quote reference, maximum six characters."
},
"saleRepId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC sales representative id.",
"exclusiveMinimum": 0
},
"vatTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC VAT type id.",
"exclusiveMinimum": 0
},
"closedDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"deliveryTo": {
"type": "array",
"items": {
"type": "string"
}
},
"layoutType": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Quote layout type id.",
"exclusiveMinimum": 0
},
"saleRepCode": {
"type": "string",
"minLength": 1,
"description": "BRC sales representative code."
},
"customFields": {
"type": "array",
"items": {}
},
"deliveryList": {
"type": "string"
},
"productTrans": {
"type": "array",
"items": {
"type": "object",
"required": [
"companyId",
"percentage",
"vatRateId",
"productId",
"productCode",
"quantity",
"unitPrice",
"amount",
"vatAmount",
"tranNotes",
"acEntries",
"vatAnalysisTypeId"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"amount": {
"type": "number",
"exclusiveMinimum": 0
},
"quantity": {
"type": "number",
"exclusiveMinimum": 0
},
"acEntries": {
"type": "array",
"items": {
"type": "object",
"required": [
"companyId",
"accountCode",
"analysisCategoryId",
"value"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"value": {
"type": "number",
"exclusiveMinimum": 0
},
"companyId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC company id.",
"exclusiveMinimum": 0
},
"accountCode": {
"type": "string",
"minLength": 1,
"description": "Sales analysis account code."
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Sales analysis category id.",
"exclusiveMinimum": 0
},
"quoteProductTranId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
},
"minItems": 1
},
"companyId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC company id.",
"exclusiveMinimum": 0
},
"productId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC product id; placeholder ids 0 and 1 are prohibited.",
"exclusiveMinimum": 0
},
"tranNotes": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"unitPrice": {
"type": "number",
"exclusiveMinimum": 0
},
"vatAmount": {
"type": "number",
"minimum": 0
},
"vatRateId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC VAT rate id.",
"exclusiveMinimum": 0
},
"percentage": {
"type": "number"
},
"productCode": {
"type": "string",
"minLength": 1,
"description": "BRC product code."
},
"vatAnalysisTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
}
},
"additionalProperties": false
},
"minItems": 1
},
"saleInvoiceId": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
},
"customerOwnerId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC customer owner id.",
"exclusiveMinimum": 0
},
"customerOwnerName": {
"type": "string",
"minLength": 1,
"description": "Customer name."
}
},
"additionalProperties": false
}
]
},
"opCode": {
"type": "number",
"const": 1,
"description": "BRC batch create operation code. Must be 1."
}
},
"additionalProperties": false
},
"maxItems": 100,
"minItems": 1,
"description": "Batch items to process. Maximum 100 items per request."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
},
"confirmCrAnalysisCategory": {
"type": "boolean",
"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."
},
"confirmCounterpartyExplicit": {
"type": "boolean",
"description": "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."
}
}
}
boolean
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
string
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.
confirmCrAnalysisCategory
boolean
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.
confirmCounterpartyExplicit
boolean
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"items",
"routeToken"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"opCode",
"item"
],
"properties": {
"item": {
"oneOf": [
{
"type": "object",
"required": [
"customerId",
"acCode",
"note",
"entryDate",
"procDate",
"bookTranTypeId",
"analysisCategoryId",
"accountCode",
"description",
"netAmount",
"vatRateId",
"vatPercentage",
"productId",
"productCode",
"quantity",
"unitPrice",
"saleRepId",
"saleRepCode"
],
"properties": {
"note": {
"type": "string",
"minLength": 1,
"description": "Sales credit note."
},
"acCode": {
"type": "string",
"minLength": 1,
"description": "Customer account code."
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Processing date in ISO format."
},
"quantity": {
"type": "number",
"exclusiveMinimum": 0
},
"entryDate": {
"type": "string",
"minLength": 1,
"description": "Entry date in ISO format."
},
"netAmount": {
"type": "number",
"exclusiveMinimum": 0
},
"productId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC product id; placeholder ids 0 and 1 are prohibited.",
"exclusiveMinimum": 0
},
"reference": {
"type": "string"
},
"saleRepId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC sales representative id.",
"exclusiveMinimum": 0
},
"unitPrice": {
"type": "number",
"exclusiveMinimum": 0
},
"vatRateId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC VAT rate id.",
"exclusiveMinimum": 0
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC customer id.",
"exclusiveMinimum": 0
},
"accountCode": {
"type": "string",
"minLength": 1,
"description": "Sales analysis account code."
},
"description": {
"type": "string",
"minLength": 1,
"description": "Product-line analysis description."
},
"productCode": {
"type": "string",
"minLength": 1,
"description": "BRC product code."
},
"saleRepCode": {
"type": "string",
"minLength": 1,
"description": "BRC sales representative code."
},
"vatPercentage": {
"type": "number"
},
"bookTranTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Sales Credit Note book transaction type id; use 7.",
"exclusiveMinimum": 0
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Sales analysis category id.",
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"productTrans",
"saleRepId",
"saleRepCode",
"customerId",
"unpaid",
"vatTypeId",
"totalNet",
"totalVAT",
"bookTranTypeId",
"acCode",
"entryDate",
"procDate",
"total",
"customFields"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"note": {
"type": "string"
},
"total": {
"type": "number",
"exclusiveMaximum": 0
},
"acCode": {
"type": "string",
"minLength": 1,
"description": "Customer account code."
},
"loType": {
"type": "string"
},
"unpaid": {
"type": "number",
"exclusiveMaximum": 0
},
"details": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"quoteId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"netGoods": {
"type": "number"
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Processing date in ISO format."
},
"totalNet": {
"type": "number",
"exclusiveMaximum": 0
},
"totalVAT": {
"type": "number",
"exclusiveMaximum": 0
},
"entryDate": {
"type": "string",
"minLength": 1,
"description": "Entry date in ISO format."
},
"reference": {
"type": "string"
},
"saleRepId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC sales representative id.",
"exclusiveMinimum": 0
},
"vatTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC VAT type id.",
"exclusiveMinimum": 0
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC customer id.",
"exclusiveMinimum": 0
},
"deliveryTo": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"netServices": {
"type": "number"
},
"saleRepCode": {
"type": "string",
"minLength": 1,
"description": "BRC sales representative code."
},
"customFields": {
"type": "array",
"items": {}
},
"ourReference": {
"type": "string"
},
"productTrans": {
"type": "array",
"items": {
"type": "object",
"required": [
"amount",
"amountNet",
"percentage",
"productId",
"productCode",
"quantity",
"unitPrice",
"vat",
"vatRateId",
"vatAnalysisTypeId",
"tranNotes",
"acEntries"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"vat": {
"type": "number",
"exclusiveMaximum": 0
},
"amount": {
"type": "number",
"exclusiveMaximum": 0
},
"quantity": {
"type": "number",
"exclusiveMaximum": 0
},
"acEntries": {
"type": "array",
"items": {
"type": "object",
"required": [
"accountCode",
"analysisCategoryId",
"value"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"value": {
"type": "number",
"exclusiveMaximum": 0
},
"accountCode": {
"type": "string",
"minLength": 1,
"description": "Sales analysis account code."
},
"description": {
"type": "string"
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Sales analysis category id.",
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"minItems": 1
},
"amountNet": {
"type": "number",
"exclusiveMaximum": 0
},
"productId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC product id; placeholder ids 0 and 1 are prohibited.",
"exclusiveMinimum": 0
},
"tranNotes": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"unitPrice": {
"type": "number",
"exclusiveMinimum": 0
},
"vatAmount": {
"type": "number",
"exclusiveMaximum": 0
},
"vatRateId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC VAT rate id.",
"exclusiveMinimum": 0
},
"percentage": {
"type": "number"
},
"productCode": {
"type": "string",
"minLength": 1,
"description": "BRC product code."
},
"vatAnalysisTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"useTaxInclusiveUnitPrice": {
"type": "boolean"
}
},
"additionalProperties": false
},
"minItems": 1
},
"yourReference": {
"type": "string"
},
"bookTranTypeId": {
"type": "number",
"const": 7
},
"useTaxInclusiveUnitPrice": {
"type": "boolean"
}
},
"additionalProperties": false
}
]
},
"opCode": {
"type": "number",
"const": 1,
"description": "BRC batch create operation code. Must be 1."
}
},
"additionalProperties": false
},
"maxItems": 100,
"minItems": 1,
"description": "Batch items to process. Maximum 100 items per request."
},
"priceBasis": {
"enum": [
"net",
"gross"
],
"type": "string",
"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."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
},
"confirmCrAnalysisCategory": {
"type": "boolean",
"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."
},
"confirmCounterpartyExplicit": {
"type": "boolean",
"description": "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."
}
}
}
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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
string
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.
detailedResponse
boolean
Return full payload and BRC response for audit inspection. Default is compact.
confirmCrAnalysisCategory
boolean
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.
confirmCounterpartyExplicit
boolean
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"items",
"routeToken"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"opCode",
"item"
],
"properties": {
"item": {
"type": "object",
"required": [
"customerId",
"acCode",
"note",
"entryDate",
"procDate",
"bookTranTypeId",
"netAmount"
],
"properties": {
"note": {
"type": "string"
},
"total": {
"type": "number"
},
"acCode": {
"type": "string",
"minLength": 1
},
"procDate": {
"type": "string",
"minLength": 1
},
"totalNet": {
"type": "number"
},
"totalVAT": {
"type": "number"
},
"vatLines": {
"type": "array",
"items": {
"type": "object",
"required": [
"vatRateId",
"vatPercentage",
"netAmount"
],
"properties": {
"netAmount": {
"type": "number"
},
"vatRateId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"vatPercentage": {
"type": "number"
}
},
"additionalProperties": false
},
"maxItems": 100,
"description": "Separate VAT allocations; net amounts must sum to netAmount. Legacy vatRateId/vatPercentage remain supported."
},
"entryDate": {
"type": "string",
"minLength": 1
},
"netAmount": {
"type": "number",
"description": "Signed net total: positive, zero, or negative credit. No record-type conversion."
},
"vatRateId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"accountCode": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string"
},
"vatPercentage": {
"type": "number"
},
"bookTranTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"opCode": {
"type": "number",
"const": 1,
"description": "BRC batch create operation code. Must be 1."
}
},
"additionalProperties": false
},
"maxItems": 100,
"minItems": 1,
"description": "Batch items to process. Maximum 100 items per request."
},
"batchSize": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum item count for this request, not an automatic chunk size. If omitted: BRC_SALES_ENTRY_BATCH_SIZE, then BRC_MAX_BATCH_ITEMS, then fallback 20. Hard ceiling 100. RED never auto-splits requests; preview/confirm each submitted set."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
},
"detailedResponse": {
"type": "boolean",
"description": "Return full payload and BRC response for audit inspection. Default is compact."
},
"confirmCrAnalysisCategory": {
"type": "boolean",
"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."
},
"confirmCounterpartyExplicit": {
"type": "boolean",
"description": "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."
}
}
}
boolean
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
string
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.
confirmCrAnalysisCategory
boolean
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.
confirmCounterpartyExplicit
boolean
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"items",
"routeToken"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"item"
],
"properties": {
"item": {
"type": "object",
"required": [
"customerId",
"acCode",
"entryDate",
"procDate",
"saleRepId",
"saleRepCode",
"bookTranTypeId",
"totalNet",
"totalVAT",
"total"
],
"properties": {
"id": {
"type": "number"
},
"note": {
"type": "string"
},
"total": {
"type": "number"
},
"acCode": {
"type": "string",
"minLength": 1
},
"unpaid": {
"type": "number"
},
"quoteId": {
"type": "number"
},
"netGoods": {
"type": "number"
},
"procDate": {
"type": "string",
"minLength": 1
},
"totalNet": {
"type": "number"
},
"totalVAT": {
"type": "number"
},
"entryDate": {
"type": "string",
"minLength": 1
},
"saleRepId": {
"type": "number"
},
"vatTypeId": {
"type": "number"
},
"customerId": {
"type": "number"
},
"deliveryTo": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"netServices": {
"type": "number"
},
"saleRepCode": {
"type": "string",
"minLength": 1
},
"customFields": {
"type": "array",
"items": {}
},
"productTrans": {
"type": "array",
"items": {
"type": "object",
"required": [
"amount",
"amountNet",
"percentage",
"productCode",
"quantity",
"unitPrice",
"vat",
"vatRateId",
"vatAnalysisTypeId",
"tranNotes"
],
"properties": {
"id": {
"type": "number"
},
"vat": {
"type": "number"
},
"amount": {
"type": "number"
},
"quantity": {
"type": "number"
},
"acEntries": {
"type": "array",
"items": {
"type": "object",
"required": [
"accountCode",
"analysisCategoryId",
"value"
],
"properties": {
"id": {
"type": "number"
},
"value": {
"type": "number"
},
"accountCode": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string"
},
"analysisCategoryId": {
"type": "number"
}
},
"additionalProperties": {}
}
},
"amountNet": {
"type": "number"
},
"productId": {
"type": "number"
},
"tranNotes": {
"type": "array",
"items": {
"type": "string"
}
},
"unitPrice": {
"type": "number"
},
"vatRateId": {
"type": "number"
},
"percentage": {
"type": "number"
},
"productCode": {
"type": "string",
"minLength": 1
},
"vatAnalysisTypeId": {
"type": "number"
},
"useTaxInclusiveUnitPrice": {
"type": "boolean"
}
},
"additionalProperties": {}
}
},
"bookTranTypeId": {
"type": "number"
},
"useTaxInclusiveUnitPrice": {
"type": "boolean"
}
},
"description": "Complete BRC sales-invoice payload. Use nested productTrans lines with nested acEntries, matching brc_create_sales_invoice_gen_ref.",
"additionalProperties": {}
},
"opCode": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "BRC batch operation code. Use 1 to create a sales invoice."
}
},
"additionalProperties": {}
},
"maxItems": 100,
"minItems": 1,
"description": "Batch items to process. Maximum 100 items per request."
},
"priceBasis": {
"enum": [
"net",
"gross"
],
"type": "string",
"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."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
},
"confirmCrAnalysisCategory": {
"type": "boolean",
"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."
},
"confirmCounterpartyExplicit": {
"type": "boolean",
"description": "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."
}
}
}
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"items",
"routeToken"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"opCode",
"item"
],
"properties": {
"item": {
"type": "object",
"required": [
"code",
"name"
],
"properties": {
"code": {
"type": "string",
"minLength": 1,
"description": "BRC sales representative code. BRC may enforce additional server-side code limits."
},
"name": {
"type": "string",
"minLength": 1,
"description": "Sales representative name."
}
},
"additionalProperties": false
},
"opCode": {
"type": "number",
"const": 1,
"description": "BRC batch create operation code. Must be 1."
}
},
"additionalProperties": false
},
"maxItems": 100,
"minItems": 1,
"description": "Batch items to process. Maximum 100 items per request."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
}
}
}
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"items",
"routeToken"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"opCode",
"item"
],
"properties": {
"item": {
"type": "object",
"required": [
"code",
"name",
"vatType",
"vatAnalysisTypeId"
],
"properties": {
"fax": {
"type": "string",
"description": "Optional fax number. Blank values are accepted and omitted by the existing builder."
},
"code": {
"type": "string",
"maxLength": 8,
"minLength": 1,
"description": "BRC account code, maximum eight characters."
},
"name": {
"type": "string",
"minLength": 1,
"description": "Customer or supplier name."
},
"email": {
"type": "string",
"description": "Optional email address. Blank values are accepted and omitted by the existing builder."
},
"phone": {
"type": "string",
"description": "Optional phone number. Blank values are accepted and omitted by the existing builder."
},
"mobile": {
"type": "string",
"description": "Optional mobile number. Blank values are accepted and omitted by the existing builder."
},
"vatReg": {
"type": "string",
"description": "Optional VAT registration number. Blank values are accepted and omitted by the existing builder."
},
"address": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional address lines."
},
"contact": {
"type": "string",
"description": "Optional contact name. Blank values are accepted and omitted by the existing builder."
},
"vatType": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC VAT type integer. Resolve the intended value from the connected company's VAT reference data.",
"exclusiveMinimum": 0
},
"creditTerms": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Optional credit terms in days."
},
"vatRegistered": {
"type": "boolean",
"description": "Whether the owner is VAT registered."
},
"additionalEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional additional email addresses."
},
"vatAnalysisTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "BRC VAT analysis type id."
},
"businessIdentifierCode": {
"type": "string",
"description": "Optional BIC. Blank values are accepted and omitted by the existing builder."
},
"internationalBankAccountNumber": {
"type": "string",
"description": "Optional IBAN. Blank values are accepted and omitted by the existing builder."
}
},
"additionalProperties": false
},
"opCode": {
"type": "number",
"const": 1,
"description": "BRC batch create operation code. Must be 1."
}
},
"additionalProperties": false
},
"maxItems": 100,
"minItems": 1,
"description": "Batch items to process. Maximum 100 items per request."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
}
}
}
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Quote id."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
}
}
}
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
firstDetail
string
First detail text.
confirmWrite
boolean
Must be true only after the user explicitly confirms creating this accrual.
secondDetail
string
Second detail text.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"acCode",
"entryDate",
"procDate",
"reference",
"total",
"routeToken"
],
"properties": {
"total": {
"type": "number",
"description": "Accrual total amount."
},
"acCode": {
"type": "string",
"minLength": 1,
"description": "Nominal account code, for example 4000."
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Processing date, for example 2024-03-15T00:00:00."
},
"entryDate": {
"type": "string",
"minLength": 1,
"description": "Entry date, for example 2024-03-01T00:00:00."
},
"reference": {
"type": "string",
"minLength": 1,
"description": "Accrual reference, for example ACC0001."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"firstDetail": {
"type": "string",
"default": "",
"description": "First detail text."
},
"confirmWrite": {
"type": "boolean",
"description": "Must be true only after the user explicitly confirms creating this accrual."
},
"secondDetail": {
"type": "string",
"default": "",
"description": "Second detail text."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
accountName
string
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
accountNumber
string
confirmCreate
boolean
Must be true only after the user explicitly confirms creation.
connectionRef
string
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.
isDefaultBank
boolean
nominalAcCode
string
Existing linked nominal account code. This must already exist in Big Red Cloud and will be sent to the API as account.acCode.
creditorScheme
string
bankFeedsSource
integer
businessIdentifierCode
string
internationalBankAccountNumber
string
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"routeToken"
],
"properties": {
"acCode": {
"type": "string",
"description": "Bank account code, for example 1603."
},
"address": {
"type": "array",
"items": {
"type": "string"
}
},
"balance": {
"type": "number",
"default": 0,
"description": "Opening/current starting balance."
},
"details": {
"type": "string",
"description": "Bank account description/name."
},
"lastChq": {
"type": "string",
"description": "Last cheque number, for example 000001."
},
"payload": {
"type": "object",
"description": "Optional raw bank account payload.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"sortCode": {
"type": "string"
},
"categoryId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Bank Payments category type id from brc_list_category_types."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"accountName": {
"type": "string"
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"accountNumber": {
"type": "string"
},
"confirmCreate": {
"type": "boolean",
"default": false,
"description": "Must be true only after the user explicitly confirms creation."
},
"connectionRef": {
"type": "string",
"description": "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."
},
"isDefaultBank": {
"type": "boolean",
"default": false
},
"nominalAcCode": {
"type": "string",
"description": "Existing linked nominal account code. This must already exist in Big Red Cloud and will be sent to the API as account.acCode."
},
"creditorScheme": {
"type": "string"
},
"bankFeedsSource": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"businessIdentifierCode": {
"type": "string"
},
"internationalBankAccountNumber": {
"type": "string"
}
}
}
lodgement
number
Lodgement amount; must equal total when lodging to bank.
routeToken*
string
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
integer
Supplier id for ledger payments.
accountCode
string
Analysis account code matching analysisCategoryId, for example CP01.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
description
string
Analysis line description.
confirmWrite
boolean
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
integer
Bank account id for lodgements.
connectionRef
string
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
integer
Cash Payment book transaction type id.
bankAccountCode
string
Bank account code for lodgements.
analysisCategoryId
integer
Cash Payments analysis category id (categoryTypeId 1391170).
confirmCounterpartyExplicit
boolean
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"note",
"total",
"routeToken"
],
"properties": {
"note": {
"type": "string"
},
"total": {
"type": "number",
"exclusiveMinimum": 0
},
"acCode": {
"type": "string",
"description": "Supplier account code for ledger payments."
},
"ledger": {
"type": "number",
"description": "Ledger amount; must equal total for supplier payments."
},
"discount": {
"type": "number"
},
"procDate": {
"type": "string",
"description": "Processing date in ISO format. Defaults to entryDate."
},
"entryDate": {
"type": "string",
"description": "Entry date in ISO format. Defaults to today."
},
"lodgement": {
"type": "number",
"description": "Lodgement amount; must equal total when lodging to bank."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"supplierId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Supplier id for ledger payments.",
"exclusiveMinimum": 0
},
"accountCode": {
"type": "string",
"description": "Analysis account code matching analysisCategoryId, for example CP01."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"description": {
"type": "string",
"description": "Analysis line description."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Bank account id for lodgements.",
"exclusiveMinimum": 0
},
"connectionRef": {
"type": "string",
"description": "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": {
"type": "integer",
"default": 2,
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Cash Payment book transaction type id."
},
"bankAccountCode": {
"type": "string",
"description": "Bank account code for lodgements."
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Cash Payments analysis category id (categoryTypeId 1391170).",
"exclusiveMinimum": 0
},
"confirmCounterpartyExplicit": {
"type": "boolean",
"description": "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."
}
}
}
payload
object
Raw cash-receipt fields. Customer-ledger mode requires both customerId and acCode for the same resolved customer; analysed mode uses analysis allocation instead.
discount
number
procDate
string
Processing date; defaults to entryDate and is shown in the preview.
totalNet
number
totalVAT
number
totalVat
number
acEntries
array
entryDate
string
Entry date; defaults to today and is shown in the preview.
reference
string
Cash receipts do not support reference in the documented BRC API. Use detailCollection for audit or bank-reference text.
vatRateId
integer
vatTypeId
integer
customerId
integer
Resolved customer id. Customer-ledger receipts also require acCode for the same customer; analysed receipts can omit both.
percentage
number
routeToken*
string
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
array
accountCode
string
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
description
string
unallocated
number
confirmWrite
boolean
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
array
connectionRef
string
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
number
bookTranTypeId
integer
detailCollection
array
analysisCategoryId
integer
confirmCounterpartyExplicit
boolean
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"routeToken"
],
"properties": {
"note": {
"type": "string"
},
"total": {
"type": "number"
},
"acCode": {
"type": "string",
"description": "Resolved customer account code. Customer-ledger receipts also require customerId for the same customer; analysed receipts can omit both."
},
"ledger": {
"type": "number"
},
"details": {
"type": "string"
},
"payload": {
"type": "object",
"description": "Raw cash-receipt fields. Customer-ledger mode requires both customerId and acCode for the same resolved customer; analysed mode uses analysis allocation instead.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"discount": {
"type": "number"
},
"procDate": {
"type": "string",
"description": "Processing date; defaults to entryDate and is shown in the preview."
},
"totalNet": {
"type": "number"
},
"totalVAT": {
"type": "number"
},
"totalVat": {
"type": "number"
},
"acEntries": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"entryDate": {
"type": "string",
"description": "Entry date; defaults to today and is shown in the preview."
},
"reference": {
"type": "string",
"description": "Cash receipts do not support reference in the documented BRC API. Use detailCollection for audit or bank-reference text."
},
"vatRateId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"vatTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Resolved customer id. Customer-ledger receipts also require acCode for the same customer; analysed receipts can omit both.",
"exclusiveMinimum": 0
},
"percentage": {
"type": "number"
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"vatEntries": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"accountCode": {
"type": "string"
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"description": {
"type": "string"
},
"unallocated": {
"type": "number"
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "array",
"items": {}
},
"connectionRef": {
"type": "string",
"description": "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": {
"type": "number"
},
"bookTranTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"detailCollection": {
"type": "array",
"items": {
"type": "string"
}
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"confirmCounterpartyExplicit": {
"type": "boolean",
"description": "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."
}
}
}
detailedResponse
boolean
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"payload",
"routeToken"
],
"properties": {
"payload": {
"type": "object",
"description": "Raw BRC-compatible payload for this endpoint.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
},
"detailedResponse": {
"type": "boolean"
}
}
}
connectionRef
string
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
integer
Book transaction type id. Nominal Journal Batch is usually 7.
accountTransactions*
array
Nominal journal account transaction lines. Debits and credits should balance.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"entryDate",
"procDate",
"total",
"accountTransactions",
"routeToken"
],
"properties": {
"total": {
"type": "number",
"minimum": 0,
"description": "Total journal amount."
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Processing date, for example 2024-01-15T00:00:00."
},
"entryDate": {
"type": "string",
"minLength": 1,
"description": "Entry date, for example 2024-01-15T00:00:00."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "Must be true only after the user explicitly confirms creating this Nominal Journal Batch."
},
"connectionRef": {
"type": "string",
"description": "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": {
"type": "integer",
"default": 7,
"maximum": 9007199254740991,
"description": "Book transaction type id. Nominal Journal Batch is usually 7.",
"exclusiveMinimum": 0
},
"accountTransactions": {
"type": "array",
"items": {
"type": "object",
"required": [
"acCode",
"description",
"procDate",
"reference",
"debit",
"credit"
],
"properties": {
"debit": {
"type": "number",
"minimum": 0,
"description": "Debit amount for this line."
},
"acCode": {
"type": "string",
"minLength": 1,
"description": "Nominal account code, for example 400 or 800."
},
"credit": {
"type": "number",
"minimum": 0,
"description": "Credit amount for this line."
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Processing date for this transaction line."
},
"reference": {
"type": "string",
"minLength": 1,
"description": "Journal reference, for example NJ0001."
},
"description": {
"type": "string",
"minLength": 1,
"description": "Line description, for example Sales or Expenses."
},
"firstDetail": {
"type": "string",
"default": "",
"description": "First detail text for this line."
},
"secondDetail": {
"type": "string",
"default": "",
"description": "Second detail text for this line."
}
}
},
"minItems": 2,
"description": "Nominal journal account transaction lines. Debits and credits should balance."
}
}
}
*
string
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
integer
Supplier id for supplier payments.
accountCode
string
Analysis account code matching analysisCategoryId, for example BP01.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
description
string
Analysis line description.
confirmWrite
boolean
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*
integer
connectionRef
string
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
integer
Cheques Entry / Payments book transaction type id.
bankAccountCode*
string
analysisCategoryId
integer
Payments book analysis category id for the selected bank.
confirmCounterpartyExplicit
boolean
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"note",
"total",
"bankAccountId",
"bankAccountCode",
"routeToken"
],
"properties": {
"note": {
"type": "string"
},
"total": {
"type": "number",
"exclusiveMinimum": 0
},
"acCode": {
"type": "string",
"description": "Supplier account code for supplier payments."
},
"discount": {
"type": "number"
},
"procDate": {
"type": "string",
"description": "Processing date in ISO format. Defaults to entryDate."
},
"entryDate": {
"type": "string",
"description": "Entry date in ISO format. Defaults to today."
},
"reference": {
"type": "string"
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"supplierId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Supplier id for supplier payments.",
"exclusiveMinimum": 0
},
"accountCode": {
"type": "string",
"description": "Analysis account code matching analysisCategoryId, for example BP01."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"description": {
"type": "string",
"description": "Analysis line description."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"connectionRef": {
"type": "string",
"description": "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": {
"type": "integer",
"default": 3,
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Cheques Entry / Payments book transaction type id."
},
"bankAccountCode": {
"type": "string"
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Payments book analysis category id for the selected bank.",
"exclusiveMinimum": 0
},
"confirmCounterpartyExplicit": {
"type": "boolean",
"description": "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."
}
}
}
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
firstDetail
string
First detail text.
confirmWrite
boolean
Must be true only after the user explicitly confirms creating this prepayment.
secondDetail
string
Second detail text.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"acCode",
"entryDate",
"procDate",
"reference",
"total",
"routeToken"
],
"properties": {
"total": {
"type": "number",
"description": "Prepayment total amount."
},
"acCode": {
"type": "string",
"minLength": 1,
"description": "Nominal account code, for example 4000."
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Processing date, for example 2024-03-15T00:00:00."
},
"entryDate": {
"type": "string",
"minLength": 1,
"description": "Entry date, for example 2024-03-01T00:00:00."
},
"reference": {
"type": "string",
"minLength": 1,
"description": "Prepayment reference, for example PRE0001."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"firstDetail": {
"type": "string",
"default": "",
"description": "First detail text."
},
"confirmWrite": {
"type": "boolean",
"description": "Must be true only after the user explicitly confirms creating this prepayment."
},
"secondDetail": {
"type": "string",
"default": "",
"description": "Second detail text."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"payload",
"routeToken"
],
"properties": {
"payload": {
"type": "object",
"description": "Raw BRC-compatible payload for this endpoint.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
}
}
}
vatRateId*
integer
VAT rate id.
routeToken*
string
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*
string
Supplier id, for example 26180406.
accountCode*
string
Nominal/account code.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
description*
string
Analysis line description.
confirmWrite
boolean
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
string
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*
number
VAT percentage.
bookTranTypeId*
integer
Purchase book transaction type id.
analysisCategoryId*
integer
Purchases analysis category id.
confirmCounterpartyExplicit
boolean
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"supplierId",
"acCode",
"note",
"entryDate",
"procDate",
"bookTranTypeId",
"analysisCategoryId",
"accountCode",
"description",
"netAmount",
"vatRateId",
"vatPercentage",
"routeToken"
],
"properties": {
"note": {
"type": "string",
"description": "Purchase note."
},
"acCode": {
"type": "string",
"description": "Supplier account code, for example SUP001."
},
"procDate": {
"type": "string",
"description": "Processing date in ISO format."
},
"entryDate": {
"type": "string",
"description": "Entry date in ISO format."
},
"netAmount": {
"type": "number",
"description": "Net amount before VAT."
},
"reference": {
"type": "string",
"description": "Required when the company is configured for manual purchase references."
},
"vatRateId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "VAT rate id."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"supplierId": {
"type": "string",
"description": "Supplier id, for example 26180406."
},
"accountCode": {
"type": "string",
"description": "Nominal/account code."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"description": {
"type": "string",
"description": "Analysis line description."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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": {
"type": "number",
"description": "VAT percentage."
},
"bookTranTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Purchase book transaction type id."
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Purchases analysis category id."
},
"confirmCounterpartyExplicit": {
"type": "boolean",
"description": "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."
}
}
}
supplierId*
integer
accountCode*
string
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
description*
string
confirmWrite
boolean
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
string
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*
number
bookTranTypeId*
integer
analysisCategoryId*
integer
confirmCounterpartyExplicit
boolean
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"supplierId",
"acCode",
"note",
"entryDate",
"procDate",
"bookTranTypeId",
"analysisCategoryId",
"accountCode",
"description",
"netAmount",
"vatRateId",
"vatPercentage",
"routeToken"
],
"properties": {
"note": {
"type": "string"
},
"acCode": {
"type": "string"
},
"procDate": {
"type": "string"
},
"entryDate": {
"type": "string"
},
"netAmount": {
"type": "number",
"exclusiveMinimum": 0
},
"vatRateId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"supplierId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"accountCode": {
"type": "string"
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"description": {
"type": "string"
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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": {
"type": "number"
},
"bookTranTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"confirmCounterpartyExplicit": {
"type": "boolean",
"description": "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."
}
}
}
Required BRC company id for the quote payload. Use the connected company's id from existing records such as customers, products, or sales reps. Do not omit this field.
entryDate*
string
productId*
integer
reference
string
Optional manual quote reference, max 6 characters. Required when quote references are manual, or when the quote reference setting is unknown. Quote reference must be 6 characters or fewer because Big Red Cloud truncates longer references.
saleRepId*
integer
Sales rep id from brc_list_sales_reps.
unitPrice*
number
vatRateId*
integer
vatTypeId
integer
layoutType
integer
routeToken*
string
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.
accountCode*
string
Sales Analysis account code for the quote product line, for example SA01.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
productCode*
string
saleRepCode*
string
Sales rep code from brc_list_sales_reps.
confirmWrite
boolean
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
string
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*
number
customerOwnerId*
integer
customerOwnerName*
string
analysisCategoryId*
integer
confirmCrAnalysisCategory
boolean
Set true only after the user confirms a CR sales analysis account code is intentional for this product line.
confirmCounterpartyExplicit
boolean
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.
confirmQuotesAutoGenerateInBrc
boolean
Set true only after the user confirms quotes are auto-generated in Big Red Cloud. Required for brc_create_quote_gen_ref when Quotes reference setting is Unknown.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"companyId",
"customerOwnerId",
"acCode",
"customerOwnerName",
"comments",
"entryDate",
"procDate",
"saleRepId",
"saleRepCode",
"productId",
"productCode",
"quantity",
"unitPrice",
"vatRateId",
"vatPercentage",
"tranNote",
"analysisCategoryId",
"accountCode",
"routeToken"
],
"properties": {
"acCode": {
"type": "string"
},
"comments": {
"type": "string"
},
"ddNumber": {
"type": "string"
},
"poNumber": {
"type": "string"
},
"procDate": {
"type": "string"
},
"quantity": {
"type": "number",
"exclusiveMinimum": 0
},
"tranNote": {
"type": "string"
},
"companyId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Required BRC company id for the quote payload. Use the connected company's id from existing records such as customers, products, or sales reps. Do not omit this field.",
"exclusiveMinimum": 0
},
"entryDate": {
"type": "string"
},
"productId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"reference": {
"type": "string",
"maxLength": 6,
"description": "Optional manual quote reference, max 6 characters. Required when quote references are manual, or when the quote reference setting is unknown. Quote reference must be 6 characters or fewer because Big Red Cloud truncates longer references."
},
"saleRepId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Sales rep id from brc_list_sales_reps.",
"exclusiveMinimum": 0
},
"unitPrice": {
"type": "number",
"exclusiveMinimum": 0
},
"vatRateId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"vatTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"layoutType": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"accountCode": {
"type": "string",
"minLength": 1,
"description": "Sales Analysis account code for the quote product line, for example SA01."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"productCode": {
"type": "string"
},
"saleRepCode": {
"type": "string",
"minLength": 1,
"description": "Sales rep code from brc_list_sales_reps."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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": {
"type": "number"
},
"customerOwnerId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"customerOwnerName": {
"type": "string"
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"confirmCrAnalysisCategory": {
"type": "boolean",
"description": "Set true only after the user confirms a CR sales analysis account code is intentional for this product line."
},
"confirmCounterpartyExplicit": {
"type": "boolean",
"description": "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."
},
"confirmQuotesAutoGenerateInBrc": {
"type": "boolean",
"description": "Set true only after the user confirms quotes are auto-generated in Big Red Cloud. Required for brc_create_quote_gen_ref when Quotes reference setting is Unknown."
}
}
}
Required BRC company id for the quote payload. Use the connected company's id from existing records such as customers, products, or sales reps. Do not omit this field.
entryDate*
string
productId*
integer
reference
string
Optional manual quote reference, max 6 characters. Required when quote references are manual, or when the quote reference setting is unknown. Quote reference must be 6 characters or fewer because Big Red Cloud truncates longer references.
saleRepId*
integer
Sales rep id from brc_list_sales_reps.
unitPrice*
number
vatRateId*
integer
vatTypeId
integer
layoutType
integer
routeToken*
string
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.
accountCode*
string
Sales Analysis account code for the quote product line, for example SA01.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
productCode*
string
saleRepCode*
string
Sales rep code from brc_list_sales_reps.
confirmWrite
boolean
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
string
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*
number
customerOwnerId*
integer
customerOwnerName*
string
analysisCategoryId*
integer
confirmCrAnalysisCategory
boolean
Set true only after the user confirms a CR sales analysis account code is intentional for this product line.
confirmCounterpartyExplicit
boolean
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.
confirmQuotesAutoGenerateInBrc
boolean
Set true only after the user confirms quotes are auto-generated in Big Red Cloud. Required for brc_create_quote_gen_ref when Quotes reference setting is Unknown.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"companyId",
"customerOwnerId",
"acCode",
"customerOwnerName",
"comments",
"entryDate",
"procDate",
"saleRepId",
"saleRepCode",
"productId",
"productCode",
"quantity",
"unitPrice",
"vatRateId",
"vatPercentage",
"tranNote",
"analysisCategoryId",
"accountCode",
"routeToken"
],
"properties": {
"acCode": {
"type": "string"
},
"comments": {
"type": "string"
},
"ddNumber": {
"type": "string"
},
"poNumber": {
"type": "string"
},
"procDate": {
"type": "string"
},
"quantity": {
"type": "number",
"exclusiveMinimum": 0
},
"tranNote": {
"type": "string"
},
"companyId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Required BRC company id for the quote payload. Use the connected company's id from existing records such as customers, products, or sales reps. Do not omit this field.",
"exclusiveMinimum": 0
},
"entryDate": {
"type": "string"
},
"productId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"reference": {
"type": "string",
"maxLength": 6,
"description": "Optional manual quote reference, max 6 characters. Required when quote references are manual, or when the quote reference setting is unknown. Quote reference must be 6 characters or fewer because Big Red Cloud truncates longer references."
},
"saleRepId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Sales rep id from brc_list_sales_reps.",
"exclusiveMinimum": 0
},
"unitPrice": {
"type": "number",
"exclusiveMinimum": 0
},
"vatRateId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"vatTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"layoutType": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"accountCode": {
"type": "string",
"minLength": 1,
"description": "Sales Analysis account code for the quote product line, for example SA01."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"productCode": {
"type": "string"
},
"saleRepCode": {
"type": "string",
"minLength": 1,
"description": "Sales rep code from brc_list_sales_reps."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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": {
"type": "number"
},
"customerOwnerId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"customerOwnerName": {
"type": "string"
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"confirmCrAnalysisCategory": {
"type": "boolean",
"description": "Set true only after the user confirms a CR sales analysis account code is intentional for this product line."
},
"confirmCounterpartyExplicit": {
"type": "boolean",
"description": "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."
},
"confirmQuotesAutoGenerateInBrc": {
"type": "boolean",
"description": "Set true only after the user confirms quotes are auto-generated in Big Red Cloud. Required for brc_create_quote_gen_ref when Quotes reference setting is Unknown."
}
}
}
reference
string
saleRepId*
integer
Sales rep id from brc_list_sales_reps.
unitPrice*
number
vatRateId*
integer
customerId*
integer
routeToken*
string
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.
accountCode*
string
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
description*
string
productCode*
string
saleRepCode*
string
Sales rep code from brc_list_sales_reps.
confirmWrite
boolean
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
string
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*
number
bookTranTypeId*
integer
analysisCategoryId*
integer
confirmCrAnalysisCategory
boolean
Set true only after the user confirms a CR sales analysis account code is intentional for this product line.
confirmCounterpartyExplicit
boolean
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"customerId",
"acCode",
"note",
"entryDate",
"procDate",
"bookTranTypeId",
"analysisCategoryId",
"accountCode",
"description",
"netAmount",
"vatRateId",
"vatPercentage",
"productId",
"productCode",
"quantity",
"unitPrice",
"saleRepId",
"saleRepCode",
"routeToken"
],
"properties": {
"note": {
"type": "string"
},
"acCode": {
"type": "string"
},
"procDate": {
"type": "string"
},
"quantity": {
"type": "number",
"exclusiveMinimum": 0
},
"entryDate": {
"type": "string"
},
"netAmount": {
"type": "number",
"exclusiveMinimum": 0
},
"productId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"reference": {
"type": "string"
},
"saleRepId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Sales rep id from brc_list_sales_reps.",
"exclusiveMinimum": 0
},
"unitPrice": {
"type": "number",
"exclusiveMinimum": 0
},
"vatRateId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"accountCode": {
"type": "string",
"minLength": 1
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"description": {
"type": "string"
},
"productCode": {
"type": "string"
},
"saleRepCode": {
"type": "string",
"minLength": 1,
"description": "Sales rep code from brc_list_sales_reps."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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": {
"type": "number"
},
"bookTranTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"confirmCrAnalysisCategory": {
"type": "boolean",
"description": "Set true only after the user confirms a CR sales analysis account code is intentional for this product line."
},
"confirmCounterpartyExplicit": {
"type": "boolean",
"description": "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."
}
}
}
connectionRef
string
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.
confirmCrAnalysisCategory
boolean
Set true only after the user confirms a CR sales analysis account code is intentional for this product line.
confirmCounterpartyExplicit
boolean
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"payload",
"routeToken"
],
"properties": {
"payload": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
},
"confirmCrAnalysisCategory": {
"type": "boolean",
"description": "Set true only after the user confirms a CR sales analysis account code is intentional for this product line."
},
"confirmCounterpartyExplicit": {
"type": "boolean",
"description": "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."
}
}
}
entryDate*
string
netAmount*
number
Signed net total: positive, zero, or negative credit. No record-type conversion.
vatRateId
integer
customerId*
integer
routeToken*
string
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.
accountCode
string
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
description
string
confirmWrite
boolean
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
string
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
number
bookTranTypeId*
integer
detailedResponse
boolean
Include full payload and BRC response; compact result is default.
analysisCategoryId
integer
confirmCounterpartyExplicit
boolean
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"customerId",
"acCode",
"note",
"entryDate",
"procDate",
"bookTranTypeId",
"netAmount",
"routeToken"
],
"properties": {
"note": {
"type": "string"
},
"total": {
"type": "number"
},
"acCode": {
"type": "string",
"minLength": 1
},
"procDate": {
"type": "string",
"minLength": 1
},
"totalNet": {
"type": "number"
},
"totalVAT": {
"type": "number"
},
"vatLines": {
"type": "array",
"items": {
"type": "object",
"required": [
"vatRateId",
"vatPercentage",
"netAmount"
],
"properties": {
"netAmount": {
"type": "number"
},
"vatRateId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"vatPercentage": {
"type": "number"
}
},
"additionalProperties": false
},
"maxItems": 100,
"description": "Separate VAT allocations; net amounts must sum to netAmount. Legacy vatRateId/vatPercentage remain supported."
},
"entryDate": {
"type": "string",
"minLength": 1
},
"netAmount": {
"type": "number",
"description": "Signed net total: positive, zero, or negative credit. No record-type conversion."
},
"vatRateId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"accountCode": {
"type": "string",
"minLength": 1
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"description": {
"type": "string"
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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": {
"type": "number"
},
"bookTranTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"detailedResponse": {
"type": "boolean",
"description": "Include full payload and BRC response; compact result is default."
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"confirmCounterpartyExplicit": {
"type": "boolean",
"description": "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."
}
}
}
number
productId*
integer
productCode is the BRC product "Code" (JSON `productCode`); productId is the BRC product "Id" (JSON `productId`) from brc_list_products. The product name is not a payload field — do not place it in the BRC "Note" field (JSON `note`).
reference
string
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*
integer
Sales rep id from brc_list_sales_reps.
unitPrice*
number
vatRateId*
integer
customerId*
integer
deliveryTo
any
Optional. BRC "Delivery To" address (JSON field `deliveryTo`). Leave blank unless the user explicitly provides a delivery address. Do not invent or default a delivery address (for example "MCP Test").
priceBasis
string
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.
routeToken*
string
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.
accountCode*
string
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
description*
string
Product line description shown on the document line (BRC product line description / JSON `tranNotes`, also used on the line's analysis entry description). This is the line narrative, not the BRC "Note" field.
productCode*
string
productCode is the BRC product "Code" (JSON `productCode`); productId is the BRC product "Id" (JSON `productId`) from brc_list_products. The product name is not a payload field — do not place it in the BRC "Note" field (JSON `note`).
saleRepCode*
string
Sales rep code from brc_list_sales_reps.
confirmWrite
boolean
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.
customerName
string
Optional. The selected customer's name (BRC customer "Name" / JSON `name`). Used as the default sales document note (BRC "Note" / JSON `note`) when no explicit note is given.
connectionRef
string
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*
number
bookTranTypeId*
integer
analysisCategoryId*
integer
confirmCrAnalysisCategory
boolean
Set true only after the user confirms a CR sales analysis account code is intentional for this product line.
confirmCounterpartyExplicit
boolean
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"customerId",
"acCode",
"entryDate",
"procDate",
"bookTranTypeId",
"analysisCategoryId",
"accountCode",
"description",
"netAmount",
"vatRateId",
"vatPercentage",
"productId",
"productCode",
"quantity",
"unitPrice",
"saleRepId",
"saleRepCode",
"routeToken"
],
"properties": {
"note": {
"type": "string",
"description": "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."
},
"acCode": {
"type": "string"
},
"procDate": {
"type": "string"
},
"quantity": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"entryDate": {
"type": "string"
},
"netAmount": {
"type": "number",
"exclusiveMinimum": 0
},
"productId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "productCode is the BRC product \"Code\" (JSON `productCode`); productId is the BRC product \"Id\" (JSON `productId`) from brc_list_products. The product name is not a payload field — do not place it in the BRC \"Note\" field (JSON `note`).",
"exclusiveMinimum": 0
},
"reference": {
"type": "string",
"description": "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": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Sales rep id from brc_list_sales_reps.",
"exclusiveMinimum": 0
},
"unitPrice": {
"type": "number",
"exclusiveMinimum": 0
},
"vatRateId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"deliveryTo": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Optional. BRC \"Delivery To\" address (JSON field `deliveryTo`). Leave blank unless the user explicitly provides a delivery address. Do not invent or default a delivery address (for example \"MCP Test\")."
},
"priceBasis": {
"enum": [
"net",
"gross"
],
"type": "string",
"description": "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."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"accountCode": {
"type": "string",
"minLength": 1
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"description": {
"type": "string",
"description": "Product line description shown on the document line (BRC product line description / JSON `tranNotes`, also used on the line's analysis entry description). This is the line narrative, not the BRC \"Note\" field."
},
"productCode": {
"type": "string",
"description": "productCode is the BRC product \"Code\" (JSON `productCode`); productId is the BRC product \"Id\" (JSON `productId`) from brc_list_products. The product name is not a payload field — do not place it in the BRC \"Note\" field (JSON `note`)."
},
"saleRepCode": {
"type": "string",
"minLength": 1,
"description": "Sales rep code from brc_list_sales_reps."
},
"confirmWrite": {
"type": "boolean",
"description": "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."
},
"customerName": {
"type": "string",
"description": "Optional. The selected customer's name (BRC customer \"Name\" / JSON `name`). Used as the default sales document note (BRC \"Note\" / JSON `note`) when no explicit note is given."
},
"connectionRef": {
"type": "string",
"description": "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": {
"type": "number"
},
"bookTranTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"confirmCrAnalysisCategory": {
"type": "boolean",
"description": "Set true only after the user confirms a CR sales analysis account code is intentional for this product line."
},
"confirmCounterpartyExplicit": {
"type": "boolean",
"description": "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."
}
}
}
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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
string
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.
confirmCrAnalysisCategory
boolean
Set true only after the user confirms a CR sales analysis account code is intentional for this product line.
confirmCounterpartyExplicit
boolean
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"payload",
"routeToken"
],
"properties": {
"payload": {
"type": "object",
"required": [
"customerId",
"acCode",
"entryDate",
"procDate",
"saleRepId",
"saleRepCode",
"bookTranTypeId",
"totalNet",
"totalVAT",
"total"
],
"properties": {
"id": {
"type": "number"
},
"note": {
"type": "string"
},
"total": {
"type": "number"
},
"acCode": {
"type": "string",
"minLength": 1
},
"unpaid": {
"type": "number"
},
"quoteId": {
"type": "number"
},
"netGoods": {
"type": "number"
},
"procDate": {
"type": "string",
"minLength": 1
},
"totalNet": {
"type": "number"
},
"totalVAT": {
"type": "number"
},
"entryDate": {
"type": "string",
"minLength": 1
},
"saleRepId": {
"type": "number"
},
"vatTypeId": {
"type": "number"
},
"customerId": {
"type": "number"
},
"deliveryTo": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"netServices": {
"type": "number"
},
"saleRepCode": {
"type": "string",
"minLength": 1
},
"customFields": {
"type": "array",
"items": {}
},
"productTrans": {
"type": "array",
"items": {
"type": "object",
"required": [
"amount",
"amountNet",
"percentage",
"productCode",
"quantity",
"unitPrice",
"vat",
"vatRateId",
"vatAnalysisTypeId",
"tranNotes"
],
"properties": {
"id": {
"type": "number"
},
"vat": {
"type": "number"
},
"amount": {
"type": "number"
},
"quantity": {
"type": "number"
},
"acEntries": {
"type": "array",
"items": {
"type": "object",
"required": [
"accountCode",
"analysisCategoryId",
"value"
],
"properties": {
"id": {
"type": "number"
},
"value": {
"type": "number"
},
"accountCode": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string"
},
"analysisCategoryId": {
"type": "number"
}
},
"additionalProperties": {}
}
},
"amountNet": {
"type": "number"
},
"productId": {
"type": "number"
},
"tranNotes": {
"type": "array",
"items": {
"type": "string"
}
},
"unitPrice": {
"type": "number"
},
"vatRateId": {
"type": "number"
},
"percentage": {
"type": "number"
},
"productCode": {
"type": "string",
"minLength": 1
},
"vatAnalysisTypeId": {
"type": "number"
},
"useTaxInclusiveUnitPrice": {
"type": "boolean"
}
},
"additionalProperties": {}
}
},
"bookTranTypeId": {
"type": "number"
},
"useTaxInclusiveUnitPrice": {
"type": "boolean"
}
},
"description": "Raw BRC payloads for multi-line sales invoices must use `productTrans[]` (one object per product line). Each product line must include its own nested `acEntries[]` for Sales analysis posting — do not send a top-level `acEntries` array on the invoice. Required header fields include customerId, acCode, entryDate, procDate, saleRepId, saleRepCode, bookTranTypeId, totalNet, totalVAT, total, and unpaid. Red validates line amounts, nested analysis values, qty × unit price (using useTaxInclusiveUnitPrice), and header totals before posting, and returns all validation issues together when the payload does not reconcile. Preview-before-posting still shows what Red will post and waits for confirmation before anything is written to Big Red Cloud.",
"additionalProperties": {}
},
"priceBasis": {
"enum": [
"net",
"gross"
],
"type": "string",
"description": "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."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
},
"confirmCrAnalysisCategory": {
"type": "boolean",
"description": "Set true only after the user confirms a CR sales analysis account code is intentional for this product line."
},
"confirmCounterpartyExplicit": {
"type": "boolean",
"description": "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."
}
}
}
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"code",
"name",
"routeToken"
],
"properties": {
"code": {
"type": "string",
"description": "Sales rep code."
},
"name": {
"type": "string",
"description": "Sales rep name."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
}
}
}
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"payload",
"routeToken"
],
"properties": {
"payload": {
"type": "object",
"description": "Raw BRC-compatible payload for this endpoint.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
}
}
}
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"timestamp",
"routeToken"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Parent accrual id.",
"exclusiveMinimum": 0
},
"timestamp": {
"type": "string",
"minLength": 1,
"description": "Base64 timestamp returned by the accrual, for example K94UQIbL3gg=."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "Must be true only after the user explicitly confirms deleting this accrual."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Allocation resolver id to reverse/delete.",
"exclusiveMinimum": 0
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "Must be true only after the user explicitly confirms reversing/deleting this allocation."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "bank account id."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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."
},
"confirmDelete": {
"type": "boolean",
"default": false
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "cash payment id."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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."
},
"confirmDelete": {
"type": "boolean",
"default": false
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "cash receipt id."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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."
},
"confirmDelete": {
"type": "boolean",
"default": false
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "customer id."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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."
},
"confirmDelete": {
"type": "boolean",
"default": false
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"timestamp",
"routeToken"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Nominal Journal Batch id.",
"exclusiveMinimum": 0
},
"timestamp": {
"type": "string",
"minLength": 1,
"description": "Base64 timestamp returned by the Nominal Journal Batch, for example 7aIZQIbL3gg=."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "Must be true only after the user explicitly confirms deleting this Nominal Journal Batch."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "payment id."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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."
},
"confirmDelete": {
"type": "boolean",
"default": false
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"timestamp",
"routeToken"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Parent prepayment id.",
"exclusiveMinimum": 0
},
"timestamp": {
"type": "string",
"minLength": 1,
"description": "Base64 timestamp returned by the prepayment, for example bgUcQIbL3gg=."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "Must be true only after the user explicitly confirms deleting this prepayment."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "product id."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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."
},
"confirmDelete": {
"type": "boolean",
"default": false
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
boolean
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Purchase id."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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."
},
"confirmDelete": {
"type": "boolean",
"default": false
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
confirmDelete
boolean
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Quote id."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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."
},
"confirmDelete": {
"type": "boolean",
"default": false
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Sales credit note id."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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."
},
"confirmDelete": {
"type": "boolean",
"default": false
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Sales entry id.",
"exclusiveMinimum": 0
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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."
},
"confirmDelete": {
"type": "boolean",
"default": false
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Sales invoice id."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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."
},
"confirmDelete": {
"type": "boolean",
"default": false
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Sales rep id."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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."
},
"confirmDelete": {
"type": "boolean",
"default": false
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "supplier id."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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."
},
"confirmDelete": {
"type": "boolean",
"default": false
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
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
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"quoteId",
"routeToken"
],
"properties": {
"quoteId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Quote id.",
"exclusiveMinimum": 0
},
"procDate": {
"type": "string",
"description": "Optional invoice processing date in ISO format."
},
"entryDate": {
"type": "string",
"description": "Optional invoice entry date in ISO format."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
}
}
}
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
customerCode
string
Exact case-sensitive code; bounded local filtering, no fuzzy match.
procDateFrom
string
Inclusive transaction date YYYY-MM-DD; local filtering.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter using entryDate only. Other fields are unsupported."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"procDateTo": {
"type": "string",
"description": "Inclusive transaction date YYYY-MM-DD; local filtering."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"customerCode": {
"type": "string",
"minLength": 1,
"description": "Exact case-sensitive code; bounded local filtering, no fuzzy match."
},
"procDateFrom": {
"type": "string",
"description": "Inclusive transaction date YYYY-MM-DD; local filtering."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Unsupported: BRC customers forbid $filter. List with pagination and match locally."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"customerCode": {
"type": "string",
"minLength": 1,
"description": "Exact case-sensitive code; bounded local filtering, no fuzzy match."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName"
],
"properties": {
"top": {
"type": "integer",
"maximum": 500,
"exclusiveMinimum": 0
},
"page": {
"type": "integer",
"default": 1,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"filter": {
"type": "string",
"description": "Optional OData $filter expression, only if this endpoint supports filtering."
},
"orderBy": {
"type": "string",
"description": "Optional OData $orderby expression, only if this endpoint supports ordering."
},
"pageSize": {
"type": "integer",
"default": 20,
"maximum": 500,
"exclusiveMinimum": 0
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
string
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.
effectiveDate
string
Not a valid standalone payload. Use vatCategoryRates instead.
confirmProcess
boolean
vatCategoryRates
array
Full BRC payload array for POST /v1/vatCategories/vatRates, e.g. [{ vatCategoryId: 1, vatRates: [...] }].
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"routeToken"
],
"properties": {
"payload": {
"type": "object",
"description": "Deprecated. Use vatCategoryRates instead of a raw payload object.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
},
"effectiveDate": {
"type": "string",
"description": "Not a valid standalone payload. Use vatCategoryRates instead."
},
"confirmProcess": {
"type": "boolean",
"default": false
},
"vatCategoryRates": {
"type": "array",
"items": {
"type": "object",
"required": [
"vatCategoryId",
"vatRates"
],
"properties": {
"vatRates": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"percentage",
"orderIndex",
"isActive",
"isDefault",
"vatCategoryId"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"isActive": {
"type": "boolean"
},
"isDefault": {
"type": "boolean"
},
"orderIndex": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"percentage": {
"type": "number"
},
"vatCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
},
"minItems": 1
},
"vatCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
},
"minItems": 1,
"description": "Full BRC payload array for POST /v1/vatCategories/vatRates, e.g. [{ vatCategoryId: 1, vatRates: [...] }]."
}
}
}
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Quote id."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
}
}
}
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmSend
boolean
Must be true only after the user has reviewed the email preview and explicitly confirmed sending.
fromAddress
string
Optional sender address override.
messageBody
string
Optional custom email message body.
toAddresses
array
Optional list of recipients. If more than one is provided, ask the user whether to send one email with BCC or separate individual emails.
bccAddresses
array
Optional BCC email addresses. Only use if the user explicitly provides BCC addresses or chooses one email with BCC.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"customerId",
"routeToken"
],
"properties": {
"sendMode": {
"enum": [
"single_with_bcc",
"separate"
],
"type": "string",
"description": "How to handle multiple recipients. Use separate only when the user explicitly asks to send separate individual emails."
},
"toPeriod": {
"type": "string",
"description": "Statement period end (ISO date-time, e.g. 2026-05-31T00:00:00)."
},
"toAddress": {
"type": "string",
"description": "Optional single recipient override. If omitted or empty, BRC uses the customer's email address."
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC field: customerId.",
"exclusiveMinimum": 0
},
"fromPeriod": {
"type": "string",
"description": "Statement period start (ISO date-time, e.g. 2026-01-01T00:00:00)."
},
"minBalance": {
"type": "number",
"description": "Minimum balance threshold for transactions included on the statement."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmSend": {
"type": "boolean",
"default": false,
"description": "Must be true only after the user has reviewed the email preview and explicitly confirmed sending."
},
"fromAddress": {
"type": "string",
"description": "Optional sender address override."
},
"messageBody": {
"type": "string",
"description": "Optional custom email message body."
},
"toAddresses": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional list of recipients. If more than one is provided, ask the user whether to send one email with BCC or separate individual emails."
},
"bccAddresses": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional BCC email addresses. Only use if the user explicitly provides BCC addresses or chooses one email with BCC."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
fromAddress
string
Optional sender address override.
messageBody
string
Optional custom email message body.
toAddresses
array
Optional list of recipients. If more than one is provided, ask the user whether to send one email with BCC or separate individual emails.
bccAddresses
array
Optional BCC email addresses. Only use if the user explicitly provides BCC addresses or chooses one email with BCC.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"quoteId",
"routeToken"
],
"properties": {
"quoteId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC field: quoteId.",
"exclusiveMinimum": 0
},
"sendMode": {
"enum": [
"single_with_bcc",
"separate"
],
"type": "string",
"description": "How to handle multiple recipients. Use separate only when the user explicitly asks to send separate individual emails."
},
"toAddress": {
"type": "string",
"description": "Optional single recipient override. If omitted or empty, BRC uses the customer's email address."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmSend": {
"type": "boolean",
"default": false,
"description": "Must be true only after the user has reviewed the email preview and explicitly confirmed sending."
},
"fromAddress": {
"type": "string",
"description": "Optional sender address override."
},
"messageBody": {
"type": "string",
"description": "Optional custom email message body."
},
"toAddresses": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional list of recipients. If more than one is provided, ask the user whether to send one email with BCC or separate individual emails."
},
"bccAddresses": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional BCC email addresses. Only use if the user explicitly provides BCC addresses or chooses one email with BCC."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
messageBody
string
Optional custom email message body.
toAddresses
array
Optional list of recipients. If more than one is provided, ask the user whether to send one email with BCC or separate individual emails.
bccAddresses
array
Optional BCC email addresses. Only use if the user explicitly provides BCC addresses or chooses one email with BCC.
connectionRef
string
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.
salesInvoiceId*
integer
BRC field: salesInvoiceId.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"salesInvoiceId",
"routeToken"
],
"properties": {
"sendMode": {
"enum": [
"single_with_bcc",
"separate"
],
"type": "string",
"description": "How to handle multiple recipients. Use separate only when the user explicitly asks to send separate individual emails."
},
"toAddress": {
"type": "string",
"description": "Optional single recipient override. If omitted or empty, BRC uses the customer's email address."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmSend": {
"type": "boolean",
"default": false,
"description": "Must be true only after the user has reviewed the email preview and explicitly confirmed sending."
},
"fromAddress": {
"type": "string",
"description": "Optional sender address override."
},
"messageBody": {
"type": "string",
"description": "Optional custom email message body."
},
"toAddresses": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional list of recipients. If more than one is provided, ask the user whether to send one email with BCC or separate individual emails."
},
"bccAddresses": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional BCC email addresses. Only use if the user explicitly provides BCC addresses or chooses one email with BCC."
},
"connectionRef": {
"type": "string",
"description": "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."
},
"salesInvoiceId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "BRC field: salesInvoiceId.",
"exclusiveMinimum": 0
}
}
}
Base64 timestamp returned by the accrual, for example K94UQIbL3gg=.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
firstDetail
string
First detail text.
confirmWrite
boolean
Must be true only after the user explicitly confirms updating this accrual.
secondDetail
string
Second detail text.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"acCode",
"entryDate",
"procDate",
"reference",
"total",
"timestamp",
"routeToken"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Parent accrual id.",
"exclusiveMinimum": 0
},
"total": {
"type": "number",
"description": "Accrual total amount."
},
"acCode": {
"type": "string",
"minLength": 1,
"description": "Nominal account code, for example 4000."
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Processing date, for example 2024-03-15T00:00:00."
},
"entryDate": {
"type": "string",
"minLength": 1,
"description": "Entry date, for example 2024-03-01T00:00:00."
},
"reference": {
"type": "string",
"minLength": 1,
"description": "Accrual reference, for example ACC0001."
},
"timestamp": {
"type": "string",
"minLength": 1,
"description": "Base64 timestamp returned by the accrual, for example K94UQIbL3gg=."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"firstDetail": {
"type": "string",
"default": "",
"description": "First detail text."
},
"confirmWrite": {
"type": "boolean",
"description": "Must be true only after the user explicitly confirms updating this accrual."
},
"secondDetail": {
"type": "string",
"default": "",
"description": "Second detail text."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
allocationResolvers*
array
Allocations to create or update.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"bookTranId",
"allocationResolvers",
"routeToken"
],
"properties": {
"bookTranId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Book transaction id to allocate from, for example 1001.",
"exclusiveMinimum": 0
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "Must be true only after the user explicitly confirms posting the allocation update."
},
"connectionRef": {
"type": "string",
"description": "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."
},
"allocationResolvers": {
"type": "array",
"items": {
"type": "object",
"required": [
"allocated",
"bookTranIdReceiver"
],
"properties": {
"id": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0,
"description": "Existing allocation id, or 0 for a new allocation."
},
"discount": {
"type": "number",
"default": 0,
"minimum": 0,
"description": "Discount amount to apply to this allocation."
},
"allocated": {
"type": "number",
"minimum": 0,
"description": "Amount to allocate to the receiver transaction."
},
"bookTranIdReceiver": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Receiver book transaction id, for example the invoice being allocated against.",
"exclusiveMinimum": 0
}
}
},
"minItems": 1,
"description": "Allocations to create or update."
}
}
}
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Bank account id."
},
"payload": {
"type": "object",
"description": "Alias for updates.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"updates": {
"type": "object",
"description": "Fields to merge into the existing record.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
}
}
}
confirmWrite
boolean
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
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Cash payment id."
},
"payload": {
"type": "object",
"description": "Alias for updates.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"updates": {
"type": "object",
"description": "Fields to merge into the existing record.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
}
}
}
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Cash receipt id."
},
"payload": {
"type": "object",
"description": "Alias for updates.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"updates": {
"type": "object",
"description": "Fields to merge into the existing record.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
}
}
}
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Customer id."
},
"payload": {
"type": "object",
"description": "Alias for updates.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"updates": {
"type": "object",
"description": "Fields to merge into the existing record.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
}
}
}
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
Must be true only after the user explicitly confirms updating this Nominal Journal Batch.
connectionRef
string
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
integer
Book transaction type id. Nominal Journal Batch is usually 7.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"entryDate",
"procDate",
"total",
"timestamp",
"accountTransactions",
"routeToken"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Nominal Journal Batch id.",
"exclusiveMinimum": 0
},
"total": {
"type": "number",
"minimum": 0
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Date/time string, for example 2024-01-15T00:00:00."
},
"entryDate": {
"type": "string",
"minLength": 1,
"description": "Date/time string, for example 2024-01-15T00:00:00."
},
"timestamp": {
"type": "string",
"minLength": 1,
"description": "Base64 timestamp for the nominal journal batch."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "Must be true only after the user explicitly confirms updating this Nominal Journal Batch."
},
"connectionRef": {
"type": "string",
"description": "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": {
"type": "integer",
"default": 7,
"maximum": 9007199254740991,
"description": "Book transaction type id. Nominal Journal Batch is usually 7.",
"exclusiveMinimum": 0
},
"accountTransactions": {
"type": "array",
"items": {
"type": "object",
"required": [
"acCode",
"description",
"procDate",
"reference",
"debit",
"credit",
"id",
"timeStamp"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Existing account transaction line id.",
"exclusiveMinimum": 0
},
"debit": {
"type": "number",
"minimum": 0,
"description": "Debit amount for this line."
},
"acCode": {
"type": "string",
"minLength": 1,
"description": "Nominal account code, for example 400 or 800."
},
"credit": {
"type": "number",
"minimum": 0,
"description": "Credit amount for this line."
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Processing date for this transaction line."
},
"reference": {
"type": "string",
"minLength": 1,
"description": "Journal reference, for example NJ0001."
},
"timeStamp": {
"type": "string",
"minLength": 1,
"description": "Base64 timestamp for this account transaction line."
},
"description": {
"type": "string",
"minLength": 1,
"description": "Line description, for example Sales or Expenses."
},
"firstDetail": {
"type": "string",
"default": "",
"description": "First detail text for this line."
},
"secondDetail": {
"type": "string",
"default": "",
"description": "Second detail text for this line."
}
}
},
"minItems": 2,
"description": "Updated nominal journal account transaction lines."
}
}
}
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Payment id."
},
"payload": {
"type": "object",
"description": "Alias for updates.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"updates": {
"type": "object",
"description": "Fields to merge into the existing record.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
}
}
}
string
Base64 timestamp returned by the prepayment, for example bgUcQIbL3gg=.
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
firstDetail
string
First detail text.
confirmWrite
boolean
Must be true only after the user explicitly confirms updating this prepayment.
secondDetail
string
Second detail text.
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"acCode",
"entryDate",
"procDate",
"reference",
"total",
"timestamp",
"routeToken"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Parent prepayment id.",
"exclusiveMinimum": 0
},
"total": {
"type": "number",
"description": "Prepayment total amount."
},
"acCode": {
"type": "string",
"minLength": 1,
"description": "Nominal account code, for example 4000."
},
"procDate": {
"type": "string",
"minLength": 1,
"description": "Processing date, for example 2024-03-15T00:00:00."
},
"entryDate": {
"type": "string",
"minLength": 1,
"description": "Entry date, for example 2024-03-01T00:00:00."
},
"reference": {
"type": "string",
"minLength": 1,
"description": "Prepayment reference, for example PRE0001."
},
"timestamp": {
"type": "string",
"minLength": 1,
"description": "Base64 timestamp returned by the prepayment, for example bgUcQIbL3gg=."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"firstDetail": {
"type": "string",
"default": "",
"description": "First detail text."
},
"confirmWrite": {
"type": "boolean",
"description": "Must be true only after the user explicitly confirms updating this prepayment."
},
"secondDetail": {
"type": "string",
"default": "",
"description": "Second detail text."
},
"connectionRef": {
"type": "string",
"description": "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."
}
}
}
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Product id."
},
"payload": {
"type": "object",
"description": "Alias for updates.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"updates": {
"type": "object",
"description": "Fields to merge into the existing record.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
}
}
}
routeToken*
string
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
string
accountCode
string
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
description
string
confirmWrite
boolean
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
string
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
number
bookTranTypeId
integer
analysisCategoryId
integer
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Purchase id."
},
"note": {
"type": "string"
},
"acCode": {
"type": "string"
},
"procDate": {
"type": "string"
},
"entryDate": {
"type": "string"
},
"netAmount": {
"type": "number"
},
"vatRateId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"supplierId": {
"type": "string"
},
"accountCode": {
"type": "string"
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"description": {
"type": "string"
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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": {
"type": "number"
},
"bookTranTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"analysisCategoryId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
}
}
}
confirmWrite
boolean
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
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Quote id."
},
"reference": {
"type": "string",
"maxLength": 6,
"description": "Optional manual quote reference, max 6 characters. Required when quote references are manual, or when the quote reference setting is unknown. Quote reference must be 6 characters or fewer because Big Red Cloud truncates longer references."
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
}
}
}
reference
string
saleRepId
integer
vatTypeId
integer
customerId
integer
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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
string
productTrans
array
Complete BRC productTrans collection. Preserve existing line ids and accounting/VAT data when modifying an existing credit note.
connectionRef
string
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
string
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Sales credit note id."
},
"note": {
"type": "string"
},
"total": {
"type": "number"
},
"details": {
"type": "string"
},
"procDate": {
"type": "string",
"description": "Processing date. Historical dates may be attempted; BRC determines whether the update is permitted."
},
"totalNet": {
"type": "number"
},
"totalVAT": {
"type": "number"
},
"entryDate": {
"type": "string",
"description": "Entry date. Historical dates may be attempted; BRC determines whether the update is permitted."
},
"reference": {
"type": "string"
},
"saleRepId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"vatTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string"
},
"productTrans": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"description": "Complete BRC productTrans collection. Preserve existing line ids and accounting/VAT data when modifying an existing credit note."
},
"connectionRef": {
"type": "string",
"description": "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": {
"type": "string"
}
}
}
totalNet
number
New total net value. For monetary edits this must be supplied together with totalVAT, total, acEntries and vatEntries.
totalVAT
number
New total VAT value. For monetary edits this must be supplied together with totalNet, total, acEntries and vatEntries.
acEntries
array
Complete BRC accounting-entry collection. For monetary edits, the sum of each entry's value must equal totalNet.
entryDate
string
Entry date in ISO format. Historical dates may be attempted; BRC determines whether the change is permitted.
reference
string
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.
vatTypeId
integer
VAT type id.
customerId
integer
Customer id.
routeToken*
string
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
array
Complete BRC VAT-entry collection. Each entry should contain the BRC vatRateId, percentage and net amount used to calculate VAT.
companyName*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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
string
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
integer
Book transaction type id. Sales Entries normally use the existing record's transaction type.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Sales Entry id, normally the bookTranId returned by customer account transactions."
},
"note": {
"type": "string",
"description": "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": {
"type": "number",
"description": "New gross total. For monetary edits this must equal totalNet + totalVAT."
},
"acCode": {
"type": "string",
"description": "Customer account code."
},
"details": {
"type": "string",
"description": "Sales Entry details/description field."
},
"procDate": {
"type": "string",
"description": "Processing date in ISO format. Historical dates may be attempted; BRC determines whether the change is permitted."
},
"totalNet": {
"type": "number",
"description": "New total net value. For monetary edits this must be supplied together with totalVAT, total, acEntries and vatEntries."
},
"totalVAT": {
"type": "number",
"description": "New total VAT value. For monetary edits this must be supplied together with totalNet, total, acEntries and vatEntries."
},
"acEntries": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"description": "Complete BRC accounting-entry collection. For monetary edits, the sum of each entry's value must equal totalNet."
},
"entryDate": {
"type": "string",
"description": "Entry date in ISO format. Historical dates may be attempted; BRC determines whether the change is permitted."
},
"reference": {
"type": "string",
"description": "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."
},
"vatTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "VAT type id.",
"exclusiveMinimum": 0
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Customer id.",
"exclusiveMinimum": 0
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"vatEntries": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"description": "Complete BRC VAT-entry collection. Each entry should contain the BRC vatRateId, percentage and net amount used to calculate VAT."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Book transaction type id. Sales Entries normally use the existing record's transaction type.",
"exclusiveMinimum": 0
}
}
}
entryDate
string
Entry date. Historical dates are permitted as an attempted update; BRC may accept or reject them.
reference
string
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
integer
vatTypeId
integer
customerId
integer
routeToken*
string
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*
string
Company context name, for example YOUR-COMPANY-NAME.
confirmWrite
boolean
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
string
productTrans
array
Complete BRC productTrans collection. Use this when changing invoice lines, quantities, unit prices, VAT or line amounts.
connectionRef
string
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
string
bookTranTypeId
integer
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Sales invoice id."
},
"note": {
"type": "string",
"description": "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": {
"type": "number"
},
"details": {
"type": "string"
},
"procDate": {
"type": "string",
"description": "Processing date. Historical dates are permitted as an attempted update; BRC may accept or reject them."
},
"totalNet": {
"type": "number"
},
"totalVAT": {
"type": "number"
},
"entryDate": {
"type": "string",
"description": "Entry date. Historical dates are permitted as an attempted update; BRC may accept or reject them."
},
"reference": {
"type": "string",
"description": "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": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"vatTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string"
},
"productTrans": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"description": "Complete BRC productTrans collection. Use this when changing invoice lines, quantities, unit prices, VAT or line amounts."
},
"connectionRef": {
"type": "string",
"description": "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": {
"type": "string"
},
"bookTranTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
}
}
}
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Sales rep id."
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
}
}
}
connectionRef
string
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.
Input schema (JSON)
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"companyName",
"id",
"routeToken"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"description": "Supplier id."
},
"payload": {
"type": "object",
"description": "Alias for updates.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"updates": {
"type": "object",
"description": "Fields to merge into the existing record.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"routeToken": {
"type": "string",
"minLength": 1,
"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."
},
"companyName": {
"type": "string",
"minLength": 1,
"description": "Company context name, for example YOUR-COMPANY-NAME."
},
"confirmWrite": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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."
}
}
}