Skip to content

Get Debtor Credit Note Data

seansimit edited this page Oct 12, 2022 · 5 revisions

GET Debtor Credit Note Data

Using CURL in terminal console to retrieve the Debtor Credit Note data. (* If there is no data in the data column, user may direct remove the column from the get data array.)

curl --header "Content-Type: application/x-www-form-urlencoded" \
--request POST \
--data '
{
        "action":"getDebtorCreditNoteData",
        "module":"sales",
        "token":"simit_5d6c867398a91-75539",
        "uid":"admin",
        "org":"SIMIT",
        "branch":"HQ",
        "data":
        {
                "document_id":"",
                "document_no":"",
                "bpartner_id":"",
                "bpartner_no":"",
                "date_from":"",
                "date_to":"2021-01-01",
                "document_status":"CO"
        }
}
' \
https://simbiz_system_url/simbiz/api.php

The available field for retrieve Debtor Credit Note Data Required field for calling API, least one of the fields regarding the request you are searching for.

No Field Name Data Type (Size) Required Backend ID for the official receipt
1 document_id varchar(50)
2 document_no varchar(255) Document Number
3 bpartner_id varchar(50) Business Partner ID
4 bpartner_no varchar(50) Business Partner No
5 date_from date Debtor Credit Note date from (document_date) (Date format YYYY-MM-DD)
6 date_to date Debtor Credit Note date to (document_date) (Date format YYYY-MM-DD)
7 document_status varchar(30) Document Status (CO = Confirmed, D = Draft, V = Voided, CL = Closed)

Debtor Credit Note Header Data

No Field Name Data Type (Size) Required Description
1 Document No varchar(255) Debtor Credit Note's document number
2 Document Type varchar(10) ARCN
3 Document Reference No varchar(255) Debtor Credit Note's reference number
4 Document Date date Debtor Credit Note's document date
5 Document Status varchar(30) D : Draft; CO : Confirm, V : VOID;
6 Document PreparedBy varchar(50) Debtor Credit Note's prepare user
7 Document Description text Debtor Credit Note's description
8 Document Note text Debtor Credit Note's Note
9 Document Reason varchar(255) Debtor Credit Note's void reason
10 Document GLMemo varchar(255) Debtor Credit Note's GL Memo
11 Cheque No varchar(255) Debtor Credit Note's cheque number
12 Payment Method varchar(50) [] Debtor Credit Note's payment method
13 Cheque Collected Date date Debtor Credit Note's cheque collected date
14 BPartner Name varchar(50) Debtor Credit Note'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) Debtor Credit Note's account ID
18 Accounts Code varchar(50) Debtor Credit Note's account code
19 Accounts Name varchar(200) Debtor Credit Note's account name
20 Bill Contacts Name varchar(255) Debtor Credit Note's bill contact name
21 Bill Contacts HP varchar(255) Debtor Credit Note'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) Debtor Credit Note's shipping contact name
25 Ship Contacts HP varchar(255) Debtor Credit Note's shipping contact handphone number
26 Total Amount decimal(22,2) Debtor Credit Note's total amount
27 Total Amount Local decimal(22,2) Debtor Credit Note's total amount in local currency
28 Total Tax Amount decimal(22,2) Debtor Credit Note's total tax amount
29 Total Tax Amount Local decimal(22,2) Debtor Credit Note's total tax amount in local currency
30 Total Nett Amount decimal(22,2) Debtor Credit Note's total net amount (total amount + tax amount)
31 Total Nett Amount Local decimal(22,2) Debtor Credit Note's total net amount in local currency
32 Sales Agent varchar(255) Debtor Credit Note's sales agent
33 Currency Code varchar(255) Debtor Credit Note's currency code
34 Currency Rate decimal(14,8) Debtor Credit Note's currency rate
35 Track1 varchar(50) Debtor Credit Note's Track 1 ID
36 Track1 Value varchar(200) Debtor Credit Note's Track 1 Name
37 Track2 varchar(50) Debtor Credit Note's Track 2 ID
38 Track2 Value varchar(200) Debtor Credit Note's Track 2 Name
39 Track3 varchar(50) Debtor Credit Note's Track 3 ID
40 Track3 Value varchar(200) Debtor Credit Note's Track 3 Name
41 Track4 varchar(50) Debtor Credit Note's Track 4 ID
42 Track4 Value varchar(200) Debtor Credit Note's Track 4 Name
43 Track5 varchar(50) Debtor Credit Note's Track 5 ID
44 Track5 Value varchar(200) Debtor Credit Note's Track 5 Name
45 Draw ID varchar(50) Signature ID
46 Track Date date Debtor Credit Note's track date
47 Track Type varchar(100) Debtor Credit Note's track type
48 Track Remark text Debtor Credit Note's track remark
49 Track Updated datetime NULL Debtor Credit Note's track last updated date
50 Track Updated_By varchar(50) Debtor Credit Note's track last updated user
51 Is Print int(11) Debtor Credit Note's is allow print out in the print format (yes[1]/no[0])
52 Is OP smallint(1)
53 Is Deposit int(11)
54 Is Refund int(11)
55 Is Knock_Off smallint(1) [0] Is the document knock off (yes[1]/no[0])
56 Knock Off ID varchar(50) NULL Knock off ID (if any)
57 Revision From varchar(50)
58 From Opportunity varchar(50) The Debtor Credit Note is from which opportunity
59 From Invoice varchar(50) Debtor Credit Note's generate from invoice
60 Duty Daily Rate decimal(12,4)
61 Filling Date date Debtor Credit Note's filling Date
62 Filling Date Last Change varchar(50) Debtor Credit Note's filling Date last updated user
63 Created datetime Debtor Credit Note's created date in the system
64 Created By varchar(50) Debtor Credit Note's creator
65 Updated datetime Debtor Credit Note's last updated date
66 Updated By varchar(50) Debtor Credit Note's last updated user
67 Organization int(11) Debtor Credit Note was created under which organization
68 Branch int(11) Debtor Credit Note was created under which branch
69 isautoexchangegainloss smallint(1) is the document using auto exchange gain loss? (yes[1]/no[0])
70 Exchange Gain Loss Account ID varchar(50) Auto exchange gain loss account ID
71 Exchange Gain Loss Tax ID varchar(50) Auto exchange gain loss tax ID
72 BPartner Debtor Account varchar(50) Business Partner's debtor account
73 Rounding Account ID varchar(50) Debtor Credit Note's rounding account ID
74 Rounding Amount decimal(22,2) Debtor Credit Note's rounding amount
75 Is Show All Tax smallint(1) NULL
76 Document Tracking Sent Date date Debtor Credit Note's document tracking's sent date
77 Document Tracking Type varchar(60) Debtor Credit Note's document tracking type
78 Document Tracking Remark text Debtor Credit Note's document tracking remoark
79 Document Tracking Updated datetime Debtor Credit Note's document tracking last update date time
80 Document Tracking Updated By varchar(50) Debtor Credit Note's document tracking last update by
81 Table No varchar(10) Customer's table number (POS)
82 From Branch int(11)
83 Discount varchar(100) Debtor Credit Note's discount rate
84 Overall Discount decimal(22,2) Debtor Credit Note's overall discount
85 Bounce Cheque JE ID varchar(100) Debtor Credit Note's bounce cheque JE's document ID
86 Discount Accounts ID varchar(50) Debtor Credit Note's discount account ID

Debtor Credit Note line data

No Field Name Data Type (Size) Required Description
1 DocumentLine ID varchar(50) Debtor Credit Note's document line ID
2 Documentline Seq smallint(6) Debtor Credit Note's document line sequence number
3 Description text Debtor Credit Note'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 Batch No varchar(255) document line item batch number
31 Lot No varchar(255) document line item lot number
32 Location ID varchar(50) document line item location ID
33 Acc ID varchar(50) [0] document line item account ID
34 Acc Code varchar(100) document line item account code
35 Acc Name varchar(50) document line item account name
36 Bpartner ID varchar(50) [0] document line business partner ID
37 Track1 varchar(50) document line track 1
38 Track2 varchar(50) document line track 2
39 Track3 varchar(50) document line track 3
40 Track4 varchar(50) document line track 4
41 Track5 varchar(50) document line track 5
42 Customfield1 varchar(255) document line custom field 1
43 Customfield2 varchar(255) document line custom field 2
44 Customfield3 varchar(255) document line custom field 3
45 Created datetime document line created date in the system
46 Created By varchar(50) document line creator
47 Updated datetime document line last updated date
48 Updated By varchar(50) document line last updated user
49 Invoice ID varchar(50) document line from invoice ID
50 Order ID varchar(50) document line from order ID
51 BpartnerAccounts ID varchar(50) document line business partner account ID
52 Product ID varchar(50) document line product ID
53 Trans ID varchar(50) document line transaction ID
54 RejectInvoiceline ID varchar(50) Rejected Invoice line ID
55 RejectOrderline ID varchar(50) Rejected Order line ID
56 HeadPaymentLine ID varchar(50) Rejected payment line ID
57 Invoice NO varchar(50) document line invoice number
58 From Oppo Doc Line varchar(50) document line from opening ID
59 Remark int(11) document line remark
60 Syscalgstamt decimal(22,2) System calculate's GST amount
61 From Order ID varchar(255) document line from order ID
62 From Order Line ID varchar(255) document line from order line ID
63 Taxable Amount decimal(22,2) document line taxable amount
64 Tax Updated By varchar(50) document line tax last update by
65 Inventory Debit Acc ID varchar(50) document line inventory debit account ID
66 Inventory Credit Acc ID varchar(50) document line inventory credit account ID
67 Inventory Cost decimal(14,2) NULL document line inventory cost
68 From Staff Claim ID varchar(50) document line generate from which staff claim ID
69 From Staff Claim Line ID varchar(50) document line generate from which staff claim line ID
70 From Branch ID int(11) document line generate from which branch
71 HS Code ID varchar(50) document line item HS code ID
72 HS Code Code varchar(50) document line item HS code Code
73 Promotion ID varchar(50) document line promotion ID (POS)
74 Is Promotion Line smallint(1) is the document line for promotion? (yes[1]/no[0]) (POS)

Debtor Credit Note 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

Sample Data

"status": "OK",
"msg": "OK",
"data": [
       {
            "Header": {
                "Document No": "ARCN-001",
                "Document Type": "ARCN",
                "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": "",
                "Draw ID": "",
                "Track Date": "0000-00-00",
                "Track Type": "",
                "Track Remark": "",
                "Track Updated": "0000-00-00 00:00:00",
                "Track Updated_By": "",
                "Is Print": "0",
                "Is OP": "0",
                "Is Deposit": "0",
                "Is Refund": "0",
                "Is Knock_Off": "0",
                "Knock Off ID": "",
                "Revision From": "",
                "From Opportunity": null,
                "From Invoice": null,
                "Duty Daily Rate": "0.0000",
                "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": null,
                "isautoexchangegainloss": null,
                "Exchange Gain Loss Account ID": "",
                "Exchange Gain Loss Tax ID": "",
                "BPartner Debtor Account": "DEBTOR ACCOUNT",
                "Rounding Account ID": "",
                "Rounding Amount": "0.00",
                "Is Show All Tax": "0",
                "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": "",
                "Discount Accounts 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": "",
                    "Batch No": "",
                    "Lot 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",
                    "Invoice ID": "",
                    "Order ID": "",
                    "BpartnerAccounts ID": "",
                    "Product ID": "",
                    "Trans ID": "",
                    "RejectInvoiceline ID": "",
                    "RejectOrderline ID": "",
                    "HeadPaymentLine ID": "",
                    "Invoice NO": "",
                    "From Oppo Doc Line": "",
                    "Remark": "0",
                    "Syscalgstamt": "0.00",
                    "From Order ID": "",
                    "From Order Line ID": "",
                    "Taxable Amount": "0.00",
                    "Tax Updated By": "",
                    "Inventory Debit Acc ID": "",
                    "Inventory Credit Acc ID": "",
                    "Inventory Cost": "0.00",
                    "From Staff Claim ID": "",
                    "From Staff Claim Line ID": "",
                    "From Branch ID": "",
                    "HS Code ID": "",
                    "HS Code Code": "",
                    "Promotion ID": "",
                    "Is Promotion Line": "0"
                }
            ],
            "KnockOffDetails": []
        }
    ]
}