-
Notifications
You must be signed in to change notification settings - Fork 2
Get Data Documentation Official Receipt
seansimit edited this page Oct 12, 2022
·
21 revisions
Using CURL in terminal console to retrieve the Official Receipt 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":"getOfficialReceiptData",
"module":"accounting",
"token":"yourtoken",
"uid":"admin",
"org":"SIMIT",
"branch":"HQ",
"data":
{
"document_id":"",
"document_no":"RC-001",
"bpartner_id":"",
"bpartner_no":"",
"date_from":"",
"date_to":"",
"document_status":"CO"
}
}
' \
https://simbiz_system_url/simbiz/api.php
The available field for retrieve Official Receipt Data Required field for calling API
| No | Field Name | Data Type (Size) | Required | Description |
|---|---|---|---|---|
| 1 | document_id | varchar(50) | Y | Backend ID for the official receipt (* 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 | Official Receipt date from (Document Date) (Date format YYYY-MM-DD) | |
| 6 | date_to | date | Official Receipt date to (Document Data) (Date format YYYY-MM-DD) | |
| 7 | show_knockoffinvoice | smallint(1) | Show the KnockOff Invoice Details. The return data can refer here. | |
| 8 | document_status | varchar(30) | Document Status (CO = Confirmed, D = Draft, V = Voided, CL = Closed) |
Official Receipt Header Data
| No | Field Name | Data Type (Size) | Required | Description |
|---|---|---|---|---|
| 1 | Document No | varchar(255) | Official Receipt's document number | |
| 2 | Document Type | varchar(10) | RC (Official Receipt) | |
| 3 | Document Reference No | varchar(255) | Official Receipt's reference number | |
| 4 | Document Date | date | Official Receipt's document date | |
| 5 | Document Status | varchar(30) | D : Draft; CO : Confirmed; V : Voided. | |
| 6 | Document PreparedBy | varchar(50) | Official Receipt's prepare user | |
| 7 | Document Description | text | Official Receipt's description | |
| 8 | Document Note | text | Official Receipt's Note | |
| 9 | Document Reason | varchar(255) | Official Receipt's void reason | |
| 10 | Document GLMemo | varchar(255) | Official Receipt's GL Memo | |
| 11 | Cheque No | varchar(255) | Official Receipt's cheque number | |
| 12 | Payment Method | varchar(50) [] | Official Receipt's payment method | |
| 13 | Cheque Collected Date | date | Official Receipt's cheque collected date | |
| 14 | BPartner Name | varchar(50) | Official Receipt's business partner name | |
| 15 | Payee Type | varchar(50) | Business Partner (bpartner) or others (others) | |
| 16 | Paid From To | varchar(255) | Paid to customer name (others) | |
| 17 | Accounts ID | varchar(50) | Official Receipt's account ID | |
| 18 | Accounts Code | varchar(50) | Official Receipt's account code | |
| 19 | Accounts Name | varchar(200) | Official Receipt's account name | |
| 20 | Bill Contacts Name | varchar(255) | Official Receipt's bill contact name | |
| 21 | Bill Contacts HP | varchar(255) | Official Receipt's bill contact handphone number | |
| 22 | Bill Address | Combination of all the bill contact address data | ||
| 23 | Ship Address | Combination of all the ship contact address data | ||
| 24 | Ship Contacts Name | varchar(255) | Official Receipt's shipping contact name | |
| 25 | Ship Contacts HP | varchar(255) | Official Receipt's shipping contact handphone number | |
| 26 | Total Amount | decimal(22,2) | Official Receipt's total amount | |
| 27 | Total Amount Local | decimal(22,2) | Official Receipt's total amount in local currency | |
| 28 | Total Tax Amount | decimal(22,2) | Official Receipt's total tax amount | |
| 29 | Total Tax Amount Local | decimal(22,2) | Official Receipt's total tax amount in local currency | |
| 30 | Total Nett Amount | decimal(22,2) | Official Receipt's total net amount (total amount + tax amount) | |
| 31 | Total Nett Amount Local | decimal(22,2) | Official Receipt's total net amount in local currency | |
| 32 | Sales Agent | varchar(255) | Official Receipt's sales agent | |
| 33 | Currency Code | varchar(255) | Official Receipt's currency code | |
| 34 | Currency Rate | decimal(14,8) | Official Receipt's currency rate | |
| 35 | Track1 | varchar(50) | Official Receipt's Track 1 ID | |
| 36 | Track1 Value | varchar(200) | Official Receipt's Track 1 Name | |
| 37 | Track2 | varchar(50) | Official Receipt's Track 2 ID | |
| 38 | Track2 Value | varchar(200) | Official Receipt's Track 2 Name | |
| 39 | Track3 | varchar(50) | Official Receipt's Track 3 ID | |
| 40 | Track3 Value | varchar(200) | Official Receipt's Track 3 Name | |
| 41 | Track4 | varchar(50) | Official Receipt's Track 4 ID | |
| 42 | Track4 Value | varchar(200) | Official Receipt's Track 4 Name | |
| 43 | Track5 | varchar(50) | Official Receipt's Track 5 ID | |
| 44 | Track5 Value | varchar(200) | Official Receipt's Track 5 Name | |
| 45 | Is Print | int(11) | Official Receipt's is allow print out in the print format (yes[1]/no[0]) | |
| 46 | From Opportunity | varchar(50) | The official receipt is from which opportunity | |
| 47 | From Invoice | varchar(50) | Official Receipt's generate from invoice | |
| 48 | Filling Date | date | Official Receipt's filling Date | |
| 49 | Filling Date Last Change | varchar(50) | Official Receipt's filling Date last updated user | |
| 50 | Created | datetime | Official Receipt's created date in the system | |
| 51 | Created By | varchar(50) | Official Receipt's creator | |
| 52 | Updated | datetime | Official Receipt's last updated date | |
| 53 | Updated By | varchar(50) | Official Receipt's last updated user | |
| 54 | Organization | varchar(200) | Official Receipt was created under which organization | |
| 55 | Branch | varchar(200) | Official Receipt was created under which branch | |
| 56 | isautoexchangegainloss | smallint(1) | is the document using auto exchange gain loss? (yes[1]/no[0]) | |
| 57 | Exchange Gain Loss Account ID | varchar(50) | Auto exchange gain loss account ID | |
| 58 | Exchange Gain Loss Tax ID | varchar(50) | Auto exchange gain loss tax ID | |
| 59 | BPartner Debtor Account | varchar(50) | Business Partner's debtor account | |
| 60 | Rounding Account ID | varchar(50) | Official Receipt's rounding account ID | |
| 61 | Rounding Amount | decimal(22,2) | Official Receipt's rounding amount | |
| 62 | Document Tracking Sent Date | date | Official Receipt's document tracking's sent date | |
| 63 | Document Tracking Type | varchar(60) | Official Receipt's document tracking type | |
| 64 | Document Tracking Remark | text | Official Receipt's document tracking remoark | |
| 65 | Document Tracking Updated | datetime | Official Receipt's document tracking last update date time | |
| 66 | Document Tracking Updated By | varchar(50) | Official Receipt's document tracking last update by | |
| 67 | Table No | varchar(10) | Customer's table number (POS) | |
| 68 | From Branch | int(11) | ||
| 69 | Discount | varchar(100) | Official Receipt's discount rate | |
| 70 | Overall Discount | decimal(22,2) | Official Receipt's overall discount | |
| 71 | Bounce Cheque JE ID | varchar(100) | Official Receipt's bounce cheque JE's document ID |
Official Receipt line data
| No | Field Name | Data Type (Size) | Required | Description |
|---|---|---|---|---|
| 1 | DocumentLine ID | varchar(50) | Y | Official Receipt's document line ID |
| 2 | Documentline Seq | smallint(6) | Official Receipt's document line sequence number | |
| 3 | Description | text | Official Receipt's document line description | |
| 4 | Credit Reason | text | ||
| 5 | Item Id | varchar(50) | document line item ID | |
| 6 | Item Code | varchar(255) | document line item code | |
| 7 | Item Name | varchar(255) | document line item name | |
| 8 | Quantity | decimal(28,8) | document line item quantity | |
| 9 | Base Quantity | decimal(28,8) | document line item base quantity | |
| 10 | Unit Price | decimal(24,4) | document line item unit price | |
| 11 | Unit Price Local | decimal(24,4) | document line item unit price in local currency | |
| 12 | Discount | varchar(255) | document line item discount rate | |
| 13 | Discount Amount | decimal(24,2) | document line item discount amount | |
| 14 | Amount Sub | decimal(22,2) | document line sub amount | |
| 15 | Amount Sub Local | decimal(22,2) | document line sub amount in local currency | |
| 16 | Amount Tax | decimal(22,2) | document line tax amount | |
| 17 | Amount Tax Local | decimal(22,2) | document line tax amount in local currency | |
| 18 | Amount Netttotal | decimal(22,2) | document line net total amount | |
| 19 | Amount Netttotal Local | decimal(22,2) | document line net total amount in local currency | |
| 20 | Is Inclusive | int(1) | is the item inclusive tax (yes[1]/no[0]) | |
| 21 | Tax ID | varchar(50) | document line item tax ID | |
| 22 | Tax Name | varchar(255) | document line item tax name | |
| 23 | Tax Rate | decimal(10,4) | document line item tax rate | |
| 24 | Tax Acc ID | varchar(50) | document line item tax account Id | |
| 25 | Tax Acc Code | varchar(100) | document line item tax code | |
| 26 | Tax Acc Name | varchar(50) | document line item tax name | |
| 27 | Msic ID | varchar(50) | document line item MSIC ID | |
| 28 | Msic Code | varchar(30) | document line item MSIC code | |
| 29 | Serial No | text | document line item serial number | |
| 30 | Location ID | varchar(50) | document line item location ID | |
| 31 | Acc ID | varchar(50) [0] | document line item account ID | |
| 32 | Acc Code | varchar(100) | document line item account code | |
| 33 | Acc Name | varchar(50) | document line item account name | |
| 34 | Bpartner ID | varchar(50) [0] | document line business partner ID | |
| 35 | Track1 | varchar(50) | document line track 1 | |
| 36 | Track2 | varchar(50) | document line track 2 | |
| 37 | Track3 | varchar(50) | document line track 3 | |
| 38 | Track4 | varchar(50) | document line track 4 | |
| 39 | Track5 | varchar(50) | document line track 5 | |
| 40 | Customfield1 | varchar(255) | document line custom field 1 | |
| 41 | Customfield2 | varchar(255) | document line custom field 2 | |
| 42 | Customfield3 | varchar(255) | document line custom field 3 | |
| 43 | Created | datetime | document line created date in the system | |
| 44 | Created By | varchar(50) | document line creator | |
| 45 | Updated | datetime | document line last updated date | |
| 46 | Updated By | varchar(50) | document line last updated user | |
| 47 | BpartnerAccounts ID | varchar(50) | document line business partner account ID | |
| 48 | Remark | int(11) | document line remark | |
| 49 | Inventory Cost | decimal(14,2) NULL | document line inventory cost | |
| 50 | HS Code ID | varchar(50) | document line item HS code ID | |
| 51 | HS Code Code | varchar(50) | document line item HS code Code | |
| 52 | Promotion ID | varchar(50) | document line promotion ID (POS) | |
| 53 | Is Promotion Line | smallint(1) | is the document line for promotion? (yes[1]/no[0]) (POS) |
Official Receipt line knock off data
| No | Field Name | Data Type (Size) | Required | Description |
|---|---|---|---|---|
| 1 | Paymentline Knockoff ID | varchar(255) | Payment Knockoff document ID | |
| 2 | Paymentline ID | varchar(255) | Knock off to payment's line ID | |
| 3 | Knock Doc Type | varchar(255) | Knock off to which document type | |
| 4 | Knock Doc ID | varchar(255) | Knock off to which document ID | |
| 5 | Knock Doc No | varchar(50) | Knock off to which document Number | |
| 6 | Knock Amt | decimal(14,2) | Knock off's amount | |
| 7 | Knock Amt Local | decimal(14,2) | Knock off's amount in local currency | |
| 8 | Description | text | Knock offs' description | |
| 9 | Created | datetime | Knock off's created date in the system | |
| 10 | Created By | varchar(255) | Knock off's creator | |
| 11 | Updated | datetime | Knock off's last updated date | |
| 12 | Updated By | varchar(255) | Knock off's last updated user | |
| 13 | Exchange Gain Loss Amount | decimal(22,2) | Knock off's exchange gain loss amount | |
| 14 | Track1 | varchar(50) NULL | Knock off's Track 1 ID | |
| 15 | Track1 Value | varchar(200) | Knock off's Track 1 Name | |
| 16 | Track2 | varchar(50) NULL | Knock off's Track 2 ID | |
| 17 | Track2 Value | varchar(200) | Knock off's Track 2 Name | |
| 18 | Track3 | varchar(50) NULL | Knock off's Track 3 ID | |
| 19 | Track3 Value | varchar(200) | Knock off's Track 3 Name | |
| 20 | Track4 | varchar(50) NULL | Knock off's Track 4 ID | |
| 21 | Track4 Value | varchar(200) | Knock off's Track 4 Name | |
| 22 | Track5 | varchar(50) NULL | Knock off's Track 5 ID | |
| 23 | Track5 Value | varchar(200) | Knock off's Track 5 Name |
**Official Receipt knock off Invoice Header and Line Data please refer here **
"status": "OK",
"msg": "OK",
"data": [
{
"Header": {
"Document No": "RC-001",
"Document Type": "RC",
"Document Reference No": "",
"Document Date": "2019-01-31",
"Document Status": "CO",
"Document PreparedBy": "admin",
"Document Description": "",
"Document Note": "",
"Document Reason": "",
"Document GLMemo": "",
"Cheque No": "",
"Payment Method": "IBG",
"Cheque Collected Date": "0000-00-00",
"BPartner Name": "SIMIT SDN BHD",
"Payee Type": "bpartner",
"Paid From To": "",
"Accounts ID": "1-1-443",
"Accounts Code": "3005-002",
"Accounts Name": "RHB BANK-03584",
"Bill Contacts Name": "",
"Bill Contacts HP": "",
"Bill Address": "",
"Ship Address": "",
"Ship Contacts Name": "",
"Ship Contacts HP": "",
"Total Amount": "360.00",
"Total Amount Local": "360.00",
"Total Tax Amount": "0.00",
"Total Tax Amount Local": "0.00",
"Total Nett Amount": "360.00",
"Total Nett Amount Local": "360.00",
"Sales Agent": "",
"Currency Code": "MYR",
"Currency Rate": "1.00000000",
"Track1": "",
"Track1 Value": "005",
"Track2": "",
"Track2 Value": "",
"Track3": "",
"Track3 Value": "",
"Track4": "",
"Track4 Value": "",
"Track5": "",
"Track5 Value": "",
"Is Print": "0",
"From Opportunity": null,
"From Invoice": null,
"Filling Date": "0.0000",
"Filling Date Last Change": "",
"Created": "2019-05-15 14:20:20",
"Created By": "admin",
"Updated": "2019-05-30 12:50:37",
"Updated By": "admin",
"Organization": "SIMIT SDN BHD",
"Branch": "HQ",
"isautoexchangegainloss": null,
"Exchange Gain Loss Account ID": "",
"Exchange Gain Loss Tax ID": "",
"BPartner Debtor Account": "DEBTOR ACCOUNT",
"Rounding Account ID": "",
"Rounding Amount": "0.00",
"Document Tracking Sent Date": null,
"Document Tracking Type": null,
"Document Tracking Remark": null,
"Document Tracking Updated": null,
"Document Tracking Updated By": null,
"Table No": "",
"From Branch": null,
"Discount": "0",
"Overall Discount": "0.00",
"Bounce Cheque JE ID": "",
},
"LineDetail": [
{
"DocumentLine ID": "1-1-7824-1557901220408",
"Documentline Seq": "0",
"Description": "",
"Credit Reason": "",
"Item Id": "1-1-208",
"Item Code": "A0001",
"Item Name": "ITEM A",
"Quantity": "1.00000000",
"Base Quantity": "1.00000000",
"Unit Price": "360.0000",
"Unit Price Local": "360.0000",
"Discount": "0",
"Discount Amount": "0.00",
"Amount Sub": "360.00",
"Amount Sub Local": "360.00",
"Amount Tax": "0.00",
"Amount Tax Local": "0.00",
"Amount Netttotal": "360.00",
"Amount Netttotal Local": "360.00",
"Is Inclusive": "0",
"Tax ID": "",
"Tax Name": "",
"Tax Rate": "0.0000",
"Tax Acc ID": "",
"Tax Acc Code": null,
"Tax Acc Name": null,
"Msic ID": "",
"Msic Code": "",
"Serial No": "",
"Location ID": "0-0-0",
"Acc ID": "1-1-529",
"Acc Code": "7006\/005",
"Acc Name": "ACCOUNT A",
"Bpartner ID": "",
"Track1": "1-1-10",
"Track2": "",
"Track3": "",
"Track4": "",
"Track5": "",
"Customfield1": "",
"Customfield2": "",
"Customfield3": "",
"Created": "2019-05-15 14:20:20",
"Created By": "admin",
"Updated": "2019-05-30 12:50:37",
"Updated By": "admin",
"BpartnerAccounts ID": "",
"Remark": "0",
"Tax Updated By": "",
"Inventory Cost": "0.00",
"HS Code ID": "",
"HS Code Code": "",
"Promotion ID": "",
"Is Promotion Line": "0"
}
],
"KnockOffDetails": [
"Paymentline Knockoff ID": "1-1-2488",
"Paymentline ID": "1-1-7824-0",
"Knock Doc Type": "SI",
"Knock Doc ID": "1-1-335",
"Knock Doc No": "TEST 00005",
"Knock Amt": "360.00",
"Knock Amt Local": "360.00",
"Description": "",
"Created": "2022-04-25 15:28:11",
"Created By": "admin",
"Updated": "2022-04-25 15:28:11",
"Updated By": "admin",
"Exchange Gain Loss Amount": "0.00",
"Track1": "",
"Track1 Value": "",
"Track2": "",
"Track2 Value": "",
"Track3": "",
"Track3 Value": "",
"Track4": "",
"Track4 Value": "",
"Track5": "",
"Track5 Value": ""
"KnockOffInvoiceHeader":[
"Document ID": "1-1-335",
"Document No": "TEST 00005",
"Document Type": "SI",
"Document Reference No": "",
"Document Date": "2022-04-25",
"Document Status": "CO",
"Document Prepared By": "admin",
"Document Description": "",
"Document Note": "",
"Document Reason": "",
"Document GLMemo": "",
"BPartner No": "B-001",
"BPartner Name": "Simit",
"BPartner Account": "Trade Debtors",
"Bill Contact Name": "",
"Bill Conatct HP": "",
"Bill Address": "",
"Ship Address": "",
"Shipping Info": "",
"Ship Contact Name": "",
"Ship Contact HP": "",
"Delivery Method": "",
"Delivery Term": "",
"Total Amount": "360.00",
"Total Amount Local": "360.00",
"Total Tax Amount": "0.00",
"Total Tax Amount Local": "0.00",
"Total Nett Amount": "360.00",
"Total Nett Amount Local": "360.00",
"Sales Agent": "",
"Terms Name": "",
"Terms Day": "0",
"Currency Code": "MYR",
"Currency Rate": "1.00000000",
"Track 1": "",
"Track 1 Value": "",
"Track 2": "",
"Track 2 Value": "",
"Track 3": "",
"Track 3 Value": "",
"Track 4": "",
"Track 4 Value": "",
"Track 5": "",
"Track 5 Value": "",
"Is Print": "0",
"From Order": "",
"Filling Date": "2022-04-25",
"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": "2022-04-25 10:58:29",
"Created By": "admin",
"Updated": "2022-04-25 10:58:29",
"Updated By": "admin",
"Organization": "SIMIT SDN BHD",
"Branch": "HQ",
"Rounding Account ID":"",
"Rounding Amount": "0.00",
"Outstanding": "0.00"
],
"KnockOffInvoiceLine":[
"Document Line ID": "1-1-335-1650855492680",
"Line Seq No": "10",
"Line Description": "",
"Line Promise Date": "0000-00-00",
"Item Code": "001",
"Item Name": "earphone",
"Quantity": "1.00000000",
"Base Quantity": "1.00000000",
"UOM": "Unit(s)",
"Base UOM": "Unit(s)",
"Unit Price": "360.000000",
"Unit Price Local": "360.000000",
"Discount": "",
"Discount Amount": "0.00",
"Sub Amount": "360.00",
"Sub Amount Local": "360.00",
"Tax Amount": "0.00",
"Tax Amount Local": "0.00",
"Nett Total": "360.00",
"Nett Total Local": "360.00",
"Is Inclusive": "0",
"Tax Name": "",
"Tax Rate": "0.0000",
"Tax Account": "Cash Sales",
"MSIC": "",
"Serial No": "",
"Location Name": "Default",
"Account": "Cash Sales",
"Track 1": "",
"Track 2": "",
"Track 3": "",
"Track 4": "",
"Track 5": "",
"Custom Field 1": "",
"Custom Field 2": "",
"Custom Field 3": "",
"From Order": "",
"From Order Line": "",
"Created": "2022-04-25 10:58:29",
"Created By": "admin",
"Updated": "2022-04-25 10:58:29",
"Updated By": "admin",
"Is Print": "0",
"Line Document No": "",
"Inventory Debit Account": "",
"Inventory Credit Account": "",
"Tax Updated By": "",
"Inventory Cost": "0.00",
"HS Code": "",
"HS Code Name": ""
]
]
}
]
}