Create An Item Filter
Filters are applied to properties of the field_coverage object and direct_deposit_switch object of Items using the comparison operators below. You can also filter Items by their status property using the eq operator.
The name and ID of the new Item filter are returned in the response, which can be used as a query parameter when listing Items.
Comparison operators
eq — equals
gt — greater than
gte — greater than or equal to
lt — less than
lte — less than or equal to
Note on percent and amount precision filters for deposit switches:
When an Item’s underlying payroll system does not specify a required percent or amount precision, it is indicated by a null value (e.g. \"amount_precision\": null) in the features object.
In Item filters that apply a numerical comparison to the amount_precision or percent_precision properties, such as \"amount_precision\": {\"lte\": \"100\"}, the response will not include Items with null values for these properties.
Authorizations
Username = api_key_id, Password = api_key_secret
Body
Name for the Item filter.
The set of filters, which can be applied when listing Items.