Depending on applicable regulations or business limitations, specific API requests may not be available for your use.

Get All Member Statements

This request returns the list of documents that are available for download for a member.

Request URL

Syntax GET /restapi/members/{loginid}/downloads/statements
Example URL https://testapi.foliofn.com/restapi/members/testusername/downloads/statements

Response Data Fields

Field Description
createts The date and time when the report is created.
ownerId The unique identifier of the report owner.
ownerType The type of the report owner, either “M” for member, or “F” for firm.
isCorrected A binary indicator of whether this report is a corrected version of previous same type reports that have the same report timestamp and use the same template.
isRead
readts The time when the report was read.
reportDataType “X” type means the report is stored as XML data, it can be downloaded as a .XML or .HTML format file.
“P” type means the report is stored as a .PDF file and it can be downloaded only as a .PDF file.
reportId The unique identifier of the report.
reportDate The date which indicates which period of time the report is created for.
reportType The type of the report.
templateOid The version of the template that is used to generated reports. Only for monthly statements, trade confirmations, and billing notices.

Member Report Type Code

Field Description
AD Billing report.
M Monthly statement.
T Trade confirmation.
W 5498 tax statement.
X Tax 1099 document.
Y 1099-R tax statement.

Response Example


HTTP/1.1 200 OK
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Content-Type: application/json
Transfer-Encoding: chunked
Date: Thu, 11 Sep 2014 18:35:54 GMT
[
{
      "createts": "2014-11-09T00:00:00.000-05:00",
      "isCorrected": false,
      "isRead": false,
      "ownerId": "testusername",
      "ownerType": "M",
      "reportDataType": "X",
      "reportDate": "2014-11-13T00:00:00.000-05:00",
      "reportId": "5332261960208825037",
      "reportType": "M",
      "templateOid": "1000081"
   },
      {
      "createts": "2014-10-07T00:00:00.000-04:00",
      "isCorrected": false,
      "isRead": false,
      "ownerId": "testusername",
      "ownerType": "M",
      "reportDataType": "X",
      "reportDate": "2014-11-13T00:00:00.000-05:00",
      "reportId": "1369094288104401240",
      "reportType": "M",
      "templateOid": "1000077"
   },
      {
      "createts": "2014-09-04T00:00:00.000-04:00",
      "isCorrected": false,
      "isRead": true,
      "ownerId": "testusername",
      "ownerType": "M",
      "readts": "2014-11-13T00:00:00.000-05:00",
      "reportDataType": "X",
      "reportDate": "2014-11-13T00:00:00.000-05:00",
      "reportId": "288230377517926703",
      "reportType": "M",
      "templateOid": "1000077"
   }
]


Getting Started

REST APIs

Resources

Developer Home