List Invoices
Resource URL
| Code Block | ||
|---|---|---|
| ||
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 Invoices
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) |
| Info |
|---|
Using the |
Handling the response
Please see GET /invoices/:id for handling the response.