Miscellaneous
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| UseLegacy | When 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. |
| BatchSize | Specifies the maximum number of rows included in each batch operation. Set to 0 to submit the entire batch as a single request. |
| ClientID | A 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. |
| ConnectionLifeTime | Specifies the maximum lifetime of a connection in seconds. When the specified time elapses, the provider closes the connection. Set to 0 or leave empty for no time limit. |
| DocParId | The 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'. |
| EnableSubscriptions | A 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'. |
| IncludeDetailAggregate | If True, aggregate columns are displayed in query results. |
| IncludeGLEntries | If 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. |
| IncludeRelatedAttributes | The scope of related attributes retrieved by the provider. Use this only when the 'UseLegacy' connection property is set to False. |
| LocationsId | The 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 +). |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| MinimumColumnSize | The 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. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| Pagesize | The maximum number of records per page the provider returns when requesting data from Sage Intacct:. |
| PoolIdleTimeout | Specifies the maximum idle time, in seconds, that a connection can remain in the pool before being closed. |
| PoolMaxSize | Specifies the maximum number of connections allowed in the connection pool. The default value is 100. Set to 0 or a negative value to disable pooling. |
| PoolMinSize | Specifies the minimum number of connections maintained in the connection pool. The default value is 1. |
| 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. The default is 60 seconds. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| ReadByName | If 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. |
| Readonly | Toggles read-only access to Sage Intacct from the provider. |
| ReturnFormatAsXML | If set to True, the Sage Intacct API returns requested data in XML format. If False, the Sage Intacct API returns data in JSON format. |
| RTK | Specifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. Use this property only 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. The default is 60 seconds. Set to 0 to disable the timeout. |
| UseConnectionPooling | Enables the connection pooling feature, which allows the provider to reuse existing connections instead of creating new ones for each request. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |