P45
Get p45list finalised 1
GET
/
p45
/
list
/
{payrollConfigId}
/
{taxYear}
/
finalised
cURL
curl --request GET \
--url https://api.sandbox.flowpayroll.ai/v1/hmrc-p-forms/p45/list/{payrollConfigId}/{taxYear}/finalised \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/hmrc-p-forms/p45/list/{payrollConfigId}/{taxYear}/finalised"
headers = {
"X-Auth-Token": "<api-key>",
"X-Org-Id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>', 'X-Org-Id': '<api-key>'}};
fetch('https://api.sandbox.flowpayroll.ai/v1/hmrc-p-forms/p45/list/{payrollConfigId}/{taxYear}/finalised', 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/hmrc-p-forms/p45/list/{payrollConfigId}/{taxYear}/finalised",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v1/hmrc-p-forms/p45/list/{payrollConfigId}/{taxYear}/finalised"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("X-Org-Id", "<api-key>")
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/v1/hmrc-p-forms/p45/list/{payrollConfigId}/{taxYear}/finalised")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/hmrc-p-forms/p45/list/{payrollConfigId}/{taxYear}/finalised")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": [
{
"organisationId": "<string>",
"employeeId": "<string>",
"taxYear": 123,
"status": "<string>",
"fileName": "<string>",
"contentType": "<string>",
"fileSize": 123,
"eTag": "<string>",
"versionId": "<string>",
"generationVersion": 123,
"payrollConfigId": "<string>",
"finalisedDate": "<string>",
"finalisedBy": "<string>",
"replacementCount": 123,
"previousS3Keys": [
"<string>"
],
"employeeDetails": {
"id": "<string>",
"payrollId": "<string>",
"nationalInsuranceNumber": "<string>",
"department": "<string>",
"jobTitle": "<string>",
"email": "<string>",
"name": {
"title": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"initials": "<string>",
"middleName": "<string>"
},
"hasStudentLoanDeductions": true,
"hasPostGraduateLoanDeductions": true,
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"birthGender": "<string>",
"birthDate": "<string>",
"employeeLeaverDetails": {
"leavingDate": "<string>",
"reason": "<string>",
"issuedBy": "<string>",
"reportedToHmrc": true
}
},
"employerDetails": {
"id": "<string>",
"name": {
"legalName": "<string>",
"tradingName": "<string>"
},
"taxReferenceNumbers": {
"employerPayeReference": {
"officeNumber": "<string>",
"referenceNumber": "<string>"
},
"accountsOfficeReference": "<string>",
"selfAssessmentUniqueTaxpayerReference": "<string>",
"corporationTaxReferenceUniqueTaxpayerReference": "<string>"
},
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
}
},
"taxDetails": {
"taxCodeAtLeavingDate": "<string>",
"taxCodeWeek1Month1": true,
"totalPayToDate": 123,
"totalTaxToDate": 123,
"totalPayInThisEmployment": 123,
"totalTaxInThisEmployment": 123,
"weekNumber": 123,
"monthNumber": 123
},
"createdDate": "<string>",
"createdBy": "<string>",
"updatedDate": "<string>",
"updatedBy": "<string>",
"lastEmailedAt": "<string>",
"lastEmailedTo": "<string>",
"lastEmailedBy": "<string>",
"lastEmailedStatus": "<string>",
"lastEmailError": "<string>"
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}Authorizations
Authentication token for API access
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).
Was this page helpful?
⌘I
cURL
curl --request GET \
--url https://api.sandbox.flowpayroll.ai/v1/hmrc-p-forms/p45/list/{payrollConfigId}/{taxYear}/finalised \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/hmrc-p-forms/p45/list/{payrollConfigId}/{taxYear}/finalised"
headers = {
"X-Auth-Token": "<api-key>",
"X-Org-Id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>', 'X-Org-Id': '<api-key>'}};
fetch('https://api.sandbox.flowpayroll.ai/v1/hmrc-p-forms/p45/list/{payrollConfigId}/{taxYear}/finalised', 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/hmrc-p-forms/p45/list/{payrollConfigId}/{taxYear}/finalised",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v1/hmrc-p-forms/p45/list/{payrollConfigId}/{taxYear}/finalised"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("X-Org-Id", "<api-key>")
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/v1/hmrc-p-forms/p45/list/{payrollConfigId}/{taxYear}/finalised")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/hmrc-p-forms/p45/list/{payrollConfigId}/{taxYear}/finalised")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": [
{
"organisationId": "<string>",
"employeeId": "<string>",
"taxYear": 123,
"status": "<string>",
"fileName": "<string>",
"contentType": "<string>",
"fileSize": 123,
"eTag": "<string>",
"versionId": "<string>",
"generationVersion": 123,
"payrollConfigId": "<string>",
"finalisedDate": "<string>",
"finalisedBy": "<string>",
"replacementCount": 123,
"previousS3Keys": [
"<string>"
],
"employeeDetails": {
"id": "<string>",
"payrollId": "<string>",
"nationalInsuranceNumber": "<string>",
"department": "<string>",
"jobTitle": "<string>",
"email": "<string>",
"name": {
"title": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"initials": "<string>",
"middleName": "<string>"
},
"hasStudentLoanDeductions": true,
"hasPostGraduateLoanDeductions": true,
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"birthGender": "<string>",
"birthDate": "<string>",
"employeeLeaverDetails": {
"leavingDate": "<string>",
"reason": "<string>",
"issuedBy": "<string>",
"reportedToHmrc": true
}
},
"employerDetails": {
"id": "<string>",
"name": {
"legalName": "<string>",
"tradingName": "<string>"
},
"taxReferenceNumbers": {
"employerPayeReference": {
"officeNumber": "<string>",
"referenceNumber": "<string>"
},
"accountsOfficeReference": "<string>",
"selfAssessmentUniqueTaxpayerReference": "<string>",
"corporationTaxReferenceUniqueTaxpayerReference": "<string>"
},
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
}
},
"taxDetails": {
"taxCodeAtLeavingDate": "<string>",
"taxCodeWeek1Month1": true,
"totalPayToDate": 123,
"totalTaxToDate": 123,
"totalPayInThisEmployment": 123,
"totalTaxInThisEmployment": 123,
"weekNumber": 123,
"monthNumber": 123
},
"createdDate": "<string>",
"createdBy": "<string>",
"updatedDate": "<string>",
"updatedBy": "<string>",
"lastEmailedAt": "<string>",
"lastEmailedTo": "<string>",
"lastEmailedBy": "<string>",
"lastEmailedStatus": "<string>",
"lastEmailError": "<string>"
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}