Welcome to the Big Red Cloud API This API enables programmatic access to Big Red Cloud data. 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. To get started, you will require an API Key - check
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://app.bigredcloud.com/api
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Welcome to the Big Red Cloud API This API enables programmatic access to Big Red Cloud data. 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. To get started, you will require an API Key - check out our guide at https://www.bigredcloud.com/support/generating-api-key-guide/ for information on h
| method | path | what the vendor says it does |
|---|---|---|
GET | /v1/accounts | Returns a list of company's Accounts. Supports OData querying protocol. Filtering is forbidden. Ordering is |
GET | /v1/analysisCategories | Returns a list of company's Analysis Categories. Supports OData querying protocol. Filtering is allowed by "c |
GET | /v1/bankAccounts | Returns a list of company's Bank Account. Supports OData querying protocol. Filtering is forbidden. Ordering |
POST | /v1/bankAccounts | Creates a new Bank Account. BankAccounts |
PUT | /v1/bankAccounts/batch | Processes a batch of Bank Accounts. BankAccounts |
GET | /v1/bankAccounts/{id} | Returns information about a single Bank Account. BankAccounts |
PUT | /v1/bankAccounts/{id} | Updates an existing Bank Account. BankAccounts |
DELETE | /v1/bankAccounts/{id} | Removes an existing Bank Account. BankAccounts |
GET | /v1/bookTranTypes | Returns a list of global Book Transactions' Types. Supports OData querying protocol. Filtering is forbidden. |
GET | /v1/cashPayments | Returns a list of company's Cash Payments. Supports OData querying protocol. Filtering is allowed by "entryDa |
POST | /v1/cashPayments | Creates a new Cash Payment. CashPayments |
PUT | /v1/cashPayments/batch | Processes a batch of Cash Payments. CashPayments |
GET | /v1/cashPayments/{id} | Returns information about a single Cash Payment. CashPayments |
PUT | /v1/cashPayments/{id} | Updates an existing Cash Payment. CashPayments |
DELETE | /v1/cashPayments/{id} | Removes an existing Cash Payment. CashPayments |
GET | /v1/cashReceipts | Returns a list of company's Cash Receipts. Supports OData querying protocol. Filtering is allowed by "entryDa |
POST | /v1/cashReceipts | Creates a new Cash Receipt. CashReceipts |
PUT | /v1/cashReceipts/batch | Processes a batch of Cash Receipts. CashReceipts |
GET | /v1/cashReceipts/{id} | Returns information about a single Cash Receipt. CashReceipts |
PUT | /v1/cashReceipts/{id} | Updates an existing Cash Receipt. CashReceipts |
DELETE | /v1/cashReceipts/{id} | Removes an existing Cash Receipt. CashReceipts |
GET | /v1/categoryTypes | Returns a list of company's Category Types. Supports OData querying protocol. Filtering is forbidden. Orderi |
GET | /v1/companySettings | Returns a list of company settings. Supports OData querying protocol. Filtering is forbidden. CompanySettings |
GET | /v1/companySetupConfig | Returns the company configuration settings. CompanySetupConfig |
GET | /v1/companySetupConfig/getCompanyOptions | Returns the company option setting. CompanySetupConfig |
GET | /v1/companySetupConfig/getFinancialYear | Returns the financial year. CompanySetupConfig |
GET | /v1/customers | Returns a list of company's Customers. Supports OData querying protocol. Filtering is forbidden. Ordering is |
POST | /v1/customers | Creates a new Customer. Customers |
PUT | /v1/customers/batch | Processes a batch of Customers. Customers |
GET | /v1/customers/{id} | Returns information about a single Customer. You may specify that Customer's ledger balance should be calculat |
PUT | /v1/customers/{id} | Updates an existing Customer. Customers |
DELETE | /v1/customers/{id} | Removes an existing Customer. Customers |
GET | /v1/customers/{itemId}/accountTrans | Returns a list of Customer's account transactions. Customers |
GET | /v1/customers/{itemId}/openingBalance | Returns a Customer's opening balances, calculated for the next periods: current month, one month old, two mont |
GET | /v1/customers/{itemId}/openingBalanceList | Returns a list of Customer's opening balance transactions. Customers |
GET | /v1/customers/{itemId}/quotes | Returns a list of Customer's quotes. Customers |
POST | /v1/email/sendEmailStatement | Sends a Statement email. If "toAddress" is not empty then email will be sent to this address. Otherwise email |
POST | /v1/email/sendQuote | Sends a Quote email. If "toAddress" is not empty then email will be sent to this address. Otherwise email wil |
POST | /v1/email/sendSalesInvoice | Sends a Sales Invoice email. If "toAddress" is not empty then email will be sent to this address. Otherwise e |
GET | /v1/ownerTypeGroups | Returns a list of global Owner Type Groups. Supports OData querying protocol. Filtering is forbidden. Orderi |
and 71 more operation(s) in this specification, all searchable.
specification origin: https://app.bigredcloud.com/api/swagger/docs/v1
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.