Please enable JavaScript to view this site.

Teamleader Data Model

Navigation: » No topics above this level «

Provider Teamleader: Teamleader CRM.

Scroll Comments Prev Top Next More

Teamleader CRM.

Code for use in settings.xml: Teamleader

Alias: teamleader

Status: Production

Available in Editions: Paid

Technical Documentation: http://apidocs.teamleader.be/

Documentation

Authentication

Authentication can be done using one of the following two alternatives:

1. Using the user log on code and password also used on the Teamleader website.

2. Using an API group and API secret.

Authentication using user log on code and password is recommended for general use. The user must have access to all functionality since by default all so-called 'scopes' are requested. The scopes can be manually entered to be able to log in with a restricted accounts. Please provide a space-separated list chosen from companies, contacts, deals, departments, events, invoices, products, projects, quotations, subscriptions, tickets, todos, users.

The API group and secret can be found on https://app.teamleader.eu/apiwebhooks.php?show_key.

 

Usage Limits

Invantive SQL executes API calls to retrieve and upload data. The number of API calls allowed per 5 seconds is 25. Invantive SQL ensures that within your session the number of calls allowed per hour is not exceeded.

To get an impression of how Invantive SQL translates into API calls, please query the data dictionary view 'sessionios', such as with 'select * from sessionios@datadictionary'.

 

Custom Fields

Custom fields for which one value can be entered on an object are added to the table representing the object. For instance, a custom field 'needsaudit' on 'project', will be added as a column 'c_needsaudit' on the 'project' table. The name of the additional column directly derives from the custom field name. Almost all changes, including adding numbers or reading characters, will result in the data model being changed.

Custom fields which can have no, one or multiple values ('set' custom fields) are reflected in the data model by tables with a name constructed of the object name, an underscore plus the name of the custom field. For example, a custom field named 'Multiple Selection' on 'Task' will add a table 'task_multipleselection' to the data model.

Custom fields are unique to each Teamleader environment. When the existence of specific custom field is not guaranteed, please use generic solutions like the tables 'CustomFieldDefinitions', 'custom_fields', 'custom_field_options', 'custom_field', 'Custom_Fields_All', 'Custom_Field_Types' and their object-specific custom field value tables like 'ticket_custom_field_values_by_id'.

Provider Attributes

The following provider attributes are available for Teamleader:

Code

Description

Default Value

Set from Connection String

Set from Set SQL-Statement

Set from Providers File

api-client-id

The client ID is a unique identifier of your application. It is generated by registering an application.

 

 

api-client-secret

The client secret is to be kept confidential. Such as a password for a logon code, the client secret is the confidential part of an app identified by a client ID. It is needed during the OAuth2 Code Grant Flow together with the refresh token to get access.

***

 

api-group-authentication

Use API group authentication when true. OAuth otherwise.

 

 

api-redirect-url

The redirect URI is the website a browser session is redirected to after the OAuth2 authentication process has been completed.

 

 

api-refresh-token

Refresh Token is a security token for the OAuth2 Code Grant Flow. With a Refresh Token and client secret you can retrieve a renewed access token to access protected resources. A Refresh Token and client secret must be stored securely since once compromised allows access to your protected resources.

***

 

api-url

URL to access the API.

 

 

download-error-internet-down-max-tries

Maximum number of tries when the Internet connection seems down during retrieval of data.

 

download-error-internet-down-sleep-initial-ms

Initial sleep in milliseconds between retries when the Internet connection seems down during retrieval of data.

 

download-error-internet-down-sleep-max-ms

Maximum sleep in milliseconds between retries when the Internet connection seems down during retrieval of data.

 

download-error-internet-down-sleep-multiplicator

Multiplication factor for sleep between retries when the Internet connection seems down during retrieval of data.

 

force-case-sensitive-identifiers

Consider identifiers as case-sensitive independent of the platform capabilities.

False

forced-casing-identifiers

Forced casing of identifiers. Choose from Unset, Lower, Upper and Mixed.

 

http-disk-cache-compression-level

Compression level for the HTTP disk cache, ranging from 1 (little) to 9 (intense). Default is 5.

5

http-disk-cache-directory

Directory where HTTP cache is stored.

C:\Users\gle3\Invantive\Cache

http-disk-cache-max-age-sec

Maximum acceptable age in seconds for use of data in the HTTP disk cache.

2592000

http-get-timeout-ms

HTTP GET timeout (ms).

300000

http-memory-cache-compression-level

Compression level for the HTTP memory cache, ranging from 1 (little) to 9 (intense). Default is 5.

5

http-memory-cache-max-age-sec

Maximum acceptable age in seconds for use of data in the HTTP memory cache.

14400

http-post-timeout-ms

HTTP POST timeout (ms).

300000

ignore-http-400-errors

Ignore HTTP 400 errors when exchanging results with the OData endpoint.

False

ignore-http-403-errors

Ignore HTTP 403 errors when exchanging results with the OData endpoint.

False

invantive-sql-forward-filters-to-data-containers

Whether to forward filters to data containers.

True

invantive-sql-shuffle-fetch-results-data-containers

Whether to shuffle results fetched from data containers.

False

invantive-use-cache

Whether to cache the results of a query.

True

join-set-points-per-request

Maximum number of values in a request when executing a join set.

60

maximum-length-identifiers

Non-default maximum length in characters of identifier names.

 

pre-request-delay-ms

Pre-request delay in milliseconds per request.

0

requests-parallel-max

Maximum number of parallel data requests from individual partitions on the data container.

32

scopes

Space-separated and case-sensitive list of scope for OAuth only. Leave empty for all.

 

 

slot-based-rate-limit-length-ms

Length in ms of a slot-based rate limit.

6000

 

slot-based-rate-limit-slots

Number of slots of a slot-based rate limit. Null means no slot-based rate limit

23

 

standardize-identifiers

Rewrite all identifiers to the preferred standards as configured by standardize-identifiers-casing and maximum-length-identifiers.

True

standardize-identifiers-casing

Rewrite all identifiers to the recommended standard platform-specific casing when changing a data model on a case-dependent platform.

True

trace-native-calls

Trace native calls to data container backend.

False

use-http-disk-cache-read

Whether to use HTTP responses from previous queries stored on disk to answer the current query.

True

use-http-disk-cache-write

Whether to memorize HTTP responses on disk.

True

use-http-memory-cache-read

Whether to use HTTP responses from previous queries stored in memory that can answer the current query.

True

use-http-memory-cache-write

Whether to memorize HTTP responses from previous queries for use by future queries.

True