APIHub
Back to Explore

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.

Finance
none
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

1544ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
POST

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

POST

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

GET

/v1/ownerTypeGroups

Returns a list of global Owner Type Groups. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.

GET

/v1/ownerTypes

Returns a list of global Owner Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.

PUT

/v1/salesReps/batch

Processes a batch of Sale Rep.

DELETE

/v1/salesReps/{id}

Removes an existing Sale Rep.

  • id (path, required) — Id of Sale Rep to remove.
  • timestamp (query, required) — Timestamp of Sale Rep to remove. Should be encoded in Base64.
GET

/v1/accounts

Returns a list of company's Accounts. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.

GET

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

GET

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

POST

/v1/bankAccounts

Creates a new Bank Account.

PUT

/v1/bankAccounts/batch

Processes a batch of Bank Accounts.

DELETE

/v1/bankAccounts/{id}

Removes an existing Bank Account.

  • id (path, required) — Id of Bank Account to remove.
  • timestamp (query, required) — Timestamp of Bank Account to remove. Should be encoded in Base64.
GET

/v1/bankAccounts/{id}

Returns information about a single Bank Account.

  • id (path, required) — Id of Bank Account to return.
PUT

/v1/bankAccounts/{id}

Updates an existing Bank Account.

  • id (path, required) — Id of Bank Account to update.
GET

/v1/bookTranTypes

Returns a list of global Book Transactions' Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.

GET

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

POST

/v1/cashPayments

Creates a new Cash Payment.

PUT

/v1/cashPayments/batch

Processes a batch of Cash Payments.

DELETE

/v1/cashPayments/{id}

Removes an existing Cash Payment.

  • id (path, required) — Id of Cash Receipt to remove.
  • timestamp (query, required) — Timestamp of Cash Receipt to remove. Should be encoded in Base64.
GET

/v1/cashPayments/{id}

Returns information about a single Cash Payment.

  • id (path, required) — Id of Cash Receipt to return.
PUT

/v1/cashPayments/{id}

Updates an existing Cash Payment.

  • id (path, required) — Id of Cash Receipt to update.
GET

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

POST

/v1/cashReceipts

Creates a new Cash Receipt.

PUT

/v1/cashReceipts/batch

Processes a batch of Cash Receipts.

DELETE

/v1/cashReceipts/{id}

Removes an existing Cash Receipt.

  • id (path, required) — Id of Cash Receipt to remove.
  • timestamp (query, required) — Timestamp of Cash Receipt to remove. Should be encoded in Base64.
GET

/v1/cashReceipts/{id}

Returns information about a single Cash Receipt.

  • id (path, required) — Id of Cash Receipt to return.
PUT

/v1/cashReceipts/{id}

Updates an existing Cash Receipt.

  • id (path, required) — Id of Cash Receipt to update.
GET

/v1/categoryTypes

Returns a list of company's Category Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.

GET

/v1/companySettings

Returns a list of company settings. Supports OData querying protocol. Filtering is forbidden.

GET

/v1/companySetupConfig

Returns the company configuration settings.

GET

/v1/companySetupConfig/getCompanyOptions

Returns the company option setting.

GET

/v1/companySetupConfig/getFinancialYear

Returns the financial year.

GET

/v1/salesReps/{id}

Returns information about a single SaleRep.

  • id (path, required) — Id of Sale Rep to return.
PUT

/v1/salesReps/{id}

Updates an existing Sale Rep.

  • id (path, required) — Id of Sale Rep to update.
GET

/v1/customers

Returns a list of company's Customers. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.

POST

/v1/customers

Creates a new Customer.

PUT

/v1/customers/batch

Processes a batch of Customers.

DELETE

/v1/customers/{id}

Removes an existing Customer.

  • id (path, required) — Id of Customer to remove.
  • timestamp (query, required) — Timestamp of Customer to remove. Should be encoded in Base64.
GET

/v1/customers/{id}

Returns information about a single Customer. You may specify that Customer's ledger balance should be calculated.

  • id (path, required) — Id of Customer to return.
  • needBalance (query) — If "true" then Customer's ledger balance will be calculated; otherwise balance will be returned as 0.
PUT

/v1/customers/{id}

Updates an existing Customer.

  • id (path, required) — Id of Customer to update.
GET

/v1/customers/{itemId}/accountTrans

Returns a list of Customer's account transactions.

  • itemId (path, required) — Id of Customer to return account transaction.
GET

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

  • itemId (path, required) — Id of Customer to return opening balances.
GET

/v1/customers/{itemId}/openingBalanceList

Returns a list of Customer's opening balance transactions.

  • itemId (path, required) — Id of Customer to return opening balances transaction.
GET

/v1/customers/{itemId}/quotes

Returns a list of Customer's quotes.

  • itemId (path, required) — Id of Customer to return quotes.
POST

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

GET

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

POST

/v1/payments

Creates a new Payment.

PUT

/v1/payments/batch

Processes a batch of Payments.

DELETE

/v1/payments/{id}

Removes an existing Payment.

  • id (path, required) — Id of Payment to remove.
  • timestamp (query, required) — Timestamp of Payment to remove. Should be encoded in Base64.
GET

/v1/payments/{id}

Returns information about a single Payments.

  • id (path, required) — Id of Payment to return.
PUT

/v1/payments/{id}

Updates an existing Payment.

  • id (path, required) — Id of Payment to update.
GET

/v1/productTypes

Returns a list of global Product Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.

GET

/v1/products

Returns a list of company's Products. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "stockCode" fields.

POST

/v1/products

Creates a new Product.

PUT

/v1/products/batch

Processes a batch of Products.

DELETE

/v1/products/{id}

Removes an existing Product.

  • id (path, required) — Id of Product to remove.
  • timestamp (query, required) — Timestamp of Product to remove. Should be encoded in Base64.
GET

/v1/products/{id}

Returns information about a single Product.

  • id (path, required) — Id of Product to return.
PUT

/v1/products/{id}

Updates an existing Product.

  • id (path, required) — Id of Product to update.
GET

/v1/vatAnalysisTypes

Returns a list of global Vat Analysis Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.

GET

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

POST

/v1/purchases

Creates a new Purchase.

PUT

/v1/purchases/batch

Processes a batch of Purchases.

DELETE

/v1/purchases/{id}

Removes an existing Purchase.

  • id (path, required) — Id of Purchase to remove.
  • timestamp (query, required) — Timestamp of Purchase to remove. Should be encoded in Base64.
GET

/v1/purchases/{id}

Returns information about a single Purchases.

  • id (path, required) — Id of Purchase to return.
PUT

/v1/purchases/{id}

Updates an existing Purchase.

  • id (path, required) — Id of Purchase to update.
GET

/v1/quotes

Returns a list of company's Quotes. Filtering is forbidden. Ordering is allowed by "id".

POST

/v1/quotes

Creates a new Quote.

PUT

/v1/quotes/batch

Processes a batch of Quote.

PUT

/v1/quotes/close/{id}

Close a Quote.

  • id (path, required) — Id of Quote to close
POST

/v1/quotes/createQuoteWithGeneratingReference

Creates a new Quote with auto generating reference.

POST

/v1/quotes/generateSaleInvoice

Generate a sale invoice from a Quote. When sale invoice is empty, new sale invoice will be generated from Quote.

PUT

/v1/quotes/reopen/{id}

Reopen a Quote.

  • id (path, required) — Id of Quote to reopen
DELETE

/v1/quotes/{id}

Removes an existing Quote.

  • id (path, required) — Id of Quote to remove.
  • timestamp (query, required) — Timestamp of Quote to remove. Should be encoded in Base64.
GET

/v1/quotes/{id}

Returns information about a single Quote.

  • id (path, required) — Id of Sale Rep to return.
PUT

/v1/quotes/{id}

Updates an existing Quote.

  • id (path, required) — Id of Quote to update.
GET

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

GET

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

POST

/v1/salesCreditNotes

Creates a new Sales Credit Note.

PUT

/v1/salesCreditNotes/batch

Processes a batch of Sales Credit Notes.

DELETE

/v1/salesCreditNotes/{id}

Removes an existing Sales Credit Note.

  • id (path, required) — Id of Sales Credit Note to remove.
  • timestamp (query, required) — Timestamp of Sales Credit Note to remove. Should be encoded in Base64.
GET

/v1/vatCategories

Returns a list of global Vat Categories. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.

POST

/v1/vatCategories/vatRates

Process Vat Rates

GET

/v1/salesCreditNotes/{id}

Returns information about a single Sales Credit Note.

  • id (path, required) — Id of Sales Credit Note to return.
PUT

/v1/salesCreditNotes/{id}

Updates an existing Sales Credit Note.

  • id (path, required) — Id of Sales Credit Note to update.
GET

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

POST

/v1/salesEntries

Creates a new Sales Entry.

PUT

/v1/salesEntries/batch

Processes a batch of Sales Entries.

DELETE

/v1/salesEntries/{id}

Removes an existing Sales Entry.

  • id (path, required) — Id of Sales Entry to remove.
  • timestamp (query, required) — Timestamp of Sales Entry to remove. Should be encoded in Base64.
GET

/v1/salesEntries/{id}

Returns information about a single Sales Entry.

  • id (path, required) — Id of Sales Entry to return.
PUT

/v1/salesEntries/{id}

Updates an existing Sales Entry.

  • id (path, required) — Id of Sales Entry to update.
GET

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

POST

/v1/salesInvoices

Creates a new Sales Invoice.

PUT

/v1/salesInvoices/batch

Processes a batch of Sales Invoices.

POST

/v1/salesInvoices/createSaleInvoiceWithGeneratingReference

Creates a new Sale Invoice with auto generating reference.

DELETE

/v1/salesInvoices/{id}

Removes an existing Sales Invoice.

  • id (path, required) — Id of Sales Invoice to remove.
  • timestamp (query, required) — Timestamp of Sales Invoice to remove. Should be encoded in Base64.
GET

/v1/salesInvoices/{id}

Returns information about a single Sales Invoice.

  • id (path, required) — Id of Sales Invoice to return.
PUT

/v1/salesInvoices/{id}

Updates an existing Sales Invoice.

  • id (path, required) — Id of Sales Invoice to update.
GET

/v1/salesReps

Returns a list of company's SaleRep. Filtering is forbidden. Ordering is allowed by "id".

POST

/v1/salesReps

Creates a new SaleRep.

GET

/v1/suppliers

Returns a list of company's Suppliers. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.

POST

/v1/suppliers

Creates a new Supplier.

PUT

/v1/suppliers/batch

Processes a batch of Suppliers.

DELETE

/v1/suppliers/{id}

Removes an existing Supplier.

  • id (path, required) — Id of Supplier to remove.
  • timestamp (query, required) — Timestamp of Supplier to remove. Should be encoded in Base64.
GET

/v1/suppliers/{id}

Returns information about a single Supplier. You may specify that Supplier's ledger balance should be calculated.

  • id (path, required) — Id of Supplier to return.
  • needBalance (query) — If "true" then Supplier's ledger balance will be calculated; otherwise balance will be returned as 0.
PUT

/v1/suppliers/{id}

Updates an existing Supplier.

  • id (path, required) — Id of Supplier to update.
GET

/v1/suppliers/{itemId}/accountTrans

Returns a list of Supplier's account transactions.

  • itemId (path, required) — Id of Supplier to return account transaction.
GET

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

  • itemId (path, required) — Id of Supplier to return opening balances.
GET

/v1/suppliers/{itemId}/openingBalanceList

Returns a list of Supplier's opening balance transactions.

  • itemId (path, required) — Id of Supplier to return opening balances transaction.
GET

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

GET

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

GET

/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