PensionScheme
Put pension schema
PUT
/
pension-schema
/
{id}
cURL
curl --request PUT \
--url https://api.sandbox.flowpayroll.ai/v2/pension/pension-schema/{id} \
--header 'Content-Type: application/json' \
--data '
{
"pensionProviderId": "<string>",
"name": "<string>",
"paymentSource": "<string>",
"lastReEnrolmentDate": "2023-12-25",
"dutyStartDate": "2023-12-25",
"externalReferenceId": "<string>"
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v2/pension/pension-schema/{id}"
payload = {
"pensionProviderId": "<string>",
"name": "<string>",
"paymentSource": "<string>",
"lastReEnrolmentDate": "2023-12-25",
"dutyStartDate": "2023-12-25",
"externalReferenceId": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
pensionProviderId: '<string>',
name: '<string>',
paymentSource: '<string>',
lastReEnrolmentDate: '2023-12-25',
dutyStartDate: '2023-12-25',
externalReferenceId: '<string>'
})
};
fetch('https://api.sandbox.flowpayroll.ai/v2/pension/pension-schema/{id}', 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-schema/{id}",
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([
'pensionProviderId' => '<string>',
'name' => '<string>',
'paymentSource' => '<string>',
'lastReEnrolmentDate' => '2023-12-25',
'dutyStartDate' => '2023-12-25',
'externalReferenceId' => '<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-schema/{id}"
payload := strings.NewReader("{\n \"pensionProviderId\": \"<string>\",\n \"name\": \"<string>\",\n \"paymentSource\": \"<string>\",\n \"lastReEnrolmentDate\": \"2023-12-25\",\n \"dutyStartDate\": \"2023-12-25\",\n \"externalReferenceId\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.sandbox.flowpayroll.ai/v2/pension/pension-schema/{id}")
.header("Content-Type", "application/json")
.body("{\n \"pensionProviderId\": \"<string>\",\n \"name\": \"<string>\",\n \"paymentSource\": \"<string>\",\n \"lastReEnrolmentDate\": \"2023-12-25\",\n \"dutyStartDate\": \"2023-12-25\",\n \"externalReferenceId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v2/pension/pension-schema/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"pensionProviderId\": \"<string>\",\n \"name\": \"<string>\",\n \"paymentSource\": \"<string>\",\n \"lastReEnrolmentDate\": \"2023-12-25\",\n \"dutyStartDate\": \"2023-12-25\",\n \"externalReferenceId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"content": {
"data": {
"id": "<string>",
"organisationId": "<string>",
"pensionProviderId": "<string>",
"name": "<string>",
"createdBy": "<string>",
"createdDate": "<string>",
"updatedBy": "<string>",
"updatedDate": "<string>",
"paymentSource": "<string>",
"lastReEnrolmentDate": "2023-12-25",
"dutyStartDate": "2023-12-25",
"externalReferenceId": "<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>"
}
]
}
}Path Parameters
Body
application/json
Available options:
NationalInsuranceNumber, PayrollId, EmployeeCode, EmployeeId Was this page helpful?
⌘I
cURL
curl --request PUT \
--url https://api.sandbox.flowpayroll.ai/v2/pension/pension-schema/{id} \
--header 'Content-Type: application/json' \
--data '
{
"pensionProviderId": "<string>",
"name": "<string>",
"paymentSource": "<string>",
"lastReEnrolmentDate": "2023-12-25",
"dutyStartDate": "2023-12-25",
"externalReferenceId": "<string>"
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v2/pension/pension-schema/{id}"
payload = {
"pensionProviderId": "<string>",
"name": "<string>",
"paymentSource": "<string>",
"lastReEnrolmentDate": "2023-12-25",
"dutyStartDate": "2023-12-25",
"externalReferenceId": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
pensionProviderId: '<string>',
name: '<string>',
paymentSource: '<string>',
lastReEnrolmentDate: '2023-12-25',
dutyStartDate: '2023-12-25',
externalReferenceId: '<string>'
})
};
fetch('https://api.sandbox.flowpayroll.ai/v2/pension/pension-schema/{id}', 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-schema/{id}",
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([
'pensionProviderId' => '<string>',
'name' => '<string>',
'paymentSource' => '<string>',
'lastReEnrolmentDate' => '2023-12-25',
'dutyStartDate' => '2023-12-25',
'externalReferenceId' => '<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-schema/{id}"
payload := strings.NewReader("{\n \"pensionProviderId\": \"<string>\",\n \"name\": \"<string>\",\n \"paymentSource\": \"<string>\",\n \"lastReEnrolmentDate\": \"2023-12-25\",\n \"dutyStartDate\": \"2023-12-25\",\n \"externalReferenceId\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.sandbox.flowpayroll.ai/v2/pension/pension-schema/{id}")
.header("Content-Type", "application/json")
.body("{\n \"pensionProviderId\": \"<string>\",\n \"name\": \"<string>\",\n \"paymentSource\": \"<string>\",\n \"lastReEnrolmentDate\": \"2023-12-25\",\n \"dutyStartDate\": \"2023-12-25\",\n \"externalReferenceId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v2/pension/pension-schema/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"pensionProviderId\": \"<string>\",\n \"name\": \"<string>\",\n \"paymentSource\": \"<string>\",\n \"lastReEnrolmentDate\": \"2023-12-25\",\n \"dutyStartDate\": \"2023-12-25\",\n \"externalReferenceId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"content": {
"data": {
"id": "<string>",
"organisationId": "<string>",
"pensionProviderId": "<string>",
"name": "<string>",
"createdBy": "<string>",
"createdDate": "<string>",
"updatedBy": "<string>",
"updatedDate": "<string>",
"paymentSource": "<string>",
"lastReEnrolmentDate": "2023-12-25",
"dutyStartDate": "2023-12-25",
"externalReferenceId": "<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>"
}
]
}
}