v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Billable Matters

Return the data for all BillableMatters

Outlines the parameters, optional and required, used when requesting the data for all BillableMatters

get/billable_matters.json

Query parameters

client_idinteger

The unique identifier for a single Contact. The keyword null is not valid for this field. The list will be filtered to include only the BillableMatter records with the matching property.

custom_field_values'=' | '<' | '>' | '<=' | '>='

Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or, if the value type only supports one operator, the supported operator is used. In the latter case, no check for operator is performed on the input string. The key for the custom field value filter is the custom_field.id. e.g. custom_field_values[12345] If an operator is used for a type that does not support it, an 400 Bad Request is returned.

Supported operators:

  • checkbox, contact, matter, picklist : =

e.g. ?custom_field_values[1]=42

  • currency, date, time, numeric : =, <, >, <=, >=

e.g. ?custom_field_values[1]=>=105.4

  • email, text_area, text_line, url : =

e.g. ?custom_field_values[1]=url_encoded

Multiple conditions for the same custom field:

If you want to use more than one operator to filter a custom field, you can do so by passing in an array of values. e.g. ?custom_field_values[1]=[<=50, >=45]

end_datestring date

Filter BillableMatter records to those that have matters with unbilled activities on or before this date (Expects an ISO-8601 date).

fieldsstring

The fields to be returned. See response samples for what fields are available. For more information see the fields section.

limitinteger

A limit on the number of BillableMatter records to be returned. Limit can range between 1 and 1000. Default: 1000.

matter_idinteger

The unique identifier for a single Matter. The keyword null is not valid for this field. The list will be filtered to include only the BillableMatter records with the matching property.

originating_attorney_idinteger

The unique identifier for a single User. Use the keyword null to match those without a BillableMatter. The list will be filtered to include only the BillableMatter records with the matching property.

page_tokenstring

A token specifying which page to return.

querystring

Wildcard search for display_number or number or description matching a given string.

responsible_attorney_idinteger

The unique identifier for a single User. Use the keyword null to match those without a BillableMatter. The list will be filtered to include only the BillableMatter records with the matching property.

start_datestring date

Filter BillableMatter records to those that have matters with unbilled activities on or after this date (Expects an ISO-8601 date).

status'open' | 'closed' | 'pending'

Filter BillableMatter records to those having a specific matter status.

Headers

X-API-VERSIONstring

The API minor version. Default: latest version.

Response

Ok