Expenses

List expenses

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

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

  • filter[tab] — draft / submitted / approved / rejected / ready_to_pay: the app's expense tabs, or approved with no payment yet.
  • filter[tag_id] — Comma-separated tag ids: expenses carrying any of them.
  • filter[has_work_order] — true / false: whether the expense is attached to a work order.
  • filter[archived] — false (default) hides archived expenses, true returns only archived ones, all returns both.
get/v1/expenses

Request

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

draft / submitted / approved / rejected / ready_to_pay: the app's expense tabs, or approved with no payment yet.

tag_idstring

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

has_work_orderstring

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

archivedstring

false (default) hides archived expenses, 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_sync_status, approval_status, bill_id, category, created_at, date, expensable_type, gl_code_id, id, property_id, state, submitted_at, updated_at, user_id.

Comma-separated relationships to sideload into included.

Response

A page of expenses.

Changes

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