Endpoint Explorer

Summary

List consignments

Get a consignment by id

Create a consignment

Settle

Update a consignment

Delete a consignment

List delivery notes

Get a delivery note by id

Create a delivery note

Update a delivery note

Set status

Set lock

Set discount

Set charges

Set reminder

Duplicate

Convert a DeliveryNote to a SalesInvoice (bill a dispatched shipment)

Convert a DeliveryNote to a ProformaInvoice (client docx #1: proforma should be able to follow the delivery note)

Delete a delivery note

List proforma-invoice activities

Create a proforma-invoice activity

Delete a proforma-invoice activity

List proforma invoices

Get a proforma invoice by id

Create a proforma invoice

Update a proforma invoice

Set status

Convert a Proforma Invoice directly to a SalesInvoice

Delete a proforma invoice

List quotation activities

Create a quotation activity

Delete a quotation activity

List quotations

Get a quotation by id

Create a quotation

Update a quotation

Set status

Convert a Quotation to a SalesOrder

Convert a Quotation directly to a SalesInvoice (skipping SO)

Convert a Quotation to a ProformaInvoice (pre-invoice / advance payment request, before the tax invoice is issued)

Convert a Quotation to a DeliveryNote (ship first, bill later)

Convert a Quotation to a SalesReturn (credit note)

Delete a quotation

List sales invoices

Get a sales invoice by id

Create a sales invoice

Update a sales invoice

Set status

Set lock

Set discount

Set charges

Set reminder

Record payment

issue the invoice: generate/attach its ZATCA QR and stamp `qrGeneratedAt`

Duplicate

Delete a sales invoice

List sales orders

Get a sales order by id

Create a sales order

Update a sales order

manual workflow status change

Set lock

Set discount

Set charges

Set reminder

Duplicate

Convert

Convert a SalesOrder into a real SalesInvoice (billing)

Convert a SalesOrder into a real DeliveryNote (shipment)

Delete a sales order

List sales returns

Get a sales return by id

Create a sales return

Bugs (1).docx — Convert a Sales Invoice → Sales Return (credit note)

Update a sales return

Set status

Set lock

Set discount

Set charges

Set reminder

Approve

Inspect

Process refund

issue the credit note: generate/attach its ZATCA QR and stamp `qrGeneratedAt`

Duplicate

Delete a sales return

List salesmans

Summary

Get a salesman by id

Create a salesman

Update a salesman

Delete a salesman

Summary

List routes

Find route

Create route

Update route

Remove route

List loads

Find load

Create load

Settle

Update load

Remove load

List goods receipts

Get a goods receipt by id

Create a goods receipt

Update a goods receipt

Set status

Set lock

Set discount

Set charges

Set reminder

Inspect

Duplicate

GoodsReceipt → PurchaseInvoice (see GoodsReceiptsService.convertToPurchaseInvoice)

Delete a goods receipt

List payment terms

Create a payment term

Update a payment term

Delete a payment term

List purchase invoices

Get a purchase invoice by id

Create a purchase invoice

Update a purchase invoice

Set status

Set lock

Set discount

Set charges

Set reminder

Record payment

Duplicate

Delete a purchase invoice

List purchase orders

Get a purchase order by id

Create a purchase order

Update a purchase order

Set status

Set lock

Set discount

Set charges

Set reminder

Duplicate

Convert a PurchaseOrder → GoodsReceipt (GRN)

Convert a PurchaseOrder → PurchaseInvoice (vendor bill / AP)

Delete a purchase order

List purchase requests

Get a purchase request by id

Create a purchase request

Update a purchase request

Set status

Set lock

Set discount

Set charges

Set reminder

Duplicate

Convert to purchase order

Delete a purchase request

List purchase returns

Get a purchase return by id

Create a purchase return

Bugs (1).docx — Convert a Purchase Invoice → Purchase Return (debit note)

Update a purchase return

Set status

Set lock

Set discount

Set charges

Set reminder

Approve

Inspect

Process refund

Duplicate

Delete a purchase return

List vendors

Declared BEFORE @Get(':id') so `/vendors/check-duplicate` is not captured by the :id param route

Get a vendor by id

Create a vendor

Update a vendor

Delete a vendor

List customer branches

Get a customer branch by id

Create a customer branch

Update a customer branch

Delete a customer branch

List customer categories

Get a customer category by id

Create a customer category

Update a customer category

Delete a customer category

List customer contacts

Get a customer contact by id

Create a customer contact

Update a customer contact

Delete a customer contact

List customer groups

Get a customer group by id

Create a customer group

Update a customer group

Delete a customer group

List customers

Declared BEFORE @Get(':id') so `/customers/check-duplicate` is not captured by the :id param route

Declared BEFORE @Get(':id') so `/customers/:id/financials` resolves to this handler (Review #18 — real Customer-360 aggregates), not the detail route

Get a customer by id

Create a customer

Update a customer

Delete a customer

List items

NOTE: declared BEFORE @Get(':id') so the literal `/items/check-duplicate` path is matched here and never captured by the :id param route

Get an item by id

Create an item

Update an item

Delete an item

Upload image

Get image

Delete image

Get a price record

Batch

List inventory categories

REAL per-category rollups (item count + on-hand stock value), company-scoped

Find by code

Get an inventory category by id

Create an inventory category

Update an inventory category

Delete an inventory category

List stock transfers

Get a stock transfer by id

Create a stock transfer

Post

Delete a stock transfer

List units of measure

REAL per-unit usage counts (items using each unit symbol), company-scoped

Find by symbol

Get an unit of measure by id

Create an unit of measure

Update an unit of measure

Delete an unit of measure

List warehouses

REAL stock-by-warehouse rollups (item count + value + movements), company-scoped

Find by code

REAL recent movements for one warehouse (company-scoped), newest first

Get a warehouse by id

Create a warehouse

Update a warehouse

Delete a warehouse

List stock movements

per-item on-hand at one warehouse (from the ledger)

List stock adjustments

Get a stock adjustment by id

Create a stock adjustment

Delete a stock adjustment

─────────────────────────────── BINS ───────────────────────────────

Find bin

Create bin

Update bin

Remove bin

───────────────────────────── MOVEMENTS ─────────────────────────────

Create movement

Permissions

Users

List roles

Create role

Update role

Remove role

List assignments

Create assignment

Remove assignment

List outlets

Create outlet

Update outlet

List terminals

Create terminal

Update terminal

List POS records

Current

rich shift summary (reference images 6 & 8)

Get a POS record by id

Open

Close

Pause / Resume / Handover / Expense (reference images 6 & 8)

Resume

Handover

Expense

List POS records

Get a POS record by id

Create a POS record

List POS records

Get a POS record by id

Create a POS record

Delete a POS record

Current

Create a POS record

List POS records

Get a POS record by id

Create a POS record

Today

Receipts

Cashier sales

Shift report

Payment mode