/
BI
bigredcloud
/
Big Red Cloud API
Search skmtc…
⌘K
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Subscribe
v2
latest
Swagger 2.0
2026-08-01
139
174
369.1 KB
Accounts
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
Response
OK
PageResultAccountDto
required
Items
AccountDto[]
NextPageLink
string
Count
integer
All 139 operations
get
Returns a list of company's Accounts. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.
get
Returns a list of company's Accruals. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
post
Creates a new Accrual. The API accepts only the parent transaction shape and relies on shared logic to generate the reversing child transaction.
get
Returns information about a single parent Accrual. Child accruals are not exposed by the public API.
put
Updates an existing parent Accrual. Child accruals are not exposed by the public API.
delete
Removes an existing parent Accrual. Child accruals are not exposed by the public API.
get
Returns transactions eligible for allocation from the specified sender BookTran.
put
Creates or updates allocations for a sender BookTran.
get
Returns transactions already allocated from the specified sender BookTran.
delete
Reverses a single allocation.
get
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
Returns a list of company's Bank Account. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "acCode" fields.
post
Creates a new Bank Account.
get
Returns information about a single Bank Account.
put
Updates an existing Bank Account.
delete
Removes an existing Bank Account.
put
Processes a batch of Bank Accounts.
get
Returns a list of global Book Transactions' Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
get
Returns a list of company's Cash Payments. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
post
Creates a new Cash Payment.
get
Returns information about a single Cash Payment.
put
Updates an existing Cash Payment.
delete
Removes an existing Cash Payment.
put
Processes a batch of Cash Payments.
get
Returns a list of company's Cash Receipts. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
post
Creates a new Cash Receipt.
get
Returns information about a single Cash Receipt.
put
Updates an existing Cash Receipt.
delete
Removes an existing Cash Receipt.
put
Processes a batch of Cash Receipts.
get
Returns a list of company's Category Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
get
Returns a list of company settings. Supports OData querying protocol. Filtering is forbidden.
get
Returns the company configuration settings.
get
Returns the financial year.
get
Returns the company option setting.
get
Returns the company logo.
get
Returns a list of company's Customers. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.
post
Creates a new Customer.
get
Returns information about a single Customer. You may specify that Customer's ledger balance should be calculated.
put
Updates an existing Customer.
delete
Removes an existing Customer.
get
Returns a list of company's Customers without dormant records. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.
put
Processes a batch of Customers.
get
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
Returns a list of Customer's opening balance transactions.
get
Returns a list of Customer's account transactions.
get
Returns a list of Customer's quotes.
post
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.
post
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.
post
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.
get
Returns a list of company's Nominal Accounts. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.
get
Returns information about a single Nominal Account.
get
Returns information about Nominal Ledger from all Nominal accounts.
get
Returns information about Nominal Ledger from specific Nominal Accounts.
get
Returns a list of company's Nominal Journal Batches. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
post
Creates a new Nominal Journal Batch.
get
Returns information about a single Nominal Journal Batch.
put
Updates an existing Nominal Journal Batch.
delete
Removes an existing Nominal Journal Batch.
get
Returns a list of global Owner Type Groups. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
get
Returns a list of global Owner Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
get
Returns a list of company's Payments. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
post
Creates a new Payment.
get
Returns information about a single Payments.
put
Updates an existing Payment.
delete
Removes an existing Payment.
put
Processes a batch of Payments.
get
Returns a list of company's Prepayments. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
post
Creates a new Prepayment. The API accepts only the parent transaction shape and relies on shared logic to generate the reversing child transaction.
get
Returns information about a single parent Prepayment. Child prepayments are not exposed by the public API.
put
Updates an existing parent Prepayment. Child prepayments are not exposed by the public API.
delete
Removes an existing parent Prepayment. Child prepayments are not exposed by the public API.
get
Returns a list of company's Products. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "stockCode" fields.
post
Creates a new Product.
get
Returns information about a single Product.
put
Updates an existing Product.
delete
Removes an existing Product.
get
Returns a list of company's Products without dormant records. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "stockCode" fields.
put
Processes a batch of Products.
get
Returns a list of global Product Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
get
Returns a list of company's Purchases. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
post
Creates a new Purchase.
get
Returns information about a single Purchases.
put
Updates an existing Purchase.
delete
Removes an existing Purchase.
put
Processes a batch of Purchases.
post
Creates a new Purchase with auto generating reference.
get
Returns a list of company's Quotes. Filtering is forbidden. Ordering is allowed by "id".
post
Creates a new Quote.
get
Returns information about a single Quote.
put
Updates an existing Quote.
delete
Removes an existing Quote.
put
Processes a batch of Quote.
put
Close a Quote.
put
Reopen a Quote.
post
Generate a sale invoice from a Quote. When sale invoice is empty, new sale invoice will be generated from Quote.
post
Creates a new Quote with auto generating reference.
get
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
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.
post
Creates a new Sales Credit Note.
get
Returns information about a single Sales Credit Note.
put
Updates an existing Sales Credit Note.
delete
Removes an existing Sales Credit Note.
put
Processes a batch of Sales Credit Notes.
post
Creates a new Sale Credit Note with auto generating reference.
get
Returns a list of company's Sales Entries. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
post
Creates a new Sales Entry.
get
Returns information about a single Sales Entry.
put
Updates an existing Sales Entry.
delete
Removes an existing Sales Entry.
put
Processes a batch of Sales Entries.
get
Returns a list of company's Sales Invoices. Supports OData querying protocol. Filtering is allowed by "entryDate" field. Ordering is allowed by "id" field.
post
Creates a new Sales Invoice.
get
Returns information about a single Sales Invoice.
put
Updates an existing Sales Invoice.
delete
Removes an existing Sales Invoice.
put
Processes a batch of Sales Invoices.
post
Creates a new Sale Invoice with auto generating reference.
get
Returns a list of company's SaleRep. Filtering is forbidden. Ordering is allowed by "id".
post
Creates a new SaleRep.
get
Returns information about a single SaleRep.
put
Updates an existing Sale Rep.
delete
Removes an existing Sale Rep.
put
Processes a batch of Sale Rep.
get
Returns a list of company's Suppliers. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" and "code" fields.
post
Creates a new Supplier.
get
Returns information about a single Supplier. You may specify that Supplier's ledger balance should be calculated.
put
Updates an existing Supplier.
delete
Removes an existing Supplier.
put
Processes a batch of Suppliers.
get
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
Returns a list of Supplier's opening balance transactions.
get
Returns a list of Supplier's account transactions.
get
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
Returns a list of global Vat Analysis Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
get
Returns a list of global Vat Categories. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.
post
Process Vat Rates
get
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
Returns a list of global Vat Types. Supports OData querying protocol. Filtering is forbidden. Ordering is allowed by "id" field.