Bills

How many bills match, and their total amount

Takes exactly the bill list's filters — its filter[<field>_<predicate>] fields and filter[payment_status], filter[tab], filter[property_id], filter[tag_id], filter[has_work_order], 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/bills/totals

Request

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

Query parameters

payment_statusstring

created / scheduled / processing / failed / paid / canceled. Pair with a date range.

tabstring

One of the app's Bills tabs: draft / needs_approval / ready_to_pay / progress / completed. needs_approval is exactly the app's Needs Approval tab.

property_idstring

Comma-separated property ids: bills with a line item on any of them.

tag_idstring

Comma-separated tag ids: bills carrying any of them.

has_work_orderstring

true / false: whether the bill is attached to a work order.

archivedstring

false (default) hides archived bills, 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.