Statutory Calculations
Post calculationspreview
POST
/
calculations
/
preview
cURL
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v1/statutory-pay/calculations/preview \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>' \
--data '
{
"startDate": "<string>",
"employmentStartDate": "<string>",
"payFrequency": "<string>",
"earnings": [
123
],
"endDate": "<string>",
"qualifyingEventDate": "<string>",
"workingDays": {
"standardWorkingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true
},
"shiftPattern": {
"rotationStartDate": "<string>",
"shifts": [
{
"name": "<string>",
"workingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true
},
"durationInDays": 123,
"weekNumber": 123
}
],
"patternType": "<string>",
"patternWeeks": 123
},
"workingPattern": "<string>",
"explicitSchedule": {
"weeks": [
{
"weekCommencing": "<string>",
"workingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true
}
}
]
}
},
"paidWeeks": 123,
"paidUntilDate": "<string>",
"isReceivingStatutoryMaternityPay": true,
"previousSicknessPeriods": [
{
"startDate": "<string>",
"endDate": "<string>",
"wereFirstThreeDaysPaid": true
}
]
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/statutory-pay/calculations/preview"
payload = {
"startDate": "<string>",
"employmentStartDate": "<string>",
"payFrequency": "<string>",
"earnings": [123],
"endDate": "<string>",
"qualifyingEventDate": "<string>",
"workingDays": {
"standardWorkingDays": {
"monday": True,
"tuesday": True,
"wednesday": True,
"thursday": True,
"friday": True,
"saturday": True,
"sunday": True
},
"shiftPattern": {
"rotationStartDate": "<string>",
"shifts": [
{
"name": "<string>",
"workingDays": {
"monday": True,
"tuesday": True,
"wednesday": True,
"thursday": True,
"friday": True,
"saturday": True,
"sunday": True
},
"durationInDays": 123,
"weekNumber": 123
}
],
"patternType": "<string>",
"patternWeeks": 123
},
"workingPattern": "<string>",
"explicitSchedule": { "weeks": [
{
"weekCommencing": "<string>",
"workingDays": {
"monday": True,
"tuesday": True,
"wednesday": True,
"thursday": True,
"friday": True,
"saturday": True,
"sunday": True
}
}
] }
},
"paidWeeks": 123,
"paidUntilDate": "<string>",
"isReceivingStatutoryMaternityPay": True,
"previousSicknessPeriods": [
{
"startDate": "<string>",
"endDate": "<string>",
"wereFirstThreeDaysPaid": True
}
]
}
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({
startDate: '<string>',
employmentStartDate: '<string>',
payFrequency: '<string>',
earnings: [123],
endDate: '<string>',
qualifyingEventDate: '<string>',
workingDays: {
standardWorkingDays: {
monday: true,
tuesday: true,
wednesday: true,
thursday: true,
friday: true,
saturday: true,
sunday: true
},
shiftPattern: {
rotationStartDate: '<string>',
shifts: [
{
name: '<string>',
workingDays: {
monday: true,
tuesday: true,
wednesday: true,
thursday: true,
friday: true,
saturday: true,
sunday: true
},
durationInDays: 123,
weekNumber: 123
}
],
patternType: '<string>',
patternWeeks: 123
},
workingPattern: '<string>',
explicitSchedule: {
weeks: [
{
weekCommencing: '<string>',
workingDays: {
monday: true,
tuesday: true,
wednesday: true,
thursday: true,
friday: true,
saturday: true,
sunday: true
}
}
]
}
},
paidWeeks: 123,
paidUntilDate: '<string>',
isReceivingStatutoryMaternityPay: true,
previousSicknessPeriods: [{startDate: '<string>', endDate: '<string>', wereFirstThreeDaysPaid: true}]
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/statutory-pay/calculations/preview', 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/statutory-pay/calculations/preview",
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([
'startDate' => '<string>',
'employmentStartDate' => '<string>',
'payFrequency' => '<string>',
'earnings' => [
123
],
'endDate' => '<string>',
'qualifyingEventDate' => '<string>',
'workingDays' => [
'standardWorkingDays' => [
'monday' => true,
'tuesday' => true,
'wednesday' => true,
'thursday' => true,
'friday' => true,
'saturday' => true,
'sunday' => true
],
'shiftPattern' => [
'rotationStartDate' => '<string>',
'shifts' => [
[
'name' => '<string>',
'workingDays' => [
'monday' => true,
'tuesday' => true,
'wednesday' => true,
'thursday' => true,
'friday' => true,
'saturday' => true,
'sunday' => true
],
'durationInDays' => 123,
'weekNumber' => 123
]
],
'patternType' => '<string>',
'patternWeeks' => 123
],
'workingPattern' => '<string>',
'explicitSchedule' => [
'weeks' => [
[
'weekCommencing' => '<string>',
'workingDays' => [
'monday' => true,
'tuesday' => true,
'wednesday' => true,
'thursday' => true,
'friday' => true,
'saturday' => true,
'sunday' => true
]
]
]
]
],
'paidWeeks' => 123,
'paidUntilDate' => '<string>',
'isReceivingStatutoryMaternityPay' => true,
'previousSicknessPeriods' => [
[
'startDate' => '<string>',
'endDate' => '<string>',
'wereFirstThreeDaysPaid' => true
]
]
]),
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/statutory-pay/calculations/preview"
payload := strings.NewReader("{\n \"startDate\": \"<string>\",\n \"employmentStartDate\": \"<string>\",\n \"payFrequency\": \"<string>\",\n \"earnings\": [\n 123\n ],\n \"endDate\": \"<string>\",\n \"qualifyingEventDate\": \"<string>\",\n \"workingDays\": {\n \"standardWorkingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": true,\n \"sunday\": true\n },\n \"shiftPattern\": {\n \"rotationStartDate\": \"<string>\",\n \"shifts\": [\n {\n \"name\": \"<string>\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": true,\n \"sunday\": true\n },\n \"durationInDays\": 123,\n \"weekNumber\": 123\n }\n ],\n \"patternType\": \"<string>\",\n \"patternWeeks\": 123\n },\n \"workingPattern\": \"<string>\",\n \"explicitSchedule\": {\n \"weeks\": [\n {\n \"weekCommencing\": \"<string>\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": true,\n \"sunday\": true\n }\n }\n ]\n }\n },\n \"paidWeeks\": 123,\n \"paidUntilDate\": \"<string>\",\n \"isReceivingStatutoryMaternityPay\": true,\n \"previousSicknessPeriods\": [\n {\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"wereFirstThreeDaysPaid\": true\n }\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/statutory-pay/calculations/preview")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"startDate\": \"<string>\",\n \"employmentStartDate\": \"<string>\",\n \"payFrequency\": \"<string>\",\n \"earnings\": [\n 123\n ],\n \"endDate\": \"<string>\",\n \"qualifyingEventDate\": \"<string>\",\n \"workingDays\": {\n \"standardWorkingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": true,\n \"sunday\": true\n },\n \"shiftPattern\": {\n \"rotationStartDate\": \"<string>\",\n \"shifts\": [\n {\n \"name\": \"<string>\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": true,\n \"sunday\": true\n },\n \"durationInDays\": 123,\n \"weekNumber\": 123\n }\n ],\n \"patternType\": \"<string>\",\n \"patternWeeks\": 123\n },\n \"workingPattern\": \"<string>\",\n \"explicitSchedule\": {\n \"weeks\": [\n {\n \"weekCommencing\": \"<string>\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": true,\n \"sunday\": true\n }\n }\n ]\n }\n },\n \"paidWeeks\": 123,\n \"paidUntilDate\": \"<string>\",\n \"isReceivingStatutoryMaternityPay\": true,\n \"previousSicknessPeriods\": [\n {\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"wereFirstThreeDaysPaid\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/statutory-pay/calculations/preview")
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 \"startDate\": \"<string>\",\n \"employmentStartDate\": \"<string>\",\n \"payFrequency\": \"<string>\",\n \"earnings\": [\n 123\n ],\n \"endDate\": \"<string>\",\n \"qualifyingEventDate\": \"<string>\",\n \"workingDays\": {\n \"standardWorkingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": true,\n \"sunday\": true\n },\n \"shiftPattern\": {\n \"rotationStartDate\": \"<string>\",\n \"shifts\": [\n {\n \"name\": \"<string>\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": true,\n \"sunday\": true\n },\n \"durationInDays\": 123,\n \"weekNumber\": 123\n }\n ],\n \"patternType\": \"<string>\",\n \"patternWeeks\": 123\n },\n \"workingPattern\": \"<string>\",\n \"explicitSchedule\": {\n \"weeks\": [\n {\n \"weekCommencing\": \"<string>\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": true,\n \"sunday\": true\n }\n }\n ]\n }\n },\n \"paidWeeks\": 123,\n \"paidUntilDate\": \"<string>\",\n \"isReceivingStatutoryMaternityPay\": true,\n \"previousSicknessPeriods\": [\n {\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"wereFirstThreeDaysPaid\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": {
"statutoryType": "<string>",
"totalAmount": 123,
"statutoryId": "<string>",
"uploadUrls": [
{
"attachmentId": "<string>",
"filename": "<string>",
"uploadUrl": "<string>",
"expiresAt": "<string>"
}
],
"nonRoundedTotalAmount": 123,
"requestDate": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"breakdown": [
{
"year": 123,
"period": 123,
"frequency": "<string>",
"week": 123,
"value": 123,
"nonRoundedValue": 123,
"status": "<string>"
}
],
"maxEndDate": "<string>",
"dailyBreakdown": [
{
"date": "<string>",
"amount": 123,
"description": "<string>",
"isLinked": true
}
],
"periodRange": "<string>",
"warnings": [
{
"code": "BackdatedWeeksAccruedToNextOpenRun",
"message": "<string>",
"details": {
"accruedWeeks": 123,
"accruedAmount": 123,
"accrualPaymentDate": "<string>",
"closedPeriods": [
{
"year": 123,
"period": 123,
"payPeriodStartDate": "<string>",
"payPeriodEndDate": "<string>",
"paymentDate": "<string>"
}
]
}
}
],
"averageWeeklyEarnings": 123,
"paidUntilDate": "<string>",
"paidAmount": 123,
"pendingAmount": 123,
"paidThroughPayPeriodEnd": "<string>",
"paidThroughYear": 123,
"paidThroughPeriod": 123
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}Authorizations
Authentication token for API access
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).
Body
application/json
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
Minimum string length:
1Minimum string length:
1Minimum string length:
1Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I
cURL
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v1/statutory-pay/calculations/preview \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>' \
--data '
{
"startDate": "<string>",
"employmentStartDate": "<string>",
"payFrequency": "<string>",
"earnings": [
123
],
"endDate": "<string>",
"qualifyingEventDate": "<string>",
"workingDays": {
"standardWorkingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true
},
"shiftPattern": {
"rotationStartDate": "<string>",
"shifts": [
{
"name": "<string>",
"workingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true
},
"durationInDays": 123,
"weekNumber": 123
}
],
"patternType": "<string>",
"patternWeeks": 123
},
"workingPattern": "<string>",
"explicitSchedule": {
"weeks": [
{
"weekCommencing": "<string>",
"workingDays": {
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true
}
}
]
}
},
"paidWeeks": 123,
"paidUntilDate": "<string>",
"isReceivingStatutoryMaternityPay": true,
"previousSicknessPeriods": [
{
"startDate": "<string>",
"endDate": "<string>",
"wereFirstThreeDaysPaid": true
}
]
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/statutory-pay/calculations/preview"
payload = {
"startDate": "<string>",
"employmentStartDate": "<string>",
"payFrequency": "<string>",
"earnings": [123],
"endDate": "<string>",
"qualifyingEventDate": "<string>",
"workingDays": {
"standardWorkingDays": {
"monday": True,
"tuesday": True,
"wednesday": True,
"thursday": True,
"friday": True,
"saturday": True,
"sunday": True
},
"shiftPattern": {
"rotationStartDate": "<string>",
"shifts": [
{
"name": "<string>",
"workingDays": {
"monday": True,
"tuesday": True,
"wednesday": True,
"thursday": True,
"friday": True,
"saturday": True,
"sunday": True
},
"durationInDays": 123,
"weekNumber": 123
}
],
"patternType": "<string>",
"patternWeeks": 123
},
"workingPattern": "<string>",
"explicitSchedule": { "weeks": [
{
"weekCommencing": "<string>",
"workingDays": {
"monday": True,
"tuesday": True,
"wednesday": True,
"thursday": True,
"friday": True,
"saturday": True,
"sunday": True
}
}
] }
},
"paidWeeks": 123,
"paidUntilDate": "<string>",
"isReceivingStatutoryMaternityPay": True,
"previousSicknessPeriods": [
{
"startDate": "<string>",
"endDate": "<string>",
"wereFirstThreeDaysPaid": True
}
]
}
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({
startDate: '<string>',
employmentStartDate: '<string>',
payFrequency: '<string>',
earnings: [123],
endDate: '<string>',
qualifyingEventDate: '<string>',
workingDays: {
standardWorkingDays: {
monday: true,
tuesday: true,
wednesday: true,
thursday: true,
friday: true,
saturday: true,
sunday: true
},
shiftPattern: {
rotationStartDate: '<string>',
shifts: [
{
name: '<string>',
workingDays: {
monday: true,
tuesday: true,
wednesday: true,
thursday: true,
friday: true,
saturday: true,
sunday: true
},
durationInDays: 123,
weekNumber: 123
}
],
patternType: '<string>',
patternWeeks: 123
},
workingPattern: '<string>',
explicitSchedule: {
weeks: [
{
weekCommencing: '<string>',
workingDays: {
monday: true,
tuesday: true,
wednesday: true,
thursday: true,
friday: true,
saturday: true,
sunday: true
}
}
]
}
},
paidWeeks: 123,
paidUntilDate: '<string>',
isReceivingStatutoryMaternityPay: true,
previousSicknessPeriods: [{startDate: '<string>', endDate: '<string>', wereFirstThreeDaysPaid: true}]
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/statutory-pay/calculations/preview', 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/statutory-pay/calculations/preview",
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([
'startDate' => '<string>',
'employmentStartDate' => '<string>',
'payFrequency' => '<string>',
'earnings' => [
123
],
'endDate' => '<string>',
'qualifyingEventDate' => '<string>',
'workingDays' => [
'standardWorkingDays' => [
'monday' => true,
'tuesday' => true,
'wednesday' => true,
'thursday' => true,
'friday' => true,
'saturday' => true,
'sunday' => true
],
'shiftPattern' => [
'rotationStartDate' => '<string>',
'shifts' => [
[
'name' => '<string>',
'workingDays' => [
'monday' => true,
'tuesday' => true,
'wednesday' => true,
'thursday' => true,
'friday' => true,
'saturday' => true,
'sunday' => true
],
'durationInDays' => 123,
'weekNumber' => 123
]
],
'patternType' => '<string>',
'patternWeeks' => 123
],
'workingPattern' => '<string>',
'explicitSchedule' => [
'weeks' => [
[
'weekCommencing' => '<string>',
'workingDays' => [
'monday' => true,
'tuesday' => true,
'wednesday' => true,
'thursday' => true,
'friday' => true,
'saturday' => true,
'sunday' => true
]
]
]
]
],
'paidWeeks' => 123,
'paidUntilDate' => '<string>',
'isReceivingStatutoryMaternityPay' => true,
'previousSicknessPeriods' => [
[
'startDate' => '<string>',
'endDate' => '<string>',
'wereFirstThreeDaysPaid' => true
]
]
]),
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/statutory-pay/calculations/preview"
payload := strings.NewReader("{\n \"startDate\": \"<string>\",\n \"employmentStartDate\": \"<string>\",\n \"payFrequency\": \"<string>\",\n \"earnings\": [\n 123\n ],\n \"endDate\": \"<string>\",\n \"qualifyingEventDate\": \"<string>\",\n \"workingDays\": {\n \"standardWorkingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": true,\n \"sunday\": true\n },\n \"shiftPattern\": {\n \"rotationStartDate\": \"<string>\",\n \"shifts\": [\n {\n \"name\": \"<string>\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": true,\n \"sunday\": true\n },\n \"durationInDays\": 123,\n \"weekNumber\": 123\n }\n ],\n \"patternType\": \"<string>\",\n \"patternWeeks\": 123\n },\n \"workingPattern\": \"<string>\",\n \"explicitSchedule\": {\n \"weeks\": [\n {\n \"weekCommencing\": \"<string>\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": true,\n \"sunday\": true\n }\n }\n ]\n }\n },\n \"paidWeeks\": 123,\n \"paidUntilDate\": \"<string>\",\n \"isReceivingStatutoryMaternityPay\": true,\n \"previousSicknessPeriods\": [\n {\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"wereFirstThreeDaysPaid\": true\n }\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/statutory-pay/calculations/preview")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"startDate\": \"<string>\",\n \"employmentStartDate\": \"<string>\",\n \"payFrequency\": \"<string>\",\n \"earnings\": [\n 123\n ],\n \"endDate\": \"<string>\",\n \"qualifyingEventDate\": \"<string>\",\n \"workingDays\": {\n \"standardWorkingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": true,\n \"sunday\": true\n },\n \"shiftPattern\": {\n \"rotationStartDate\": \"<string>\",\n \"shifts\": [\n {\n \"name\": \"<string>\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": true,\n \"sunday\": true\n },\n \"durationInDays\": 123,\n \"weekNumber\": 123\n }\n ],\n \"patternType\": \"<string>\",\n \"patternWeeks\": 123\n },\n \"workingPattern\": \"<string>\",\n \"explicitSchedule\": {\n \"weeks\": [\n {\n \"weekCommencing\": \"<string>\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": true,\n \"sunday\": true\n }\n }\n ]\n }\n },\n \"paidWeeks\": 123,\n \"paidUntilDate\": \"<string>\",\n \"isReceivingStatutoryMaternityPay\": true,\n \"previousSicknessPeriods\": [\n {\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"wereFirstThreeDaysPaid\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/statutory-pay/calculations/preview")
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 \"startDate\": \"<string>\",\n \"employmentStartDate\": \"<string>\",\n \"payFrequency\": \"<string>\",\n \"earnings\": [\n 123\n ],\n \"endDate\": \"<string>\",\n \"qualifyingEventDate\": \"<string>\",\n \"workingDays\": {\n \"standardWorkingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": true,\n \"sunday\": true\n },\n \"shiftPattern\": {\n \"rotationStartDate\": \"<string>\",\n \"shifts\": [\n {\n \"name\": \"<string>\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": true,\n \"sunday\": true\n },\n \"durationInDays\": 123,\n \"weekNumber\": 123\n }\n ],\n \"patternType\": \"<string>\",\n \"patternWeeks\": 123\n },\n \"workingPattern\": \"<string>\",\n \"explicitSchedule\": {\n \"weeks\": [\n {\n \"weekCommencing\": \"<string>\",\n \"workingDays\": {\n \"monday\": true,\n \"tuesday\": true,\n \"wednesday\": true,\n \"thursday\": true,\n \"friday\": true,\n \"saturday\": true,\n \"sunday\": true\n }\n }\n ]\n }\n },\n \"paidWeeks\": 123,\n \"paidUntilDate\": \"<string>\",\n \"isReceivingStatutoryMaternityPay\": true,\n \"previousSicknessPeriods\": [\n {\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"wereFirstThreeDaysPaid\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": {
"statutoryType": "<string>",
"totalAmount": 123,
"statutoryId": "<string>",
"uploadUrls": [
{
"attachmentId": "<string>",
"filename": "<string>",
"uploadUrl": "<string>",
"expiresAt": "<string>"
}
],
"nonRoundedTotalAmount": 123,
"requestDate": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"breakdown": [
{
"year": 123,
"period": 123,
"frequency": "<string>",
"week": 123,
"value": 123,
"nonRoundedValue": 123,
"status": "<string>"
}
],
"maxEndDate": "<string>",
"dailyBreakdown": [
{
"date": "<string>",
"amount": 123,
"description": "<string>",
"isLinked": true
}
],
"periodRange": "<string>",
"warnings": [
{
"code": "BackdatedWeeksAccruedToNextOpenRun",
"message": "<string>",
"details": {
"accruedWeeks": 123,
"accruedAmount": 123,
"accrualPaymentDate": "<string>",
"closedPeriods": [
{
"year": 123,
"period": 123,
"payPeriodStartDate": "<string>",
"payPeriodEndDate": "<string>",
"paymentDate": "<string>"
}
]
}
}
],
"averageWeeklyEarnings": 123,
"paidUntilDate": "<string>",
"paidAmount": 123,
"pendingAmount": 123,
"paidThroughPayPeriodEnd": "<string>",
"paidThroughYear": 123,
"paidThroughPeriod": 123
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}