Download an account statement as a PDF
Use this when the customer needs a statement document they can keep, print, or send to a third party.
It returns the statement for the managed account identified by the id path parameter as a rendered PDF, ready to hand to the end customer as-is.
Choosing a period
startPeriod and endPeriod are dates in the format yyyy-MM-dd, both inclusive, and are resolved to local midnight in timezone. The period defaults to the last month and must not exceed 12 months.
Unlike Get an account statement, this returns every entry in the period rather than a page of them. A period longer than 12 months, or one holding more than 5,000 entries, is rejected with a 400 rather than silently truncated. Narrow the period and request again. A period with no entries still produces a valid PDF, with no entry rows.
Timezones
Every date and time on the document is rendered in timezone, which the document itself states, so the reader knows what the times mean. It defaults to UTC. Pass an IANA name such as Europe/Rome; fixed offsets like +02:00 are rejected because they carry no daylight-saving rules.
Access
This operation requires a stepped-up access token. Step up before calling it by issuing a challenge through Step-up.
Request
- Base URL: https://sandbox.weavr.io/multi
- URL: https://sandbox.weavr.io/multi/managed_accounts/{id}/statement/pdf
- Auth: HTTP bearer and API key in header api-key
Path parameters
The unique identifier of the managed account.
Query parameters
First day of the statement period, inclusive, as a date in the format yyyy-MM-dd.
Interpreted as local midnight in timezone. Defaults to one month before endPeriod.
Last day of the statement period, inclusive, as a date in the format yyyy-MM-dd.
Interpreted as local midnight in timezone, so the period ends at the final moment of this day in that timezone. Defaults to today in timezone. The period must not exceed 12 months.
IANA timezone used to render every date and time on the PDF, and to resolve startPeriod and endPeriod to local midnight. Defaults to UTC.
Only IANA timezone names are accepted, for example Europe/Rome or America/New_York. Fixed offsets such as +02:00 or GMT+2 are rejected, because they carry no daylight-saving rules and would render incorrect times across a transition.
Response
The generated PDF statement
Changes
No recorded changes to this operation across all 1 revision of this API.