ZUzuper

Get Invoices By Group Filter (Kanban)

Changed on

Returns, per invoice_status, a capped list of invoices plus the full count — the Kanban board's per-column data. Populates customer/organization/property/job/project/estimate/service_contract (minimal projections) and created_by. All 9 statuses always present (empty invoices array if none match).

post/invoice/group/filter

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/invoice/group/filter
  • Auth
    API key in header x-api-key

Request body

sort'ASC' | 'DESC'
sort_by'created_at' | 'updated_at' | 'invoice_date' | 'due_date' | 'total' | 'amount_paid' | 'amount_due'
countinteger

Max invoices returned per status column.

filter_rulesobject[]
filter_rule_operator'AND' | 'OR'
preferred_timezonestring

Response

200

Changes