| title | description | author | ms.author | ms.date | ms.topic | ms.reviewer |
|---|---|---|---|---|---|---|
Using filters with API/OData calls |
Learn how to use filters with API calls to get targeted information in return. |
SusanneWindfeldPedersen |
solsen |
03/14/2024 |
conceptual |
solsen |
You can provide filters in API calls to get targeted information in return. The syntax for this follows the Microsoft REST API guidelines. For example, to GET all open (unpaid) sales invoices above 1000.00 excl tax, call <endpoint>/companies(bb6d48b6-c7b2-4a38-9a93-ad5506407f12)/salesInvoices?$filter=status eq 'Open' and totalAmountExcludingTax gt 1000.00
You can either filter by range or by property. To learn how to develop a good filter expression, see Entering Criteria in Filters. To know more about filter expressions and their equivalent AL expressions in web services, check out Filter expressions.
You can include filters for the delta links; which are typically based on the GET query call. When calling the API with the deltaLink to get the changes, each entity that previously didn't match the filter criteria, but matches it now, returns as an "add" entity. Each entity that previously matched the query but no longer does, either because the entity was deleted, or the properties of the entity have changed such that it doesn't matches the query parameters, returns as a "removed" entry.
Note
There's a special filter, journals.templateDisplayName, which returns journals if a user hasn't defined the filter criteria.
Developing connect apps for Dynamics 365 Business Central
Using deltas with APIs
Tips for working with the APIs