Jump to Content

v1.0

API Reference

v1.0API Reference

General

Introduction
Authentication
HTTP Methods
Environments
Error Codes
Pagination, Sorting and Filtering
Rate limits
Testing your webhook
User Feedback

Invoice

Create an Invoicepost
Create and optionally send an invoicepost
Send invoice (PDF)post
Get List of Invoicesget
Get a Single Invoiceget
Preview invoice (PDF)get
Update an invoicepatch
Update and Send Invoice PDFget
Add an Invoice Productpost
Edit an Invoice Productpatch
Remove an Invoice Productdelete
Get an invoice Product listpatch
Remove an invoicedelete
Create Recurring Schedulepost
Update Recurring Schedulepatch

Customer

Create Customerpost
Upload/import customerspost
Export customersget
Get customer by idget
Update customerpatch
Toggle Customer Statuspost
Delete Customerdelete
Get Customersget

Vendor

Create Vendorpost
Upload/import vendors recordpost
Get vendors Listget
Download All vendors recordget
Get a single Vendor detailsget
Update a Vendors Recordpatch
Toggle vendor statuspost

Services

Service Category
Create servicepost
Get All Serviceget
Update Servicepatch
Get a Service Detailsget
Delete a Servicedelete
Delete Bulk Servicesdelete

Product

Variable Product
Product Category
Product Distribution
Product Pricing Distribution
Get All Productsget
Export Productsget
Bulk Delete Productdelete
Single Product
Grouped Product
- Create Grouped Productget

Expenses

Create Expensepost
Get All Expensesget
Get Expenseget
Get Expense Categoriesget
Update Expensepatch
Delete Expensedelete
Expense Procurement
Expense Payment
- Record Expense Paymentpost
- Remove Expense paymentdelete

Point of sales (POS)

Create Point of Sale (POS)post
Add Pos Paymentpost
Add Service Procurement to Existing POS Orderpost
Add Product Procurement to Existing POS Orderpost
Send POS Procurement To Kitchenpost
Get All POSget
Get a POS By Either Customer Name or PosIdget
Get Customer Viewget
Get Kitchen Listget
Update POSpatch
Update POS Procurementpatch
Void POSpatch
Toggle Kitchen POSpatch
Bulk Delete POSdelete
Remove Procurementdelete
Remove POS Paymentdelete

Purchase Order

Create Purchase Orderpost
Add Purchase-Order Procurementpost
Record Purchase Order Paymentpost
Get All Purchase Orderget
Get One Purchase Orderget
Export Purchase Order paymentget
Update Purchase Orderpatch
Update Purchase Order procurementpatch
Remove Purchase Orderdelete
Remove Purchase Order-Procurementdelete
Remove Purchase Order paymentdelete

Additional Revenue

Additional Revenue Category
Add Additional Revenuepost
Get Additional Revenueget
Get Additional Revenue Listget
Export Additional Revenue Listget
Update Additional Revenuepatch
Delete Additional Revenuedelete

Wallet

Get Wallet Detailsget
Get Transaction Detailsget
Get Wallet Transactionsget
Export Wallet Transactionsget
Fund walletpost
Transfer to Business Walletpost
Business to personal Wallet Transferpost
Transfer to External bank accountpost
Get Platform Chargesget
Get debit transaction receiptget

Analytics

Profit And Lossget
Sales and incomeget
Performance Overviewget
Total Payment Distributionget
Get Order by Teamget
Leaderboardget
Banking and walletget
Get CPVget

Accounting

Generate Profits-And-Loss Pdfget
Generate Profits-And-Loss Excelget
Generate Balance sheet pdfget
Generate Balance sheet Excelget
Generate Cash Flow Pdfget
Generate Cash Flow Excelget

Payment link

Create Payment Linkpost
Create Payment Link Categorypost
Paypost
Get All Payment Linksget
Get All Paymentsget
Validate Payment Linkget
Update Payment Linkpatch
Delete Payment Linkdelete
Remove payment link Categorydelete

Beneficiaries

Wallet
Bills

Bills Payment

Create a Bill Categorypost
Get Bills Categoriesget
Get a Single Bill Categoryget
update a Bill Categorypatch
Delete a Bill Categorydelete
Get Billersget
Get Biller Productget
Validate Billerget
Pay Billpost

Branch

Create Branchpost
Get branchesget
Update Branchpatch
Archive branch by iddelete

Partner

Add Partner Accountpost
Get Partner Accountsget
Update Partner Accountpatch
Update Active Partner Accountpatch
Remove Partner Accountdelete

Tables

Create Tablepost
Get Tableget
Get Table listget
Update Tablepatch
Remove Tabledelete

Business

Invite to Join Businesspost
Invite Partnerpost
Change Team Member Rolepost
Update Team Member's Assigned Branchespost
Un-invite from Businesspost
Add Bank Accountpost
Verify Business by RC Numberpost
Add Tax Listingpost
Setup Transaction Pinpost
Set Revenue Goalpost
Save Business Loyalty pointpost
Get Team membersget
Get Partnersget
Get Partner Detailsget
Get Managed Businessget
Get Owned Businessesget
Get Business as Employeeget
Get Business Categoriesget
Get Business Listget
Get Businesses Listget
Get User's Ghost Businessget
Get All Bank Accountsget
Get Team Member By Emailget
Get Recent Transactionsget
Get Getting Started Issuesget
Get All Tax Listingget
Verify Transaction Pinget
Get Revenue Goalget
Get Purchase Plan Historiesget
Get Business Loyalty Summaryget
Update Invited Partnerpatch
Update Account detailspatch
Select Active Bank Accountpatch
Update Business Infopatch
Set Branch HQpatch
Change Transaction Pinpatch
Remove bank accountdelete
Delete Invited Partnerdelete

Powered by

General

Introduction
Authentication
HTTP Methods
Environments
Error Codes
Pagination, Sorting and Filtering
Rate limits
Testing your webhook
User Feedback

Invoice

Create an Invoicepost
Create and optionally send an invoicepost
Send invoice (PDF)post
Get List of Invoicesget
Get a Single Invoiceget
Preview invoice (PDF)get
Update an invoicepatch
Update and Send Invoice PDFget
Add an Invoice Productpost
Edit an Invoice Productpatch
Remove an Invoice Productdelete
Get an invoice Product listpatch
Remove an invoicedelete
Create Recurring Schedulepost
Update Recurring Schedulepatch

Customer

Create Customerpost
Upload/import customerspost
Export customersget
Get customer by idget
Update customerpatch
Toggle Customer Statuspost
Delete Customerdelete
Get Customersget

Vendor

Create Vendorpost
Upload/import vendors recordpost
Get vendors Listget
Download All vendors recordget
Get a single Vendor detailsget
Update a Vendors Recordpatch
Toggle vendor statuspost

Services

Service Category
Create servicepost
Get All Serviceget
Update Servicepatch
Get a Service Detailsget
Delete a Servicedelete
Delete Bulk Servicesdelete

Product

Variable Product
Product Category
Product Distribution
Product Pricing Distribution
Get All Productsget
Export Productsget
Bulk Delete Productdelete
Single Product
Grouped Product
- Create Grouped Productget

Expenses

Create Expensepost
Get All Expensesget
Get Expenseget
Get Expense Categoriesget
Update Expensepatch
Delete Expensedelete
Expense Procurement
Expense Payment
- Record Expense Paymentpost
- Remove Expense paymentdelete

Point of sales (POS)

Create Point of Sale (POS)post
Add Pos Paymentpost
Add Service Procurement to Existing POS Orderpost
Add Product Procurement to Existing POS Orderpost
Send POS Procurement To Kitchenpost
Get All POSget
Get a POS By Either Customer Name or PosIdget
Get Customer Viewget
Get Kitchen Listget
Update POSpatch
Update POS Procurementpatch
Void POSpatch
Toggle Kitchen POSpatch
Bulk Delete POSdelete
Remove Procurementdelete
Remove POS Paymentdelete

Purchase Order

Create Purchase Orderpost
Add Purchase-Order Procurementpost
Record Purchase Order Paymentpost
Get All Purchase Orderget
Get One Purchase Orderget
Export Purchase Order paymentget
Update Purchase Orderpatch
Update Purchase Order procurementpatch
Remove Purchase Orderdelete
Remove Purchase Order-Procurementdelete
Remove Purchase Order paymentdelete

Additional Revenue

Additional Revenue Category
Add Additional Revenuepost
Get Additional Revenueget
Get Additional Revenue Listget
Export Additional Revenue Listget
Update Additional Revenuepatch
Delete Additional Revenuedelete

Wallet

Get Wallet Detailsget
Get Transaction Detailsget
Get Wallet Transactionsget
Export Wallet Transactionsget
Fund walletpost
Transfer to Business Walletpost
Business to personal Wallet Transferpost
Transfer to External bank accountpost
Get Platform Chargesget
Get debit transaction receiptget

Analytics

Profit And Lossget
Sales and incomeget
Performance Overviewget
Total Payment Distributionget
Get Order by Teamget
Leaderboardget
Banking and walletget
Get CPVget

Accounting

Generate Profits-And-Loss Pdfget
Generate Profits-And-Loss Excelget
Generate Balance sheet pdfget
Generate Balance sheet Excelget
Generate Cash Flow Pdfget
Generate Cash Flow Excelget

Payment link

Create Payment Linkpost
Create Payment Link Categorypost
Paypost
Get All Payment Linksget
Get All Paymentsget
Validate Payment Linkget
Update Payment Linkpatch
Delete Payment Linkdelete
Remove payment link Categorydelete

Beneficiaries

Wallet
Bills

Bills Payment

Create a Bill Categorypost
Get Bills Categoriesget
Get a Single Bill Categoryget
update a Bill Categorypatch
Delete a Bill Categorydelete
Get Billersget
Get Biller Productget
Validate Billerget
Pay Billpost

Branch

Create Branchpost
Get branchesget
Update Branchpatch
Archive branch by iddelete

Partner

Add Partner Accountpost
Get Partner Accountsget
Update Partner Accountpatch
Update Active Partner Accountpatch
Remove Partner Accountdelete

Tables

Create Tablepost
Get Tableget
Get Table listget
Update Tablepatch
Remove Tabledelete

Business

Invite to Join Businesspost
Invite Partnerpost
Change Team Member Rolepost
Update Team Member's Assigned Branchespost
Un-invite from Businesspost
Add Bank Accountpost
Verify Business by RC Numberpost
Add Tax Listingpost
Setup Transaction Pinpost
Set Revenue Goalpost
Save Business Loyalty pointpost
Get Team membersget
Get Partnersget
Get Partner Detailsget
Get Managed Businessget
Get Owned Businessesget
Get Business as Employeeget
Get Business Categoriesget
Get Business Listget
Get Businesses Listget
Get User's Ghost Businessget
Get All Bank Accountsget
Get Team Member By Emailget
Get Recent Transactionsget
Get Getting Started Issuesget
Get All Tax Listingget
Verify Transaction Pinget
Get Revenue Goalget
Get Purchase Plan Historiesget
Get Business Loyalty Summaryget
Update Invited Partnerpatch
Update Account detailspatch
Select Active Bank Accountpatch
Update Business Infopatch
Set Branch HQpatch
Change Transaction Pinpatch
Remove bank accountdelete
Delete Invited Partnerdelete

Powered by

Get All Service

get https://api-sandbox.branddrive.co/api/v1/services

Language

Credentials

Header

Click Try It! to start a request and see the response here!