Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
API Reference
Create Grouped Product
Search
JUMP TO
General
Introduction
Authentication
HTTP Methods
Environments
Error Codes
Pagination, Sorting and Filtering
Rate limits
Testing your webhook
User Feedback
Invoice
Create an Invoice
post
Create and optionally send an invoice
post
Send invoice (PDF)
post
Get List of Invoices
get
Get a Single Invoice
get
Preview invoice (PDF)
get
Update an invoice
patch
Update and Send Invoice PDF
get
Add an Invoice Product
post
Edit an Invoice Product
patch
Remove an Invoice Product
delete
Get an invoice Product list
patch
Remove an invoice
delete
Create Recurring Schedule
post
Update Recurring Schedule
patch
Customer
Create Customer
post
Upload/import customers
post
Export customers
get
Get customer by id
get
Update customer
patch
Toggle Customer Status
post
Delete Customer
delete
Get Customers
get
Vendor
Create Vendor
post
Upload/import vendors record
post
Get vendors List
get
Download All vendors record
get
Get a single Vendor details
get
Update a Vendors Record
patch
Toggle vendor status
post
Services
Service Category
Create Service Category
post
Get All Service Categories
get
Delete Service Category
patch
Create service
post
Get All Service
get
Update Service
patch
Get a Service Details
get
Delete a Service
delete
Delete Bulk Services
delete
Product
Variable Product
Regenerate Product Variations
post
Update product variation
patch
Delete Product Variation
delete
Product Category
Create Product Category
post
Get All Product Categories
get
Update Product Category
patch
Delete Product Category
delete
Product Distribution
Add product distribution
post
Edit product distribution
patch
Remove product distribution
delete
Product Pricing Distribution
Add pricing distribution
post
Edit pricing distribution
patch
Remove pricing distribution
delete
Get All Products
get
Export Products
get
Bulk Delete Product
delete
Single Product
Create Product
post
Get Variable Product
get
Update Product
patch
Grouped Product
Create Grouped Product
get
Expenses
Create Expense
post
Get All Expenses
get
Get Expense
get
Get Expense Categories
get
Update Expense
patch
Delete Expense
delete
Expense Procurement
Add Expense Procurement
post
Update Expense Procurement
patch
Delete Expense Procurement
delete
Expense Payment
Record Expense Payment
post
Remove Expense payment
delete
Point of sales (POS)
Create Point of Sale (POS)
post
Add Pos Payment
post
Add Service Procurement to Existing POS Order
post
Add Product Procurement to Existing POS Order
post
Send POS Procurement To Kitchen
post
Get All POS
get
Get a POS By Either Customer Name or PosId
get
Get Customer View
get
Get Kitchen List
get
Update POS
patch
Update POS Procurement
patch
Void POS
patch
Toggle Kitchen POS
patch
Bulk Delete POS
delete
Remove Procurement
delete
Remove POS Payment
delete
Purchase Order
Create Purchase Order
post
Add Purchase-Order Procurement
post
Record Purchase Order Payment
post
Get All Purchase Order
get
Get One Purchase Order
get
Export Purchase Order payment
get
Update Purchase Order
patch
Update Purchase Order procurement
patch
Remove Purchase Order
delete
Remove Purchase Order-Procurement
delete
Remove Purchase Order payment
delete
Additional Revenue
Additional Revenue Category
Create Additional-Revenue Category
post
Get Revenue Category
get
Get Revenue Categories List
get
Update Additional-Revenue Category
patch
Remove Additional-Revenue Category
delete
Add Additional Revenue
post
Get Additional Revenue
get
Get Additional Revenue List
get
Export Additional Revenue List
get
Update Additional Revenue
patch
Delete Additional Revenue
delete
Wallet
Get Wallet Details
get
Get Transaction Details
get
Get Wallet Transactions
get
Export Wallet Transactions
get
Fund wallet
post
Transfer to Business Wallet
post
Business to personal Wallet Transfer
post
Transfer to External bank account
post
Get Platform Charges
get
Get debit transaction receipt
get
Analytics
Profit And Loss
get
Sales and income
get
Performance Overview
get
Total Payment Distribution
get
Get Order by Team
get
Leaderboard
get
Banking and wallet
get
Get CPV
get
Accounting
Generate Profits-And-Loss Pdf
get
Generate Profits-And-Loss Excel
get
Generate Balance sheet pdf
get
Generate Balance sheet Excel
get
Generate Cash Flow Pdf
get
Generate Cash Flow Excel
get
Payment link
Create Payment Link
post
Create Payment Link Category
post
Pay
post
Get All Payment Links
get
Get All Payments
get
Validate Payment Link
get
Update Payment Link
patch
Delete Payment Link
delete
Remove payment link Category
delete
Beneficiaries
Wallet
Create Beneficiary
post
Get beneficiary list
get
Get Beneficiary By Id
get
Update Beneficiary
patch
Remove Beneficiary
delete
Bills
Create Bill Beneficiary
post
Get Bill Beneficiary
get
Get Bill Beneficiary List
get
Update Bill Beneficiary
patch
Remove bill beneficiary
delete
Bills Payment
Create a Bill Category
post
Get Bills Categories
get
Get a Single Bill Category
get
update a Bill Category
patch
Delete a Bill Category
delete
Get Billers
get
Get Biller Product
get
Validate Biller
get
Pay Bill
post
Branch
Create Branch
post
Get branches
get
Update Branch
patch
Archive branch by id
delete
Partner
Add Partner Account
post
Get Partner Accounts
get
Update Partner Account
patch
Update Active Partner Account
patch
Remove Partner Account
delete
Tables
Create Table
post
Get Table
get
Get Table list
get
Update Table
patch
Remove Table
delete
Business
Invite to Join Business
post
Invite Partner
post
Change Team Member Role
post
Update Team Member's Assigned Branches
post
Un-invite from Business
post
Add Bank Account
post
Verify Business by RC Number
post
Add Tax Listing
post
Setup Transaction Pin
post
Set Revenue Goal
post
Save Business Loyalty point
post
Get Team members
get
Get Partners
get
Get Partner Details
get
Get Managed Business
get
Get Owned Businesses
get
Get Business as Employee
get
Get Business Categories
get
Get Business List
get
Get Businesses List
get
Get User's Ghost Business
get
Get All Bank Accounts
get
Get Team Member By Email
get
Get Recent Transactions
get
Get Getting Started Issues
get
Get All Tax Listing
get
Verify Transaction Pin
get
Get Revenue Goal
get
Get Purchase Plan Histories
get
Get Business Loyalty Summary
get
Update Invited Partner
patch
Update Account details
patch
Select Active Bank Account
patch
Update Business Info
patch
Set Branch HQ
patch
Change Transaction Pin
patch
Remove bank account
delete
Delete Invited Partner
delete
Powered by
Create Grouped Product
get
https://api-sandbox.branddrive.co/api/v1
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
RESPONSE
Click
Try It!
to start a request and see the response here!