/
GET /invoices
The following macros are not currently supported in the header:
- style
GET /invoices
List Invoices
Resource URL
GET /invoices
Parameters
Table of allowed parameters.
_page | unsigned int | The page of the list to display. For example, 5 will display the fifth page. Each page contains 10 resources. |
---|---|---|
_limit | unsigned int | The maximum number of resources to return. Default is 10 and maximum is 50. |
_offset | unsigned int | The position in the list of resources to return from. For example, if you had 20 resources and requested an offset of 10. Resources 10 to 19 would be returned. Offset cannot be used in conjunction with _page . |
_fields | partial string | Allows you to specify optional fields and linked objects to include in the response. |
_filters | partial_string |
Filtering
You can filter the returned list using the _filters
parameter.
Name | Example | Description |
---|---|---|
id(<ids>) | ||
invoice_number(<numbers>) | ||
date_raised_after(unix_timestamp), date_raised_before(uinx_timestamp) | ||
date_due_after(unix_timestamp), date_due_before(uinx_timestamp) | ||
date_modified_after(unix_timestamp), date_modified_before(uinx_timestamp) | ||
NEW <field_name>_greater_than(<value>), <field_name>_less_than(<value>), <field_name>_greater_than_or_equal(<value>), <field_name>_less_than_or_equal(<value>)
| _filters=id_greater_than(5) | Available fields: id |
Using the _not
suffix (e.g, id_not
) on standard in filters will returns results not in.
Handling the response
Please see GET /invoices/:id for handling the response.
, multiple selections available,
Related content
GET /invoices/:id
GET /invoices/:id
More like this
GET /requests
GET /requests
More like this
GET /quotes
GET /quotes
More like this
GET /staff
GET /staff
More like this
List Tasks
List Tasks
More like this
GET /issues
GET /issues
More like this