v1
latestOpenAPI 3.0.02026-08-063014193.1 MBReturn the data for all Bills
Outlines the parameters, optional and required, used when requesting the data for all Bills
Query parameters
Filter Bill records to those with this exact bill number
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 Bill records with the matching property.
Filter Bill records to those having the created_at field after a specific time. (Expects an ISO-8601 timestamp).
Filter Bill records to those of a specific currency.
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]
Filter Bill records to those that have a due_date after the one provided (Expects an ISO-8601 date).
Filter Bill records to those that have a specific due_date (Expects an ISO-8601 date).
Filter Bill records to those that have a due_date before the one provided (Expects an ISO-8601 date).
The fields to be returned. See response samples for what fields are available. For more information see the fields section.
Filter Bill records to those having the specified unique identifiers.
Filter Bill records to those that have an issue_date after the one provided (Expects an ISO-8601 date).
Filter Bill records to those that have an issue_date before the one provided (Expects an ISO-8601 date).
Filter Bill records for those whose bills have been sent before the specified date
Filter Bill records for those whose bills have been sent after the specified date
A limit on the number of Bill records to be returned. Limit can range between 1 and 200. Default: 200.
The unique identifier for a single Matter. Use the keyword null to match those without a Bill. The list will be filtered to include only the Bill records with the matching property.
Orders the Bill records by the given field. Default: id(asc).
The unique identifier for a single User. Use the keyword null to match those without a Bill. The list will be filtered to include only the Bill records with the matching property.
Filter Bill records to those that are overdue.
A token specifying which page to return.
Allows matching search on invoice number.
The unique identifier for a single User. Use the keyword null to match those without a Bill. The list will be filtered to include only the Bill records with the matching property.
Filter Bill records to those in a given state.
Filter Bill records to those with particular payment status.
Filter Bill records to those of a specific type.
Filter Bill records to those having the updated_at field after a specific time. (Expects an ISO-8601 timestamp).
Headers
The API minor version. Default: latest version.
Response
Ok