List accounting event groups

Retrieves a paginated list of accounting event groups.

Accounting Event Groups Overview

Accounting Event Groups represent collections of related accounting events
that belong to a specific accounting operation. These groups organize accounting
entries and help track financial activities such as:

  • Rent collection and landlord payments
  • Invoice processing
  • Bank transaction reconciliation

Each group contains metrics that summarize the financial activities it represents,
such as amounts billed to tenants, amounts received, fee calculations, and
transfer information.

Business Significance

Accounting Event Groups are essential for:

  • Organizing accounting entries into logical business operations
  • Tracking rent collection metrics
  • Calculating tenant balances and landlord payments
  • Associating financial documents with their related transactions
  • Providing period-based financial reporting

Filtering Options

This endpoint supports filtering by various attributes to help you find specific
accounting event groups:

  • nature: Filter by the type of accounting operation
  • leasing_contract_id: Filter by the related leasing contract
  • invoice_id: Filter by the related invoice
  • charges_regularisation_id: Filter by the related charges regularisation
  • uuid: Filter by the specific UUID
  • from_billing_period_start_date / to_billing_period_start_date: Filter on the
    billing period start date (inclusive bounds, format YYYY-MM-DD)
  • from_billing_period_end_date / to_billing_period_end_date: Filter on the
    billing period end date (inclusive bounds, format YYYY-MM-DD)
  • month: Convenience filter scoping groups whose billing period start date falls
    within the given calendar month (format YYYY-MM, e.g. 2026-04)

Calendar-month reporting

For monthly recovery-rate dashboards (1st → end of month), use either:

  • ?month=2026-04 (single calendar month)
  • ?from_billing_period_start_date=2026-04-01&to_billing_period_start_date=2026-04-30
    (custom range)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Page number for pagination

integer

Number of items per page (default: 10, max: 100)

string
enum

Filter by nature (rent, bank_transactions, invoice)

Allowed:
integer

Filter by leasing contract ID

integer

Filter by invoice ID

integer

Filter by charges regularisation ID

string

Filter by UUID

date

Filter groups whose billing_period_start_date is on or after this date (format: YYYY-MM-DD)

date

Filter groups whose billing_period_start_date is on or before this date (format: YYYY-MM-DD)

date

Filter groups whose billing_period_end_date is on or after this date (format: YYYY-MM-DD)

date

Filter groups whose billing_period_end_date is on or before this date (format: YYYY-MM-DD)

string

Filter groups whose billing_period_start_date falls within the given calendar month (format: YYYY-MM, e.g. 2026-04)

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json