Teamleader API Data Model
companies: Teamleader Focus Companies |
Catalog: Teamleader
Schema: V1
Primary Keys: id
Label: Companies
This is a read-only table function. The Teamleader Focus API may not support changing the data or the Invantive SQL driver for Teamleader Focus does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Teamleader Focus API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function companies. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
filter_by_tag |
string |
☐ |
|
Select only contacts with this tag. |
modifiedsince |
datetime |
☐ |
|
Select contacts modified and/or added since this timestamp. |
searchby |
string |
☐ |
|
A search string. Teamleader will try to match each part of the string to the forename, surname, company name and email address. |
segment_id |
decimal |
☐ |
|
Select contacts with this segment ID. |
selected_customfields |
string |
☐ |
|
Comma-separated list of the IDs of the custom fields you wish to select with a maximum of 10. |
Columns of Table Function
The columns of the table function companies are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
bic |
string |
BIC Number |
☐ |
|
business_type |
string |
Business Type |
☐ |
|
city |
string |
City |
☐ |
|
country |
string |
Country |
☐ |
|
date_added |
datetime |
Date Added |
☐ |
|
date_edited |
datetime |
Date Edited |
☐ |
|
deleted |
boolean |
Deleted |
☑ |
|
string |
☐ |
|
||
fax |
string |
Fax |
☐ |
|
iban |
string |
IBAN Number |
☐ |
|
id |
int32 |
ID |
☑ |
|
language_code |
string |
Language Code |
☐ |
|
language_name |
string |
Language Name |
☐ |
|
name |
string |
Name |
☐ |
|
number |
string |
Number |
☐ |
|
payment_term |
string |
Payment Term |
☐ |
|
status |
string |
Status |
☐ |
|
street |
string |
Street |
☐ |
|
taxcode |
string |
Tax Code |
☐ |
|
telephone |
string |
Telephone |
☐ |
|
vat_liability |
string |
VAT Liability |
☐ |
|
website |
string |
Website |
☐ |
|
zipcode |
string(30) |
ZIP Code |
☐ |
|
22-12-2022 21:06 Version 22.1.101-BETA+3681
