CData Python Connector for Xero

Build 25.0.9454

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.

Data Type

bool

Default Value

false

Remarks

When set to 'true', queries return both active and archived records. This can be useful for historical analysis, reconciliation, or full audit trails.

When set to 'false' (default), only active records are retrieved, improving performance and reducing noise in operational reports.

Note: Enabling this option may increase the size of result sets, especially in datasets with a long history or large volume of archived entries.

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