When set to 'true', this property instructs the provider to only push filters that are considered optimized by the Xero API. This improves the reliability of queries targeting high-volume endpoints that may otherwise fail or be throttled when unoptimized filters are used.

Data Type

bool

Default Value

false

Remarks

Enable this property to ensure that only safe, high-performance filters are included in API requests to Xero. This is particularly important when working with endpoints subject to High Volume Thresholds or stricter rate-limiting constraints. This reduces the chance of query failure due to unsupported or expensive filters and improves performance and stability when querying large datasets.

Set this property to 'true' when accessing endpoints like Invoices, Contacts, or Reports with large result sets, when using tools that auto-generate complex queries, or when you receive errors related to unsupported filters or timeouts.

See Xero API Limits for more information.