Customer App

app.grivaone.com

The core ERP consumed by end-user companies — sales, purchasing, inventory, POS, accounting, HR, projects and every operational module.

893 endpoints25 moduleshttps://gulfpay-production.up.railway.app/api/v1

893 endpoints across 25 modules

The full sell-side document flow: quotation → sales order → delivery note → invoice, plus returns, proforma, salesman & van sales.

MethodPathAuthPurpose

GETJWT

/api/v1/consignment/summary

Summary

GET/api/v1/consignment/summary

JWT

Summary

GETJWT

/api/v1/consignment

List consignments

Query: pagination / filters

GET/api/v1/consignment

JWT

List consignments

Query: pagination / filters

GETJWT

/api/v1/consignment/:id

Get a consignment by id

GET/api/v1/consignment/:id

JWT

Get a consignment by id

POSTJWT

/api/v1/consignment

Create a consignment

Body: CreateConsignmentDto

POST/api/v1/consignment

JWT

Create a consignment

Body: CreateConsignmentDto

PATCHJWT

/api/v1/consignment/:id/settle

Settle

Body: SettleConsignmentDto

PATCH/api/v1/consignment/:id/settle

JWT

Settle

Body: SettleConsignmentDto

PATCHJWT

/api/v1/consignment/:id

Update a consignment

Body: UpdateConsignmentDto

PATCH/api/v1/consignment/:id

JWT

Update a consignment

Body: UpdateConsignmentDto

DELETEJWT

/api/v1/consignment/:id

Delete a consignment

DELETE/api/v1/consignment/:id

JWT

Delete a consignment

GETJWT

/api/v1/delivery-notes

List delivery notes

Query: pagination / filters

GET/api/v1/delivery-notes

JWT

List delivery notes

Query: pagination / filters

GETJWT

/api/v1/delivery-notes/:id

Get a delivery note by id

GET/api/v1/delivery-notes/:id

JWT

Get a delivery note by id

POSTJWT

/api/v1/delivery-notes

Create a delivery note

Body: CreateDeliveryNoteDto

POST/api/v1/delivery-notes

JWT

Create a delivery note

Body: CreateDeliveryNoteDto

PATCHJWT

/api/v1/delivery-notes/:id

Update a delivery note

Body: UpdateDeliveryNoteDto

PATCH/api/v1/delivery-notes/:id

JWT

Update a delivery note

Body: UpdateDeliveryNoteDto

PATCHJWT

/api/v1/delivery-notes/:id/status

Set status

Body: JSON

PATCH/api/v1/delivery-notes/:id/status

JWT

Set status

Body: JSON

PATCHJWT

/api/v1/delivery-notes/:id/lock

Set lock

Body: JSON

PATCH/api/v1/delivery-notes/:id/lock

JWT

Set lock

Body: JSON

PATCHJWT

/api/v1/delivery-notes/:id/discount

Set discount

Body: JSON

PATCH/api/v1/delivery-notes/:id/discount

JWT

Set discount

Body: JSON

PATCHJWT

/api/v1/delivery-notes/:id/charges

Set charges

Body: JSON

PATCH/api/v1/delivery-notes/:id/charges

JWT

Set charges

Body: JSON

PATCHJWT

/api/v1/delivery-notes/:id/reminder

Set reminder

Body: JSON

PATCH/api/v1/delivery-notes/:id/reminder

JWT

Set reminder

Body: JSON

POSTJWT

/api/v1/delivery-notes/:id/duplicate

Duplicate

POST/api/v1/delivery-notes/:id/duplicate

JWT

Duplicate

POSTJWT

/api/v1/delivery-notes/:id/convert-to-sales-invoice

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

POST/api/v1/delivery-notes/:id/convert-to-sales-invoice

JWT

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

POSTJWT

/api/v1/delivery-notes/:id/convert-to-proforma-invoice

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

POST/api/v1/delivery-notes/:id/convert-to-proforma-invoice

JWT

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

DELETEJWT

/api/v1/delivery-notes/:id

Delete a delivery note

DELETE/api/v1/delivery-notes/:id

JWT

Delete a delivery note

GETJWT

/api/v1/proforma-invoices/:proformaInvoiceId/activities

List proforma-invoice activities

Query: pagination / filters

GET/api/v1/proforma-invoices/:proformaInvoiceId/activities

JWT

List proforma-invoice activities

Query: pagination / filters

POSTJWT

/api/v1/proforma-invoices/:proformaInvoiceId/activities

Create a proforma-invoice activity

Body: CreateActivityDto

POST/api/v1/proforma-invoices/:proformaInvoiceId/activities

JWT

Create a proforma-invoice activity

Body: CreateActivityDto

DELETEJWT

/api/v1/proforma-invoices/:proformaInvoiceId/activities/:activityId

Delete a proforma-invoice activity

DELETE/api/v1/proforma-invoices/:proformaInvoiceId/activities/:activityId

JWT

Delete a proforma-invoice activity

GETJWT

/api/v1/proforma-invoices

List proforma invoices

Query: pagination / filters

GET/api/v1/proforma-invoices

JWT

List proforma invoices

Query: pagination / filters

GETJWT

/api/v1/proforma-invoices/:id

Get a proforma invoice by id

GET/api/v1/proforma-invoices/:id

JWT

Get a proforma invoice by id

POSTJWT

/api/v1/proforma-invoices

Create a proforma invoice

Body: CreateProformaInvoiceDto

POST/api/v1/proforma-invoices

JWT

Create a proforma invoice

Body: CreateProformaInvoiceDto

PATCHJWT

/api/v1/proforma-invoices/:id

Update a proforma invoice

Body: UpdateProformaInvoiceDto

PATCH/api/v1/proforma-invoices/:id

JWT

Update a proforma invoice

Body: UpdateProformaInvoiceDto

PATCHJWT

/api/v1/proforma-invoices/:id/status

Set status

Body: JSON

PATCH/api/v1/proforma-invoices/:id/status

JWT

Set status

Body: JSON

POSTJWT

/api/v1/proforma-invoices/:id/convert-to-sales-invoice

Convert a Proforma Invoice directly to a SalesInvoice

POST/api/v1/proforma-invoices/:id/convert-to-sales-invoice

JWT

Convert a Proforma Invoice directly to a SalesInvoice

DELETEJWT

/api/v1/proforma-invoices/:id

Delete a proforma invoice

DELETE/api/v1/proforma-invoices/:id

JWT

Delete a proforma invoice

GETJWT

/api/v1/quotations/:quotationId/activities

List quotation activities

Query: pagination / filters

GET/api/v1/quotations/:quotationId/activities

JWT

List quotation activities

Query: pagination / filters

POSTJWT

/api/v1/quotations/:quotationId/activities

Create a quotation activity

Body: CreateActivityDto

POST/api/v1/quotations/:quotationId/activities

JWT

Create a quotation activity

Body: CreateActivityDto

DELETEJWT

/api/v1/quotations/:quotationId/activities/:activityId

Delete a quotation activity

DELETE/api/v1/quotations/:quotationId/activities/:activityId

JWT

Delete a quotation activity

GETJWT

/api/v1/quotations

List quotations

Query: pagination / filters

GET/api/v1/quotations

JWT

List quotations

Query: pagination / filters

GETJWT

/api/v1/quotations/:id

Get a quotation by id

GET/api/v1/quotations/:id

JWT

Get a quotation by id

POSTJWT

/api/v1/quotations

Create a quotation

Body: CreateQuotationDto

POST/api/v1/quotations

JWT

Create a quotation

Body: CreateQuotationDto

PATCHJWT

/api/v1/quotations/:id

Update a quotation

Body: UpdateQuotationDto

PATCH/api/v1/quotations/:id

JWT

Update a quotation

Body: UpdateQuotationDto

PATCHJWT

/api/v1/quotations/:id/status

Set status

Body: JSON

PATCH/api/v1/quotations/:id/status

JWT

Set status

Body: JSON

POSTJWT

/api/v1/quotations/:id/convert-to-sales-order

Convert a Quotation to a SalesOrder

POST/api/v1/quotations/:id/convert-to-sales-order

JWT

Convert a Quotation to a SalesOrder

POSTJWT

/api/v1/quotations/:id/convert-to-sales-invoice

Convert a Quotation directly to a SalesInvoice (skipping SO)

POST/api/v1/quotations/:id/convert-to-sales-invoice

JWT

Convert a Quotation directly to a SalesInvoice (skipping SO)

POSTJWT

/api/v1/quotations/:id/convert-to-proforma-invoice

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

POST/api/v1/quotations/:id/convert-to-proforma-invoice

JWT

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

POSTJWT

/api/v1/quotations/:id/convert-to-delivery-note

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

POST/api/v1/quotations/:id/convert-to-delivery-note

JWT

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

POSTJWT

/api/v1/quotations/:id/convert-to-sales-return

Convert a Quotation to a SalesReturn (credit note)

POST/api/v1/quotations/:id/convert-to-sales-return

JWT

Convert a Quotation to a SalesReturn (credit note)

DELETEJWT

/api/v1/quotations/:id

Delete a quotation

DELETE/api/v1/quotations/:id

JWT

Delete a quotation

GETJWT

/api/v1/sales-invoices

List sales invoices

Query: pagination / filters

GET/api/v1/sales-invoices

JWT

List sales invoices

Query: pagination / filters

GETJWT

/api/v1/sales-invoices/:id

Get a sales invoice by id

GET/api/v1/sales-invoices/:id

JWT

Get a sales invoice by id

POSTJWT

/api/v1/sales-invoices

Create a sales invoice

Body: CreateSalesInvoiceDto

POST/api/v1/sales-invoices

JWT

Create a sales invoice

Body: CreateSalesInvoiceDto

PATCHJWT

/api/v1/sales-invoices/:id

Update a sales invoice

Body: UpdateSalesInvoiceDto

PATCH/api/v1/sales-invoices/:id

JWT

Update a sales invoice

Body: UpdateSalesInvoiceDto

PATCHJWT

/api/v1/sales-invoices/:id/status

Set status

Body: JSON

PATCH/api/v1/sales-invoices/:id/status

JWT

Set status

Body: JSON

PATCHJWT

/api/v1/sales-invoices/:id/lock

Set lock

Body: JSON

PATCH/api/v1/sales-invoices/:id/lock

JWT

Set lock

Body: JSON

PATCHJWT

/api/v1/sales-invoices/:id/discount

Set discount

Body: JSON

PATCH/api/v1/sales-invoices/:id/discount

JWT

Set discount

Body: JSON

PATCHJWT

/api/v1/sales-invoices/:id/charges

Set charges

Body: JSON

PATCH/api/v1/sales-invoices/:id/charges

JWT

Set charges

Body: JSON

PATCHJWT

/api/v1/sales-invoices/:id/reminder

Set reminder

Body: JSON

PATCH/api/v1/sales-invoices/:id/reminder

JWT

Set reminder

Body: JSON

POSTJWT

/api/v1/sales-invoices/:id/record-payment

Record payment

Body: RecordPaymentDto

POST/api/v1/sales-invoices/:id/record-payment

JWT

Record payment

Body: RecordPaymentDto

POSTJWT

/api/v1/sales-invoices/:id/zatca-qr

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

Body: IssueZatcaQrDto

POST/api/v1/sales-invoices/:id/zatca-qr

JWT

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

Body: IssueZatcaQrDto

POSTJWT

/api/v1/sales-invoices/:id/duplicate

Duplicate

POST/api/v1/sales-invoices/:id/duplicate

JWT

Duplicate

DELETEJWT

/api/v1/sales-invoices/:id

Delete a sales invoice

DELETE/api/v1/sales-invoices/:id

JWT

Delete a sales invoice

GETJWT

/api/v1/sales-orders

List sales orders

Query: pagination / filters

GET/api/v1/sales-orders

JWT

List sales orders

Query: pagination / filters

GETJWT

/api/v1/sales-orders/:id

Get a sales order by id

GET/api/v1/sales-orders/:id

JWT

Get a sales order by id

POSTJWT

/api/v1/sales-orders

Create a sales order

Body: CreateSalesOrderDto

POST/api/v1/sales-orders

JWT

Create a sales order

Body: CreateSalesOrderDto

PATCHJWT

/api/v1/sales-orders/:id

Update a sales order

Body: UpdateSalesOrderDto

PATCH/api/v1/sales-orders/:id

JWT

Update a sales order

Body: UpdateSalesOrderDto

PATCHJWT

/api/v1/sales-orders/:id/status

manual workflow status change

Body: UpdateSalesOrderStatusDto

PATCH/api/v1/sales-orders/:id/status

JWT

manual workflow status change

Body: UpdateSalesOrderStatusDto

PATCHJWT

/api/v1/sales-orders/:id/lock

Set lock

Body: JSON

PATCH/api/v1/sales-orders/:id/lock

JWT

Set lock

Body: JSON

PATCHJWT

/api/v1/sales-orders/:id/discount

Set discount

Body: JSON

PATCH/api/v1/sales-orders/:id/discount

JWT

Set discount

Body: JSON

PATCHJWT

/api/v1/sales-orders/:id/charges

Set charges

Body: JSON

PATCH/api/v1/sales-orders/:id/charges

JWT

Set charges

Body: JSON

PATCHJWT

/api/v1/sales-orders/:id/reminder

Set reminder

Body: JSON

PATCH/api/v1/sales-orders/:id/reminder

JWT

Set reminder

Body: JSON

POSTJWT

/api/v1/sales-orders/:id/duplicate

Duplicate

POST/api/v1/sales-orders/:id/duplicate

JWT

Duplicate

POSTJWT

/api/v1/sales-orders/:id/convert

Convert

Body: JSON

POST/api/v1/sales-orders/:id/convert

JWT

Convert

Body: JSON

POSTJWT

/api/v1/sales-orders/:id/convert-to-sales-invoice

Convert a SalesOrder into a real SalesInvoice (billing)

POST/api/v1/sales-orders/:id/convert-to-sales-invoice

JWT

Convert a SalesOrder into a real SalesInvoice (billing)

POSTJWT

/api/v1/sales-orders/:id/convert-to-delivery-note

Convert a SalesOrder into a real DeliveryNote (shipment)

POST/api/v1/sales-orders/:id/convert-to-delivery-note

JWT

Convert a SalesOrder into a real DeliveryNote (shipment)

DELETEJWT

/api/v1/sales-orders/:id

Delete a sales order

DELETE/api/v1/sales-orders/:id

JWT

Delete a sales order

GETJWT

/api/v1/sales-returns

List sales returns

Query: pagination / filters

GET/api/v1/sales-returns

JWT

List sales returns

Query: pagination / filters

GETJWT

/api/v1/sales-returns/:id

Get a sales return by id

GET/api/v1/sales-returns/:id

JWT

Get a sales return by id

POSTJWT

/api/v1/sales-returns

Create a sales return

Body: CreateSalesReturnDto

POST/api/v1/sales-returns

JWT

Create a sales return

Body: CreateSalesReturnDto

POSTJWT

/api/v1/sales-returns/from-invoice/:invoiceId

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

POST/api/v1/sales-returns/from-invoice/:invoiceId

JWT

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

PATCHJWT

/api/v1/sales-returns/:id

Update a sales return

Body: UpdateSalesReturnDto

PATCH/api/v1/sales-returns/:id

JWT

Update a sales return

Body: UpdateSalesReturnDto

PATCHJWT

/api/v1/sales-returns/:id/status

Set status

Body: JSON

PATCH/api/v1/sales-returns/:id/status

JWT

Set status

Body: JSON

PATCHJWT

/api/v1/sales-returns/:id/lock

Set lock

Body: JSON

PATCH/api/v1/sales-returns/:id/lock

JWT

Set lock

Body: JSON

PATCHJWT

/api/v1/sales-returns/:id/discount

Set discount

Body: JSON

PATCH/api/v1/sales-returns/:id/discount

JWT

Set discount

Body: JSON

PATCHJWT

/api/v1/sales-returns/:id/charges

Set charges

Body: JSON

PATCH/api/v1/sales-returns/:id/charges

JWT

Set charges

Body: JSON

PATCHJWT

/api/v1/sales-returns/:id/reminder

Set reminder

Body: JSON

PATCH/api/v1/sales-returns/:id/reminder

JWT

Set reminder

Body: JSON

POSTJWT

/api/v1/sales-returns/:id/approve

Approve

Body: ApproveReturnDto

POST/api/v1/sales-returns/:id/approve

JWT

Approve

Body: ApproveReturnDto

POSTJWT

/api/v1/sales-returns/:id/inspect

Inspect

Body: InspectReturnDto

POST/api/v1/sales-returns/:id/inspect

JWT

Inspect

Body: InspectReturnDto

POSTJWT

/api/v1/sales-returns/:id/process-refund

Process refund

Body: ProcessRefundDto

POST/api/v1/sales-returns/:id/process-refund

JWT

Process refund

Body: ProcessRefundDto

POSTJWT

/api/v1/sales-returns/:id/zatca-qr

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

Body: IssueZatcaQrDto

POST/api/v1/sales-returns/:id/zatca-qr

JWT

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

Body: IssueZatcaQrDto

POSTJWT

/api/v1/sales-returns/:id/duplicate

Duplicate

POST/api/v1/sales-returns/:id/duplicate

JWT

Duplicate

DELETEJWT

/api/v1/sales-returns/:id

Delete a sales return

DELETE/api/v1/sales-returns/:id

JWT

Delete a sales return

GETJWT

/api/v1/salesman

List salesmans

Query: pagination / filters

GET/api/v1/salesman

JWT

List salesmans

Query: pagination / filters

GETJWT

/api/v1/salesman/:id/summary

Summary

GET/api/v1/salesman/:id/summary

JWT

Summary

GETJWT

/api/v1/salesman/:id

Get a salesman by id

GET/api/v1/salesman/:id

JWT

Get a salesman by id

POSTJWT

/api/v1/salesman

Create a salesman

Body: CreateSalesmanDto

POST/api/v1/salesman

JWT

Create a salesman

Body: CreateSalesmanDto

PATCHJWT

/api/v1/salesman/:id

Update a salesman

Body: UpdateSalesmanDto

PATCH/api/v1/salesman/:id

JWT

Update a salesman

Body: UpdateSalesmanDto

DELETEJWT

/api/v1/salesman/:id

Delete a salesman

DELETE/api/v1/salesman/:id

JWT

Delete a salesman

GETJWT

/api/v1/van-sales/summary

Summary

GET/api/v1/van-sales/summary

JWT

Summary

GETJWT

/api/v1/van-sales/routes

List routes

Query: pagination / filters

GET/api/v1/van-sales/routes

JWT

List routes

Query: pagination / filters

GETJWT

/api/v1/van-sales/routes/:id

Find route

GET/api/v1/van-sales/routes/:id

JWT

Find route

POSTJWT

/api/v1/van-sales/routes

Create route

Body: CreateSalesRouteDto

POST/api/v1/van-sales/routes

JWT

Create route

Body: CreateSalesRouteDto

PATCHJWT

/api/v1/van-sales/routes/:id

Update route

Body: UpdateSalesRouteDto

PATCH/api/v1/van-sales/routes/:id

JWT

Update route

Body: UpdateSalesRouteDto

DELETEJWT

/api/v1/van-sales/routes/:id

Remove route

DELETE/api/v1/van-sales/routes/:id

JWT

Remove route

GETJWT

/api/v1/van-sales/loads

List loads

Query: pagination / filters

GET/api/v1/van-sales/loads

JWT

List loads

Query: pagination / filters

GETJWT

/api/v1/van-sales/loads/:id

Find load

GET/api/v1/van-sales/loads/:id

JWT

Find load

POSTJWT

/api/v1/van-sales/loads

Create load

Body: CreateVanLoadDto

POST/api/v1/van-sales/loads

JWT

Create load

Body: CreateVanLoadDto

PATCHJWT

/api/v1/van-sales/loads/:id/settle

Settle

Body: SettleVanLoadDto

PATCH/api/v1/van-sales/loads/:id/settle

JWT

Settle

Body: SettleVanLoadDto

PATCHJWT

/api/v1/van-sales/loads/:id

Update load

Body: UpdateVanLoadDto

PATCH/api/v1/van-sales/loads/:id

JWT

Update load

Body: UpdateVanLoadDto

DELETEJWT

/api/v1/van-sales/loads/:id

Remove load

DELETE/api/v1/van-sales/loads/:id

JWT

Remove load