Skip to main content
GET
Download a user or company's monthly statement
This endpoint is currently available for Rain-Managed programs only.

Statement period

The year and month path parameters identify the calendar month the statement covers, not the date it was issued. To download the statement for May 2026, set year=2026 and month=5.

Selecting a user or company

Pass either the userId or the companyId query parameter to identify whose statement you want to download โ€” not both. The user or company must belong to the authenticated tenant.

Response

A successful request returns the statement as a PDF (Content-Type: application/pdf). The response includes a Content-Disposition: attachment header whose filename identifies the user or company and the statement period (YYYY-MM) you requested. If no statement exists for the user or company and period you request, the endpoint returns 404 Not Found. Invalid parameters return 400 Bad Request โ€” for example, a month outside the range 1โ€“12.

Authorizations

Api-Key
string
header
required

Path Parameters

year
integer
required

Year the statement covers

month
integer
required

Month the statement covers, as a number from 1 (January) to 12 (December)

Required range: 1 <= x <= 12

Query Parameters

userId
string<uuid>

ID of the user whose statement you want to download. Provide exactly one of userId or companyId. Provide exactly one of userId or companyId.

companyId
string<uuid>

ID of the company whose statement you want to download. Provide exactly one of userId or companyId. Provide exactly one of userId or companyId.

Response

Successful operation

The user or company's monthly statement PDF