PensionInformation
Get pension information
GET
/
pension-information
/
{employeeId}
cURL
curl --request GET \
--url https://api.sandbox.flowpayroll.ai/v2/pension/pension-information/{employeeId}import requests
url = "https://api.sandbox.flowpayroll.ai/v2/pension/pension-information/{employeeId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.sandbox.flowpayroll.ai/v2/pension/pension-information/{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/v2/pension/pension-information/{employeeId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v2/pension/pension-information/{employeeId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.flowpayroll.ai/v2/pension/pension-information/{employeeId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v2/pension/pension-information/{employeeId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"content": {
"data": {
"pension": {
"organisationId": "<string>",
"employeeId": "<string>",
"pensionGroupId": "<string>",
"enrolmentDate": "2023-12-25",
"pensionGroup": {
"id": "<string>",
"organisationId": "<string>",
"pensionSchemaId": "<string>",
"name": "<string>",
"isDefault": true,
"basis": "<string>",
"employeeFactor": 123,
"employerFactor": 123,
"nationalInsuranceSavingsFactor": 123,
"createdBy": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedDate": "2023-11-07T05:31:56Z",
"isSalarySacrifice": true,
"externalReferenceId": "<string>"
},
"isAutoEnrolled": true,
"isAdminEnrolled": true,
"autoEnrolmentPensionGroup": {
"id": "<string>",
"organisationId": "<string>",
"pensionSchemaId": "<string>",
"name": "<string>",
"isDefault": true,
"basis": "<string>",
"employeeFactor": 123,
"employerFactor": 123,
"nationalInsuranceSavingsFactor": 123,
"createdBy": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedDate": "2023-11-07T05:31:56Z",
"isSalarySacrifice": true,
"externalReferenceId": "<string>"
},
"manualEnrolmentPensionGroup": {
"id": "<string>",
"organisationId": "<string>",
"pensionSchemaId": "<string>",
"name": "<string>",
"isDefault": true,
"basis": "<string>",
"employeeFactor": 123,
"employerFactor": 123,
"nationalInsuranceSavingsFactor": 123,
"createdBy": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedDate": "2023-11-07T05:31:56Z",
"isSalarySacrifice": true,
"externalReferenceId": "<string>"
},
"adminPensionGroup": {
"id": "<string>",
"organisationId": "<string>",
"pensionSchemaId": "<string>",
"name": "<string>",
"isDefault": true,
"basis": "<string>",
"employeeFactor": 123,
"employerFactor": 123,
"nationalInsuranceSavingsFactor": 123,
"createdBy": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedDate": "2023-11-07T05:31:56Z",
"isSalarySacrifice": true,
"externalReferenceId": "<string>"
},
"enrolmentType": "<string>"
},
"autoEnrolmentDetermination": {
"determinationDate": "2023-12-25",
"revisionNumber": 123,
"assessmentResult": "<string>",
"enrolmentType": "<string>",
"isComplete": true,
"isManualEnrolled": true,
"optOutDate": "2023-12-25",
"postponement": {
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"postponementType": "<string>"
}
},
"postponement": {
"organisationId": "<string>",
"employeeId": "<string>",
"startDateDefinition": {
"value": 123,
"frequency": "<string>"
},
"eligibilityDateDefinition": {
"value": 123,
"frequency": "<string>"
}
}
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
}
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
},
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"message": {
"text": "<string>",
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
}Was this page helpful?
⌘I
cURL
curl --request GET \
--url https://api.sandbox.flowpayroll.ai/v2/pension/pension-information/{employeeId}import requests
url = "https://api.sandbox.flowpayroll.ai/v2/pension/pension-information/{employeeId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.sandbox.flowpayroll.ai/v2/pension/pension-information/{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/v2/pension/pension-information/{employeeId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v2/pension/pension-information/{employeeId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.flowpayroll.ai/v2/pension/pension-information/{employeeId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v2/pension/pension-information/{employeeId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"content": {
"data": {
"pension": {
"organisationId": "<string>",
"employeeId": "<string>",
"pensionGroupId": "<string>",
"enrolmentDate": "2023-12-25",
"pensionGroup": {
"id": "<string>",
"organisationId": "<string>",
"pensionSchemaId": "<string>",
"name": "<string>",
"isDefault": true,
"basis": "<string>",
"employeeFactor": 123,
"employerFactor": 123,
"nationalInsuranceSavingsFactor": 123,
"createdBy": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedDate": "2023-11-07T05:31:56Z",
"isSalarySacrifice": true,
"externalReferenceId": "<string>"
},
"isAutoEnrolled": true,
"isAdminEnrolled": true,
"autoEnrolmentPensionGroup": {
"id": "<string>",
"organisationId": "<string>",
"pensionSchemaId": "<string>",
"name": "<string>",
"isDefault": true,
"basis": "<string>",
"employeeFactor": 123,
"employerFactor": 123,
"nationalInsuranceSavingsFactor": 123,
"createdBy": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedDate": "2023-11-07T05:31:56Z",
"isSalarySacrifice": true,
"externalReferenceId": "<string>"
},
"manualEnrolmentPensionGroup": {
"id": "<string>",
"organisationId": "<string>",
"pensionSchemaId": "<string>",
"name": "<string>",
"isDefault": true,
"basis": "<string>",
"employeeFactor": 123,
"employerFactor": 123,
"nationalInsuranceSavingsFactor": 123,
"createdBy": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedDate": "2023-11-07T05:31:56Z",
"isSalarySacrifice": true,
"externalReferenceId": "<string>"
},
"adminPensionGroup": {
"id": "<string>",
"organisationId": "<string>",
"pensionSchemaId": "<string>",
"name": "<string>",
"isDefault": true,
"basis": "<string>",
"employeeFactor": 123,
"employerFactor": 123,
"nationalInsuranceSavingsFactor": 123,
"createdBy": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedDate": "2023-11-07T05:31:56Z",
"isSalarySacrifice": true,
"externalReferenceId": "<string>"
},
"enrolmentType": "<string>"
},
"autoEnrolmentDetermination": {
"determinationDate": "2023-12-25",
"revisionNumber": 123,
"assessmentResult": "<string>",
"enrolmentType": "<string>",
"isComplete": true,
"isManualEnrolled": true,
"optOutDate": "2023-12-25",
"postponement": {
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"postponementType": "<string>"
}
},
"postponement": {
"organisationId": "<string>",
"employeeId": "<string>",
"startDateDefinition": {
"value": 123,
"frequency": "<string>"
},
"eligibilityDateDefinition": {
"value": 123,
"frequency": "<string>"
}
}
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
}
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
},
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"message": {
"text": "<string>",
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
}