<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.co
https://app.bigredcloud.com/api111 endpoints available
/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. Ordering is allowed by "id" field.
/v1/quotesReturns a list of company's Quotes. Filtering is forbidden. Ordering is allowed by "id".
/v1/quotesCreates a new Quote.
/v1/accountsReturns a list of company's Accounts. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.
/v1/paymentsReturns a list of company's Payments. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
/v1/paymentsCreates a new Payment.
/v1/productsReturns a list of company's Products. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "stockCode" fields.
/v1/productsCreates a new Product.
/v1/vatRatesReturns 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/vatTypesReturns a list of global Vat Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/customersReturns a list of company's Customers. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.
/v1/customersCreates a new Customer.
/v1/purchasesReturns a list of company's Purchases. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
/v1/purchasesCreates a new Purchase.
/v1/salesRepsReturns a list of company's SaleRep. Filtering is forbidden. Ordering is allowed by "id".
/v1/salesRepsCreates a new SaleRep.
/v1/suppliersReturns a list of company's Suppliers. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.
/v1/suppliersCreates a new Supplier.
/v1/ownerTypesReturns a list of global Owner Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/quotes/{id}Returns information about a single Quote.
/v1/quotes/{id}Updates an existing Quote.
/v1/quotes/{id}Removes an existing Quote.
/v1/bankAccountsReturns a list of company's Bank Account. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "acCode" fields.
/v1/bankAccountsCreates a new Bank Account.
/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.
/v1/cashPaymentsCreates a new Cash Payment.
/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.
/v1/cashReceiptsCreates a new Cash Receipt.
/v1/productTypesReturns a list of global Product Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/quotes/batchProcesses a batch of Quote.
/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.
/v1/salesEntriesCreates a new Sales Entry.
/v1/bookTranTypesReturns a list of global Book Transactions' Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/categoryTypesReturns a list of company's Category Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/payments/{id}Returns information about a single Payments.
/v1/payments/{id}Updates an existing Payment.
/v1/payments/{id}Removes an existing Payment.
/v1/products/{id}Returns information about a single Product.
/v1/products/{id}Updates an existing Product.
/v1/products/{id}Removes an existing Product.
/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.
/v1/salesInvoicesCreates a new Sales Invoice.
/v1/vatCategoriesReturns a list of global Vat Categories. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/customers/{id}Returns information about a single Customer. You may specify that Customer's ledger balance should be calculated.
/v1/customers/{id}Updates an existing Customer.
/v1/customers/{id}Removes an existing Customer.
/v1/payments/batchProcesses a batch of Payments.
/v1/products/batchProcesses a batch of Products.
/v1/purchases/{id}Returns information about a single Purchases.
/v1/purchases/{id}Updates an existing Purchase.
/v1/purchases/{id}Removes an existing Purchase.
/v1/salesReps/{id}Returns information about a single SaleRep.
/v1/salesReps/{id}Updates an existing Sale Rep.
/v1/salesReps/{id}Removes an existing Sale Rep.
/v1/suppliers/{id}Returns information about a single Supplier. You may specify that Supplier's ledger balance should be calculated.
/v1/suppliers/{id}Updates an existing Supplier.
/v1/suppliers/{id}Removes an existing Supplier.
/v1/companySettingsReturns a list of company settings. Supports OData querying protocol. Filtering is forbidden.
/v1/customers/batchProcesses a batch of Customers.
/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.
/v1/ownerTypeGroupsReturns a list of global Owner Type Groups. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/purchases/batchProcesses a batch of Purchases.
/v1/salesReps/batchProcesses a batch of Sale Rep.
/v1/suppliers/batchProcesses a batch of Suppliers.
/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.
/v1/salesCreditNotesCreates a new Sales Credit Note.
/v1/vatAnalysisTypesReturns a list of global Vat Analysis Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/bankAccounts/{id}Returns information about a single Bank Account.
/v1/bankAccounts/{id}Updates an existing Bank Account.
/v1/bankAccounts/{id}Removes an existing Bank Account.
/v1/cashPayments/{id}Returns information about a single Cash Payment.
/v1/cashPayments/{id}Updates an existing Cash Payment.
/v1/cashPayments/{id}Removes an existing Cash Payment.
/v1/cashReceipts/{id}Returns information about a single Cash Receipt.
/v1/cashReceipts/{id}Updates an existing Cash Receipt.
/v1/cashReceipts/{id}Removes an existing Cash Receipt.
/v1/quotes/close/{id}Close a Quote.
/v1/salesEntries/{id}Returns information about a single Sales Entry.
/v1/salesEntries/{id}Updates an existing Sales Entry.
/v1/salesEntries/{id}Removes an existing Sales Entry.
/v1/userDefinedFieldsReturns 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/analysisCategoriesReturns 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/bankAccounts/batchProcesses a batch of Bank Accounts.
/v1/cashPayments/batchProcesses a batch of Cash Payments.
/v1/cashReceipts/batchProcesses a batch of Cash Receipts.
/v1/companySetupConfigReturns the company configuration settings.
/v1/quotes/reopen/{id}Reopen a Quote.
/v1/salesEntries/batchProcesses a batch of Sales Entries.
/v1/salesInvoices/{id}Returns information about a single Sales Invoice.
/v1/salesInvoices/{id}Updates an existing Sales Invoice.
/v1/salesInvoices/{id}Removes an existing Sales Invoice.
/v1/salesInvoices/batchProcesses a batch of Sales Invoices.
/v1/salesCreditNotes/{id}Returns information about a single Sales Credit Note.
/v1/salesCreditNotes/{id}Updates an existing Sales Credit Note.
/v1/salesCreditNotes/{id}Removes an existing Sales Credit Note.
/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 address.
/v1/salesCreditNotes/batchProcesses a batch of Sales Credit Notes.
/v1/vatCategories/vatRatesProcess Vat Rates
/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.
/v1/customers/{itemId}/quotesReturns a list of Customer's quotes.
/v1/quotes/generateSaleInvoiceGenerate a sale invoice from a Quote. When sale invoice is empty, new sale invoice will be generated from Quote.
/v1/customers/{itemId}/accountTransReturns a list of Customer's account transactions.
/v1/suppliers/{itemId}/accountTransReturns a list of Supplier's account transactions.
/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.
/v1/suppliers/{itemId}/openingBalanceReturns a Supplier's opening balances, calculated for the next periods: current month, one month old, two months old, three and more months old.
/v1/companySetupConfig/getFinancialYearReturns the financial year.
/v1/companySetupConfig/getCompanyOptionsReturns the company option setting.
/v1/customers/{itemId}/openingBalanceListReturns a list of Customer's opening balance transactions.
/v1/suppliers/{itemId}/openingBalanceListReturns a list of Supplier's opening balance transactions.
/v1/quotes/createQuoteWithGeneratingReferenceCreates a new Quote with auto generating reference.
/v1/salesInvoices/createSaleInvoiceWithGeneratingReferenceCreates a new Sale Invoice with auto generating reference.
<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.co
https://app.bigredcloud.com/api111 endpoints available
/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. Ordering is allowed by "id" field.
/v1/quotesReturns a list of company's Quotes. Filtering is forbidden. Ordering is allowed by "id".
/v1/quotesCreates a new Quote.
/v1/accountsReturns a list of company's Accounts. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.
/v1/paymentsReturns a list of company's Payments. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
/v1/paymentsCreates a new Payment.
/v1/productsReturns a list of company's Products. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "stockCode" fields.
/v1/productsCreates a new Product.
/v1/vatRatesReturns 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/vatTypesReturns a list of global Vat Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/customersReturns a list of company's Customers. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.
/v1/customersCreates a new Customer.
/v1/purchasesReturns a list of company's Purchases. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
/v1/purchasesCreates a new Purchase.
/v1/salesRepsReturns a list of company's SaleRep. Filtering is forbidden. Ordering is allowed by "id".
/v1/salesRepsCreates a new SaleRep.
/v1/suppliersReturns a list of company's Suppliers. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.
/v1/suppliersCreates a new Supplier.
/v1/ownerTypesReturns a list of global Owner Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/quotes/{id}Returns information about a single Quote.
/v1/quotes/{id}Updates an existing Quote.
/v1/quotes/{id}Removes an existing Quote.
/v1/bankAccountsReturns a list of company's Bank Account. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "acCode" fields.
/v1/bankAccountsCreates a new Bank Account.
/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.
/v1/cashPaymentsCreates a new Cash Payment.
/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.
/v1/cashReceiptsCreates a new Cash Receipt.
/v1/productTypesReturns a list of global Product Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/quotes/batchProcesses a batch of Quote.
/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.
/v1/salesEntriesCreates a new Sales Entry.
/v1/bookTranTypesReturns a list of global Book Transactions' Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/categoryTypesReturns a list of company's Category Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/payments/{id}Returns information about a single Payments.
/v1/payments/{id}Updates an existing Payment.
/v1/payments/{id}Removes an existing Payment.
/v1/products/{id}Returns information about a single Product.
/v1/products/{id}Updates an existing Product.
/v1/products/{id}Removes an existing Product.
/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.
/v1/salesInvoicesCreates a new Sales Invoice.
/v1/vatCategoriesReturns a list of global Vat Categories. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/customers/{id}Returns information about a single Customer. You may specify that Customer's ledger balance should be calculated.
/v1/customers/{id}Updates an existing Customer.
/v1/customers/{id}Removes an existing Customer.
/v1/payments/batchProcesses a batch of Payments.
/v1/products/batchProcesses a batch of Products.
/v1/purchases/{id}Returns information about a single Purchases.
/v1/purchases/{id}Updates an existing Purchase.
/v1/purchases/{id}Removes an existing Purchase.
/v1/salesReps/{id}Returns information about a single SaleRep.
/v1/salesReps/{id}Updates an existing Sale Rep.
/v1/salesReps/{id}Removes an existing Sale Rep.
/v1/suppliers/{id}Returns information about a single Supplier. You may specify that Supplier's ledger balance should be calculated.
/v1/suppliers/{id}Updates an existing Supplier.
/v1/suppliers/{id}Removes an existing Supplier.
/v1/companySettingsReturns a list of company settings. Supports OData querying protocol. Filtering is forbidden.
/v1/customers/batchProcesses a batch of Customers.
/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.
/v1/ownerTypeGroupsReturns a list of global Owner Type Groups. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/purchases/batchProcesses a batch of Purchases.
/v1/salesReps/batchProcesses a batch of Sale Rep.
/v1/suppliers/batchProcesses a batch of Suppliers.
/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.
/v1/salesCreditNotesCreates a new Sales Credit Note.
/v1/vatAnalysisTypesReturns a list of global Vat Analysis Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
/v1/bankAccounts/{id}Returns information about a single Bank Account.
/v1/bankAccounts/{id}Updates an existing Bank Account.
/v1/bankAccounts/{id}Removes an existing Bank Account.
/v1/cashPayments/{id}Returns information about a single Cash Payment.
/v1/cashPayments/{id}Updates an existing Cash Payment.
/v1/cashPayments/{id}Removes an existing Cash Payment.
/v1/cashReceipts/{id}Returns information about a single Cash Receipt.
/v1/cashReceipts/{id}Updates an existing Cash Receipt.
/v1/cashReceipts/{id}Removes an existing Cash Receipt.
/v1/quotes/close/{id}Close a Quote.
/v1/salesEntries/{id}Returns information about a single Sales Entry.
/v1/salesEntries/{id}Updates an existing Sales Entry.
/v1/salesEntries/{id}Removes an existing Sales Entry.
/v1/userDefinedFieldsReturns 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/analysisCategoriesReturns 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/bankAccounts/batchProcesses a batch of Bank Accounts.
/v1/cashPayments/batchProcesses a batch of Cash Payments.
/v1/cashReceipts/batchProcesses a batch of Cash Receipts.
/v1/companySetupConfigReturns the company configuration settings.
/v1/quotes/reopen/{id}Reopen a Quote.
/v1/salesEntries/batchProcesses a batch of Sales Entries.
/v1/salesInvoices/{id}Returns information about a single Sales Invoice.
/v1/salesInvoices/{id}Updates an existing Sales Invoice.
/v1/salesInvoices/{id}Removes an existing Sales Invoice.
/v1/salesInvoices/batchProcesses a batch of Sales Invoices.
/v1/salesCreditNotes/{id}Returns information about a single Sales Credit Note.
/v1/salesCreditNotes/{id}Updates an existing Sales Credit Note.
/v1/salesCreditNotes/{id}Removes an existing Sales Credit Note.
/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 address.
/v1/salesCreditNotes/batchProcesses a batch of Sales Credit Notes.
/v1/vatCategories/vatRatesProcess Vat Rates
/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.
/v1/customers/{itemId}/quotesReturns a list of Customer's quotes.
/v1/quotes/generateSaleInvoiceGenerate a sale invoice from a Quote. When sale invoice is empty, new sale invoice will be generated from Quote.
/v1/customers/{itemId}/accountTransReturns a list of Customer's account transactions.
/v1/suppliers/{itemId}/accountTransReturns a list of Supplier's account transactions.
/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.
/v1/suppliers/{itemId}/openingBalanceReturns a Supplier's opening balances, calculated for the next periods: current month, one month old, two months old, three and more months old.
/v1/companySetupConfig/getFinancialYearReturns the financial year.
/v1/companySetupConfig/getCompanyOptionsReturns the company option setting.
/v1/customers/{itemId}/openingBalanceListReturns a list of Customer's opening balance transactions.
/v1/suppliers/{itemId}/openingBalanceListReturns a list of Supplier's opening balance transactions.
/v1/quotes/createQuoteWithGeneratingReferenceCreates a new Quote with auto generating reference.
/v1/salesInvoices/createSaleInvoiceWithGeneratingReferenceCreates a new Sale Invoice with auto generating reference.