Big Red Cloud API

OpenAPI apis-guru financial

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

Homepage: https://api.apis.guru/v2/specs/bigredcloud.com/v1.json
Provider: bigredcloud.com
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/bigredcloud.com/v1/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/bigredcloud.com/v1/openapi.yaml

Tools (113)

Extracted live via the executor SDK.

accounts.accountsGet

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

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.
bankAccounts.bankAccountsDelete

Removes an existing Bank Account.
bankAccounts.bankAccountsGet

Returns a list of company's Bank Account. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "acCode" fields.
bankAccounts.bankAccountsPost

Creates a new Bank Account.
bankAccounts.bankAccountsProcessBatch

Processes a batch of Bank Accounts.
bankAccounts.bankAccountsPut

Updates an existing Bank Account.
bankAccounts.getV1BankAccountsId

Returns information about a single Bank Account.
bookTranTypes.bookTranTypesGet

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

Removes an existing Cash Payment.
cashPayments.cashPaymentsGet

Returns a list of company's Cash Payments. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
cashPayments.cashPaymentsPost

Creates a new Cash Payment.
cashPayments.cashPaymentsProcessBatch

Processes a batch of Cash Payments.
cashPayments.cashPaymentsPut

Updates an existing Cash Payment.
cashPayments.getV1CashPaymentsId

Returns information about a single Cash Payment.
cashReceipts.cashReceiptsDelete

Removes an existing Cash Receipt.
cashReceipts.cashReceiptsGet

Returns a list of company's Cash Receipts. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
cashReceipts.cashReceiptsPost

Creates a new Cash Receipt.
cashReceipts.cashReceiptsProcessBatch

Processes a batch of Cash Receipts.
cashReceipts.cashReceiptsPut

Updates an existing Cash Receipt.
cashReceipts.getV1CashReceiptsId

Returns information about a single Cash Receipt.
categoryTypes.categoryTypesGet

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

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

Returns the company configuration settings.
companySetupConfig.companySetupConfigGetCompanyOptions

Returns the company option setting.
companySetupConfig.companySetupConfigGetFinancialYear

Returns the financial year.
customers.customersDelete

Removes an existing Customer.
customers.customersGet

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

Returns a list of Customer's account transactions.
customers.customersGetOpeningBalance

Returns a Customer's opening balances, calculated for the next periods: current month, one month old, two months old, three and more months old.
customers.customersGetOpeningBalanceList

Returns a list of Customer's opening balance transactions.
customers.customersGetQuotes

Returns a list of Customer's quotes.
customers.customersPost

Creates a new Customer.
customers.customersProcessBatch

Processes a batch of Customers.
customers.customersPut

Updates an existing Customer.
customers.getV1CustomersId

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

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.
email.emailSendQuote

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.
email.emailSendSalesInvoice

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.
ownerTypeGroups.ownerTypeGroupsGet

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

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

Returns information about a single Payments.
payments.paymentsDelete

Removes an existing Payment.
payments.paymentsGet

Returns a list of company's Payments. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
payments.paymentsPost

Creates a new Payment.
payments.paymentsProcessBatch

Processes a batch of Payments.
payments.paymentsPut

Updates an existing Payment.
products.getV1ProductsId

Returns information about a single Product.
products.productsDelete

Removes an existing Product.
products.productsGet

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

Creates a new Product.
products.productsProcessBatch

Processes a batch of Products.
products.productsPut

Updates an existing Product.
productTypes.productTypesGet

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

Returns information about a single Purchases.
purchases.purchasesDelete

Removes an existing Purchase.
purchases.purchasesGet

Returns a list of company's Purchases. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
purchases.purchasesPost

Creates a new Purchase.
purchases.purchasesProcessBatch

Processes a batch of Purchases.
purchases.purchasesPut

Updates an existing Purchase.
quote.getV1QuotesId

Returns information about a single Quote.
quote.quoteClose

Close a Quote.
quote.quoteDelete

Removes an existing Quote.
quote.quoteGet

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

Creates a new Quote.
quote.quotePostCreateQuoteWithGeneratingReference

Creates a new Quote with auto generating reference.
quote.quotePostGenerateSaleInvoice

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

Processes a batch of Quote.
quote.quotePut

Updates an existing Quote.
quote.quoteReopen

Reopen a Quote.
sales.salesGet

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.
salesCreditNotes.getV1SalesCreditNotesId

Returns information about a single Sales Credit Note.
salesCreditNotes.salesCreditNotesDelete

Removes an existing Sales Credit Note.
salesCreditNotes.salesCreditNotesGet

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.
salesCreditNotes.salesCreditNotesPost

Creates a new Sales Credit Note.
salesCreditNotes.salesCreditNotesProcessBatch

Processes a batch of Sales Credit Notes.
salesCreditNotes.salesCreditNotesPut

Updates an existing Sales Credit Note.
salesEntries.getV1SalesEntriesId

Returns information about a single Sales Entry.
salesEntries.salesEntriesDelete

Removes an existing Sales Entry.
salesEntries.salesEntriesGet

Returns a list of company's Sales Entries. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
salesEntries.salesEntriesPost

Creates a new Sales Entry.
salesEntries.salesEntriesProcessBatch

Processes a batch of Sales Entries.
salesEntries.salesEntriesPut

Updates an existing Sales Entry.
salesInvoices.getV1SalesInvoicesId

Returns information about a single Sales Invoice.
salesInvoices.salesInvoicesDelete

Removes an existing Sales Invoice.
salesInvoices.salesInvoicesGet

Returns a list of company's Sales Invoices. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
salesInvoices.salesInvoicesPost

Creates a new Sales Invoice.
salesInvoices.salesInvoicesPostCreateSaleInvoiceWithGeneratingReference

Creates a new Sale Invoice with auto generating reference.
salesInvoices.salesInvoicesProcessBatch

Processes a batch of Sales Invoices.
salesInvoices.salesInvoicesPut

Updates an existing Sales Invoice.
salesRep.getV1SalesRepsId

Returns information about a single SaleRep.
salesRep.salesRepDelete

Removes an existing Sale Rep.
salesRep.salesRepGet

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

Creates a new SaleRep.
salesRep.salesRepProcessBatch

Processes a batch of Sale Rep.
salesRep.salesRepPut

Updates an existing Sale Rep.
suppliers.getV1SuppliersId

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

Removes an existing Supplier.
suppliers.suppliersGet

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

Returns a list of Supplier's account transactions.
suppliers.suppliersGetOpeningBalance

Returns a Supplier's opening balances, calculated for the next periods: current month, one month old, two months old, three and more months old.
suppliers.suppliersGetOpeningBalanceList

Returns a list of Supplier's opening balance transactions.
suppliers.suppliersPost

Creates a new Supplier.
suppliers.suppliersProcessBatch

Processes a batch of Suppliers.
suppliers.suppliersPut

Updates an existing Supplier.
userDefinedFields.userDefinedFieldsGet

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.
vatAnalysisTypes.vatAnalysisTypesGet

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

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

Process Vat Rates
vatRates.vatRatesGet

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.
vatTypes.vatTypesGet

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

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools