# Payslip fields

> Every field returned by GET /payslips.

`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](https://developer.paycaptain.com/openapi.json)

## `payslip`

| Field | Type | Description |
| --- | --- | --- |
| `id` | string | Payslip identifier. |
| `payeReference` | string | Employer PAYE reference. |
| `companyName` | string | Company name. |
| `payPeriod` | string | Pay Period reference. |
| `published` | boolean | Whether the payslip is published to the employee. |
| `payPeriodStatus` | string | Status of the pay period. |
| `payGroup` | string | Pay Group name. |
| `taxCode` | string | Tax code applied. |
| `w1m1` | boolean | Tax calculated on a week 1 / month 1 basis. |
| `niCategory` | string | National Insurance category letter. |
| `date` | string | Pay date. |
| `periodNumber` | integer | Tax period number. |
| `pensionNotice` | string | Pension notice text. |
| `message` | string | Message shown on the payslip. |
| `taxYear` | string | Tax year. |
| `url` | string | Link to the payslip. |

## `employee`

| Field | Type | Description |
| --- | --- | --- |
| `hrEmployee_Id` | string | Your identifier for the person. Note the spelling differs from hrEmployeeId on requests. |
| `payrollCode` | string | Payroll code of the employment. |
| `firstName` | string | First name. |
| `middleName` | string | Middle name. |
| `lastName` | string | Last name. |
| `email` | string | Email address. |
| `mailingStreet` | string | Home address: street. |
| `mailingCity` | string | Home address: town or city. |
| `mailingState` | string | Home address: county. |
| `mailingPostalCode` | string | Home address: postcode. |
| `MailingCountry` | string | Home address: country. Note the capital M. |
| `phone` | string | Phone number. |
| `niNumber` | string | National Insurance number. |

## `totals`

| Field | Type | Description |
| --- | --- | --- |
| `gross` | number | Gross pay this period. |
| `taxable` | number | Taxable pay this period. |
| `net` | number | Net pay this period. |
| `benefits` | number | Benefits this period. |
| `tax` | number | Income tax this period. |
| `employerNationalInsurance` | number | Employer National Insurance this period. |
| `employeeNationalInsurance` | number | Employee National Insurance this period. |
| `employeePensoin` | number | Employee pension this period. Spelled this way in API v1.0.1. |
| `employerPensoin` | number | Employer pension this period. Spelled this way in API v1.0.1. |

## `ytd`

| Field | Type | Description |
| --- | --- | --- |
| `gross` | number | Gross pay, year to date. |
| `taxable` | number | Taxable pay, year to date. |
| `net` | number | Net pay, year to date. |
| `benefits` | number | Benefits, year to date. |
| `tax` | number | Income tax, year to date. |
| `employeePension` | number | Employee pension, year to date. |
| `employerPension` | number | Employer pension, year to date. |

## `previousEmployment`

| Field | Type | Description |
| --- | --- | --- |
| `taxable` | number | Taxable pay from previous employment this tax year. |
| `tax` | number | Tax paid in previous employment this tax year. |

## `thisEmployment`

| Field | Type | Description |
| --- | --- | --- |
| `taxable` | number | Taxable pay in this employment this tax year. |
| `tax` | number | Tax paid in this employment this tax year. |

## `payslipLines[]`

| Field | Type | Description |
| --- | --- | --- |
| `payslipLineId` | string | Line identifier. |
| `payslipId` | string | Parent payslip identifier. |
| `units` | integer | Units. |
| `amount` | number | Amount per unit. |
| `total` | number | Line total. |
| `code` | string | Pay Code. |
| `description` | string | Text shown on the payslip. |
| `locationCode` | string | Location. |
| `departmentCode` | string | Department. |
| `teamCode` | string | Team. |
| `jobCode` | string | Job. |
| `isDeduction` | boolean | Line is a deduction. |
| `isBenefit` | boolean | Line is a benefit. |
| `excludedfromPayslip` | boolean | Line is hidden on the employee's payslip. |
| `information` | string | Extra detail shown behind the help icon. |