Payslip
Get all payslip data for an employee within a date range
Retrieves all payslip data for a specific employee within a specified date range. If no date range is provided, defaults to the last year from today.
GET
/
payslip
/
data
/
{employeeId}
Get all payslip data for an employee within a date range
curl --request GET \
--url https://api.sandbox.flowpayroll.ai/v1/payslip/data/{employeeId} \
--header 'X-Auth-Token: <api-key>'{
"message": {
"text": "All Payslip Data Retrieved",
"token": "getAllPayslipDataRetrieved"
},
"content": {
"data": [
{
"employeeDetails": {
"id": "EMP01JPW80Q2B7Q9RGGRY29VGC8WM",
"name": {
"title": "Mr",
"firstName": "John",
"lastName": "Doe",
"initials": "JD"
},
"address": {
"line1": "123 Main Street",
"line2": "Apartment 4B",
"city": "London",
"county": "Greater London",
"postcode": "SW1A 1AA",
"countryCode": "GB"
},
"birthDate": "1980-01-12",
"birthGender": "Male",
"payrollId": "PAY123",
"employeeCode": "EMP001",
"hoursWorkedCategory": "Above30Hours",
"taxCode": {
"code": "1257L",
"effectiveDate": "2024-04-06",
"reason": "Standard tax code",
"issuedBy": "HMRC",
"week1Month1": false
},
"nationalInsuranceCategory": "A",
"nationalInsuranceNumber": "AB123456C",
"passportNumber": "123456789",
"starterDetails": {
"startDate": "2024-01-15",
"starterDeclaration": "ThisIsMyOnlyJob",
"secondedDetails": {
"stayStatus": "Stay183DaysOrMore",
"eEACitizen": true,
"ePM6": false
},
"alreadySentToHmrcFps": false
},
"studentDetails": {
"studentLoanDetails": {
"loanType": "Plan2",
"startDate": "2020-09-01",
"endDate": "2023-06-30"
},
"postgraduateLoanDetails": {
"loanType": "PostgraduateLoan",
"startDate": "2023-09-01",
"endDate": "2024-06-30"
}
},
"directorDetails": {
"directorsNICType": "Annual",
"appointmentDate": "2024-01-15"
},
"leaverDetails": {
"leavingDate": "2024-12-31",
"reason": "Retirement",
"issuedBy": "Employer"
},
"workplaceDetails": {
"workplacePostcode": "SW1A 1AA"
},
"bankAccounts": [
{
"accountNumber": "12345678",
"sortCode": "123456",
"accountHolderName": "John Doe",
"isPrimaryPayrollAccount": true,
"allocationPercentage": 100
}
]
},
"employerDetails": {
"id": "LOAD_TEST",
"organisationInformation": {
"organisationId": "ORG123456789",
"name": {
"legalName": "Acme Corporation Ltd",
"tradingName": "Acme Corp"
},
"organisationType": "LimitedCompany",
"companyRegistrationNumber": "12345678",
"businessType": "LimitedCompany",
"registredOfficeAddress": {
"line1": "456 Business Park",
"line2": "Suite 100",
"city": "Manchester",
"county": "Greater Manchester",
"postcode": "M1 1AA",
"countryCode": "GB"
},
"correspondenceAddress": {
"line1": "456 Business Park",
"line2": "Suite 100",
"city": "Manchester",
"county": "Greater Manchester",
"postcode": "M1 1AA",
"countryCode": "GB"
},
"companyContactDetails": {
"name": "HR Department",
"email": "hr@acme.com",
"phone": "0161 123 4567"
},
"primaryContactDetails": {
"name": "John Smith",
"email": "john.smith@acme.com",
"phone": "0161 123 4568"
},
"createdBy": "System",
"createdDate": "2024-01-01T00:00:00.000Z",
"updatedBy": "System",
"updatedDate": "2024-01-01T00:00:00.000Z"
},
"taxReferenceNumbers": {
"employerPayeReference": {
"officeNumber": "123",
"referenceNumber": "AB12345"
},
"accountsOfficeReference": "123PX00123456",
"selfAssessmentUniqueTaxpayerReference": "1234567890",
"corporationTaxReferenceUniqueTaxpayerReference": "1234567890"
}
},
"year": 2024,
"period": 1,
"payrollConfigId": "01JNR9P81W74HYCN35X1EEFDZE",
"frequency": "Monthly",
"summaryItems": [
{
"id": "PAYLINE-01JPW80Q2B5B76SQ2K56BZ3DHA",
"description": "Regular Hours",
"amount": 306,
"type": "Employee",
"category": "Earnings",
"payElementId": "base_salary",
"date": "2024-02-28"
}
],
"forPeriod": {
"gross": 306,
"grossTaxable": 306,
"grossNi": 306,
"tax": 45.2,
"ni": 25.3,
"employerNi": 35.4,
"studentLoan": 0,
"postgraduateLoan": 0,
"net": 235.5
},
"yearToDate": {
"gross": 306,
"grossTaxable": 306,
"grossNi": 306,
"tax": 45.2,
"ni": 25.3,
"employerNi": 35.4,
"studentLoan": 0,
"postgraduateLoan": 0,
"net": 235.5
},
"createdDate": "2025-03-21T14:17:19.076Z",
"createdBy": "System",
"updatedDate": "2025-03-21T14:17:19.076Z",
"updatedBy": "System",
"status": "Final",
"paymentDate": null,
"payPeriodStartDate": "2024-02-01",
"payPeriodEndDate": "2024-02-29",
"lateReason": null
}
]
}
}Documentation Index
Fetch the complete documentation index at: https://docs.flowpayroll.ai/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Access token obtained from OAuth2 client credentials flow
Path Parameters
ID of the employee
Query Parameters
Start date for the payslip search range (YYYY-MM-DD format). Defaults to one year before endDate.
End date for the payslip search range (YYYY-MM-DD format). Defaults to today.
Response
All payslip data retrieved successfully
The response is of type any.
Was this page helpful?
Create or update payslip metadata such as notes and payment date overwrite
Previous
Send payslip notification emails to employees
Next
⌘I
Get all payslip data for an employee within a date range
curl --request GET \
--url https://api.sandbox.flowpayroll.ai/v1/payslip/data/{employeeId} \
--header 'X-Auth-Token: <api-key>'{
"message": {
"text": "All Payslip Data Retrieved",
"token": "getAllPayslipDataRetrieved"
},
"content": {
"data": [
{
"employeeDetails": {
"id": "EMP01JPW80Q2B7Q9RGGRY29VGC8WM",
"name": {
"title": "Mr",
"firstName": "John",
"lastName": "Doe",
"initials": "JD"
},
"address": {
"line1": "123 Main Street",
"line2": "Apartment 4B",
"city": "London",
"county": "Greater London",
"postcode": "SW1A 1AA",
"countryCode": "GB"
},
"birthDate": "1980-01-12",
"birthGender": "Male",
"payrollId": "PAY123",
"employeeCode": "EMP001",
"hoursWorkedCategory": "Above30Hours",
"taxCode": {
"code": "1257L",
"effectiveDate": "2024-04-06",
"reason": "Standard tax code",
"issuedBy": "HMRC",
"week1Month1": false
},
"nationalInsuranceCategory": "A",
"nationalInsuranceNumber": "AB123456C",
"passportNumber": "123456789",
"starterDetails": {
"startDate": "2024-01-15",
"starterDeclaration": "ThisIsMyOnlyJob",
"secondedDetails": {
"stayStatus": "Stay183DaysOrMore",
"eEACitizen": true,
"ePM6": false
},
"alreadySentToHmrcFps": false
},
"studentDetails": {
"studentLoanDetails": {
"loanType": "Plan2",
"startDate": "2020-09-01",
"endDate": "2023-06-30"
},
"postgraduateLoanDetails": {
"loanType": "PostgraduateLoan",
"startDate": "2023-09-01",
"endDate": "2024-06-30"
}
},
"directorDetails": {
"directorsNICType": "Annual",
"appointmentDate": "2024-01-15"
},
"leaverDetails": {
"leavingDate": "2024-12-31",
"reason": "Retirement",
"issuedBy": "Employer"
},
"workplaceDetails": {
"workplacePostcode": "SW1A 1AA"
},
"bankAccounts": [
{
"accountNumber": "12345678",
"sortCode": "123456",
"accountHolderName": "John Doe",
"isPrimaryPayrollAccount": true,
"allocationPercentage": 100
}
]
},
"employerDetails": {
"id": "LOAD_TEST",
"organisationInformation": {
"organisationId": "ORG123456789",
"name": {
"legalName": "Acme Corporation Ltd",
"tradingName": "Acme Corp"
},
"organisationType": "LimitedCompany",
"companyRegistrationNumber": "12345678",
"businessType": "LimitedCompany",
"registredOfficeAddress": {
"line1": "456 Business Park",
"line2": "Suite 100",
"city": "Manchester",
"county": "Greater Manchester",
"postcode": "M1 1AA",
"countryCode": "GB"
},
"correspondenceAddress": {
"line1": "456 Business Park",
"line2": "Suite 100",
"city": "Manchester",
"county": "Greater Manchester",
"postcode": "M1 1AA",
"countryCode": "GB"
},
"companyContactDetails": {
"name": "HR Department",
"email": "hr@acme.com",
"phone": "0161 123 4567"
},
"primaryContactDetails": {
"name": "John Smith",
"email": "john.smith@acme.com",
"phone": "0161 123 4568"
},
"createdBy": "System",
"createdDate": "2024-01-01T00:00:00.000Z",
"updatedBy": "System",
"updatedDate": "2024-01-01T00:00:00.000Z"
},
"taxReferenceNumbers": {
"employerPayeReference": {
"officeNumber": "123",
"referenceNumber": "AB12345"
},
"accountsOfficeReference": "123PX00123456",
"selfAssessmentUniqueTaxpayerReference": "1234567890",
"corporationTaxReferenceUniqueTaxpayerReference": "1234567890"
}
},
"year": 2024,
"period": 1,
"payrollConfigId": "01JNR9P81W74HYCN35X1EEFDZE",
"frequency": "Monthly",
"summaryItems": [
{
"id": "PAYLINE-01JPW80Q2B5B76SQ2K56BZ3DHA",
"description": "Regular Hours",
"amount": 306,
"type": "Employee",
"category": "Earnings",
"payElementId": "base_salary",
"date": "2024-02-28"
}
],
"forPeriod": {
"gross": 306,
"grossTaxable": 306,
"grossNi": 306,
"tax": 45.2,
"ni": 25.3,
"employerNi": 35.4,
"studentLoan": 0,
"postgraduateLoan": 0,
"net": 235.5
},
"yearToDate": {
"gross": 306,
"grossTaxable": 306,
"grossNi": 306,
"tax": 45.2,
"ni": 25.3,
"employerNi": 35.4,
"studentLoan": 0,
"postgraduateLoan": 0,
"net": 235.5
},
"createdDate": "2025-03-21T14:17:19.076Z",
"createdBy": "System",
"updatedDate": "2025-03-21T14:17:19.076Z",
"updatedBy": "System",
"status": "Final",
"paymentDate": null,
"payPeriodStartDate": "2024-02-01",
"payPeriodEndDate": "2024-02-29",
"lateReason": null
}
]
}
}