startBreak
curl --request POST \
--url https://sandbox.rollfi.xyz/userPortal/startBreak \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "startBreak",
"userId": "C4CA148F-F2C6-4E70-8349-57CC6DFC1C2B",
"companyId": "5221FFCF-E84B-4690-B7DC-DE29D549096B"
}
'import requests
url = "https://sandbox.rollfi.xyz/userPortal/startBreak"
payload = {
"method": "startBreak",
"userId": "C4CA148F-F2C6-4E70-8349-57CC6DFC1C2B",
"companyId": "5221FFCF-E84B-4690-B7DC-DE29D549096B"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'startBreak',
userId: 'C4CA148F-F2C6-4E70-8349-57CC6DFC1C2B',
companyId: '5221FFCF-E84B-4690-B7DC-DE29D549096B'
})
};
fetch('https://sandbox.rollfi.xyz/userPortal/startBreak', 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://sandbox.rollfi.xyz/userPortal/startBreak",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'startBreak',
'userId' => 'C4CA148F-F2C6-4E70-8349-57CC6DFC1C2B',
'companyId' => '5221FFCF-E84B-4690-B7DC-DE29D549096B'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.rollfi.xyz/userPortal/startBreak"
payload := strings.NewReader("{\n \"method\": \"startBreak\",\n \"userId\": \"C4CA148F-F2C6-4E70-8349-57CC6DFC1C2B\",\n \"companyId\": \"5221FFCF-E84B-4690-B7DC-DE29D549096B\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.rollfi.xyz/userPortal/startBreak")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"startBreak\",\n \"userId\": \"C4CA148F-F2C6-4E70-8349-57CC6DFC1C2B\",\n \"companyId\": \"5221FFCF-E84B-4690-B7DC-DE29D549096B\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/userPortal/startBreak")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"startBreak\",\n \"userId\": \"C4CA148F-F2C6-4E70-8349-57CC6DFC1C2B\",\n \"companyId\": \"5221FFCF-E84B-4690-B7DC-DE29D549096B\"\n}"
response = http.request(request)
puts response.read_body{
"timeEntryBreak": {
"breakId": "3B6F5367-9AB1-4BCB-997D-CBCE29DC6EBE",
"success": true,
"message": "Break started successfully."
}
}{
"error": {
"code": 400,
"message": "Employee is already on a break."
}
}User Portal
startBreak
The startBreak API starts a break for an employee who is currently clocked in.
What it does:
- Opens a break segment that is excluded from worked-hour totals.
Notes:
- Use
getEmployeeTimeTrackingStatusto verify break eligibility.
POST
/
userPortal
/
startBreak
startBreak
curl --request POST \
--url https://sandbox.rollfi.xyz/userPortal/startBreak \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "startBreak",
"userId": "C4CA148F-F2C6-4E70-8349-57CC6DFC1C2B",
"companyId": "5221FFCF-E84B-4690-B7DC-DE29D549096B"
}
'import requests
url = "https://sandbox.rollfi.xyz/userPortal/startBreak"
payload = {
"method": "startBreak",
"userId": "C4CA148F-F2C6-4E70-8349-57CC6DFC1C2B",
"companyId": "5221FFCF-E84B-4690-B7DC-DE29D549096B"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'startBreak',
userId: 'C4CA148F-F2C6-4E70-8349-57CC6DFC1C2B',
companyId: '5221FFCF-E84B-4690-B7DC-DE29D549096B'
})
};
fetch('https://sandbox.rollfi.xyz/userPortal/startBreak', 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://sandbox.rollfi.xyz/userPortal/startBreak",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'startBreak',
'userId' => 'C4CA148F-F2C6-4E70-8349-57CC6DFC1C2B',
'companyId' => '5221FFCF-E84B-4690-B7DC-DE29D549096B'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.rollfi.xyz/userPortal/startBreak"
payload := strings.NewReader("{\n \"method\": \"startBreak\",\n \"userId\": \"C4CA148F-F2C6-4E70-8349-57CC6DFC1C2B\",\n \"companyId\": \"5221FFCF-E84B-4690-B7DC-DE29D549096B\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.rollfi.xyz/userPortal/startBreak")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"startBreak\",\n \"userId\": \"C4CA148F-F2C6-4E70-8349-57CC6DFC1C2B\",\n \"companyId\": \"5221FFCF-E84B-4690-B7DC-DE29D549096B\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/userPortal/startBreak")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"startBreak\",\n \"userId\": \"C4CA148F-F2C6-4E70-8349-57CC6DFC1C2B\",\n \"companyId\": \"5221FFCF-E84B-4690-B7DC-DE29D549096B\"\n}"
response = http.request(request)
puts response.read_body{
"timeEntryBreak": {
"breakId": "3B6F5367-9AB1-4BCB-997D-CBCE29DC6EBE",
"success": true,
"message": "Break started successfully."
}
}{
"error": {
"code": 400,
"message": "Employee is already on a break."
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Response
Break started
Show child attributes
Show child attributes
⌘I
