# Big Red Cloud API API

> Big Red Cloud API API on Apizie: 111 endpoints (Returns a list of company's Accounts. Supports OData querying protocol. Filtering is forbidden. Ordering is…, Returns a list of company's Analysis Categories. Supports OData querying protocol. Filtering is allowed by…, Returns a list of company's Bank Account. Supports OData querying protocol. Filtering is forbidden. Ordering…, Creates a new Bank Account., …) returned as clean JSON through one API key. 111 endpoints are live now. Call it over REST at https://zieapi.vercel.app/v1/finance:bigredcloud/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `finance:bigredcloud`
- Category: Finance
- Status: live
- Source: https://bigredcloud.com
- Page: https://zieapi.vercel.app/api/finance/bigredcloud
- OpenAPI: https://zieapi.vercel.app/api/finance/bigredcloud/openapi.json

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…

## Endpoints

### Returns a list of company's Accounts. Supports OData querying protocol. Filtering is forbidden. Ordering is…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/accounts-get`

### Returns a list of company's Analysis Categories. Supports OData querying protocol. Filtering is allowed by…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/analysis-categories-get`

### Returns a list of company's Bank Account. Supports OData querying protocol. Filtering is forbidden. Ordering…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/bank-accounts-get`

### Creates a new Bank Account.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/bank-accounts-post`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Processes a batch of Bank Accounts.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/bank-accounts-process-batch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Returns information about a single Bank Account.
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/get-v1-bank-accounts-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Bank Account to return. |

### Updates an existing Bank Account.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/bank-accounts-put`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Bank Account to update. |
| body | object | yes | JSON request body |

### Removes an existing Bank Account.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/bank-accounts-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Bank Account to remove. |
| timestamp | string | yes | Timestamp of Bank Account to remove. Should be encoded in Base64. |

### Returns a list of global Book Transactions' Types. Supports OData querying protocol. Filtering is forbidden.…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/book-tran-types-get`

### Returns a list of company's Cash Payments. Supports OData querying protocol. Filtering is allowed by…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/cash-payments-get`

### Creates a new Cash Payment.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/cash-payments-post`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Processes a batch of Cash Payments.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/cash-payments-process-batch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Returns information about a single Cash Payment.
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/get-v1-cash-payments-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Cash Receipt to return. |

### Updates an existing Cash Payment.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/cash-payments-put`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Cash Receipt to update. |
| body | object | yes | JSON request body |

### Removes an existing Cash Payment.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/cash-payments-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Cash Receipt to remove. |
| timestamp | string | yes | Timestamp of Cash Receipt to remove. Should be encoded in Base64. |

### Returns a list of company's Cash Receipts. Supports OData querying protocol. Filtering is allowed by…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/cash-receipts-get`

### Creates a new Cash Receipt.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/cash-receipts-post`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Processes a batch of Cash Receipts.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/cash-receipts-process-batch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Returns information about a single Cash Receipt.
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/get-v1-cash-receipts-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Cash Receipt to return. |

### Updates an existing Cash Receipt.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/cash-receipts-put`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Cash Receipt to update. |
| body | object | yes | JSON request body |

### Removes an existing Cash Receipt.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/cash-receipts-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Cash Receipt to remove. |
| timestamp | string | yes | Timestamp of Cash Receipt to remove. Should be encoded in Base64. |

### Returns a list of company's Category Types. Supports OData querying protocol. Filtering is forbidden.…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/category-types-get`

### Returns a list of company settings. Supports OData querying protocol. Filtering is forbidden.
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/company-settings-get`

### Returns the company configuration settings.
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/company-setup-config-get`

### Returns the company option setting.
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/company-setup-config-get-company-options`

### Returns the financial year.
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/company-setup-config-get-financial-year`

### Returns a list of company's Customers. Supports OData querying protocol. Filtering is forbidden. Ordering is…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/customers-get`

### Creates a new Customer.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/customers-post`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Processes a batch of Customers.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/customers-process-batch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Returns information about a single Customer. You may specify that Customer's ledger balance should be…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/get-v1-customers-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Customer to return. |
| needBalance | boolean | no | If "true" then Customer's ledger balance will be calculated; otherwise balance will be returned as 0. |

### Updates an existing Customer.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/customers-put`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Customer to update. |
| body | object | yes | JSON request body |

### Removes an existing Customer.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/customers-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Customer to remove. |
| timestamp | string | yes | Timestamp of Customer to remove. Should be encoded in Base64. |

### Returns a list of Customer's account transactions.
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/customers-get-account-trans`

| Parameter | Type | Required | Description |
|---|---|---|---|
| itemId | integer | yes | Id of Customer to return account transaction. |

### Returns a Customer's opening balances, calculated for the next periods: current month, one month old, two…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/customers-get-opening-balance`

| Parameter | Type | Required | Description |
|---|---|---|---|
| itemId | integer | yes | Id of Customer to return opening balances. |

### Returns a list of Customer's opening balance transactions.
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/customers-get-opening-balance-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| itemId | integer | yes | Id of Customer to return opening balances transaction. |

### Returns a list of Customer's quotes.
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/customers-get-quotes`

| Parameter | Type | Required | Description |
|---|---|---|---|
| itemId | integer | yes | Id of Customer to return quotes. |

### Sends a Statement email. If "toAddress" is not empty then email will be sent to this address. Otherwise…
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/email-send-email-statement`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Sends a Quote email. If "toAddress" is not empty then email will be sent to this address. Otherwise email…
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/email-send-quote`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Sends a Sales Invoice email. If "toAddress" is not empty then email will be sent to this address. Otherwise…
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/email-send-sales-invoice`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Returns a list of global Owner Type Groups. Supports OData querying protocol. Filtering is forbidden.…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/owner-type-groups-get`

### Returns a list of global Owner Types. Supports OData querying protocol. Filtering is forbidden. Ordering is…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/owner-types-get`

### Returns a list of company's Payments. Supports OData querying protocol. Filtering is allowed by "entryDate"…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/payments-get`

### Creates a new Payment.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/payments-post`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Processes a batch of Payments.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/payments-process-batch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Returns information about a single Payments.
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/get-v1-payments-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Payment to return. |

### Updates an existing Payment.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/payments-put`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Payment to update. |
| body | object | yes | JSON request body |

### Removes an existing Payment.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/payments-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Payment to remove. |
| timestamp | string | yes | Timestamp of Payment to remove. Should be encoded in Base64. |

### Returns a list of global Product Types. Supports OData querying protocol. Filtering is forbidden. Ordering…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/product-types-get`

### Returns a list of company's Products. Supports OData querying protocol. Filtering is forbidden. Ordering is…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/products-get`

### Creates a new Product.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/products-post`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Processes a batch of Products.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/products-process-batch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Returns information about a single Product.
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/get-v1-products-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Product to return. |

### Updates an existing Product.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/products-put`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Product to update. |
| body | object | yes | JSON request body |

### Removes an existing Product.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/products-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Product to remove. |
| timestamp | string | yes | Timestamp of Product to remove. Should be encoded in Base64. |

### Returns a list of company's Purchases. Supports OData querying protocol. Filtering is allowed by "entryDate"…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/purchases-get`

### Creates a new Purchase.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/purchases-post`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Processes a batch of Purchases.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/purchases-process-batch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Returns information about a single Purchases.
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/get-v1-purchases-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Purchase to return. |

### Updates an existing Purchase.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/purchases-put`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Purchase to update. |
| body | object | yes | JSON request body |

### Removes an existing Purchase.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/purchases-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Purchase to remove. |
| timestamp | string | yes | Timestamp of Purchase to remove. Should be encoded in Base64. |

### Returns a list of company's Quotes. Filtering is forbidden. Ordering is allowed by "id".
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/quote-get`

### Creates a new Quote.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/quote-post`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Processes a batch of Quote.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/quote-process-batch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Close a Quote.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/quote-close`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Quote to close |

### Creates a new Quote with auto generating reference.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/quote-post-create-quote-with-generating-reference`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Generate a sale invoice from a Quote. When sale invoice is empty, new sale invoice will be generated from…
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/quote-post-generate-sale-invoice`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Reopen a Quote.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/quote-reopen`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Quote to reopen |

### Returns information about a single Quote.
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/get-v1-quotes-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Sale Rep to return. |

### Updates an existing Quote.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/quote-put`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Quote to update. |
| body | object | yes | JSON request body |

### Removes an existing Quote.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/quote-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Quote to remove. |
| timestamp | string | yes | Timestamp of Quote to remove. Should be encoded in Base64. |

### Returns a list of company's Sales Entries, Sales Invoices and Sales Credit Notes. Supports OData querying…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/sales-get`

### Returns a list of company's Sales Credit Notes. Supports OData querying protocol. Filtering is allowed by…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/sales-credit-notes-get`

### Creates a new Sales Credit Note.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/sales-credit-notes-post`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Processes a batch of Sales Credit Notes.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/sales-credit-notes-process-batch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Returns information about a single Sales Credit Note.
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/get-v1-sales-credit-notes-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Sales Credit Note to return. |

### Updates an existing Sales Credit Note.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/sales-credit-notes-put`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Sales Credit Note to update. |
| body | object | yes | JSON request body |

### Removes an existing Sales Credit Note.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/sales-credit-notes-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Sales Credit Note to remove. |
| timestamp | string | yes | Timestamp of Sales Credit Note to remove. Should be encoded in Base64. |

### Returns a list of company's Sales Entries. Supports OData querying protocol. Filtering is allowed by…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/sales-entries-get`

### Creates a new Sales Entry.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/sales-entries-post`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Processes a batch of Sales Entries.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/sales-entries-process-batch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Returns information about a single Sales Entry.
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/get-v1-sales-entries-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Sales Entry to return. |

### Updates an existing Sales Entry.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/sales-entries-put`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Sales Entry to update. |
| body | object | yes | JSON request body |

### Removes an existing Sales Entry.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/sales-entries-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Sales Entry to remove. |
| timestamp | string | yes | Timestamp of Sales Entry to remove. Should be encoded in Base64. |

### Returns a list of company's Sales Invoices. Supports OData querying protocol. Filtering is allowed by…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/sales-invoices-get`

### Creates a new Sales Invoice.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/sales-invoices-post`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Processes a batch of Sales Invoices.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/sales-invoices-process-batch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Creates a new Sale Invoice with auto generating reference.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/sales-invoices-post-create-sale-invoice-with-generating-refe`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Returns information about a single Sales Invoice.
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/get-v1-sales-invoices-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Sales Invoice to return. |

### Updates an existing Sales Invoice.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/sales-invoices-put`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Sales Invoice to update. |
| body | object | yes | JSON request body |

### Removes an existing Sales Invoice.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/sales-invoices-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Sales Invoice to remove. |
| timestamp | string | yes | Timestamp of Sales Invoice to remove. Should be encoded in Base64. |

### Returns a list of company's SaleRep. Filtering is forbidden. Ordering is allowed by "id".
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/sales-rep-get`

### Creates a new SaleRep.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/sales-rep-post`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Processes a batch of Sale Rep.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/sales-rep-process-batch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Returns information about a single SaleRep.
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/get-v1-sales-reps-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Sale Rep to return. |

### Updates an existing Sale Rep.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/sales-rep-put`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Sale Rep to update. |
| body | object | yes | JSON request body |

### Removes an existing Sale Rep.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/sales-rep-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Sale Rep to remove. |
| timestamp | string | yes | Timestamp of Sale Rep to remove. Should be encoded in Base64. |

### Returns a list of company's Suppliers. Supports OData querying protocol. Filtering is forbidden. Ordering is…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/suppliers-get`

### Creates a new Supplier.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/suppliers-post`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Processes a batch of Suppliers.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/suppliers-process-batch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Returns information about a single Supplier. You may specify that Supplier's ledger balance should be…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/get-v1-suppliers-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Supplier to return. |
| needBalance | boolean | no | If "true" then Supplier's ledger balance will be calculated; otherwise balance will be returned as 0. |

### Updates an existing Supplier.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/suppliers-put`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Supplier to update. |
| body | object | yes | JSON request body |

### Removes an existing Supplier.
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/suppliers-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of Supplier to remove. |
| timestamp | string | yes | Timestamp of Supplier to remove. Should be encoded in Base64. |

### Returns a list of Supplier's account transactions.
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/suppliers-get-account-trans`

| Parameter | Type | Required | Description |
|---|---|---|---|
| itemId | integer | yes | Id of Supplier to return account transaction. |

### Returns a Supplier's opening balances, calculated for the next periods: current month, one month old, two…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/suppliers-get-opening-balance`

| Parameter | Type | Required | Description |
|---|---|---|---|
| itemId | integer | yes | Id of Supplier to return opening balances. |

### Returns a list of Supplier's opening balance transactions.
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/suppliers-get-opening-balance-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| itemId | integer | yes | Id of Supplier to return opening balances transaction. |

### Returns a list of company's User Defined Fields. Supports OData querying protocol. Filtering is allowed by…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/user-defined-fields-get`

### Returns a list of global Vat Analysis Types. Supports OData querying protocol. Filtering is forbidden.…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/vat-analysis-types-get`

### Returns a list of global Vat Categories. Supports OData querying protocol. Filtering is forbidden. Ordering…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/vat-categories-get`

### Process Vat Rates
`POST https://zieapi.vercel.app/v1/finance:bigredcloud/vat-categories-process-vat-rates`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Returns a list of company's Vat Rates. Supports OData querying protocol. Filtering is allowed by…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/vat-rates-get`

### Returns a list of global Vat Types. Supports OData querying protocol. Filtering is forbidden. Ordering is…
`GET https://zieapi.vercel.app/v1/finance:bigredcloud/vat-types-get`

## Example
```
curl "https://zieapi.vercel.app/v1/finance:bigredcloud/accounts-get" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the Big Red Cloud API API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/finance:bigredcloud/accounts-get with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Big Red Cloud API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the Big Red Cloud API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key finance:bigredcloud.

### What is the status of the Big Red Cloud API API?
Live: works with just an Apizie key