Get contract payrolls
curl --request GET \
--url https://api-{region}.sesametime.com/contract/v1/contracts/contracts-for-payroll \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-{region}.sesametime.com/contract/v1/contracts/contracts-for-payroll"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-{region}.sesametime.com/contract/v1/contracts/contracts-for-payroll', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-{region}.sesametime.com/contract/v1/contracts/contracts-for-payroll",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-{region}.sesametime.com/contract/v1/contracts/contracts-for-payroll"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-{region}.sesametime.com/contract/v1/contracts/contracts-for-payroll")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-{region}.sesametime.com/contract/v1/contracts/contracts-for-payroll")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "48bd1f1f-8082-4bd7-a185-d9bfabe6f9b8",
"firstName": "Lucas",
"lastName": "García",
"imageProfileURL": "https://sesame-v2-prod-companies.s3.eu-west-3.amazonaws.com/48351485-1659-413d-bf7f-3ca34fadb521/public-read/g892f1fb-55a3-4e32-9cc9-7c19faa70gaa.png",
"grossAnnualSalary": 25000,
"compensations": {
"generalCompensations": [
{
"compensation": "Comisiones de ventas",
"compensation_id": "91358d5f-14c7-4b89-a180-9cb145d4fe2f",
"compensation_comment": "Comment",
"compensation_status": "active",
"compensation_type": "fixed",
"salary_compensation_id": "21358d5f-14c7-4b89-a180-9cb145d4fe2f",
"recurrence": 1,
"max": 2000,
"dates": [
{
"date": "2022-07-01",
"quantity": 1000,
"id": "21358d5f-14c7-4b89-a180-9cb145d4fe2f"
}
],
"total": 2000
}
],
"payrollCompensations": [
{
"compensation": "Complemento de ventas puntual",
"compensation_id": "43218d5f-14c7-4b89-a180-9cb145d4fe2f",
"dates": [
{
"date": "2022-07-01",
"quantity": 1000,
"id": "21358d5f-14c7-4b89-a180-9cb145d4fe2f"
}
],
"quantity": 1000,
"recurrence": 1,
"salary_compensation_id": 1
}
]
},
"position": "Analista financiero",
"startDate": "2023-11-01",
"endDate": "null",
"trialPeriod": {
"quantity": 6,
"trialPeriodType": "months"
},
"currency": "EUR",
"grossMonthlySalary": 2000,
"payPeriod": {
"value": "monthly"
},
"prorated": true,
"remuneration": 2083.33,
"businessData": {
"daysWorked": 20,
"vacationDays": 1,
"remuneratedAbsences": 0,
"notRemuneratedAbsences": 0,
"absenteeismDays": 1,
"workedHolidays": 0,
"nonWorkingDaysWorked": 0,
"secondsToWork": 576000,
"overtime": 0,
"salaryId": "21358d5f-14c7-4b89-a180-9cb145d4fe2f",
"delays": 0,
"hoursBagRemunerated": 0,
"effectiveDaysWithMoreThanFiveHoursWorked": 15
},
"code": "0001",
"ssn": "123456789",
"dni": "12345678A",
"secondaryDni": "CURP12345678",
"accountNumber": "ES123456789123456712312312",
"offices": [
{
"id": "21358d5f-14c7-4b89-a180-9cb145d4fe2f",
"name": "Madrid",
"address": "Calle de la piruleta, 1",
"coordinates": {
"latitude": "40.416775",
"longitude": "-3.703790"
},
"description": "Oficina principal",
"radio": 50,
"defaultEmployeesTimezone": "Europe/Madrid",
"numberEmployees": 10
}
],
"departments": [
{
"id": "21358d5f-14c7-4b89-a180-9cb145d4fe2f",
"name": "Madrid",
"numberEmployees": 0
}
],
"additionalCompensations": 333,
"extraPayCompensations": 2333,
"salaryPayments": 2,
"a3EmployeeCode": "123456"
}
],
"meta": {
"currentPage": 1,
"lastPage": 1,
"total": 1,
"perPage": 1
}
}Contracts
Get contract payrolls
Retrieve labour and contract data for payroll purposes
GET
/
contract
/
v1
/
contracts
/
contracts-for-payroll
Get contract payrolls
curl --request GET \
--url https://api-{region}.sesametime.com/contract/v1/contracts/contracts-for-payroll \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-{region}.sesametime.com/contract/v1/contracts/contracts-for-payroll"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-{region}.sesametime.com/contract/v1/contracts/contracts-for-payroll', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-{region}.sesametime.com/contract/v1/contracts/contracts-for-payroll",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-{region}.sesametime.com/contract/v1/contracts/contracts-for-payroll"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-{region}.sesametime.com/contract/v1/contracts/contracts-for-payroll")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-{region}.sesametime.com/contract/v1/contracts/contracts-for-payroll")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "48bd1f1f-8082-4bd7-a185-d9bfabe6f9b8",
"firstName": "Lucas",
"lastName": "García",
"imageProfileURL": "https://sesame-v2-prod-companies.s3.eu-west-3.amazonaws.com/48351485-1659-413d-bf7f-3ca34fadb521/public-read/g892f1fb-55a3-4e32-9cc9-7c19faa70gaa.png",
"grossAnnualSalary": 25000,
"compensations": {
"generalCompensations": [
{
"compensation": "Comisiones de ventas",
"compensation_id": "91358d5f-14c7-4b89-a180-9cb145d4fe2f",
"compensation_comment": "Comment",
"compensation_status": "active",
"compensation_type": "fixed",
"salary_compensation_id": "21358d5f-14c7-4b89-a180-9cb145d4fe2f",
"recurrence": 1,
"max": 2000,
"dates": [
{
"date": "2022-07-01",
"quantity": 1000,
"id": "21358d5f-14c7-4b89-a180-9cb145d4fe2f"
}
],
"total": 2000
}
],
"payrollCompensations": [
{
"compensation": "Complemento de ventas puntual",
"compensation_id": "43218d5f-14c7-4b89-a180-9cb145d4fe2f",
"dates": [
{
"date": "2022-07-01",
"quantity": 1000,
"id": "21358d5f-14c7-4b89-a180-9cb145d4fe2f"
}
],
"quantity": 1000,
"recurrence": 1,
"salary_compensation_id": 1
}
]
},
"position": "Analista financiero",
"startDate": "2023-11-01",
"endDate": "null",
"trialPeriod": {
"quantity": 6,
"trialPeriodType": "months"
},
"currency": "EUR",
"grossMonthlySalary": 2000,
"payPeriod": {
"value": "monthly"
},
"prorated": true,
"remuneration": 2083.33,
"businessData": {
"daysWorked": 20,
"vacationDays": 1,
"remuneratedAbsences": 0,
"notRemuneratedAbsences": 0,
"absenteeismDays": 1,
"workedHolidays": 0,
"nonWorkingDaysWorked": 0,
"secondsToWork": 576000,
"overtime": 0,
"salaryId": "21358d5f-14c7-4b89-a180-9cb145d4fe2f",
"delays": 0,
"hoursBagRemunerated": 0,
"effectiveDaysWithMoreThanFiveHoursWorked": 15
},
"code": "0001",
"ssn": "123456789",
"dni": "12345678A",
"secondaryDni": "CURP12345678",
"accountNumber": "ES123456789123456712312312",
"offices": [
{
"id": "21358d5f-14c7-4b89-a180-9cb145d4fe2f",
"name": "Madrid",
"address": "Calle de la piruleta, 1",
"coordinates": {
"latitude": "40.416775",
"longitude": "-3.703790"
},
"description": "Oficina principal",
"radio": 50,
"defaultEmployeesTimezone": "Europe/Madrid",
"numberEmployees": 10
}
],
"departments": [
{
"id": "21358d5f-14c7-4b89-a180-9cb145d4fe2f",
"name": "Madrid",
"numberEmployees": 0
}
],
"additionalCompensations": 333,
"extraPayCompensations": 2333,
"salaryPayments": 2,
"a3EmployeeCode": "123456"
}
],
"meta": {
"currentPage": 1,
"lastPage": 1,
"total": 1,
"perPage": 1
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Salary pay period
Available options:
daily, weekly, biweekly, fortnightly, monthly Y-m-d
Y-m-d
Salary currency
Available options:
EUR, MXN, USD Example:
"EUR"
Office Ids to filter employees belonging to them
Department Ids to filter employees belonging to them
Employee status
Available options:
active, inactive Limit custom fields
Request a specific page
firstName asc
Was this page helpful?
⌘I