SSIS Components for Xero

Build 25.0.9434

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection settings for this provider.


PropertyDescription
AutoExpandDetailsSpecifies 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.
IncludeArchivedSpecifies 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.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
OtherSpecifies 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.
PagesizeSpecifies 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.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ReadonlyToggles read-only access to Xero from the provider.
RetryDailyLimitSpecifies 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.
RetryWaitTimeSpecifies 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.
RTKSpecifies 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.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UnitDPControls 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.
UseOptimizedFiltersOnlyWhen 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.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434