Miscellaneous
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| AutoExpandDetails | Specifies whether the connection should automatically expand and include additional details for complex objects such as BankTransfers, ContactGroups, ExpenseClaims, ExpenseClaimPayments, ExpenseClaimReceipts, and Receipts. Enabling this option retrieves embedded or related data without requiring separate item-level queries. |
| BatchSize | Specifies the maximum number of rows included in each batch submitted during batch operations. To submit the entire batch as a single request, set BatchSize to 0 . |
| ConnectionLifeTime | Specifies the maximum lifetime of a connection in seconds. When the specified time elapses, the provider closes the connection. |
| ConnectOnOpen | Specifies whether the provider establishes a connection to Xero immediately upon opening the connection. Set ConnectOnOpen to True if immediate connectivity verification is necessary. |
| IncludeArchived | Specifies whether archived records should be included in query results. Archived records typically represent inactive, soft-deleted, or historical entries that are retained for compliance or auditing purposes. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details. |
| Pagesize | Specifies the maximum number of results to return per page when retrieving data from Xero. This property controls pagination behavior during data queries, improving performance and controllability of result sets. |
| PoolIdleTimeout | Specifies the maximum idle time, in seconds, that a connection can remain in the pool before being closed. Requires UseConnectionPooling=True. |
| PoolMaxSize | Specifies the maximum number of connections allowed in the connection pool. |
| PoolMinSize | Specifies the minimum number of connections to be maintained in the connection pool at all times. |
| PoolWaitTime | Specifies the maximum number of seconds a connection request waits for an available connection in the pool. If the wait exceeds this time, an error is returned. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Readonly | Toggles read-only access to Xero from the provider. |
| RetryDailyLimit | Specifies whether the provider should wait and retry when Xero reports that the daily API usage limit has been reached. Enabling this setting allows the connection to pause and resume automatically based on the wait time recommended by Xero. |
| RetryWaitTime | Specifies the amount of time (in milliseconds) that the provider should wait before retrying a request after hitting the Xero API rate limit. This delay helps manage request throttling and prevent repeated failures. |
| RTK | Specifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UnitDP | Controls the number of decimal places returned for unit prices in query results. This setting affects the precision of unit price values retrieved from the Xero API. |
| UseConnectionPooling | Enables the connection pooling feature, which allows the provider to reuse existing connections instead of creating new ones for each request. |
| UseOptimizedFiltersOnly | 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. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |