API System Settings

API system settings define how the API functions for the tenant.

NOTE: The value in the Tenant Editable column indicates whether or not the system setting can be edited by a user.

  • Yes — A user (with the appropriate role and security authorities) can edit the system setting value in the Admin application, as well as return it to the default value. Refer to Edit System Settings.

  • No — The system setting can only be edited by a Gotransverse representative. Contact Gotransverse Technical Support before editing the system setting to ensure the change will not cause issues within the tenant.

API System Settings
Name Description Data Type Possible Values Default Value Tenant Editable
Allow the API to return deep query results

Allow the API to return all child objects of a queried object. False will only allow shallow results, which return only the EIDS of the child objects of the queried object.

Boolean

TRUE

FALSE

TRUE

Yes

API Version Validation

Specifies whether API version validation is performed for this tenant. Validates against System Setting 'Tenant API Version'

Boolean

TRUE

FALSE

 FALSE

No

Default API Query Scope

The default value for the API queryScope attribute for this tenant.

List

Shallow

Deep

Shallow

Yes

Default Manual Invoice Reason for API

Define the manual invoice reason to be used if a manual invoice reason isn't supplied via API.

Text

Default Manual Invoice Reason

Default Manual Invoice Reason

Yes

Lookup Table Processing Mode

Defines lookup table entries processing via API 2 GET calls and access in UI.

MULTI - Returns multiple values per key and view but no filter access.

SINGLE - Returns single values per key and allows both view and filter for only single values.

List

Multi

Single

Multi

No

Max Bulk Size of API NG Request

Maximum count of API NG elements to be processed per batch or bulk request.

Integer

 

50

No

Max Number of API Entities Returned in Query Response

Maximum count of API NG elements to be processed per batch or bulk request.

Integer

 

50

No

Max Number of API NG Entities Returned in Query Response

Maximum number of top level entities allowed in an API query response.

Integer

 

50

No

Max Number of API Requests

Maximum number of top level entities allowed in an API NG query response.

Integer

 

50

No
Tenant API Version

Specifies the API version used by this tenant.

List

1.24

1.25

1.26

1.27

1.28

1.29

1.30

1.31

1.32

1.33

1.33 for new tenants

No

Transactional API batch optimization

When set to TRUE, API batches are attempted in transactional mode first. Upon failure, an automatic retry is initiated using individual transactions.

Boolean

TRUE

FALSE

FALSE

Yes

 

 

 

Topic updated: 04/2025.