Cantant
  1. Add User
Cantant
  • Adonis cantant v1
    • Auth
      • Add User
        • OWNER
          POST
        • STAFF
          POST
        • MANAGER
          POST
        • PARTNER
          POST
      • Register
        POST
      • Login
        POST
      • Admin login as user
        POST
      • Validate email
        POST
      • Request OTP
        POST
      • Validate OTP
        POST
      • Validate Passcode
        POST
      • Reset passcode
        POST
      • Validate business info
        POST
      • Logout
        POST
      • check for invitation
        POST
      • UnSubscribe Email
        GET
      • Subscribe Email
        GET
      • Ably Auth
        GET
    • Profile
      • Get Profile
      • Delete Account
      • Update profile
      • update profile image
      • Change passcode
      • unSubscribe newsletter
      • subscribe to newsletter
      • Is Valid Mongo ID
    • Business
      • Payment Note
        • Get payment note
        • Save payment note
      • Tax
        • update tax
        • get tax
      • Business Information
      • Business Periodic Report
      • Business Types
      • update business
      • Update Logo
      • create new business
      • get all businesses
      • Get default business
      • Change default business
      • merge businesses otp
      • merge business
      • Change business staff role
      • Get business staff activities
      • Get Businesses Staff
      • Delete My Business
      • Account Businesses
      • download data
    • Bank Details
      • update bank details
      • get bank details
    • Add User
      • Add Staff
        • send-invitation
        • cancel invitation
        • reject invitation
        • validate invitation code
        • complete registration
        • resend invitation code
        • accept invitation
        • get staffs and invitations
        • Get Business Staffs
        • get staff notification
        • remove staff
        • accept expense
        • reject expense
        • get user role
      • add staff
      • validate staff
      • complete staff signup
      • Get Staff Activities
    • Devices & App Version
      • Get Devices
      • Create Device
      • Delete device
      • Get App Version
      • Get App Command
      • Store app version
      • Reset last sync
      • Set last sync
    • Expenses
      • Get Categories
      • Add Categories
    • Fundings
      • Get Categories
    • Sync
      • Sync Down
      • Sync Down All
      • Sync Up
      • Sync Up Full Transaction
      • Sync Up Multiple Tables
      • Sync Up Full Products
      • Sync Delete
      • Sync Delete Bulk
      • Sync Up Event Logs
      • Sync Up Bulk
      • Sync deleted
    • Notifications
      • Get Notifications
      • Get Countries
    • ErrorLogs
      • Get All error Logs
      • Create ErrorLog
      • Delete ErrorLog
      • Send Error Log to Dev
    • Admin
      • Auth
        • login
        • Impersonate user
      • User
        • get users
        • get trashed user
        • restore deleted user
        • get user
        • make user admin
        • Search Users
        • Search Users Copy
        • Create Business For Users
        • convertToParsable
        • Generate passcode (For admin login as user)
        • Get Users Count By month
        • Get User Data
        • Get User Businesses
        • Get User Businesses Data
        • Ban user
        • Clear business data
      • Transactions
        • get transactions
        • get transaction
        • Search Transactions
        • Get Transaction By Currency
        • Get Sales and Expenses By Month
        • Get Transactions By Month
        • Get Product and Services count By Month
        • Start Pdf Processing
        • Get Pdf
        • GetTransaction Processing
        • Get Transaction report (PDF)
      • Products
        • get products
        • get products Copy
        • get product
        • Search Products
      • Admin-Notifications
        • get notifications
      • Notifications
        • Get Notifications
        • Create Notifications
        • Send Notification
        • Send Notification To Device
        • Delete Notification
        • Get Countries
      • Data
        • get genders
        • get currency in last 6 months
        • get 6 months transactions of currency
      • Sales
        • Get Sales
        • Get Sale
        • Search Sales
        • Get Sales By Currency
        • Sales By Month
        • {{BASE}}/admin/get-sale-by-currency?currency=NGN
      • Expenses
        • Get Expenses
        • Get Expense
        • Search Expenses
        • Get Expense By Currency
        • Get Expenses By month
      • Services
        • Get Services
        • Get Services
        • Search Services
        • Get Service By Currency
      • Device
        • Get Devices
        • Send device command
        • Send user device command
      • ErrorNotifiers
        • Get all error notifiers
        • Create ErrorNotifier
        • Update ErrorNotifier
        • Delete ErrorNotifier
      • Video Tutorial
        • Save Video Tutorial
        • Delete Video Tutorial
      • Business Data Integrity
        • Reparse tables
        • Parse tables
        • Run Data Integrity Check
        • Periodic app report
        • Personality
        • Trigger Recurring Budgets
      • Subscriptions
        • Generate user plan transaction receipt
        • Check Renew Subscription
      • Business
        • Convert data to parsable raw
        • Restore deleted business
    • Feedback
      • Create Feedback
      • Get All feedbacks
      • Delete Feedback
    • Webhooks
      • Sendgrid
    • Email Logs
      • Get logs
    • Bulk Process
      • Upload
      • process pdf transaction history
      • Product Bulk Upload
      • Service Upload
      • Get Transaction History
      • get transaction processes
      • New Request
      • Confirm Product/Service Upload
      • Confirm Product/Service Upload Staging
      • Product Bulk Process Staging
      • Get Last Uploaded Product
      • Get Latest Bulk Process
      • Product Upload History
      • Product Upload History Staging
    • Video Tutorial
      • Get Tutorials
      • Get Tutorials Grouped by Category
      • Get Tutorials With Category
    • Permissions
      • Add Permission
      • Get All Permissions
      • Add Permission Roles
      • Get Role Permissions
      • Get Role Names
      • Delete Role Permissions
      • Add Api Permissions
      • Get All Api Permissions
      • Delete Api Permissions
      • {{BASE_URL}}/permissions/add-permission
    • Transaction
      • Get Transaction History
      • Get Transaction Short URL
      • Get Transaction Report
      • Create Transaction
      • Update Transaction
      • Edit transaction
    • Subscription
      • Tier
        • create a tier
        • get tiers
      • User Subscription
        • add user subscription
        • Verify Android Subscription
        • Verify iOS Subscription
        • Get user subscription
      • Charge paystack auth code
      • Get subscription info
      • Get iOS Notification History
      • Get iOS Transaction History
      • Get iOS Subscription Status
      • Get iOS TransactionInfo
      • Request iOS Notification
      • TEST WEBHOOK
    • Product
      • Change product variant stock
      • Update product
    • Gen AI
      • Generate
      • Chat sessions
      • Chat history
    • home
      GET
    • Send File
      GET
  • Adonis Fince AI v1
    • Auth
      • Add User
        • OWNER
        • STAFF
        • MANAGER
        • PARTNER
      • Register
      • Login
      • Admin login as user
      • Validate email
      • Request OTP
      • Validate OTP
      • Validate Passcode
      • Reset passcode
      • Validate business info
      • Logout
      • check for invitation
      • UnSubscribe Email
      • Subscribe Email
      • Ably Auth
    • Profile
      • Get Profile
      • Delete Account
      • Update profile
      • update profile image
      • Change passcode
      • unSubscribe newsletter
      • subscribe to newsletter
      • Is Valid Mongo ID
    • Business
      • Payment Note
        • Get payment note
        • Save payment note
      • Tax
        • update tax
        • get tax
      • Business Information
      • Business Periodic Report
      • Business Types
      • update business
      • Update Logo
      • create new business
      • get all businesses
      • Get default business
      • Change default business
      • merge businesses otp
      • merge business
      • Change business staff role
      • Get business staff activities
      • Get Businesses Staff
      • Delete My Business
      • Account Businesses
      • download data
    • Bank Details
      • update bank details
      • get bank details
    • Add User
      • Add Staff
        • send-invitation
        • cancel invitation
        • reject invitation
        • validate invitation code
        • complete registration
        • resend invitation code
        • accept invitation
        • get staffs and invitations
        • Get Business Staffs
        • get staff notification
        • remove staff
        • accept expense
        • reject expense
        • get user role
      • add staff
      • validate staff
      • complete staff signup
      • Get Staff Activities
    • Devices & App Version
      • Get Devices
      • Create Device
      • Delete device
      • Get App Version
      • Get App Command
      • Store app version
      • Reset last sync
      • Set last sync
    • Expenses
      • Get Categories
      • Add Categories
    • Fundings
      • Get Categories
    • Sync
      • Sync Down
      • Sync Down All
      • Sync Up
      • Sync Up Full Transaction
      • Sync Up Multiple Tables
      • Sync Up Full Products
      • Sync Delete
      • Sync Delete Bulk
      • Sync Up Event Logs
      • Sync Up Bulk
      • Sync deleted
    • Notifications
      • Get Notifications
      • Get Countries
    • ErrorLogs
      • Get All error Logs
      • Create ErrorLog
      • Delete ErrorLog
      • Send Error Log to Dev
    • Admin
      • Auth
        • login
        • Impersonate user
      • User
        • get users
        • get trashed user
        • restore deleted user
        • get user
        • make user admin
        • Search Users
        • Search Users Copy
        • Create Business For Users
        • convertToParsable
        • Generate passcode (For admin login as user)
        • Get Users Count By month
        • Get User Data
        • Get User Businesses
        • Get User Businesses Data
        • Ban user
        • Clear business data
      • Transactions
        • get transactions
        • get transaction
        • Search Transactions
        • Get Transaction By Currency
        • Get Sales and Expenses By Month
        • Get Transactions By Month
        • Get Product and Services count By Month
        • Start Pdf Processing
        • Get Pdf
        • GetTransaction Processing
        • Get Transaction report (PDF)
      • Products
        • get products
        • get products Copy
        • get product
        • Search Products
      • Admin-Notifications
        • get notifications
      • Notifications
        • Get Notifications
        • Create Notifications
        • Send Notification
        • Send Notification To Device
        • Delete Notification
        • Get Countries
      • Data
        • get genders
        • get currency in last 6 months
        • get 6 months transactions of currency
      • Sales
        • Get Sales
        • Get Sale
        • Search Sales
        • Get Sales By Currency
        • Sales By Month
        • {{BASE}}/admin/get-sale-by-currency?currency=NGN
      • Expenses
        • Get Expenses
        • Get Expense
        • Search Expenses
        • Get Expense By Currency
        • Get Expenses By month
      • Services
        • Get Services
        • Get Services
        • Search Services
        • Get Service By Currency
      • Device
        • Get Devices
        • Send device command
        • Send user device command
      • ErrorNotifiers
        • Get all error notifiers
        • Create ErrorNotifier
        • Update ErrorNotifier
        • Delete ErrorNotifier
      • Video Tutorial
        • Save Video Tutorial
        • Delete Video Tutorial
      • Business Data Integrity
        • Reparse tables
        • Parse tables
        • Run Data Integrity Check
        • Periodic app report
        • Personality
        • Trigger Recurring Budgets
      • Subscriptions
        • Generate user plan transaction receipt
        • Check Renew Subscription
      • Business
        • Convert data to parsable raw
        • Restore deleted business
    • Feedback
      • Create Feedback
      • Get All feedbacks
      • Delete Feedback
    • Webhooks
      • Sendgrid
    • Email Logs
      • Get logs
    • Bulk Process
      • Upload
      • process pdf transaction history
      • Product Bulk Upload
      • Service Upload
      • Get Transaction History
      • get transaction processes
      • New Request
      • Confirm Product/Service Upload
      • Confirm Product/Service Upload Staging
      • Product Bulk Process Staging
      • Get Last Uploaded Product
      • Get Latest Bulk Process
      • Product Upload History
      • Product Upload History Staging
    • Video Tutorial
      • Get Tutorials
      • Get Tutorials Grouped by Category
      • Get Tutorials With Category
    • Permissions
      • Add Permission
      • Get All Permissions
      • Add Permission Roles
      • Get Role Permissions
      • Get Role Names
      • Delete Role Permissions
      • Add Api Permissions
      • Get All Api Permissions
      • Delete Api Permissions
      • {{BASE_URL}}/permissions/add-permission
    • Transaction
      • Get Transaction History
      • Get Transaction Short URL
      • Get Transaction Report
      • Create Transaction
      • Update Transaction
      • Edit transaction
    • Subscription
      • Tier
        • create a tier
        • get tiers
      • User Subscription
        • add user subscription
        • Verify Android Subscription
        • Verify iOS Subscription
        • Get user subscription
      • Charge paystack auth code
      • Get subscription info
      • Get iOS Notification History
      • Get iOS Transaction History
      • Get iOS Subscription Status
      • Get iOS TransactionInfo
      • Request iOS Notification
      • TEST WEBHOOK
    • Product
      • Change product variant stock
      • Update product
    • Gen AI
      • Change message tone
      • Generate
      • Chat sessions
      • Chat history
    • Payment Collector Settings
      • Get Invoice Reminder Setting
      • Create/Update Invoice Reminder Setting
    • Cheque Mailing
      • Get cheque mailing address
      • Create/Update cheque mailing address
    • Payment Collector
      • Get invoices for month
      • Get invoices for year
      • Get Reconcilliation Invoices
      • Get Pending Invoices
      • Get Due Invoices
      • Get Overdue Invoices
      • Get Escalation Invoices
      • Get Payment Reminder Email
      • Send Payment Reminder Email
      • Receipt expense data extraction
    • home
    • Send File
  • cantant API
    • Auth
      • Register User
      • Register User
      • Check Phone Number
      • Login User
      • Update Pin
      • Verify Otp
      • Resend Otp
      • Email Exist
      • New Register User
      • Logout User
      • Reset Pin
      • Request Otp
      • Validate Otp
    • Product
      • Add Product
      • Edit Product
      • Get a Product
      • Get User Product
      • Add Stock
      • Delete Product
    • User
      • Get User
      • Edit User
      • Delete User Account
      • Get all Users
      • UpdateLogo
    • Expenses
      • Add Expense
      • Get All Expenses
      • Delete Expense
    • Transaction
      • Add Transaction
      • Get All Transactions
      • Get A Transaction
      • Delete Transaction
    • Otp
      • Send Otp
      • Verify Otp
      • Send Device Token
    • Supplier
      • Add Supplier
      • Get Supplier
      • Get all user suppliers
      • Update Supplier
      • Delete Suppplier
      • Get Supplier Product
    • Notifcations
      • Get User Notifications
      • Add Device Token
    • Category
      • Add Category
      • Get All Categories
      • Get a category
      • Update Category
      • Delete Category
    • Sales
      • Add Sales
      • Delete Sales
      • Get User Sales
    • Price History
      • Add Price History
      • Delete Price History
      • Get User Price History
    • Services
      • Add Service
      • Delete Service
      • Get User Services
    • Admin Section
      • Get All Users
      • Get All Transactions
      • Get All Products
      • Get a User Transaction
      • Get a User Products
      • Get a User Products Count
      • Get a User Products Count Copy
      • Get a User Products Count Copy
      • Get a User Products Count Copy 2
      • Admin Login
      • Get User Sales
      • Query User Sales by date
      • Get User Expenses
      • GEt Expense By Date
      • Search Users
      • Get Users Count By Month
      • Get Product Pluse Services by month
      • Get Sales and Expenses By month
      • Search Product
      • Search Transactions
      • Search Sales
      • Search Expense
      • Get Sales with highest currency
      • Get Expenses with highest currency
      • Get Transactions By Month
      • Get Transaction By Currency for each Month Copy
      • Get total sales by currency and month
      • Sales by month
      • Get Expenese by month
      • Get Expenses my currency and month
      • Get All Deleted Users
      • Admin Delete User
      • Admin Restore User Account
      • Request Password for User
      • Login as a User
      • Transfer User Data
      • Transfer User Data Copy
    • Reports
      • Add Report
      • Get User Reports
    • Country
      • Add Country
      • Update Country
      • Get a Country
      • Get All Countries
      • Delete a Country
      • Get All Countries from Json
    • Currency
      • Add Country
      • Update Country
      • Get a Country
      • Get All Countries
      • Delete a Country
    • Customer
      • Add Customer
      • Get User Customers
      • Delete Customer
      • Get All Customers for Admin
      • Update Customer
    • Bank Details
      • Add Bank Details
      • Get User Bank Details
      • Delete Bank Details
      • Get All Bank Details for Admin
      • Upload Business Logo
      • Update Taxs
    • CheckList
      • Add CheckList
      • Get User CheckList
      • Delete CheckList
      • Get All CheckLists
      • Update checkList
    • Notification
      • New Notification
      • Get All Notifications
      • Get a Notification
      • Update Notification
      • Delete Notification
    • Add User
      • Send Invite
      • Validate Otp
      • Register Staff
      • Get User Staffs
    • CronJob
      • Weekly Summary Checklist Notification a User
      • CheckList reminder for a user
      • CheckTotalChecklistForUser
      • CheckTotalChecklistForUser Copy
    • ProductVariant
      • Add ProductVariant
      • Get User ProductVariant
      • Delete ProductVariant
      • Update Product Variant
    • ErrorLogs
      • Add ErrorLogs
      • Add ErrorLogs Copy
      • Get All error Logs
      • Send Error Log to Dev
      • Add Feedback
      • Get All feedbacks
      • Delete a User Error Logs
    • ErrorKeyword
      • Add ErrorKeywords
      • Get Keywords
      • Update Keywords
      • Delete Keyword
    • Transfer Data
      • Transfer User Data
      • {{cat_url}}/api/v1/data/bulk-data
    • Payments
      • get bank list
  • cantant Desktop
    • Business
      • Update Logo
      • Business Information
      • Business Types
      • Update Business information
      • Clear Business Data
      • Delete business
      • Get all businesses
      • Create Business
      • Get Merge Business
      • Merge Business
      • Resend Merge Business Otp
      • Get Default Business
      • Make Default Business
      • Get Business Staffs
    • Products
      • Get Business Products
      • Get Business Product Variants
      • Get Single Business Product
      • Get Business ProductStock Information
      • Delete Product
      • Get ProductStock Count
      • Search Products
      • Search InventoryCount
      • Create Product
      • Upload Product Image
      • delete bulk images
      • upload bulk images
      • Delete Image
      • Update Product
      • Get Price history
      • Update Product Stock
      • Products with Low Stock
    • Services
      • Get Business Services
      • Get Business Services
      • Delete Service
      • Search
      • Create Services
      • Update Service
      • Get Chart Data
      • Get Service Sales
      • Get Transaction Invoice
      • Service Price History
      • Price History Graph
    • Transactions
      • all transactions
      • all transactions With filter
      • all-sales
      • all-expenses
      • Search Tranasctions
      • Transaction Summary
      • Debtors Summary
      • Get Payables Summary
      • Get All Debtors
      • Get All Payables
      • Search Debtors
      • Search Payables
      • Search Sales
      • Search Expenses
      • Add Transaction
      • Transaction File Upload
      • Upload Bulk Transaction File
      • Delete Bulk Files
      • Delete Single File
      • Add Cashin Others
      • Add Cashout Transaction
      • Get Single Transaction
      • Update Cashin Transaction
      • Update Cashout Transaction
      • Delete Transaction
      • Update Payment
      • Payment Reminder
      • Get Single Cashin Others transactions
      • Update Cashin Others
      • Get Transactions Others
      • Get Staff Unapproved Transactions
      • Approve Transactions
      • Reject Transaction
      • Get Unapproved Transaction
    • Home Page
      • Get Business Transaction Report
      • Get Top Sales
      • Top Expenses
      • Get Inventory Count
      • Get Checklist
      • Get Due Transactions
      • get chart item
      • Get Chart Data
      • {{BASE_URL}}/desktop/home/chart-data?filterTypes=previousMonth
    • Inventory Count
      • Get All ProductVariants
      • Get a Single ProductVariant
      • Search ProductVariants
      • Delete ProductVariant
    • Customers
      • Get Business Customers
      • Get a Customer
      • Search for Customer
      • Delete Customer
      • Customers Transaction Summary
      • Create Customer
      • Update Customer
      • Get Customer Transaction Summary
      • Get Customer Transactions
      • Get Top Items
      • Get Customer Segement
    • Suppliers
      • Get Business Suppliers
      • Get a Supplier
      • Search Suppliers
      • Delete Supplier
      • Supplier Product Summary
      • Create Supplier
      • Update Supplier
      • Get Supplier Product Summary
      • Get Supplier Products
      • Get Top Supplier Items
    • Invoices
      • Get Invoices Summary
      • Get Invocies Transactions
      • Search Invoices Transactions
      • Transaction Invoice
      • Get Invoice Data
      • Get Invoice Pdf
      • Get Invoice Pdf Copy
    • Receipts
      • Get Receipts Summary
      • Get Receipts Transactions
      • Search Receipts Transactions
    • Checklists
      • Get All Checklists
      • Get a Checklist
      • Search Checklists
      • Add CheckList
      • Update Checklists
      • Update Bulk Checklists
      • Delete Checklist
      • Bulk Delete Checklist
    • Transaction Notes
      • Add Transaction Note
      • Update Transaction Note
      • Get Transaction Notes
      • Get All Transaction Notes
      • Get Single Transaction Note
      • Delete Transaction Note
    • Expenses Categories
      • Get Categories
    • Product Variant
      • Get Single Product Variant
      • Get ProductVariant Sales
      • ProductVariant Chart Data
      • Product Variant Price History
      • Delete ProductVariant
      • Get All Product Variants
      • Product Variant Price Change Graph
      • Get Product Variant Graph
      • Search Product Variants
      • Get Product Variant Customers
    • Recurring Transactions
      • Get All Recurring Transactions
      • Get Overdue Recurring Transaction
      • Due Recurring
      • Recurring Transaction Summary
      • Get Single Recurring
      • Get Recurring By Filter
      • Search Recurring Transaction
      • Add Recurring Cashout Transacation
      • Add Recurring Cashin Service Transaction
      • Cancel Recurring Transactions
      • Edit Recurring Transaction
    • Bank Details
      • Add Bank Detail
      • Get Bank Detail
      • Get All Bank Details
      • Update Bank Details
      • Delete Bank Detail
      • Business Bank Details
    • Reports
      • Cash Flow
      • Money Graph
      • Profit Graph
      • Profit Margin
      • Investment Reports
      • Sales Summary
      • Sales Graph
      • Sales Items By Revenue
      • Sales Items by Profit
      • Item Transaction Details
      • Expenses Summary
      • Expenses Graph
      • Fastest Expense
      • Expenses By Amount
      • Expense Item Detail
      • Best Selling Days
      • Best Selling Times
      • Downloadable Reports PDF
      • Downloadable Reports Excel
      • Send Weekly Report
      • Get Sales Payment methods
      • Get Sales Channel
    • Profile
      • get profile
      • update profile
      • change pin
      • get delete account otp
      • delete account
    • Feedback
      • create feedback
    • Funding Source
      • Add Funding Source
      • Get Business Funding Sources
    • Product Reports
      • Product Report Summary
      • Product Reports Graph
      • Get Products Turn Over
    • Add User
      • Get Team Summary
      • Get Business Staffs
      • Search Business Staffs
      • Remove Staff from Business
      • Change User Role
      • Send Invites
      • Pending Invites
      • Cancel Invites
      • Accept Invitation
      • Reject Invitation
      • Complete Invitation
      • Get Staff
      • Get Staff Activity
      • Get Invitation Details
      • Validate Invitation Code
      • Get Staff Detail
    • Budgets
      • Add Budgets
      • Add Bulk Budgets
      • Update Budget
      • Update Bulk Budget
      • Delete Budget
      • Bulk Delete Budgets
      • Get Budget Summary
      • Get All Budgets
      • Get Single Budget
      • Get Budget Category Summary
      • Get Category Transactions
      • Get Unbudget Expenses
      • Budget Chart Data
      • Get Budgeted Expenses
    • Multiple Business Reports
      • CashFlow Summary
      • Get Combined Sales Summary
      • Get Combined Expenses Summary
      • Get Combined Profits
      • Business Invoices
      • Business Best Sellers
      • Businesses Top Expense
    • Device Event Logs
      • Add or Update Device Info
      • Add Device Event Log
      • Get User Device Event Logs
      • Get Business Device Event Logs
      • Get Business Notifiction
      • Mark Notification as Read
      • Bulk Create Device Event Logs
    • Notifications
      • get notifications
      • Clear Business Tips Notifications
      • Clear User Notifications
      • Get Budget Insight Notification
    • Webhooks
      • Playstore
    • ReminderEmail
      • Send Reminder
      • Send Payment Reminder
    • BulkUpload Product
      • Upload Product Excel
      • Confirm Product Bulk Upload
      • Get Latest Bulk Process
    • Credit Report
      • Get Unpaid Invoices Summary
      • Get Unpaid Expenses Summary
      • Get Top Owning Customers
      • Get Top Vendors
      • Get Owing Customers
      • Get Owing Vendors
      • Get Customer Detail With Transactions
      • Get Vendor Detail with Transactions
    • Downloadable Report
      • Get Excel downloadable Report
      • Get Pdf downloable reports
    • Customer Segment
      • Add Customer Segment
      • Get All Customer Segment
      • Get Customer Segment
      • Update Customer Segment
      • Delete Customer Segment
      • Add Customers to Segement
      • Remove Customers from Segment
      • Get Segment Members
      • Get Business Segement Customers
      • Add Group and Members
    • Files
      • Share via Email
      • Upload Files
      • List Files
      • Update Files
      • Delete Files
      • Get Transaction Data
      • Update Filename
      • Get Single File
      • Files Filter Options
      • Search Files
      • Get All Files
    • Quotes
      • Create Quote
      • Get All Quotes
      • Update Quote
      • Get Single Quote
      • Send Quote Reminder
      • Update Quote Status
    • iOS Tx History
    • iOS Sub Status
    • Request otp
  • Payment
    • Plan
      • check free trial qualification
      • get plans
      • get paddle plans
      • get plan
      • start free trials
      • get plan change price
      • cancel plan
      • get order history
      • get saved auths codes
      • accept payment for paddle
      • retry payment
      • switch plan via credits
      • get wallet credit balance
      • get billing cycles
      • get user subscription
      • create discount
      • get all discounts
      • calculate coupon discount
      • get plan upgrade price
      • charge card - paystack
      • check payment error
      • initiate direct debit
      • get direct debit supported banks
      • validate account number
      • cancel direct debit authorization
    • Paddle
      • get plans and prices
      • get single plan
      • get paddle subscription
      • cancel paddle subscription
      • get paddle transactions
      • get paddle cards
      • preview subscription update
      • upgrade paddle subscription
      • get discounts
    • Paystack callback
  • Quickbooks Integration
    • get quickbooks notification
    • clear quickbooks notification
    • get quickbooks error logs
    • get quickbooks status
    • store quickbooks credentials
    • exchange token
    • save preferences
    • get connected apps
    • disconnect app
    • activity logs
    • get preferences
  1. Add User

PARTNER

POST
/api/v2/auth/login

Request

Body Params application/json

Examples

Responses

🟢200PARTNER Copy
application/json
Body

🟢200PARTNER Copy
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v2/auth/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "cathedralmessiah98@gmail.com",
    "passcode": "1111"
}'
Response Response Example
200 - PARTNER Copy - PARTNER Copy
{
    "success": true,
    "message": "Login successful",
    "data": {
        "user": {
            "id": "2426",
            "user_id": "1578ec90-b5d6-4b57-9ca3-343aa0ddf26a",
            "business_id": "2290",
            "first_name": "Ade",
            "last_name": "Ola",
            "phone": "190257",
            "email": "cathedralmessiah98@gmail.com",
            "gender": "male",
            "avatar": null,
            "dial_code": "+234",
            "role": "PARTNER",
            "timezone": "Africa/Lagos",
            "is_subscribed": true,
            "email_verified": true,
            "created_at": "2024-06-24T06:17:40.888+01:00",
            "updated_at": "2024-09-20T10:19:51.583+01:00",
            "has_opened_desktop": false,
            "last_login": null,
            "defaultBusiness": {
                "id": "2290",
                "business_id": "fa8c7ee1-80c1-4935-b4b0-73eabbfaf46f",
                "user_id": "2400",
                "business_type_id": "15",
                "name": "Maman",
                "code": null,
                "country": "Angola (AGO)",
                "state": "",
                "address": "lekki face one",
                "currency": "VEF",
                "logo": "https://res.cloudinary.com/dwfnoynkp/image/upload/v1720098558/dev/logos/business-fa8c7ee1-80c1-4935-b4b0-73eabbfaf46f.jpg",
                "is_verified": false,
                "is_active": true,
                "created_at": "2024-05-30T00:58:33.454+01:00",
                "updated_at": "2025-02-05T13:17:13.218+01:00",
                "brand_color": "#0898A0"
            },
            "fullName": "Ade Ola",
            "defaultBusinessStaffs": [
                {
                    "id": "2400",
                    "email": "adeleke1402@gmail.com",
                    "first_name": "Aa",
                    "last_name": "Mm",
                    "user_id": "71a1e24c-e5ad-4aef-95af-7dbcb74e2988",
                    "role": "OWNER",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-05-29T23:58:33.461Z"
                },
                {
                    "id": "2402",
                    "email": "d2402__abdullah@mycantant.com",
                    "first_name": "Abdul",
                    "last_name": "Gumi",
                    "user_id": "935b5f87-d599-444b-b1cf-ec0e045f4114",
                    "role": "PARTNER",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-05-30T17:50:53.748Z"
                },
                {
                    "id": "2404",
                    "email": "d2404__abdullah@mycantant.com",
                    "first_name": "Abdullah",
                    "last_name": "Gumi",
                    "user_id": "60c69141-b6ad-4b79-9a8a-96024c984ea2",
                    "role": "PARTNER",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-06-04T17:17:27.492Z"
                },
                {
                    "id": "2405",
                    "email": "d2405__abdullah@mycantant.com",
                    "first_name": "Gumi",
                    "last_name": "Abdul",
                    "user_id": "3c81c29d-a9af-4516-be23-a0e068d7639a",
                    "role": "STAFF",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-06-04T17:39:09.954Z"
                },
                {
                    "id": "2406",
                    "email": "d2406__abdullah@mycantant.com",
                    "first_name": "Gumi",
                    "last_name": "Abdul",
                    "user_id": "420a1ec5-87ab-4533-93ee-cd9c177230a0",
                    "role": "STAFF",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-06-04T17:43:09.237Z"
                },
                {
                    "id": "2407",
                    "email": "d2407__abdullah@mycantant.com",
                    "first_name": "Gummi",
                    "last_name": "Abdul",
                    "user_id": "f1f124f8-0826-47bb-9070-61498e5ccb61",
                    "role": "PARTNER",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-06-04T17:46:28.118Z"
                },
                {
                    "id": "2412",
                    "email": "d2412__cathedralmessiah98@gmail.com",
                    "first_name": "Cat",
                    "last_name": "Me",
                    "user_id": "a43f01a1-66c4-4f2b-9417-7f5b8c8b34ea",
                    "role": "PARTNER",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-06-05T08:23:29.208Z"
                },
                {
                    "id": "2413",
                    "email": "d2413__adebowale1402@gmail.com",
                    "first_name": "Car",
                    "last_name": "Read",
                    "user_id": "294fd8bb-074b-4cf7-80eb-b2d0ae838ba6",
                    "role": "STAFF",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-06-05T08:36:47.238Z"
                },
                {
                    "id": "2419",
                    "email": "abdullah@mycantant.com",
                    "first_name": "Abdul",
                    "last_name": "gumi",
                    "user_id": "fcf0a252-3ed2-461e-bd04-0e787e3f026c",
                    "role": "MANAGER",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-06-07T11:07:01.042Z"
                },
                {
                    "id": "2426",
                    "email": "cathedralmessiah98@gmail.com",
                    "first_name": "Ade",
                    "last_name": "Ola",
                    "user_id": "1578ec90-b5d6-4b57-9ca3-343aa0ddf26a",
                    "role": "PARTNER",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-06-24T05:17:40.892Z"
                },
                {
                    "id": "2428",
                    "email": "teydeveydo@gufum.com",
                    "first_name": "A",
                    "last_name": "B",
                    "user_id": "dedf2cc8-ff4b-40c7-9c3e-da9892a38362",
                    "role": "STAFF",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-08-30T11:18:35.752Z"
                },
                {
                    "id": "3893",
                    "email": "itunuoluwa1402+testing196@gmail.com",
                    "first_name": "Lol",
                    "last_name": "Kpi",
                    "user_id": "9ae44578-f659-4a12-98a5-23be9e78c6d0",
                    "role": "STAFF",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2025-02-02T19:20:15.314Z"
                }
            ],
            "subscription": null
        },
        "businesses": [
            {
                "id": "2311",
                "business_id": "4ade52b6-f948-44ca-b519-b5fc7628aff7",
                "user_id": "2426",
                "business_type_id": "2",
                "name": "Hejr",
                "code": null,
                "country": "Antigua and Barbuda",
                "state": null,
                "address": null,
                "currency": "GHC",
                "logo": null,
                "is_verified": false,
                "is_active": true,
                "created_at": "2024-08-15T15:07:35.067+01:00",
                "updated_at": "2024-08-15T15:07:35.068+01:00",
                "brand_color": null
            }
        ],
        "defaultBusiness": {
            "id": "2290",
            "business_id": "fa8c7ee1-80c1-4935-b4b0-73eabbfaf46f",
            "user_id": "2400",
            "business_type_id": "15",
            "name": "Maman",
            "code": null,
            "country": "Angola (AGO)",
            "state": "",
            "address": "lekki face one",
            "currency": "VEF",
            "logo": "https://res.cloudinary.com/dwfnoynkp/image/upload/v1720098558/dev/logos/business-fa8c7ee1-80c1-4935-b4b0-73eabbfaf46f.jpg",
            "is_verified": false,
            "is_active": true,
            "created_at": "2024-05-30T00:58:33.454+01:00",
            "updated_at": "2025-02-05T13:17:13.218+01:00",
            "brand_color": "#0898A0",
            "businessType": {
                "id": "15",
                "title": "Goods Production",
                "icon_name": "Beker",
                "sort": 11,
                "is_visible": true,
                "created_at": "2023-09-21T20:32:13.355+01:00",
                "updated_at": null
            },
            "bankDetails": [
                {
                    "id": "318",
                    "user_id": "2400",
                    "business_id": "2290",
                    "bank_name": "Wema",
                    "account_number": "10107070808",
                    "account_name": "Ololade",
                    "created_at": "2024-07-04T14:03:51.302+01:00",
                    "updated_at": "2024-07-04T14:03:51.302+01:00",
                    "created_by": null
                },
                {
                    "id": "319",
                    "user_id": "2400",
                    "business_id": "2290",
                    "bank_name": "Access",
                    "account_number": "1488386558",
                    "account_name": "Adeleke Michael Adebowale",
                    "created_at": "2024-07-04T14:07:15.806+01:00",
                    "updated_at": "2024-07-04T14:07:15.806+01:00",
                    "created_by": null
                },
                {
                    "id": "336",
                    "user_id": "2400",
                    "business_id": "2290",
                    "bank_name": "GTB Bank",
                    "account_number": "0694255043",
                    "account_name": "Ifeoluwa Alao",
                    "created_at": "2024-08-14T09:29:47.313+01:00",
                    "updated_at": "2024-08-14T09:29:47.313+01:00",
                    "created_by": null
                },
                {
                    "id": "335",
                    "user_id": "2400",
                    "business_id": "2290",
                    "bank_name": "GTB Bank",
                    "account_number": "0694255043",
                    "account_name": "Ifeoluwa Alao",
                    "created_at": "2024-08-14T09:28:21.640+01:00",
                    "updated_at": "2024-08-14T09:28:21.640+01:00",
                    "created_by": null
                },
                {
                    "id": "334",
                    "user_id": "2400",
                    "business_id": "2290",
                    "bank_name": "GTB Bank",
                    "account_number": "0694255043",
                    "account_name": "Ifeoluwa Alao",
                    "created_at": "2024-08-14T09:26:56.990+01:00",
                    "updated_at": "2024-08-14T09:26:56.990+01:00",
                    "created_by": null
                },
                {
                    "id": "339",
                    "user_id": "2400",
                    "business_id": "2290",
                    "bank_name": "GTB Bank",
                    "account_number": "0694255043",
                    "account_name": "Ifeoluwa Alao",
                    "created_at": "2024-08-15T09:18:34.018+01:00",
                    "updated_at": "2024-08-15T09:18:34.018+01:00",
                    "created_by": "2400"
                },
                {
                    "id": "322",
                    "user_id": "2400",
                    "business_id": "2290",
                    "bank_name": "GTB Bank",
                    "account_number": "0694255043",
                    "account_name": "Ifeoluwa Alao",
                    "created_at": "2024-07-25T23:58:34.616+01:00",
                    "updated_at": "2024-07-25T23:58:34.616+01:00",
                    "created_by": null
                },
                {
                    "id": "321",
                    "user_id": "2400",
                    "business_id": "2290",
                    "bank_name": "GTB Bank",
                    "account_number": "0694255043",
                    "account_name": "Ifeoluwa Alao",
                    "created_at": "2024-07-25T23:57:10.388+01:00",
                    "updated_at": "2024-07-25T23:57:10.388+01:00",
                    "created_by": null
                },
                {
                    "id": "337",
                    "user_id": "2400",
                    "business_id": "2290",
                    "bank_name": "GTB Bank",
                    "account_number": "0694255043",
                    "account_name": "Ifeoluwa Alao",
                    "created_at": "2024-08-14T09:34:28.729+01:00",
                    "updated_at": "2024-08-14T09:34:28.730+01:00",
                    "created_by": null
                }
            ],
            "tax": {
                "id": "2151",
                "user_id": "2400",
                "business_id": "2290",
                "tax": 5,
                "created_at": "2024-07-04T14:07:31.217+01:00",
                "updated_at": "2024-08-15T09:18:35.665+01:00"
            },
            "paymentNote": {
                "id": "34",
                "user_id": "2426",
                "business_id": "2290",
                "name": "Default",
                "description": "Please ensure to view your products to ensure they are in good condition. No return after purchase",
                "created_at": "2024-07-04T14:11:02.076+01:00",
                "updated_at": "2024-09-20T20:12:41.477+01:00",
                "created_by": "2400"
            },
            "staffs": [
                {
                    "id": "2400",
                    "email": "adeleke1402@gmail.com",
                    "first_name": "Aa",
                    "last_name": "Mm",
                    "user_id": "71a1e24c-e5ad-4aef-95af-7dbcb74e2988",
                    "role": "OWNER",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-05-29T23:58:33.461Z"
                },
                {
                    "id": "2402",
                    "email": "d2402__abdullah@mycantant.com",
                    "first_name": "Abdul",
                    "last_name": "Gumi",
                    "user_id": "935b5f87-d599-444b-b1cf-ec0e045f4114",
                    "role": "PARTNER",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-05-30T17:50:53.748Z"
                },
                {
                    "id": "2404",
                    "email": "d2404__abdullah@mycantant.com",
                    "first_name": "Abdullah",
                    "last_name": "Gumi",
                    "user_id": "60c69141-b6ad-4b79-9a8a-96024c984ea2",
                    "role": "PARTNER",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-06-04T17:17:27.492Z"
                },
                {
                    "id": "2405",
                    "email": "d2405__abdullah@mycantant.com",
                    "first_name": "Gumi",
                    "last_name": "Abdul",
                    "user_id": "3c81c29d-a9af-4516-be23-a0e068d7639a",
                    "role": "STAFF",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-06-04T17:39:09.954Z"
                },
                {
                    "id": "2406",
                    "email": "d2406__abdullah@mycantant.com",
                    "first_name": "Gumi",
                    "last_name": "Abdul",
                    "user_id": "420a1ec5-87ab-4533-93ee-cd9c177230a0",
                    "role": "STAFF",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-06-04T17:43:09.237Z"
                },
                {
                    "id": "2407",
                    "email": "d2407__abdullah@mycantant.com",
                    "first_name": "Gummi",
                    "last_name": "Abdul",
                    "user_id": "f1f124f8-0826-47bb-9070-61498e5ccb61",
                    "role": "PARTNER",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-06-04T17:46:28.118Z"
                },
                {
                    "id": "2412",
                    "email": "d2412__cathedralmessiah98@gmail.com",
                    "first_name": "Cat",
                    "last_name": "Me",
                    "user_id": "a43f01a1-66c4-4f2b-9417-7f5b8c8b34ea",
                    "role": "PARTNER",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-06-05T08:23:29.208Z"
                },
                {
                    "id": "2413",
                    "email": "d2413__adebowale1402@gmail.com",
                    "first_name": "Car",
                    "last_name": "Read",
                    "user_id": "294fd8bb-074b-4cf7-80eb-b2d0ae838ba6",
                    "role": "STAFF",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-06-05T08:36:47.238Z"
                },
                {
                    "id": "2419",
                    "email": "abdullah@mycantant.com",
                    "first_name": "Abdul",
                    "last_name": "gumi",
                    "user_id": "fcf0a252-3ed2-461e-bd04-0e787e3f026c",
                    "role": "MANAGER",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-06-07T11:07:01.042Z"
                },
                {
                    "id": "2426",
                    "email": "cathedralmessiah98@gmail.com",
                    "first_name": "Ade",
                    "last_name": "Ola",
                    "user_id": "1578ec90-b5d6-4b57-9ca3-343aa0ddf26a",
                    "role": "PARTNER",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-06-24T05:17:40.892Z"
                },
                {
                    "id": "2428",
                    "email": "teydeveydo@gufum.com",
                    "first_name": "A",
                    "last_name": "B",
                    "user_id": "dedf2cc8-ff4b-40c7-9c3e-da9892a38362",
                    "role": "STAFF",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2024-08-30T11:18:35.752Z"
                },
                {
                    "id": "3893",
                    "email": "itunuoluwa1402+testing196@gmail.com",
                    "first_name": "Lol",
                    "last_name": "Kpi",
                    "user_id": "9ae44578-f659-4a12-98a5-23be9e78c6d0",
                    "role": "STAFF",
                    "business_id": "2290",
                    "is_active": true,
                    "created_at": "2025-02-02T19:20:15.314Z"
                }
            ],
            "role": "PARTNER"
        },
        "staffs": [
            {
                "id": "2414",
                "user_id": "2426",
                "business_id": "2290",
                "role": "PARTNER",
                "is_active": true,
                "deleted_at": null,
                "created_at": "2024-06-24T06:17:40.892+01:00",
                "updated_at": "2024-06-24T06:17:40.892+01:00"
            }
        ],
        "staff_permission": [
            {
                "id": "2414",
                "user_id": "2426",
                "business_id": "2290",
                "role": "PARTNER",
                "is_active": true,
                "deleted_at": null,
                "created_at": "2024-06-24T06:17:40.892+01:00",
                "updated_at": "2024-06-24T06:17:40.892+01:00",
                "rolePermission": [
                    {
                        "id": "3",
                        "role": "PARTNER",
                        "permission_id": "3",
                        "created_at": "2024-02-16T19:57:25.653Z",
                        "updated_at": "2024-02-16T19:57:25.653Z",
                        "code": "CREATE_PRODUCT",
                        "resource": null
                    },
                    {
                        "id": "4",
                        "role": "PARTNER",
                        "permission_id": "4",
                        "created_at": "2024-02-16T19:57:26.089Z",
                        "updated_at": "2024-02-16T19:57:26.089Z",
                        "code": "READ_PRODUCT",
                        "resource": null
                    },
                    {
                        "id": "5",
                        "role": "PARTNER",
                        "permission_id": "5",
                        "created_at": "2024-02-16T19:57:26.528Z",
                        "updated_at": "2024-02-16T19:57:26.528Z",
                        "code": "MANAGE_PRODUCT",
                        "resource": null
                    },
                    {
                        "id": "7",
                        "role": "PARTNER",
                        "permission_id": "7",
                        "created_at": "2024-02-16T19:57:27.388Z",
                        "updated_at": "2024-02-16T19:57:27.388Z",
                        "code": "CREATE_TRANSACTION",
                        "resource": null
                    },
                    {
                        "id": "9",
                        "role": "PARTNER",
                        "permission_id": "9",
                        "created_at": "2024-02-16T19:57:28.677Z",
                        "updated_at": "2024-02-16T19:57:28.677Z",
                        "code": "MANAGE_TRANSACTION",
                        "resource": null
                    },
                    {
                        "id": "17",
                        "role": "PARTNER",
                        "permission_id": "17",
                        "created_at": "2024-02-16T19:57:32.093Z",
                        "updated_at": "2024-02-16T19:57:32.093Z",
                        "code": "MANAGE_CUSTOMER",
                        "resource": null
                    },
                    {
                        "id": "21",
                        "role": "PARTNER",
                        "permission_id": "21",
                        "created_at": "2024-02-16T19:57:33.797Z",
                        "updated_at": "2024-02-16T19:57:33.797Z",
                        "code": "MANAGE_SUPPLIER",
                        "resource": null
                    },
                    {
                        "id": "24",
                        "role": "PARTNER",
                        "permission_id": "24",
                        "created_at": "2024-02-16T19:57:35.100Z",
                        "updated_at": "2024-02-16T19:57:35.100Z",
                        "code": "READ_BUSINESS",
                        "resource": null
                    },
                    {
                        "id": "47",
                        "role": "PARTNER",
                        "permission_id": "47",
                        "created_at": "2024-02-21T14:22:43.709Z",
                        "updated_at": "2024-02-21T14:22:43.709Z",
                        "code": "SEE_REPORTS",
                        "resource": null
                    },
                    {
                        "id": "48",
                        "role": "PARTNER",
                        "permission_id": "48",
                        "created_at": "2024-02-21T14:22:44.223Z",
                        "updated_at": "2024-02-21T14:22:44.223Z",
                        "code": "VIEW_INVENTORY_STOCK_VALUE",
                        "resource": null
                    },
                    {
                        "id": "49",
                        "role": "PARTNER",
                        "permission_id": "49",
                        "created_at": "2024-02-21T14:22:44.746Z",
                        "updated_at": "2024-02-21T14:22:44.746Z",
                        "code": "DOWNLOAD_REPORT",
                        "resource": null
                    }
                ]
            }
        ],
        "type": "bearer",
        "token": "MTE5MDM.XYtZYSxnqRzzxRntm1ibCQiqpzWoYN3toq-4ZasueFf2DvXutKChCjLE2mjl"
    }
}
Modified at 2025-09-01 21:36:41
Previous
MANAGER
Next
Register
Built with