Owner payments

How many owner payments match, and their total amount

Takes exactly the owner payment list's filters — its filter[<field>_<predicate>] fields and filter[tab], filter[tag_id], filter[archived] — so a total always describes the records the list returns (e.g. filter[tab]=needs_approval). Scoped like the list. A filter key it doesn't apply (a field without a predicate, or one that isn't filterable) is a 400, never silently ignored.

get/v1/owner_payments/totals

Request

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

Query parameters

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.

Response

The totals.

Changes

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