Get Cash Statement

GET 
/cash-statement

This is used to get the pdf format of a 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

month integerrequired

Possible values: >= 1 and <= 12

if current year is given, month must be current month or a previous month

year integerrequired

only accepts cuurent year or a previous year

Example: 2022

customerNumber stringrequired

Possible values: <= 20 characters

accountNumber string

Possible values: <= 50 characters

Security account number

cashAccountNumber string

Possible values: <= 50 characters

Cash account number

contentType stringrequired

currently only accepts json format

Example: json

Responses

200

OK

application/json

Schema

Schema

status string
reason string
rejectCode integer
customerNumber string
month integer
year integer
period string
list object[]
Array [
cashAccountNumber string
currency string
tradeOpeningBalance number
settledOpeningBalance number
deposit number
withdraw number
buy number
sell number
futureBlock number
other number
tradeClosingBalance number
settledClosingBalance number
list object[]
Array [
transactionDate string
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])$
valueDate string
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])$
description string
debit number
credit number
tradeBalance number
settledBalance number
]
]

Example (from schema)

{
  "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
        }
      ]
    }
  ]
}

JSON

{
  "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
        }
      ]
    }
  ]
}

Loading...