-
Notifications
You must be signed in to change notification settings - Fork 2
Get Data Documentation Sales Order
syazanisimit edited this page Mar 12, 2026
·
1 revision
Using CURL in terminal console to retrieve the Sales Order data. (* If there is no data in the data column, user may direct remove the column from the get data array.)
Get your Token here
curl --header "Content-Type: application/x-www-form-urlencoded" \
--request POST \
--data '
{
"action":"getSalesOrderData",
"module":"sales",
"token":"yourtoken",
"uid":"admin",
"org":"SIMIT",
"branch":"HQ",
"data":
{
"document_id":"",
"document_no":"SO-001",
"bpartner_id":"",
"bpartner_no":"",
"date_from":"",
"date_to":"",
"document_status":"CO",
"document_refno":""
}
}
' \
https://simbiz_system_url/simbiz/api.php
The available field for retrieve Sales Order Data Required field for calling API
| No | Field Name | Data Type (Size) | Required | Description |
|---|---|---|---|---|
| 1 | document_id | varchar(50) | Y | Backend ID for the sales order (* will pick either one between document_id and document_no, document_id will be the first priority) |
| 2 | document_no | varchar(255) | Y | Document Number (* will pick either one between document_id and document_no, document_id will be the first priority) |
| 3 | bpartner_id | varchar(50) | Business Partner ID | |
| 4 | bpartner_no | varchar(50) | Business Partner No | |
| 5 | date_from | date | Sales Order date from (Document Date) (Date format YYYY-MM-DD) | |
| 6 | date_to | date | Sales Order date to (Document Data) (Date format YYYY-MM-DD) | |
| 7 | document_status | varchar(30) | Document Status (CO = Confirmed, D = Draft, V = Voided, CL = Closed) | |
| 8 | document_refno | varchar(50) | Sales Order Ref. No. |
Sales Order Header Data
| No | Field Name | Data Type (Size) | Required | Description |
|---|---|---|---|---|
| 1 | Document ID | varchar(255) | Sales Order's document id | |
| 2 | Document No | varchar(255) | Sales Order's document number | |
| 3 | Document Type | varchar(10) | RC (Sales Order) | |
| 4 | Document Reference No | varchar(255) | Sales Order's reference number | |
| 5 | Document Date | date | Sales Order's document date | |
| 6 | Document Status | varchar(30) | D : Draft; CO : Confirmed; V : Voided. | |
| 7 | Document Prepared By | varchar(50) | Sales Order's prepare user | |
| 8 | Document Description | text | Sales Order's description | |
| 9 | Document Note | text | Sales Order's Note | |
| 10 | Document Reason | varchar(255) | Sales Order's void reason | |
| 11 | BPartner Name | varchar(50) | Sales Order's business partner name | |
| 12 | BPartner Account | varchar(50) | Sales Order's business partner account | |
| 13 | Bill Contact Name | varchar(255) | Sales Order's bill contact name | |
| 14 | Bill Contact HP | varchar(255) | Sales Order's bill contact handphone number | |
| 15 | Bill Address | Combination of all the bill contact address data | ||
| 16 | Ship Address | Combination of all the ship contact address data | ||
| 17 | Ship Contact Name | varchar(255) | Sales Order's shipping contact name | |
| 18 | Ship Contact HP | varchar(255) | Sales Order's shipping contact handphone number | |
| 19 | Ship Contact HP | varchar(255) | Sales Order's shipping contact handphone number | |
| 20 | Total Amount | decimal(22,2) | Sales Order's total amount | |
| 21 | Total Amount Local | decimal(22,2) | Sales Order's total amount in local currency | |
| 22 | Total Tax Amount | decimal(22,2) | Sales Order's total tax amount | |
| 23 | Total Tax Amount Local | decimal(22,2) | Sales Order's total tax amount in local currency | |
| 24 | Total Nett Amount | decimal(22,2) | Sales Order's total net amount (total amount + tax amount) | |
| 25 | Total Nett Amount Local | decimal(22,2) | Sales Order's total net amount in local currency | |
| 26 | Sales Agent | varchar(255) | Sales Order's sales agent | |
| 27 | Terms Name | varchar(255) | Sales Order's terms name | |
| 28 | Terms Day | varchar(255) | Sales Order's terms day | |
| 29 | Currency Code | varchar(255) | Sales Order's currency code | |
| 30 | Currency Rate | decimal(14,8) | Sales Order's currency rate | |
| 31 | Track1 | varchar(50) | Sales Order's Track 1 ID | |
| 32 | Track1 Value | varchar(200) | Sales Order's Track 1 Name | |
| 33 | Track2 | varchar(50) | Sales Order's Track 2 ID | |
| 34 | Track2 Value | varchar(200) | Sales Order's Track 2 Name | |
| 35 | Track3 | varchar(50) | Sales Order's Track 3 ID | |
| 36 | Track3 Value | varchar(200) | Sales Order's Track 3 Name | |
| 37 | Track4 | varchar(50) | Sales Order's Track 4 ID | |
| 38 | Track4 Value | varchar(200) | Sales Order's Track 4 Name | |
| 39 | Track5 | varchar(50) | Sales Order's Track 5 ID | |
| 40 | Track5 Value | varchar(200) | Sales Order's Track 5 Name | |
| 41 | Is Print | int(11) | Sales Order's is allow print out in the print format (yes[1]/no[0]) | |
| 42 | Created | datetime | Sales Order's created date in the system | |
| 43 | Created By | varchar(50) | Sales Order's creator | |
| 44 | Updated | datetime | Sales Order's last updated date | |
| 45 | Updated By | varchar(50) | Sales Order's last updated user | |
| 46 | Organization | varchar(200) | Sales Order was created under which organization | |
| 47 | Branch | varchar(200) | Sales Order was created under which branch |
Sales Order line data
| No | Field Name | Data Type (Size) | Required | Description |
|---|---|---|---|---|
| 1 | DocumentLine ID | varchar(50) | Y | Sales Order's document line ID |
| 2 | Line Seq No. | smallint(6) | Sales Order's document line sequence number | |
| 3 | Line Description | text | Sales Order's document line description | |
| 4 | Line Promise Date | date | Sales Order's document line promise date | |
| 5 | Item Code | varchar(255) | document line item code | |
| 6 | Item Name | varchar(255) | document line item name | |
| 7 | Quantity | decimal(28,8) | document line item quantity | |
| 8 | Base Quantity | decimal(28,8) | document line item base quantity | |
| 9 | UOM | decimal(28,8) | document line item UOM | |
| 10 | Base UOM | decimal(28,8) | document line item Base UOM | |
| 11 | Unit Price | decimal(24,4) | document line item unit price | |
| 12 | Unit Price Local | decimal(24,4) | document line item unit price in local currency | |
| 13 | Discount | varchar(255) | document line item discount rate | |
| 14 | Discount Amount | decimal(24,2) | document line item discount amount | |
| 15 | Sub Amount | decimal(22,2) | document line sub amount | |
| 16 | Sub Amount Local | decimal(22,2) | document line sub amount in local currency | |
| 17 | Tax Amount | decimal(22,2) | document line tax amount | |
| 18 | Tax Amount Local | decimal(22,2) | document line tax amount in local currency | |
| 19 | Nett Total | decimal(22,2) | document line net total amount | |
| 20 | Nett Total Local. | decimal(22,2) | document line net total amount in local currency | |
| 21 | Is Inclusive | int(1) | is the item inclusive tax (yes[1]/no[0]) | |
| 22 | Tax Name | varchar(255) | document line item tax name | |
| 23 | Tax Rate | decimal(10,4) | document line item tax rate | |
| 24 | Tax Account | varchar(50) | document line item tax account | |
| 25 | Msic | varchar(50) | document line item MSIC details | |
| 26 | Serial No | text | document line item serial number | |
| 27 | Location Name | varchar(50) | document line item Location Name | |
| 28 | Account | varchar(50) [0] | document line item account. | |
| 29 | Track1 | varchar(50) | document line track 1 | |
| 30 | Track2 | varchar(50) | document line track 2 | |
| 31 | Track3 | varchar(50) | document line track 3 | |
| 32 | Track4 | varchar(50) | document line track 4 | |
| 33 | Track5 | varchar(50) | document line track 5 | |
| 34 | Customfield1 | varchar(255) | document line custom field 1 | |
| 35 | Customfield2 | varchar(255) | document line custom field 2 | |
| 36 | Customfield3 | varchar(255) | document line custom field 3 | |
| 37 | Created | datetime | document line created date in the system | |
| 38 | Created By | varchar(50) | document line creator | |
| 39 | Updated | datetime | document line last updated date | |
| 40 | Updated By | varchar(50) | document line last updated user | |
| 41 | Inventory Cost | decimal(14,2) NULL | document line inventory cost | |
| 42 | HS Code | varchar(50) | document line item HS code | |
| 43 | HS Code Name | varchar(50) | document line item HS code Code |
{
"status": "OK",
"msg": "OK",
"data": [
{
"Sales Order Header": {
"Document ID": "1-1-6198",
"Document No": "SO 00293",
"Document Type": "SO",
"Document Reference No": "",
"Document Date": "2026-02-23",
"Document Status": "CO",
"Document Prepared By": "admin",
"Document Description": "",
"Document Note": "",
"Document Reason": "",
"BPartner Name": "Test E-Invoice",
"BPartner Account": null,
"Bill Contact Name": "Seth Harris",
"Bill Conatct HP": "0192718110",
"Bill Address": "Gurney Mall (Residensi UTMKL), Jalan Maktab, 54000, Kuala Lumpur, 1-1-3, MY",
"Ship Address": "Gurney Mall (Residensi UTMKL), Jalan Maktab, 54000, Kuala Lumpur, 1-1-3, MY",
"Shipping Info": "",
"Ship Contact Name": "Seth Harris",
"Ship Contact HP": "0192718110",
"Delivery Method": null,
"Delivery Term": null,
"Total Amount": "10.00",
"Total Amount Local": "10.00",
"Total Tax Amount": "0.80",
"Total Tax Amount Local": "0.80",
"Total Nett Amount": "10.80",
"Total Nett Amount Local": "10.80",
"Sales Agent": "Chwe",
"Terms Name": "30 Days",
"Terms Day": "30",
"Currency Code": "MYR",
"Currency Rate": "1.00000000",
"Track 1": null,
"Track 1 Value": "",
"Track 2": null,
"Track 2 Value": "",
"Track 3": null,
"Track 3 Value": "",
"Track 4": null,
"Track 4 Value": "",
"Track 5": null,
"Track 5 Value": "",
"Is Print": "1",
"From Order": null,
"Filling Date": null,
"Filling Date Last Change": null,
"IT Sent Date": null,
"IT Type": null,
"IT Remark": null,
"IT Updated": null,
"IT Updated By": null,
"Created": "2026-02-23 09:49:02",
"Created By": "admin",
"Updated": "2026-02-23 09:49:02",
"Updated By": "admin",
"Organization": "SIM IT SDN BHD",
"Branch": "Paradigme Branch"
},
"Sales Order Line Details": [
{
"Document Line ID": "1-1-6198-177181133251316",
"Line Seq No": "10",
"Line Description": "",
"Line Promise Date": "0000-00-00",
"Item Code": "DRINK002",
"Item Name": "Kopi O 9",
"Quantity": "1.00000000",
"Base Quantity": "1.00000000",
"UOM": "Unit (s)",
"Base UOM": "Unit (s)",
"Unit Price": "10.000000",
"Unit Price Local": "10.000000",
"Discount": "",
"Discount Amount": "0.00",
"Sub Amount": "10.00",
"Sub Amount Local": "10.00",
"Tax Amount": "0.80",
"Tax Amount Local": "0.80",
"Nett Total": "10.80",
"Nett Total Local": "10.80",
"Is Inclusive": "0",
"Tax Name": "SST-6 (Service Tax 6%)",
"Tax Rate": "8.0000",
"Tax Account": "Credit Sales",
"MSIC": null,
"Serial No": "",
"Location Name": null,
"Account": "Credit Sales",
"Track 1": null,
"Track 2": null,
"Track 3": null,
"Track 4": null,
"Track 5": null,
"Custom Field 1": "",
"Custom Field 2": "",
"Custom Field 3": "",
"From Order": null,
"From Order Line": null,
"Created": "2026-02-23 09:49:02",
"Created By": "admin",
"Updated": "2026-02-23 09:49:02",
"Updated By": "admin",
"Is Print": "1",
"Line Document No": null,
"Inventory Debit Account": null,
"Inventory Credit Account": null,
"Tax Updated By": "",
"Inventory Cost": "0.00",
"HS Code": "",
"HS Code Name": null
}
]
}
]
}