Error itgendoc001X
xMsg javascript has not been loaded.
Teamleader API Data ModelCatalog: Teamleader
Schema: V1
Primary Keys: id
Label: Credit Invoices
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: getCreditnotes.php
Insert Teamleader API URL: getCreditnotes.php
Update Teamleader API URL: getCreditnotes.php
Delete Teamleader API URL: getCreditnotes.php
Field Selection Method: NotRequired
Table Function Parameters
The following parameters can be used to control the behaviour of the table function creditnotes. 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 |
|---|---|---|---|---|
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. |
Table Function Columns
The columns of the table function creditnotes are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
contact_or_company |
string |
Contact or Company |
☐ |
|
contact_or_company_id |
int32 |
Contact or Company ID |
☐ |
|
creditnote_nr |
int32 |
Credit Note Number |
☐ |
|
creditnote_nr_detailed |
string |
Credit Note Number (Formatted) |
☐ |
|
date |
datetime |
Date |
☐ |
|
date_formatted |
string(20) |
Date (Formatted) |
☐ |
|
date_paid |
datetime |
Date Paid |
☐ |
|
due_date |
datetime |
Due Date |
☐ |
|
due_date_formatted |
string(20) |
Due Date (Formatted) |
☐ |
|
id |
int32 |
ID |
☑ |
|
name |
string |
Name |
☐ |
|
paid |
boolean |
Paid |
☑ |
|
related_invoice_id |
int32 |
Related Invoice ID |
☐ |
|
total_price_excl_vat |
float |
Total Price excl. VAT |
☐ |
|
total_price_incl_vat |
float |
Total Price incl. VAT |
☐ |
|
12-12-2020 19:52 Version 20.1.301-BETA+3023
