-
Notifications
You must be signed in to change notification settings - Fork 2
Get Data Documentation Invoice
seansimit edited this page Oct 12, 2022
·
19 revisions
Using CURL in terminal console to retrieve the Invoice data. (* If there is no data in the data column, user may direct remove the column from the get data array.) {yourtoken} : Get your Token here
curl --header "Content-Type: application/x-www-form-urlencoded" \
--request POST \
--data '
{
"action":"getSalesInvoiceData",
"module":"sales",
"token":"{yourtoken}",
"uid":"{youruid}",
"org":"{yourorg}",
"branch":"{yourbranch}",
"data":
{
"document_id":"",
"document_no":"SI001",
"bpartner_id":"",
"bpartner_no":"",
"date_from":"",
"date_to":"",
"document_status":"CO"
}
}
' \
https://simbiz_system_url/simbiz/api.php
The available field for retrieve Invoice 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 invoice (* 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 Invoice date from (document_date) (Date format YYYY-MM-DD) | |
| 6 | date_to | date | Sales Invoice date to (document_date) (Date format YYYY-MM-DD) | |
| 7 | document_status | varchar(30) | Document Status (CO = Confirmed, D = Draft, V = Voided, CL = Closed) |
Sales Invoice Header Data
| No | Field Name | Data Type (Size) | Required | Description |
|---|---|---|---|---|
| 1 | Document ID | varchar(50) | Y | Sales Invoice's document ID |
| 2 | Document No | varchar(255) | Y | Sales Invoice's document No |
| 3 | Document Type | varchar(10) | SI (Sales Invoice) | |
| 4 | Document Reference No | varchar(255) | Sales Invoice's document reference number | |
| 5 | Document Date | date | Sales Invoice's document date | |
| 6 | Document Status | varchar(30) | Sales Invoice's Status | |
| 7 | Document Prepared By | varchar(50) | Sales Invoice's Prepared By | |
| 8 | Document Description | text | Sales Invoice's Description | |
| 9 | Document Note | text | Sales Invoice's Internal Note | |
| 10 | Document Reason | varchar(255) | Sales Invoice's Document Void Reason | |
| 11 | Document GLMemo | varchar(255) | Sales Invoice's GL Memo | |
| 12 | BPartner Name | varchar(255) | Sales Invoice's business partner name | |
| 13 | BPartner Account | varchar(50) | Sales Invoice's business partner account | |
| 14 | Bill Contact Name | varchar(255) | Sales Invoice's bill contact name | |
| 15 | Bill Contact HP | varchar(255) | Sales Invoice's bill contact handphone number | |
| 16 | Bill Address | Combination of all the bill contact address data | ||
| 17 | Ship Adress | Combination of all the ship contact address data | ||
| 18 | Shipping Info | varchar(255) | Sales Invoice's shipping info | |
| 19 | Ship Contact Name | varchar(255) | Sales Invoice's shipping contact name | |
| 20 | Ship Contact HP | varchar(50) | Sales Invoice's shipping contact handphone number | |
| 21 | Delivery Method | varchar(50) | Sales Invoice's delivery method | |
| 22 | Delivery Term | varchar(50) | Sales Invoice's delivery term | |
| 23 | Total Amount | decimal(22,2) | Sales Invoice's total amount | |
| 24 | Total Amount Local | decimal(22,2) | Sales Invoice's total amount in local currency | |
| 25 | Total Tax Amount | decimal(22,2) | Sales Invoice's total tax amount | |
| 26 | Total Tax Amount Local | decimal(22,2) | Sales Invoice's total tax amount in local currency | |
| 27 | Total Nett Amount | decimal(22,2) | Sales Invoice's total net amount (amt + tax) | |
| 28 | Total Nett Amount Local | decimal(22,2) | Sales Invoice's total net amount in local currency | |
| 29 | Sales Agent | varchar(255) | Sales Invoice's sales agent | |
| 30 | Terms Name | varchar(255) | Sales Invoice's term name | |
| 31 | Terms Day | int(11) | Sales Invoice's term day | |
| 32 | Currency Code | varchar(255) | Sales Invoice's currency code | |
| 33 | Currency Rate | decimal(14,8) NULL | Sales Invoice's currency rate | |
| 34 | Track 1 | varchar(50) | Sales Invoice's Track 1 ID | |
| 35 | Track 1 Value | varchar(200) | Sales Invoice's Track 1 Name | |
| 36 | Track 2 | varchar(50) | Sales Invoice's Track 2 ID | |
| 37 | Track 2 Value | varchar(255) | Sales Invoice's Track 2 Name | |
| 38 | Track 3 | varchar(50) | Sales Invoice's Track 3 ID | |
| 39 | Track 3 Value | varchar(255) | Sales Invoice's Track 3 Name | |
| 40 | Track 4 | varchar(50) | Sales Invoice's Track 4 ID | |
| 41 | Track 4 Value | varchar(255) | Sales Invoice's Track 4 Name | |
| 42 | Track 5 | varchar(50) | Sales Invoice's Track 5 ID | |
| 43 | Track 5 Value | varchar(255) | Sales Invoice's Track 5 Name | |
| 44 | Is Print | smallint(1) | ||
| 45 | From Order | varchar(50) | Sales Invoice's generate from document | |
| 46 | Filling Date | date | Sales Invoice's filling Date | |
| 47 | Filling Date Last Change | varchar(50) | Sales Invoice's filling Date last updated user | |
| 48 | IT Sent Date | date | ||
| 49 | IT Type | varchar(60) | ||
| 50 | IT Remark | text | ||
| 51 | IT Updated | datetime | ||
| 52 | IT Updated By | varchar(50) | ||
| 53 | Created | datetime | Sales Invoice's created date in the system | |
| 54 | Created By | varchar(50) | Sales Invoice's creator | |
| 55 | Updated | datetime | Sales Invoice's last updated date | |
| 56 | Updated By | varchar(50) | Sales Invoice's last updated user | |
| 57 | Organization | varchar(200) | Sales Invoice was created under which organization | |
| 58 | Branch | varchar(200) | Sales Invoice was created under which branch | |
| 59 | Rounding Account ID | varchar(50) | Sales Invoice's rounding account ID | |
| 60 | Rounding Amount | decimal(22,2) | Sales Invoice's rounding amount | |
| 61 | Outstanding | decimal(22,2) | Sales Invoice's Outstanding amount |
Sales Invoice line data
| No | Field Name | Data Type (Size) | Required | Description |
|---|---|---|---|---|
| 1 | Document Line ID | varchar(50) | Y | Sales Invoice's document line ID |
| 2 | Line Seq No | smallint(6) | Sales Invoice's document line Sequence No | |
| 3 | Line Description | text | Sales Invoice's Line description | |
| 4 | Line Promise Date | date | Sales Invoice's line promise date | |
| 5 | Item Code | varchar(255) | Sales Invoice's line item code | |
| 6 | Item Name | varchar(255) | Sales Invoice's line item name | |
| 7 | Quantity | decimal(28,8) | Sales Invoice's line item quantity | |
| 8 | Base Quantity | decimal(28,8) | Sales Invoice's line item base quantity | |
| 9 | UOM | varchar(255) | Sales Invoice's line item UOM | |
| 10 | Base UOM | varchar(255) | Sales Invoice's line item base UOM | |
| 11 | Unit Price | decimal(24,4) | Sales Invoice's line item unit price | |
| 12 | Unit Price Local | decimal(24,4) | Sales Invoice's line item unit price in local currency | |
| 13 | Discount | varchar(255) | Sales Invoice's line item discount percentage | |
| 14 | Discount Amount | decimal(24,2) | Sales Invoice's line item discount amount | |
| 15 | Sub Amount | decimal(22,2) | Sales Invoice's line sub amount (unitprice * quantity) | |
| 16 | Sub Amount Local | decimal(22,2) | Sales Invoice's line sub amount in local currency | |
| 17 | Tax Amount | decimal(22,2) | Sales Invoice's line tax amount | |
| 18 | Tax Amount Local | decimal(22,2) | Sales Invoice's line tax amount in local currency | |
| 19 | Nett Total | decimal(22,2) | Sales Invoice's line net total (sub amount + tax amount) | |
| 20 | Nett Total Local | decimal(22,2) | Sales Invoice's line net total in local currency | |
| 21 | Is Inclusive | smallint(11) | Is Inclusive tax? (Yes[1]/No[0]) | |
| 22 | Tax Name | varchar(255) | Sales Invoice's line tax name | |
| 23 | Tax Rate | decimal(10,4) | Sales Invoice's line tax rate | |
| 24 | Tax Account | varchar(50) | Sales Invoice's line tax account | |
| 25 | MSIC | varchar(30) | Sales Invoice's line MSIC code | |
| 26 | Serial No | text NULL | Sales Invoice's line item's serial number | |
| 27 | Location Name | varchar(50) | Sales Invoice's line item's location name | |
| 28 | Account | varchar(50) [0] | Sales Invoice's line account | |
| 29 | Track 1 | varchar(50) | Sales Invoice's line track 1 | |
| 30 | Track 2 | varchar(50) | Sales Invoice's line track 2 | |
| 31 | Track 3 | varchar(50) | Sales Invoice's line track 3 | |
| 32 | Track 4 | varchar(50) | Sales Invoice's line track 4 | |
| 33 | Track 5 | varchar(50) | Sales Invoice's line track 5 | |
| 34 | Custom Field 1 | varchar(255) | Sales Invoice's line custom field 1 | |
| 35 | Custom Field 2 | varchar(255) | Sales Invoice's line custom field 2 | |
| 36 | Custom Field 3 | varchar(255) | Sales Invoice's line custom field 3 | |
| 37 | From Order | varchar(50) | Sales Invoice's line generate from ID (stock_order table [document_id]) | |
| 38 | From Order Line | varchar(50) | Sales Invoice's line generate from line ID (stock_orderline table [documentline_id]) | |
| 39 | Created | datetime | Sales Invoice line's created date in the system | |
| 40 | Created By | varchar(50) | Sales Invoice line's creator | |
| 41 | Updated | datetime | Sales Invoice line's last updated date | |
| 42 | Updated By | varchar(50) | Sales Invoice line's last updated user | |
| 43 | Is Print | smallint(1) [1] | Sales Invoice's line is avaliable for printing? (yes[1]/no[0]) | |
| 44 | Line Document No | varchar(255) | ||
| 45 | Inventory Debit Account | varchar(50) | Sales Invoice's line item inventory debit account | |
| 46 | Inventory Credit Account | varchar(50) | Sales Invoice's line item inventory credit account | |
| 47 | Tax Updated By | varchar(50) | ||
| 48 | Inventory Cost | decimal(22,2) NULL | Sales Invoice's line inventory cost | |
| 49 | HS Code | varchar(50) | Sales Invoice's line item HS code id | |
| 50 | HS Code Name | varchar(50) | Sales Invoice's line item HS code name |
"status": "OK",
"msg": "OK",
"data": [
{
"Sales Invoice Header": {
"Document ID": "1-1-5363",
"Document No": "SI001",
"Document Type": "SI",
"Document Reference No": "",
"Document Date": "2019-07-15",
"Document Status": "CO",
"Document Prepared By": "admin",
"Document Description": "SIMIT SALES INVOICE",
"Document Note": "",
"Document Reason": "",
"Document GLMemo": "",
"BPartner Name": "SIMIT SDN BHD",
"BPartner Account": "A-001",
"Bill Contact Name": "",
"Bill Conatct HP": "",
"Bill Address": "20, Jalan Ekoperniagaan 2/5, Taman Ekoperniagaan, 81100 Johor Bahru, Johor",
"Ship Address": "20, Jalan Ekoperniagaan 2/5, Taman Ekoperniagaan, 81100 Johor Bahru, Johor",
"Shipping Info": "",
"Ship Contact Name": "",
"Ship Contact HP": "",
"Delivery Method": null,
"Delivery Term": null,
"Total Amount": "150360.00",
"Total Amount Local": "150360.00",
"Total Tax Amount": "0.00",
"Total Tax Amount Local": "0.00",
"Total Nett Amount": "150360.00",
"Total Nett Amount Local": "150360.00",
"Sales Agent": null,
"Terms Name": "30 Days",
"Terms Day": "30",
"Currency Code": "MYR",
"Currency Rate": "1.00000000",
"Track 1": "Foundation Centre",
"Track 1 Value": "008",
"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": "0",
"From Order": null,
"Filling Date": "2019-07-15",
"Filling Date Last Change": "admin",
"IT Sent Date": "0000-00-00",
"IT Type": "",
"IT Remark": "",
"IT Updated": "0000-00-00 00:00:00",
"IT Updated By": "",
"Created": "2019-07-15 21:59:26",
"Created By": "admin",
"Updated": "2019-08-01 21:09:08",
"Updated By": "admin",
"Organization": "SIMIT SDN BHD",
"Branch": "HQ",
"Rounding Account ID": null,
"Rounding Amount": "0.00",
"Outstanding": "150360.00"
},
"Sales Invoice Line Details": [
{
"Document Line ID": "1-1-5363-1563199166053",
"Line Seq No": "10",
"Line Description": "SIMIT SALES INVOICE LINE",
"Line Promise Date": "0000-00-00",
"Item Code": "",
"Item Name": "ITEM 001",
"Quantity": "24.00000000",
"Base Quantity": "24.00000000",
"UOM": "Unit(s)",
"Base UOM": "Unit(s)",
"Unit Price": "6265.0000",
"Unit Price Local": "6265.0000",
"Discount": "",
"Discount Amount": "0.00",
"Sub Amount": "150360.00",
"Sub Amount Local": "150360.00",
"Tax Amount": "0.00",
"Tax Amount Local": "0.00",
"Nett Total": "150360.00",
"Nett Total Local": "150360.00",
"Is Inclusive": "0",
"Tax Name": "",
"Tax Rate": "0.0000",
"Tax Account": "DEFERRED REVENUE",
"MSIC": null,
"Serial No": "",
"Location Name": null,
"Account": "DEFERRED REVENUE",
"Track 1": "Foundation Centre",
"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": "",
"Created": "2019-07-15 21:59:26",
"Created By": "admin",
"Updated": "2019-08-01 21:09:08",
"Updated By": "admin",
"Is Print": "0",
"Line Document No": "",
"Inventory Debit Account": null,
"Inventory Credit Account": null,
"Tax Updated By": "",
"Inventory Cost": "0.00",
"HS Code": "",
"HS Code Name": null
}
]
}
]