invantive documentation
Invantive Support ForumsLog In / Sign Up

Companies: Teamleader Focus Companies

popular read only REST

  • Catalog: Teamleader
  • Schema: V2
  • Primary Keys: id
  • Label: Companies

Can only retrieve data.

API Source

  • Endpoint: companies.list

Performance Characteristics

Characteristic Value
Average access latency (ms) 39

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
company_id ``
term `` Filters on first_name, last_name, email and telephone.
updated_since date
vat_number ``

Table Columns

The columns of the table Companies are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
added_at datetime Added At filters on the platform, writable
bic varchar2 BIC Number filters on the platform, writable
business_type_id varchar2 Business Type ID filters on the platform, writable, business_type.id
business_type_type varchar2 Business Type filters on the platform, writable, business_type.type
c_regio varchar2 itgen_teamleader_c_regio filters on the platform, writable
c_test varchar2 itgen_teamleader_c_test filters on the platform, writable
c_transport_2020 int32 itgen_teamleader_c_transport_2020 filters on the platform, writable
iban varchar2 IBAN Number filters on the platform, writable
id varchar2 ID filters on the platform, writable
invoicing_preferences_electronic_invoicing_address varchar2 Invoicing Preferences Electronic Invoicing Address filters on the platform, writable, invoicing_preferences.electronic_invoicing_address
language varchar2 Language filters on the platform, writable
local_business_number varchar2 Local Business Number filters on the platform, writable Also known as Chamber of Commerce number in many countries.
name varchar2 Name filters on the platform, writable
national_identification_number varchar2 National Identification Number filters on the platform, writable Also known as Chamber of Commerce number in many countries.
payment_term_days decimal Payment Term (days) filters on the platform, writable, payment_term.days
payment_term_type varchar2 Payment Term Type filters on the platform, writable, payment_term.type
preferred_currency varchar2 Preferred Currency filters on the platform, writable
primary_address_city varchar2 Primary Address City filters on the platform, writable, primary_address.city
primary_address_country varchar2 Primary Address Country filters on the platform, writable, primary_address.country
primary_address_line_1 varchar2 Primary Address Line 1 filters on the platform, writable, primary_address.line_1
primary_address_postal_code varchar2 Primary Address Postal Code filters on the platform, writable, primary_address.postal_code
responsible_user_id varchar2 Responsible User ID filters on the platform, writable, responsible_user.id
responsible_user_type varchar2 Responsible User Type filters on the platform, writable, responsible_user.type
status varchar2 Status filters on the platform, writable
updated_at datetime Updated At filters on the platform, writable
vat_number varchar2 VAT Number filters on the platform, writable VAT number.
web_url varchar2 Web (URL) filters on the platform, writable
website varchar2 Website filters on the platform, writable

Keys

Key Column Refers to Kind Description
Companies_business_type_id_fk business_type_id BusinessTypes.id Key
Companies_responsible_user_id_fk responsible_user_id Users.id Key

Referenced By

Sample Queries

--
-- List of companies with all detail and custom fields. Very slow, with solely 1 row per second over prolonged periods of time.
--
-- Table documentation: https://documentation.invantive.eu/2017R2/teamleader-data-model/webhelp/teamleader-focus-connector-v2flat-companiesall.html
--
-- Related forum post: https://forums.invantive.eu/t/what-are-table-functions-and-table-function-parameters/1868
--
select *
from   Teamleader.V2Flat.CompaniesAll@tlr
limit  100

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: