Filters records by using a query string on the field client.id.

Supports comparison operators eq, in.

Operator semantics:

• eq — Exact match. Default when no operator prefix is supplied.
• in — Matches any value in a comma-separated list.

Query examples:

filter[client.id]=0d3e7d0k-241a-461r-av15-758a90d70283

filter[client.id]=eq:0d3e7d0k-241a-461r-av15-758a90d70283

filter[client.id]=in:0d3e7d0k-241a-461r-av15-758a90d70283,1a2b3c4d-5e6f-7a8b-9c0d-e1f2a3b4c5d6

Filters records by using a query string on the field name.

Supports comparison operators cont.

Operator semantics:

• cont — Case-insensitive substring match (LIKE %value%). Use this for free-form search inputs; the supplied value is matched anywhere inside the field, and % / _ characters in the value are escaped so they do not act as wildcards.

Query examples:

filter[name]=cont:exam

Filters records by using a query string on the field is_hidden.

Supports comparison operators eq, in.

Operator semantics:

• eq — Exact match. Default when no operator prefix is supplied.
• in — Matches any value in a comma-separated list.

Query examples:

filter[is_hidden]=example_string

filter[is_hidden]=eq:example_string

filter[is_hidden]=in:example_string,another_string

Available values: true, false, True, False.

Filters records by using a query string on the field status.

Supports comparison operators eq, in.

Operator semantics:

• eq — Exact match. Default when no operator prefix is supplied.
• in — Matches any value in a comma-separated list.

Query examples:

filter[status]=example_string

filter[status]=eq:example_string

filter[status]=in:example_string,another_string

Available values: Active, Inactive.

Filters records by using a query string on the field cost_type.

Supports comparison operators eq, in.

Operator semantics:

• eq — Exact match. Default when no operator prefix is supplied.
• in — Matches any value in a comma-separated list.

Query examples:

filter[cost_type]=example_string

filter[cost_type]=eq:example_string

filter[cost_type]=in:example_string,another_string

Available values: Actual, Estimate.

Filters records by using a query string on the field billing_cycle.

Supports comparison operators eq, in.

Operator semantics:

• eq — Exact match. Default when no operator prefix is supplied.
• in — Matches any value in a comma-separated list.

Query examples:

filter[billing_cycle]=example_string

filter[billing_cycle]=eq:example_string

filter[billing_cycle]=in:example_string,another_string

Available values: Monthly, Quarterly, Annually, SemiAnnual, EveryTwoYears, EveryThreeYears, EveryFourYears, EveryFiveYears, EveryTenYears, OneTime, BiMonthly, Unknown, BiWeekly.

Filters records by using a query string on the field location.

Supports comparison operators eq, in.

Operator semantics:

• eq — Exact match. Default when no operator prefix is supplied.
• in — Matches any value in a comma-separated list.

Query examples:

filter[location]=example_string

filter[location]=eq:example_string

filter[location]=in:example_string,another_string

Filters records by using a query string on the field is_third_party.

Supports comparison operators eq.

Operator semantics:

• eq — Exact match. Default when no operator prefix is supplied.

Query examples:

filter[is_third_party]=true

filter[is_third_party]=eq:true

Filters records by using a query string on the field auto_renew.

Supports comparison operators eq.

Operator semantics:

• eq — Exact match. Default when no operator prefix is supplied.

Query examples:

filter[auto_renew]=example_string

filter[auto_renew]=eq:example_string

Available values: Yes, No, Either.

Filters records by using a query string on the field expiry.

Supports comparison operators eq, in.

Operator semantics:

• eq — Exact match. Default when no operator prefix is supplied.
• in — Matches any value in a comma-separated list.

Query examples:

filter[expiry]=example_string

filter[expiry]=eq:example_string

filter[expiry]=in:example_string,another_string

Available values: Expired, ZeroToThirty, ThirtyOneToSixty, SixtyOneToNinety, NinetyPlus.

Available values: billing_next_due_at, end_at, name, client.name, billing_cost_subunits, status, billing_cycle, is_auto_renew