-
Notifications
You must be signed in to change notification settings - Fork 2
Get Data Documentation Payment Voucher
syazanisimit edited this page Jun 13, 2025
·
1 revision
Using CURL in terminal console to retrieve the Payment Voucher 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":"getPaymentVoucherData",
"module":"accounting",
"token":"yourtoken",
"uid":"admin",
"org":"SIMIT",
"branch":"HQ",
"data":
{
"document_id":"",
"document_no":"PV-001",
"bpartner_id":"",
"bpartner_no":"",
"date_from":"",
"date_to":"",
"document_status":"CO"
}
}
' \
https://simbiz_system_url/simbiz/api.php
The available field for retrieve Payment Voucher Data Required field for calling API
| No | Field Name | Data Type (Size) | Required | Description |
|---|---|---|---|---|
| 1 | document_id | varchar(50) | Y | Backend ID for the payment voucher (* 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 | Payment Voucher date from (Document Date) (Date format YYYY-MM-DD) | |
| 6 | date_to | date | Payment Voucher 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) |
Payment Voucher Header Data
| No | Field Name | Data Type (Size) | Required | Description |
|---|---|---|---|---|
| 1 | Document No | varchar(255) | Payment Voucher's document number | |
| 2 | Document Type | varchar(10) | PV (Payment Voucher) | |
| 3 | Document Reference No | varchar(255) | Payment Voucher's reference number | |
| 4 | Document Date | date | Payment Voucher's document date | |
| 5 | Document Status | varchar(30) | D : Draft; CO : Confirmed; V : Voided. | |
| 6 | Document PreparedBy | varchar(50) | Payment Voucher's prepare user | |
| 7 | Document Description | text | Payment Voucher's description | |
| 8 | Document Note | text | Payment Voucher's Note | |
| 9 | Document Reason | varchar(255) | Payment Voucher's void reason | |
| 10 | Cheque No | varchar(255) | Payment Voucher's cheque number | |
| 11 | Payment Method | varchar(50) [] | Payment Voucher's payment method | |
| 12 | Tax Filing Date | date | Payment Voucher's tax filing date | |
| 13 | Is Refund | int(11) | Payment Voucher's is allow print out in the print format (yes[1]/no[0]) | |
| 14 | BPartner Name | varchar(50) | Payment Voucher'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) | Payment Voucher's account ID | |
| 18 | Accounts Code | varchar(50) | Payment Voucher's account code | |
| 19 | Accounts Name | varchar(200) | Payment Voucher's account name | |
| 20 | Bill Contacts Name | varchar(255) | Payment Voucher's bill contact name | |
| 21 | Bill Contacts HP | varchar(255) | Payment Voucher'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) | Payment Voucher's shipping contact name | |
| 25 | Ship Contacts HP | varchar(255) | Payment Voucher's shipping contact handphone number | |
| 26 | Total Amount | decimal(22,2) | Payment Voucher's total amount | |
| 27 | Total Amount Local | decimal(22,2) | Payment Voucher's total amount in local currency | |
| 28 | Total Tax Amount | decimal(22,2) | Payment Voucher's total tax amount | |
| 29 | Total Tax Amount Local | decimal(22,2) | Payment Voucher's total tax amount in local currency | |
| 30 | Total Nett Amount | decimal(22,2) | Payment Voucher's total net amount (total amount + tax amount) | |
| 31 | Total Nett Amount Local | decimal(22,2) | Payment Voucher's total net amount in local currency | |
| 32 | Sales Agent | varchar(255) | Payment Voucher's sales agent | |
| 33 | Currency Code | varchar(255) | Payment Voucher's currency code | |
| 34 | Currency Rate | decimal(14,8) | Payment Voucher's currency rate | |
| 35 | Track1 | varchar(50) | Payment Voucher's Track 1 ID | |
| 36 | Track1 Value | varchar(200) | Payment Voucher's Track 1 Name | |
| 37 | Track2 | varchar(50) | Payment Voucher's Track 2 ID | |
| 38 | Track2 Value | varchar(200) | Payment Voucher's Track 2 Name | |
| 39 | Track3 | varchar(50) | Payment Voucher's Track 3 ID | |
| 40 | Track3 Value | varchar(200) | Payment Voucher's Track 3 Name | |
| 41 | Track4 | varchar(50) | Payment Voucher's Track 4 ID | |
| 42 | Track4 Value | varchar(200) | Payment Voucher's Track 4 Name | |
| 43 | Track5 | varchar(50) | Payment Voucher's Track 5 ID | |
| 44 | Track5 Value | varchar(200) | Payment Voucher's Track 5 Name | |
| 45 | Is Print | int(11) | Payment Voucher's is allow print out in the print format (yes[1]/no[0]) | |
| 46 | From Opportunity | varchar(50) | The payment voucher is from which opportunity | |
| 47 | From Invoice | varchar(50) | Payment Voucher's generate from invoice | |
| 48 | Filling Date Last Change | varchar(50) | Payment Voucher's filling Date last updated user | |
| 49 | Created | datetime | Payment Voucher's created date in the system | |
| 50 | Created By | varchar(50) | Payment Voucher's creator | |
| 51 | Updated | datetime | Payment Voucher's last updated date | |
| 52 | Updated By | varchar(50) | Payment Voucher's last updated user | |
| 53 | Organization | varchar(200) | Payment Voucher was created under which organization | |
| 54 | Branch | varchar(200) | Payment Voucher was created under which branch | |
| 55 | isautoexchangegainloss | smallint(1) | is the document using auto exchange gain loss? (yes[1]/no[0]) | |
| 56 | Exchange Gain Loss Account ID | varchar(50) | Auto exchange gain loss account ID | |
| 57 | Exchange Gain Loss Tax ID | varchar(50) | Auto exchange gain loss tax ID | |
| 58 | BPartner Debtor Account | varchar(50) | Business Partner's debtor account | |
| 59 | Rounding Account ID | varchar(50) | Payment Voucher's rounding account ID | |
| 60 | Rounding Amount | decimal(22,2) | Payment Voucher's rounding amount | |
| 61 | Document Tracking Sent Date | date | Payment Voucher's document tracking's sent date | |
| 62 | Document Tracking Type | varchar(60) | Payment Voucher's document tracking type | |
| 63 | Document Tracking Remark | text | Payment Voucher's document tracking remoark | |
| 64 | Document Tracking Updated | datetime | Payment Voucher's document tracking last update date time | |
| 65 | Document Tracking Updated By | varchar(50) | Payment Voucher's document tracking last update by | |
| 66 | Table No | varchar(10) | Customer's table number (POS) | |
| 67 | From Branch | int(11) | ||
| 68 | Discount | varchar(100) | Payment Voucher's discount rate | |
| 69 | Overall Discount | decimal(22,2) | Payment Voucher's overall discount | |
| 70 | Bounce Cheque JE ID | varchar(100) | Payment Voucher's bounce cheque JE's document ID |
Payment Voucher line data
| No | Field Name | Data Type (Size) | Required | Description |
|---|---|---|---|---|
| 1 | DocumentLine ID | varchar(50) | Y | Payment Voucher's document line ID |
| 2 | Documentline Seq | smallint(6) | Payment Voucher's document line sequence number | |
| 3 | Description | text | Payment Voucher'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) |
Payment Voucher 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 |
**Payment Voucher knock off Invoice Header and Line Data please refer here **
"status": "OK",
"msg": "OK",
"data": [
{
"Header": {
"Document No": "API-PV-00018",
"Document Type": "PV",
"Document Reference No": "API_DOC_TEST",
"Document Date": "2025-05-22",
"Document Status": "CO",
"Document PreparedBy": "admin",
"Document Description": "DOCUMENT CREATED FROM API",
"Document Note": "ADDITIONAL NOTE",
"Document Reason": "",
"ss": "ADDITIONAL GLMEMO",
"Cheque No": "00001",
"Payment Method": "Cash",
"Tax Filing Date": "2025-05-22",
"Is Refund": "1",
"BPartner Name": "Bpartner A",
"Payee Type": "bpartner",
"Paid From To": "",
"Accounts ID": "1-1-275",
"Accounts Code": "11-10000",
"Accounts Name": "Test Acc",
"Bill Contacts Name": "",
"Bill Contacts HP": "",
"Bill Address": "",
"Ship Address": "",
"Ship Contacts Name": "",
"Ship Contacts HP": "",
"Total Amount": "110.80",
"Total Amount Local": "110.80",
"Total Tax Amount": "0.00",
"Total Tax Amount Local": "0.00",
"Total Nett Amount": "110.80",
"Total Nett Amount Local": "110.80",
"Sales Agent": "Chwe",
"Currency Code": "MYR",
"Currency Rate": "1.00000000",
"Track1": "",
"Track1 Value": "",
"Track2": "",
"Track2 Value": "",
"Track3": "",
"Track3 Value": "",
"Track4": "",
"Track4 Value": "",
"Track5": "",
"Track5 Value": "",
"Is Print": "0",
"From Opportunity": null,
"From Invoice": null,
"Filling Date Last Change": "admin",
"Created": "2025-05-22 12:04:36",
"Created By": "admin",
"Updated": "2025-06-12 12:07:38",
"Updated By": "admin",
"Organization": "Organization A",
"Branch": null,
"isautoexchangegainloss": null,
"Exchange Gain Loss Account ID": "",
"Exchange Gain Loss Tax ID": "",
"BPartner Debtor Account": "Trade Creditors",
"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": "",
"Overall Discount": "0.00",
"Bounce Cheque JE ID": ""
},
"LineDetail": [
{
"DocumentLine ID": "1-1-2676-0",
"Documentline Seq": "10",
"Description": "",
"Credit Reason": "",
"Item Id": "1-10-3",
"Item Code": "DRINK001",
"Item Name": "Kopi O Kosong",
"Quantity": "1.00000000",
"Base Quantity": "1.00000000",
"Unit Price": "100.000000",
"Unit Price Local": "100.000000",
"Discount": "",
"Discount Amount": "0.00",
"Amount Sub": "100.00",
"Amount Sub Local": "100.00",
"Amount Tax": "0.00",
"Amount Tax Local": "0.00",
"Amount Netttotal": "100.00",
"Amount Netttotal Local": "100.00",
"Is Inclusive": "0",
"Tax ID": "",
"Tax Name": "",
"Tax Rate": "0.0000",
"Tax Acc ID": "",
"Tax Acc Code": null,
"Tax Acc Name": null,
"Acc ID": "1-1-37",
"Acc Code": "51-0010",
"Acc Name": "Purchases",
"Inventory Cost": "100.00",
"Remark": "0"
},
{
"DocumentLine ID": "1-1-2676-1749701258988",
"Documentline Seq": "0",
"Item Name": "Knock Off",
"Quantity": "0.00000000",
"Base Quantity": "0.00000000",
"Unit Price": "0.000000",
"Unit Price Local": "0.000000",
"Amount Sub": "10.80",
"Amount Sub Local": "10.80",
"Amount Netttotal": "10.80",
"Amount Netttotal Local": "10.80",
"Acc ID": "1-1-18",
"Acc Code": "21-1000A",
"Acc Name": "Trade Creditors",
"Bpartner ID": "1-1-458",
"Remark": "0"
}
],
"KnockOffDetails": [
{
"Paymentline Knockoff ID": "1-1-874-0",
"Paymentline ID": "1-1-2676-1749701258988",
"Knock Doc Type": "PI",
"Knock Doc ID": "1-1-3633",
"Knock Doc No": "PI 00180",
"Knock Amt": "10.80",
"Knock Amt Local": "10.80",
"Created": "2025-06-12 12:14:59",
"Created By": "admin",
"Updated": "2025-06-12 12:14:59",
"Updated By": "admin",
"KnockOffInvoiceHeader": [
{
"Document ID": "1-1-3633",
"Document No": "PI 00180",
"Document Type": "PI",
"Document Reference No": "7189472142",
"Document Date": "2025-06-09",
"Document Status": "CO",
"Document Prepared By": "admin",
"BPartner Name": "Bpartner A",
"BPartner Account": "Trade Creditors",
"Bill Contact Name": "",
"Bill Conatct HP": "",
"Bill Address": "",
"Ship Address": "",
"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",
"Currency Code": "MYR",
"Currency Rate": "1.00000000",
"Outstanding": "0.00"
}
],
"KnockOffInvoiceLine": [
{
"Document Line ID": "1-1-3633-1749439470764",
"Line Seq No": "10",
"Item Code": "DRINK002",
"Item Name": "Kopi O 9",
"Quantity": "1.00000000",
"Unit Price": "10.000000",
"Unit Price Local": "10.000000",
"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",
"Tax Name": "IM (Import) 2",
"Tax Rate": "8.0000",
"Account": "Purchases",
"Inventory Cost": "10.00",
"Landed Cost": "10.00"
}
]
}
]
}
]