API Reference

Generate a PDF report for an account's proposal

post
https://live.moment-api.com/v1/report/

Creates and returns a PDF report containing account details, statistics, compliance information, and holdings for a proposal

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Proposal generation request

string

ID of an existing proposal. When provided, Reporter fetches
the full proposal payload server-side from the upstream
proposal API (configured via MOM_INTERNAL_ALB_ENDPOINT) and
uses one of its accounts as proposal_account. Either
proposal_id or an inline proposal_account must be
supplied. If the proposal has more than one account, also
supply account_id to pick which one to report on.

string

Optional. When proposal_id is provided and the upstream
proposal has more than one account, this picks which one to
report on. Required for multi-account proposals; ignored if
proposal_account is supplied inline.

proposal_account
object
url
required

A url of the JPG image to be included in the generated PDF report

string

The name of the reporter (deprecated, use prepared_by instead)

string
Defaults to Your Advisor

The name to display as the preparer of the report

string

Custom disclaimer text to include in the report

string

Custom disclaimer text to display on the cover page

color_palette
array of strings
Defaults to #3c5e5c

Array of hex color codes for the report color scheme

color_palette
string
enum
Defaults to weight

Optional parameter to specify the key to sort holdings by

string
enum
Defaults to desc

Optional parameter to specify the order to sort holdings by

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 2 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/pdf
application/json

Updated 2 months ago

Did this page help you?