List Documents

GET/document/{accountId}/documents

Returns a paginated list of account documents filtered by date range and document type. documentCategory can be one of the STATEMENT, DAILY_CONFIRM, TAX_FORM. documentType can have more different values, for example tax documents can have multiple versions of 1099 forms.

Path Parameters

accountIdstringrequired

Account identifier

Query Parameters

startDateintegeroptional

Start of date range as Unix timestamp in milliseconds

endDateintegeroptional

End of date range as Unix timestamp in milliseconds

pageNointegeroptional

Page number (1-based)

pageSizeintegeroptional

Number of records per page

typestringoptional

Document type filter (e.g. FORM_1099_Q, STATEMENT)

Response

200application/json

Paginated list of documents

sstring

Response status indicator

dobject
d.pageNointeger

Current page number

d.pageSizeinteger

Number of records per page

d.totalElementinteger

Total number of matching documents

d.totalPageinteger

Total number of pages

d.dataobject[]
d.data[].clearAccountstring

Clearing account number

d.data[].documentDateinteger

Document date as Unix timestamp in milliseconds

d.data[].documentCategorystring

Broad document category

d.data[].documentTypestring

Specific document type

d.data[].fullPathstring

Relative path to the document file

errormsgstringnull

Error message when s is not ok

Response

401application/json

Unauthorized — missing or invalid authentication

sstring
errormsgstring

Response Example

{
  "s": "ok",
  "d": {
    "pageNo": 1,
    "pageSize": 149,
    "totalElement": 149,
    "totalPage": 1,
    "data": [
      {
        "clearAccount": "XXXXXXXX",
        "documentDate": 1667188800000,
        "documentCategory": "STATEMENT",
        "documentType": "STATEMENT",
        "fullPath": "XXXXXXXX/statements/2022-10-31-STATEMENT.pdf"
      }
    ]
  },
  "errormsg": null
}