Employee enrolment
Enrol an employee
Associates an employee with a pension group, recording the enrolment date.
POST
/
employee-pension
Enrol an employee
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v2/pension/employee-pension \
--header 'Content-Type: application/json' \
--data '
{
"employeeId": "<string>",
"pensionGroupId": "<string>",
"enrolmentDate": "2023-12-25",
"acknowledgeBelowAutoEnrolmentMinimum": true,
"sendLetters": true
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v2/pension/employee-pension"
payload = {
"employeeId": "<string>",
"pensionGroupId": "<string>",
"enrolmentDate": "2023-12-25",
"acknowledgeBelowAutoEnrolmentMinimum": True,
"sendLetters": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
employeeId: '<string>',
pensionGroupId: '<string>',
enrolmentDate: '2023-12-25',
acknowledgeBelowAutoEnrolmentMinimum: true,
sendLetters: true
})
};
fetch('https://api.sandbox.flowpayroll.ai/v2/pension/employee-pension', 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/v2/pension/employee-pension",
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([
'employeeId' => '<string>',
'pensionGroupId' => '<string>',
'enrolmentDate' => '2023-12-25',
'acknowledgeBelowAutoEnrolmentMinimum' => true,
'sendLetters' => true
]),
CURLOPT_HTTPHEADER => [
"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://api.sandbox.flowpayroll.ai/v2/pension/employee-pension"
payload := strings.NewReader("{\n \"employeeId\": \"<string>\",\n \"pensionGroupId\": \"<string>\",\n \"enrolmentDate\": \"2023-12-25\",\n \"acknowledgeBelowAutoEnrolmentMinimum\": true,\n \"sendLetters\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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/v2/pension/employee-pension")
.header("Content-Type", "application/json")
.body("{\n \"employeeId\": \"<string>\",\n \"pensionGroupId\": \"<string>\",\n \"enrolmentDate\": \"2023-12-25\",\n \"acknowledgeBelowAutoEnrolmentMinimum\": true,\n \"sendLetters\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v2/pension/employee-pension")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"employeeId\": \"<string>\",\n \"pensionGroupId\": \"<string>\",\n \"enrolmentDate\": \"2023-12-25\",\n \"acknowledgeBelowAutoEnrolmentMinimum\": true,\n \"sendLetters\": true\n}"
response = http.request(request)
puts response.read_body{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {
"organisationId": "<string>",
"employeeId": "<string>",
"pensionGroupId": "<string>",
"enrolmentDate": "2023-12-25",
"createdBy": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedDate": "2023-11-07T05:31:56Z",
"recurringContributionOverride": {
"contributionType": "Percentage",
"employeeFactor": 123,
"employerFactor": 123,
"employeeFixedAmount": 123,
"employerFixedAmount": 123
},
"recurringAdditionalVoluntaryContribution": {
"contributionType": "Percentage",
"value": 123
},
"enrolmentInformationSentDate": "2023-12-25",
"enrolmentInformationSentBy": "<string>",
"enrolmentLetter": {
"lastEmailedAt": "2023-11-07T05:31:56Z",
"lastEmailedBy": "<string>",
"lastEmailedStatus": "Sending",
"lastEmailedTo": "<string>",
"lastEmailError": "<string>"
}
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}Body
application/json
Per-employee contribution override. When present on an association it fully replaces the pension group's contribution settings.
Show child attributes
Show child attributes
Standing additional voluntary contribution the member pays every pay period on top of the scheme contribution.
Show child attributes
Show child attributes
Confirms the contribution override is deliberately below the automatic enrolment minimum (8% total / 3% employer) or uses a fixed amount. Without it such an override is rejected.
Response
OK
The response envelope every FlowPayroll API answers with: a message, the
content, and any validationIssues. errors and the top-level
metadata are deprecated copies of validationIssues and
content.metadata, and will be removed.
What happened, as English text and a stable token to translate from.
textId and textParameters are deprecated copies of token and tokenArguments.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Deprecated: the same issues as validationIssues (reasonText is reason, reasonId is reasonToken, reasonParameters is reasonTokenArguments). Read validationIssues; this will be removed.
Show child attributes
Show child attributes
Deprecated: the same values as content.metadata. Read that; this will be removed.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Enrol an employee
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v2/pension/employee-pension \
--header 'Content-Type: application/json' \
--data '
{
"employeeId": "<string>",
"pensionGroupId": "<string>",
"enrolmentDate": "2023-12-25",
"acknowledgeBelowAutoEnrolmentMinimum": true,
"sendLetters": true
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v2/pension/employee-pension"
payload = {
"employeeId": "<string>",
"pensionGroupId": "<string>",
"enrolmentDate": "2023-12-25",
"acknowledgeBelowAutoEnrolmentMinimum": True,
"sendLetters": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
employeeId: '<string>',
pensionGroupId: '<string>',
enrolmentDate: '2023-12-25',
acknowledgeBelowAutoEnrolmentMinimum: true,
sendLetters: true
})
};
fetch('https://api.sandbox.flowpayroll.ai/v2/pension/employee-pension', 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/v2/pension/employee-pension",
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([
'employeeId' => '<string>',
'pensionGroupId' => '<string>',
'enrolmentDate' => '2023-12-25',
'acknowledgeBelowAutoEnrolmentMinimum' => true,
'sendLetters' => true
]),
CURLOPT_HTTPHEADER => [
"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://api.sandbox.flowpayroll.ai/v2/pension/employee-pension"
payload := strings.NewReader("{\n \"employeeId\": \"<string>\",\n \"pensionGroupId\": \"<string>\",\n \"enrolmentDate\": \"2023-12-25\",\n \"acknowledgeBelowAutoEnrolmentMinimum\": true,\n \"sendLetters\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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/v2/pension/employee-pension")
.header("Content-Type", "application/json")
.body("{\n \"employeeId\": \"<string>\",\n \"pensionGroupId\": \"<string>\",\n \"enrolmentDate\": \"2023-12-25\",\n \"acknowledgeBelowAutoEnrolmentMinimum\": true,\n \"sendLetters\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v2/pension/employee-pension")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"employeeId\": \"<string>\",\n \"pensionGroupId\": \"<string>\",\n \"enrolmentDate\": \"2023-12-25\",\n \"acknowledgeBelowAutoEnrolmentMinimum\": true,\n \"sendLetters\": true\n}"
response = http.request(request)
puts response.read_body{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {
"organisationId": "<string>",
"employeeId": "<string>",
"pensionGroupId": "<string>",
"enrolmentDate": "2023-12-25",
"createdBy": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedDate": "2023-11-07T05:31:56Z",
"recurringContributionOverride": {
"contributionType": "Percentage",
"employeeFactor": 123,
"employerFactor": 123,
"employeeFixedAmount": 123,
"employerFixedAmount": 123
},
"recurringAdditionalVoluntaryContribution": {
"contributionType": "Percentage",
"value": 123
},
"enrolmentInformationSentDate": "2023-12-25",
"enrolmentInformationSentBy": "<string>",
"enrolmentLetter": {
"lastEmailedAt": "2023-11-07T05:31:56Z",
"lastEmailedBy": "<string>",
"lastEmailedStatus": "Sending",
"lastEmailedTo": "<string>",
"lastEmailError": "<string>"
}
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}