Please enable JavaScript to view this site.

Error itgendoc001X

xMsg javascript has not been loaded.

Simplicate API Data Model

Navigation: Schema: HRM > Tables

ContractById

 Contents Previous Home Next More

Fetches a single contract 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/contract/{id}

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

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

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

Field Selection Method: NotRequired

Base Path: data

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

Table Function Parameters

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

Name

Data Type

Label

Required

Documentation

contract_type_blocked

boolean

 

☐

 

contract_type_id

string

 

☐

 

contract_type_name

string

 

☐

 

created_at

string

Created at

☐

 

created

string

Created

☐

 

days_off

float

 

☐

 

employee_avatar_color

string

 

☐

 

employee_avatar_initials

string

 

☐

 

employee_avatar_url_large

string

 

☐

 

employee_avatar_url_small

string

 

☐

 

employee_bank_account

string

 

☐

 

employee_created_at

string

 

☐

 

employee_created

string

 

☐

 

employee_employment_status

string

 

☐

 

employee_function

string

 

☐

 

employee_hourly_cost_tariff

float

 

☐

 

employee_hourly_sales_tariff

float

 

☐

 

employee_id

string

Employee ID

☐

 

employee_is_user

boolean

 

☐

 

employee_marital_status

string

 

☐

 

employee_modified

string

 

☐

 

employee_name

string

 

☐

 

employee_person_address_country_code

string

 

☐

 

employee_person_address_country_id

string

 

☐

 

employee_person_address_country

string

 

☐

 

employee_person_address_id

string

 

☐

 

employee_person_address_line_1

string

 

☐

 

employee_person_address_line_2

string

 

☐

 

employee_person_address_locality

string

 

☐

 

employee_person_address_postal_code

string

 

☐

 

employee_person_address_province

string

 

☐

 

employee_person_address_type

string

 

☐

 

employee_person_avatar_color

string

 

☐

 

employee_person_avatar_initials

string

 

☐

 

employee_person_avatar_url_large

string

 

☐

 

employee_person_avatar_url_small

string

 

☐

 

employee_person_bank_account

string

 

☐

 

employee_person_bank_bic

string

 

☐

 

employee_person_created_at

string

 

☐

 

employee_person_date_of_birth

string

 

☐

 

employee_person_email

string

 

☐

 

employee_person_facebook_url

string

 

☐

 

employee_person_family_name_prefix

string

 

☐

 

employee_person_family_name

string

 

☐

 

employee_person_first_name

string

 

☐

 

employee_person_full_name

string

 

☐

 

employee_person_gender_id

string

 

☐

 

employee_person_gender

string

 

☐

 

employee_person_id_1

string

 

☐

 

employee_person_id

string

 

☐

 

employee_person_initials

string

 

☐

 

employee_person_invoice_receiver

string

 

☐

 

employee_person_linkedin_url

string

 

☐

 

employee_person_mailing_list_email

string

 

☐

 

employee_person_note

string

 

☐

 

employee_person_phone

string

 

☐

 

employee_person_relation_manager_avatar_color

string

 

☐

 

employee_person_relation_manager_avatar_initials

string

 

☐

 

employee_person_relation_manager_avatar_url_large

string

 

☐

 

employee_person_relation_manager_avatar_url_small

string

 

☐

 

employee_person_relation_manager_bank_account

string

 

☐

 

employee_person_relation_manager_created_at

string

 

☐

 

employee_person_relation_manager_created

string

 

☐

 

employee_person_relation_manager_employment_status

string

 

☐

 

employee_person_relation_manager_function

string

 

☐

 

employee_person_relation_manager_hourly_cost_tariff

float

 

☐

 

employee_person_relation_manager_hourly_sales_tariff

float

 

☐

 

employee_person_relation_manager_id

string

 

☐

 

employee_person_relation_manager_is_user

boolean

 

☐

 

employee_person_relation_manager_marital_status

string

 

☐

 

employee_person_relation_manager_modified

string

 

☐

 

employee_person_relation_manager_name

string

 

☐

 

employee_person_relation_manager_person_address_country_code

string

 

☐

 

employee_person_relation_manager_person_address_country_id

string

 

☐

 

employee_person_relation_manager_person_address_country

string

 

☐

 

employee_person_relation_manager_person_address_id

string

 

☐

 

employee_person_relation_manager_person_address_line_1

string

 

☐

 

employee_person_relation_manager_person_address_line_2

string

 

☐

 

employee_person_relation_manager_person_address_locality

string

 

☐

 

employee_person_relation_manager_person_address_postal_code

string

 

☐

 

employee_person_relation_manager_person_address_province

string

 

☐

 

employee_person_relation_manager_person_address_type

string

 

☐

 

employee_person_relation_manager_person_avatar_color

string

 

☐

 

employee_person_relation_manager_person_avatar_initials

string

 

☐

 

employee_person_relation_manager_person_avatar_url_large

string

 

☐

 

employee_person_relation_manager_person_avatar_url_small

string

 

☐

 

employee_person_relation_manager_person_bank_account

string

 

☐

 

employee_person_relation_manager_person_bank_bic

string

 

☐

 

employee_person_relation_manager_person_created_at

string

 

☐

 

employee_person_relation_manager_person_date_of_birth

string

 

☐

 

employee_person_relation_manager_person_email

string

 

☐

 

employee_person_relation_manager_person_facebook_url

string

 

☐

 

employee_person_relation_manager_person_family_name_prefix

string

 

☐

 

employee_person_relation_manager_person_family_name

string

 

☐

 

employee_person_relation_manager_person_first_name

string

 

☐

 

employee_person_relation_manager_person_full_name

string

 

☐

 

employee_person_relation_manager_person_gender_id

string

 

☐

 

employee_person_relation_manager_person_gender

string

 

☐

 

employee_person_relation_manager_person_id_1

string

 

☐

 

employee_person_relation_manager_person_id

string

 

☐

 

employee_person_relation_manager_person_initials

string

 

☐

 

employee_person_relation_manager_person_invoice_receiver

string

 

☐

 

employee_person_relation_manager_person_linkedin_url

string

 

☐

 

employee_person_relation_manager_person_mailing_list_email

string

 

☐

 

employee_person_relation_manager_person_note

string

 

☐

 

employee_person_relation_manager_person_phone

string

 

☐

 

employee_person_relation_manager_person_relation_manager_bank_account

string

 

☐

 

employee_person_relation_manager_person_relation_manager_created_at

string

 

☐

 

employee_person_relation_manager_person_relation_manager_created

string

 

☐

 

employee_person_relation_manager_person_relation_manager_employment_status

string

 

☐

 

employee_person_relation_manager_person_relation_manager_function

string

 

☐

 

employee_person_relation_manager_person_relation_manager_hourly_cost_tariff

float

 

☐

 

employee_person_relation_manager_person_relation_manager_hourly_sales_tariff

float

 

☐

 

employee_person_relation_manager_person_relation_manager_id

string

 

☐

 

employee_person_relation_manager_person_relation_manager_is_user

boolean

 

☐

 

employee_person_relation_manager_person_relation_manager_marital_status

string

 

☐

 

employee_person_relation_manager_person_relation_manager_modified

string

 

☐

 

employee_person_relation_manager_person_relation_manager_name

string

 

☐

 

employee_person_relation_manager_person_relation_manager_person_id

string

 

☐

 

employee_person_relation_manager_person_relation_manager_simplicate_url

string

 

☐

 

employee_person_relation_manager_person_relation_manager_social_security_number

string

 

☐

 

employee_person_relation_manager_person_relation_manager_timeline_email_address

string

 

☐

 

employee_person_relation_manager_person_relation_manager_updated_at

string

 

☐

 

employee_person_relation_manager_person_relation_manager_work_email

string

 

☐

 

employee_person_relation_manager_person_relation_manager_work_mobile

string

 

☐

 

employee_person_relation_manager_person_relation_manager_work_phone

string

 

☐

 

employee_person_relation_manager_person_relation_number

string

 

☐

 

employee_person_relation_manager_person_relation_type_color

string

 

☐

 

employee_person_relation_manager_person_relation_type_id

string

 

☐

 

employee_person_relation_manager_person_relation_type_label

string

 

☐

 

employee_person_relation_manager_person_relation_type_type

string

 

☐

 

employee_person_relation_manager_person_simplicate_url

string

 

☐

 

employee_person_relation_manager_person_timeline_email_address

string

 

☐

 

employee_person_relation_manager_person_twitter_url

string

 

☐

 

employee_person_relation_manager_person_updated_at

string

 

☐

 

employee_person_relation_manager_person_website_url

string

 

☐

 

employee_person_relation_manager_simplicate_url

string

 

☐

 

employee_person_relation_manager_social_security_number

string

 

☐

 

employee_person_relation_manager_status_id

string

 

☐

 

employee_person_relation_manager_status_label

string

 

☐

 

employee_person_relation_manager_timeline_email_address

string

 

☐

 

employee_person_relation_manager_type_id

string

 

☐

 

employee_person_relation_manager_type_label

string

 

☐

 

employee_person_relation_manager_updated_at

string

 

☐

 

employee_person_relation_manager_work_email

string

 

☐

 

employee_person_relation_manager_work_mobile

string

 

☐

 

employee_person_relation_manager_work_phone

string

 

☐

 

employee_person_relation_number

string

 

☐

 

employee_person_relation_type_color

string

 

☐

 

employee_person_relation_type_id

string

 

☐

 

employee_person_relation_type_label

string

 

☐

 

employee_person_relation_type_type

string

 

☐

 

employee_person_simplicate_url

string

 

☐

 

employee_person_timeline_email_address

string

 

☐

 

employee_person_twitter_url

string

 

☐

 

employee_person_updated_at

string

 

☐

 

employee_person_website_url

string

 

☐

 

employee_simplicate_url

string

 

☐

 

employee_social_security_number

string

 

☐

 

employee_status_id

string

 

☐

 

employee_status_label

string

 

☐

 

employee_timeline_email_address

string

 

☐

 

employee_type_id

string

 

☐

 

employee_type_label

string

 

☐

 

employee_updated_at

string

 

☐

 

employee_work_email

string

 

☐

 

employee_work_mobile

string

 

☐

 

employee_work_phone

string

 

☐

 

employer_id

string

 

☐

 

employer_name

string

 

☐

 

employment_type_blocked

boolean

 

☐

 

employment_type_id

string

 

☐

 

employment_type_name

string

 

☐

 

end_date

string

End Date

☐

 

id

string

ID

☐

 

last_updated

string

 

☐

 

parttime_percentage

float

 

☐

 

salary_fulltime

float

 

☐

 

start_date

string

Start Date

☐

 

updated_at

string

Updated at

☐

 

 

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