io.github.BigRedCloud由 GitHub 账号 BigRedCloud 发布v1.4.0更新于 Oct 24, 2026
Secure MCP access to Big Red Cloud accounting data, workflows, help and training.
让 AI 助手接入 Big Red Cloud 会计数据，可查询客户、发票、增值税与总账报表，并在确认后写入变更。
Web executable，通过 Streamable HTTP。 远程服务在工作区中配置后即可从网页运行时运行。
把这段提示词粘贴到 Claude Code、Codex、Cursor 等智能体，或 SourceWeft 对话中。智能体会读取该服务器的安装指南，先向你展示发布者、端点和登录方式，经你同意后再把它添加到你的客户端。密钥不会写进任何命令。
阅读 https://sourceweft.com/mcp/io.github.BigRedCloud%2Fred-mcp-server/install.md，并按其中说明把这个 MCP 服务器接入我的客户端。修改任何配置之前，先告诉我它的发布者、端点和登录方式，等我确认。不要把 API 密钥写进命令或我会提交的文件；问我密钥应从哪里获取。把它添加到你客户端的 mcpServers 配置中。
{
"mcpServers": {
"red-by-big-red-cloud": {
"type": "http",
"url": "https://red.bigredcloud.com/mcp"
}
}
}Red is an open-source Model Context Protocol (MCP) server that connects AI assistants and MCP clients to Big Red Cloud accounting data through a set of controlled MCP tools.
Supported customer platforms today are ChatGPT, Claude, Mistral (Vibe), and Microsoft 365 Copilot. Copilot uses a Microsoft federated connector at /mcp/copilot. Because of current Microsoft federated connector limitations, that connector is read-only for now. Create, update and delete tools on Copilot are expected to follow when Microsoft supports them. ChatGPT, Claude and Mistral use /mcp, which already includes those write tools where the deployment enables them. Other MCP clients may work technically, but they are not treated as officially supported platforms. Red uses platform detection only for anonymous operational telemetry (see Privacy-safe telemetry).
Instead of calling the Big Red Cloud REST API directly, users work in plain language. The server translates requests into structured API calls and applies safety checks around anything that changes data.
With Red, a connected user can:
We believe AI infrastructure should be transparent. Customers should be able to inspect the software that connects their accounting data to AI assistants.
Our competitive advantage is not the connector itself; it is our accounting platform, our expert bookkeeping advice, our customer experience, and the value we build on top of it.
By open-sourcing Red, we hope to encourage trust, community contributions, and wider adoption of open standards.
failedCompaniesconnectionRef / activeConnectionRef so MCP clients can silently reuse a confirmed connection across supported session changes; kept in tool JSON, not shown to end usersrouteToken from the router before create/update/delete/batch/email workflows proceedbrc_company_readiness_check) for connected companiespriceBasis handling, Sales VAT category validation, placeholder product ID blocking, and related preflight checksRed is designed so that AI-driven access to accounting data stays controlled and auditable.
https://red.bigredcloud.com/mcp, a connected company stays available for about the configured session duration and is held in session memory (or an optional shared connection store in hosted deployments). Where supported, that flow can reuse connectionRef / activeConnectionRef across MCP session changes. On https://red.bigredcloud.com/mcp/copilot, companies are linked to the verified Microsoft user who connected them. Those Microsoft-owned connections are separate from anonymous or session connections.failedCompanies at confirmation time.connectionRef, session IDs, and other MCP diagnostics are for tool arguments only. Assistants must not show redconn_… values or internal connection metadata to normal users unless the user explicitly asks for technical details.BRC_API_KEY_TTL_MINUTES. User-facing wording (connection page, getting-started text, connection status) is derived from that value — not hardcoded.routeToken issued by the request router for the matching workflow. A route token is not permission to post — preview and confirmation still apply.Sales invoice handling includes:
priceBasis of gross or net so VAT is never guessed.productId 0 and 1) are treated as placeholders and blocked before preview-before-posting and post.brc_create_sales_invoice_gen_ref) require each productTrans line to include its own acEntries analysis allocation. Line net/VAT/gross reconciliation, analysis allocation totals, header totals, and required product/VAT/analysis fields are validated before posting; failures return structured field-level errors.note defaults to the customer name unless a note is explicitly provided, and is never set to a product name.deliveryTo is included only when a delivery address is explicitly provided.Red has two hosted MCP interfaces, each with its own tool registry.
Local stdio (src/index.ts, node build/index.js) uses the same full registry as /mcp. Hosted HTTP is src/remote.ts. /mcp registers that full registry and keeps request routing, routeToken checks, and preview-before-posting confirmation on protected writes. /mcp/copilot registers only its own read-only facade. It does not register accounting create, update or delete tools.
Key shared modules:
src/server.ts — MCP server factory and stdio singletonsrc/register_all_tools.ts — central tool registration; skips tools whose skill group is disabled, and wraps write tools with routing and preview-before-posting/confirmation handlingsrc/config/server_config.ts — deployment skill gating driven by the BRC_ALLOW_* flagssrc/config/mcp_config.ts — MCP server instructions, connection-safety rules, help-answer rules, and connectionRef presentation rulessrc/routing/ — request classification and short-lived routeToken issuance/validation for transactional toolssrc/shared.ts — Big Red Cloud HTTP client, connection handling, audit log, and helperssrc/read_connection_metadata.ts — connection status metadata echoed on tool responses (including activeConnectionRef for hosted clients)src/auth/connection_presentation.ts — user-facing TTL wording and assistant presentation hintssrc/auth/credential_validation.ts — BRC read validation before storing company connection credentialssrc/guards/ — transaction, reference, VAT category, product line, and write-confirmation safety checkssrc/auth/ — secure connection flow, connection store (memory or Cosmos), connection page, and credential persistencesrc/telemetry/ — anonymous client/session identity and platform detection for hosted operational telemetrysrc/brc-edu/ — Freshdesk articles, customer documentation, webinar indexes, screenshots, and unified help searchsrc/edu/ — shared help-resource loading, enrichment, workbook parsing, and storage configurationsrc/tools/edu/ — read-only help toolssrc/tools/routing/ — request-routing tool registrationDomain logic lives under src/tools/, with generic create/update/delete/list/batch helpers in src/tools/general/.
@modelcontextprotocol/sdkengines in package.json; the hosted Linux app uses Node 24).If a .env.example file is provided, copy it to .env and adjust the values:
Never commit your .env file or any real credentials.
Hosted HTTP server:
Local stdio server:
Opening the HTTP endpoint in a browser without an MCP session returns an error — that is expected.
A hosted deployment can expose /mcp/copilot for Microsoft 365 Copilot as a federated connector. That path uses Microsoft Entra sign-in. Company API keys are still entered on the Red connection page and stored for the signed-in Microsoft user. Setup is in docs/copilot-entra-sso.md.
The production Copilot address is https://red.bigredcloud.com/mcp/copilot.
The Copilot connector is read-only. It can search and retrieve supported Big Red Cloud data, but it does not create, update or delete records. That limit comes from the current Microsoft federated connector, not from the absence of write tools in Red. Create, update and delete on Copilot are expected to follow when Microsoft supports them. Until then, those actions stay on /mcp for ChatGPT, Claude and Mistral.
Local stdio (the client spawns the process):
Hosted HTTP (production):
For the hosted Big Red Cloud Red service, customers should use:
https://red.bigredcloud.com/mcp
Hosted HTTP (local development):
Tests cover the safety guards described above, including sales invoice checks, transaction date validation, the secure connection flow (CSV validation, partial confirm, credential invalidation), connectionRef presentation rules, request routing, TTL wording, and response wording.
Customers of the hosted Red service do not configure its environment. ChatGPT, Claude and Mistral use https://red.bigredcloud.com/mcp. Microsoft 365 Copilot uses https://red.bigredcloud.com/mcp/copilot.
Operators who self-host Red set environment variables for that process. The canonical list, including which settings are optional, platform-managed, or secret, is docs/environment-variables.md. .env.example is a placeholder template only. Never commit real secrets.
On /mcp, deployment skill flags (BRC_ALLOW_*) choose which tool groups are registered. The Copilot facade keeps its own read-only catalogue and does not follow those write flags. brc_get_deployment_policy summarises customer-facing availability for the normal registry.
Customers should connect companies through the secure Red connection page. Company connection credentials must not be sent through chat — they are entered only on the secure Red connection page, not in the chat window.
Customers can get or regenerate their company API keys in Big Red Cloud under Administration → API Keys.
The flow is:
failedCompanies immediately — you do not need to run a lookup first to discover a bad key.Connection links are one-time use. Connected companies stay available for about the configured session duration (BRC_API_KEY_TTL_MINUTES, for example 240 minutes → about four hours), unless you disconnect or the connection expires.
connectionRefIn hosted HTTP mode (for example Mistral/Vibe), brc_confirm_company_connection returns an opaque connectionRef in the tool JSON. MCP clients should preserve and silently reuse connectionRef / activeConnectionRef on later tool calls when the platform rotates session IDs. Connection persistence survives MCP session rotation where supported. This is an implementation detail for the client — assistants should not show connectionRef or redconn_… values to end users. Tool responses include assistantInstruction / presentationHint fields to reinforce that rule.
Helper tools:
On hosted deployments, Red may record anonymous operational telemetry so operators can understand approximate usage. Typical dimensions include anonymous client and connection-session identifiers, detected platform, deployment environment, tool name, and connected-company count.
Telemetry does not include API keys, credentials, raw connectionRef values, authorisation headers, request bodies, or invoice/customer/supplier payloads. Failed Big Red Cloud calls may include safe identifiers such as company_id or record_id. Anonymous telemetry is not a verified Big Red Cloud user identity. Microsoft 365 Copilot uses verified Microsoft sign-in to decide which companies that user may access. That sign-in is separate from the anonymous telemetry described here.
Details for operators and developers: docs/TELEMETRY.md.
Red exposes a focused set of MCP tools, grouped by domain. Exact tool names and their endpoint mappings live in the source code under src/tools/ and are summarised for developers in docs/TOOLS.md.
Batch variants exist for the main create workflows and apply the same safety checks as the single-record tools.
brc_company_readiness_check is a read-only overall health check for a connected company. Overall statuses are:
readyready_with_warningsnot_readyconnection_problemIt reviews connection status plus relevant setup such as financial year, transaction date position, active Sales VAT rates, Sales Analysis categories, products, and sales representatives. Missing suppliers is reported as a purchase-setup warning and does not block sales-invoice readiness. Manual reference settings are treated as a warning / preflight consideration, not necessarily a blocker.
For a specific VAT-sensitive workflow (sales invoice, purchase, cash receipt, statement), use brc_check_transaction_settings instead — that tool checks one workflow’s processing settings, while readiness scores overall company readiness. Narrower helpers such as brc_validate_transaction_date, brc_get_company_processing_settings, and brc_get_company_reference_settings remain available for focused lookups.
brc_list_audit_log shows Red write activity from the current session for currently connected companies. Read-only lookups are not treated as completed changes.
brc_generate_support_report creates a downloadable plain-text diagnostic for one connected company at a time. If several companies were used, generate a separate report for each. Reports include success/failure and correlation information useful to support. They exclude credentials, API keys, tokens and connection references. Generating a report is read-only and does not write to Big Red Cloud.
Developer details: docs/TOOLS.md and docs/TELEMETRY.md.
A transaction date outside the current financial year is a warning, not an automatic statement that the operation is impossible. After normal preview and confirmation, Red attempts only the supported action. If Big Red Cloud rejects the action or date, Red reports the actual response. Not every historical transaction can be changed.
brc_generate_sales_invoice_from_quote).brc_resolve_book_transaction_type) before a document-specific lookup or change.Red includes read-only MCP tools for Big Red Cloud help and training questions. They do not require a connected company.
Typical capabilities:
red-help / /red-help style commands) through the help pipeline.Help answers may include:
Help-resource indexes are supplied by the deployment operator. The repository includes the operator upload, catalogue and sync implementation used to maintain those indexes. Customers do not configure that workflow.
unknown when a client does not provide enough identifying information.This project is maintained by the Big Red Cloud software development team.
Red is in BETA. Red is an open-source MCP integration for Big Red Cloud and is under active development. Tool availability and behaviour may change between releases, and some capabilities are gated by deployment policy.
This project is licensed under the Apache License 2.0. See LICENSE for details.
If you believe you have found a security issue, please report it to Big Red Cloud's support team.
来源：README.md，提交 614e3f7
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.
connectionRefConfirm 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.
code必填connectionRefGet Company API Key Status
Returns company connection-status metadata without returning API keys or other credentials.
companyNameconnectionRefList Company Contexts
Returns connected-company contexts and connection-expiry metadata, including duration, remaining time and timezone details. Connection credentials are not returned.
connectionRefClear Company API Key
Clears the API key for a named company context from MCP server memory.
companyName必填connectionRefClear All Company API Keys
Clears all connection credentials for all company contexts from MCP server memory.
connectionRefList Accounts
Lists BRC accounts.
toppageskipfilterorderBypageSizecompanyName必填connectionRefList Customers
Lists BRC customers. customerCode uses exact case-sensitive bounded local lookup (10,000 records); BRC forbids customer OData filters.
toppageskipfilterorderBypageSizecompanyName必填customerCodeconnectionRefGet Customer
Gets one BRC customer by id.
id必填companyName必填connectionRefList Active Customers
Lists BRC customers without dormant records.
toppageskipfilterorderBypageSizecompanyName必填connectionRefList Suppliers
Lists BRC suppliers.
toppageskipfilterorderBypageSizecompanyName必填connectionRefGet Supplier
Gets one BRC supplier by id.
id必填companyName必填connectionRefList Products
Lists BRC products.
toppageskipfilterorderBypageSizecompanyName必填connectionRefList Product Types
Lists BRC product types.
toppageskipfilterorderBypageSizecompanyName必填connectionRefList Active Products
Lists BRC products without dormant records.
toppageskipfilterorderBypageSizecompanyName必填connectionRefList Sales Entries
Lists BRC sales entries.
toppageskipfilterorderBypageSizecompanyName必填connectionRefGet Sales Entry
Gets one BRC sales entry by id.
id必填companyName必填connectionRefList Sales Invoices
Lists BRC sales invoices.
toppageskipfilterorderBypageSizecompanyName必填connectionRefGet Sales Invoice
Gets one BRC sales invoice by id.
id必填companyName必填connectionRefList Purchases
Lists BRC purchases.
toppageskipfilterorderBypageSizecompanyName必填connectionRefGet Purchase
Gets one BRC purchase by id.
id必填companyName必填connectionRefList Analysis Categories
Returns company analysis categories and their book context. Customer-control categories are distinct from Sales analysis categories.
toppageskipfilterorderBypageSizecompanyName必填connectionRefList VAT Rates
Returns company VAT rates and their associated category identifiers.
toppageskipfilterorderBypageSizecompanyName必填connectionRefList VAT Analysis Types
Lists BRC VAT analysis types.
toppageskipfilterorderBypageSizecompanyName必填connectionRefList VAT Categories
Returns company VAT categories and their Sales or Purchase context.
toppageskipfilterorderBypageSizecompanyName必填connectionRefList VAT Types
Lists BRC VAT types.
toppageskipfilterorderBypageSizecompanyName必填connectionRefList Company Settings
Lists BRC company settings.
toppageskipfilterorderBypageSizecompanyName必填connectionRefList Category Types
Lists BRC category types.
toppageskipfilterorderBypageSizecompanyName必填connectionRefList Owner Type Groups
Lists BRC owner type groups.
toppageskipfilterorderBypageSizecompanyName必填connectionRefList Owner Types
Lists BRC owner types.
toppageskipfilterorderBypageSizecompanyName必填connectionRefList User-Defined Fields
Lists BRC user defined fields.
toppageskipfilterorderBypageSizecompanyName必填connectionRefList Book Transaction Types
Lists BRC book transaction types.
toppageskipfilterorderBypageSizecompanyName必填connectionRefList Nominal Accounts
Returns nominal accounts and period movements. Monthly values represent movements rather than monthly balances.
toppageskipfilterorderBypageSizecompanyName必填connectionRefGet Nominal Account Ledger by ID
Returns one nominal account ledger and its period movements. Monthly values represent movements rather than monthly balances.
id必填companyName必填connectionRefList 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.
toppageskipfilterorderBypageSizecompanyName必填connectionRefGet 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.
id必填companyName必填connectionRefList Sales Credit Notes
Lists BRC sales credit notes.
toppageskipfilterorderBypageSizecompanyName必填connectionRefGet Sales Credit Note
Gets one BRC sales credit note by id.
id必填companyName必填connectionRefList Sales Representatives
Lists BRC sales reps.
toppageskipfilterorderBypageSizecompanyName必填connectionRefGet Sales Representative
Gets one BRC sales rep by id.
id必填companyName必填connectionRefGet Company Setup Configuration
Gets full BRC company setup configuration, including general details, financial year, reference settings, and processing options.
companyName必填connectionRefGet Company Logo
Gets the company logo from BRC.
companyName必填connectionRefGet Financial Year
Gets BRC company financial year.
companyName必填connectionRefCreate 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.
payload必填routeToken必填companyName必填confirmWriteconnectionRefdetailedResponseUpdate 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.
id必填payloadupdatesrouteToken必填companyName必填confirmWriteconnectionRefDelete 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.
id必填routeToken必填companyName必填confirmWriteconfirmDeleteconnectionRefGet Customer Opening Balance
Gets a customer's opening balance.
itemId必填companyName必填connectionRefList Customer Opening Balance Transactions
Gets a customer's opening balance transaction list.
itemId必填companyName必填connectionRefList Customer Account Transactions
Returns customer account transactions. Transaction IDs and types are endpoint- and company-specific.
itemId必填companyName必填connectionRefList Customer Quotes
Gets quotes for a specific customer.
itemId必填companyName必填connectionRefCreate 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.
payload必填routeToken必填companyName必填confirmWriteconnectionRefUpdate 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.
id必填payloadupdatesrouteToken必填companyName必填confirmWriteconnectionRefDelete 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.
id必填routeToken必填companyName必填confirmWriteconfirmDeleteconnectionRefGet Supplier Opening Balance
Gets a supplier's opening balance.
itemId必填companyName必填connectionRefList Supplier Opening Balance Transactions
Gets a supplier's opening balance transaction list.
itemId必填companyName必填connectionRefList Supplier Account Transactions
Returns supplier account transactions. Transaction IDs and types are endpoint- and company-specific.
itemId必填companyName必填connectionRefCreate 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.
note必填acCode必填procDate必填entryDate必填netAmount必填referencevatRateId必填routeToken必填supplierId必填accountCode必填companyName必填description必填另有 6 个Create Purchase with Generated Reference
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.
note必填acCode必填procDate必填entryDate必填netAmount必填vatRateId必填routeToken必填supplierId必填accountCode必填companyName必填description必填confirmWrite另有 5 个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.
id必填noteacCodeprocDateentryDatenetAmountvatRateIdrouteToken必填supplierIdaccountCodecompanyName必填description另有 5 个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.
id必填routeToken必填companyName必填confirmWriteconfirmDeleteconnectionRefCreate 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.
note必填totalacCode必填procDate必填totalNettotalVATvatLinesentryDate必填netAmount必填vatRateIdcustomerId必填routeToken必填另有 10 个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.
id必填notetotalacCodedetailsprocDatetotalNettotalVATacEntriesentryDatereferencevatTypeId另有 7 个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.
id必填routeToken必填companyName必填confirmWriteconfirmDeleteconnectionRefCreate 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.
noteacCode必填procDate必填quantity必填entryDate必填netAmount必填productId必填referencesaleRepId必填unitPrice必填vatRateId必填customerId必填另有 16 个Create Sales Invoice with Generated Reference
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.
payload必填priceBasisrouteToken必填companyName必填confirmWriteconnectionRefconfirmCrAnalysisCategoryconfirmCounterpartyExplicitUpdate 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.
id必填notetotaldetailsprocDatetotalNettotalVATentryDatereferencesaleRepIdvatTypeIdcustomerId另有 8 个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.
id必填routeToken必填companyName必填confirmWriteconfirmDeleteconnectionRefCreate 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.
acCode必填comments必填ddNumberpoNumberprocDate必填quantity必填tranNote必填companyId必填entryDate必填productId必填referencesaleRepId必填另有 18 个Create Quote with Generated Reference
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.
acCode必填comments必填ddNumberpoNumberprocDate必填quantity必填tranNote必填companyId必填entryDate必填productId必填referencesaleRepId必填另有 18 个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.
id必填referencerouteToken必填companyName必填confirmWriteconnectionRefClose 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.
id必填routeToken必填companyName必填confirmWriteconnectionRefReopen 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.
id必填routeToken必填companyName必填confirmWriteconnectionRefDelete 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.
id必填routeToken必填companyName必填confirmWriteconfirmDeleteconnectionRefGenerate 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.
quoteId必填procDateentryDaterouteToken必填companyName必填confirmWriteconnectionRefCreate 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.
note必填acCode必填procDate必填quantity必填entryDate必填netAmount必填productId必填referencesaleRepId必填unitPrice必填vatRateId必填customerId必填另有 13 个Create Sales Credit Note with Generated Reference
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.
payload必填routeToken必填companyName必填confirmWriteconnectionRefconfirmCrAnalysisCategoryconfirmCounterpartyExplicitUpdate 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.
id必填notetotaldetailsprocDatetotalNettotalVATentryDatereferencesaleRepIdvatTypeIdcustomerId另有 7 个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.
id必填routeToken必填companyName必填confirmWriteconfirmDeleteconnectionRefCreate Sales Representative
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.
code必填name必填routeToken必填companyName必填confirmWriteconnectionRefUpdate Sales Representative
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.
id必填codenamerouteToken必填companyName必填confirmWriteconnectionRefDelete Sales Representative
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.
id必填routeToken必填companyName必填confirmWriteconfirmDeleteconnectionRefGet Nominal Account Ledgers by IDs
Returns nominal-account ledgers for supplied account IDs. Monthly values represent movements rather than monthly balances.
ids必填companyName必填connectionRefGrouped Nominal Accounts Report
Returns a grouped nominal-account report with period movements rather than monthly balances.
companyName必填connectionRefMulti-Company Nominal Account Report
Returns a multi-company nominal-account report with period movements rather than monthly balances.
companyNames必填connectionRefList Cash Payments
Lists BRC cash payments.
toppageskipfilterorderBypageSizecompanyName必填connectionRefGet Cash Payment
Gets one BRC cash payment by id.
id必填companyName必填connectionRefCreate 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.
note必填total必填acCodeledgerdiscountprocDateentryDatelodgementrouteToken必填supplierIdaccountCodecompanyName必填另有 8 个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.
id必填payloadupdatesrouteToken必填companyName必填confirmWriteconnectionRefDelete 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.
id必填routeToken必填companyName必填confirmWriteconfirmDeleteconnectionRefBatch 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.
items必填routeToken必填companyName必填confirmWriteconnectionRefconfirmCounterpartyExplicitList 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.
toppageskipfilterorderBypageSizecustomerIdprocDateTocompanyName必填customerCodeprocDateFromconnectionRefGet Cash Receipt
Gets one BRC cash receipt by id.
id必填companyName必填connectionRefCreate 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.
notetotalacCodeledgerdetailspayloaddiscountprocDatetotalNettotalVATtotalVatacEntries另有 20 个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.
id必填payloadupdatesrouteToken必填companyName必填confirmWriteconnectionRefDelete 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.
id必填routeToken必填companyName必填confirmWriteconfirmDeleteconnectionRefBatch 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.
items必填routeToken必填companyName必填confirmWriteconnectionRefconfirmCounterpartyExplicitList Payments
Lists BRC payments.
toppageskipfilterorderBypageSizecompanyName必填connectionRefGet Payment
Gets one BRC payment by id.
id必填companyName必填connectionRefCreate 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.
note必填total必填acCodediscountprocDateentryDatereferencerouteToken必填supplierIdaccountCodecompanyName必填description另有 7 个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.
id必填payloadupdatesrouteToken必填companyName必填confirmWriteconnectionRefDelete 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.
id必填routeToken必填companyName必填confirmWriteconfirmDeleteconnectionRefBatch 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.
items必填routeToken必填companyName必填confirmWriteconnectionRefconfirmCounterpartyExplicitList Bank Accounts
Lists BRC bank accounts.
toppageskipfilterorderBypageSizecompanyName必填connectionRefGet Bank Account
Gets one BRC bank account by id.
id必填companyName必填connectionRefCreate 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.
acCodeaddressbalancedetailslastChqpayloadsortCodecategoryIdrouteToken必填accountNamecompanyName必填accountNumber另有 8 个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.
id必填payloadupdatesrouteToken必填companyName必填confirmWriteconnectionRefDelete 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.
id必填routeToken必填companyName必填confirmWriteconfirmDeleteconnectionRefGet Product
Gets one BRC product by id.
id必填companyName必填connectionRefCreate 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.
payload必填routeToken必填companyName必填confirmWriteconnectionRefUpdate 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.
id必填payloadupdatesrouteToken必填companyName必填confirmWriteconnectionRefDelete 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.
id必填routeToken必填companyName必填confirmWriteconfirmDeleteconnectionRefBatch 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.
items必填priceBasisrouteToken必填companyName必填confirmWriteconnectionRefconfirmCrAnalysisCategoryconfirmCounterpartyExplicitBatch 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.
items必填routeToken必填companyName必填confirmWriteconnectionRefconfirmCrAnalysisCategoryconfirmCounterpartyExplicitBatch 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.
items必填priceBasisrouteToken必填companyName必填confirmWriteconnectionRefconfirmCrAnalysisCategoryconfirmCounterpartyExplicitBatch 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.
items必填batchSizerouteToken必填companyName必填confirmWriteconnectionRefdetailedResponseconfirmCrAnalysisCategoryconfirmCounterpartyExplicitBatch 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.
items必填priceBasisrouteToken必填companyName必填confirmWriteconnectionRefconfirmCrAnalysisCategoryconfirmCounterpartyExplicitBatch Sales Representatives
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.
items必填routeToken必填companyName必填confirmWriteconnectionRefBatch 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.
items必填routeToken必填companyName必填confirmWriteconnectionRefBatch 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.
items必填routeToken必填companyName必填confirmWriteconnectionRefdetailedResponseBatch 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.
items必填routeToken必填companyName必填confirmWriteconnectionRefList Sales
Lists combined BRC sales entries, sales invoices and sales credit notes.
toppageskipfilterorderBypageSizecompanyName必填connectionRefProcess 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.
payloadrouteToken必填companyName必填confirmWriteconnectionRefeffectiveDateconfirmProcessvatCategoryRatesGet Deployment Policy
Returns the deployment capability and permission summary, including enabled action groups and development-mode status.
无需输入参数。
Validate Transaction Date
Checks whether a proposed transaction date is inside the connected BRC company's current financial year.
companyName必填connectionReftransactionDate必填Check Company Readiness
Returns overall company readiness across connection, financial year, reference data, VAT, analysis categories and settings.
companyName必填connectionRefResolve Book Transaction Type
Resolves a company-specific bookTranTypeId against live transaction-type reference data. Descriptions and numeric IDs are not globally stable.
companyName必填connectionRefbookTranTypeId必填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.
message必填companyNameconnectionRefGet 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.
query必填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.
sourcecategoryquestion必填maxResultsGet 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.
questionmaxImagesresourceId必填includeImagesimagePresentationOpen Education Administration
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.
无需输入参数。
List Audit Log
Returns current-session audit entries scoped to currently connected companies. Entries from other sessions, connections or companies are excluded.
connectionRefincludeTechnicalDetailsGenerate Support Report
Returns a downloadable support diagnostic and a concise summary for the current session.
companyName必填connectionRefClear 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.
confirmClearconfirmWriteconnectionRefSend 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.
sendModetoAddressrouteToken必填companyName必填confirmSendfromAddressmessageBodytoAddressesbccAddressesconnectionRefsalesInvoiceId必填Send Account Statement Email
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.
sendModetoPeriodtoAddresscustomerId必填fromPeriodminBalancerouteToken必填companyName必填confirmSendfromAddressmessageBodytoAddresses另有 2 个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.
quoteId必填sendModetoAddressrouteToken必填companyName必填confirmSendfromAddressmessageBodytoAddressesbccAddressesconnectionRefGet Company Processing Settings
Returns company processing settings that affect VAT-sensitive accounting workflows.
includeRawcompanyName必填connectionRefGet Company Reference Settings
Returns quote and transaction reference settings. An Unknown quote-reference setting does not establish automatic reference generation.
includeRawcompanyName必填connectionRefCheck Transaction Settings
Returns processing-setting warnings for one specified transaction workflow. It does not provide an overall company-readiness score.
workflow必填companyName必填connectionRefList Allocation Resolvers
Returns receiver transactions eligible for allocation updates.
bookTranId必填companyName必填connectionRefUpdate 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.
bookTranId必填routeToken必填companyName必填confirmWriteconnectionRefallocationResolvers必填List Allocated Transactions
Returns existing transaction allocations and their identifiers.
bookTranId必填companyName必填connectionRefDelete 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.
id必填routeToken必填companyName必填confirmWriteconnectionRefList Nominal Journal Batches
Returns nominal journal batches with identifiers and concurrency timestamps.
topskipfilterorderBycompanyName必填connectionRefGet Nominal Journal Batch
Returns information about a single Nominal Journal Batch by id.
id必填companyName必填connectionRefCreate 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.
total必填procDate必填entryDate必填routeToken必填companyName必填confirmWriteconnectionRefbookTranTypeIdaccountTransactions必填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.
id必填total必填procDate必填entryDate必填timestamp必填routeToken必填companyName必填confirmWriteconnectionRefbookTranTypeIdaccountTransactions必填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.
id必填timestamp必填routeToken必填companyName必填confirmWriteconnectionRefList Accruals
Returns a list of the company's Accruals. Supports optional OData filtering by entryDate. Supports optional ordering by id.
topskipfilterorderBycompanyName必填connectionRefGet Accrual
Returns information about a single parent Accrual by id. Child accruals are not exposed by the public API.
id必填companyName必填connectionRefCreate 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.
total必填acCode必填procDate必填entryDate必填reference必填routeToken必填companyName必填firstDetailconfirmWritesecondDetailconnectionRefUpdate 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.
id必填total必填acCode必填procDate必填entryDate必填reference必填timestamp必填routeToken必填companyName必填firstDetailconfirmWritesecondDetail另有 1 个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.
id必填timestamp必填routeToken必填companyName必填confirmWriteconnectionRefList Prepayments
Returns a list of the company's Prepayments. Supports optional OData filtering by entryDate. Supports optional ordering by id.
topskipfilterorderBycompanyName必填connectionRefGet Prepayment
Returns information about a single parent Prepayment by id. Child prepayments are not exposed by the public API.
id必填companyName必填connectionRefCreate 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.
total必填acCode必填procDate必填entryDate必填reference必填routeToken必填companyName必填firstDetailconfirmWritesecondDetailconnectionRefUpdate 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.
id必填total必填acCode必填procDate必填entryDate必填reference必填timestamp必填routeToken必填companyName必填firstDetailconfirmWritesecondDetail另有 1 个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.
id必填timestamp必填routeToken必填companyName必填confirmWriteconnectionRef已满足适用检查项的 100%
该评分衡量此收录条目的完整程度，依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价，也不表示服务器安全或当前可用：可连通性是带日期的检查结果，评分也不包含安装量或用户评价。
npm installnpm run buildcp .env.example .envnpm run start# Serves the MCP endpoint at http://localhost:3000/mcpnpm run start:local{ "mcpServers": { "red-mcp-server": { "command": "node", "args": ["build/index.js"], "env": { "BRC_API_BASE_URL": "https://app.bigredcloud.com/api" } } }}{ "mcpServers": { "red-mcp-server": { "url": "https://red.bigredcloud.com/mcp" } }}{ "mcpServers": { "red-mcp-server": { "url": "http://localhost:3000/mcp" } }}