GET
List tenant invoices

Authorizations

Authorization
string
header
required

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

Query Parameters

period
string

Optional tenant list filter period in YYYY-MM format.

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

Optional tenant invoice status filter: ISSUED, PARTIALLY_PAID, PAID, OVERDUE, or CANCELLED.

Available options:
ISSUED,
PARTIALLY_PAID,
PAID,
OVERDUE,
CANCELLED

Response

Tenant API operation succeeded

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.