Get Invoices By Filter

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
Defaults to 1
integer
Defaults to 10

Max 1000 — larger values are rejected.

string
enum
Defaults to ASC
Allowed:
string
enum
Defaults to created_at
filter_rules
array of objects

Rule-engine filter conditions, ANDed/ORed per filter_rule_operator. type must match the type this module's Meta Filter endpoint declares for that key (fieldDataKey) — sending the wrong type is rejected. Some shared keys require module: "INVOICE" since the query engine branches on it directly.

filter_rules
string
enum
Defaults to AND
Allowed:
string

Sparse fieldset selector.

string
string
string
boolean

Switches the response to the cursor-paginated shape.

boolean
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json