API reference tips

Time tracking (clock in/out)

In our Reference section, we have two endpoints related to the Attendance module (time tracking). We are going to explain the difference between these two:

1. Attendance > V1
   This version is to GET the time tracking data of all users or POST the time tracking data live. For example, connect a clock-in device to Factorial.
   1. You cannot implement this version if you want to clock in before another open clock in
   2. You must have a clock out to POST a clock in
   3. There is no automation to place the clock out after XX hours. We don't offer this option in Factorial.
2. Attendance > V2
   This version is to GET the time tracking data of all users or POST the time tracking closed. This means, the time tracking must have a clock in and a clock out and applies to the past days.

• Spanish video Explaining time tracking endpoints.
• English video Explaining time tracking endpoints.

How can I GET the work areas (office)?

Depending on the call you are using to GET employees, you will be able to obtain the work area (office, workplace) of your users.

If you are using GET>Employees> V1

1. Get the employee call (you have the location_id)
2. With the CORE>Locations call, you will have the location_id information

If you are using GET > Employee > V2

1. Get the employee data with V2
2. Go to CORE> Workplace> V2
   1. You can place the ID of the employees in this call to know the work area (office) of the employee
   2. Or you can GET all the workplaces areas and filter by workplaces

How do custom fields work?

The custom fields are in a separate endpoint in our API. This is the endpoint where you can find all the custom fields about employees' data

Video with the explanation

How can I get the information about contracts?

1. Go to PAYROLL > Contracts To obtain all contracts of your employees.
2. If you want to obtain for certain employees (filter by the employee) > go to reference contracts

Power Bi

In this link, you will find all the necessary steps to connect with Power Bi

Holidays

Regarding holidays, you can obtain the number of days the employee takes.

1. Time > leaves are the endpoints you should use.
   1. Get leave by ID will filter the employee you are looking for (remember this should be done with the ID you obtain in the GET call)
2. Time> Leave Types you will obtain all the information of your leave types.

Webhooks

Click here, to find our complete explanation regarding Webhooks.

Click here to see how to set up your first webhook.