getPayPeriodTimeCards
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getPayPeriodTimeCards \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getPayPeriodTimeCards",
"companyId": "5221FFCF-E84B-4690-B7DC-DE29D549096B",
"payPeriodId": "3EAEC271-6C06-4E17-8C3B-1C6649D534D5"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getPayPeriodTimeCards"
payload = {
"method": "getPayPeriodTimeCards",
"companyId": "5221FFCF-E84B-4690-B7DC-DE29D549096B",
"payPeriodId": "3EAEC271-6C06-4E17-8C3B-1C6649D534D5"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'getPayPeriodTimeCards',
companyId: '5221FFCF-E84B-4690-B7DC-DE29D549096B',
payPeriodId: '3EAEC271-6C06-4E17-8C3B-1C6649D534D5'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getPayPeriodTimeCards', 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/reports/getPayPeriodTimeCards",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'getPayPeriodTimeCards',
'companyId' => '5221FFCF-E84B-4690-B7DC-DE29D549096B',
'payPeriodId' => '3EAEC271-6C06-4E17-8C3B-1C6649D534D5'
]),
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/reports/getPayPeriodTimeCards"
payload := strings.NewReader("{\n \"method\": \"getPayPeriodTimeCards\",\n \"companyId\": \"5221FFCF-E84B-4690-B7DC-DE29D549096B\",\n \"payPeriodId\": \"3EAEC271-6C06-4E17-8C3B-1C6649D534D5\"\n}")
req, _ := http.NewRequest("GET", 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.get("https://sandbox.rollfi.xyz/reports/getPayPeriodTimeCards")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getPayPeriodTimeCards\",\n \"companyId\": \"5221FFCF-E84B-4690-B7DC-DE29D549096B\",\n \"payPeriodId\": \"3EAEC271-6C06-4E17-8C3B-1C6649D534D5\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getPayPeriodTimeCards")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"getPayPeriodTimeCards\",\n \"companyId\": \"5221FFCF-E84B-4690-B7DC-DE29D549096B\",\n \"payPeriodId\": \"3EAEC271-6C06-4E17-8C3B-1C6649D534D5\"\n}"
response = http.request(request)
puts response.read_body{
"timeCards": [
{
"timeCardId": "4DDB60ED-BC33-49FA-A589-E29FB6C4FD5C",
"companyId": "5221FFCF-E84B-4690-B7DC-DE29D549096B",
"userId": "C4CA148F-F2C6-4E70-8349-57CC6DFC1C2B",
"payPeriodId": "3EAEC271-6C06-4E17-8C3B-1C6649D534D5",
"approvalStatus": "New",
"lastSynced": null,
"isOvertimeEligible": true,
"regularHours": 24.5,
"overtimeHours": 12
}
]
}{
"error": {
"code": 400,
"message": "payPeriodId is required."
}
}Time Tracking
getPayPeriodTimeCards
The getPayPeriodTimeCards API retrieves active timecards given a payPeriodId
What it does:
- Fetches top level information for all time cards in a pay period
- Displays totals for regular hours, overtime hours and the employee’s overtime eligibility for easy top level timecard display screens
- Can be used to display time cards history given a
processedpayPeriodId, or the current timecard given anewpayPeriodId
Notes:
- For more in depth information you can retrieve an individual employee’s time cards using the
getEmployeePayPeriodTimeCardAPI - overtimeHours is only retirned when
isOvertimeEligible = true
GET
/
reports
/
getPayPeriodTimeCards
getPayPeriodTimeCards
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getPayPeriodTimeCards \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getPayPeriodTimeCards",
"companyId": "5221FFCF-E84B-4690-B7DC-DE29D549096B",
"payPeriodId": "3EAEC271-6C06-4E17-8C3B-1C6649D534D5"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getPayPeriodTimeCards"
payload = {
"method": "getPayPeriodTimeCards",
"companyId": "5221FFCF-E84B-4690-B7DC-DE29D549096B",
"payPeriodId": "3EAEC271-6C06-4E17-8C3B-1C6649D534D5"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'getPayPeriodTimeCards',
companyId: '5221FFCF-E84B-4690-B7DC-DE29D549096B',
payPeriodId: '3EAEC271-6C06-4E17-8C3B-1C6649D534D5'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getPayPeriodTimeCards', 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/reports/getPayPeriodTimeCards",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'getPayPeriodTimeCards',
'companyId' => '5221FFCF-E84B-4690-B7DC-DE29D549096B',
'payPeriodId' => '3EAEC271-6C06-4E17-8C3B-1C6649D534D5'
]),
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/reports/getPayPeriodTimeCards"
payload := strings.NewReader("{\n \"method\": \"getPayPeriodTimeCards\",\n \"companyId\": \"5221FFCF-E84B-4690-B7DC-DE29D549096B\",\n \"payPeriodId\": \"3EAEC271-6C06-4E17-8C3B-1C6649D534D5\"\n}")
req, _ := http.NewRequest("GET", 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.get("https://sandbox.rollfi.xyz/reports/getPayPeriodTimeCards")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getPayPeriodTimeCards\",\n \"companyId\": \"5221FFCF-E84B-4690-B7DC-DE29D549096B\",\n \"payPeriodId\": \"3EAEC271-6C06-4E17-8C3B-1C6649D534D5\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getPayPeriodTimeCards")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"getPayPeriodTimeCards\",\n \"companyId\": \"5221FFCF-E84B-4690-B7DC-DE29D549096B\",\n \"payPeriodId\": \"3EAEC271-6C06-4E17-8C3B-1C6649D534D5\"\n}"
response = http.request(request)
puts response.read_body{
"timeCards": [
{
"timeCardId": "4DDB60ED-BC33-49FA-A589-E29FB6C4FD5C",
"companyId": "5221FFCF-E84B-4690-B7DC-DE29D549096B",
"userId": "C4CA148F-F2C6-4E70-8349-57CC6DFC1C2B",
"payPeriodId": "3EAEC271-6C06-4E17-8C3B-1C6649D534D5",
"approvalStatus": "New",
"lastSynced": null,
"isOvertimeEligible": true,
"regularHours": 24.5,
"overtimeHours": 12
}
]
}{
"error": {
"code": 400,
"message": "payPeriodId is required."
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Response
Pay period time cards
Show child attributes
Show child attributes
⌘I
