v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB

Employees > Employee

Create with contracts an Employee

Create an employee with a contract

post/api/2026-07-01/resources/employees/employees/create_with_contract

Request body

company_idstring required

company id of the employee, you can get it in companies/legal_entities endpoint.

first_namestring required

name of the employee.

last_namestring required

last name of the employee.

emailstring required

personal email of the employee.

contract_effective_onstring

the day the specific contract starts, in case of hiring the same than contract_starts_on.

contract_starts_onstring

the day the employee is hired.

ends_onstring

the day the contract ends.

genderstring

gender of the employee (male | female).

identifierstring

national identifier number.

identifier_typestring

type of identifier (ex passport).

identifier_expiration_datestring

identifier expiration date.

birthday_onstring

birthday of the employee.

nationalitystring

nationality country code of the employee (Spain ES, United Kingdom GB).

address_line1string

address of the employee.

address_line_2string

address of the employee.

postal_codestring

postal code of the employee.

citystring

city of the employee.

statestring

state/province/region of the employee.

countrystring

country code of the employee (Spain ES, United Kingdom GB).

bank_numberstring

bank account number of the employee.

swift_bicstring

code to identify banks and financial institutions globally.

manager_idstring

id of manager, you can get the manager_id from employees endpoint.

timeoff_manager_idstring

id of manager, you can get the manager_id from employees endpoint.

legal_entity_idstring

legal entity of the employee, references to companies/legal_entities.

company_identifierstring

identity number or string used inside a company to internally identify the employee.

seniority_calculation_datestring

date since when the employee is working in the company.

job_catalog_tree_node_uuidstring

the uuid of nodes in the job catalog tree. For now it only supports level nodes. From this point in the job catalog tree you can get the full ancestor path to the root node including the role. Refer to job_catalog/tree_nodes endpoint.

team_idstring

team id of the employee.

location_idstring

location id of the employee, references to locations/locations.

social_security_numberstring

social security number of the employee.

has_trial_periodboolean

does the employee have a trial period?

trial_period_ends_onstring

when the trial period ends.

contact_namestring

name of the emergency contact.

contact_numberstring

phone number of the emergency contact.

phone_numberstring

phone number of the employee.

a3_innuva_codestring

A3Innuva employee code.

a3_nom_codestring

A3Nom employee code.

contracts_bank_holiday_treatment'workable' | 'non_workable'

Defines whether a bank holiday should be considered as a workable or non-workable day.

contracts_annual_working_time_distribution'limit_workdays' | 'limit_daily_hours'

the annual working time distribution of the employee.

contracts_working_time_percentage_in_centsinteger

Working time percentage in cents (e.g., when an employee is working part-time, the percentage of full-time hours they are working).

contracts_max_legal_yearly_hoursinteger

the maximum amount of hours the employee can work in a year.

contracts_maximum_weekly_hoursinteger

the maximum amount of hours the employee can work in a week.

Example request

{
  "company_id": "1",
  "first_name": "Ana",
  "last_name": "Blanco Perez",
  "email": "ana@factorial.com",
  "contract_effective_on": "2024-10-06",
  "contract_starts_on": "2024-10-06",
  "ends_on": "2024-10-06",
  "gender": "female",
  "identifier": "QKG587532Y",
  "identifier_type": "passport",
  "identifier_expiration_date": "2023-12-31",
  "birthday_on": "1990-06-06",
  "nationality": "ES",
  "address_line1": "Calle Adaro 10 1 A",
  "address_line_2": "Calle Adaro 10 1 A",
  "city": "Santander",
  "state": "Cantabria",
  "country": "es",
  "bank_number": "ES6220809324751871912999",
  "swift_bic": "CAGLES2M510",
  "manager_id": "1",
  "timeoff_manager_id": "1",
  "legal_entity_id": "1",
  "company_identifier": "bb9d281e",
  "seniority_calculation_date": "2024-10-07",
  "job_catalog_tree_node_uuid": "jobcatalog_treelevel-14",
  "team_id": "1",
  "location_id": "1",
  "has_trial_period": true,
  "trial_period_ends_on": "2024-10-06",
  "contact_name": "Laura Delgado",
  "contact_number": "647384950",
  "phone_number": "657483987",
  "a3_innuva_code": "35600",
  "a3_nom_code": "45600",
  "contracts_bank_holiday_treatment": "workable",
  "contracts_annual_working_time_distribution": "limit_daily_hours",
  "contracts_working_time_percentage_in_cents": 8000,
  "contracts_max_legal_yearly_hours": 18000,
  "contracts_maximum_weekly_hours": 400
}

Response

idstring required

id of the employee.

access_idstring required

access_id associated to the employee.

first_namestring required

name of the employee.

last_namestring required

last name of the employee.

full_namestring required

full name of the employee.

preferred_namestring

nickname of the employee or a name that defines the employee better.

birth_namestring

Birthname of the employee.

genderstring

gender of the employee (male | female).

identifierstring

national identifier number.

identifier_typestring

type of identifier (ex passport).

emailstring

personal email of the employee.

login_emailstring

email associated to the session.

birthday_onstring

birthday of the employee.

nationalitystring

nationality country code of the employee (Spain ES, United Kingdom GB).

address_line_1string

address of the employee.

address_line_2string

secondary address of the employee.

postal_codestring

postal code of the employee.

citystring

city of the employee.

statestring

state/province/region of the employee.

countrystring

country code of the employee (Spain ES, United Kingdom GB).

bank_numberstring

bank account number of the employee.

swift_bicstring

code to identify banks and financial institutions globally.

bank number format.

company_idstring required

id of the company to which the employee belongs (not editable).

legal_entity_idstring

legal entity of the employee, references to companies/legal_entities.

location_idstring required

location id of the employee, references to locations/locations.

default_work_area_idstring

Default work area ID for the employee at the default workplace. References locations/work_areas.

created_atstring required

creation date of the employee.

updated_atstring required

date of last modification of the employee

social_security_numberstring

social security number of the employee.

is_terminatingboolean required

is the employee being terminated?

terminated_onstring

termination date of the employee.

termination_reason_typestring

termination reason type of the employee

termination_reasonstring

A reason for the termination.

termination_observationsstring

observations about the termination.

manager_idstring

manager id of the employee, you can get the manager id from employees endpoint.

timeoff_manager_idstring

Timeoff manager id of the employee.

phone_numberstring

phone number of the employee.

company_identifierstring

identity number or string used inside a company to internally identify the employee.

age_numberinteger

age of the employee.

termination_type_descriptionstring

The description of the termination type.

contact_namestring

name of the employee contact.

contact_numberstring

phone number of the employee contact .

personal_emailstring

personal email of the employee.

seniority_calculation_datestring

date since when the employee is working in the company.

communications_emailstring

Confirmed email address for company communications and notifications. Separate from login email, used for internal company announcements.

unconfirmed_communications_emailstring

unconfirmed communications email address for the employee.

pronounsstring

pronouns that an employee uses to define themselves.

activeboolean

status of the employee, true when active, false when terminated.

disability_percentage_centsinteger

officially certified level of disability granted by public administration for individuals with physical or mental impairments, expressed in cents

identifier_expiration_datestring

identifier expiration date

attendableboolean required

employee included in a time tracking policy.

country_of_birthstring

Country of birth of the employee.

birthplacestring

Birthplace of the employee.

Example response

{
  "id": "2",
  "access_id": "1",
  "first_name": "Ana",
  "last_name": "Blanco Perez",
  "full_name": "Ana Blanco Perez",
  "preferred_name": "Anita",
  "birth_name": "Anna",
  "gender": "female",
  "identifier": "QKG587532Y",
  "identifier_type": "passport",
  "email": "ana@factorial.com",
  "login_email": "ana@factorial.com",
  "birthday_on": "1990-06-06",
  "nationality": "es",
  "address_line_1": "Calle Adaro 10 1 A",
  "address_line_2": "Calle Adaro 10 1 A",
  "postal_code": "27004",
  "city": "Santander",
  "state": "Cantabria",
  "country": "es",
  "bank_number": "ES6220809324751871912999",
  "swift_bic": "CAGLES2M510",
  "bank_number_format": "iban",
  "company_id": "1",
  "legal_entity_id": "1",
  "location_id": "1",
  "default_work_area_id": "1",
  "created_at": "2010-10-06T00:00:00.000Z",
  "updated_at": "2024-10-06T00:00:00.000Z",
  "social_security_number": "150126298420",
  "terminated_on": "2024-10-06",
  "termination_reason_type": "others",
  "termination_reason": "The employee has left the company",
  "termination_observations": "Ana has been working on this project before she left",
  "manager_id": "1",
  "timeoff_manager_id": "1",
  "phone_number": "657483987",
  "company_identifier": "bb9d281e",
  "age_number": 30,
  "termination_type_description": "Baja voluntaria/Dimisión",
  "contact_name": "Laura Delgado",
  "contact_number": "647384950",
  "personal_email": "ana@factorial.com",
  "seniority_calculation_date": "2024-10-07",
  "communications_email": "employee@company.com",
  "unconfirmed_communications_email": "new-email@example.com",
  "pronouns": "She/Her",
  "active": true,
  "disability_percentage_cents": 1200,
  "identifier_expiration_date": "2023-12-31",
  "attendable": true,
  "country_of_birth": "Spain",
  "birthplace": "Barcelona"
}