PayrollConfig
Set a payroll config's default working pattern (overrides the organisation default)
Replaces the default for one payroll config, overriding the organisation default for employees in it who have no pattern of their own. An employee’s own pattern still takes precedence over this.
POST
/
payrollconfig
/
{payrollConfigId}
/
working-pattern-defaults
Set a payroll config's default working pattern (overrides the organisation default)
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}/working-pattern-defaults \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>' \
--data '
{
"qualifyingDayMode": "DeriveFromPattern",
"defaultWorkingDays": {
"standardWorkingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
},
"shiftPattern": {
"rotationStartDate": "2024-01-01",
"shifts": [
{
"name": "Morning Shift",
"workingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
},
"durationInDays": 5
},
{
"name": "Night Shift",
"workingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
},
"durationInDays": 5
}
],
"patternType": "FourOnFourOff"
},
"workingPattern": "Standard"
},
"agreedQualifyingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
}
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}/working-pattern-defaults"
payload = {
"qualifyingDayMode": "DeriveFromPattern",
"defaultWorkingDays": {
"standardWorkingDays": {
"monday": True,
"tuesday": True,
"wednesday": True,
"thursday": True,
"friday": True,
"saturday": False,
"sunday": False
},
"shiftPattern": {
"rotationStartDate": "2024-01-01",
"shifts": [
{
"name": "Morning Shift",
"workingDays": {
"monday": True,
"tuesday": True,
"wednesday": True,
"thursday": True,
"friday": True,
"saturday": False,
"sunday": False
},
"durationInDays": 5
},
{
"name": "Night Shift",
"workingDays": {
"monday": True,
"tuesday": True,
"wednesday": True,
"thursday": True,
"friday": True,
"saturday": False,
"sunday": False
},
"durationInDays": 5
}
],
"patternType": "FourOnFourOff"
},
"workingPattern": "Standard"
},
"agreedQualifyingDays": {
"monday": True,
"tuesday": True,
"wednesday": True,
"thursday": True,
"friday": True,
"saturday": False,
"sunday": False
}
}
headers = {
"X-Auth-Token": "<api-key>",
"X-Org-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Auth-Token': '<api-key>',
'X-Org-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
qualifyingDayMode: 'DeriveFromPattern',
defaultWorkingDays: {
standardWorkingDays: {
monday: true,
tuesday: true,
wednesday: true,
thursday: true,
friday: true,
saturday: false,
sunday: false
},
shiftPattern: {
rotationStartDate: '2024-01-01',
shifts: [
{
name: 'Morning Shift',
workingDays: {
monday: true,
tuesday: true,
wednesday: true,
thursday: true,
friday: true,
saturday: false,
sunday: false
},
durationInDays: 5
},
{
name: 'Night Shift',
workingDays: {
monday: true,
tuesday: true,
wednesday: true,
thursday: true,
friday: true,
saturday: false,
sunday: false
},
durationInDays: 5
}
],
patternType: 'FourOnFourOff'
},
workingPattern: 'Standard'
},
agreedQualifyingDays: {
monday: true,
tuesday: true,
wednesday: true,
thursday: true,
friday: true,
saturday: false,
sunday: false
}
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}/working-pattern-defaults', 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.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}/working-pattern-defaults",
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([
'qualifyingDayMode' => 'DeriveFromPattern',
'defaultWorkingDays' => [
'standardWorkingDays' => [
'monday' => true,
'tuesday' => true,
'wednesday' => true,
'thursday' => true,
'friday' => true,
'saturday' => false,
'sunday' => false
],
'shiftPattern' => [
'rotationStartDate' => '2024-01-01',
'shifts' => [
[
'name' => 'Morning Shift',
'workingDays' => [
'monday' => true,
'tuesday' => true,
'wednesday' => true,
'thursday' => true,
'friday' => true,
'saturday' => false,
'sunday' => false
],
'durationInDays' => 5
],
[
'name' => 'Night Shift',
'workingDays' => [
'monday' => true,
'tuesday' => true,
'wednesday' => true,
'thursday' => true,
'friday' => true,
'saturday' => false,
'sunday' => false
],
'durationInDays' => 5
]
],
'patternType' => 'FourOnFourOff'
],
'workingPattern' => 'Standard'
],
'agreedQualifyingDays' => [
'monday' => true,
'tuesday' => true,
'wednesday' => true,
'thursday' => true,
'friday' => true,
'saturday' => false,
'sunday' => false
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Auth-Token: <api-key>",
"X-Org-Id: <api-key>"
],
]);
$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://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}/working-pattern-defaults"
payload := strings.NewReader("{\n \"qualifyingDayMode\": \"DeriveFromPattern\",\n \"defaultWorkingDays\": {\n \"standardWorkingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n },\n \"shiftPattern\": {\n \"rotationStartDate\": \"2024-01-01\",\n \"shifts\": [\n {\n \"name\": \"Morning Shift\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n },\n \"durationInDays\": 5\n },\n {\n \"name\": \"Night Shift\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n },\n \"durationInDays\": 5\n }\n ],\n \"patternType\": \"FourOnFourOff\"\n },\n \"workingPattern\": \"Standard\"\n },\n \"agreedQualifyingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("X-Org-Id", "<api-key>")
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://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}/working-pattern-defaults")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"qualifyingDayMode\": \"DeriveFromPattern\",\n \"defaultWorkingDays\": {\n \"standardWorkingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n },\n \"shiftPattern\": {\n \"rotationStartDate\": \"2024-01-01\",\n \"shifts\": [\n {\n \"name\": \"Morning Shift\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n },\n \"durationInDays\": 5\n },\n {\n \"name\": \"Night Shift\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n },\n \"durationInDays\": 5\n }\n ],\n \"patternType\": \"FourOnFourOff\"\n },\n \"workingPattern\": \"Standard\"\n },\n \"agreedQualifyingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}/working-pattern-defaults")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"qualifyingDayMode\": \"DeriveFromPattern\",\n \"defaultWorkingDays\": {\n \"standardWorkingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n },\n \"shiftPattern\": {\n \"rotationStartDate\": \"2024-01-01\",\n \"shifts\": [\n {\n \"name\": \"Morning Shift\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n },\n \"durationInDays\": 5\n },\n {\n \"name\": \"Night Shift\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n },\n \"durationInDays\": 5\n }\n ],\n \"patternType\": \"FourOnFourOff\"\n },\n \"workingPattern\": \"Standard\"\n },\n \"agreedQualifyingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {
"qualifyingDayMode": "DeriveFromPattern",
"defaultWorkingDays": {
"standardWorkingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
},
"shiftPattern": {
"rotationStartDate": "2024-01-01",
"shifts": [
{
"name": "Morning Shift",
"workingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
},
"durationInDays": 5
},
{
"name": "Night Shift",
"workingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
},
"durationInDays": 5
}
],
"patternType": "FourOnFourOff"
},
"workingPattern": "Standard",
"explicitSchedule": {
"weeks": [
{
"weekCommencing": "2026-07-06",
"workingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
}
}
]
}
},
"agreedQualifyingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
}
},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
]
}Authorizations
Access token obtained from OAuth2 client credentials flow
Organisation to scope the request to. Required when the principal can access more than one organisation; optional for single-organisation principals (the authorizer resolves it automatically).
Path Parameters
The ID of the payroll config
Body
application/json
A default working pattern and SSP qualifying-day policy, used at organisation and payroll-config scope as a fallback for employees with no pattern of their own.
How SSP qualifying days are decided for employees falling back to this default.
Available options:
DeriveFromPattern, AgreedFixedDays, WednesdayDefault The default working pattern. Omit to leave this scope with no pattern default.
Show child attributes
Show child attributes
The agreed qualifying weekdays. Required when qualifyingDayMode is "AgreedFixedDays".
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Set a payroll config's default working pattern (overrides the organisation default)
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}/working-pattern-defaults \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>' \
--data '
{
"qualifyingDayMode": "DeriveFromPattern",
"defaultWorkingDays": {
"standardWorkingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
},
"shiftPattern": {
"rotationStartDate": "2024-01-01",
"shifts": [
{
"name": "Morning Shift",
"workingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
},
"durationInDays": 5
},
{
"name": "Night Shift",
"workingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
},
"durationInDays": 5
}
],
"patternType": "FourOnFourOff"
},
"workingPattern": "Standard"
},
"agreedQualifyingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
}
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}/working-pattern-defaults"
payload = {
"qualifyingDayMode": "DeriveFromPattern",
"defaultWorkingDays": {
"standardWorkingDays": {
"monday": True,
"tuesday": True,
"wednesday": True,
"thursday": True,
"friday": True,
"saturday": False,
"sunday": False
},
"shiftPattern": {
"rotationStartDate": "2024-01-01",
"shifts": [
{
"name": "Morning Shift",
"workingDays": {
"monday": True,
"tuesday": True,
"wednesday": True,
"thursday": True,
"friday": True,
"saturday": False,
"sunday": False
},
"durationInDays": 5
},
{
"name": "Night Shift",
"workingDays": {
"monday": True,
"tuesday": True,
"wednesday": True,
"thursday": True,
"friday": True,
"saturday": False,
"sunday": False
},
"durationInDays": 5
}
],
"patternType": "FourOnFourOff"
},
"workingPattern": "Standard"
},
"agreedQualifyingDays": {
"monday": True,
"tuesday": True,
"wednesday": True,
"thursday": True,
"friday": True,
"saturday": False,
"sunday": False
}
}
headers = {
"X-Auth-Token": "<api-key>",
"X-Org-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Auth-Token': '<api-key>',
'X-Org-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
qualifyingDayMode: 'DeriveFromPattern',
defaultWorkingDays: {
standardWorkingDays: {
monday: true,
tuesday: true,
wednesday: true,
thursday: true,
friday: true,
saturday: false,
sunday: false
},
shiftPattern: {
rotationStartDate: '2024-01-01',
shifts: [
{
name: 'Morning Shift',
workingDays: {
monday: true,
tuesday: true,
wednesday: true,
thursday: true,
friday: true,
saturday: false,
sunday: false
},
durationInDays: 5
},
{
name: 'Night Shift',
workingDays: {
monday: true,
tuesday: true,
wednesday: true,
thursday: true,
friday: true,
saturday: false,
sunday: false
},
durationInDays: 5
}
],
patternType: 'FourOnFourOff'
},
workingPattern: 'Standard'
},
agreedQualifyingDays: {
monday: true,
tuesday: true,
wednesday: true,
thursday: true,
friday: true,
saturday: false,
sunday: false
}
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}/working-pattern-defaults', 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.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}/working-pattern-defaults",
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([
'qualifyingDayMode' => 'DeriveFromPattern',
'defaultWorkingDays' => [
'standardWorkingDays' => [
'monday' => true,
'tuesday' => true,
'wednesday' => true,
'thursday' => true,
'friday' => true,
'saturday' => false,
'sunday' => false
],
'shiftPattern' => [
'rotationStartDate' => '2024-01-01',
'shifts' => [
[
'name' => 'Morning Shift',
'workingDays' => [
'monday' => true,
'tuesday' => true,
'wednesday' => true,
'thursday' => true,
'friday' => true,
'saturday' => false,
'sunday' => false
],
'durationInDays' => 5
],
[
'name' => 'Night Shift',
'workingDays' => [
'monday' => true,
'tuesday' => true,
'wednesday' => true,
'thursday' => true,
'friday' => true,
'saturday' => false,
'sunday' => false
],
'durationInDays' => 5
]
],
'patternType' => 'FourOnFourOff'
],
'workingPattern' => 'Standard'
],
'agreedQualifyingDays' => [
'monday' => true,
'tuesday' => true,
'wednesday' => true,
'thursday' => true,
'friday' => true,
'saturday' => false,
'sunday' => false
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Auth-Token: <api-key>",
"X-Org-Id: <api-key>"
],
]);
$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://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}/working-pattern-defaults"
payload := strings.NewReader("{\n \"qualifyingDayMode\": \"DeriveFromPattern\",\n \"defaultWorkingDays\": {\n \"standardWorkingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n },\n \"shiftPattern\": {\n \"rotationStartDate\": \"2024-01-01\",\n \"shifts\": [\n {\n \"name\": \"Morning Shift\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n },\n \"durationInDays\": 5\n },\n {\n \"name\": \"Night Shift\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n },\n \"durationInDays\": 5\n }\n ],\n \"patternType\": \"FourOnFourOff\"\n },\n \"workingPattern\": \"Standard\"\n },\n \"agreedQualifyingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("X-Org-Id", "<api-key>")
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://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}/working-pattern-defaults")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"qualifyingDayMode\": \"DeriveFromPattern\",\n \"defaultWorkingDays\": {\n \"standardWorkingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n },\n \"shiftPattern\": {\n \"rotationStartDate\": \"2024-01-01\",\n \"shifts\": [\n {\n \"name\": \"Morning Shift\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n },\n \"durationInDays\": 5\n },\n {\n \"name\": \"Night Shift\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n },\n \"durationInDays\": 5\n }\n ],\n \"patternType\": \"FourOnFourOff\"\n },\n \"workingPattern\": \"Standard\"\n },\n \"agreedQualifyingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}/working-pattern-defaults")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"qualifyingDayMode\": \"DeriveFromPattern\",\n \"defaultWorkingDays\": {\n \"standardWorkingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n },\n \"shiftPattern\": {\n \"rotationStartDate\": \"2024-01-01\",\n \"shifts\": [\n {\n \"name\": \"Morning Shift\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n },\n \"durationInDays\": 5\n },\n {\n \"name\": \"Night Shift\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n },\n \"durationInDays\": 5\n }\n ],\n \"patternType\": \"FourOnFourOff\"\n },\n \"workingPattern\": \"Standard\"\n },\n \"agreedQualifyingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": false,\n \"sunday\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {
"qualifyingDayMode": "DeriveFromPattern",
"defaultWorkingDays": {
"standardWorkingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
},
"shiftPattern": {
"rotationStartDate": "2024-01-01",
"shifts": [
{
"name": "Morning Shift",
"workingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
},
"durationInDays": 5
},
{
"name": "Night Shift",
"workingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
},
"durationInDays": 5
}
],
"patternType": "FourOnFourOff"
},
"workingPattern": "Standard",
"explicitSchedule": {
"weeks": [
{
"weekCommencing": "2026-07-06",
"workingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
}
}
]
}
},
"agreedQualifyingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
}
},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
]
}