Owner payments

List owner payments

Cursor-paginated, scoped to the token's account and role.

Besides the filter[<field>_<predicate>] fields, these filters take a plain value:

  • filter[tab] — One of the app's Owner Payments tabs: draft / needs_approval / ready_to_pay / progress / completed.
  • filter[tag_id] — Comma-separated tag ids: owner payments carrying any of them.
  • filter[archived] — false (default) hides archived owner payments, true returns only archived ones, all returns both.
get/v1/owner_payments

Request

  • Base URL: https://api.topkey.io
  • URL: https://api.topkey.io/v1/owner_payments
  • Auth: HTTP bearer

Query parameters

page[size]integer

Rows per page (max 100).

page[after]string

Opaque cursor from the previous page's meta.next_cursor.

tabstring

One of the app's Owner Payments tabs: draft / needs_approval / ready_to_pay / progress / completed.

tag_idstring

Comma-separated tag ids: owner payments carrying any of them.

archivedstring

false (default) hides archived owner payments, true returns only archived ones, all returns both.

filter[field_predicate]=value (Ransack, per-resource allowlist), and the plain-value filters listed. Unknown filters return 400. Filterable fields: approval_status, created_at, created_by_id, gl_code_id, id, owner_id, paid_at, payment_group_id, property_id, state, updated_at.

Comma-separated relationships to sideload into included.

Response

A page of owner payments.

Changes

No recorded changes to this operation across all 1 revision of this API.