Skip to content

Latest commit

 

History

History
879 lines (757 loc) · 51.2 KB

File metadata and controls

879 lines (757 loc) · 51.2 KB

REST API reference

Generated from api/src/routes/ by npm run docs:api. Do not edit this file by hand; edit the routes and regenerate.

587 endpoints across 36 route groups.

All paths below are relative to the API root. On a desktop install the API runs on a port derived per installation (see local-ports.js); in the cloud it sits behind the tenant hostname.

Machine-readable spec

openapi.json is generated alongside this file. Import it into Postman, Insomnia or Bruno, point Swagger UI or Redoc at it, or generate a client from it. It is OpenAPI 3.0.3.

102 of 587 endpoints carry a request schema (17%), recovered from their express-validator middleware. The remaining 485 are listed with path, method and handler but no body, because inventing a schema is worse than admitting the gap.

Adding validation to an endpoint improves runtime safety and this document in the same commit, which makes it one of the more useful contributions available.

Conventions

  • Authentication is a bearer token unless an endpoint's middleware says otherwise.
  • Several groups carry a second mount path kept for compatibility with the older PHP application. New work should use the primary path.
  • Response bodies are not documented. They are not inferable from the source.

Endpoints

Activity logs

Mounted at /activity-logs. Source: api/src/routes/activity-logs.routes.js.

Method Path Body documented Handler
GET /activity-logs/sales activityLogController.getSalesAuditLogs
GET /activity-logs activityLogController.getActivityLogs
GET /activity-logs/:id yet
POST /activity-logs yet
PUT /activity-logs/:id yet
DELETE /activity-logs/:id yet

Auth utils

Mounted at /auth-utils. Source: api/src/routes/auth-utils.routes.js.

Method Path Body documented Handler
POST /auth-utils/sign-token error
POST /auth-utils/verify-token error
POST /auth-utils/refresh-token error

Auth

Mounted at /auth. Source: api/src/routes/auth.routes.js.

Method Path Body documented Handler
POST /auth/register authController.register
POST /auth/login authController.login
POST /auth/verify authController.verifyToken
POST /auth/forgot-password authController.forgotPassword
PATCH /auth/reset-password/:token authController.resetPassword
GET /auth/shadow shadowLogin
PATCH /auth/update-password authController.updatePassword
GET /auth/me authController.getMe
PATCH /auth/update-me authController.updateMe
DELETE /auth/delete-me authController.deleteMe

Authorizations

Mounted at /authorizations. Source: api/src/routes/authorizations.routes.js.

Method Path Body documented Handler
POST /authorizations/set-manager-pin authorizationsController.setManagerPin
POST /authorizations/verify-pin authorizationsController.verifyPin
POST /authorizations/set-rfid authorizationsController.setRfid
POST /authorizations/verify-card authorizationsController.verifyCard

Base

Mounted at /base. Source: api/src/routes/base.routes.js.

Method Path Body documented Handler
GET /base running
GET /base/health healthy
GET /base/autoSuggestionTableField baseController.autoSuggestionTableField
GET /base/autoSuggestionReportTableField baseController.autoSuggestionReportTableField
GET /base/getDefaultSuggest baseController.getDefaultSuggest

Branches

Mounted at /branches. Source: api/src/routes/branches.routes.js.

Method Path Body documented Handler
GET /branches bound.getAll
GET /branches/options bound.getOptions
GET /branches/getBranchList bound.getBranchList
GET /branches/userRegisterBranchSelect bound.userRegisterBranchSelect
GET /branches/getOneStore bound.getOneStore
GET /branches/getBranchDetails bound.getBranchDetails
GET /branches/getDataChanges bound.getDataChanges
POST /branches/exportBranches bound.exportBranches
GET /branches/getBranchRegisterList bound.getBranchRegisterList
GET /branches/resetPaymentGateway bound.resetPaymentGateway
GET /branches/resetPhonepePaymentGateway bound.resetPhonepePaymentGateway
GET /branches/resetEmailSetting bound.resetEmailSetting
GET /branches/stats bound.getStats
GET /branches/search bound.search
PATCH /branches/:id/toggle-status bound.toggleStatus
GET /branches/:id bound.getOne
POST /branches yes bound.add
PUT /branches/:id yes bound.edit
DELETE /branches/delete bound.delete
DELETE /branches/:id bound.delete

Campaign

Mounted at /campaigns. Source: api/src/routes/campaign.routes.js.

Method Path Body documented Handler
POST /campaigns/preview campaignController.preview
POST /campaigns/run-due campaignController.runDue
GET /campaigns campaignController.list
POST /campaigns campaignController.create
GET /campaigns/:id campaignController.get
PUT /campaigns/:id campaignController.update
DELETE /campaigns/:id campaignController.remove
POST /campaigns/:id/send campaignController.send
POST /campaigns/:id/schedule campaignController.schedule

Cashback

Mounted at /cashback. Source: api/src/routes/cashback.routes.js.

Method Path Body documented Handler
GET /cashback/settings cashbackController.getSettings
PUT /cashback/settings cashbackController.saveSettings
POST /cashback/settings cashbackController.saveSettings
GET /cashback/recent cashbackController.recent

Categories

Mounted at /categories. Source: api/src/routes/categories.routes.js.

Method Path Body documented Handler
GET /categories yes categoriesController.getAll
GET /categories/options error.message
GET /categories/getDataChanges categoriesController.getDataChanges
POST /categories/categoriesImport yes categoriesController.categoriesImport
POST /categories/exportCategories categoriesController.exportCategories
POST /categories/uploadCategoryImage categoriesController.uploadCategoryImage
DELETE /categories/categoryImageDelete categoriesController.categoryImageDelete
GET /categories/getCategoryAjaxList categoriesController.getCategoryAjaxList
GET /categories/getCategoriesWithValidItems categoriesController.getCategoriesWithValidItems
DELETE /categories/delete yes categoriesController.bulkDelete
GET /categories/getCategoryDetails error.message
GET /categories/:id yes error.message
POST /categories yes categoriesController.create
PUT /categories/:id yes categoriesController.update
PATCH /categories/:id/toggle-status yes error.message
DELETE /categories/:id yes error.message

Common pdf

Mounted at /common-pdf. Source: api/src/routes/common-pdf.routes.js.

Method Path Body documented Handler
POST /common-pdf/generate commonPdfController.generatePdf

Coupon

Mounted at /coupons. Source: api/src/routes/coupon.routes.js.

Method Path Body documented Handler
POST /coupons/validate couponController.validate
GET /coupons couponController.list
POST /coupons couponController.create
PUT /coupons/:id couponController.update
DELETE /coupons/:id couponController.remove

Credit

Mounted at /credit. Source: api/src/routes/credit.routes.js.

Method Path Body documented Handler
GET /credit/settings creditController.getSettings
PUT /credit/settings creditController.saveSettings
POST /credit/settings creditController.saveSettings
GET /credit/outstanding creditController.outstanding
GET /credit/check-limit creditController.checkLimit
POST /credit/run-reminders creditController.runReminders
POST /credit/reminder/:customerId creditController.sendReminder

Crons

Mounted at /crons. Source: api/src/routes/crons.routes.js.

Method Path Body documented Handler
POST /crons/cronCreateFile cronsController.cronCreateFile
GET /crons cronsController.getAllCronJobs
POST /crons cronsController.createCronJob
PUT /crons/:name cronsController.updateCronJob
DELETE /crons/:name cronsController.deleteCronJob
POST /crons/:name/start cronsController.startCronJob
POST /crons/:name/stop cronsController.stopCronJob
POST /crons/:name/execute cronsController.executeCronJob
GET /crons/:name/logs cronsController.getCronLogs

Customer categories

Mounted at /customer-category. Source: api/src/routes/customer-categories.routes.js.

Also reachable at /customercategory (legacy php path support).

Method Path Body documented Handler
GET /customer-category yes customerCategoryController.getAll
POST /customer-category yes customerCategoryController.add
GET /customer-category/getDataChanges customerCategoryController.getDataChanges
GET /customer-category/getCategoryDetails customerCategoryController.getCategoryDetails
GET /customer-category/getCustomerCategoryAjaxList customerCategoryController.getCustomerCategoryAjaxList
POST /customer-category/customercategoryImport yes customerCategoryController.customercategoryImport
POST /customer-category/importcustomercategory yes customerCategoryController.customercategoryImport
POST /customer-category/exportCustomerCategory customerCategoryController.exportCustomerCategory
POST /customer-category/exportcustomerCategory customerCategoryController.exportCustomerCategory
GET /customer-category/:id yes customerCategoryController.getOne
PUT /customer-category/:id yes customerCategoryController.edit
DELETE /customer-category/delete yes customerCategoryController.delete
DELETE /customer-category yes customerCategoryController.delete

Customers

Mounted at /customers. Source: api/src/routes/customers.routes.js.

Method Path Body documented Handler
GET /customers customersController.getCustomers
GET /customers/search yes customersController.searchCustomers
GET /customers/getCustomersAjaxList yes customersController.getCustomersAjaxList
GET /customers/customerGraphicalReports customersController.customerGraphicalReports
GET /customers/getDataChanges customersController.getDataChanges
POST /customers/customersImport yes customersController.customersImport
GET /customers/customerOutstandingReportTable customersController.customerOutstandingReportTable
POST /customers/exportCustomers customersController.exportCustomers
POST /customers/exportcustomers customersController.exportCustomers
GET /customers/customerPaymentDetails customersController.customerPaymentDetails
GET /customers/getCustomerDetails customersController.getCustomer
GET /customers/transactionDetails customersController.transactionDetails
POST /customers/transaction customersController.transaction
DELETE /customers/deleteTransaction customersController.deleteTransaction
POST /customers/uploadTransactionImage customersController.uploadTransactionImage
GET /customers/tier/:tier customersController.getCustomersByTier
GET /customers/:id/summary customersController.getCustomerSummary
GET /customers/:id customersController.getCustomer
POST /customers yes customersController.createCustomer
POST /customers/:id/loyalty/points yes customersController.addLoyaltyPoints
POST /customers/:id/loyalty/redeem yes customersController.redeemPoints
PUT /customers/:id/preferences yes customersController.updatePreferences
PUT /customers/:id yes customersController.updateCustomer
DELETE /customers/delete customersController.delete
DELETE /customers/:id customersController.deleteCustomer

Dashboard

Mounted at /dashboard. Source: api/src/routes/dashboard.routes.js.

Method Path Body documented Handler
GET /dashboard/welcome dashboardController.getDashboardCurrentWish
GET /dashboard/getDashboardCurrentWish dashboardController.getDashboardCurrentWish
GET /dashboard/getDashboardPaymentModeData yes dashboardController.getDashboardPaymentModeData
GET /dashboard/getPendingActivities yes dashboardController.getPendingActivities
GET /dashboard/getDashboardTopPerformers yes dashboardController.getDashboardTopPerformers
GET /dashboard/getDashboardBestSellingProducts yes dashboardController.getDashboardBestSellingProducts
GET /dashboard/getDashboardTotalAmounts yes dashboardController.getDashboardTotalAmounts
GET /dashboard/getDashboardSalesPurchase yes dashboardController.getDashboardSalesPurchase
GET /dashboard/getDashboardExpiredProducts yes dashboardController.getDashboardExpiredProducts
GET /dashboard/getProfitSummary yes dashboardController.getProfitSummary
GET /dashboard/getOverview yes dashboardController.getOverview
GET /dashboard/debug-session-filter dashboardController.debugSessionFilter
GET /dashboard/setupChecklist dashboardController.getSetupChecklist

Easy tables

Mounted at /easy-table. Source: api/src/routes/easy-tables.routes.js.

Method Path Body documented Handler
GET /easy-table/data easyTableController.getTableData
GET /easy-table easyTableController.getAll
GET /easy-table/:id easyTableController.getOne
POST /easy-table easyTableController.create
PUT /easy-table/:id easyTableController.update
DELETE /easy-table/:id easyTableController.delete

Expenses

Mounted at /expenses. Source: api/src/routes/expenses.routes.js.

Method Path Body documented Handler
GET /expenses expensesController.getAll
GET /expenses/expensesReportTable expensesController.expensesReportTable
GET /expenses/getDataChanges expensesController.getDataChanges
POST /expenses/expensesImport expensesController.expensesImport
POST /expenses/exportExpenses expensesController.exportExpenses
GET /expenses/getExpenseDetails expensesController.getExpenseDetails
GET /expenses/summary expensesController.getSummary
GET /expenses/category/:category expensesController.getByCategory
GET /expenses/type/:type expensesController.getByType
GET /expenses/:id expensesController.getOne
POST /expenses expensesController.create
PUT /expenses/:id expensesController.update
DELETE /expenses/delete expensesController.delete
DELETE /expenses expensesController.delete

Install

Mounted at /install. Source: api/src/routes/install.routes.js.

Method Path Body documented Handler
POST /install/add yes installController.add
POST /install yes installController.add
POST /install/cleanup yes installController.cleanup

Items

Mounted at /items. Source: api/src/routes/items.routes.js.

Method Path Body documented Handler
POST /items/accesskiosk itemsController.accesskiosk
POST /items/accessQr itemsController.accessQr
POST /items/accessMobileApp itemsController.accessMobileApp
GET /items itemsController.getAll
GET /items/itemLowStockTable itemsController.itemLowStockTable
GET /items/getOnlineItemsAjaxList itemsController.getOnlineItemsAjaxList
GET /items/onlineSalesItemsAjaxLists itemsController.onlineSalesItemsAjaxLists
POST /items/instanceItemInsert itemsController.instanceItemInsert
GET /items/category/:categoryId itemsController.getByCategory
GET /items/search itemsController.search
GET /items/quantityCount itemsController.quantityCount
GET /items/getDataChanges itemsController.getDataChanges
POST /items/itemsImport itemsController.itemsImport
POST /items/exportItems itemsController.exportItems
GET /items/export/jsonld itemsController.exportCatalogueJsonLd
DELETE /items/demo itemsController.purgeDemoData
POST /items/demo itemsController.reseedDemoData
POST /items/createFamily itemsController.createFamily
GET /items/family itemsController.getFamily
POST /items/bulkUpdatePrices itemsController.bulkUpdatePrices
POST /items/bulkPricePreview itemsController.bulkPricePreview
POST /items/bulkSetMargin itemsController.bulkSetMargin
POST /items/marginPreview itemsController.marginPreview
GET /items/priceHistory/:id itemsController.getPriceHistory
GET /items/bulkPriceHistory itemsController.getBulkPriceUpdates
POST /items/bulkUpdateStock itemsController.bulkUpdateStock
POST /items/bulkStockPreview itemsController.bulkStockPreview
GET /items/bulkStockHistory itemsController.getBulkStockUpdates
GET /items/categoryItemsReportTable itemsController.categoryItemsReportTable
GET /items/supplierItemsReportTable itemsController.supplierItemsReportTable
GET /items/itemReportTable itemsController.itemReportTable
POST /items/uploadItemMultiImage itemsController.uploadItemMultiImage
GET /items/getReceivingItemsAjaxList itemsController.getReceivingItemsAjaxList
GET /items/bySupplier itemsController.getItemsBySupplier
POST /items/stockAdjustment itemsController.stockAdjustment
POST /items/updateKioskStatus itemsController.updateKioskStatus
POST /items/bulkUpdateKioskStatus itemsController.bulkUpdateKioskStatus
GET /items/getItemsByCategoryId itemsController.getItemsByCategoryId
GET /items/itemSearchTable itemsController.itemSearchTable
POST /items/updateItemQuantity itemsController.updateItemQuantity
POST /items/quickPatch itemsController.quickPatch
GET /items/gstReadiness itemsController.gstReadiness
GET /items/categoryProductDetails itemsController.categoryProductDetails
GET /items/supplierProductDetails itemsController.supplierProductDetails
GET /items/getCustomerSearchItemsAjaxList itemsController.getCustomerSearchItemsAjaxList
GET /items/itemStockReportTable itemsController.itemStockReportTable
GET /items/getJSONhsncode itemsController.getJSONhsncode
POST /items yes itemsController.add
DELETE /items itemsController.delete
DELETE /items/delete itemsController.delete
GET /items/getItemDetails itemsController.getItemDetails
GET /items/:id itemsController.getOne
PUT /items/:id yes itemsController.edit

Loyalty

Mounted at /loyalty. Source: api/src/routes/loyalty.routes.js.

Method Path Body documented Handler
GET /loyalty/config loyaltyController.getConfig
PUT /loyalty/config loyaltyController.saveConfig
POST /loyalty/config loyaltyController.saveConfig
POST /loyalty/preview loyaltyController.preview
GET /loyalty/report/liability loyaltyController.liability
GET /loyalty/customer/:id loyaltyController.summary

Messaging

Mounted at /messaging. Source: api/src/routes/messaging.routes.js.

Method Path Body documented Handler
GET /messaging/providers messagingController.providers
GET /messaging/settings messagingController.getSettings
PUT /messaging/settings messagingController.saveSettings
POST /messaging/settings messagingController.saveSettings
POST /messaging/test messagingController.test

Purchase orders

Mounted at /purchaseOrders. Source: api/src/routes/purchase-orders.routes.js.

Method Path Body documented Handler
POST /purchaseOrders controller.create
GET /purchaseOrders controller.list
GET /purchaseOrders/:id controller.getById
PUT /purchaseOrders/:id controller.update
POST /purchaseOrders/:id/transition controller.transition
DELETE /purchaseOrders/:id controller.remove

Quotes

Mounted at /quotes. Source: api/src/routes/quotes.routes.js.

Method Path Body documented Handler
POST /quotes controller.create
GET /quotes controller.list
GET /quotes/:id controller.getById
PUT /quotes/:id controller.update
POST /quotes/:id/transition controller.transition
POST /quotes/:id/share controller.share
DELETE /quotes/:id controller.remove

Receivings

Mounted at /receivings. Source: api/src/routes/receivings.routes.js.

Method Path Body documented Handler
POST /receivings receivingsController.create
GET /receivings receivingsController.getAll
GET /receivings/receivingReportTable receivingsController.receivingReportTable
GET /receivings/supplierReceivingReportTable receivingsController.supplierReceivingReportTable
GET /receivings/returnReceivingReportTable receivingsController.returnReceivingReportTable
GET /receivings/receivingsGraphicalReports receivingsController.receivingsGraphicalReports
GET /receivings/productBasedReceivingReturnDetails receivingsController.productBasedReceivingReturnDetails
GET /receivings/summary receivingsController.getSummary
GET /receivings/pendingReceivingReportTable receivingsController.pendingReceivingReportTable
GET /receivings/pendingSupplierReportTable receivingsController.pendingSupplierReportTable
POST /receivings/receivedReceiving receivingsController.receivedReceiving
POST /receivings/returnReceiving receivingsController.returnReceiving
PUT /receivings/returnReceiving receivingsController.returnReceiving
GET /receivings/getDataChanges receivingsController.getDataChanges
GET /receivings/receivingsPdf receivingsController.receivingsPdf
POST /receivings/emailToSupplier receivingsController.emailToSupplier
POST /receivings/exportReceivings receivingsController.exportReceivings
POST /receivings/exportreceivings receivingsController.exportReceivings
GET /receivings/supplierReceivingDetails receivingsController.supplierReceivingDetails
POST /receivings/uploadReceivingImage receivingsController.uploadReceivingImage
GET /receivings/pendingReceivingProductDetails receivingsController.pendingReceivingProductDetails
GET /receivings/returnReceivingProductView receivingsController.returnReceivingProductView
GET /receivings/returnPrintDetails receivingsController.returnPrintDetails
GET /receivings/gstTwoReportTable receivingsController.gstTwoReportTable
GET /receivings/gstNineReportTable receivingsController.gstNineReportTable
POST /receivings/companyPriceUpdate receivingsController.companyPriceUpdate
PUT /receivings/companyPriceUpdate receivingsController.companyPriceUpdate
GET /receivings/returnReceivingProductDetails receivingsController.returnReceivingProductDetails
DELETE /receivings/delete receivingsController.delete
GET /receivings/:id receivingsController.getById
PUT /receivings/:id receivingsController.update
PATCH /receivings/:id/status receivingsController.updateStatus

Registers

Mounted at /registers. Source: api/src/routes/registers.routes.js.

Method Path Body documented Handler
GET /registers/getDataChanges registersController.getDataChanges
GET /registers/getcashField registersController.getcashField
GET /registers/registerReportTable yes registersController.registerReportTable
GET /registers/registeropendateFilter registersController.registeropendateFilter
GET /registers/registerFindStatus registersController.registerFindStatus
POST /registers/registerAdd yes registersController.registerAdd
POST /registers/registerUpdate registersController.registerUpdate
POST /registers/registerInDetail yes registersController.registerInDetail
POST /registers/registerClose yes registersController.registerClose
GET /registers/cashRegisterOpenManual registersController.cashRegisterOpenManual
GET /registers/getCashRegister registersController.getCashRegister
POST /registers/registerCountedAmount yes registersController.registerCountedAmount
POST /registers/registerPaymentNote yes registersController.registerPaymentNote
GET /registers/registerSaleDetails yes registersController.registerSaleDetails
GET /registers/getRegisterReportDetails registersController.getRegisterReportDetails
GET /registers/getRegisterReportPdfDetails registersController.getRegisterReportPdfDetails
POST /registers/registerDenomsubmit yes registersController.registerDenomsubmit
GET /registers/editCashDenomination registersController.editCashDenomination
DELETE /registers/deleteCashDenomination registersController.deleteCashDenomination
POST /registers/deleteCashInOut yes registersController.deleteCashInOut

Roles

Mounted at /roles. Source: api/src/routes/roles.routes.js.

Method Path Body documented Handler
GET /roles rolesController.list
POST /roles/seed rolesController.seed
GET /roles/:id rolesController.getById
POST /roles rolesController.create
PUT /roles/:id rolesController.update
PATCH /roles/:id rolesController.update
DELETE /roles/:id rolesController.remove

Sales

Mounted at /sales. Source: api/src/routes/sales.routes.js.

Method Path Body documented Handler
GET /sales/getTablesWithActiveOrders salesController.getTablesWithActiveOrders
POST /sales/getTablesWithActiveOrders salesController.getTablesWithActiveOrders
POST /sales/kioskOrder salesController.kioskOrder
POST /sales/generateRazorPayQrCodekiosk salesController.generateRazorPayQrCodekiosk
POST /sales/getRazorPayQrStatus salesController.getRazorPayQrStatus
POST /sales/razorPayQrCodeClose salesController.razorPayQrCodeClose
POST /sales/fetchLastSale salesController.fetchLastSale
POST /sales/kitchenPrint salesController.kitchenPrint
POST /sales/multiKitchenPrint salesController.multiKitchenPrint
POST /sales/markKitchenPrinted salesController.markKitchenPrinted
POST /sales/qrOrder salesController.qrOrder
GET /sales/getNewSale salesController.getNewSale
POST /sales/getOrderHistory salesController.getOrderHistory
POST /sales/updateOrder salesController.updateOrder
PUT /sales/updateOrder salesController.updateOrder
POST /sales/searchProducts salesController.searchProducts
POST /sales/getFrequentItems salesController.getFrequentItems
GET /sales/getListKot salesController.getListKot
GET /sales/getCustomerPrint salesController.getCustomerPrint
POST /sales yes salesController.create
GET /sales salesController.getAll
GET /sales/dailySalesReports salesController.dailySalesReports
GET /sales/dailyReportPdf salesController.dailyReportPdf
GET /sales/salesGraphicalReports salesController.salesGraphicalReports
GET /sales/itemGraphicalReports salesController.itemGraphicalReports
GET /sales/salesReports salesController.salesReports
GET /sales/itemSalesReportTable salesController.itemSalesReportTable
GET /sales/taxSummaryReportTable salesController.taxSummaryReportTable
GET /sales/categorySalesReportTable salesController.categorySalesReportTable
GET /sales/supplierSalesReportTable salesController.supplierSalesReportTable
GET /sales/customerSalesReportTable salesController.customerSalesReportTable
GET /sales/salesSummaryReports salesController.salesSummaryReports
GET /sales/instantSalesReports salesController.instantSalesReports
GET /sales/instantSaleDetails salesController.instantSaleDetails
GET /sales/getLatestSales salesController.getLatestSales
GET /sales/userReportTable salesController.userReportTable
GET /sales/userGraphicalReports salesController.userGraphicalReports
GET /sales/returnSalesReportTable salesController.returnSalesReportTable
GET /sales/productBasedReturnDetails salesController.productBasedReturnDetails
GET /sales/pendingSalesReportTable salesController.pendingSalesReportTable
GET /sales/pendingCustomerReportTable salesController.pendingCustomerReportTable
GET /sales/taxSalesReports salesController.taxSalesReports
GET /sales/paymentSalesTranscationReportTable salesController.paymentSalesTranscationReportTable
GET /sales/paymentSaleTypeReport salesController.paymentSaleTypeReport
GET /sales/paymentReturnSalesTranscationReportTable salesController.paymentReturnSalesTranscationReportTable
GET /sales/paymentGraphicalReports salesController.paymentGraphicalReports
POST /sales/salesReceipt salesController.salesReceipt
GET /sales/salesPdf salesController.salesPdf
POST /sales/:id/invoiceLink salesController.createInvoiceLink
GET /sales/salesMailPdf salesController.salesMailPdf
POST /sales/returnSales salesController.returnSales
POST /sales/exportSales salesController.exportSales
POST /sales/exportsales salesController.exportSales
GET /sales/exportsales salesController.exportSales
GET /sales/getDataChanges salesController.getDataChanges
GET /sales/getReturnSalesDetails salesController.getReturnSalesDetails
GET /sales/returnPrintDetails salesController.returnPrintDetails
GET /sales/getSalesAjaxList salesController.getSalesAjaxList
GET /sales/getSaleQtyDetail salesController.getSaleQtyDetail
GET /sales/ServerStatus salesController.ServerStatus
GET /sales/customerSaleDetails salesController.customerSaleDetails
GET /sales/customerCategorySaleDetails salesController.customerCategorySaleDetails
GET /sales/itemSaleDetails salesController.itemSaleDetails
GET /sales/categorySaleDetails salesController.categorySaleDetails
GET /sales/userSalesDetails salesController.userSalesDetails
GET /sales/returnProductDetails salesController.returnProductDetails
GET /sales/returnProductView salesController.returnProductView
GET /sales/pendingProductDetails salesController.pendingProductDetails
GET /sales/gstOneReportTable salesController.gstOneReportTable
GET /sales/gstThreeReportTable salesController.gstThreeReportTable
GET /sales/gstOneReportTableJson salesController.gstOneReportTableJson
POST /sales/dailySalesMail salesController.dailySalesMail
POST /sales/salesPaymentClose salesController.salesPaymentClose
GET /sales/qrCodeClose salesController.qrCodeClose
GET /sales/qrSalePayementUpdate salesController.qrSalePayementUpdate
GET /sales/generateQrCode salesController.generateQrCode
GET /sales/getQrStatus salesController.getQrStatus
GET /sales/phonepeQr salesController.phonepeQr
GET /sales/phonepeQrStatus salesController.phonepeQrStatus
POST /sales/createRazorPayMobile salesController.createRazorPayMobile
POST /sales/fetchRazorPayQrStatusMobile salesController.fetchRazorPayQrStatusMobile
GET /sales/kotDiscountReports salesController.kotDiscountReports
GET /sales/kotTablewiseDetails salesController.kotTablewiseDetails
GET /sales/pendingCustomerCategoryReportTable salesController.pendingCustomerCategoryReportTable
GET /sales/kioskReports salesController.kioskReports
GET /sales/kiosksSummaryReports salesController.kiosksSummaryReports
GET /sales/kiosksGraphicalReports salesController.kiosksGraphicalReports
GET /sales/itemExpiryReportTable salesController.itemExpiryReportTable
DELETE /sales/delete salesController.delete
POST /sales/cancel/:id salesController.cancel
GET /sales/cancel/:id salesController.cancel
GET /sales/:id/edit salesController.getOne
GET /sales/:id salesController.getOne
PUT /sales/:id yes salesController.update
DELETE /sales/:id salesController.delete

Settings groups

Mounted at /settings/group. Source: api/src/routes/settings-groups.routes.js.

Method Path Body documented Handler
POST /settings/group/copy controller.copy
GET /settings/group/:group controller.read
PUT /settings/group/:group controller.write

Settings

Mounted at /settings. Source: api/src/routes/settings.routes.js.

Also reachable at /setting (legacy php path support).

Method Path Body documented Handler
GET /settings/getJSONCountry settingController.getJSONCountry
GET /settings/getJSONState settingController.getJSONState
GET /settings/getJSONCurrency settingController.getJSONCurrency
GET /settings/getJSONTimeZone settingController.getJSONTimeZone
POST /settings/forgotPassword settingController.forgotPassword
GET /settings/getDefaultCustomer settingController.getDefaultCustomer
GET /settings/getDefaultSupplier settingController.getDefaultSupplier
GET /settings/getDefaultCustomerSupplier settingController.getDefaultCustomerSupplier
GET /settings/backupTable settingController.backupTable
PUT /settings/general yes settingController.updateGeneralSetting
PUT /settings/updateGeneralSetting yes settingController.updateGeneralSetting
POST /settings/updateGeneralSetting yes settingController.updateGeneralSetting
POST /settings/updateCommonSettings yes settingController.updateCommonSettings
PUT /settings/updateCommonSettings yes settingController.updateCommonSettings
GET /settings/branchModules settingController.getBranchModules
GET /settings/taxProfile settingController.getTaxProfile
GET /settings/priceLists settingController.getPriceLists
POST /settings/priceLists settingController.savePriceList
DELETE /settings/priceLists/:id settingController.deletePriceList
GET /settings/modifierGroups settingController.getModifierGroups
POST /settings/modifierGroups settingController.addModifierGroup
PUT /settings/modifierGroups/:id settingController.editModifierGroup
DELETE /settings/modifierGroups/:id settingController.deleteModifierGroup
GET /settings/getTaxAll settingController.getTaxAll
GET /settings/getTaxAjaxList settingController.getTaxAjaxList
GET /settings/getTaxGroup settingController.getTaxGroup
POST /settings/addTax yes settingController.addTax
POST /settings/editTax yes settingController.editTax
PUT /settings/editTax yes settingController.editTax
DELETE /settings/deleteTax settingController.deleteTax
GET /settings/getUnitAll settingController.getUnitAll
GET /settings/getUnitAjaxList settingController.getUnitAjaxList
POST /settings/addUnit yes settingController.addUnit
POST /settings/editUnit yes settingController.editUnit
PUT /settings/editUnit yes settingController.editUnit
DELETE /settings/deleteUnit settingController.deleteUnit
POST /settings/addTaxGroup yes settingController.addTaxGroup
POST /settings/editTaxGroup yes settingController.editTaxGroup
PUT /settings/editTaxGroup yes settingController.editTaxGroup
DELETE /settings/deleteTaxGroup settingController.deleteTaxGroup
POST /settings/addDenomForm yes settingController.addDenomForm
POST /settings/addDenomData yes settingController.addDenomData
GET /settings/getDenomAll settingController.getDenomAll
PUT /settings/editDenomForm yes settingController.editDenomForm
DELETE /settings/deleteDenom settingController.deleteDenom
GET /settings/getPaymentAll settingController.getPaymentAll
POST /settings/addPaymentData yes settingController.addPaymentData
PUT /settings/editPaymentForm yes settingController.editPaymentForm
DELETE /settings/deletePayment settingController.deletePayment
POST /settings/updateWay2SmsSetting yes settingController.updateWay2SmsSetting
POST /settings/updateTextLocalSmsSetting yes settingController.updateTextLocalSmsSetting
POST /settings/updateBranchLogo settingController.updateBranchLogo
POST /settings/updateKioskImages settingController.updateKioskImages
POST /settings/storedImageData settingController.storedImageData
PUT /settings/storedImageData settingController.storedImageData
DELETE /settings/branchImageDelete settingController.branchImageDelete
GET /settings/updateCustomerSettings settingController.updateCustomerSettings
GET /settings/updateSupplierSettings settingController.updateSupplierSettings
POST /settings/changePassword yes settingController.changePassword
POST /settings/salesSmsReceipt settingController.salesSmsReceipt
POST /settings/saveWhatsAppReceipt settingController.saveWhatsAppReceipt
GET /settings/getWhatsAppReceipt settingController.getWhatsAppReceipt
POST /settings/paymentsKey settingController.paymentsKey
POST /settings/phonepepaymentsKey settingController.phonepepaymentsKey
DELETE /settings/deleteCollection settingController.deleteCollection
POST /settings/deleteAllSelectedCollection settingController.deleteAllSelectedCollection
GET /settings/getJSONGstState settingController.getJSONGstState
POST /settings/restoreBackup settingController.restoreBackup
GET /settings/getDasboardSalesCount settingController.getDasboardSalesCount
GET /settings/getRecycleBin settingController.getRecycleBin
GET /settings/autoSuggestionRecycleBinTableField settingController.autoSuggestionRecycleBinTableField
GET /settings/getAllCollectionTotal settingController.getAllCollectionTotal
POST /settings/emailSetting settingController.emailSetting
PUT /settings/emailSetting settingController.emailSetting
POST /settings/kioskAccountSettings settingController.kioskAccountSettings
PUT /settings/kioskAccountSettings settingController.kioskAccountSettings
POST /settings/kioskPrinterSettings settingController.kioskPrinterSettings
PUT /settings/kioskPrinterSettings settingController.kioskPrinterSettings
POST /settings/kioskPayment settingController.kioskPayment
PUT /settings/kioskPayment settingController.kioskPayment
POST /settings/kioskupdateInfo settingController.kioskupdateInfo
PUT /settings/kioskupdateInfo settingController.kioskupdateInfo
POST /settings/addTableOrderData settingController.addTableOrderData
GET /settings/getTableOrderAll settingController.getTableOrderAll
PUT /settings/editTableOrderForm settingController.editTableOrderForm
DELETE /settings/deleteTableOrder settingController.deleteTableOrder
GET /settings/getThemeSettings settingController.getThemeSettings
POST /settings/updateThemeSettings settingController.updateThemeSettings
PUT /settings/updateThemeSettings settingController.updateThemeSettings

Shifts

Mounted at /shifts. Source: api/src/routes/shifts.routes.js.

Method Path Body documented Handler
GET /shifts/current shiftsController.current
POST /shifts/clock-in shiftsController.clockIn
POST /shifts/clock-out shiftsController.clockOut
POST /shifts/clock-by-card shiftsController.clockByCard
GET /shifts/report shiftsController.report
POST /shifts/set-rate shiftsController.setRate
POST /shifts/set-targets shiftsController.setTargets
GET /shifts/schedule shiftsController.listSchedule
POST /shifts/schedule shiftsController.addSchedule
DELETE /shifts/schedule/:id shiftsController.deleteSchedule
PUT /shifts/:id shiftsController.editShift
GET /shifts shiftsController.list

Stock logs

Mounted at /stock-logs. Source: api/src/routes/stock-logs.routes.js.

Also reachable at /stocklogs (legacy path support).

Method Path Body documented Handler
GET /stock-logs stockLogController.getAll
POST /stock-logs/exportStocklogs stockLogController.exportStocklogs
POST /stock-logs/cleanup yes stockLogController.cleanupOldDeletedLogs
GET /stock-logs/export stockLogController.export
PUT /stock-logs/item/:itemId/update-name yes stockLogController.updateItemName
GET /stock-logs/:id stockLogController.getOne
POST /stock-logs yes stockLogController.create
DELETE /stock-logs stockLogController.delete

Suppliers

Mounted at /suppliers. Source: api/src/routes/suppliers.routes.js.

Method Path Body documented Handler
GET /suppliers yes suppliersController.getAll
GET /suppliers/getSuppliersAjaxList yes suppliersController.getSuppliersAjaxList
GET /suppliers/supplierGraphicalReports suppliersController.supplierGraphicalReports
GET /suppliers/getDataChanges suppliersController.getDataChanges
GET /suppliers/getSupplierDetails suppliersController.getSupplierDetails
POST /suppliers/suppliersImport yes suppliersController.suppliersImport
POST /suppliers/exportSuppliers suppliersController.exportSuppliers
POST /suppliers yes suppliersController.add
DELETE /suppliers yes suppliersController.delete
DELETE /suppliers/delete yes suppliersController.delete
GET /suppliers/:id suppliersController.getOne
PUT /suppliers/:id yes suppliersController.edit

Users

Mounted at /users. Source: api/src/routes/users.routes.js.

Method Path Body documented Handler
POST /users/register yes userController.add
POST /users/login userController.login
POST /users/verify yes userController.legacyVerifyLogin
POST /users/mobileLogin yes userController.mobileLogin
POST /users/kioskMobileLogin yes userController.kioskMobileLogin
GET /users/ssoAuth userController.ssoAuth
POST /users/ssoToken/:key/:secret userController.ssoToken
POST /users/planUpdate/:key/:secret userController.planUpdate
GET /users/getUserKeyDetails userController.getUserKeyDetails
POST /users/updateNewPassword yes userController.updateNewPassword
GET /users/verify-token req.user.role
GET /users/userBranchSelection userController.userBranchSelection
GET /users/userDefaultBranchSet userController.userDefaultBranchSet
GET /users/getUserRegisterList userController.getUserRegisterList
GET /users/me userController.getOne
PATCH /users/update-me userController.edit
PATCH /users/update-password userController.updatePassword
DELETE /users/deactivate-me userController.delete
GET /users/listAll userController.getAll
DELETE /users/delete userController.delete
GET /users/userstatusReportTable userController.userstatusReportTable
GET /users/getUserDetails userController.getUserDetails
GET /users/getDataChanges userController.getDataChanges
POST /users/exportUsers userController.exportUsers
GET /users/getUserAjaxList userController.getUserAjaxList
POST /users/uploadUserImage userController.uploadUserImage
DELETE /users/userImageDelete userController.userImageDelete
POST /users/updatePrintSetting userController.updatePrintSetting
GET /users/printType userController.printType
POST /users/userProfile yes userController.userProfile
GET /users/logOut userController.logOut
POST /users/logOut userController.logOut
POST /users/changeBranch yes userController.changeBranch
GET /users/userVerify yes userController.userVerify
POST /users/ssoClientLogin userController.ssoClientLogin

Variants

Mounted at /variants. Source: api/src/routes/variants.routes.js.

Method Path Body documented Handler
GET /variants yes variantsController.getAll
GET /variants/getVariantsAjaxList yes variantsController.getVariantsAjaxList
GET /variants/getVariantDetails yes variantsController.getVariantDetails
POST /variants/exportVariants variantsController.exportVariants
GET /variants/stats variantsController.getStats
GET /variants/search yes variantsController.search
GET /variants/field/:field yes variantsController.getByField
POST /variants/bulk-delete yes variantsController.bulkDelete
DELETE /variants/delete yes variantsController.legacyDelete
GET /variants/:id yes variantsController.getOne
POST /variants yes variantsController.create
PUT /variants/:id yes variantsController.update
DELETE /variants/:id yes variantsController.delete

Whatsapp

Mounted at /whatsapp. Source: api/src/routes/whatsapp.routes.js.

Method Path Body documented Handler
POST /whatsapp/initialize whatsappController.initializeConnection
GET /whatsapp/getQRCode whatsappController.getQRCode
GET /whatsapp/getStatus whatsappController.getConnectionStatus
POST /whatsapp/logout whatsappController.logout
POST /whatsapp/removeDevice whatsappController.removeDevice
POST /whatsapp/sendMessage whatsappController.sendMessage
POST /whatsapp/saveTemplate whatsappController.saveTemplate
POST /whatsapp/updateTemplate whatsappController.updateTemplate
GET /whatsapp/getTemplates whatsappController.getTemplates
POST /whatsapp/deleteTemplate whatsappController.deleteTemplate
POST /whatsapp/getSalesReceiptTemplate whatsappController.getSalesReceiptTemplate