API
Table of Contents
Features
Listing down all the sales orders in one page including search, sort, and pagination.
API
Welcome to the Sales Order API documentation! This section provides details on how to interact with the API to manage sales orders index
Endpoint
| Type | Endpoint |
|---|---|
GET | /sales-order/index |
Request
{
"divisionId": 1,
"sorts": [],
"filters": [],
"pageSize": 10
}
| Parameter | Type | Description | Example |
|---|---|---|---|
divisionId | integer | Division ID of the user. | 1 |
sorts | array | The field to sort by (e.g., doc_code, status). | doc_code, status |
filters | array | The field to filter search by (e.g., doc_code, status). | doc_code = SO1001, status = COMPLETE |
pageSize | integer | The number of results per page (default is 20). | 10, 50 (or leave empty for default 20) |
Response
{
"data": [
{
"id": 18390,
"doc_code": "SO00014",
"ref_code": "testing purpose",
"doc_date": "2025-01-06 00:00:00",
"order_type": "m",
"company_id": 0,
"customer_id": 2,
"salesman_id": 17,
"project_id": 0,
"division_id": 0,
"term_id": 0,
"term_code": "",
"term_day": 0,
"branch_id": 0,
"branch_code": "",
"area_id": 0,
"area_code": "",
"del_address_01": "0",
"del_address_02": "0",
"del_address_03": "0",
"del_address_04": "0",
"del_attention": "0",
"del_postcode": "0",
"del_phone_01": "0",
"del_phone_02": "0",
"del_fax_01": "0",
"del_fax_02": "0",
"description": "0",
"currency_rate": "0.000000",
"currency_id": 0,
"disc_percent_01": "0.0000",
"disc_percent_02": "0.0000",
"disc_percent_03": "0.0000",
"disc_percent_04": "0.0000",
"disc_percent_05": "0.0000",
"disc_percent_06": "0.0000",
"disc_percent_07": "0.0000",
"disc_percent_08": "0.0000",
"disc_amt": "0.000000",
"disc_local_amt": "0.000000",
"tax_group_id": 0,
"tax_id_01": 0,
"tax_percent_01": "0.00",
"tax_id_02": 0,
"tax_percent_02": "0.00",
"tax_id_03": 0,
"tax_percent_03": "0.00",
"tax_id_04": 0,
"tax_percent_04": "0.00",
"tax_amt": "0.000000",
"tax_local_amt": "0.000000",
"order_amt": "0.000000",
"order_local_amt": "0.000000",
"net_amt": "0.000000",
"net_local_amt": "0.000000",
"remark_01": "",
"remark_02": "",
"is_printed": 0,
"is_exported": 0,
"status": 0,
"voided": "1970-01-01 00:00:00",
"voidedby": 0,
"void_reason_id": 0,
"void_remark": "",
"location_check_in_id": 0,
"lorry_num": "",
"k2_ref_no_01": "",
"k2_ref_no_02": "",
"k2_date": "1970-01-01 00:00:00",
"incoterms": "",
"created": "2025-01-06T06:24:21.000000Z",
"createdby": 1,
"updated": "2025-02-10T05:03:33.000000Z",
"updatedby": 1,
"userfield_01": "",
"userfield_02": "",
"userfield_03": "",
"userfield_04": "",
"usernumber_01": "0.0000",
"usernumber_02": "0.0000",
"usernumber_03": "0.0000",
"usernumber_04": "0.0000",
"useryesno_01": 0,
"useryesno_02": 0,
"useryesno_03": 0,
"useryesno_04": 0,
"userdate_01": "1970-01-01 00:00:00",
"userdate_02": "1970-01-01 00:00:00",
"userdate_03": "1970-01-01 00:00:00",
"userdate_04": "1970-01-01 00:00:00"
}
],
"first_page_url": "base_url/api/v1/sales-order/index?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "base_url/api/v1/sales-order/index?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "base_url/api/v1/sales-order/index?page=1",
"label": "1",
"active": true
}
],
"next_page_url": null,
"path": "base_url/api/v1/sales-order/index",
"per_page": 20,
"prev_page_url": null,
"to": 20,
"total": 1
}