CData Python Connector for Sage Intacct

Build 25.0.9454

Miscellaneous

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


PropertyDescription
UseLegacyWhen set to True, the provider uses the old API implementation. When set to False, the provider uses the new API implementation. The new API supports server-side filtering, ORDER BY clauses, as well as offset and aggregate functions including COUNT, AVG, MIN, MAX and SUM.
ClientIDA company ID of a child company that you want to connect to. When a value is set for this property, data returned by the provider is limited to the data organized under this company.
DocParIdThe name of a transaction type, exactly as it appears in the Applications dropdown under (your desired application) > 'All' tab > 'Transactions'. The provider returns custom fields associated with the specified transaction type. For example: 'Sales Invoice'.
EnableSubscriptionsA list of one or more subscriptions enabled in your Sage Intacct account. The provider exposes any tables exclusive to the specified subscription(s). If multiple subscriptions are specified, separate them with commas. For example: 'Subscription1,Subscription2'.
IncludeDetailAggregateIf True, aggregate columns are displayed in query results.
IncludeGLEntriesIf True, when updating the GLBatch table with new GLEntry items, the provider includes existing GLEntry items associated with the record being updated. If False, the provider does not include the existing items, and they are deleted from the table.
IncludeItemDetailsIf True, aggregate columns are displayed in query results for the 'INVDOCUMENTPARAMS', 'PODOCUMENTPARAMS', and 'SODOCUMENTPARAMS' tables.
IncludeRelatedAttributesThe scope of related attributes retrieved by the provider. Use this only when the 'UseLegacy' connection property is set to False.
LocationsIdThe Location ID of the shared child company that you want to access. When this property is set, data returned by the provider is limited to the data organized under this Location. To find Location Ids, click the dropdown menu next to the Home button (house icon), then navigate to Reports > Dimensions > Locations (click the text, not the +).
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MinimumColumnSizeThe minimum column size returned by the provider. All column sizes reported by the provider are equal or greater to this value. When set to the default value (-1), the provider reports the exact column sizes it receives from Sage Intacct.
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.
PagesizeThe maximum number of records per page the provider returns when requesting data from Sage Intacct.
PreferredDateFormatsA semicolon separated string containing a list of DateTime formats which should be tried when parsing DateTime values.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ReadByNameIf True, the provider uses the ReadByName clause in its XML request to the Sage Intacct API. This allows the provider to query API endpoints that require this clause. Use this only when the UseLegacy connection property is set to True. It is rare for tables or views to require setting this property.
ReadonlyToggles read-only access to Sage Intacct from the provider.
ReturnFormatAsXMLIf set to True, the Sage Intacct API returns requested data in XML format. If False, the Sage Intacct API returns data in JSON format.
RowScanDepthThe maximum number of rows to scan to look for the columns available in a table.
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.
ShowPrivateEntityDataWhen using newer elements of the Sage Intacct API by setting UseLegacy to False , setting this property to True will cause queries to return data from private entities owned by the top-level entity targeted by the query. Setting this to false will cause queries to only return data from the top-level entity.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
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.9454