canonical: https://jentic.com/apis/bigredcloud.com/bigredcloud

# Big Red Cloud API

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.

## For AI 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.

## Scope

Does not handle payroll, time tracking, or card payment processing - use for Big Red Cloud accounting ledger and invoicing operations only.

## Capabilities

- 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

### 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.

Example prompt: 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.

Example prompt: 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.

Example prompt: 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.

Example prompt: Search Jentic for 'email a customer statement', load Big Red Cloud `/v1/email/sendEmailStatement`, execute with the customer ID for Acme Ltd

## Key endpoints

| 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 |

## Key resources

- **Customers and Suppliers** — Manage customer and supplier master data, balances, and account transactions
- **Sales and Purchase Invoices** — Post sales invoices, purchase invoices, and credit notes individually or in batch
- **Cash Payments and Receipts** — Record money in and out against bank accounts and nominal codes
- **Bank and Nominal Accounts** — Manage bank accounts and access the nominal ledger by account ID
- **Email Dispatch** — Send sales invoices, quotes, and customer statements by email from the platform
- **Company Setup** — Read company settings, financial year, and company logo

## Why Jentic

- **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 handling:** 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.
- **Discovery method:** 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

- **Xero Accounting API** — Cloud accounting platform with broad multi-country tax and bank-feed coverage
- **Sage Accounting API** — Sage's cloud accounting API for SMB ledger, invoicing, and reporting
- **Stripe API** — Take card payments that flow back into Big Red Cloud as cash receipts

## FAQ

### 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.