Please enable JavaScript to view this site.

Error itgendoc001X

xMsg javascript has not been loaded.

Simplicate API Data Model

Navigation: Schema: HRM > Tables

EmployeeById

 Contents Previous Home Next More

Fetches a single employee by id

Catalog: Simplicate

Schema: HRM

This is a read-only table function. The Simplicate API may not support changing the data or the Invantive SQL driver for Simplicate does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Simplicate API.

Select Simplicate API URL: /hrm/employee/{id}

Insert Simplicate API URL: /hrm/employee/{id}

Update Simplicate API URL: /hrm/employee/{id}

Delete Simplicate API URL: /hrm/employee/{id}

Field Selection Method: NotRequired

Base Path: data

Select Simplicate API Operation: get /hrm/employee/{id}

Table Function Parameters

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

☑

 

The template's id

 

Table Function Columns

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

Name

Data Type

Label

Required

Documentation

avatar_color

string

 

☐

 

avatar_initials

string

 

☐

 

avatar_url_large

string

 

☐

 

avatar_url_small

string

 

☐

 

bank_account

string

Bank Account

☐

 

created_at

string

Created at

☐

 

created

string

Created

☐

 

employment_status

string

 

☐

 

function

string

 

☐

 

hourly_cost_tariff

float

 

☐

 

hourly_sales_tariff

float

 

☐

 

id

string

ID

☐

 

is_user

boolean

 

☐

 

marital_status

string

 

☐

 

modified

string

Modified

☐

 

name

string

Name

☐

 

person_address_country_code

string

 

☐

 

person_address_country_id

string

 

☐

 

person_address_country

string

 

☐

 

person_address_id

string

 

☐

 

person_address_line_1

string

 

☐

 

person_address_line_2

string

 

☐

 

person_address_locality

string

 

☐

 

person_address_postal_code

string

 

☐

 

person_address_province

string

 

☐

 

person_address_type

string

 

☐

 

person_avatar_color

string

 

☐

 

person_avatar_initials

string

 

☐

 

person_avatar_url_large

string

 

☐

 

person_avatar_url_small

string

 

☐

 

person_bank_account

string

 

☐

 

person_bank_bic

string

 

☐

 

person_created_at

string

 

☐

 

person_date_of_birth

string

 

☐

 

person_email

string

 

☐

 

person_facebook_url

string

 

☐

 

person_family_name_prefix

string

 

☐

 

person_family_name

string

 

☐

 

person_first_name

string

 

☐

 

person_full_name

string

 

☐

 

person_gender_id

string

 

☐

 

person_gender

string

 

☐

 

person_id_1

string

 

☐

 

person_id

string

Person ID

☐

 

person_initials

string

 

☐

 

person_invoice_receiver

string

 

☐

 

person_linkedin_url

string

 

☐

 

person_mailing_list_email

string

 

☐

 

person_note

string

 

☐

 

person_phone

string

 

☐

 

person_relation_manager_avatar_color

string

 

☐

 

person_relation_manager_avatar_initials

string

 

☐

 

person_relation_manager_avatar_url_large

string

 

☐

 

person_relation_manager_avatar_url_small

string

 

☐

 

person_relation_manager_bank_account

string

 

☐

 

person_relation_manager_created_at

string

 

☐

 

person_relation_manager_created

string

 

☐

 

person_relation_manager_employment_status

string

 

☐

 

person_relation_manager_function

string

 

☐

 

person_relation_manager_hourly_cost_tariff

float

 

☐

 

person_relation_manager_hourly_sales_tariff

float

 

☐

 

person_relation_manager_id

string

 

☐

 

person_relation_manager_is_user

boolean

 

☐

 

person_relation_manager_marital_status

string

 

☐

 

person_relation_manager_modified

string

 

☐

 

person_relation_manager_name

string

 

☐

 

person_relation_manager_person_address_country_code

string

 

☐

 

person_relation_manager_person_address_country_id

string

 

☐

 

person_relation_manager_person_address_country

string

 

☐

 

person_relation_manager_person_address_id

string

 

☐

 

person_relation_manager_person_address_line_1

string

 

☐

 

person_relation_manager_person_address_line_2

string

 

☐

 

person_relation_manager_person_address_locality

string

 

☐

 

person_relation_manager_person_address_postal_code

string

 

☐

 

person_relation_manager_person_address_province

string

 

☐

 

person_relation_manager_person_address_type

string

 

☐

 

person_relation_manager_person_avatar_color

string

 

☐

 

person_relation_manager_person_avatar_initials

string

 

☐

 

person_relation_manager_person_avatar_url_large

string

 

☐

 

person_relation_manager_person_avatar_url_small

string

 

☐

 

person_relation_manager_person_bank_account

string

 

☐

 

person_relation_manager_person_bank_bic

string

 

☐

 

person_relation_manager_person_created_at

string

 

☐

 

person_relation_manager_person_date_of_birth

string

 

☐

 

person_relation_manager_person_email

string

 

☐

 

person_relation_manager_person_facebook_url

string

 

☐

 

person_relation_manager_person_family_name_prefix

string

 

☐

 

person_relation_manager_person_family_name

string

 

☐

 

person_relation_manager_person_first_name

string

 

☐

 

person_relation_manager_person_full_name

string

 

☐

 

person_relation_manager_person_gender_id

string

 

☐

 

person_relation_manager_person_gender

string

 

☐

 

person_relation_manager_person_id_1

string

 

☐

 

person_relation_manager_person_id

string

 

☐

 

person_relation_manager_person_initials

string

 

☐

 

person_relation_manager_person_invoice_receiver

string

 

☐

 

person_relation_manager_person_linkedin_url

string

 

☐

 

person_relation_manager_person_mailing_list_email

string

 

☐

 

person_relation_manager_person_note

string

 

☐

 

person_relation_manager_person_phone

string

 

☐

 

person_relation_manager_person_relation_manager_avatar_color

string

 

☐

 

person_relation_manager_person_relation_manager_avatar_initials

string

 

☐

 

person_relation_manager_person_relation_manager_avatar_url_large

string

 

☐

 

person_relation_manager_person_relation_manager_avatar_url_small

string

 

☐

 

person_relation_manager_person_relation_manager_bank_account

string

 

☐

 

person_relation_manager_person_relation_manager_created_at

string

 

☐

 

person_relation_manager_person_relation_manager_created

string

 

☐

 

person_relation_manager_person_relation_manager_employment_status

string

 

☐

 

person_relation_manager_person_relation_manager_function

string

 

☐

 

person_relation_manager_person_relation_manager_hourly_cost_tariff

float

 

☐

 

person_relation_manager_person_relation_manager_hourly_sales_tariff

float

 

☐

 

person_relation_manager_person_relation_manager_id

string

 

☐

 

person_relation_manager_person_relation_manager_is_user

boolean

 

☐

 

person_relation_manager_person_relation_manager_marital_status

string

 

☐

 

person_relation_manager_person_relation_manager_modified

string

 

☐

 

person_relation_manager_person_relation_manager_name

string

 

☐

 

person_relation_manager_person_relation_manager_person_bank_account

string

 

☐

 

person_relation_manager_person_relation_manager_person_bank_bic

string

 

☐

 

person_relation_manager_person_relation_manager_person_created_at

string

 

☐

 

person_relation_manager_person_relation_manager_person_date_of_birth

string

 

☐

 

person_relation_manager_person_relation_manager_person_email

string

 

☐

 

person_relation_manager_person_relation_manager_person_facebook_url

string

 

☐

 

person_relation_manager_person_relation_manager_person_family_name_prefix

string

 

☐

 

person_relation_manager_person_relation_manager_person_family_name

string

 

☐

 

person_relation_manager_person_relation_manager_person_first_name

string

 

☐

 

person_relation_manager_person_relation_manager_person_full_name

string

 

☐

 

person_relation_manager_person_relation_manager_person_gender_id

string

 

☐

 

person_relation_manager_person_relation_manager_person_gender

string

 

☐

 

person_relation_manager_person_relation_manager_person_id_1

string

 

☐

 

person_relation_manager_person_relation_manager_person_id

string

 

☐

 

person_relation_manager_person_relation_manager_person_initials

string

 

☐

 

person_relation_manager_person_relation_manager_person_invoice_receiver

string

 

☐

 

person_relation_manager_person_relation_manager_person_linkedin_url

string

 

☐

 

person_relation_manager_person_relation_manager_person_mailing_list_email

string

 

☐

 

person_relation_manager_person_relation_manager_person_note

string

 

☐

 

person_relation_manager_person_relation_manager_person_phone

string

 

☐

 

person_relation_manager_person_relation_manager_person_relation_number

string

 

☐

 

person_relation_manager_person_relation_manager_person_simplicate_url

string

 

☐

 

person_relation_manager_person_relation_manager_person_timeline_email_address

string

 

☐

 

person_relation_manager_person_relation_manager_person_twitter_url

string

 

☐

 

person_relation_manager_person_relation_manager_person_updated_at

string

 

☐

 

person_relation_manager_person_relation_manager_person_website_url

string

 

☐

 

person_relation_manager_person_relation_manager_simplicate_url

string

 

☐

 

person_relation_manager_person_relation_manager_social_security_number

string

 

☐

 

person_relation_manager_person_relation_manager_status_id

string

 

☐

 

person_relation_manager_person_relation_manager_status_label

string

 

☐

 

person_relation_manager_person_relation_manager_timeline_email_address

string

 

☐

 

person_relation_manager_person_relation_manager_type_id

string

 

☐

 

person_relation_manager_person_relation_manager_type_label

string

 

☐

 

person_relation_manager_person_relation_manager_updated_at

string

 

☐

 

person_relation_manager_person_relation_manager_work_email

string

 

☐

 

person_relation_manager_person_relation_manager_work_mobile

string

 

☐

 

person_relation_manager_person_relation_manager_work_phone

string

 

☐

 

person_relation_manager_person_relation_number

string

 

☐

 

person_relation_manager_person_relation_type_color

string

 

☐

 

person_relation_manager_person_relation_type_id

string

 

☐

 

person_relation_manager_person_relation_type_label

string

 

☐

 

person_relation_manager_person_relation_type_type

string

 

☐

 

person_relation_manager_person_simplicate_url

string

 

☐

 

person_relation_manager_person_timeline_email_address

string

 

☐

 

person_relation_manager_person_twitter_url

string

 

☐

 

person_relation_manager_person_updated_at

string

 

☐

 

person_relation_manager_person_website_url

string

 

☐

 

person_relation_manager_simplicate_url

string

 

☐

 

person_relation_manager_social_security_number

string

 

☐

 

person_relation_manager_status_id

string

 

☐

 

person_relation_manager_status_label

string

 

☐

 

person_relation_manager_timeline_email_address

string

 

☐

 

person_relation_manager_type_id

string

 

☐

 

person_relation_manager_type_label

string

 

☐

 

person_relation_manager_updated_at

string

 

☐

 

person_relation_manager_work_email

string

 

☐

 

person_relation_manager_work_mobile

string

 

☐

 

person_relation_manager_work_phone

string

 

☐

 

person_relation_number

string

 

☐

 

person_relation_type_color

string

 

☐

 

person_relation_type_id

string

 

☐

 

person_relation_type_label

string

 

☐

 

person_relation_type_type

string

 

☐

 

person_simplicate_url

string

 

☐

 

person_timeline_email_address

string

 

☐

 

person_twitter_url

string

 

☐

 

person_updated_at

string

 

☐

 

person_website_url

string

 

☐

 

simplicate_url

string

Simplicate URL

☐

 

social_security_number

string

 

☐

 

status_id

string

 

☐

 

status_label

string

 

☐

 

timeline_email_address

string

 

☐

 

type_id

string

 

☐

 

type_label

string

 

☐

 

updated_at

string

Updated at

☐

 

work_email

string

 

☐

 

work_mobile

string

 

☐

 

work_phone

string

 

☐

 

 

06-04-2021 14:59 Version 20.1.393-BETA+3152