Statutory payments
Post paymentsemployees
POST
/
payments
/
employees
/
{employeeId}
cURL
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v1/statutory-pay/payments/employees/{employeeId} \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>' \
--data '
{
"statutoryType": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"qualifyingEventDate": "<string>",
"averageEarningsOverride": 123,
"attachments": [
{
"filename": "<string>",
"contentType": "<string>",
"fileSize": 123
}
],
"paidWeeks": 123,
"paidUntilDate": "<string>",
"expectedWeekOfPlacement": "<string>",
"isReceivingStatutoryMaternityPay": true,
"previousSicknessPeriods": [
{
"startDate": "<string>",
"endDate": "<string>",
"wereFirstThreeDaysPaid": true
}
]
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/statutory-pay/payments/employees/{employeeId}"
payload = {
"statutoryType": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"qualifyingEventDate": "<string>",
"averageEarningsOverride": 123,
"attachments": [
{
"filename": "<string>",
"contentType": "<string>",
"fileSize": 123
}
],
"paidWeeks": 123,
"paidUntilDate": "<string>",
"expectedWeekOfPlacement": "<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({
statutoryType: '<string>',
startDate: '<string>',
endDate: '<string>',
qualifyingEventDate: '<string>',
averageEarningsOverride: 123,
attachments: [{filename: '<string>', contentType: '<string>', fileSize: 123}],
paidWeeks: 123,
paidUntilDate: '<string>',
expectedWeekOfPlacement: '<string>',
isReceivingStatutoryMaternityPay: true,
previousSicknessPeriods: [{startDate: '<string>', endDate: '<string>', wereFirstThreeDaysPaid: true}]
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/statutory-pay/payments/employees/{employeeId}', 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/payments/employees/{employeeId}",
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([
'statutoryType' => '<string>',
'startDate' => '<string>',
'endDate' => '<string>',
'qualifyingEventDate' => '<string>',
'averageEarningsOverride' => 123,
'attachments' => [
[
'filename' => '<string>',
'contentType' => '<string>',
'fileSize' => 123
]
],
'paidWeeks' => 123,
'paidUntilDate' => '<string>',
'expectedWeekOfPlacement' => '<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/payments/employees/{employeeId}"
payload := strings.NewReader("{\n \"statutoryType\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"qualifyingEventDate\": \"<string>\",\n \"averageEarningsOverride\": 123,\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"contentType\": \"<string>\",\n \"fileSize\": 123\n }\n ],\n \"paidWeeks\": 123,\n \"paidUntilDate\": \"<string>\",\n \"expectedWeekOfPlacement\": \"<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/payments/employees/{employeeId}")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"statutoryType\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"qualifyingEventDate\": \"<string>\",\n \"averageEarningsOverride\": 123,\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"contentType\": \"<string>\",\n \"fileSize\": 123\n }\n ],\n \"paidWeeks\": 123,\n \"paidUntilDate\": \"<string>\",\n \"expectedWeekOfPlacement\": \"<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/payments/employees/{employeeId}")
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 \"statutoryType\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"qualifyingEventDate\": \"<string>\",\n \"averageEarningsOverride\": 123,\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"contentType\": \"<string>\",\n \"fileSize\": 123\n }\n ],\n \"paidWeeks\": 123,\n \"paidUntilDate\": \"<string>\",\n \"expectedWeekOfPlacement\": \"<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).
Path Parameters
Query Parameters
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
- Option 14
- Option 15
- Option 16
- Option 17
- Option 18
- Option 19
- Option 20
- Option 21
- Option 22
- Option 23
- Option 24
- Option 25
- Option 26
- Option 27
- Option 28
- Option 29
- Option 30
- Option 31
- Option 32
- Option 33
- Option 34
- Option 35
- Option 36
- Option 37
- Option 38
- Option 39
- Option 40
- Option 41
- Option 42
- Option 43
- Option 44
- Option 45
- Option 46
- Option 47
- Option 48
- Option 49
- Option 50
- Option 51
- Option 52
- Option 53
- Option 54
- Option 55
Show 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/payments/employees/{employeeId} \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>' \
--data '
{
"statutoryType": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"qualifyingEventDate": "<string>",
"averageEarningsOverride": 123,
"attachments": [
{
"filename": "<string>",
"contentType": "<string>",
"fileSize": 123
}
],
"paidWeeks": 123,
"paidUntilDate": "<string>",
"expectedWeekOfPlacement": "<string>",
"isReceivingStatutoryMaternityPay": true,
"previousSicknessPeriods": [
{
"startDate": "<string>",
"endDate": "<string>",
"wereFirstThreeDaysPaid": true
}
]
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/statutory-pay/payments/employees/{employeeId}"
payload = {
"statutoryType": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"qualifyingEventDate": "<string>",
"averageEarningsOverride": 123,
"attachments": [
{
"filename": "<string>",
"contentType": "<string>",
"fileSize": 123
}
],
"paidWeeks": 123,
"paidUntilDate": "<string>",
"expectedWeekOfPlacement": "<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({
statutoryType: '<string>',
startDate: '<string>',
endDate: '<string>',
qualifyingEventDate: '<string>',
averageEarningsOverride: 123,
attachments: [{filename: '<string>', contentType: '<string>', fileSize: 123}],
paidWeeks: 123,
paidUntilDate: '<string>',
expectedWeekOfPlacement: '<string>',
isReceivingStatutoryMaternityPay: true,
previousSicknessPeriods: [{startDate: '<string>', endDate: '<string>', wereFirstThreeDaysPaid: true}]
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/statutory-pay/payments/employees/{employeeId}', 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/payments/employees/{employeeId}",
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([
'statutoryType' => '<string>',
'startDate' => '<string>',
'endDate' => '<string>',
'qualifyingEventDate' => '<string>',
'averageEarningsOverride' => 123,
'attachments' => [
[
'filename' => '<string>',
'contentType' => '<string>',
'fileSize' => 123
]
],
'paidWeeks' => 123,
'paidUntilDate' => '<string>',
'expectedWeekOfPlacement' => '<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/payments/employees/{employeeId}"
payload := strings.NewReader("{\n \"statutoryType\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"qualifyingEventDate\": \"<string>\",\n \"averageEarningsOverride\": 123,\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"contentType\": \"<string>\",\n \"fileSize\": 123\n }\n ],\n \"paidWeeks\": 123,\n \"paidUntilDate\": \"<string>\",\n \"expectedWeekOfPlacement\": \"<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/payments/employees/{employeeId}")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"statutoryType\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"qualifyingEventDate\": \"<string>\",\n \"averageEarningsOverride\": 123,\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"contentType\": \"<string>\",\n \"fileSize\": 123\n }\n ],\n \"paidWeeks\": 123,\n \"paidUntilDate\": \"<string>\",\n \"expectedWeekOfPlacement\": \"<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/payments/employees/{employeeId}")
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 \"statutoryType\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"qualifyingEventDate\": \"<string>\",\n \"averageEarningsOverride\": 123,\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"contentType\": \"<string>\",\n \"fileSize\": 123\n }\n ],\n \"paidWeeks\": 123,\n \"paidUntilDate\": \"<string>\",\n \"expectedWeekOfPlacement\": \"<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
}
]
}
]
}