Please enable JavaScript to view this site.

Teamleader API Data Model

Navigation: » No topics above this level «

Teamleader API SQL Driver

Contents Previous Home Next More

Invantive SQL is the fastest, easiest and most reliable way to exchange data with the Teamleader API.

Use the "Search" option in the left menu to search for a specific term such as the table or column description. When you already know the term, please use the "Index" option. When you can't find the information needed, please click on the Chat button at the bottom or place your question in the user community. Other users or Invantive Support will try to help you to our best.

Teamleader is a cloud solution for customer management. Teamleader includes CRM as well as project and tickets. Teamleader can be extended by defining custom fields on several core concepts.

Teamleader API Clients

Invantive SQL is available on many user interfaces ("clients" in traditional server-client paradigma). All Invantive SQL statements can be exchanged with a close to 100% compatibility across all clients and operating systems (Windows, MacOS, Linux, iOS, Android).

The clients include Microsoft Excel, Microsoft Power BI, Microsoft Power Query, Microsoft Word and Microsoft Outlook. Web-based clients include Invantive Cloud, Invantive Bridge Online as OData proxy, Invantive App Online for interactive apps, Online SQL Editor for query execution and Invantive Data Access Point as extended proxy.

The Teamleader Power BI connector is based on the Invantive SQL driver for Teamleader, completed by a high-performance OData connector which works straight on Power BI without any add-on. The OData protocol is always version 4, independent whether the backing platform uses OData, SOAP or another protocol.

For technical users there are command-line editions of Invantive Data Hub running on iOS, Android, Windows, MacOS and Linux. Invantive Data Hub is also often used for enterprise server applications such as ETL. High-volume replication of data taken from the Teamleader API into traditional databases such as SQL Server (on-premise and Azure), MySQL, PostgreSQL and Oracle is possible using Invantive Data Replicator. Invantive Data Replicator automatically creates and maintains Teamleader datawarehouses, possibly in combination with data from over 70 other (cloud) platforms. Data Replicator supports data volumes up to over 1 TB and over 5.000 companies. The on-premise edition of Invantive Bridge offers an Teamleader ADO.net provider.

Finally, online web apps can be build for Teamleader using App Online of Invantive Cloud.

Monitor API Calls

When a query or DML-statement has been executed on Invantive SQL a developer can evaluate the actual calls made to the Teamleader API using a query on sessionios@DataDictionary. As an alternative, extensive request and response logging can be enabled by setting log-native-calls-to-disk to true. In the %USERPROFILE%\Invantive\NativeLogs folder Invantive SQL will create log files per API request and response.

Specifications

The SQL driver for Teamleader does not support partitioning. Define one data container in a database for each company in Teamleader to enable parallel access for data from multiple companies.

An introduction into the concepts of Invantive SQL such as databases, data containers and partitioning can be found in the Invantive SQL grammar.

The configuration can be changed using various attributes during log on and use. A full list of configuration options is listed in the driver attributes.

The catalog name is used to compose the full qualified name of an object like a table or view. The schema name is used to compose the full qualified name of an object like a table or view. On Teamleader the comparison of two texts is case sensitive by default.

Changes and bug fixes on the Teamleader SQL driver can be found in the release notes. There is currently no specific section on the Invantive forums for Teamleader. Please reach out to other users of Teamleader by leaving a question or contact request.

Driver code for use in settings.xml: Teamleader

Alias: teamleader

Recommended alias: tlr

More technical documentation as provided by the supplier of the Teamleader API on the native APIconnection used can be found at http://web.archive.org/web/20190913142304/https://apidocs.teamleader.eu/.

AuthenticationAuthentication 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 LimitsInvantive 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 FieldsCustom 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'.

12-12-2020 19:52 Version 20.1.301-BETA+3023