Start a PDFReport Job

post

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

Starts a Background Job for PDF Reporting and returns the created Background Job Instance

Available Sub Reports

account_summary
allocation_and_performance_summary
appraisals
appraisals_wo_cost_basis
asset_allocation_top_holdings
benchmark_perf_summary
buy_sells
consolidated_summary
deposits_withdrawals
household_performance_attribution
income
management_fees
net_investment_chart
performance_summary
performance_chart
portfolio_snapshot
realized_gain_loss
risk_return_chart
security_performance
target_vs_actual_allocation

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

pager.limit

integer

Number of items to return per page

pager.page

integer

Current page number

Body Params

account_ids

array of integers | null

List of account ids to run a PDF Report for

account_ids

household_ids

array of integers | null

List of household ids to run a PDF Report for

household_ids

start_date

string

required

Date to start the PDF Report calculations for this job

end_date

string

required

Date to end the PDF Report calculations for this job

sub_reports

array of strings

required

The list of sub reports to create during PDF Report generation

sub_reports*

irr_performance

boolean

If true is passed, performance calculations will use IRR methodology instead of the default TWR

non_inception_performance_chart

boolean

If true is passed, the performance chart will be PTD instead of the default ITD

portrait_pdf_orientation

boolean

If true is passed, the pdf will be rendered in portrait orientation instead of the default landscape

exclude_portfolio_performance_summary

boolean

If true is passed, the Asset Allocation and Performance Summary Report will be exclude the Portfolio Performance Summary section. The Portfolio Performance Summary includes calculates from the inception date of the account/household, so users may want to exclude the report to only show values for the reporting period.

settings_overrides

object

settings_overrides provides the ability to override default report settings that are set by default in the Firm resource.

Responses

200An enveloped list of Jobs

400Bad Request