Please enable JavaScript to view this site.

Error itgendoc001X

xMsg javascript has not been loaded.

Teamleader API Data Model

Navigation: Schema: V2 > Tables

InvoiceById

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

Table Function Parameters

The following parameters can be used to control the behaviour of the table function InvoiceById. 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 InvoiceById are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

created_at

datetime

 

☑

 

department_id

string

Department ID

☐

 

department_type

string

Department Type

☐

 

due_on

datetime

Due on

☐

 

id

string

ID

☑

 

invoice_date

datetime

Invoice Date

☐

 

invoice_number

string

Invoice Number

☐

 

invoicee_customer_id

string

Invoicee Customer ID

☑

 

invoicee_customer_type

string

Invoicee Customer Type

☑

 

invoicee_for_attention_of_contact_id

string

Invoice for Attention of Contact ID

☐

 

invoicee_for_attention_of_contact_type

string

Invoice for Attention of Contact Type

☐

 

invoicee_for_attention_of_name

string

Invoice for Attention of Name

☐

 

invoicee_name

string

Invoicee Name

☑

 

invoicee_vat_number

string

Invoicee VAT Number

☐

 

paid

boolean

Paid

☑

 

paid_at

datetime

Paid at

☐

 

payment_reference

string

 

☐

 

purchase_order_number

string

 

☐

 

sent

boolean

 

☑

 

status

string

Status

☑

 

total_due_amount

decimal

Total Due Amount

☐

 

total_due_currency

string

Currency of Total Due Amount

☐

 

total_payable_amount

decimal

Total Payable Amount

☐

 

total_payable_currency

string

Currency of Total Payable Amount

☐

 

total_tax_exclusive_amount

decimal

Total Amount excluding Taxes

☐

 

total_tax_exclusive_currency

string

Currency of Total Amount excluding Taxes

☐

 

total_tax_inclusive_amount

decimal

Total Amount including Taxes

☐

 

total_tax_inclusive_currency

string

Currency of Total Amount including Taxes

☐

 

updated_at

datetime

Updated At

☑

 

 

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