API Usage Sales

Purpose

This page explains how third-party systems should call Sales APIs in SimBiz 6 API V3.

Base URL

https://<host>/api/v3

Authentication

All sales endpoints are protected.

Required headers:

Authorization: Bearer <token>

How to get token:

API Usage - Auth and System: 1) Get Token

Date-Time Format

date_from and date_to: YYYY-MM-DD
updated_from and updated_to: YYYY-MM-DD HH:MM:SS

Endpoint Summary

Sales Orders

No.	Endpoint	Method	Purpose	Required Permission Scope
1	`/api/v3/sales-orders`	GET	List sales orders	`sales.order.read`
2	`/api/v3/sales-orders/{id}`	GET	Get sales order by id	`sales.order.read`
3	`/api/v3/sales-orders`	POST	Create sales order	`sales.order.write`
4	`/api/v3/sales-orders/{documentNo}/void`	POST	Void sales order	`sales.order.void`

Sales Invoices

No.	Endpoint	Method	Purpose	Required Permission Scope
1	`/api/v3/sales-invoices`	GET	List sales invoices	`sales.invoice.read`
2	`/api/v3/sales-invoices/{id}`	GET	Get sales invoice by id	`sales.invoice.read`
3	`/api/v3/sales-invoices`	POST	Create sales invoice	`sales.invoice.write`
4	`/api/v3/sales-invoices/{documentNo}/void`	POST	Void sales invoice	`sales.invoice.void`

Debtor Credit Notes

No.	Endpoint	Method	Purpose	Required Permission Scope
1	`/api/v3/debtor-credit-notes`	GET	List debtor credit notes	`sales.debtor_credit_note.read`
2	`/api/v3/debtor-credit-notes/{id}`	GET	Get debtor credit note by id	`sales.debtor_credit_note.read`
3	`/api/v3/debtor-credit-notes`	POST	Create debtor credit note	`sales.debtor_credit_note.write`

Debtor Debit Notes

No.	Endpoint	Method	Purpose	Required Permission Scope
1	`/api/v3/debtor-debit-notes`	GET	List debtor debit notes	`sales.debtor_debit_note.read`
2	`/api/v3/debtor-debit-notes/{id}`	GET	Get debtor debit note by id	`sales.debtor_debit_note.read`
3	`/api/v3/debtor-debit-notes`	POST	Create debtor debit note	`sales.debtor_debit_note.write`

Official Receipts

No.	Endpoint	Method	Purpose	Required Permission Scope
1	`/api/v3/official-receipts`	GET	List official receipts	`sales.official_receipt.read`
2	`/api/v3/official-receipts/{id}`	GET	Get official receipt by id	`sales.official_receipt.read`
3	`/api/v3/official-receipts`	POST	Create official receipt	`sales.official_receipt.write`

1) List Sales Orders

Request

GET /api/v3/sales-orders

Required Permission Scope

sales.order.read

Query Parameters

Parameter	Type	Required	Notes
`page`	int	No	default `1`
`per_page`	int	No	default `50`, max `200`
`all`	string	No
`paginate`	string	No
`q`	string	No	search by document no/ref no/BP no/BP name
`document_id`	string	No	exact document id
`document_no`	string	No	exact document no
`document_refno`	string	No	exact reference no
`document_status`	string	No	accepted: `D` (Draft), `CO` (Completed), `V` (Voided)
`branch_id`	string	No
`branch_code`	string	No
`bpartner_id`	string	No
`bpartner_no`	string	No
`bpartner_name`	string	No	partial BP name
`currency_code`	string	No	exact currency code
`date_from`	date	No
`date_to`	date	No
`updated_from`	datetime	No
`updated_to`	datetime	No
`organization_id/org_id` or `organization_code/org_code`	string	No	org filter

Response Fields

Field	Type	Notes
`data[]`	array	sales order rows
`data[].organization_id`	string	org id
`data[].organization_code`	string	org code
`data[].organization_name`	string	org name
`data[].branch_id`	string	branch id
`data[].branch_code`	string	branch code
`data[].branch_name`	string	branch name
`data[].document_id`	string	document id
`data[].document_no`	string	document no
`data[].document_date`	date string	`YYYY-MM-DD`
`data[].document_type`	string	document type code
`data[].document_type_name`	string	type label
`data[].document_status`	string	status code
`data[].document_status_label`	string	status label
`data[].workflow_status_label`	string	workflow label
`data[].bpartner_id`	string	business partner id
`data[].bpartner_no`	string	business partner no
`data[].bpartner_name`	string	business partner name
`data[].salesagent_id`	string	sales agent id
`data[].salesagent_no`	string	sales agent no
`data[].salesagent_name`	string	sales agent name
`data[].currency_code`	string	currency code
`data[].currency_name`	string	currency name
`data[].currency_rate`	string/number	currency rate
`data[].document_refno`	string	reference no
`data[].total_amount`	string/number	total amount
`data[].total_tax_amount`	string/number	total tax amount
`data[].total_nett_amount`	string/number	nett total amount
`data[].line_count`	int	number of document lines
`data[].lines[]`	array	document lines
`data[].lines[].uom_id`	string	line uom id
`data[].lines[].subtotal`	string/number	line subtotal amount
`data[].lines[].location_id`	string	line location id
`data[].lines[].location_code`	string	line location code
`data[].lines[].location_name`	string	line location name
`data[].lines[].tax_id`	string	line tax id
`data[].lines[].tax_code`	string	line tax code
`data[].lines[].tax_rate`	string/number	line tax rate
`data[].updated`	datetime string	`YYYY-MM-DD HH:MM:SS`
`meta.filters`	object	applied filters
`meta.pagination`	object/null	pagination info or `null`
`meta.execute_time_ms`	int	execution time in ms
`meta.request_time`	datetime string	request timestamp
`meta.response_time`	datetime string	response timestamp

Example cURL

curl -G "https://<host>/api/v3/sales-orders" \
  -H "Authorization: Bearer <token>" \
  --data-urlencode "organization_code=BHH" \
  --data-urlencode "q=SO0001" \
  --data-urlencode "document_status=CO" \
  --data-urlencode "all=1"

Success Response Example

{
  "status": "OK",
  "data": [
    {
      "document_id": "1-1-8001",
      "document_no": "SO000123",
      "document_date": "2026-04-09",
      "document_status": "CO",
      "document_status_label": "Completed",
      "workflow_status_label": "Completed",
      "bpartner_id": "1-1-1",
      "bpartner_no": "BP0001",
      "bpartner_name": "ABC Trading",
      "salesagent_id": "1-1-900",
      "salesagent_no": "SA0001",
      "salesagent_name": "John Agent",
      "organization_id": "1",
      "organization_code": "BHH",
      "organization_name": "BHH",
      "branch_id": "1-1",
      "branch_code": "HQ",
      "branch_name": "Headquarters",
      "document_type": "SO",
      "document_type_name": "Sales Order",
      "currency_code": "MYR",
      "currency_name": "Malaysian Ringgit",
      "currency_rate": "1.000000",
      "document_refno": "EXT-PO-1001",
      "total_amount": "100.00",
      "total_tax_amount": "0.00",
      "total_nett_amount": "100.00",
      "line_count": 1,
      "lines": [
        {
          "document_line_id": "1-1-8001-1",
          "line_seq_no": "1",
          "item_id": "1-1-10",
          "item_code": "ITEM001",
          "item_name": "Sample Item",
          "quantity": "2.0000",
          "uom_id": "1-1-400",
          "uom_code": "PCS",
          "unit_price": "50.0000",
          "discount": "0.00",
          "subtotal": "100.00",
          "tax_amount": "0.00",
          "nett_total": "100.00",
          "location_id": "1-1-500",
          "location_code": "MAIN",
          "location_name": "Main Store",
          "tax_id": "1-1-700",
          "tax_code": "SR",
          "tax_rate": "0.00"
        }
      ],
      "updated": "2026-04-09 10:15:00"
    }
  ],
  "meta": {
    "filters": {
      "organization_id": "1",
      "organization_code": "BHH",
      "q": "SO0001",
      "document_status": "CO"
    },
    "pagination": null,
    "execute_time_ms": 18,
    "request_time": "2026-04-10 14:10:00",
    "response_time": "2026-04-10 14:10:00"
  }
}

2) Get Sales Order by ID

Request

GET /api/v3/sales-orders/{id}

Required Permission Scope

sales.order.read

Query Parameters

None.

Response Fields

Field	Type	Notes
`data`	object	sales order header + lines
`data.organization_id`	string	org id
`data.organization_code`	string	org code
`data.organization_name`	string	org name
`data.branch_id`	string	branch id
`data.branch_code`	string	branch code
`data.branch_name`	string	branch name
`data.document_id`	string	document id
`data.document_no`	string	document no
`data.document_date`	date string	`YYYY-MM-DD`
`data.document_type`	string	document type code
`data.document_type_name`	string	type label
`data.document_status`	string	status code
`data.document_status_label`	string	status label
`data.workflow_status_label`	string	workflow label
`data.bpartner_id`	string	business partner id
`data.bpartner_no`	string	business partner no
`data.bpartner_name`	string	business partner name
`data.salesagent_id`	string	sales agent id
`data.salesagent_no`	string	sales agent no
`data.salesagent_name`	string	sales agent name
`data.currency_code`	string	currency code
`data.currency_name`	string	currency name
`data.currency_rate`	string/number	currency rate
`data.document_refno`	string	reference no
`data.shortremarks`	string	remarks
`data.total_amount`	string/number	total amount
`data.total_tax_amount`	string/number	total tax amount
`data.total_nett_amount`	string/number	nett total
`data.updated`	datetime string	`YYYY-MM-DD HH:MM:SS`
`data.lines[]`	array	document lines
`data.lines[].document_line_id`	string	line id
`data.lines[].line_seq_no`	string/int	line sequence
`data.lines[].item_id`	string	item id
`data.lines[].item_code`	string	item code
`data.lines[].item_name`	string	item name
`data.lines[].quantity`	string/number	quantity
`data.lines[].uom_id`	string	uom id
`data.lines[].uom_code`	string	uom code
`data.lines[].unit_price`	string/number	unit price
`data.lines[].subtotal`	string/number	line subtotal amount
`data.lines[].discount`	string/number	discount
`data.lines[].tax_amount`	string/number	tax amount
`data.lines[].nett_total`	string/number	line nett total
`meta.execute_time_ms`	int	execution time in ms
`meta.request_time`	datetime string	request timestamp
`meta.response_time`	datetime string	response timestamp

Example cURL

curl -X GET "https://<host>/api/v3/sales-orders/1-1-8001" \
  -H "Authorization: Bearer <token>" \

Success Response Example

{
  "status": "OK",
  "data": {
    "document_id": "1-1-8001",
    "document_no": "SO000123",
    "document_refno": "EXT-PO-1001",
    "document_date": "2026-04-09",
    "organization_id": "1",
    "organization_code": "BHH",
    "organization_name": "BHH",
    "branch_id": "1-1",
    "branch_code": "HQ",
    "branch_name": "Headquarters",
    "document_type": "SO",
    "document_type_name": "Sales Order",
    "document_status": "CO",
    "document_status_label": "Completed",
    "workflow_status_label": "Completed",
    "bpartner_id": "1-1-1",
    "bpartner_no": "BP0001",
    "bpartner_name": "ABC Trading",
    "salesagent_id": "1-1-900",
    "salesagent_no": "SA0001",
    "salesagent_name": "John Agent",
    "currency_code": "MYR",
    "currency_name": "Malaysian Ringgit",
    "currency_rate": "1.000000",
    "total_amount": "100.00",
    "total_tax_amount": "0.00",
    "total_nett_amount": "100.00",
    "shortremarks": "",
    "updated": "2026-04-09 10:20:00",
    "lines": [
      {
        "document_line_id": "1-1-8001-1",
        "line_seq_no": "10",
        "item_id": "1-1-10",
        "item_code": "ITEM001",
        "item_name": "Sample Item",
        "quantity": "1.0000",
        "uom_id": "1-1-400",
        "uom_code": "Unit",
        "unit_price": "100.00",
        "subtotal": "100.00",
        "discount": "0.00",
        "tax_amount": "0.00",
        "nett_total": "100.00",
        "updated": "2026-04-09 10:20:00"
      }
    ]
  },
  "meta": {
    "execute_time_ms": 11,
    "request_time": "2026-04-10 14:10:00",
    "response_time": "2026-04-10 14:10:00"
  }
}

3) Create Sales Order

Request

POST /api/v3/sales-orders

Required Permission Scope

sales.order.write

Body is required (JSON).

Body Parameters:

Field	Required	Accepted Value / Format	Notes
`headerarr`	Yes	object	document header
`headerarr.organization_id`	No	valid org id/code
`headerarr.organization_code`	No	valid org id/code
`headerarr.document_date`	No	`YYYY-MM-DD`	optional
`headerarr.document_status`	No	valid status code (`D`, `CO`, etc.)	optional
`headerarr.bpartner_id`	No	valid id/no
`headerarr.bpartner_no`	No	valid id/no
`headerarr.currency_code`	No	valid currency code	optional
`linearr`	Yes	array	minimum 1 row recommended
`linearr[].item_id`	No	valid id/code
`linearr[].item_code`	No	valid id/code
`linearr[].quantity`	No	decimal string > 0	quantity
`linearr[].uom_code`	No	valid UOM code	optional
`linearr[].unitprice`	No	decimal string >= 0	unit price
`linearr[].amount_netttotal`	No	decimal string >= 0	line nett total

Query Parameters

None.

Response Fields

Field	Type	Notes
`data`	object/array	Endpoint payload. See success response example for exact fields.
`meta`	object	Standard metadata including timing fields.

document_id, document_no, msg, updated

Example cURL

curl -X POST "https://<host>/api/v3/sales-orders" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "headerarr": {
      "organization_code": "BHH",
      "document_date": "2026-04-09",
      "document_status": "D",
      "bpartner_no": "BP0001",
      "currency_code": "MYR"
    },
    "linearr": [
      {
        "item_code": "ITEM001",
        "quantity": "1",
        "uom_code": "Unit",
        "unitprice": "100.00",
        "amount_netttotal": "100.00"
      }
    ]
  }'

Success Response Example

{
  "status": "OK",
  "data": {
    "document_id": "1-1-8001",
    "document_no": "SO000123",
    "msg": "Document saved successfully",
    "updated": ""
  },
  "meta": {
    "execute_time_ms": 24,
    "request_time": "2026-04-10 14:10:00",
    "response_time": "2026-04-10 14:10:00"
  }
}

4) Void Sales Order

Request

POST /api/v3/sales-orders/{documentNo}/void

Required Permission Scope

sales.order.void

Body is supported (JSON).

Body Parameters:

Field	Required	Accepted Value / Format	Notes
`organization_id`	No	valid org id/code
`organization_code`	No	valid org id/code
`document_reason`	No	string	void reason/audit note

Query Parameters

None.

Response Fields

Field	Type	Notes
`data`	object/array	Endpoint payload. See success response example for exact fields.
`meta`	object	Standard metadata including timing fields.

document_id, document_no, msg, updated

Example cURL

curl -X POST "https://<host>/api/v3/sales-orders/SO000123/void" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "organization_code": "BHH",
    "document_reason": "Customer cancel"
  }'

Success Response Example

{
  "status": "OK",
  "data": {
    "document_id": "1-1-8001",
    "document_no": "SO000123",
    "msg": "Document voided successfully",
    "updated": ""
  },
  "meta": {
    "execute_time_ms": 18,
    "request_time": "2026-04-10 14:10:00",
    "response_time": "2026-04-10 14:10:00"
  }
}

5) List Sales Invoices

Request

GET /api/v3/sales-invoices

Required Permission Scope

sales.invoice.read

Query Parameters

Same as GET /api/v3/sales-orders.

Response Fields

Field	Type	Notes
`data`	object/array	Endpoint payload. See success response example for exact fields.
`meta`	object	Standard metadata including timing fields.

Same as sales order list fields.

Example cURL

curl -G "https://<host>/api/v3/sales-invoices" \
  -H "Authorization: Bearer <token>" \
  --data-urlencode "organization_code=BHH"

Success Response Example

{
  "status": "OK",
  "data": [{ "document_id": "1-1-8002", "document_no": "SI000321", "updated": "2026-04-09 10:30:00" }],
  "meta": { "pagination": null, "execute_time_ms": 17, "request_time": "2026-04-10 14:10:00", "response_time": "2026-04-10 14:10:00" }
}

6) Get Sales Invoice by ID

Request

GET /api/v3/sales-invoices/{id}

Required Permission Scope

sales.invoice.read

Query Parameters

None.

Response Fields

Field	Type	Notes
`data`	object/array	Endpoint payload. See success response example for exact fields.
`meta`	object	Standard metadata including timing fields.

Same as sales order detail fields.

Example cURL

curl -X GET "https://<host>/api/v3/sales-invoices/1-1-8002" \
  -H "Authorization: Bearer <token>" \

Success Response Example

{
  "status": "OK",
  "data": { "document_id": "1-1-8002", "document_no": "SI000321", "updated": "2026-04-09 10:30:00", "lines": [] },
  "meta": { "execute_time_ms": 10, "request_time": "2026-04-10 14:10:00", "response_time": "2026-04-10 14:10:00" }
}

7) Create Sales Invoice

Request

POST /api/v3/sales-invoices

Required Permission Scope

sales.invoice.write

Body is required (JSON).

Body Parameters:

Field	Required	Accepted Value / Format	Notes
`headerarr`	Yes	object	same accepted values as Sales Order create
`linearr`	Yes	array	same accepted values as Sales Order create

Query Parameters

None.

Response Fields

Field	Type	Notes
`data`	object/array	Endpoint payload. See success response example for exact fields.
`meta`	object	Standard metadata including timing fields.

document_id, document_no, msg, updated

Example cURL

curl -X POST "https://<host>/api/v3/sales-invoices" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"headerarr":{"organization_code":"BHH","document_date":"2026-04-09","bpartner_no":"BP0001"},"linearr":[{"item_code":"ITEM001","quantity":"1"}]}'

Success Response Example

{
  "status": "OK",
  "data": { "document_id": "1-1-8002", "document_no": "SI000321", "msg": "Document saved successfully", "updated": "" },
  "meta": { "execute_time_ms": 24, "request_time": "2026-04-10 14:10:00", "response_time": "2026-04-10 14:10:00" }
}

8) Void Sales Invoice

Request

POST /api/v3/sales-invoices/{documentNo}/void

Required Permission Scope

sales.invoice.void

Body is supported (JSON).

Body Parameters:

Field	Required	Accepted Value / Format	Notes
`organization_id`	No	valid org id/code
`organization_code`	No	valid org id/code
`document_reason`	No	string	void reason/audit note

Query Parameters

None.

Response Fields

Field	Type	Notes
`data`	object/array	Endpoint payload. See success response example for exact fields.
`meta`	object	Standard metadata including timing fields.

document_id, document_no, msg, updated

Example cURL

curl -X POST "https://<host>/api/v3/sales-invoices/SI000321/void" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"organization_code":"BHH","document_reason":"Cancel"}'

Success Response Example

{
  "status": "OK",
  "data": { "document_id": "1-1-8002", "document_no": "SI000321", "msg": "Document voided successfully", "updated": "" },
  "meta": { "execute_time_ms": 18, "request_time": "2026-04-10 14:10:00", "response_time": "2026-04-10 14:10:00" }
}

9) List Debtor Credit Notes

Request

GET /api/v3/debtor-credit-notes

Required Permission Scope

sales.debtor_credit_note.read

Query Parameters

Same as GET /api/v3/sales-orders.

Response Fields

Field	Type	Notes
`data`	object/array	Endpoint payload. See success response example for exact fields.
`meta`	object	Standard metadata including timing fields.

Same as sales document list fields.

Example cURL

curl -G "https://<host>/api/v3/debtor-credit-notes" -H "Authorization: Bearer <token>"

Success Response Example

{ "status": "OK", "data": [{ "document_id": "1-1-8010", "document_no": "DCN000101", "updated": "2026-04-09 11:00:00" }], "meta": { "pagination": null, "execute_time_ms": 16, "request_time": "2026-04-10 14:10:00", "response_time": "2026-04-10 14:10:00" } }

10) Get Debtor Credit Note by ID

Request

GET /api/v3/debtor-credit-notes/{id}

Required Permission Scope

sales.debtor_credit_note.read

Query Parameters

None.

Response Fields

Field	Type	Notes
`data`	object/array	Endpoint payload. See success response example for exact fields.
`meta`	object	Standard metadata including timing fields.

Same as sales document detail fields.

Example cURL

curl -X GET "https://<host>/api/v3/debtor-credit-notes/1-1-8010" -H "Authorization: Bearer <token>"

Success Response Example

{ "status": "OK", "data": { "document_id": "1-1-8010", "document_no": "DCN000101", "updated": "2026-04-09 11:00:00", "lines": [] }, "meta": { "execute_time_ms": 10, "request_time": "2026-04-10 14:10:00", "response_time": "2026-04-10 14:10:00" } }

11) Create Debtor Credit Note

Request

POST /api/v3/debtor-credit-notes

Required Permission Scope

sales.debtor_credit_note.write

Body is required (JSON).

Body Parameters:

Field	Required	Accepted Value / Format	Notes
`headerarr`	Yes	object	same accepted values as Sales Order create
`linearr`	Yes	array	same accepted values as Sales Order create

Query Parameters

None.

Response Fields

Field	Type	Notes
`data`	object/array	Endpoint payload. See success response example for exact fields.
`meta`	object	Standard metadata including timing fields.

document_id, document_no, msg, updated

Example cURL

curl -X POST "https://<host>/api/v3/debtor-credit-notes" -H "Authorization: Bearer <token>" -H "Content-Type: application/json" -d '{"headerarr":{"organization_code":"BHH"},"linearr":[]}'

Success Response Example

{ "status": "OK", "data": { "document_id": "1-1-8010", "document_no": "DCN000101", "msg": "Document saved successfully", "updated": "" }, "meta": { "execute_time_ms": 22, "request_time": "2026-04-10 14:10:00", "response_time": "2026-04-10 14:10:00" } }

12) List Debtor Debit Notes

Request

GET /api/v3/debtor-debit-notes

Required Permission Scope

sales.debtor_debit_note.read

Query Parameters

Same as GET /api/v3/sales-orders.

Response Fields

Field	Type	Notes
`data`	object/array	Endpoint payload. See success response example for exact fields.
`meta`	object	Standard metadata including timing fields.

Same as sales document list fields.

Example cURL

curl -G "https://<host>/api/v3/debtor-debit-notes" -H "Authorization: Bearer <token>"

Success Response Example

{ "status": "OK", "data": [{ "document_id": "1-1-8011", "document_no": "DDN000101", "updated": "2026-04-09 11:10:00" }], "meta": { "pagination": null, "execute_time_ms": 16, "request_time": "2026-04-10 14:10:00", "response_time": "2026-04-10 14:10:00" } }

13) Get Debtor Debit Note by ID

Request

GET /api/v3/debtor-debit-notes/{id}

Required Permission Scope

sales.debtor_debit_note.read

Query Parameters

None.

Response Fields

Field	Type	Notes
`data`	object/array	Endpoint payload. See success response example for exact fields.
`meta`	object	Standard metadata including timing fields.

Same as sales document detail fields.

Example cURL

curl -X GET "https://<host>/api/v3/debtor-debit-notes/1-1-8011" -H "Authorization: Bearer <token>"

Success Response Example

{ "status": "OK", "data": { "document_id": "1-1-8011", "document_no": "DDN000101", "updated": "2026-04-09 11:10:00", "lines": [] }, "meta": { "execute_time_ms": 10, "request_time": "2026-04-10 14:10:00", "response_time": "2026-04-10 14:10:00" } }

14) Create Debtor Debit Note

Request

POST /api/v3/debtor-debit-notes

Required Permission Scope

sales.debtor_debit_note.write

Body is required (JSON).

Body Parameters:

Field	Required	Accepted Value / Format	Notes
`headerarr`	Yes	object	same accepted values as Sales Order create
`linearr`	Yes	array	same accepted values as Sales Order create

Query Parameters

None.

Response Fields

Field	Type	Notes
`data`	object/array	Endpoint payload. See success response example for exact fields.
`meta`	object	Standard metadata including timing fields.

document_id, document_no, msg, updated

Example cURL

curl -X POST "https://<host>/api/v3/debtor-debit-notes" -H "Authorization: Bearer <token>" -H "Content-Type: application/json" -d '{"headerarr":{"organization_code":"BHH"},"linearr":[]}'

Success Response Example

{ "status": "OK", "data": { "document_id": "1-1-8011", "document_no": "DDN000101", "msg": "Document saved successfully", "updated": "" }, "meta": { "execute_time_ms": 22, "request_time": "2026-04-10 14:10:00", "response_time": "2026-04-10 14:10:00" } }

15) List Official Receipts

Request

GET /api/v3/official-receipts

Required Permission Scope

sales.official_receipt.read

Query Parameters

Same as GET /api/v3/sales-orders.

Response Fields

Field	Type	Notes
`data`	object/array	Endpoint payload. See success response example for exact fields.
`meta`	object	Standard metadata including timing fields.

Same as sales document list fields.

Example cURL

curl -G "https://<host>/api/v3/official-receipts" -H "Authorization: Bearer <token>"

Success Response Example

{ "status": "OK", "data": [{ "document_id": "1-1-8012", "document_no": "OR000123", "updated": "2026-04-09 11:20:00" }], "meta": { "pagination": null, "execute_time_ms": 16, "request_time": "2026-04-10 14:10:00", "response_time": "2026-04-10 14:10:00" } }

16) Get Official Receipt by ID

Request

GET /api/v3/official-receipts/{id}

Required Permission Scope

sales.official_receipt.read

Query Parameters

None.

Response Fields

Field	Type	Notes
`data`	object/array	Endpoint payload. See success response example for exact fields.
`meta`	object	Standard metadata including timing fields.

Same as sales document detail fields.

Example cURL

curl -X GET "https://<host>/api/v3/official-receipts/1-1-8012" -H "Authorization: Bearer <token>"

Success Response Example

{ "status": "OK", "data": { "document_id": "1-1-8012", "document_no": "OR000123", "updated": "2026-04-09 11:20:00", "lines": [] }, "meta": { "execute_time_ms": 10, "request_time": "2026-04-10 14:10:00", "response_time": "2026-04-10 14:10:00" } }

17) Create Official Receipt

Request

POST /api/v3/official-receipts

Required Permission Scope

sales.official_receipt.write

Body is required (JSON).

Body Parameters:

Field	Required	Accepted Value / Format	Notes
`headerarr`	Yes	object	same accepted values as Sales Order create
`linearr`	Yes	array	same accepted values as Sales Order create

Query Parameters

None.

Response Fields

Field	Type	Notes
`data`	object/array	Endpoint payload. See success response example for exact fields.
`meta`	object	Standard metadata including timing fields.

document_id, document_no, msg, updated

Example cURL

curl -X POST "https://<host>/api/v3/official-receipts" -H "Authorization: Bearer <token>" -H "Content-Type: application/json" -d '{"headerarr":{"organization_code":"BHH"},"linearr":[]}'

Success Response Example

{ "status": "OK", "data": { "document_id": "1-1-8012", "document_no": "OR000123", "msg": "Document saved successfully", "updated": "" }, "meta": { "execute_time_ms": 22, "request_time": "2026-04-10 14:10:00", "response_time": "2026-04-10 14:10:00" } }