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…
Finance & banking#openapi#financial
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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/
Endpoints 111
Accounts
- GETReturns a list of company's Accounts. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" and "code" fields.
/v1/accounts
AnalysisCategories
- GETReturns 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/analysisCategories
BankAccounts
- GETReturns a list of company's Bank Account. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" and "acCode" fields.
/v1/bankAccounts - POSTCreates a new Bank Account.
/v1/bankAccounts - PUTProcesses a batch of Bank Accounts.
/v1/bankAccounts/batch - GETReturns information about a single Bank Account.
/v1/bankAccounts/:id - PUTUpdates an existing Bank Account.
/v1/bankAccounts/:id - DELETERemoves an existing Bank Account.
/v1/bankAccounts/:id?timestamp=string
BookTranTypes
- GETReturns a list of global Book Transactions' Types. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" field.
/v1/bookTranTypes
CashPayments
- GETReturns 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 - POSTCreates a new Cash Payment.
/v1/cashPayments - PUTProcesses a batch of Cash Payments.
/v1/cashPayments/batch - GETReturns information about a single Cash Payment.
/v1/cashPayments/:id - PUTUpdates an existing Cash Payment.
/v1/cashPayments/:id - DELETERemoves an existing Cash Payment.
/v1/cashPayments/:id?timestamp=string
CashReceipts
- GETReturns 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 - POSTCreates a new Cash Receipt.
/v1/cashReceipts - PUTProcesses a batch of Cash Receipts.
/v1/cashReceipts/batch - GETReturns information about a single Cash Receipt.
/v1/cashReceipts/:id - PUTUpdates an existing Cash Receipt.
/v1/cashReceipts/:id - DELETERemoves an existing Cash Receipt.
/v1/cashReceipts/:id?timestamp=string
CategoryTypes
- GETReturns a list of company's Category Types. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" field.
/v1/categoryTypes
CompanySettings
- GETReturns a list of company settings. Supports OData querying protocol.
Filtering is forbidden.
/v1/companySettings
CompanySetupConfig
- GETReturns the company configuration settings.
/v1/companySetupConfig - GETReturns the company option setting.
/v1/companySetupConfig/getCompanyOptions - GETReturns the financial year.
/v1/companySetupConfig/getFinancialYear
Customers
- GETReturns a list of company's Customers. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" and "code" fields.
/v1/customers - POSTCreates a new Customer.
/v1/customers - PUTProcesses a batch of Customers.
/v1/customers/batch - GETReturns information about a single Customer. You may specify that Customer's ledger balance should be calculated.
/v1/customers/:id?needBalance=true - PUTUpdates an existing Customer.
/v1/customers/:id - DELETERemoves an existing Customer.
/v1/customers/:id?timestamp=string - GETReturns a list of Customer's account transactions.
/v1/customers/:itemId/accountTrans - GETReturns 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/openingBalance - GETReturns a list of Customer's opening balance transactions.
/v1/customers/:itemId/openingBalanceList - GETReturns a list of Customer's quotes.
/v1/customers/:itemId/quotes
- POSTSends 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/email/sendEmailStatement - POSTSends 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/sendQuote - POSTSends 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/email/sendSalesInvoice
OwnerTypeGroups
- GETReturns a list of global Owner Type Groups. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" field.
/v1/ownerTypeGroups
OwnerTypes
- GETReturns a list of global Owner Types. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" field.
/v1/ownerTypes
Payments
- GETReturns a list of company's Payments. Supports OData querying protocol.
Filtering is allowed by "entryDate" field.
Ordering is allowed by "id" field.
/v1/payments - POSTCreates a new Payment.
/v1/payments - PUTProcesses a batch of Payments.
/v1/payments/batch - GETReturns information about a single Payments.
/v1/payments/:id - PUTUpdates an existing Payment.
/v1/payments/:id - DELETERemoves an existing Payment.
/v1/payments/:id?timestamp=string
ProductTypes
- GETReturns a list of global Product Types. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" field.
/v1/productTypes
Products
- GETReturns a list of company's Products. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" and "stockCode" fields.
/v1/products - POSTCreates a new Product.
/v1/products - PUTProcesses a batch of Products.
/v1/products/batch - GETReturns information about a single Product.
/v1/products/:id - PUTUpdates an existing Product.
/v1/products/:id - DELETERemoves an existing Product.
/v1/products/:id?timestamp=string
Purchases
- GETReturns a list of company's Purchases. Supports OData querying protocol.
Filtering is allowed by "entryDate" field.
Ordering is allowed by "id" field.
/v1/purchases - POSTCreates a new Purchase.
/v1/purchases - PUTProcesses a batch of Purchases.
/v1/purchases/batch - GETReturns information about a single Purchases.
/v1/purchases/:id - PUTUpdates an existing Purchase.
/v1/purchases/:id - DELETERemoves an existing Purchase.
/v1/purchases/:id?timestamp=string
Quote
- GETReturns a list of company's Quotes.
Filtering is forbidden.
Ordering is allowed by "id".
/v1/quotes - POSTCreates a new Quote.
/v1/quotes - PUTProcesses a batch of Quote.
/v1/quotes/batch - PUTClose a Quote.
/v1/quotes/close/:id - POSTCreates a new Quote with auto generating reference.
/v1/quotes/createQuoteWithGeneratingReference - POSTGenerate a sale invoice from a Quote.
When sale invoice is empty, new sale invoice will be generated from Quote.
/v1/quotes/generateSaleInvoice - PUTReopen a Quote.
/v1/quotes/reopen/:id - GETReturns information about a single Quote.
/v1/quotes/:id - PUTUpdates an existing Quote.
/v1/quotes/:id - DELETERemoves an existing Quote.
/v1/quotes/:id?timestamp=string
Sales
- GETReturns 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/sales
SalesCreditNotes
- GETReturns 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 - POSTCreates a new Sales Credit Note.
/v1/salesCreditNotes - PUTProcesses a batch of Sales Credit Notes.
/v1/salesCreditNotes/batch - GETReturns information about a single Sales Credit Note.
/v1/salesCreditNotes/:id - PUTUpdates an existing Sales Credit Note.
/v1/salesCreditNotes/:id - DELETERemoves an existing Sales Credit Note.
/v1/salesCreditNotes/:id?timestamp=string
SalesEntries
- GETReturns 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 - POSTCreates a new Sales Entry.
/v1/salesEntries - PUTProcesses a batch of Sales Entries.
/v1/salesEntries/batch - GETReturns information about a single Sales Entry.
/v1/salesEntries/:id - PUTUpdates an existing Sales Entry.
/v1/salesEntries/:id - DELETERemoves an existing Sales Entry.
/v1/salesEntries/:id?timestamp=string
SalesInvoices
- GETReturns 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 - POSTCreates a new Sales Invoice.
/v1/salesInvoices - PUTProcesses a batch of Sales Invoices.
/v1/salesInvoices/batch - POSTCreates a new Sale Invoice with auto generating reference.
/v1/salesInvoices/createSaleInvoiceWithGeneratingReference - GETReturns information about a single Sales Invoice.
/v1/salesInvoices/:id - PUTUpdates an existing Sales Invoice.
/v1/salesInvoices/:id - DELETERemoves an existing Sales Invoice.
/v1/salesInvoices/:id?timestamp=string
SalesRep
- GETReturns a list of company's SaleRep.
Filtering is forbidden.
Ordering is allowed by "id".
/v1/salesReps - POSTCreates a new SaleRep.
/v1/salesReps - PUTProcesses a batch of Sale Rep.
/v1/salesReps/batch - GETReturns information about a single SaleRep.
/v1/salesReps/:id - PUTUpdates an existing Sale Rep.
/v1/salesReps/:id - DELETERemoves an existing Sale Rep.
/v1/salesReps/:id?timestamp=string
Suppliers
- GETReturns a list of company's Suppliers. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" and "code" fields.
/v1/suppliers - POSTCreates a new Supplier.
/v1/suppliers - PUTProcesses a batch of Suppliers.
/v1/suppliers/batch - GETReturns information about a single Supplier. You may specify that Supplier's ledger balance should be calculated.
/v1/suppliers/:id?needBalance=true - PUTUpdates an existing Supplier.
/v1/suppliers/:id - DELETERemoves an existing Supplier.
/v1/suppliers/:id?timestamp=string - GETReturns a list of Supplier's account transactions.
/v1/suppliers/:itemId/accountTrans - GETReturns 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/openingBalance - GETReturns a list of Supplier's opening balance transactions.
/v1/suppliers/:itemId/openingBalanceList
UserDefinedFields
- GETReturns 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/userDefinedFields
VatAnalysisTypes
- GETReturns a list of global Vat Analysis Types. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" field.
/v1/vatAnalysisTypes
VatCategories
- GETReturns a list of global Vat Categories. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" field.
/v1/vatCategories - POSTProcess Vat Rates
/v1/vatCategories/vatRates
VatRates
- GETReturns 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/vatRates
VatTypes
- GETReturns a list of global Vat Types. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" field.
/v1/vatTypes
API details
- Base URL
https://app.bigredcloud.com/api- Authentication
- None declared in the description
- Operations
- 111 operations on 72 pathsGET 50PUT 28POST 20DELETE 13
- Main resources
- Customers 10Quote 10Suppliers 9SalesInvoices 7BankAccounts 6CashPayments 6CashReceipts 6Payments 6Products 6Purchases 6
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
v1 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Big Red Cloud API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Big Red Cloud API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Returns a list of company's Accounts. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.” (GET /v1/accounts), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the 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… It is listed under Finance & banking and has 111 endpoints.
Who publishes the Big Red Cloud API?
It is listed from Big Red Cloud's public API description (an OpenAPI document), not published by Big Red Cloud on Swastik Codes. Anyone who controls bigredcloud.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Big Red Cloud API?
Requests go to https://app.bigredcloud.com/api. Endpoint paths are added to this base URL.
How do I authenticate with the Big Red Cloud API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Big Red Cloud API have?
111 operations on 72 paths (50 GET, 28 PUT, 20 POST, 13 DELETE). The largest groups are Customers, Quote, Suppliers, SalesInvoices.
Is forking the Big Red Cloud API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.