Rendering

Three endpoints: render and store a statement, render a throwaway preview with unsaved edits applied, and download a stored render.

The renderer emits a self-contained HTML document. The logo is embedded as base64 and there are no external requests, so the browser’s print-to-PDF produces the finished statement. Ask for format: "pdf" and the server does that print step for you, returning a PDF instead. See PDF output.

Rendering requires write access, so the caller must be the report owner (or an admin). Recipients with read access can still download an existing render.

POST /api/funds/{report_id}/render

Render the report and store the output.

Request body

All fields optional. Anything omitted falls back to the period saved on the report’s configuration.

string

Display label shown in the header, for example Q1 2026.

string

YYYY-MM-DD. Drives the chart x-axis and the fee accrual window.

string

YYYY-MM-DD. The as-of stamp and the FX snapshot date.

string

default:"html"

html or pdf. See PDF output. Any other value returns 400.

curl -X POST "$BASE/api/funds/$REPORT_ID/render" \
  -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" \
  -d '{
    "period": "Q1 2026",
    "period_start": "2026-01-01",
    "period_end": "2026-03-31"
  }'

Response

{
  "ok": true,
  "filename": "fb161519-6c91-4317-87f0-2ac092b0db80_fund_9f2c1a...html",
  "download_url": "/lp-report-studio/output/fb161519-..._fund_9f2c1a...html",
  "compact_overflow": null,
  "recap_overflow": null
}

Rendering is synchronous and typically takes one to three seconds. Fetch download_url to get the document. The report is always rendered at portfolio scope. If a manager runs several LP mandates, each mandate gets its own portfolio and its own report; there is no per-investor parameter here. For per-investor figures, see the LP Portal.

Errors

/render has no 422 path. Every render-time validation failure surfaces here as a 500 with a generic message. To find out what actually went wrong, replay the same request against /render-preview with an empty config_overrides, which returns the real message with a 422.

The failures that behave this way:

Failure	Trigger
Text over budget	A prose block longer than its limit (objective 320, market commentary 520, methodology 220, disclaimer 600 characters). `PUT /config` clamps these on write, so in practice this only fires for text stored through the legacy `POST /branding`.
Sign-colour mismatch	A positive number would render in a negative-coloured cell, or the reverse. Usually triggered by a manual adjustment flipping a cell’s sign.
Fee invariant	The fee grand total disagrees with the sum of per-strategy totals, or a strategy’s monthly figures disagree with its period total, by more than the greater of $1 and 1%.
No NAV	The portfolio ledger carries no NAV at all. The renderer refuses rather than printing a zero-value statement. Re-reconcile the portfolio and retry.

404 is returned for an unknown report_id.

Layout warnings

compact_overflow and recap_overflow are advisory. When set, the document was still produced, but part of it will clip when printed. Show a banner rather than blocking. compact_overflow is only ever computed for reports whose layout is compact. On the default statement layout and on institutional it is always null, so most integrations will never see it populated.

{
  "estimated_height_px": 1184,
  "budget_height_px": 1067,
  "overflow_px": 117,
  "n_strategies": 4,
  "n_adjustments": 3,
  "message": "This report has too much content for the compact layout ..."
}

The fix is switching that report to the institutional layout, which gives adjustments their own page. recap_overflow fires when the recap section exceeds its single-page budget and carries the same fields (estimated_height_px, budget_height_px, overflow_px, n_strategies, message). It is null when the recap fits, is disabled, has no data, or spans multiple print pages by design.

POST /api/funds/{report_id}/render-preview

Render with unsaved configuration applied, and return the document inline. Nothing is written: no database changes, no stored file. This is what drives live editing, where the client debounces the edit form and posts the dirty patch.

Request body

All optional.

string

Display label, period_start and period_end behave as on /render above.

object

A patch in the same shape PUT /config accepts, applied in memory before rendering.

curl -X POST "$BASE/api/funds/$REPORT_ID/render-preview" \
  -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" \
  -d '{
    "period_start": "2026-04-01",
    "period_end": "2026-05-31",
    "config_overrides": { "content": { "investment_objective": "Draft text ..." } }
  }' -o preview.html

Responses

Status	Content type	Body
`200`	`text/html`	The rendered document, byte-identical to what `/render` would produce after saving the same patch
`404`	`application/json`	`{ "ok": false, "error": "report not found" }`
`422`	`application/json`	Render rejected the input, with a user-facing message. Same four failure classes listed under `/render` above.
`500`	`application/json`	`{ "ok": false, "error": "preview render failed" }`. A real server fault; details are logged server-side.

422 is the expected outcome while a user is mid-typing. Keep the last good preview on screen and show the message rather than swapping in a broken frame. Because this endpoint reports validation failures properly, it is also the right tool for diagnosing a /render that returns 500. Warnings ride on response headers so they can be read without parsing the document:

X-Recap-Overflow-Px: pixels by which the recap page exceeds its budget. Absent when the recap fits, is disabled, or has no data.

GET /output/{filename}

Download a stored render. Returns the HTML document as an attachment.

curl -H "X-API-Key: $API_KEY" \
  "https://api.renesis.fi$DOWNLOAD_URL" -o statement.html

Filenames follow {report_id}_fund_{random}.html. Access is checked against the report id embedded in the filename, so learning a URL is not enough to read another fund’s statement. Read access is sufficient, which is what lets a recipient download a statement they cannot re-render.

Status	Cause
`404`	No such file
`403`	No access to the report the file belongs to

PDF output

Server-side PDF is rolling out. If format: "pdf" answers 503 on your environment, it has not reached it yet; the client-side path below works everywhere in the meantime.

Two ways to get a PDF, and they produce the same document.

Ask the server for it

Add format: "pdf" to the /render body, or post to the dedicated route:

curl -X POST "$BASE/api/funds/$REPORT_ID/render-pdf" \
  -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" \
  -d '{"period":"Q1 2026","period_start":"2026-01-01","period_end":"2026-03-31"}'

POST /api/funds/{report_id}/render-pdf takes the same body and returns the same response as /render; it exists so a client that only ever wants PDFs has a URL to hardcode instead of remembering a body flag. filename and download_url point at a .pdf, and GET /output/{filename} serves it as application/pdf. The server is not building a different document. It renders the same HTML and prints it with the same browser engine you would use yourself, so the PDF matches the HTML exactly.

Status	Meaning
`400`	`format` was neither `html` nor `pdf`
`500`	The conversion failed. The HTML rendered, the print step did not.
`503`	PDF rendering is unavailable on this environment. Retry rather than changing your request.

Conversions are capped and queued server-side, so a burst of PDF requests waits rather than failing.

Print it yourself

The rendered HTML prints correctly with no further work, which is useful if you are already displaying it or want to control the print settings:

chrome --headless --disable-gpu --no-pdf-header-footer \
  --print-to-pdf=statement.pdf statement.html

Page size, margins, and page breaks are already set in the document, so no extra print options are needed.

Getting Started

Methodology

API Reference

Rendering API

Rendering

POST /api/funds/{report_id}/render

Request body

Response

Errors

Layout warnings

POST /api/funds/{report_id}/render-preview

Request body

Responses

GET /output/{filename}

PDF output

Ask the server for it

Print it yourself

​Rendering

​POST /api/funds/{report_id}/render

​Request body

​Response

​Errors

​Layout warnings

​POST /api/funds/{report_id}/render-preview

​Request body

​Responses

​GET /output/{filename}

​PDF output

​Ask the server for it

​Print it yourself

Rendering

POST /api/funds/{report_id}/render

Request body

Response

Errors

Layout warnings

POST /api/funds/{report_id}/render-preview

Request body

Responses

GET /output/{filename}

PDF output

Ask the server for it

Print it yourself