GET
Revenue report

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

period
string

Exact billing month in YYYY-MM. Revenue here means collected completed payments by payment_date within the selected month/range, not statutory tax revenue recognition.

Required string length: 7
Pattern: ^\d{4}-\d{2}$
period_from
string

Inclusive month lower bound in YYYY-MM for a closed range. Must be paired with period_to and cannot be combined with period.

Required string length: 7
Pattern: ^\d{4}-\d{2}$
period_to
string

Inclusive month upper bound in YYYY-MM for a closed range. Must be paired with period_from and cannot be combined with period.

Required string length: 7
Pattern: ^\d{4}-\d{2}$
property_id
string<uuid>

Optional property filter

Response

Revenue report with zero-filled period series

data
object
required

Endpoint-specific response payload. See the referenced schema for the resource fields.

request_id
string
required

Request correlation identifier returned from X-Request-Id or generated by the API.

meta
object

Optional response metadata such as pagination limits, counts, or export context.