Journal Report API
This is the API of the Journal Report page. Use http post to pass the fields into the function. Response returned as json string.
In order to use the Registration API, call the DOMAIN/Journal_Report_json url.
Function Input
The following fields are optional. If not posted, the whole account entries will be displayed.
Field Name | Description |
---|---|
From_Date | The entries from this date will be displayed, according to the "BK Entry Date" field of the entries. The String Mask: YYYY-MM-DD. |
Till_Date | The entries untill this date will be displayed, according to the "BK Entry Date" field of the entries. The String Mask: YYYY-MM-DD. |
Description | Search for description string of the entries. |
ForAccount | This field is available for clients with multiple accounts, and allows to choose the account number from Hyper (e.g. 500000 for a client journal). |
For_TP_Login | According to the definition of the "Website Type Purpose" field as CFD Broker (1), in the Main Configuration file, the "TP Login" can be posted. |
Functions Error Messages
Response Code | Message in English |
---|---|
3 | API function does not exists. |
4 | Database Error on server side. |
5 | Technical Error on server side. |
6 | Technical Error: Client Session not found. |
Report Function Output
{
"Title": "Client_Journal_Report",
"TableName": "hyp_Journal",
"RowCount": "3",
"Data": [
{
"EntryID": "17670",
"Description": "Transfer between Accounts",
"BKEntryDate": "2016-06-02",
"ReferenceDocument": "0",
"CashFlowDate": "2016-06-02",
"CreationTime": "2016-06-02 08:52:39",
"Debit": "5000.00",
"Credit": "0.00",
"CalculatedBalance": "-5000.00",
"Currency": "USD"
},
{
"EntryID": "17671",
"Description": "Transfer between Accounts",
"BKEntryDate": "2016-06-02",
"ReferenceDocument": "0",
"CashFlowDate": "2016-06-02",
"CreationTime": "2016-06-02 09:54:00",
"Debit": "5000.00",
"Credit": "0.00",
"CalculatedBalance": "-10000.00",
"Currency": "USD"
},
{
"EntryID": "18092",
"Description": "Dividend on UN stock",
"BKEntryDate": "2016-06-08",
"ReferenceDocument": "0",
"CashFlowDate": "2016-06-08",
"CreationTime": "2016-06-08 12:25:32",
"Debit": "0.00",
"Credit": "800.00",
"CalculatedBalance": "-9200.00",
"Currency": "USD"
}
]
}
"Title": "Client_Journal_Report",
"TableName": "hyp_Journal",
"RowCount": "3",
"Data": [
{
"EntryID": "17670",
"Description": "Transfer between Accounts",
"BKEntryDate": "2016-06-02",
"ReferenceDocument": "0",
"CashFlowDate": "2016-06-02",
"CreationTime": "2016-06-02 08:52:39",
"Debit": "5000.00",
"Credit": "0.00",
"CalculatedBalance": "-5000.00",
"Currency": "USD"
},
{
"EntryID": "17671",
"Description": "Transfer between Accounts",
"BKEntryDate": "2016-06-02",
"ReferenceDocument": "0",
"CashFlowDate": "2016-06-02",
"CreationTime": "2016-06-02 09:54:00",
"Debit": "5000.00",
"Credit": "0.00",
"CalculatedBalance": "-10000.00",
"Currency": "USD"
},
{
"EntryID": "18092",
"Description": "Dividend on UN stock",
"BKEntryDate": "2016-06-08",
"ReferenceDocument": "0",
"CashFlowDate": "2016-06-08",
"CreationTime": "2016-06-08 12:25:32",
"Debit": "0.00",
"Credit": "800.00",
"CalculatedBalance": "-9200.00",
"Currency": "USD"
}
]
}