Big Red Cloud API

Big Red Cloud API

API version: v1

Auth

ApiKey (inferred from docs)

Base URL

https://app.bigredcloud.com/api

Setup

1. Set your API key in the appropriate header
2. GET /v1/accounts -- verify access
3. POST /v1/bankAccounts -- create first bankAccounts

Endpoints

120 endpoints across 30 groups. See references/api-spec.lap for full details.

accounts

analysisCategories

bankAccounts

bookTranTypes

cashPayments

cashReceipts

categoryTypes

companySettings

companySetupConfig

customers

email

nominalAccounts

ownerTypeGroups

ownerTypes

payments

products

productTypes

purchases

quotes

sales

salesCreditNotes

salesEntries

salesInvoices

salesReps

suppliers

userDefinedFields

vatAnalysisTypes

vatCategories

vatRates

vatTypes

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all accounts?" -> GET /v1/accounts
• "List all analysisCategories?" -> GET /v1/analysisCategories
• "List all bankAccounts?" -> GET /v1/bankAccounts
• "Create a bankAccount?" -> POST /v1/bankAccounts
• "Get bankAccount details?" -> GET /v1/bankAccounts/{id}
• "Update a bankAccount?" -> PUT /v1/bankAccounts/{id}
• "Delete a bankAccount?" -> DELETE /v1/bankAccounts/{id}
• "List all bookTranTypes?" -> GET /v1/bookTranTypes
• "List all cashPayments?" -> GET /v1/cashPayments
• "Create a cashPayment?" -> POST /v1/cashPayments
• "Get cashPayment details?" -> GET /v1/cashPayments/{id}
• "Update a cashPayment?" -> PUT /v1/cashPayments/{id}
• "Delete a cashPayment?" -> DELETE /v1/cashPayments/{id}
• "List all cashReceipts?" -> GET /v1/cashReceipts
• "Create a cashReceipt?" -> POST /v1/cashReceipts
• "Get cashReceipt details?" -> GET /v1/cashReceipts/{id}
• "Update a cashReceipt?" -> PUT /v1/cashReceipts/{id}
• "Delete a cashReceipt?" -> DELETE /v1/cashReceipts/{id}
• "List all categoryTypes?" -> GET /v1/categoryTypes
• "List all companySettings?" -> GET /v1/companySettings
• "List all companySetupConfig?" -> GET /v1/companySetupConfig
• "List all getFinancialYear?" -> GET /v1/companySetupConfig/getFinancialYear
• "List all getCompanyOptions?" -> GET /v1/companySetupConfig/getCompanyOptions
• "List all getCompanyLogo?" -> GET /v1/companySetupConfig/getCompanyLogo
• "List all customers?" -> GET /v1/customers
• "Create a customer?" -> POST /v1/customers
• "Get customer details?" -> GET /v1/customers/{id}
• "Update a customer?" -> PUT /v1/customers/{id}
• "Delete a customer?" -> DELETE /v1/customers/{id}
• "List all GetWithoutDormant?" -> GET /v1/customers/GetWithoutDormant
• "List all openingBalance?" -> GET /v1/customers/{itemId}/openingBalance
• "List all openingBalanceList?" -> GET /v1/customers/{itemId}/openingBalanceList
• "List all accountTrans?" -> GET /v1/customers/{itemId}/accountTrans
• "List all quotes?" -> GET /v1/customers/{itemId}/quotes
• "Create a sendSalesInvoice?" -> POST /v1/email/sendSalesInvoice
• "Create a sendEmailStatement?" -> POST /v1/email/sendEmailStatement
• "Create a sendQuote?" -> POST /v1/email/sendQuote
• "List all nominalAccounts?" -> GET /v1/nominalAccounts
• "Get nominalAccount details?" -> GET /v1/nominalAccounts/{id}
• "List all ledger?" -> GET /v1/nominalAccounts/ledger
• "Get ledger details?" -> GET /v1/nominalAccounts/ledger/{ids}
• "List all ownerTypeGroups?" -> GET /v1/ownerTypeGroups
• "List all ownerTypes?" -> GET /v1/ownerTypes
• "List all payments?" -> GET /v1/payments
• "Create a payment?" -> POST /v1/payments
• "Get payment details?" -> GET /v1/payments/{id}
• "Update a payment?" -> PUT /v1/payments/{id}
• "Delete a payment?" -> DELETE /v1/payments/{id}
• "List all products?" -> GET /v1/products
• "Create a product?" -> POST /v1/products
• "Get product details?" -> GET /v1/products/{id}
• "Update a product?" -> PUT /v1/products/{id}
• "Delete a product?" -> DELETE /v1/products/{id}
• "List all GetWithoutDormant?" -> GET /v1/products/GetWithoutDormant
• "List all productTypes?" -> GET /v1/productTypes
• "List all purchases?" -> GET /v1/purchases
• "Create a purchase?" -> POST /v1/purchases
• "Get purchase details?" -> GET /v1/purchases/{id}
• "Update a purchase?" -> PUT /v1/purchases/{id}
• "Delete a purchase?" -> DELETE /v1/purchases/{id}
• "Create a createPurchaseWithGeneratingReference?" -> POST /v1/purchases/createPurchaseWithGeneratingReference
• "List all quotes?" -> GET /v1/quotes
• "Create a quote?" -> POST /v1/quotes
• "Get quote details?" -> GET /v1/quotes/{id}
• "Update a quote?" -> PUT /v1/quotes/{id}
• "Delete a quote?" -> DELETE /v1/quotes/{id}
• "Update a close?" -> PUT /v1/quotes/close/{id}
• "Update a reopen?" -> PUT /v1/quotes/reopen/{id}
• "Create a generateSaleInvoice?" -> POST /v1/quotes/generateSaleInvoice
• "Create a createQuoteWithGeneratingReference?" -> POST /v1/quotes/createQuoteWithGeneratingReference
• "List all sales?" -> GET /v1/sales
• "List all salesCreditNotes?" -> GET /v1/salesCreditNotes
• "Create a salesCreditNote?" -> POST /v1/salesCreditNotes
• "Get salesCreditNote details?" -> GET /v1/salesCreditNotes/{id}
• "Update a salesCreditNote?" -> PUT /v1/salesCreditNotes/{id}
• "Delete a salesCreditNote?" -> DELETE /v1/salesCreditNotes/{id}
• "Create a createCreditNoteWithGeneratingReference?" -> POST /v1/salesCreditNotes/createCreditNoteWithGeneratingReference
• "List all salesEntries?" -> GET /v1/salesEntries
• "Create a salesEntry?" -> POST /v1/salesEntries
• "Get salesEntry details?" -> GET /v1/salesEntries/{id}
• "Update a salesEntry?" -> PUT /v1/salesEntries/{id}
• "Delete a salesEntry?" -> DELETE /v1/salesEntries/{id}
• "List all salesInvoices?" -> GET /v1/salesInvoices
• "Create a salesInvoice?" -> POST /v1/salesInvoices
• "Get salesInvoice details?" -> GET /v1/salesInvoices/{id}
• "Update a salesInvoice?" -> PUT /v1/salesInvoices/{id}
• "Delete a salesInvoice?" -> DELETE /v1/salesInvoices/{id}
• "Create a createSaleInvoiceWithGeneratingReference?" -> POST /v1/salesInvoices/createSaleInvoiceWithGeneratingReference
• "List all salesReps?" -> GET /v1/salesReps
• "Create a salesRep?" -> POST /v1/salesReps
• "Get salesRep details?" -> GET /v1/salesReps/{id}
• "Update a salesRep?" -> PUT /v1/salesReps/{id}
• "Delete a salesRep?" -> DELETE /v1/salesReps/{id}
• "List all suppliers?" -> GET /v1/suppliers
• "Create a supplier?" -> POST /v1/suppliers
• "Get supplier details?" -> GET /v1/suppliers/{id}
• "Update a supplier?" -> PUT /v1/suppliers/{id}
• "Delete a supplier?" -> DELETE /v1/suppliers/{id}
• "List all openingBalance?" -> GET /v1/suppliers/{itemId}/openingBalance
• "List all openingBalanceList?" -> GET /v1/suppliers/{itemId}/openingBalanceList
• "List all accountTrans?" -> GET /v1/suppliers/{itemId}/accountTrans
• "List all userDefinedFields?" -> GET /v1/userDefinedFields
• "List all vatAnalysisTypes?" -> GET /v1/vatAnalysisTypes
• "List all vatCategories?" -> GET /v1/vatCategories
• "Create a vatRate?" -> POST /v1/vatCategories/vatRates
• "List all vatRates?" -> GET /v1/vatRates
• "List all vatTypes?" -> GET /v1/vatTypes
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP