Please enable JavaScript to view this site.

Error itgendoc001X

xMsg javascript has not been loaded.

Teamleader API Data Model

Navigation: Schema: V1 > Tables

deals: Teamleader Deals

Contents Previous Home Next More

Catalog: Teamleader

Schema: V1

Primary Keys: id

Label: Deals

This is a read-only table function. The Teamleader API may not support changing the data or the Invantive SQL driver for Teamleader does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Teamleader API.

Select Teamleader API URL: getDeals.php

Insert Teamleader API URL: getDeals.php

Update Teamleader API URL: getDeals.php

Delete Teamleader API URL: getDeals.php

Field Selection Method: NotRequired

Table Function Parameters

The following parameters can be used to control the behaviour of the table function deals. 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 treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `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_phase_id

decimal

 

Select only deals with this phase ID.

searchby

string

 

Selects deals matching this search string.

segment_id

decimal

 

Select deals 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.

 

Table Function Columns

The columns of the table function deals are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

close_date

datetime

Close Date

 

close_date_formatted

string(20)

Close Date (Formatted)

 

date_lost

datetime

Date Lost

 

date_lost_formatted

string(20)

Date Lost (Formatted)

 

entry_date

datetime

Entry Date

 

entry_date_formatted

string(20)

Entry Date (Formatted)

 

for

string

Concerns

 

for_id

int32

ID of Concerns

 

id

int32

ID

 

latest_activity_date

datetime

Latest Activity Date

 

latest_activity_date_formatted

string(20)

Latest Activity Date (Formatted)

 

phase_id

int32

Phase ID

 

probability

int32

Probability

 

quotation_nr

int32

Quotation Number

 

reason_refused

string

Reason Refused

 

responsible_user_id

int32

Responsible User ID

 

source_id

int32

Source ID

 

title

string(80)

Title

 

total_price_excl_vat

decimal

Total Price excl. VAT

 

 

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