Bills

List bills

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

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

  • filter[payment_status] — created / scheduled / processing / failed / paid / canceled. Pair with a date range.
  • filter[tab] — 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.
  • filter[property_id] — Comma-separated property ids: bills with a line item on any of them.
  • filter[tag_id] — Comma-separated tag ids: bills carrying any of them.
  • filter[has_work_order] — true / false: whether the bill is attached to a work order.
  • filter[archived] — false (default) hides archived bills, true returns only archived ones, all returns both.
get/v1/bills

Request

  • Base URL: https://api.topkey.io
  • URL: https://api.topkey.io/v1/bills
  • 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.

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. Filterable fields: accounting_archived, accounting_sync_status, bill_date, bill_vendor_id, check_number, created_at, due_date, flagged, gl_code_id, id, invoice_number, paid_at, payment_group_id, payment_method, state, updated_at, upload_source.

Comma-separated relationships to sideload into included.

Response

A page of bills.

Changes

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