Get Invoices By Filter

Changed on

Rule-engine-based list endpoint — an alternative to the simple filter.* query params on the plain list endpoint, for building complex AND/OR filter conditions. Get the field key enum for filter_rules from the corresponding Meta Filter endpoint. fields_to_select is restricted to a fixed allowlist of fields: invoice_uid, invoice_no, prefix, associations, reference_no, invoice_title, estimate, job, customer, customer_name, service_contract, invoice_date, invoice_date_dt, amount_paid, amount_due, due_date, due_date_dt, total, tags, invoice_status, custom_fields, custom_field_internal_object, is_deleted, is_active, is_paid, created_by, created_at, updated_at, external_id, external_status, paid_date, time_to_pay, payment_history, business_unit. Supports cursor pagination — pass cursor_pagination: true (or any of cursor/prev_cursor/last_page) to switch response modes.

post/invoice/filter

Request

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

Request body

pageinteger
limitinteger

Max 1000 — larger values are rejected.

sort'ASC' | 'DESC'
sort_by'invoice_date' | 'due_date' | 'invoice_no' | 'created_at' | 'updated_at' | 'total' | 'amount_paid' | 'amount_due'
filter_rule_operator'AND' | 'OR'
fields_to_selectstring

Sparse fieldset selector.

preferred_timezonestring
cursorstring
prev_cursorstring
cursor_paginationboolean

Switches the response to the cursor-paginated shape.

last_pageboolean

Response

200

type'success'
dataobject[]

Invoice documents — same shape as GET /invoice.

total_recordsinteger
current_pageinteger

0 in cursor-paginated mode.

total_pagesinteger

0 in cursor-paginated mode.

Changes