Big Red Cloud API
The Big Red Cloud API offers comprehensive REST endpoints for managing and querying core accounting and CRM data—such as customers, accounts, payments, bank accounts, invoices, quotes, sales, purchases, and related financial entries—and includes actions for sending statement and invoice emails.
Latency
1544ms p95
Uptime
100.0% 30d
Playground
Verified
live
Endpoints
/v1/email/sendQuote
Sends a Quote email. If "toAddress" is not empty then email will be sent to this address. Otherwise email will be sent to Statement Customer's address.
/v1/email/sendSalesInvoice
Sends a Sales Invoice email. If "toAddress" is not empty then email will be sent to this address. Otherwise email will be sent to Sales Invoice Customer's address.
/v1/ownerTypeGroups
Returns a list of global Owner Type Groups. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/ownerTypes
Returns a list of global Owner Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/salesReps/batch
Processes a batch of Sale Rep.
/v1/salesReps/{id}
Removes an existing Sale Rep.
/v1/accounts
Returns a list of company's Accounts. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.
/v1/analysisCategories
Returns a list of company's Analysis Categories. Supports OData querying protocol. Filtering is allowed by "categoryTypeId" field. Ordering is allowed by "id" and "orderIndex" fields.
/v1/bankAccounts
Returns a list of company's Bank Account. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "acCode" fields.
/v1/bankAccounts
Creates a new Bank Account.
/v1/bankAccounts/batch
Processes a batch of Bank Accounts.
/v1/bankAccounts/{id}
Removes an existing Bank Account.
/v1/bankAccounts/{id}
Returns information about a single Bank Account.
/v1/bankAccounts/{id}
Updates an existing Bank Account.
/v1/bookTranTypes
Returns a list of global Book Transactions' Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/cashPayments
Returns a list of company's Cash Payments. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
/v1/cashPayments
Creates a new Cash Payment.
/v1/cashPayments/batch
Processes a batch of Cash Payments.
/v1/cashPayments/{id}
Removes an existing Cash Payment.
/v1/cashPayments/{id}
Returns information about a single Cash Payment.
/v1/cashPayments/{id}
Updates an existing Cash Payment.
/v1/cashReceipts
Returns a list of company's Cash Receipts. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
/v1/cashReceipts
Creates a new Cash Receipt.
/v1/cashReceipts/batch
Processes a batch of Cash Receipts.
/v1/cashReceipts/{id}
Removes an existing Cash Receipt.
/v1/cashReceipts/{id}
Returns information about a single Cash Receipt.
/v1/cashReceipts/{id}
Updates an existing Cash Receipt.
/v1/categoryTypes
Returns a list of company's Category Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/companySettings
Returns a list of company settings. Supports OData querying protocol. Filtering is forbidden.
/v1/companySetupConfig
Returns the company configuration settings.
/v1/companySetupConfig/getCompanyOptions
Returns the company option setting.
/v1/companySetupConfig/getFinancialYear
Returns the financial year.
/v1/salesReps/{id}
Returns information about a single SaleRep.
/v1/salesReps/{id}
Updates an existing Sale Rep.
/v1/customers
Returns a list of company's Customers. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.
/v1/customers
Creates a new Customer.
/v1/customers/batch
Processes a batch of Customers.
/v1/customers/{id}
Removes an existing Customer.
/v1/customers/{id}
Returns information about a single Customer. You may specify that Customer's ledger balance should be calculated.
/v1/customers/{id}
Updates an existing Customer.
/v1/customers/{itemId}/accountTrans
Returns a list of Customer's account transactions.
/v1/customers/{itemId}/openingBalance
Returns a Customer's opening balances, calculated for the next periods: current month, one month old, two months old, three and more months old.
/v1/customers/{itemId}/openingBalanceList
Returns a list of Customer's opening balance transactions.
/v1/customers/{itemId}/quotes
Returns a list of Customer's quotes.
/v1/email/sendEmailStatement
Sends a Statement email. If "toAddress" is not empty then email will be sent to this address. Otherwise email will be sent to Statement Customer's address.
/v1/payments
Returns a list of company's Payments. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
/v1/payments
Creates a new Payment.
/v1/payments/batch
Processes a batch of Payments.
/v1/payments/{id}
Removes an existing Payment.
/v1/payments/{id}
Returns information about a single Payments.
/v1/payments/{id}
Updates an existing Payment.
/v1/productTypes
Returns a list of global Product Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/products
Returns a list of company's Products. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "stockCode" fields.
/v1/products
Creates a new Product.
/v1/products/batch
Processes a batch of Products.
/v1/products/{id}
Removes an existing Product.
/v1/products/{id}
Returns information about a single Product.
/v1/products/{id}
Updates an existing Product.
/v1/vatAnalysisTypes
Returns a list of global Vat Analysis Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/purchases
Returns a list of company's Purchases. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
/v1/purchases
Creates a new Purchase.
/v1/purchases/batch
Processes a batch of Purchases.
/v1/purchases/{id}
Removes an existing Purchase.
/v1/purchases/{id}
Returns information about a single Purchases.
/v1/purchases/{id}
Updates an existing Purchase.
/v1/quotes
Returns a list of company's Quotes. Filtering is forbidden. Ordering is allowed by "id".
/v1/quotes
Creates a new Quote.
/v1/quotes/batch
Processes a batch of Quote.
/v1/quotes/close/{id}
Close a Quote.
/v1/quotes/createQuoteWithGeneratingReference
Creates a new Quote with auto generating reference.
/v1/quotes/generateSaleInvoice
Generate a sale invoice from a Quote. When sale invoice is empty, new sale invoice will be generated from Quote.
/v1/quotes/reopen/{id}
Reopen a Quote.
/v1/quotes/{id}
Removes an existing Quote.
/v1/quotes/{id}
Returns information about a single Quote.
/v1/quotes/{id}
Updates an existing Quote.
/v1/sales
Returns a list of company's Sales Entries, Sales Invoices and Sales Credit Notes. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
/v1/salesCreditNotes
Returns a list of company's Sales Credit Notes. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
/v1/salesCreditNotes
Creates a new Sales Credit Note.
/v1/salesCreditNotes/batch
Processes a batch of Sales Credit Notes.
/v1/salesCreditNotes/{id}
Removes an existing Sales Credit Note.
/v1/vatCategories
Returns a list of global Vat Categories. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/vatCategories/vatRates
Process Vat Rates
/v1/salesCreditNotes/{id}
Returns information about a single Sales Credit Note.
/v1/salesCreditNotes/{id}
Updates an existing Sales Credit Note.
/v1/salesEntries
Returns a list of company's Sales Entries. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
/v1/salesEntries
Creates a new Sales Entry.
/v1/salesEntries/batch
Processes a batch of Sales Entries.
/v1/salesEntries/{id}
Removes an existing Sales Entry.
/v1/salesEntries/{id}
Returns information about a single Sales Entry.
/v1/salesEntries/{id}
Updates an existing Sales Entry.
/v1/salesInvoices
Returns a list of company's Sales Invoices. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
/v1/salesInvoices
Creates a new Sales Invoice.
/v1/salesInvoices/batch
Processes a batch of Sales Invoices.
/v1/salesInvoices/createSaleInvoiceWithGeneratingReference
Creates a new Sale Invoice with auto generating reference.
/v1/salesInvoices/{id}
Removes an existing Sales Invoice.
/v1/salesInvoices/{id}
Returns information about a single Sales Invoice.
/v1/salesInvoices/{id}
Updates an existing Sales Invoice.
/v1/salesReps
Returns a list of company's SaleRep. Filtering is forbidden. Ordering is allowed by "id".
/v1/salesReps
Creates a new SaleRep.
/v1/suppliers
Returns a list of company's Suppliers. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.
/v1/suppliers
Creates a new Supplier.
/v1/suppliers/batch
Processes a batch of Suppliers.
/v1/suppliers/{id}
Removes an existing Supplier.
/v1/suppliers/{id}
Returns information about a single Supplier. You may specify that Supplier's ledger balance should be calculated.
/v1/suppliers/{id}
Updates an existing Supplier.
/v1/suppliers/{itemId}/accountTrans
Returns a list of Supplier's account transactions.
/v1/suppliers/{itemId}/openingBalance
Returns a Supplier's opening balances, calculated for the next periods: current month, one month old, two months old, three and more months old.
/v1/suppliers/{itemId}/openingBalanceList
Returns a list of Supplier's opening balance transactions.
/v1/userDefinedFields
Returns a list of company's User Defined Fields. Supports OData querying protocol. Filtering is allowed by "categoryTypeId" field. Ordering is allowed by "id" and "orderIndex" fields.
/v1/vatRates
Returns a list of company's Vat Rates. Supports OData querying protocol. Filtering is allowed by "vatCategoryId" field. Ordering is allowed by "id" and "orderIndex" fields.
/v1/vatTypes
Returns a list of global Vat Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
111 endpoints auto-detected
curl -X POST \ "https://app.bigredcloud.com/api/v1/email/sendQuote"
app.bigredcloud.com · HTTPS only