Big Red Cloud API
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 how to get one.
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.
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.
For additional information on the API, check out our support article at https://www.bigredcloud.com/support/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 how to get one.
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.
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.
For additional information on the API, check out our support article at https://www.bigredcloud.com/support/api/
Screenshot:
Base URL:
Auth: basic
Endpoints: 47
Reachable: unknown
CORS: unknown
https://app.bigredcloud.com/apiAuth: basic
Endpoints: 47
Reachable: unknown
CORS: unknown
Topics
Endpoints
| Method | Path | Summary | Auth | Last Status | Latency |
|---|---|---|---|---|---|
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. | — | — | — |
GET |
/v1/bankAccounts/{id} | Returns information about a single Bank Account. | — | — | — |
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. | — | — | — |
GET |
/v1/cashPayments/{id} | Returns information about a single Cash Payment. | — | — | — |
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. | — | — | — |
GET |
/v1/cashReceipts/{id} | Returns information about a single Cash Receipt. | — | — | — |
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/customers | Returns a list of company's Customers. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields. | — | — | — |
GET |
/v1/customers/{id} | Returns information about a single Customer. You may specify that Customer's ledger balance should be calculated. | — | — | — |
GET |
/v1/customers/{itemId}/accountTrans | Returns a list of Customer's account transactions. | — | — | — |
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. | — | — | — |
GET |
/v1/customers/{itemId}/openingBalanceList | Returns a list of Customer's opening balance transactions. | — | — | — |
GET |
/v1/customers/{itemId}/quotes | Returns a list of Customer's quotes. | — | — | — |
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. | — | — | — |
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. | — | — | — |
GET |
/v1/products/{id} | Returns information about a single Product. | — | — | — |
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. | — | — | — |
GET |
/v1/purchases/{id} | Returns information about a single Purchases. | — | — | — |
GET |
/v1/quotes | Returns a list of company's Quotes. Filtering is forbidden. Ordering is allowed by "id". | — | — | — |
GET |
/v1/quotes/{id} | Returns information about a single Quote. | — | — | — |
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. | — | — | — |
GET |
/v1/salesCreditNotes/{id} | Returns information about a single Sales Credit Note. | — | — | — |
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. | — | — | — |
GET |
/v1/salesEntries/{id} | Returns information about a single Sales Entry. | — | — | — |
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. | — | — | — |
GET |
/v1/salesInvoices/{id} | Returns information about a single Sales Invoice. | — | — | — |
GET |
/v1/salesReps | Returns a list of company's SaleRep. Filtering is forbidden. Ordering is allowed by "id". | — | — | — |
GET |
/v1/salesReps/{id} | Returns information about a single 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. | — | — | — |
GET |
/v1/suppliers/{id} | Returns information about a single Supplier. You may specify that Supplier's ledger balance should be calculated. | — | — | — |
GET |
/v1/suppliers/{itemId}/accountTrans | Returns a list of Supplier's account transactions. | — | — | — |
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. | — | — | — |
GET |
/v1/suppliers/{itemId}/openingBalanceList | Returns a list of Supplier's opening balance transactions. | — | — | — |
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/vatAnalysisTypes | Returns a list of global Vat Analysis Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field. | — | — | — |
GET |
/v1/vatCategories | Returns a list of global Vat Categories. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field. | — | — | — |
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. | — | — | — |