X Statements API

This is the API of the X Statement 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/X_Statements_Report url.

Function Input

The following fields are optional. If not posted, the whole account statements 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 until this date will be displayed, according to the "BK Entry Date" field of the entries. The String Mask: YYYY-MM-DD.
Comment Search for the comment string of the statement.
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.
Please note - only one account can be posted in each post.

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.
7 Please fill up all the required fields.

Report Function Output

For regular report that contains data, the following output will be received.
{
 "Title": "X_Statements_Report",
 "TableName": "hyp_Client X Statements",
 "RowCount": "2",
 "Data": [
 {
  "ClientNumber": "500008",
  "CreatedOn": "2016-08-01 14:47:23",
  "Comment": "Receipt: 1609",
  "Status": "3",
  "TargetEMailAddress": "mail@gmail.com",
  "FileExt": "pdf",
  "Index": "1"
 },
 {
  "ClientNumber": "500188",
  "CreatedOn": "2016-08-01 12:35:58",
  "Comment": "Tax Invoice: 1026",
  "Status": "3",
  "TargetEMailAddress": "mail@gmail.com",
  "FileExt": "pdf",
  "Index": "2",
 }
 ]
}

How to Download a File

Use the value of "index" in the following link. Index is an integer number, starting from 1:
DOMAIN/DownloadSignedDoc_json?Index=1.

The server will respond the media file (usually PDF format) immediately, with Http header: Content-Disposition:attachment;

Please note: You can pass a direct link to your rendered html: DOMAIN/DownloadSignedDoc?Index=1.