REST API Reference

Welcome to the DigitCare ERP API documentation. The API serves endpoints for accounting, inventory, manufacturing, and user management. All authenticated endpoints require a Bearer token via Sanctum. Set the header Authorization: Bearer {token} in your requests.

354

Total Endpoints

Modules

API Version

💰

Accounting

12 endpoints

GET api/accounting/accounts/{id}/ledger

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Cash Account", "code": "1001", "type": "asset", "nature": "asset", "balance": 50000 } }

GET api/accounting/blueprints

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Data fetched successfully", "data": { "items": [ { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } ], "pagination": { "current_page": 1, "per_page": 20, "total": 1, "last_page": 1 } } }

GET api/accounting/payment-accounts

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Data fetched successfully", "data": { "items": [ { "id": 1, "name": "Cash Account", "code": "1001", "type": "asset", "nature": "asset", "balance": 50000 } ], "pagination": { "current_page": 1, "per_page": 20, "total": 1, "last_page": 1 } } }

POST api/accounting/payment-accounts

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string
code	required\|string
type	required\|string
nature	required\|string (asset\|liability\|equity\|income\|expense)
description	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Cash Account", "code": "1001", "type": "asset", "nature": "asset", "balance": 50000 } }

GET api/accounting/payment-accounts/manage

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

DELETE api/accounting/payment-accounts/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

PATCH api/accounting/payment-accounts/{id}/toggle

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string
code	required\|string
type	required\|string
nature	required\|string (asset\|liability\|equity\|income\|expense)
description	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Cash Account", "code": "1001", "type": "asset", "nature": "asset", "balance": 50000 } }

POST api/accounting/preview-ledger

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

GET api/accounting/reports/account-transactions

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/accounting/reports/bank-balance

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/accounting/reports/chart-of-accounts

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/accounting/transactions

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

📊

Accounts

5 endpoints

GET api/accounts

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/accounts

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string
code	required\|string
type	required\|string
nature	required\|string (asset\|liability\|equity\|income\|expense)
description	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Cash Account", "code": "1001", "type": "asset", "nature": "asset", "balance": 50000 } }

GET api/accounts/{account}

🔒 Auth

Path Parameters

Field	Type / Rules
account	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Cash Account", "code": "1001", "type": "asset", "nature": "asset", "balance": 50000 } }

PATCH api/accounts/{account}

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string
code	required\|string
type	required\|string
nature	required\|string (asset\|liability\|equity\|income\|expense)
description	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Cash Account", "code": "1001", "type": "asset", "nature": "asset", "balance": 50000 } }

DELETE api/accounts/{account}

🔒 Auth

Path Parameters

Field	Type / Rules
account	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

🔹

Activity Log

3 endpoints

GET api/activity-log

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/activity-log/stats

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/activity-log/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

📍

Addresses

3 endpoints

PUT api/addresses/{id}

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

DELETE api/addresses/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

POST api/addresses/{id}/set-default

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

🏷️

Attributes

7 endpoints

GET api/attributes

🔒 Auth products.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/attributes

🔒 Auth products.attributes.manage

Request Body

Field	Type / Rules
name	required\|string
values	required\|array (strings)

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

PUT api/attributes/{id}

🔒 Auth products.attributes.manage

Request Body

Field	Type / Rules
name	required\|string
values	required\|array (strings)

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

DELETE api/attributes/{id}

🔒 Auth products.attributes.manage

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

POST api/attributes/{id}/values

🔒 Auth products.attributes.manage

Request Body

Field	Type / Rules
name	required\|string
values	required\|array (strings)

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

POST api/attributes/{id}/values/reorder

🔒 Auth products.attributes.manage

Request Body

Field	Type / Rules
name	required\|string
values	required\|array (strings)

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

DELETE api/attributes/{id}/values/{valueId}

🔒 Auth products.attributes.manage

Path Parameters

Field	Type / Rules
id	integer\|string
valueId	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

🔐

Auth

12 endpoints

POST api/auth/forgot-password

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

GET api/auth/google/callback

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/auth/google/redirect

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/auth/login

🌐 Public

Request Body

Field	Type / Rules
email	required\|string
password	required\|string

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "token": "1|abcdef123456...", "user": { "id": 1, "name": "John Doe", "email": "admin@example.com", "role": "super-admin", "permissions": [ "users.view", "products.view" ] } } }

POST api/auth/logout

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

GET api/auth/me

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Data fetched successfully", "data": { "items": [ { "id": 1, "name": "John Doe", "email": "admin@example.com", "role": "super-admin", "permissions": [ "all" ] } ], "pagination": { "current_page": 1, "per_page": 20, "total": 1, "last_page": 1 } } }

PUT api/auth/password

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

PUT api/auth/profile

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

POST api/auth/reset-password

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

GET api/auth/sessions

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

DELETE api/auth/sessions

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

DELETE api/auth/sessions/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

🏢

Branches

7 endpoints

GET api/branches

🔒 Auth branch.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Data fetched successfully", "data": { "items": [ { "id": 1, "name": "Main Branch", "email": "branch@example.com", "phone": "01700000000", "address": "Dhaka, Bangladesh", "is_active": true } ], "pagination": { "current_page": 1, "per_page": 20, "total": 1, "last_page": 1 } } }

POST api/branches

🔒 Auth branch.create

Request Body

Field	Type / Rules
name	required\|string
email	nullable\|email
phone	nullable\|string
address	nullable\|string
is_active	boolean

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Main Branch", "email": "branch@example.com", "phone": "01700000000", "address": "Dhaka, Bangladesh", "is_active": true } }

GET api/branches/selected

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/branches/selected

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string
email	nullable\|email
phone	nullable\|string
address	nullable\|string
is_active	boolean

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/branches/{id}

🔒 Auth branch.view

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Main Branch", "email": "branch@example.com", "phone": "01700000000", "address": "Dhaka, Bangladesh", "is_active": true } }

PUT api/branches/{id}

🔒 Auth branch.edit

Request Body

Field	Type / Rules
name	required\|string
email	nullable\|email
phone	nullable\|string
address	nullable\|string
is_active	boolean

Requires Authorization: Bearer {token} header.

Response Example 200 OK

DELETE api/branches/{id}

🔒 Auth branch.delete

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

📂

Central

3 endpoints

POST api/central/login

🔒 Auth

Request Body

Field	Type / Rules
email	required\|string
password	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/central/tenants/create

🔒 Auth

Request Body

Field	Type / Rules
id	required\|string
domain	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "output": "..." } }

POST api/central/tenants/seed

🔒 Auth

Request Body

Field	Type / Rules
id	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "output": "..." } }

🔹

Customer Portal

13 endpoints

GET api/customer-portal/dashboard

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/customer-portal/invoices

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Data fetched successfully", "data": { "items": [ { "id": 1, "invoice_number": "INV-0001", "customer": { "id": 1, "name": "Customer Name" }, "total": 5000, "status": "paid", "invoice_date": "2026-03-08", "items": [ { "variant_id": 1, "name": "Product A", "quantity": 2, "price": 2500 } ] } ], "pagination": { "current_page": 1, "per_page": 20, "total": 1, "last_page": 1 } } }

GET api/customer-portal/invoices/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "invoice_number": "INV-0001", "customer": { "id": 1, "name": "Customer Name" }, "total": 5000, "status": "paid", "invoice_date": "2026-03-08", "items": [ { "variant_id": 1, "name": "Product A", "quantity": 2, "price": 2500 } ] } }

GET api/customer-portal/invoices/{id}/download

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/customer-portal/ledger

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/customer-portal/payments

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/customer-portal/payments/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

GET api/customer-portal/profile

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

PUT api/customer-portal/profile

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

PUT api/customer-portal/profile/password

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

GET api/customer-portal/vouchers

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Data fetched successfully", "data": { "items": [ { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } ], "pagination": { "current_page": 1, "per_page": 20, "total": 1, "last_page": 1 } } }

GET api/customer-portal/vouchers/{type}/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
type	integer\|string
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

GET api/customer-portal/vouchers/{type}/{id}/download

🔒 Auth

Path Parameters

Field	Type / Rules
type	integer\|string
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

🔹

Dashboard

7 endpoints

GET api/dashboard/activities

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/dashboard/charts

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/dashboard/financial

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/dashboard/inventory

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/dashboard/manufacturing

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Data fetched successfully", "data": { "items": [ { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } ], "pagination": { "current_page": 1, "per_page": 20, "total": 1, "last_page": 1 } } }

GET api/dashboard/peoples

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Data fetched successfully", "data": { "items": [ { "id": 1, "name": "John Doe", "email": "john@example.com", "phone": "+880...", "type": "customer", "roles": [ { "id": 1, "name": "Customer" } ], "created_at": "2026-01-01" } ], "pagination": { "current_page": 1, "per_page": 20, "total": 1, "last_page": 1 } } }

GET api/dashboard/top-products

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Data fetched successfully", "data": { "items": [ { "id": 1, "name": "Product Name", "type": "simple", "status": "active", "categories": [ { "id": 1, "name": "Category A" } ], "variants": [ { "id": 1, "sku": "SKU-001", "price": 500, "stock": 100 } ] } ], "pagination": { "current_page": 1, "per_page": 20, "total": 1, "last_page": 1 } } }

🔹

Email Templates

5 endpoints

GET api/email-templates

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/email-templates

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

GET api/email-templates/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

PUT api/email-templates/{id}

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

DELETE api/email-templates/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

🗺️

Geocode

3 endpoints

GET api/geocode/districts

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/geocode/divisions

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/geocode/upazilas

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

🔹

Import Export

3 endpoints

GET api/import-export/{module}/export

🔒 Auth

Path Parameters

Field	Type / Rules
module	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

POST api/import-export/{module}/import

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

GET api/import-export/{module}/template

🔒 Auth

Path Parameters

Field	Type / Rules
module	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

🔹

Inventory

8 endpoints

GET api/inventory/accounts

🔒 Auth stock_accounts.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/inventory/accounts

🔒 Auth stock_accounts.create

Request Body

Field	Type / Rules
name	required\|string
code	required\|string
type	required\|string
nature	required\|string (asset\|liability\|equity\|income\|expense)
description	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Cash Account", "code": "1001", "type": "asset", "nature": "asset", "balance": 50000 } }

PUT api/inventory/accounts/{id}

🔒 Auth stock_accounts.edit

Request Body

Field	Type / Rules
name	required\|string
code	required\|string
type	required\|string
nature	required\|string (asset\|liability\|equity\|income\|expense)
description	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Cash Account", "code": "1001", "type": "asset", "nature": "asset", "balance": 50000 } }

DELETE api/inventory/accounts/{id}

🔒 Auth stock_accounts.delete

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

GET api/inventory/levels

🔒 Auth stock.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/inventory/reports/transactions

🔒 Auth stock.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/inventory/transactions

🔒 Auth stock_transactions.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/inventory/valuation

🔒 Auth stock.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

🧾

Invoices

10 endpoints

GET api/invoices

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/invoices

🔒 Auth

Request Body

Field	Type / Rules
customer_id	required\|integer
branch_id	required\|integer
invoice_date	required\|date
items	required\|array
items.*.variant_id	required\|integer
items.*.quantity	required\|number
items.*.price	required\|number
discount	nullable\|number
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "invoice_number": "INV-0001", "customer": { "id": 1, "name": "Customer Name" }, "total": 5000, "status": "paid", "invoice_date": "2026-03-08", "items": [ { "variant_id": 1, "name": "Product A", "quantity": 2, "price": 2500 } ] } }

GET api/invoices/next-number

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/invoices/setup

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/invoices/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

PUT api/invoices/{id}

🔒 Auth

Request Body

Field	Type / Rules
customer_id	required\|integer
branch_id	required\|integer
invoice_date	required\|date
items	required\|array
items.*.variant_id	required\|integer
items.*.quantity	required\|number
items.*.price	required\|number
discount	nullable\|number
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

DELETE api/invoices/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

GET api/invoices/{id}/download

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

PATCH api/invoices/{id}/lock

🔒 Auth

Request Body

Field	Type / Rules
customer_id	required\|integer
branch_id	required\|integer
invoice_date	required\|date
items	required\|array
items.*.variant_id	required\|integer
items.*.quantity	required\|number
items.*.price	required\|number
discount	nullable\|number
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

PATCH api/invoices/{id}/unlock

🔒 Auth

Request Body

Field	Type / Rules
customer_id	required\|integer
branch_id	required\|integer
invoice_date	required\|date
items	required\|array
items.*.variant_id	required\|integer
items.*.quantity	required\|number
items.*.price	required\|number
discount	nullable\|number
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

🏭

Manufacturing

52 endpoints

GET api/manufacturing/boms

🔒 Auth manufacturing.bom.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/manufacturing/boms

🔒 Auth manufacturing.bom.create

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

GET api/manufacturing/boms/{bom}

🔒 Auth manufacturing.bom.view

Path Parameters

Field	Type / Rules
bom	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

PUT api/manufacturing/boms/{bom}

🔒 Auth manufacturing.bom.edit

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

DELETE api/manufacturing/boms/{bom}

🔒 Auth manufacturing.bom.delete

Path Parameters

Field	Type / Rules
bom	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

POST api/manufacturing/boms/{bom}/lock

🔒 Auth manufacturing.bom.lock_unlock

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

POST api/manufacturing/boms/{bom}/unlock

🔒 Auth manufacturing.bom.lock_unlock

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

GET api/manufacturing/finished-goods-stock-entries

🔒 Auth manufacturing.fg_stock_entries.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/manufacturing/finished-goods-stock-entries

🔒 Auth manufacturing.fg_stock_entries.create

Request Body

Field	Type / Rules
from_branch_id	required\|integer
to_branch_id	required\|integer
items	required\|array
items.*.variant_id	required\|integer
items.*.quantity	required\|number

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

GET api/manufacturing/finished-goods-stock-entries/{finished_goods_stock_entry}

🔒 Auth manufacturing.fg_stock_entries.view

Path Parameters

Field	Type / Rules
finished_goods_stock_entry	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

PUT api/manufacturing/finished-goods-stock-entries/{finished_goods_stock_entry}

🔒 Auth manufacturing.fg_stock_entries.edit

Request Body

Field	Type / Rules
from_branch_id	required\|integer
to_branch_id	required\|integer
items	required\|array
items.*.variant_id	required\|integer
items.*.quantity	required\|number

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

DELETE api/manufacturing/finished-goods-stock-entries/{finished_goods_stock_entry}

🔒 Auth manufacturing.fg_stock_entries.delete

Path Parameters

Field	Type / Rules
finished_goods_stock_entry	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

POST api/manufacturing/finished-goods-stock-entries/{finished_goods_stock_entry}/toggle-lock

🔒 Auth manufacturing.fg_stock_entries.lock_unlock

Request Body

Field	Type / Rules
from_branch_id	required\|integer
to_branch_id	required\|integer
items	required\|array
items.*.variant_id	required\|integer
items.*.quantity	required\|number

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

GET api/manufacturing/material-issues

🔒 Auth manufacturing.material_issues.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/manufacturing/material-issues

🔒 Auth manufacturing.material_issues.create

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

GET api/manufacturing/material-issues/bom-requirements/{productionOrderId}

🔒 Auth manufacturing.material_issues.create

Path Parameters

Field	Type / Rules
productionOrderId	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

GET api/manufacturing/material-issues/{material_issue}

🔒 Auth manufacturing.material_issues.view

Path Parameters

Field	Type / Rules
material_issue	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

PUT api/manufacturing/material-issues/{material_issue}

🔒 Auth manufacturing.material_issues.edit

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

DELETE api/manufacturing/material-issues/{material_issue}

🔒 Auth manufacturing.material_issues.delete

Path Parameters

Field	Type / Rules
material_issue	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

POST api/manufacturing/material-issues/{material_issue}/lock

🔒 Auth manufacturing.material_issues.lock_unlock

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

POST api/manufacturing/material-issues/{material_issue}/unlock

🔒 Auth manufacturing.material_issues.lock_unlock

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

GET api/manufacturing/process-stages

🔒 Auth manufacturing.wip_entries.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

DELETE api/manufacturing/process-stages

🔒 Auth manufacturing.wip_entries.delete

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

GET api/manufacturing/production-completion-reports

🔒 Auth manufacturing.production_completion_reports.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/manufacturing/production-completion-reports

🔒 Auth manufacturing.production_completion_reports.create

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

GET api/manufacturing/production-completion-reports/{production_completion_report}

🔒 Auth manufacturing.production_completion_reports.view

Path Parameters

Field	Type / Rules
production_completion_report	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

PUT api/manufacturing/production-completion-reports/{production_completion_report}

🔒 Auth manufacturing.production_completion_reports.edit

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

DELETE api/manufacturing/production-completion-reports/{production_completion_report}

🔒 Auth manufacturing.production_completion_reports.delete

Path Parameters

Field	Type / Rules
production_completion_report	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

POST api/manufacturing/production-completion-reports/{production_completion_report}/toggle-lock

🔒 Auth manufacturing.production_completion_reports.lock_unlock

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

GET api/manufacturing/production-lines

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

DELETE api/manufacturing/production-lines

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

GET api/manufacturing/production-orders

🔒 Auth manufacturing.production_orders.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/manufacturing/production-orders

🔒 Auth manufacturing.production_orders.create

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

GET api/manufacturing/production-orders/{production_order}

🔒 Auth manufacturing.production_orders.view

Path Parameters

Field	Type / Rules
production_order	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

PUT api/manufacturing/production-orders/{production_order}

🔒 Auth manufacturing.production_orders.edit

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

DELETE api/manufacturing/production-orders/{production_order}

🔒 Auth manufacturing.production_orders.delete

Path Parameters

Field	Type / Rules
production_order	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

POST api/manufacturing/production-orders/{production_order}/lock

🔒 Auth manufacturing.production_orders.lock_unlock

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

GET api/manufacturing/production-orders/{production_order}/raw-material-cost

🔒 Auth manufacturing.production_orders.view

Path Parameters

Field	Type / Rules
production_order	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

POST api/manufacturing/production-orders/{production_order}/unlock

🔒 Auth manufacturing.production_orders.lock_unlock

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

GET api/manufacturing/waste-scrap-entries

🔒 Auth manufacturing.waste_scrap_entries.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/manufacturing/waste-scrap-entries

🔒 Auth manufacturing.waste_scrap_entries.create

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

GET api/manufacturing/waste-scrap-entries/{waste_scrap_entry}

🔒 Auth manufacturing.waste_scrap_entries.view

Path Parameters

Field	Type / Rules
waste_scrap_entry	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

PUT api/manufacturing/waste-scrap-entries/{waste_scrap_entry}

🔒 Auth manufacturing.waste_scrap_entries.edit

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

DELETE api/manufacturing/waste-scrap-entries/{waste_scrap_entry}

🔒 Auth manufacturing.waste_scrap_entries.delete

Path Parameters

Field	Type / Rules
waste_scrap_entry	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

POST api/manufacturing/waste-scrap-entries/{waste_scrap_entry}/toggle-lock

🔒 Auth manufacturing.waste_scrap_entries.lock_unlock

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

GET api/manufacturing/wip-entries

🔒 Auth manufacturing.wip_entries.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/manufacturing/wip-entries

🔒 Auth manufacturing.wip_entries.create

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

GET api/manufacturing/wip-entries/stages

🔒 Auth manufacturing.wip_entries.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/manufacturing/wip-entries/{wip_entry}

🔒 Auth manufacturing.wip_entries.view

Path Parameters

Field	Type / Rules
wip_entry	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

PUT api/manufacturing/wip-entries/{wip_entry}

🔒 Auth manufacturing.wip_entries.edit

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

DELETE api/manufacturing/wip-entries/{wip_entry}

🔒 Auth manufacturing.wip_entries.delete

Path Parameters

Field	Type / Rules
wip_entry	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

POST api/manufacturing/wip-entries/{wip_entry}/toggle-lock

🔒 Auth manufacturing.wip_entries.lock_unlock

Request Body

Field	Type / Rules
name	required\|string
product_id	required\|integer
quantity	required\|number
branch_id	required\|integer
materials	required\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Production Order #1", "quantity": 100, "status": "in_progress", "branch_id": 1 } }

📷

Media

6 endpoints

GET api/media

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Data fetched successfully", "data": { "items": [ { "id": 1, "filename": "photo.webp", "urls": { "large": "\/storage\/media\/large\/photo.webp", "medium": "\/storage\/media\/medium\/photo.webp", "small": "\/storage\/media\/small\/photo.webp" } } ], "pagination": { "current_page": 1, "per_page": 20, "total": 1, "last_page": 1 } } }

POST api/media

🔒 Auth

Request Body

Field	Type / Rules
file	required\|file (image)
alt	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "filename": "photo.webp", "urls": { "large": "\/storage\/media\/large\/photo.webp", "medium": "\/storage\/media\/medium\/photo.webp", "small": "\/storage\/media\/small\/photo.webp" } } }

GET api/media/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "filename": "photo.webp", "urls": { "large": "\/storage\/media\/large\/photo.webp", "medium": "\/storage\/media\/medium\/photo.webp", "small": "\/storage\/media\/small\/photo.webp" } } }

PUT api/media/{id}

🔒 Auth

Request Body

Field	Type / Rules
file	required\|file (image)
alt	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

DELETE api/media/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

POST api/media/{id}/restore

🔒 Auth

Request Body

Field	Type / Rules
file	required\|file (image)
alt	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

👥

Peoples

16 endpoints

GET api/peoples

🔒 Auth users.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/peoples

🔒 Auth users.create

Request Body

Field	Type / Rules
name	required\|string
email	required\|email
password	nullable\|string
phone	nullable\|string
type	required\|string (customer\|supplier\|employee\|staff)
roles	nullable\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "John Doe", "email": "john@example.com", "phone": "+880...", "type": "customer", "roles": [ { "id": 1, "name": "Customer" } ], "created_at": "2026-01-01" } }

POST api/peoples/password-reset

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string
email	required\|email
password	nullable\|string
phone	nullable\|string
type	required\|string (customer\|supplier\|employee\|staff)
roles	nullable\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/peoples/password-reset/verify/{token}

🔒 Auth

Path Parameters

Field	Type / Rules
token	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "John Doe", "email": "john@example.com", "phone": "+880...", "type": "customer", "roles": [ { "id": 1, "name": "Customer" } ], "created_at": "2026-01-01" } }

POST api/peoples/share-link/set-password/{token}

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string
email	required\|email
password	nullable\|string
phone	nullable\|string
type	required\|string (customer\|supplier\|employee\|staff)
roles	nullable\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/peoples/share-link/verify/{token}

🔒 Auth

Path Parameters

Field	Type / Rules
token	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/peoples/{id}

🔒 Auth users.view

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/peoples/{id}

🔒 Auth users.edit

Request Body

Field	Type / Rules
name	required\|string
email	required\|email
password	nullable\|string
phone	nullable\|string
type	required\|string (customer\|supplier\|employee\|staff)
roles	nullable\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

DELETE api/peoples/{id}

🔒 Auth users.delete

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

GET api/peoples/{id}/password-reset-link

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/peoples/{id}/sessions

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

DELETE api/peoples/{id}/sessions

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

DELETE api/peoples/{id}/sessions/{sessionId}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string
sessionId	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

GET api/peoples/{id}/share-link

🔒 Auth users.view

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/peoples/{userId}/addresses

🔒 Auth

Path Parameters

Field	Type / Rules
userId	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/peoples/{userId}/addresses

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string
email	required\|email
password	nullable\|string
phone	nullable\|string
type	required\|string (customer\|supplier\|employee\|staff)
roles	nullable\|array

Requires Authorization: Bearer {token} header.

Response Example 200 OK

🛡️

Permission

6 endpoints

GET api/permission/roles

🔒 Auth roles.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Data fetched successfully", "data": { "items": [ { "id": 1, "name": "Manager", "slug": "manager", "permissions": [ "users.view", "products.view" ], "users_count": 5 } ], "pagination": { "current_page": 1, "per_page": 20, "total": 1, "last_page": 1 } } }

POST api/permission/roles

🔒 Auth roles.create

Request Body

Field	Type / Rules
name	required\|string
description	nullable\|string
permissions	required\|array (permission slugs)

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Manager", "slug": "manager", "permissions": [ "users.view", "products.view" ], "users_count": 5 } }

GET api/permission/roles/permissions

🔒 Auth roles.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/permission/roles/{role}

🔒 Auth roles.view

Path Parameters

Field	Type / Rules
role	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Manager", "slug": "manager", "permissions": [ "users.view", "products.view" ], "users_count": 5 } }

PUT api/permission/roles/{role}

🔒 Auth roles.edit

Request Body

Field	Type / Rules
name	required\|string
description	nullable\|string
permissions	required\|array (permission slugs)

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Manager", "slug": "manager", "permissions": [ "users.view", "products.view" ], "users_count": 5 } }

DELETE api/permission/roles/{role}

🔒 Auth roles.delete

Path Parameters

Field	Type / Rules
role	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

📦

Products

13 endpoints

GET api/products

🔒 Auth products.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/products

🔒 Auth products.create

Request Body

Field	Type / Rules
name	required\|string
type	required\|string (simple\|variable\|grouped\|affiliate)
category_ids	nullable\|array
description	nullable\|string
status	required\|string (active\|inactive)

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "name": "Product Name", "type": "simple", "status": "active", "categories": [ { "id": 1, "name": "Category A" } ], "variants": [ { "id": 1, "sku": "SKU-001", "price": 500, "stock": 100 } ] } }

GET api/products/units

🔒 Auth products.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

DELETE api/products/units

🔒 Auth products.delete

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

GET api/products/{id}

🔒 Auth products.view

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "name": "Product Name", "type": "simple", "status": "active", "categories": [ { "id": 1, "name": "Category A" } ], "variants": [ { "id": 1, "sku": "SKU-001", "price": 500, "stock": 100 } ] } }

PUT api/products/{id}

🔒 Auth products.update

Request Body

Field	Type / Rules
name	required\|string
type	required\|string (simple\|variable\|grouped\|affiliate)
category_ids	nullable\|array
description	nullable\|string
status	required\|string (active\|inactive)

Requires Authorization: Bearer {token} header.

Response Example 200 OK

DELETE api/products/{id}

🔒 Auth products.delete

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

POST api/products/{id}/duplicate

🔒 Auth products.create

Request Body

Field	Type / Rules
name	required\|string
type	required\|string (simple\|variable\|grouped\|affiliate)
category_ids	nullable\|array
description	nullable\|string
status	required\|string (active\|inactive)

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/products/{productId}/variants

🔒 Auth products.view

Path Parameters

Field	Type / Rules
productId	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/products/{productId}/variants

🔒 Auth products.variants.manage

Request Body

Field	Type / Rules
sku	required\|string
price	required\|number
sale_price	nullable\|number
cost_price	nullable\|number
stock	required\|integer
image_id	nullable\|integer

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/products/{productId}/variants/generate

🔒 Auth products.variants.manage

Request Body

Field	Type / Rules
sku	required\|string
price	required\|number
sale_price	nullable\|number
cost_price	nullable\|number
stock	required\|integer
image_id	nullable\|integer

Requires Authorization: Bearer {token} header.

Response Example 200 OK

PUT api/products/{productId}/variants/{variantId}

🔒 Auth products.variants.manage

Request Body

Field	Type / Rules
sku	required\|string
price	required\|number
sale_price	nullable\|number
cost_price	nullable\|number
stock	required\|integer
image_id	nullable\|integer

Requires Authorization: Bearer {token} header.

Response Example 200 OK

DELETE api/products/{productId}/variants/{variantId}

🔒 Auth products.variants.manage

Path Parameters

Field	Type / Rules
productId	integer\|string
variantId	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

🔹

Purchase Bills

10 endpoints

GET api/purchase-bills

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/purchase-bills

🔒 Auth

Request Body

Field	Type / Rules
supplier_id	required\|integer
branch_id	required\|integer
bill_date	required\|date
items	required\|array
items.*.variant_id	required\|integer
items.*.quantity	required\|number
items.*.cost_price	required\|number

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

GET api/purchase-bills/next-number

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/purchase-bills/setup

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/purchase-bills/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

PUT api/purchase-bills/{id}

🔒 Auth

Request Body

Field	Type / Rules
supplier_id	required\|integer
branch_id	required\|integer
bill_date	required\|date
items	required\|array
items.*.variant_id	required\|integer
items.*.quantity	required\|number
items.*.cost_price	required\|number

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

DELETE api/purchase-bills/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

GET api/purchase-bills/{id}/download

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

PATCH api/purchase-bills/{id}/lock

🔒 Auth

Request Body

Field	Type / Rules
supplier_id	required\|integer
branch_id	required\|integer
bill_date	required\|date
items	required\|array
items.*.variant_id	required\|integer
items.*.quantity	required\|number
items.*.cost_price	required\|number

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

PATCH api/purchase-bills/{id}/unlock

🔒 Auth

Request Body

Field	Type / Rules
supplier_id	required\|integer
branch_id	required\|integer
bill_date	required\|date
items	required\|array
items.*.variant_id	required\|integer
items.*.quantity	required\|number
items.*.cost_price	required\|number

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

🔹

Purchase Returns

11 endpoints

GET api/purchase-returns

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/purchase-returns

🔒 Auth

Request Body

Field	Type / Rules
original_id	required\|integer
items	required\|array
items.*.variant_id	required\|integer
items.*.quantity	required\|number
reason	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

GET api/purchase-returns/setup

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/purchase-returns/supplier/{supplierId}/bills

🔒 Auth

Path Parameters

Field	Type / Rules
supplierId	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

GET api/purchase-returns/supplier/{supplierId}/products

🔒 Auth

Path Parameters

Field	Type / Rules
supplierId	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/purchase-returns/supplier/{supplierId}/returnable-items

🔒 Auth

Path Parameters

Field	Type / Rules
supplierId	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

GET api/purchase-returns/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

PUT api/purchase-returns/{id}

🔒 Auth

Request Body

Field	Type / Rules
original_id	required\|integer
items	required\|array
items.*.variant_id	required\|integer
items.*.quantity	required\|number
reason	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

DELETE api/purchase-returns/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

PATCH api/purchase-returns/{id}/lock

🔒 Auth

Request Body

Field	Type / Rules
original_id	required\|integer
items	required\|array
items.*.variant_id	required\|integer
items.*.quantity	required\|number
reason	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

PATCH api/purchase-returns/{id}/unlock

🔒 Auth

Request Body

Field	Type / Rules
original_id	required\|integer
items	required\|array
items.*.variant_id	required\|integer
items.*.quantity	required\|number
reason	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

📱

Pwa

3 endpoints

GET api/pwa/manifest

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/pwa/settings

🔒 Auth pwa.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

PUT api/pwa/settings

🔒 Auth pwa.view pwa.update

Request Body

Field	Type / Rules
app_name	required\|string
short_name	required\|string
theme_color	required\|string
background_color	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

🔹

Reports

13 endpoints

GET api/reports/balance-sheet

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/reports/cash-flow

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/reports/cashbook

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/reports/customer-statement

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/reports/income-statement

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/reports/payable

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/reports/purchase

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/reports/purchase-items

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/reports/receivable

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/reports/sales

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/reports/sales-items

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/reports/sales-tax

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/reports/supplier-statement

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

🔹

Sale Returns

12 endpoints

GET api/sale-returns

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/sale-returns

🔒 Auth

Request Body

Field	Type / Rules
original_id	required\|integer
items	required\|array
items.*.variant_id	required\|integer
items.*.quantity	required\|number
reason	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

GET api/sale-returns/customer/{clientId}/invoices

🔒 Auth

Path Parameters

Field	Type / Rules
clientId	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/sale-returns/customer/{clientId}/products

🔒 Auth

Path Parameters

Field	Type / Rules
clientId	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/sale-returns/customer/{clientId}/returnable-items

🔒 Auth

Path Parameters

Field	Type / Rules
clientId	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

GET api/sale-returns/next-number

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/sale-returns/setup

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/sale-returns/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

PUT api/sale-returns/{id}

🔒 Auth

Request Body

Field	Type / Rules
original_id	required\|integer
items	required\|array
items.*.variant_id	required\|integer
items.*.quantity	required\|number
reason	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

DELETE api/sale-returns/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

PATCH api/sale-returns/{id}/lock

🔒 Auth

Request Body

Field	Type / Rules
original_id	required\|integer
items	required\|array
items.*.variant_id	required\|integer
items.*.quantity	required\|number
reason	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

PATCH api/sale-returns/{id}/unlock

🔒 Auth

Request Body

Field	Type / Rules
original_id	required\|integer
items	required\|array
items.*.variant_id	required\|integer
items.*.quantity	required\|number
reason	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

🔹

Supplier Portal

13 endpoints

GET api/supplier-portal/bills

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/supplier-portal/bills/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

GET api/supplier-portal/bills/{id}/download

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

GET api/supplier-portal/dashboard

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/supplier-portal/ledger

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/supplier-portal/payments

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/supplier-portal/payments/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

GET api/supplier-portal/profile

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

PUT api/supplier-portal/profile

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

PUT api/supplier-portal/profile/password

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

GET api/supplier-portal/vouchers

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/supplier-portal/vouchers/{type}/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
type	integer\|string
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

GET api/supplier-portal/vouchers/{type}/{id}/download

🔒 Auth

Path Parameters

Field	Type / Rules
type	integer\|string
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

⚙️

System

3 endpoints

GET api/system/settings

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Data fetched successfully", "data": { "items": [ { "timezone": "Asia\/Dhaka", "currency_symbol": "৳", "date_format": "d M, Y", "time_format": "h:i a" } ], "pagination": { "current_page": 1, "per_page": 20, "total": 1, "last_page": 1 } } }

PUT api/system/settings

🔒 Auth settings.update

Request Body

Field	Type / Rules
key	required\|string
value	required

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "timezone": "Asia\/Dhaka", "currency_symbol": "৳", "date_format": "d M, Y", "time_format": "h:i a" } }

POST api/system/system-reset

🔒 Auth settings.update

Request Body

Field	Type / Rules
name	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

👤

User

1 endpoint

GET api/user

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

📡

User Activities

2 endpoints

POST api/user-activities

🔒 Auth

Request Body

Field	Type / Rules
name	required\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

GET api/user-activities/{type}

🔒 Auth

Path Parameters

Field	Type / Rules
type	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "created_at": "2026-03-08T07:30:00Z", "updated_at": "2026-03-08T07:30:00Z" } }

🔀

Variants

2 endpoints

GET api/variants/search

🔒 Auth products.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/variants/{variantId}/adjust-stock

🔒 Auth products.variants.manage

Request Body

Field	Type / Rules
quantity	required\|integer
type	required\|string (add\|remove\|set)
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "from_branch": "Main Branch", "to_branch": "Branch 2", "status": "completed", "items": [ { "variant_id": 1, "quantity": 10 } ] } }

💳

Voucher

8 endpoints

GET api/voucher/stock-adj

🔒 Auth stock_adjustments.view

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Data fetched successfully", "data": { "items": [ { "id": 1, "from_branch": "Main Branch", "to_branch": "Branch 2", "status": "completed", "items": [ { "variant_id": 1, "quantity": 10 } ] } ], "pagination": { "current_page": 1, "per_page": 20, "total": 1, "last_page": 1 } } }

POST api/voucher/stock-adj

🔒 Auth stock_adjustments.create

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/voucher/stock-adj/setup

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/voucher/stock-adj/{id}

🔒 Auth stock_adjustments.view

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "from_branch": "Main Branch", "to_branch": "Branch 2", "status": "completed", "items": [ { "variant_id": 1, "quantity": 10 } ] } }

PUT api/voucher/stock-adj/{id}

🔒 Auth stock_adjustments.edit

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

DELETE api/voucher/stock-adj/{id}

🔒 Auth stock_adjustments.delete

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

PATCH api/voucher/stock-adj/{id}/lock

🔒 Auth stock_adjustments.edit

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

PATCH api/voucher/stock-adj/{id}/unlock

🔒 Auth stock_adjustments.edit

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

🔹

Vouchers

74 endpoints

GET api/vouchers/advances

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/vouchers/advances

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

GET api/vouchers/advances/setup

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/vouchers/advances/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

PUT api/vouchers/advances/{id}

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

DELETE api/vouchers/advances/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

PATCH api/vouchers/advances/{id}/lock

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

PATCH api/vouchers/advances/{id}/unlock

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

GET api/vouchers/contras

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/vouchers/contras

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

GET api/vouchers/contras/setup

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/vouchers/contras/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

PUT api/vouchers/contras/{id}

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

DELETE api/vouchers/contras/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

PATCH api/vouchers/contras/{id}/lock

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

PATCH api/vouchers/contras/{id}/unlock

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

GET api/vouchers/defaults

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

PUT api/vouchers/defaults

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

GET api/vouchers/expenses

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/vouchers/expenses

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

GET api/vouchers/expenses/setup

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/vouchers/expenses/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

PUT api/vouchers/expenses/{id}

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

DELETE api/vouchers/expenses/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

PATCH api/vouchers/expenses/{id}/lock

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

PATCH api/vouchers/expenses/{id}/unlock

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

GET api/vouchers/journals

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/vouchers/journals

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

GET api/vouchers/journals/setup

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/vouchers/journals/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

PUT api/vouchers/journals/{id}

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

DELETE api/vouchers/journals/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

PATCH api/vouchers/journals/{id}/lock

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

PATCH api/vouchers/journals/{id}/unlock

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

GET api/vouchers/payments

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/vouchers/payments

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

GET api/vouchers/payments/setup

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/vouchers/payments/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

PUT api/vouchers/payments/{id}

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

DELETE api/vouchers/payments/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

PATCH api/vouchers/payments/{id}/lock

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

PATCH api/vouchers/payments/{id}/unlock

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

GET api/vouchers/receipts

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/vouchers/receipts

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

GET api/vouchers/receipts/setup

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/vouchers/receipts/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

PUT api/vouchers/receipts/{id}

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

DELETE api/vouchers/receipts/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

PATCH api/vouchers/receipts/{id}/lock

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

PATCH api/vouchers/receipts/{id}/unlock

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

GET api/vouchers/refunds

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/vouchers/refunds

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

GET api/vouchers/refunds/setup

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/vouchers/refunds/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

PUT api/vouchers/refunds/{id}

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

DELETE api/vouchers/refunds/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

PATCH api/vouchers/refunds/{id}/lock

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

PATCH api/vouchers/refunds/{id}/unlock

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

GET api/vouchers/salaries

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/vouchers/salaries

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

GET api/vouchers/salaries/setup

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/vouchers/salaries/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

PUT api/vouchers/salaries/{id}

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Updated successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

DELETE api/vouchers/salaries/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

POST api/vouchers/salaries/{id}/lock

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

POST api/vouchers/salaries/{id}/unlock

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Created successfully", "data": { "id": 1, "type": "payment", "amount": 5000, "reference": "VCH-0001", "status": "posted" } }

GET api/vouchers/stock-transfers

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/vouchers/stock-transfers

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/vouchers/stock-transfers/setup

🔒 Auth

Query Parameters

Field	Type / Rules
per_page	integer
page	integer
search	string
sort	string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

GET api/vouchers/stock-transfers/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

PUT api/vouchers/stock-transfers/{id}

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

DELETE api/vouchers/stock-transfers/{id}

🔒 Auth

Path Parameters

Field	Type / Rules
id	integer\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

{ "success": true, "message": "Deleted successfully", "data": null }

POST api/vouchers/stock-transfers/{id}/lock

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

POST api/vouchers/stock-transfers/{id}/unlock

🔒 Auth

Request Body

Field	Type / Rules
type	required\|string
amount	required\|number
reference	nullable\|string
branch_id	required\|integer
notes	nullable\|string

Requires Authorization: Bearer {token} header.

Response Example 200 OK

No endpoints found

Try adjusting your search query.

Field	Type / Rules
name	required\|string
parent_id	nullable\|integer
description	nullable\|string
is_active	boolean

REST API Reference

Accounting

Accounts

Activity Log

Addresses

Attributes

Auth

Branches

Categories

Central

Customer Portal

Dashboard

Email Templates

Geocode

Import Export

Inventory

Invoices

Manufacturing

Media

Peoples

Permission

Products

Purchase Bills

Purchase Returns

Pwa

Reports

Sale Returns

Supplier Portal

System

User

User Activities

Variants

Voucher

Vouchers

No endpoints found