Filtering

List endpoints can optionally include filters as query parameters in the request url.

Request

GET https://api.finexio.com/v1/counterparties/?internal_id=GA127

Response

HTTP 200 OK
{
    "count": 2
    "next": null,
    "previous": null,
    "results": [
       …
    ]
}

Combining Filters

When multiple filters are applied to a request, the returned results are the intersection of the filters applied. However, when the same filter is applied multiple times, the filtering system treats this as an OR operation. For example, the following request may return up to two results:

GET https://api.finexio.com/v1/counterparties/?internal_id=GA127&internal_id=GA211

Available Filters

Filters are available for the following endpoints:

endpoint	filter paramaters
/counterparties/	type=[buyer|supplier] internal_id={value}
/invoices/	invoice_number={value} created gt {timestamp} created gte {timestamp} created lt {timestamp} created lte {timestamp}

👍

More Filters

If you have a filtering use case that is not covered above, just let us know!