GET /payslips returns an array. Each item holds the objects below. These are read-only values produced by PayCaptain, so there is nothing to validate before sending, but field names must be read exactly as spelled.
Machine-readable: OpenAPI
payslip#
idstringPayslip identifier.
payeReferencestringEmployer PAYE reference.
companyNamestringCompany name.
payPeriodstringPay Period reference.
publishedbooleanWhether the payslip is published to the employee.
payPeriodStatusstringStatus of the pay period.
payGroupstringPay Group name.
taxCodestringTax code applied.
w1m1booleanTax calculated on a week 1 / month 1 basis.
niCategorystringNational Insurance category letter.
datestringPay date.
periodNumberintegerTax period number.
pensionNoticestringPension notice text.
messagestringMessage shown on the payslip.
taxYearstringTax year.
urlstringLink to the payslip.
employee#
hrEmployee_IdstringYour identifier for the person. Note the spelling differs from hrEmployeeId on requests.
payrollCodestringPayroll code of the employment.
firstNamestringFirst name.
middleNamestringMiddle name.
lastNamestringLast name.
emailstringEmail address.
mailingStreetstringHome address: street.
mailingCitystringHome address: town or city.
mailingStatestringHome address: county.
mailingPostalCodestringHome address: postcode.
MailingCountrystringHome address: country. Note the capital M.
phonestringPhone number.
niNumberstringNational Insurance number.
totals#
grossnumberGross pay this period.
taxablenumberTaxable pay this period.
netnumberNet pay this period.
benefitsnumberBenefits this period.
taxnumberIncome tax this period.
employerNationalInsurancenumberEmployer National Insurance this period.
employeeNationalInsurancenumberEmployee National Insurance this period.
employeePensoinnumberEmployee pension this period. Spelled this way in API v1.0.1.
employerPensoinnumberEmployer pension this period. Spelled this way in API v1.0.1.
ytd#
grossnumberGross pay, year to date.
taxablenumberTaxable pay, year to date.
netnumberNet pay, year to date.
benefitsnumberBenefits, year to date.
taxnumberIncome tax, year to date.
employeePensionnumberEmployee pension, year to date.
employerPensionnumberEmployer pension, year to date.
previousEmployment#
thisEmployment#
payslipLines[]#
payslipLineIdstringLine identifier.
payslipIdstringParent payslip identifier.
unitsintegerUnits.
amountnumberAmount per unit.
totalnumberLine total.
codestringPay Code.
descriptionstringText shown on the payslip.
locationCodestringLocation.
departmentCodestringDepartment.
teamCodestringTeam.
jobCodestringJob.
isDeductionbooleanLine is a deduction.
isBenefitbooleanLine is a benefit.
excludedfromPayslipbooleanLine is hidden on the employee's payslip.
informationstringExtra detail shown behind the help icon.