Get Cash Statement
GET/v1.1/statement/cash
This is used to get the cash statement for a given cash account of a given customer. This includes details about all the cash transactions that happened during the given period on a given cash account.
Request
Query Parameters
Possible values: >= 1
and <= 12
if current year is given, month must be current month or a previous month
only accepts current year or a previous year
Example: 2022
Possible values: <= 20 characters
Possible values: <= 50 characters
Security account number
Possible values: <= 50 characters
Cash account number
currently only accepts json format
Example: json
Responses
- 200
- 401
OK
- application/json
- Schema
- Example (from schema)
- JSON
Schema
- Array [
- Array [
- ]
- ]
Find error codes here
list object[]
list object[]
Possible values: Value must match regular expression ^[0-9]{4}/(0[1-9]|1[0-2])/(0[1-9]|[1-2][0-9]|3[0-1])$
Possible values: Value must match regular expression ^[0-9]{4}/(0[1-9]|1[0-2])/(0[1-9]|[1-2][0-9]|3[0-1])$
{
"status": "string",
"reason": "string",
"rejectCode": 0,
"customerNumber": "string",
"month": 0,
"year": 0,
"period": "string",
"list": [
{
"cashAccountNumber": "string",
"currency": "string",
"tradeOpeningBalance": 0,
"settledOpeningBalance": 0,
"deposit": 0,
"withdraw": 0,
"buy": 0,
"sell": 0,
"futureBlock": 0,
"other": 0,
"tradeClosingBalance": 0,
"settledClosingBalance": 0,
"list": [
{
"transactionDate": "string",
"valueDate": "string",
"description": "string",
"debit": 0,
"credit": 0,
"tradeBalance": 0,
"settledBalance": 0
}
]
}
]
}
{
"status": "SUCCESS",
"customerNumber": "ASI446440071",
"month": 8,
"year": 2023,
"period": "2023/08/01 to 2023/08/31",
"list": [
{
"cashAccountNumber": "C000306574",
"currency": "USD",
"tradeOpeningBalance": 0,
"settledOpeningBalance": 0,
"deposit": 0,
"withdraw": 0,
"buy": 63302.4,
"sell": 0,
"futureBlock": 0,
"other": 0,
"tradeClosingBalance": -63302.4,
"settledClosingBalance": -63302.4,
"list": [
{
"transactionDate": "2023/08/22",
"valueDate": "2023/08/22",
"description": "Buy AAPL 100.00000@ -175.84000 Ord:2237910",
"debit": 31651.2,
"credit": 0,
"tradeBalance": -31651.2,
"settledBalance": -94953.6
},
{
"transactionDate": "2023/08/22",
"valueDate": "2023/08/22",
"description": "Buy AAPL 100.00000@ -175.84000 Ord:2237920",
"debit": 31651.2,
"credit": 0,
"tradeBalance": -63302.4,
"settledBalance": -126604.8
}
]
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Invalid Token
- Expired Token
Schema
{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string",
"rejectCode": "string"
}
{
"timestamp": "2023-12-28T09:51:50.682Z",
"status": "401",
"error": "Unauthorized",
"message": "Invalid Token",
"path": "/api/v1.1/statement/cash",
"rejectCode": "1008"
}
{
"timestamp": "2023-12-28T09:51:50.682Z",
"status": "401",
"error": "Unauthorized",
"message": "Expired Token",
"path": "/api/v1.1/statement/cash",
"rejectCode": "1007"
}