Factorial

Deletes a Webhook subscription

Deletes an Application

Deletes a candidate from the ATS

This endpoint allows to delete a specific feedback entry associated with a candidate's application.

Delete a job posting.

Deletes a Question

Deletes an edit timesheet.

Deletes an Overtime request

Deletes a Shift

Deletes a Compensation

Deletes a Contract version

Deletes a Field

Deletes a Document

Deletes a Cost center

Deletes an It asset

Deletes a Location

Reads Payroll employee identifier codes, current countries supported are Portugal, Italy and Germany

Deletes a Code

Deletes a Supplement

Remove an owner from a review process. The review process must have at least one owner.

Delete a participant from the active review process. This will also remove all previously submitted evaluations about the participant.

Delete an existing review process.

Deletes a Comment

Deletes a Group

Deletes a Post

Deletes a Budget strategy

Deletes a Planned record

###### **What does it do?** This deletes a subproject. ###### **Who can use it?** Only companies who have enabled the `projects_with_subprojects` feature and users with a role in the project owning the subproject.

Deletes a Time record

Deletes a Shift

Deletes a Task file

This endpoint deletes a task.

Delete the membership to remove the employee from the team.

Delete a team

Deletes a Planning version

Deletes an allowance incidence

Deletes an allowance

Deletes a blocked period

Deletes a Leave

Deletes a Policy

Delete a Time off Policy Assignment

Deletes a Category

Deletes a Session

Deletes a Training class

Deletes a Training

Deletes an Overlap period

Reads all Credentials

Reads all Webhook subscriptions

Reads a single Webhook subscription

Reads all Answers

Reads a single Answer

Reads all Application phases

Reads a single Application phase

Reads all Applications

Reads a single Application

Reads all Candidate sources

Reads a single Candidate source

Fetches candidates data from Factorial. When using administrator-level API Credentials, all candidates associated with a company will be returned. When using non-admin level API credentials, only candidates that applied to a job for which the user is a hiring manager will be returned.

Fetches candidates data from Factorial. When using administrator-level API Credentials, all candidates associated with a company will be returned. When using non-admin level API credentials, only candidates that applied to a job for which the user is a hiring manager will be returned.

Reads all Evaluation forms

Reads a single Evaluation form

This endpoint retrieves all feedbacks associated with a candidate's applications.

This endpoint retrieves all feedbacks associated with a candidate's applications.

Reads all Hiring stages

Reads a single Hiring stage

Reads all Job postings

Reads a single Job posting

Reads all Messages

Reads a single Message

Reads all Questions

Reads a single Question

Reads all Rejection reasons

Reads a single Rejection reason

Reads all Break configurations

Reads a single Break configuration

Reads all Edit timesheet requests

Reads a single Edit timesheet request

Get information about estimated data for a given date range and a bunch of employees.

This endpoint retrieves the current open shifts for the specified employee_ids.

Reads all Overtime requests

Reads a single Overtime request

Reads all Reviews

Reads all Shifts

Reads a single Shift

Reads all Worked times

Fetch one or all bank accounts for the company.

Fetch one or all bank accounts for the company.

Reads all Card payments

Reads a single Card payment

Reads all Transactions

Reads a single Transaction

Reads all Incidences

Reads a single Incidence

Reads all Legal entities

Reads a single Legal entity

Reads all Concepts

Reads a single Concept

Reads all Compensations

Reads a single Compensation

Read Contract Template

Read Contract Template

Reads all Contract version histories

Reads a single Contract version history

Reads all Contract version meta data

Reads all Contract versions

Reads a single Contract version

Reads all French contract types

Reads a single French contract type

Reads all German contract types

Reads a single German contract type

Reads all Materialized templates

Reads all Portuguese contract types

Reads a single Portuguese contract type

Reads all Reference Contracts. The reference contract is the contract that applies today. If no contract applies today, we will return the nearest upcoming contract. If there are no upcoming contracts, we will provide the most recent past contract.

Reads all Spanish contract types

Reads a single Spanish contract type

Reads all Spanish education levels

Reads a single Spanish education level

Reads all Spanish professional categories

Reads a single Spanish professional category

Reads all Spanish working day types

Reads a single Spanish working day type

Reads all Taxonomies

Reads a single Taxonomy

Reads all Fields

Reads a single Field

Reads all Options

Reads a single Option

Reads schema custom fields

Reads schema custom fields

Reads all Values

Reads a single Value

Reads all Resources

Reads a single Resource

Reads all Schemas

Reads a single Schema

Reads all Values

Reads a single Value

Reads all Documents

Reads a single Document

Get all folders.

Get all folders.

This endpoint can be used to retrieve a list of absence `employee updates`.

This endpoint can be used to retrieve a list of absence `employee updates`.

This endpoint can be used to retrieve a list of contract changes `employee updates` details.

This endpoint can be used to retrieve a list of contract changes `employee updates` details.

This endpoint can be used to retrieve a detail of new hire `employee updates`.

This endpoint can be used to retrieve a detail of new hire `employee updates`.

This endpoint can be used to retrieve a list of personal changes `employee updates`.

This endpoint can be used to retrieve a list of personal changes `employee updates`.

This endpoint can be used to retrieve a list of `employee updates`.

This endpoint can be used to retrieve a list of `employee updates`.

This endpoint can be used to retrieve a list of termination `employee updates`.

This endpoint can be used to retrieve a list of termination `employee updates`.

Only admins can see all the employees' information, regular users will get a restricted version of the payload as a response based on the permission set by the admin

Only admins can see all the employees' information, regular users will get a restricted version of the payload as a response based on the permission set by the admin

Reads all Expensables

Reads a single Expensable

Reads all Expenses

Reads a single Expense

Reads all Mileages

Reads a single Mileage

Reads all Per diems

Reads a single Per diem

Reads all Accounting settings

Reads a single Accounting setting

Fetch one or all ledger accounts for the company legal_entities.

Fetch one or all ledger accounts for the company legal_entities.

Fetch budget options for the company

Fetch budget options for the company

Fetch expense categories and subcategories for the company

Fetch expense categories and subcategories for the company

Reads all Contacts

Reads a single Contact

Reads all Cost center memberships

Reads all Cost centers

Reads a single Cost center

Fetch one or all financial documents for the company.

Fetch one or all financial documents for the company.

Reads all Journal entries

Reads a single Journal entry

Reads all Journal lines

Reads a single Journal line

Fetch one or all ledger account resource for the company.

Fetch one or all ledger account resource for the company.

Reads all Tax rates

Reads a single Tax rate

Reads all Tax types

Reads a single Tax type

Retrieves company holidays

Retrieves company holidays

Reads all Syncable items

Reads all Syncable sync runs

Reads a single Syncable sync run

Reads all It asset models

Reads a single It asset model

Reads all It assets

Reads a single It asset

This returns the job catalog levels

This returns the job catalog levels

Fetch Attributes for a node (Family, Function, role or level) in the Job Catalog Tree

Reads all Roles

Reads a single Role

Fetch Job Catalog Tree Node. For now only admins can see all the nodes' information, regular users won't have access to the nodes' information. In general there are four node types level, function, role and family.

Reads all Locations

Reads a single Location

Reads all Work areas

Reads a single Work area

Reads all Installation settings

Reads Payroll employee identifier codes, current countries supported are Portugal, Italy and Germany

Reads Payroll employee identifier codes, current countries supported are Portugal, Italy and Germany

Get all family situations.

Reads all Codes

Reads all Supplements

Reads a single Supplement

Retrieves the action plans of review processes.

Retrieves the action plans of review processes.

Retrieves the predefined scale set for the company and used when scoring the employee inside a review.

Retrieves the predefined scale set for the company and used when scoring the employee inside a review.

Retrieves the predefined employee score scales that can be set for the company to be used when scoring the employee inside a review.

Retrieves the predefined employee score scales that can be set for the company to be used when scoring the employee inside a review.

Retrieves the questions and answers of review evaluations.

Retrieves the published evaluation scores of performance reviews.

Retrieves the published evaluation scores of performance reviews.

Retrieves the pending and published review evaluations. The evaluations are created based on the participants and the review types when the review process is started. For example, if the defined review types are "self-review" and "manager review," two evaluations will be created for each participant when the review process starts. One will be for the self-review, where the participant is both the target and the reviewer. The other will be for the manager review, where the participant is the target, and the manager is the reviewer.

Retrieves the pending and published review evaluations. The evaluations are created based on the participants and the review types when the review process is started. For example, if the defined review types are "self-review" and "manager review," two evaluations will be created for each participant when the review process starts. One will be for the self-review, where the participant is both the target and the reviewer. The other will be for the manager review, where the participant is the target, and the manager is the reviewer.

Retrieves the review owners of review processes (each process has at least one owner). The owners can edit the review process and access its results.

Retrieves the templates for the company.

Retrieves the templates for the company.

Retrieve review process estimated target before the review process is launched

Retrieves the participants of active review processes.

Retrieves the participants of active review processes.

Reads all Review processes

Reads a single Review process

Retrieves the questionnaires by reviewer strategy for review processes.

Retrieves the questionnaires by reviewer strategy for review processes.

Retrieves the visibility settings of review processes.

Retrieves the participants' managers of a review process.

Retrieves the participants' managers of a review process.

Reads all Comments

Reads a single Comment

> ###### **What does it do?** > These endpoints will allow you to retrieve groups > ###### **What can you do with groups?** > Increase visibility and communication within the company by creating events and announcements. You can create groups for different departments, teams, or projects. > ###### **Who can use it?** > For having this funcionality available, you need to have Communities V2 feature enabled.

> ###### **What does it do?** > These endpoints will allow you to retrieve groups > ###### **What can you do with groups?** > Increase visibility and communication within the company by creating events and announcements. You can create groups for different departments, teams, or projects. > ###### **Who can use it?** > For having this funcionality available, you need to have Communities V2 feature enabled.

###### **What does it do?** These endpoints allow you to retrieve posts of a community ###### **What can you do with groups?** Increase visibility and communication within the company by creating interaction and community within your company. ###### **Who can use it?** For having this funcionality available, you need to have Communities V2 feature available

###### **What does it do?** These endpoints allow you to retrieve posts of a community ###### **What can you do with groups?** Increase visibility and communication within the company by creating interaction and community within your company. ###### **Who can use it?** For having this funcionality available, you need to have Communities V2 feature available

Fetch one or all purchase orders for the company.

Fetch one or all purchase orders for the company.

Fetch one or all purchase requests for the company.

Fetch one or all purchase requests for the company.

Fetch one or all procurement types for the company.

Fetch one or all procurement types for the company.

Reads all Budget strategies

Reads a single Budget strategy

Reads all Expense records

Reads a single Expense record

###### **What does it do?** This will generate an export of the type **"Project's expenses"**. You will have to pass the start and end date to determine the range for which htis information will be exported; as well as the projects ids to get the information of specifically given projects. ###### **What params does it accept?** - `start_date`: It's mandatory to pass this data, being start date to delimit the range of information exported. - `end_date`: It's mandatory to pass this data, corresponding to an end date for the date range of data to be exported. - `project_ids`: Mandatory data to pass to the export, specifying the projects to be exported from. ###### **Who can use it?** Only companies who have enabled the `projects_management` feature and users with the permission of read projects.

Reads all Imputable projects

Reads a single Imputable project

Reads all Planned records

Reads a single Planned record

###### **What does it do?** This reads the data of projects tasks, and retrieves the information based on permissions: - If the user can see all company projects for everybody, the endpoint will return a list with the tasks from the related projects. - If the user can create projects for everybody, the endpoint will return a list with the tasks from the related projects. - If the user has any role (editor or owner) on the project, the endpoint will return a list with the tasks from the related projects where the user has that role. - If those conditions are not matched, the endpoint will return an empty list. ###### **What params does it accept?** - `ids`: retrieve only the projects tasks that matches the ids passed in the request. - `project_ids`: retrieve only the projects tasks from the projects that matched the ids passed in the request. - `subproject_ids`: retrieve only the projects tasks from the subprojects that matched the ids passed in the request. - `completed`: boolean - retrieve only the projects tasks with the status completed. - `overdue`: boolean - retrieve only the projects tasks that are overdue. - `search`: retrieve only the projects tasks that their name match with the content passed as argument. - `due_status`: retrieve only the project tasks that their due status match with the content passed as argument. - `client_ids`: retrieve only the projects tasks from the clients that matched the ids passed in the request. ###### **Who can use it?** Only companies who have enabled the `projects_management` feature and users with the permission of read projects.

###### **What does it do?** This reads the data of projects tasks, and retrieves the information based on permissions: - If the user can see all company projects for everybody, the endpoint will return a list with the tasks from the related projects. - If the user can create projects for everybody, the endpoint will return a list with the tasks from the related projects. - If the user has any role (editor or owner) on the project, the endpoint will return a list with the tasks from the related projects where the user has that role. - If those conditions are not matched, the endpoint will return an empty list. ###### **What params does it accept?** - `ids`: retrieve only the projects tasks that matches the ids passed in the request. - `project_ids`: retrieve only the projects tasks from the projects that matched the ids passed in the request. - `subproject_ids`: retrieve only the projects tasks from the subprojects that matched the ids passed in the request. - `completed`: boolean - retrieve only the projects tasks with the status completed. - `overdue`: boolean - retrieve only the projects tasks that are overdue. - `search`: retrieve only the projects tasks that their name match with the content passed as argument. - `due_status`: retrieve only the project tasks that their due status match with the content passed as argument. - `client_ids`: retrieve only the projects tasks from the clients that matched the ids passed in the request. ###### **Who can use it?** Only companies who have enabled the `projects_management` feature and users with the permission of read projects.

###### **What does it do?** This endpoint reads and retrieves a list of project workers. You can utilize URL parameters to filter the results. ###### **Is it related to other entities?** A project_worker is always related to a project and a employee. Only a `project worker` is able to add time to a project using the `time_record` entity. ###### **Who can use it?** Only companies who have enabled the `projects_management` feature and users with the permission to read project workers.

###### **What does it do?** This endpoint reads and retrieves a list of project workers. You can utilize URL parameters to filter the results. ###### **Is it related to other entities?** A project_worker is always related to a project and a employee. Only a `project worker` is able to add time to a project using the `time_record` entity. ###### **Who can use it?** Only companies who have enabled the `projects_management` feature and users with the permission to read project workers.

###### **What does it do?** This reads the data of projects, and retrieves the information based on the permissions: - If the user has the `team_leader` permission, he will only be able to read the projects that he is the team leader. - If the user has the `reportees` permission, he will only be able to read the projects that he is the team leader or the projects that he is a team member. - If the user has `everyone` permission, he will be able to read all projects. - If the user has the `owned` permission, he will only be able to read the projects that he is the assigned. ###### **Is it related to other entities?** A project is always related to a company, so you can use the query params to list only the projects that are related to a specific company. ###### **Who can use it?** Only companies who have enabled the `projects_management` feature and users with the permission of read projects.

###### **What does it do?** This reads the data of projects, and retrieves the information based on the permissions: - If the user has the `team_leader` permission, he will only be able to read the projects that he is the team leader. - If the user has the `reportees` permission, he will only be able to read the projects that he is the team leader or the projects that he is a team member. - If the user has `everyone` permission, he will be able to read all projects. - If the user has the `owned` permission, he will only be able to read the projects that he is the assigned. ###### **Is it related to other entities?** A project is always related to a company, so you can use the query params to list only the projects that are related to a specific company. ###### **Who can use it?** Only companies who have enabled the `projects_management` feature and users with the permission of read projects.

###### **What does it do?** This reads all subprojects created ###### **What params does it accept?** - `ids`: retrieve only the subprojects that matches the ids passed in the request.\n - `include_inputed_minutes`: if `true` we will perform the minutes calculations and will be return the total `inputed_minutes`. If the param is not passed in the request, its default value is `FALSE` so it will return `inputed_minutes: 0` and no minutes calculations will be performed. - `updated_after`: this parameter is needed to filter subprojects created or updated after a date. ###### **Is it related to other entities?** A subproject is always related to a project, so you can use the query params to list only the subprojects that are related to a specific project. ###### **Who can use it?** Only companies who have enabled the `projects_with_subprojects` feature and users with the permission of read subprojects.

###### **What does it do?** This reads all subprojects created ###### **What params does it accept?** - `ids`: retrieve only the subprojects that matches the ids passed in the request.\n - `include_inputed_minutes`: if `true` we will perform the minutes calculations and will be return the total `inputed_minutes`. If the param is not passed in the request, its default value is `FALSE` so it will return `inputed_minutes: 0` and no minutes calculations will be performed. - `updated_after`: this parameter is needed to filter subprojects created or updated after a date. ###### **Is it related to other entities?** A subproject is always related to a project, so you can use the query params to list only the subprojects that are related to a specific project. ###### **Who can use it?** Only companies who have enabled the `projects_with_subprojects` feature and users with the permission of read subprojects.

###### **What does it do?** This endpoint reads and retrieves a list of time records. You can utilize URL parameters to filter the results. ###### **What params does it accept?** - `ids`: retrieve only the time records that matches the `ids` passed in the request. - `project_workers_ids`: Retrieve only the time records assigned to any `project_workers_ids` passed in the request. - `subproject_ids`: retrieve only the time records related with any `subproject_ids` passed in the request. - `attendance_shift_ids`: retrieve only the time records related with any `attendance_shift_ids` passed in the request. - `employee_ids`: ⚠️ This param, will be deprecated soon. **Please use `project_worker_ids` param instead.** - `month`: Filter time records created in a specific month of the year. - `year`: To be used with the `month` parameter to filter time records created in a particular period. - `updated_after`: this parameter is needed to filter time records created or updated after a date. ###### **Is it related to other entities?** A `time_record` is mandatory related to a `project_worker_id` and an `attendance_shift_id`. Optionally, it can be related to a subproject. ###### **Who can use it?** Only companies who have enabled the `projects_management` feature and users with the permission to read time_records.

###### **What does it do?** This endpoint reads and retrieves a list of time records. You can utilize URL parameters to filter the results. ###### **What params does it accept?** - `ids`: retrieve only the time records that matches the `ids` passed in the request. - `project_workers_ids`: Retrieve only the time records assigned to any `project_workers_ids` passed in the request. - `subproject_ids`: retrieve only the time records related with any `subproject_ids` passed in the request. - `attendance_shift_ids`: retrieve only the time records related with any `attendance_shift_ids` passed in the request. - `employee_ids`: ⚠️ This param, will be deprecated soon. **Please use `project_worker_ids` param instead.** - `month`: Filter time records created in a specific month of the year. - `year`: To be used with the `month` parameter to filter time records created in a particular period. - `updated_after`: this parameter is needed to filter time records created or updated after a date. ###### **Is it related to other entities?** A `time_record` is mandatory related to a `project_worker_id` and an `attendance_shift_id`. Optionally, it can be related to a subproject. ###### **Who can use it?** Only companies who have enabled the `projects_management` feature and users with the permission to read time_records.

Reads all Shifts

Reads a single Shift

Reads all Task files

Reads a single Task file

This endpoint retrieves all tasks created.

This endpoint retrieves all tasks created.

Get all memberships.

Get all memberships.

Gets all the teams

Gets all the teams

Reads all Planned breaks

Reads a single Planned break

Reads all Planning versions

Reads all Break configurations

Reads a single Break configuration

Reads all Allowance incidences

Reads a single Allowance incidence

Retrieves the employee time off counters for a specific allowance with a reference date

Retrieves the employee time off counters for a specific allowance with a reference date

Retrieves allowances

Retrieves allowances

Retrieves blocked periods

Retrieves blocked periods

Reads all Leave types

Reads a single Leave type

Reads all Leaves

Reads a single Leave

Reads all Policies

Reads a single Policy

Read Time off Policy Assignments

Read Time off Policy Assignments

Reads all Policy timelines

Reads all Categories

Reads a single Category

Reads all Session access memberships

Reads a single Session access membership

Reads all Session attendances

Reads a single Session attendance

Reads all Sessions

Reads a single Session

Reads all Training classes

Reads a single Training class

Reads all Training memberships

Reads a single Training membership

Reads all Trainings

Reads a single Training

Reads all Day configurations

Reads a single Day configuration

Reads all Overlap periods

Reads a single Overlap period

Reads all Schedules

Reads a single Schedule

Creates a Webhook subscription

Approves the current pending step of an approval flow identified by resource_id and resource_type, without needing to know the materialized_approval_flow_id.

Rejects the current pending step of an approval flow identified by resource_id and resource_type, without needing to know the materialized_approval_flow_id.

Creates an Answer

Creates an Application

Apply to a job posting

Move an application to a different phase within the same job posting. Triggers the same side effects as moving a candidate in the product: configured phase-change automations and emails (smart actions) are executed.

Creates candidates related to a particular company in an ATS

Save an evaluation form as a template.

This endpoint allows to create new feedback entries for candidates.

Create a new job posting.

Duplicate an existing job posting.

Creates a Question

Creates a Break configuration

Creates an edit timesheet request by specifying the type of the request and the fields required to create or update the shift.

Creates an Overtime request

Approves an Overtime request

Rejects an Overtime request

Bulk creates a Review

Bulk destroys a Review

Creates a complete shift by specifying both the clock-in and clock-out times. If you need to clock in directly, consider using or subscribing to the [clock-in endpoint](https://apidoc.factorialhr.com/v2025-01-01/reference/post_api-2025-01-01-resources-attendance-shifts-clock-in)

Autofills a Shift

Given that attendance breaks are enabled, this endpoint ends a break in an open shift.

Given that attendance breaks are enabled, this endpoint starts a break in an open shift.

Records the start of a shift by setting the current time as the clock-in. The shift remains open and will not have a clock-out time until explicitly updated. If you need to clock out directly, consider using or subscribing to the [clock-out endpoint](https://apidoc.factorialhr.com/v2025-01-01/reference/post_api-2025-01-01-resources-attendance-shifts-clock-out)

Completes an open shift by setting the current time as the clock-out. This action only applies to shifts that were previously started using clock_in. If you need to clock in directly, consider using or subscribing to the [clock-in endpoint](https://apidoc.factorialhr.com/v2025-01-01/reference/post_api-2025-01-01-resources-attendance-shifts-clock-in)

Use this endpoint to toggle shift (it will clock in or out)

Create a manual bank account.

Creates a Legal entity

Creates a Compensation

Creates a Contract version

Creates a Spanish contract type

Creates a Spanish education level

Creates a Spanish professional category

Creates a Spanish working day type

Creates a Field

Creates an Option