Teamleader Focus API Data Model
invoices: Teamleader Focus Invoices |
Catalog: Teamleader
Schema: V1
Primary Keys: id
Label: Invoices
This is a read-only table function. The Teamleader Focus API may not support changing the data or the Invantive UniversalSQL 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 invoices. 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 |
|---|---|---|---|---|
date_from |
datetime |
☑ |
01/01/0001 00:00:00 |
|
date_to |
datetime |
☑ |
01/01/9999 00:00:00 |
|
deep_search |
int32 |
☐ |
1 |
The default 1 selects both invoices related to the contact, but also for linked companies. 0 selects only invoices related to the contact. |
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 invoices are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
contact_or_company_id |
int32 |
Contact or Company ID |
☐ |
|
contact_or_company |
string |
Contact or Company |
☐ |
|
date_formatted |
string(20) |
Date (Formatted) |
☐ |
|
date_paid |
datetime |
Date Paid |
☐ |
|
date |
datetime |
Date |
☐ |
|
due_date_formatted |
string(20) |
Due Date (Formatted) |
☐ |
|
due_date |
datetime |
Due Date |
☐ |
|
entry_date_formatted |
string(20) |
Entry Date (Formatted) |
☐ |
|
for_attention_of |
string |
For Attention of |
☐ |
|
id |
int32 |
ID |
☑ |
|
incasso_interest_amount |
float |
Collection Interest Amount |
☐ |
|
incasso_recall_costs |
float |
|
☐ |
|
invoice_nr |
int32 |
Invoice Number |
☐ |
|
latest_activity_date_formatted |
string(20) |
Latest Activity Date (Formatted) |
☐ |
|
latest_activity_date |
datetime |
Latest Activity Date |
☐ |
|
name |
string |
Name |
☐ |
|
paid |
boolean |
Paid |
☑ |
|
structured_communication |
string |
Structured Communication |
☐ |
|
total_price_excl_vat |
float |
Total Price excl. VAT |
☐ |
|
total_price_incl_vat |
float |
Total Price incl. VAT |
☐ |
|
10-06-2024 18:37 Version 24.1.3-BETA+4689
