Please enable JavaScript to view this site.

Error itgendoc001X

xMsg javascript has not been loaded.

Teamleader API Data Model

Navigation: Schema: V2 > Tables

InvoiceLinesById

Contents Previous Home Next More

Catalog: Teamleader

Schema: V2

Primary Keys: id

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: invoices.info

Insert Teamleader API URL: invoices.info

Update Teamleader API URL: invoices.info

Delete Teamleader API URL: invoices.info

Field Selection Method: NotRequired

Base Path: grouped_lines[*].line_items[*]

Table Function Parameters

The following parameters can be used to control the behaviour of the table function InvoiceLinesById. 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

id

string

 

 

 

Table Function Columns

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

Name

Data Type

Label

Required

Documentation

description

string

Description

 

discount_type

string

 

 

discount_value

decimal

 

 

extended_description

string

 

 

group_section_title

string

 

 

invoice_date

datetime

Invoice Date

 

invoice_due_on

datetime

 

 

invoice_id

string

Invoice ID

 

invoice_number

string

Invoice Number

 

invoice_paid

boolean

 

 

invoice_paid_at

datetime

 

 

invoice_payment_reference

string

 

 

invoice_purchase_order_number

string

 

 

invoice_sent

boolean

 

 

invoice_status

string

 

 

product_category_id

string

 

 

product_category_type

string

 

 

product_id

string

 

 

product_type

string

 

 

quantity

decimal

 

 

tax_id

string

 

 

tax_type

string

 

 

total_tax_exclusive_amount

decimal

Total Amount excluding Taxes

 

total_tax_exclusive_before_discount_amount

decimal

 

 

total_tax_exclusive_before_discount_currency

string

 

 

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_currency

string

 

 

total_tax_inclusive_currency

string

Currency of Total Amount including Taxes

 

unit_currency

string

 

 

unit_price_amount

decimal

 

 

unit_tax

string

 

 

 

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