PensionCalculation
Post pension calculation
POST
/
pension-calculation
cURL
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v2/pension/pension-calculation \
--header 'Content-Type: application/json' \
--data '
{
"employeeId": "<string>",
"frequency": "<string>",
"year": 123,
"period": 123,
"payrollConfigId": "<string>",
"employeeAmount": 123,
"employerAmount": 123,
"periodStart": "2023-12-25",
"periodEnd": "2023-12-25",
"nationalInsuranceNumber": "<string>",
"externalReferenceId": "<string>",
"pensionProviderId": "<string>"
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v2/pension/pension-calculation"
payload = {
"employeeId": "<string>",
"frequency": "<string>",
"year": 123,
"period": 123,
"payrollConfigId": "<string>",
"employeeAmount": 123,
"employerAmount": 123,
"periodStart": "2023-12-25",
"periodEnd": "2023-12-25",
"nationalInsuranceNumber": "<string>",
"externalReferenceId": "<string>",
"pensionProviderId": "<string>"
}
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>',
frequency: '<string>',
year: 123,
period: 123,
payrollConfigId: '<string>',
employeeAmount: 123,
employerAmount: 123,
periodStart: '2023-12-25',
periodEnd: '2023-12-25',
nationalInsuranceNumber: '<string>',
externalReferenceId: '<string>',
pensionProviderId: '<string>'
})
};
fetch('https://api.sandbox.flowpayroll.ai/v2/pension/pension-calculation', 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-calculation",
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>',
'frequency' => '<string>',
'year' => 123,
'period' => 123,
'payrollConfigId' => '<string>',
'employeeAmount' => 123,
'employerAmount' => 123,
'periodStart' => '2023-12-25',
'periodEnd' => '2023-12-25',
'nationalInsuranceNumber' => '<string>',
'externalReferenceId' => '<string>',
'pensionProviderId' => '<string>'
]),
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/pension-calculation"
payload := strings.NewReader("{\n \"employeeId\": \"<string>\",\n \"frequency\": \"<string>\",\n \"year\": 123,\n \"period\": 123,\n \"payrollConfigId\": \"<string>\",\n \"employeeAmount\": 123,\n \"employerAmount\": 123,\n \"periodStart\": \"2023-12-25\",\n \"periodEnd\": \"2023-12-25\",\n \"nationalInsuranceNumber\": \"<string>\",\n \"externalReferenceId\": \"<string>\",\n \"pensionProviderId\": \"<string>\"\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/pension-calculation")
.header("Content-Type", "application/json")
.body("{\n \"employeeId\": \"<string>\",\n \"frequency\": \"<string>\",\n \"year\": 123,\n \"period\": 123,\n \"payrollConfigId\": \"<string>\",\n \"employeeAmount\": 123,\n \"employerAmount\": 123,\n \"periodStart\": \"2023-12-25\",\n \"periodEnd\": \"2023-12-25\",\n \"nationalInsuranceNumber\": \"<string>\",\n \"externalReferenceId\": \"<string>\",\n \"pensionProviderId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v2/pension/pension-calculation")
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 \"frequency\": \"<string>\",\n \"year\": 123,\n \"period\": 123,\n \"payrollConfigId\": \"<string>\",\n \"employeeAmount\": 123,\n \"employerAmount\": 123,\n \"periodStart\": \"2023-12-25\",\n \"periodEnd\": \"2023-12-25\",\n \"nationalInsuranceNumber\": \"<string>\",\n \"externalReferenceId\": \"<string>\",\n \"pensionProviderId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"content": {
"data": {
"employeeId": "<string>",
"frequency": "<string>",
"year": 123,
"period": 123,
"payrollConfigId": "<string>",
"organisationId": "<string>",
"employeeAmount": 123,
"employerAmount": 123,
"periodStart": "2023-12-25",
"periodEnd": "2023-12-25",
"nationalInsuranceNumber": "<string>",
"externalReferenceId": "<string>",
"pensionProviderId": "<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>"
}
]
}
}Body
application/json
Was this page helpful?
⌘I
cURL
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v2/pension/pension-calculation \
--header 'Content-Type: application/json' \
--data '
{
"employeeId": "<string>",
"frequency": "<string>",
"year": 123,
"period": 123,
"payrollConfigId": "<string>",
"employeeAmount": 123,
"employerAmount": 123,
"periodStart": "2023-12-25",
"periodEnd": "2023-12-25",
"nationalInsuranceNumber": "<string>",
"externalReferenceId": "<string>",
"pensionProviderId": "<string>"
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v2/pension/pension-calculation"
payload = {
"employeeId": "<string>",
"frequency": "<string>",
"year": 123,
"period": 123,
"payrollConfigId": "<string>",
"employeeAmount": 123,
"employerAmount": 123,
"periodStart": "2023-12-25",
"periodEnd": "2023-12-25",
"nationalInsuranceNumber": "<string>",
"externalReferenceId": "<string>",
"pensionProviderId": "<string>"
}
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>',
frequency: '<string>',
year: 123,
period: 123,
payrollConfigId: '<string>',
employeeAmount: 123,
employerAmount: 123,
periodStart: '2023-12-25',
periodEnd: '2023-12-25',
nationalInsuranceNumber: '<string>',
externalReferenceId: '<string>',
pensionProviderId: '<string>'
})
};
fetch('https://api.sandbox.flowpayroll.ai/v2/pension/pension-calculation', 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-calculation",
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>',
'frequency' => '<string>',
'year' => 123,
'period' => 123,
'payrollConfigId' => '<string>',
'employeeAmount' => 123,
'employerAmount' => 123,
'periodStart' => '2023-12-25',
'periodEnd' => '2023-12-25',
'nationalInsuranceNumber' => '<string>',
'externalReferenceId' => '<string>',
'pensionProviderId' => '<string>'
]),
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/pension-calculation"
payload := strings.NewReader("{\n \"employeeId\": \"<string>\",\n \"frequency\": \"<string>\",\n \"year\": 123,\n \"period\": 123,\n \"payrollConfigId\": \"<string>\",\n \"employeeAmount\": 123,\n \"employerAmount\": 123,\n \"periodStart\": \"2023-12-25\",\n \"periodEnd\": \"2023-12-25\",\n \"nationalInsuranceNumber\": \"<string>\",\n \"externalReferenceId\": \"<string>\",\n \"pensionProviderId\": \"<string>\"\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/pension-calculation")
.header("Content-Type", "application/json")
.body("{\n \"employeeId\": \"<string>\",\n \"frequency\": \"<string>\",\n \"year\": 123,\n \"period\": 123,\n \"payrollConfigId\": \"<string>\",\n \"employeeAmount\": 123,\n \"employerAmount\": 123,\n \"periodStart\": \"2023-12-25\",\n \"periodEnd\": \"2023-12-25\",\n \"nationalInsuranceNumber\": \"<string>\",\n \"externalReferenceId\": \"<string>\",\n \"pensionProviderId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v2/pension/pension-calculation")
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 \"frequency\": \"<string>\",\n \"year\": 123,\n \"period\": 123,\n \"payrollConfigId\": \"<string>\",\n \"employeeAmount\": 123,\n \"employerAmount\": 123,\n \"periodStart\": \"2023-12-25\",\n \"periodEnd\": \"2023-12-25\",\n \"nationalInsuranceNumber\": \"<string>\",\n \"externalReferenceId\": \"<string>\",\n \"pensionProviderId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"content": {
"data": {
"employeeId": "<string>",
"frequency": "<string>",
"year": 123,
"period": 123,
"payrollConfigId": "<string>",
"organisationId": "<string>",
"employeeAmount": 123,
"employerAmount": 123,
"periodStart": "2023-12-25",
"periodEnd": "2023-12-25",
"nationalInsuranceNumber": "<string>",
"externalReferenceId": "<string>",
"pensionProviderId": "<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>"
}
]
}
}