PayrollConfig
Update a payroll configuration
PUT
/
payrollconfig
/
{payrollConfigId}
Update a payroll configuration
curl --request PUT \
--url https://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId} \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"tags": [
{
"name": "FullTime",
"group": "EmploymentType",
"value": "FullTime"
}
],
"paymentPeriodConfig": {
"startingDayOfMonth": 1,
"startingDayOfWeek": "Monday",
"startingDayOfWeekOffSet": 0,
"startingDayOfMonthOffSet": 0
},
"processZeroGrossPayslips": false,
"includeZeroGrossPayslipsInFps": true
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}"
payload = {
"name": "<string>",
"description": "<string>",
"tags": [
{
"name": "FullTime",
"group": "EmploymentType",
"value": "FullTime"
}
],
"paymentPeriodConfig": {
"startingDayOfMonth": 1,
"startingDayOfWeek": "Monday",
"startingDayOfWeekOffSet": 0,
"startingDayOfMonthOffSet": 0
},
"processZeroGrossPayslips": False,
"includeZeroGrossPayslipsInFps": True
}
headers = {
"X-Auth-Token": "<api-key>",
"X-Org-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'X-Auth-Token': '<api-key>',
'X-Org-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
description: '<string>',
tags: [{name: 'FullTime', group: 'EmploymentType', value: 'FullTime'}],
paymentPeriodConfig: {
startingDayOfMonth: 1,
startingDayOfWeek: 'Monday',
startingDayOfWeekOffSet: 0,
startingDayOfMonthOffSet: 0
},
processZeroGrossPayslips: false,
includeZeroGrossPayslipsInFps: true
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'tags' => [
[
'name' => 'FullTime',
'group' => 'EmploymentType',
'value' => 'FullTime'
]
],
'paymentPeriodConfig' => [
'startingDayOfMonth' => 1,
'startingDayOfWeek' => 'Monday',
'startingDayOfWeekOffSet' => 0,
'startingDayOfMonthOffSet' => 0
],
'processZeroGrossPayslips' => false,
'includeZeroGrossPayslipsInFps' => 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/payrollconfig/{payrollConfigId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n {\n \"name\": \"FullTime\",\n \"group\": \"EmploymentType\",\n \"value\": \"FullTime\"\n }\n ],\n \"paymentPeriodConfig\": {\n \"startingDayOfMonth\": 1,\n \"startingDayOfWeek\": \"Monday\",\n \"startingDayOfWeekOffSet\": 0,\n \"startingDayOfMonthOffSet\": 0\n },\n \"processZeroGrossPayslips\": false,\n \"includeZeroGrossPayslipsInFps\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n {\n \"name\": \"FullTime\",\n \"group\": \"EmploymentType\",\n \"value\": \"FullTime\"\n }\n ],\n \"paymentPeriodConfig\": {\n \"startingDayOfMonth\": 1,\n \"startingDayOfWeek\": \"Monday\",\n \"startingDayOfWeekOffSet\": 0,\n \"startingDayOfMonthOffSet\": 0\n },\n \"processZeroGrossPayslips\": false,\n \"includeZeroGrossPayslipsInFps\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n {\n \"name\": \"FullTime\",\n \"group\": \"EmploymentType\",\n \"value\": \"FullTime\"\n }\n ],\n \"paymentPeriodConfig\": {\n \"startingDayOfMonth\": 1,\n \"startingDayOfWeek\": \"Monday\",\n \"startingDayOfWeekOffSet\": 0,\n \"startingDayOfMonthOffSet\": 0\n },\n \"processZeroGrossPayslips\": false,\n \"includeZeroGrossPayslipsInFps\": true\n}"
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {
"name": "<string>",
"description": "<string>",
"id": "<string>",
"tags": [
{
"name": "FullTime",
"group": "EmploymentType",
"value": "FullTime"
}
],
"paymentDateConfig": {
"dayOfMonth": 123,
"weekOfMonth": 123,
"month": 123,
"isWorkingDay": true,
"customRuleParams": "<string>",
"whichWeekInPeriod": 123
},
"paymentPeriodConfig": {
"startingDayOfMonth": 1,
"startingDayOfWeek": "Monday",
"startingDayOfWeekOffSet": 0,
"startingDayOfMonthOffSet": 0
},
"processZeroGrossPayslips": false,
"includeZeroGrossPayslipsInFps": true,
"createdBy": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedDate": "2023-11-07T05:31:56Z",
"organisationId": "<string>"
},
"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>"
}
]
}
],
"messageToken": "<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>"
}
]
}
],
"messageToken": "<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>"
}
]
}
],
"messageToken": "<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
Body
application/json
Available options:
Annual, Monthly, FourWeekly, Fortnightly, Weekly, Daily, Quarterly, BiAnnually Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Whether to process payslips with no line items (zero gross). Defaults to false.
When true (default), payslips with totally-zero values (Gross, Net, Tax, Ni etc all 0) are included in FPS preview AND submission. When false, they are filtered out of both so HMRC never sees zeroed records that have no payment to report. Same flag controls preview and submit (single source of truth — no drift).
Was this page helpful?
⌘I
Update a payroll configuration
curl --request PUT \
--url https://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId} \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"tags": [
{
"name": "FullTime",
"group": "EmploymentType",
"value": "FullTime"
}
],
"paymentPeriodConfig": {
"startingDayOfMonth": 1,
"startingDayOfWeek": "Monday",
"startingDayOfWeekOffSet": 0,
"startingDayOfMonthOffSet": 0
},
"processZeroGrossPayslips": false,
"includeZeroGrossPayslipsInFps": true
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}"
payload = {
"name": "<string>",
"description": "<string>",
"tags": [
{
"name": "FullTime",
"group": "EmploymentType",
"value": "FullTime"
}
],
"paymentPeriodConfig": {
"startingDayOfMonth": 1,
"startingDayOfWeek": "Monday",
"startingDayOfWeekOffSet": 0,
"startingDayOfMonthOffSet": 0
},
"processZeroGrossPayslips": False,
"includeZeroGrossPayslipsInFps": True
}
headers = {
"X-Auth-Token": "<api-key>",
"X-Org-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'X-Auth-Token': '<api-key>',
'X-Org-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
description: '<string>',
tags: [{name: 'FullTime', group: 'EmploymentType', value: 'FullTime'}],
paymentPeriodConfig: {
startingDayOfMonth: 1,
startingDayOfWeek: 'Monday',
startingDayOfWeekOffSet: 0,
startingDayOfMonthOffSet: 0
},
processZeroGrossPayslips: false,
includeZeroGrossPayslipsInFps: true
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'tags' => [
[
'name' => 'FullTime',
'group' => 'EmploymentType',
'value' => 'FullTime'
]
],
'paymentPeriodConfig' => [
'startingDayOfMonth' => 1,
'startingDayOfWeek' => 'Monday',
'startingDayOfWeekOffSet' => 0,
'startingDayOfMonthOffSet' => 0
],
'processZeroGrossPayslips' => false,
'includeZeroGrossPayslipsInFps' => 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/payrollconfig/{payrollConfigId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n {\n \"name\": \"FullTime\",\n \"group\": \"EmploymentType\",\n \"value\": \"FullTime\"\n }\n ],\n \"paymentPeriodConfig\": {\n \"startingDayOfMonth\": 1,\n \"startingDayOfWeek\": \"Monday\",\n \"startingDayOfWeekOffSet\": 0,\n \"startingDayOfMonthOffSet\": 0\n },\n \"processZeroGrossPayslips\": false,\n \"includeZeroGrossPayslipsInFps\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n {\n \"name\": \"FullTime\",\n \"group\": \"EmploymentType\",\n \"value\": \"FullTime\"\n }\n ],\n \"paymentPeriodConfig\": {\n \"startingDayOfMonth\": 1,\n \"startingDayOfWeek\": \"Monday\",\n \"startingDayOfWeekOffSet\": 0,\n \"startingDayOfMonthOffSet\": 0\n },\n \"processZeroGrossPayslips\": false,\n \"includeZeroGrossPayslipsInFps\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/payrollconfig/{payrollConfigId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n {\n \"name\": \"FullTime\",\n \"group\": \"EmploymentType\",\n \"value\": \"FullTime\"\n }\n ],\n \"paymentPeriodConfig\": {\n \"startingDayOfMonth\": 1,\n \"startingDayOfWeek\": \"Monday\",\n \"startingDayOfWeekOffSet\": 0,\n \"startingDayOfMonthOffSet\": 0\n },\n \"processZeroGrossPayslips\": false,\n \"includeZeroGrossPayslipsInFps\": true\n}"
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {
"name": "<string>",
"description": "<string>",
"id": "<string>",
"tags": [
{
"name": "FullTime",
"group": "EmploymentType",
"value": "FullTime"
}
],
"paymentDateConfig": {
"dayOfMonth": 123,
"weekOfMonth": 123,
"month": 123,
"isWorkingDay": true,
"customRuleParams": "<string>",
"whichWeekInPeriod": 123
},
"paymentPeriodConfig": {
"startingDayOfMonth": 1,
"startingDayOfWeek": "Monday",
"startingDayOfWeekOffSet": 0,
"startingDayOfMonthOffSet": 0
},
"processZeroGrossPayslips": false,
"includeZeroGrossPayslipsInFps": true,
"createdBy": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedDate": "2023-11-07T05:31:56Z",
"organisationId": "<string>"
},
"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>"
}
]
}
],
"messageToken": "<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>"
}
]
}
],
"messageToken": "<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>"
}
]
}
],
"messageToken": "<string>"
}