Filter all Printable Reports

post

https://api.bridgeft.com/v2/reporting/printable-reports/filter

Returns a filtered list of Printable Reports

Query Params

pager.limit

integer

Number of items to return per page

pager.page

integer

Current page number

Body Params

integer

Unique ID for this printable report object

firm_id

integer

ID of the owning firm

account_id

integer | null

ID of the account that the report is on. Null if household_id is non-null.

household_id

integer

ID of the household that the report is on. Null if account_id is non-null.

created_by_user_id

integer

ID of the user that created the report

report_date

date

report date

frequency

string | null

See Frequency Codes

start_date

date

start date

end_date

date

end date

timestamp_utc

integer

Created/last updated timestamp in UTC

dt_utc

date-time

Created/last updated timestamp in datetime UTC

size_bytes

integer

Size of the printable report in bytes

client_accessible

boolean

If true, the report is accessible in the client portal

state

string

0 if the report is generating, R if it's ready, and E if it's failed

error_message

string | null

Error message if in error state E

Responses

Language

Credentials

Bearer

Response

Choose an example:

application/json

200An enveloped list of Printable Reports

400Bad Request