Teamleader Focus API Data Model
CreditNoteLinesByCreditNoteId |
Catalog: Teamleader
Schema: V2
Primary Keys: id
Label: {res:itgen_teamleader_credit_note_lines_by_id}
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 CreditNoteLinesByCreditNoteId. 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 |
|---|---|---|---|---|
id |
string |
☑ |
|
|
Columns of Table Function
The columns of the table function CreditNoteLinesByCreditNoteId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
credit_note_id |
string |
{res:itgen_teamleader_credit_note_id} |
☑ |
|
currency_exchange_rate_from |
string |
{res:itgen_teamleader_currency_exchange_rate_from} |
☐ |
|
currency_exchange_rate_rate |
decimal |
{res:itgen_teamleader_currency_exchange_rate_rate} |
☐ |
|
currency_exchange_rate_to |
string |
{res:itgen_teamleader_currency_exchange_rate_to} |
☐ |
|
currency |
string |
Currency |
☐ |
|
description |
string |
Description |
☐ |
|
discount_type |
string |
Discount Type |
☐ |
|
discount_value |
decimal |
Discount Value |
☐ |
|
extended_description |
string |
Extended Description |
☐ |
|
group_section_title |
string |
{res:itgen_teamleader_group_section_title} |
☐ |
|
product_category_id |
string |
Product Category ID |
☐ |
|
product_category_type |
string |
Product Category Type |
☐ |
|
product_id |
string |
Product ID |
☐ |
|
product_type |
string |
Product Type |
☐ |
|
quantity |
decimal |
Quantity |
☐ |
|
tax_id |
string |
Tax ID |
☐ |
|
tax_type |
string |
Tax Type |
☐ |
|
total_tax_exclusive_amount |
decimal |
Total Amount excluding Taxes |
☐ |
|
total_tax_exclusive_before_discount_amount |
decimal |
Total Tax Exclusive before Discount Amount |
☐ |
|
total_tax_exclusive_before_discount_currency |
string |
Total Tax Exclusive before Discount Currency |
☐ |
|
total_tax_exclusive_currency |
string |
Currency of Total Amount excluding Taxes |
☐ |
|
total_tax_inclusive_amount |
decimal |
Total Amount including Taxes |
☐ |
|
total_tax_inclusive_before_discount_amount |
decimal |
Total Tax Inclusive before Discount Amount |
☐ |
|
total_tax_inclusive_before_discount_currency |
string |
Total Tax Inclusive before Discount Currency |
☐ |
|
total_tax_inclusive_currency |
string |
Currency of Total Amount including Taxes |
☐ |
|
unit_currency |
string |
Unit Currency |
☐ |
|
unit_id |
string |
Unit ID |
☐ |
|
unit_price_amount |
decimal |
Unit Price Amount |
☐ |
|
unit_tax |
string |
Unit Tax |
☐ |
|
unit_type |
string |
Unit Type |
☐ |
|
10-09-2024 14:03 Version 24.1.8-BETA+4877
