Lists documents available for download

get

https://wealth-rest-api.softwarealgo.com/v1/document/list

Lists all available documents based on the given filters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

date.year

int32

Year of date. Must be from 1 to 9999, or 0 if specifying a date without
a year.

date.month

int32

Month of year. Must be from 1 to 12, or 0 if specifying a year without a
month and day.

date.day

int32

Day of month. Must be from 1 to 31 and valid for the year and month, or 0
if specifying a year by itself or a year and month where the day is not
significant.

month

string

Specifies the month of the document. This is typically used for documents that are monthly, such as monthly statements in conjunction with the year field. The value may be empty, month of trade date, or another relevant month—depending on the selected document type.

year

string

Specifies the year of the document. This is typically used for documents that are monthly or yearly, such as monthly statements or annual tax documents. The value may be empty, year of trade date, or another relevant year—depending on the selected document type.

reportType

string

Specifies the category of the document being requested. Check /v1/systemcode/list API for valid values (type = 'Document Type'), use the 'code' value.

subReportType

string

Specifies the sub-category of the document based on the selected report type. Check /v1/systemcode/list API for valid values (type = 'Document Sub Report Type', subType =

accountId

int64

Account numeric unique identifier

pagination.pageSize

int64

Number of records to return per page. Used to control the size of each paginated response.

pagination.pageNo

int64

Zero-based index of the page to retrieve. For example, page_no = 0 returns the first page.

pagination.sortName

string

Name of the field to sort by. Leave empty for default sorting behavior.

pagination.sortDirection

string

Sorting order for the results. Acceptable values are 'asc' for ascending and 'desc' for descending.

pagination.filterNames

array of strings

List of field names to apply filters on. Must correspond to valid queryable fields.

pagination.filterNames

pagination.filterValues

array of strings

List of values corresponding to each filter name. The position of each value must match the position of its filter name.

pagination.filterValues

Response

200A successful response.