Skip to content

Big Red Cloud API API

by bigredcloud.com

No authHTTPSFinance
Open documentation ↗

Overview

<div style='line-height: 30px;'> <strong>Welcome to the Big Red Cloud API</strong><br/> This API enables programmatic access to Big Red Cloud data.<br/> We have used Swagger to auto generate the API documentation on this page, and it also enables direct interaction with the API in this page. <br/> To get started, you will require an API Key - check out our guide at <a target='_blank' href='https://www.bigredcloud.com/support/generating-api-key-guide/'>https://www.bigredcloud.com/support/generating-api-key-guide/</a> for information on how to get one. <br/> Use the 'Enter API Key' button below to enter your API key and start interacting with your Big Red Cloud data right on this page. <br/> The API key will be stored in your browsers local storage for convenience, but you will be able to delete it at any time if you wish. <br/> For additional information on the API, check out our support article at <a target='_blank' href='https://www.bigredcloud.com/support/api/'>https://www.bigredcloud.com/support/api/</a><br/> </div>

Big Red Cloud API is a finance API from bigredcloud.com. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 111 endpoints.

At a glance

Authentication
No auth
HTTPS
Yes
CORS
Unknown
Category
Finance
Base URL
https://app.bigredcloud.com/api
Version
v1
Endpoints
111
Spec updated
2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://app.bigredcloud.com/api/v1/accounts" \
  -H "Accept: application/json"
JavaScript
const response = await fetch("https://app.bigredcloud.com/api/v1/accounts", {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://app.bigredcloud.com/api/v1/accounts",
    headers={
    "Accept": "application/json",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/v1/accountsReturns a list of company's Accounts. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.
GET/v1/analysisCategoriesReturns a list of company's Analysis Categories. Supports OData querying protocol. Filtering is allowed by "categoryTypeId" field. Ordering is allowed by "id"
GET/v1/bankAccountsReturns a list of company's Bank Account. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "acCode" fields.
POST/v1/bankAccountsCreates a new Bank Account.
PUT/v1/bankAccounts/batchProcesses a batch of Bank Accounts.
GET/v1/bankAccounts/{id}Returns information about a single Bank Account.
PUT/v1/bankAccounts/{id}Updates an existing Bank Account.
DELETE/v1/bankAccounts/{id}Removes an existing Bank Account.
GET/v1/bookTranTypesReturns a list of global Book Transactions' Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
GET/v1/cashPaymentsReturns 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/cashPaymentsCreates a new Cash Payment.
PUT/v1/cashPayments/batchProcesses a batch of Cash Payments.
GET/v1/cashPayments/{id}Returns information about a single Cash Payment.
PUT/v1/cashPayments/{id}Updates an existing Cash Payment.
DELETE/v1/cashPayments/{id}Removes an existing Cash Payment.
GET/v1/cashReceiptsReturns 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/cashReceiptsCreates a new Cash Receipt.
PUT/v1/cashReceipts/batchProcesses a batch of Cash Receipts.
GET/v1/cashReceipts/{id}Returns information about a single Cash Receipt.
PUT/v1/cashReceipts/{id}Updates an existing Cash Receipt.
DELETE/v1/cashReceipts/{id}Removes an existing Cash Receipt.
GET/v1/categoryTypesReturns a list of company's Category Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
GET/v1/companySettingsReturns a list of company settings. Supports OData querying protocol. Filtering is forbidden.
GET/v1/companySetupConfigReturns the company configuration settings.
GET/v1/companySetupConfig/getCompanyOptionsReturns the company option setting.
GET/v1/companySetupConfig/getFinancialYearReturns the financial year.
GET/v1/customersReturns a list of company's Customers. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.
POST/v1/customersCreates a new Customer.
PUT/v1/customers/batchProcesses a batch of Customers.
GET/v1/customers/{id}Returns information about a single Customer. You may specify that Customer's ledger balance should be calculated.
PUT/v1/customers/{id}Updates an existing Customer.
DELETE/v1/customers/{id}Removes an existing Customer.
GET/v1/customers/{itemId}/accountTransReturns a list of Customer's account transactions.
GET/v1/customers/{itemId}/openingBalanceReturns a Customer's opening balances, calculated for the next periods: current month, one month old, two months old, three and more months old.
GET/v1/customers/{itemId}/openingBalanceListReturns a list of Customer's opening balance transactions.
GET/v1/customers/{itemId}/quotesReturns a list of Customer's quotes.
POST/v1/email/sendEmailStatementSends 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.
POST/v1/email/sendQuoteSends 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/sendSalesInvoiceSends 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 addr
GET/v1/ownerTypeGroupsReturns a list of global Owner Type Groups. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
GET/v1/ownerTypesReturns a list of global Owner Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
GET/v1/paymentsReturns a list of company's Payments. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
POST/v1/paymentsCreates a new Payment.
PUT/v1/payments/batchProcesses a batch of Payments.
GET/v1/payments/{id}Returns information about a single Payments.
PUT/v1/payments/{id}Updates an existing Payment.
DELETE/v1/payments/{id}Removes an existing Payment.
GET/v1/productTypesReturns a list of global Product Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
GET/v1/productsReturns a list of company's Products. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "stockCode" fields.
POST/v1/productsCreates a new Product.
PUT/v1/products/batchProcesses a batch of Products.
GET/v1/products/{id}Returns information about a single Product.
PUT/v1/products/{id}Updates an existing Product.
DELETE/v1/products/{id}Removes an existing Product.
GET/v1/purchasesReturns a list of company's Purchases. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
POST/v1/purchasesCreates a new Purchase.
PUT/v1/purchases/batchProcesses a batch of Purchases.
GET/v1/purchases/{id}Returns information about a single Purchases.
PUT/v1/purchases/{id}Updates an existing Purchase.
DELETE/v1/purchases/{id}Removes an existing Purchase.
GET/v1/quotesReturns a list of company's Quotes. Filtering is forbidden. Ordering is allowed by "id".
POST/v1/quotesCreates a new Quote.
PUT/v1/quotes/batchProcesses a batch of Quote.
PUT/v1/quotes/close/{id}Close a Quote.
POST/v1/quotes/createQuoteWithGeneratingReferenceCreates a new Quote with auto generating reference.
POST/v1/quotes/generateSaleInvoiceGenerate 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.
GET/v1/quotes/{id}Returns information about a single Quote.
PUT/v1/quotes/{id}Updates an existing Quote.
DELETE/v1/quotes/{id}Removes an existing Quote.
GET/v1/salesReturns a list of company's Sales Entries, Sales Invoices and Sales Credit Notes. Supports OData querying protocol. Filtering is allowed by "entryDate" field.
GET/v1/salesCreditNotesReturns 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/salesCreditNotesCreates a new Sales Credit Note.
PUT/v1/salesCreditNotes/batchProcesses a batch of Sales Credit Notes.
GET/v1/salesCreditNotes/{id}Returns information about a single Sales Credit Note.
PUT/v1/salesCreditNotes/{id}Updates an existing Sales Credit Note.
DELETE/v1/salesCreditNotes/{id}Removes an existing Sales Credit Note.
GET/v1/salesEntriesReturns 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/salesEntriesCreates a new Sales Entry.
PUT/v1/salesEntries/batchProcesses a batch of Sales Entries.
GET/v1/salesEntries/{id}Returns information about a single Sales Entry.
PUT/v1/salesEntries/{id}Updates an existing Sales Entry.
DELETE/v1/salesEntries/{id}Removes an existing Sales Entry.
GET/v1/salesInvoicesReturns 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/salesInvoicesCreates a new Sales Invoice.
PUT/v1/salesInvoices/batchProcesses a batch of Sales Invoices.
POST/v1/salesInvoices/createSaleInvoiceWithGeneratingReferenceCreates a new Sale Invoice with auto generating reference.
GET/v1/salesInvoices/{id}Returns information about a single Sales Invoice.
PUT/v1/salesInvoices/{id}Updates an existing Sales Invoice.
DELETE/v1/salesInvoices/{id}Removes an existing Sales Invoice.
GET/v1/salesRepsReturns a list of company's SaleRep. Filtering is forbidden. Ordering is allowed by "id".
POST/v1/salesRepsCreates a new SaleRep.
PUT/v1/salesReps/batchProcesses a batch of Sale Rep.
GET/v1/salesReps/{id}Returns information about a single SaleRep.
PUT/v1/salesReps/{id}Updates an existing Sale Rep.
DELETE/v1/salesReps/{id}Removes an existing Sale Rep.
GET/v1/suppliersReturns a list of company's Suppliers. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.
POST/v1/suppliersCreates a new Supplier.
PUT/v1/suppliers/batchProcesses a batch of Suppliers.
GET/v1/suppliers/{id}Returns information about a single Supplier. You may specify that Supplier's ledger balance should be calculated.

Showing the first 100 of 111 endpoints; the full list is in the documentation.

Questions

Does the Big Red Cloud API API need an API key?

No. The Big Red Cloud API API can be called without an API key or sign-up, which makes it handy for prototypes and front-end demos.

Does the Big Red Cloud API API support HTTPS?

Yes, the Big Red Cloud API API is served over HTTPS.

How many endpoints does the Big Red Cloud API API have?

Its OpenAPI description lists 111 endpoints in version v1. The first 100 are shown on this page.

What are alternatives to the Big Red Cloud API API?

Other Finance APIs include Stripe, SEC EDGAR Data, Plaid, Fed Treasury, Razorpay IFSC.

Compare alternatives →

Listed from APIs.guru (CC0).