Big Red Cloud API
35
AI ReadinessNon-Ready (F)35/100
Official vendor OpenAPI document · agent-readyFinanceAccountingapiKey120 EndpointsREST
For Agents
Read and write the full Big Red Cloud accounting ledger - customers, suppliers, sales and purchase invoices, payments, receipts, and nominal accounts - and email invoices and statements directly to customers.
Use for: I need to create a new customer in Big Red Cloud, Post a sales invoice for customer 4012 totalling 850 EUR, Email the latest statement to a customer, Record a cash receipt against the main bank account
Not supported: Does not handle payroll, time tracking, or card payment processing - use for Big Red Cloud accounting ledger and invoicing operations only.
Big Red Cloud is an Irish small-business accounting platform, and its REST API exposes the full ledger model - customers, suppliers, sales and purchase invoices, cash payments and receipts, bank accounts, and nominal accounts - across 120 endpoints under /v1. The API supports list, single-item, and batch operations for most resources, plus dedicated endpoints for sending sales invoices, statements, and quotes by email. Authentication is by API key generated from the user's Big Red Cloud account, scoping access to that company's books. Suitable for syncing accounting data with e-commerce platforms, payment processors, or custom reporting tools.
Install Jentic One Beta
Connect the Big Red Cloud API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Big Red Cloud API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fbigredcloud.com%2Fbigredcloud" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fbigredcloud.com%2Fbigredcloud" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Big Red Cloud API.
Create, update, and delete customers and suppliers individually or in batches
Post sales invoices, purchase invoices, and credit notes to the ledger
Record cash payments and cash receipts against bank accounts and nominal accounts
Email a sales invoice, quote, or customer statement using /v1/email endpoints
Retrieve customer account transactions, opening balances, and outstanding quotes
Read nominal account ledger detail for a specific period or account ID range
Fetch company setup configuration including financial year and company logo
Use Cases
Patterns agents use Big Red Cloud API for, with concrete tasks.
★ E-Commerce to Accounting Sync
Irish online retailers running on Shopify or WooCommerce push completed orders into Big Red Cloud as sales invoices, then mark them paid via cash receipts as the payment processor settles. POST /v1/customers handles new buyers, POST /v1/salesInvoices posts the order, and POST /v1/cashReceipts closes the loop. Batch endpoints make end-of-day catch-up runs efficient when the sync has been offline for a window.
Call POST /v1/customers for the buyer, POST /v1/salesInvoices with the line items, then POST /v1/cashReceipts when payment settles
Customer Statement Automation
Finance teams chase aged debt by sending statements at scheduled intervals. Big Red Cloud exposes /v1/email/sendEmailStatement to dispatch the customer's outstanding statement directly from the platform, with /v1/customers/{itemId}/accountTrans giving the reviewer the underlying transactions before they trigger the send. This removes the manual export-to-PDF-to-email loop most small finance teams still run.
Call GET /v1/customers/{itemId}/accountTrans, then POST /v1/email/sendEmailStatement with the customer ID to dispatch the statement
Quote-to-Invoice Workflow
Service businesses send quotes, win the work, and convert the quote to a sales invoice without rekeying. Big Red Cloud's API supports listing quotes for a customer through /v1/customers/{itemId}/quotes, emailing a quote with /v1/email/sendQuote, then creating the resulting sales invoice via /v1/salesInvoices and emailing it with /v1/email/sendSalesInvoice. The whole pipeline runs without anyone opening the Big Red Cloud UI.
Call GET /v1/customers/{itemId}/quotes, then POST /v1/email/sendQuote, then POST /v1/salesInvoices to convert and POST /v1/email/sendSalesInvoice
Agent-Driven Bookkeeping via Jentic
An AI bookkeeping assistant connected through Jentic answers a user's natural-language request to 'send Acme Ltd their statement' by searching Jentic, loading the Big Red Cloud sendEmailStatement operation, and executing it with the customer ID. The user's API key stays in your Jentic One instance, scoped to the company books, so the agent never sees the raw secret. The same flow scales to invoice posting and receipt logging.
Search Jentic for 'email a customer statement', load Big Red Cloud /v1/email/sendEmailStatement, execute with the customer ID for Acme Ltd
Key Endpoints
120 endpoints — big red cloud is an irish small-business accounting platform, and its rest api exposes the full ledger model - customers, suppliers, sales and purchase invoices, cash payments and receipts, bank accounts, and nominal accounts - across 120 endpoints under /v1.
METHOD
PATH
DESCRIPTION
GET
/v1/customers
List all customers
POST
/v1/customers
Create a new customer
GET
/v1/customers/{itemId}/accountTrans
List a customer's account transactions
POST
/v1/cashReceipts
Record a cash receipt against a bank account
POST
/v1/payments
Record a payment
POST
/v1/email/sendSalesInvoice
Email a sales invoice to a customer
POST
/v1/email/sendEmailStatement
Email a customer statement
GET
/v1/nominalAccounts/ledger
Read the nominal account ledger
GET
/v1/customers
List all customers
POST
/v1/customers
Create a new customer
GET
/v1/customers/{itemId}/accountTrans
List a customer's account transactions
POST
/v1/cashReceipts
Record a cash receipt against a bank account
POST
/v1/payments
Record a payment
POST
/v1/email/sendSalesInvoice
Email a sales invoice to a customer
POST
/v1/email/sendEmailStatement
Email a customer statement
GET
/v1/nominalAccounts/ledger
Read the nominal account ledger
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
B
Big Red Cloud API
- Non-Ready (F)35/100
37
Foundational Compliance51
Developer Experience & Jentic Compatibility15
AI-Readiness & Agent Experience79
Agent Usability100
Security61
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
37
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: FSignals: 4
48%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
0%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
51
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: C-Signals: 4
5%
Example Density
How richly the API is illustrated with examples.
76%
Example Validity
Percentage of examples that conform to their schemas.
25%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
15
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
14%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
0%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
48%
Summary Coverage
Coverage of summaries across operations/tags/info.
79
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A-Signals: 1
79%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
100
Security
Trust, risk posture, and security compliance.
Grade: A+Signals: 1
100%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
61
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: B-Signals: 1
61%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Big Red Cloud API by hand means attaching your API key to every call and building each customer, receipt, payment, and email path across the ledger yourself. Through Jentic you install once, import Big Red Cloud from the API Directory, store the key once, and your agent calls it.
Permission scoping
Big Red Cloud puts the customer id in the URL path (/customers/{itemId}/accountTrans), so a rule can pin your agent to one customer's transactions. You choose the operations it may call, so posting payments or emailing a statement is not included unless you add them.
Credential isolation
Your Big Red Cloud API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'post a sales invoice' or 'email a customer statement', and Jentic returns the matching Big Red Cloud operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
Complementary
Stripe API
Take card payments that flow back into Big Red Cloud as cash receipts
Pair Stripe with Big Red Cloud when the customer accepts online card payments and needs each settlement reflected as a cash receipt against a sales invoice
FAQs
Specific to using Big Red Cloud API through Jentic.
What authentication does the Big Red Cloud API use?
Big Red Cloud uses an API key generated from the user's Big Red Cloud account. The key is scoped to that company's books and is passed on each request. Through Jentic, the key is held encrypted in the vault and attached at execution time so it never enters the agent's context.
Can I post sales invoices through the Big Red Cloud API?
Yes. POST /v1/salesInvoices accepts a customer ID, line items mapped to nominal accounts, and totals, returning the created invoice record. Use PUT /v1/salesInvoices/batch for end-of-day bulk posts when syncing from an e-commerce platform.
What are the rate limits for the Big Red Cloud API?
Big Red Cloud does not publish hard rate limits in the spec - limits are enforced by the platform per API key tier. For high-volume syncs use the batch endpoints (PUT /v1/customers/batch, /v1/salesInvoices/batch, /v1/cashReceipts/batch) instead of looping single-item calls.
How do I email a customer statement through Jentic?
Run `pip install jentic`, then `await client.search('email a customer statement')`, `await client.load(...)` for /v1/email/sendEmailStatement, and `await client.execute(...)` with the customer ID. Jentic injects the API key from the vault and Big Red Cloud sends the statement directly to the customer's email on file.
Does the API expose VAT and Irish-specific tax handling?
VAT codes flow through the line-item structure on sales and purchase invoices, and the nominal ledger captures the resulting tax control account postings. Use GET /v1/nominalAccounts to enumerate account codes, and GET /v1/nominalAccounts/ledger/{ids} to inspect period activity for VAT control accounts.
Can I retrieve a customer's outstanding balance and transaction history?
Yes. GET /v1/customers/{itemId}/openingBalance and /v1/customers/{itemId}/openingBalanceList return balance information, and GET /v1/customers/{itemId}/accountTrans returns the underlying transactions - useful for chasing aged debt or rendering a statement preview before sending.
Can I limit what my agent is allowed to do with the Big Red Cloud API?
Yes. Because you run Jentic One yourself, your own rules decide which Big Red Cloud operations and credentials the agent may use. You can grant read-only calls like GET /v1/customers/{itemId}/accountTrans while withholding write operations such as POST /v1/salesInvoices, POST /v1/cashReceipts, or POST /v1/email/sendEmailStatement. Since the customer id sits in the URL path, a rule can also pin the agent to a single customer's transactions rather than the whole ledger.
GET STARTED