Guides

If you don't want to use our customisable PDFs for Payslips then you can retrieve the raw data used to create a Payslip.
This is the model you will be provided with for each employee.

Schema

Name / Description	Type / Format	Example
`isClosed` Indicates if the Payrun has been finalised	`boolean`	`true`
`taxYear`	`string`	`"Year2017"` `"Year2018"` `"Year2019"` `"Year2020"` `"Year2021"` `"Year2022"` `"Year2023"` `"Year2024"`
`payPeriod`	`string`	`"Custom"` `"Monthly"` `"FourWeekly"` `"Fortnightly"` `"Weekly"` `"Daily"`
`periodNumber`	`integer` int32	`0`
`period` A description of the period that Payslip relates to.	`string`	`"string"`
`from` The start date of the period this Payslip covers.	`string` date	`"2024-11-21"`
`to` The end date of the period this Payslip covers.	`string` date	`"2024-11-21"`
`paymentDate` The date the Employee will be paid on	`string` date	`"2024-11-21"`
`note` Any note that should appear on the payslip	`string`	`"string"`
`allowanceNote` Details of remaining allowance to show on payslip	`string`	`"string"`
`employee`	`Item`	`{Item}`
`logoUrl` The Logo to include on the payslip	`string`	`"string"`
`employer`	`Item`	`{Item}`
`employerAddress`	`Address`	`{Address}`
`hmrcDetails`	`HmrcDetails`	`{HmrcDetails}`
`payOptions` This object forms the basis of the Employees payment.	`PayOptions`	`{PayOptions}`
`employmentDetails`	`EmploymentDetails`	`{EmploymentDetails}`
`personalDetails`	`PersonalDetails`	`{PersonalDetails}`
`totals` Used to represent totals for a PayRun or PayRunEntry. If a value is 0 then it will not be shown in the JSON.	`PayRunTotals`	`{PayRunTotals}`
`totalsYtd` Used to represent totals for a PayRun or PayRunEntry. If a value is 0 then it will not be shown in the JSON.	`PayRunTotals`	`{PayRunTotals}`
`lines` The lines to display on the Payslip	`PayslipLine[]`	`{PayslipLine}`
`employerNi` The Employer NI Contribution amount	`number` double	`0.0`
`employerPensionContribs` The Employer Pension Contribution Amount	`number` double	`0.0`
`depts` The employees Department Membership(s) at the time the payrun was finalised	`StringDecimalKeyValuePair[]`	`{StringDecimalKeyValuePair}`
`umbrellaPayment`	`UmbrellaPayment`	`{UmbrellaPayment}`
`costCentres` The employees Cost Centre Membership(s) only populated when creating journals	`StringDecimalKeyValuePair[]`	`{StringDecimalKeyValuePair}`
`employeeRoleAnalysisCategoryCodes` The EmployeeRoleAnalysisCategoryCodes only populated when creating journals	`EmployeeRoleAnalysisCategoryCode[]`	`{EmployeeRoleAnalysisCategoryCode}`
`employeeCostCentres` The Employee Cost Centre Membership(s) by role only populated when creating journals	`EmployeeCostCentre[]`	`{EmployeeCostCentre}`
`departmentMemberships` The Employee Department Membership(s) by role only populated when creating journals	`DepartmentMembership[]`	`{DepartmentMembership}`
`pensionContributionsByRole` The Pension Employer contribution by role only populated when creating journals	`Item[]`	`{Item}`
`employerPensionContributions` The list of Employer Pension Contribution(s)	`EmployerPensionContribution[]`	`{EmployerPensionContribution}`

JSON Example

{
  "isClosed": true,
  "taxYear": "Year2017",
  "payPeriod": "Custom",
  "periodNumber": 0,
  "period": "string",
  "from": "2024-11-21",
  "to": "2024-11-21",
  "paymentDate": "2024-11-21",
  "note": "string",
  "allowanceNote": "string",
  "employee": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "logoUrl": "string",
  "employer": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "employerAddress": {
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "line4": "string",
    "line5": "string",
    "postCode": "string",
    "country": "England",
    "foreignCountry": "string"
  },
  "hmrcDetails": {
    "officeNumber": "string",
    "payeReference": "string",
    "accountsOfficeReference": "string",
    "econ": "string",
    "utr": "string",
    "coTax": "string",
    "employmentAllowance": true,
    "employmentAllowanceMaxClaim": 0.0,
    "smallEmployersRelief": true,
    "apprenticeshipLevy": true,
    "apprenticeshipLevyAllowance": 0.0,
    "quarterlyPaymentSchedule": true,
    "includeEmploymentAllowanceOnMonthlyJournal": true,
    "carryForwardUnpaidLiabilities": true,
    "paymentDateRule": "OnPayDate",
    "paymentDateDayOfMonth": 0,
    "id": "string"
  },
  "payOptions": {
    "period": "Custom",
    "ordinal": 0,
    "method": "Cash",
    "withholdTaxRefundIfPayIsZero": true,
    "taxAndNi": {
      "niTable": "string",
      "secondaryClass1NotPayable": true,
      "postgradLoan": true,
      "postgraduateLoanStartDate": "2024-11-21",
      "postgraduateLoanEndDate": "2024-11-21",
      "studentLoan": "None",
      "studentLoanStartDate": "2024-11-21",
      "studentLoanEndDate": "2024-11-21",
      "taxCode": "string",
      "week1Month1": true,
      "foreignTaxCredit": true
    },
    "fpsFields": {
      "offPayrollWorker": true,
      "irregularPaymentPattern": true,
      "nonIndividual": true,
      "hoursNormallyWorked": "LessThan16",
      "excludeFromRtiSubmissions": true
    },
    "tags": [
      "string"
    ],
    "basis": "Hourly",
    "nationalMinimumWage": true,
    "payCode": "string",
    "mileageVehicleType": "Car",
    "mapsMiles": 0,
    "payAmount": 0.0,
    "payAmountMultiplier": 0.0,
    "baseHourlyRate": 0.0,
    "baseDailyRate": 0.0,
    "basicPay": 0.0,
    "autoAdjustForLeave": true,
    "niTable": "string",
    "regularPayLines": [
      {
        "value": 0.0,
        "rate": 0.0,
        "multiplier": 0.0,
        "description": "string",
        "attachmentOrderId": "string",
        "pensionId": "string",
        "leaveId": "string",
        "loanId": "string",
        "leaveStatutoryDaysPaid": 0.0,
        "leaveStatutoryWeeksPaid": 0.0,
        "code": "string",
        "tags": [
          "string"
        ],
        "childId": "string",
        "isNetToGross": true,
        "targetNetToGrossValue": 0.0,
        "netToGrossDiscrepancy": 0.0,
        "effectiveFrom": "2024-11-21",
        "effectiveTo": "2024-11-21",
        "department": "string",
        "costCentre": "string",
        "departmentId": "string",
        "costCentreId": "string",
        "isAutoGeneratedBasicPayLine": true,
        "percentageOfEffectiveDays": 0.0,
        "totalWorkingDays": 0.0,
        "isAutomaticBackPay": true,
        "ignoreInitialBackPay": true,
        "initialBackPayPublicPayRunId": "string",
        "autoAdjustForLeave": true,
        "contributesToBasicPay": true,
        "calculateAsWhenPaid": true,
        "totalPaidDays": 0.0,
        "roleId": "string",
        "employeeRoleReference": "string",
        "earnedFrom": "2024-11-21",
        "earnedTo": "2024-11-21",
        "periodFrom": "2024-11-21",
        "periodTo": "2024-11-21",
        "annualValue": 0.0,
        "parentId": "string",
        "isAutoCalculatedBackPayLine": true,
        "isZeroHoursTeachersBackPayLine": true,
        "analysisCategoriesCodes": [
          {
            "analysisCategory": "string",
            "analysisCategoryCode": "string",
            "analysisCategoryId": "string",
            "analysisCategoryCodeId": "string"
          }
        ],
        "analysisCategoryCodeIds": [
          "string"
        ],
        "paySpineId": "string",
        "paySpineGradeId": "string",
        "spinalPointId": "string",
        "londonAllowanceId": 0,
        "fullTimeAnnualValue": 0.0,
        "paySpine": "string",
        "payGrade": "string",
        "spinePoint": "string"
      }
    ]
  },
  "employmentDetails": {
    "cisSubContractor": true,
    "payrollCode": "string",
    "jobTitle": "string",
    "onHold": true,
    "onFurlough": true,
    "furloughStart": "2024-11-21",
    "furloughEnd": "2024-11-21",
    "furloughCalculationBasis": "ActualPaidAmount",
    "furloughCalculationBasisAmount": 0.0,
    "partialFurlough": true,
    "furloughHoursNormallyWorked": 0.0,
    "furloughHoursOnFurlough": 0.0,
    "isApprentice": true,
    "apprenticeshipStartDate": "2024-11-21",
    "apprenticeshipEndDate": "2024-11-21",
    "workingPattern": "string",
    "forcePreviousPayrollCode": "string",
    "starterDetails": {
      "startDate": "2024-11-21",
      "starterDeclaration": "A",
      "overseasEmployerDetails": {
        "overseasEmployer": true,
        "overseasSecondmentStatus": "None",
        "eeaCitizen": true,
        "epm6Scheme": true
      },
      "pensionerPayroll": {
        "inReceiptOfPension": true,
        "bereaved": true,
        "amount": 0.0,
        "startDate": "2024-11-21"
      }
    },
    "directorshipDetails": {
      "isDirector": true,
      "startDate": "2024-11-21",
      "leaveDate": "2024-11-21",
      "niAlternativeMethod": true
    },
    "leaverDetails": {
      "hasLeft": true,
      "leaveDate": "2024-11-21",
      "isDeceased": true,
      "paymentAfterLeaving": true,
      "p45Sent": true,
      "payAccruedBalance": true,
      "paymentMethodAfterLeaving": "RegularPayMethod"
    },
    "cis": {
      "type": "SoleTrader",
      "utr": "string",
      "tradingName": "string",
      "companyUtr": "string",
      "companyNumber": "string",
      "vatRegistered": true,
      "vatNumber": "string",
      "vatRate": 0.0,
      "reverseChargeVAT": true,
      "verification": {
        "manuallyEntered": true,
        "matchInsteadOfVerify": true,
        "number": "string",
        "date": "2024-11-21",
        "taxStatus": "Gross",
        "verificationRequest": "string",
        "verificationResponse": "error too many levels"
      }
    },
    "department": {
      "code": "string",
      "title": "string",
      "color": "string",
      "employeeCount": 0,
      "accountingCode": "string",
      "hasJournalOverrides": true
    },
    "roles": [
      {
        "id": "string",
        "name": "string",
        "metadata": {},
        "url": "string"
      }
    ],
    "isWorkingInFreePort": true,
    "veteranDetails": {
      "isVeteran": true,
      "firstCivilianEmploymentDate": "2024-11-21"
    },
    "continuousEmploymentDate": "2024-11-21",
    "includeSecondedInfoOnStarter": true,
    "isWorkingInInvestmentZone": true
  },
  "personalDetails": {
    "address": {
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "line4": "string",
      "line5": "string",
      "postCode": "string",
      "country": "England",
      "foreignCountry": "string"
    },
    "maritalStatus": "Single",
    "title": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "alternativeEmail": "string",
    "previousSurName": "string",
    "email": "string",
    "emailPayslip": true,
    "pdfPassword": "string",
    "pdfPasswordType": "InitialsAndDob",
    "emailStatement": true,
    "photoUrl": "string",
    "photoSasUrl": "string",
    "telephone": "string",
    "mobile": "string",
    "dateOfBirth": "2024-11-21",
    "statePensionAge": 0,
    "gender": "Male",
    "niNumber": "string",
    "passportNumber": "string",
    "partnerDetails": {
      "firstName": "string",
      "initials": "string",
      "lastName": "string",
      "niNumber": "string"
    }
  },
  "totals": {
    "basicPay": 0.0,
    "gross": 0.0,
    "grossForNi": 0.0,
    "grossForNiNonRti": 0.0,
    "grossNotSubjectToEmployersNi": 0.0,
    "grossNotSubjectToEmployersNiNonRti": 0.0,
    "grossForTax": 0.0,
    "employerNi": 0.0,
    "employerNiNonRti": 0.0,
    "employeeNi": 0.0,
    "employeeNiNonRti": 0.0,
    "employerNiOffPayroll": 0.0,
    "realTimeClass1ANi": 0.0,
    "realTimeClass1ANiNonRti": 0.0,
    "tax": 0.0,
    "taxNonRti": 0.0,
    "netPay": 0.0,
    "adjustments": 0.0,
    "notionalPay": 0.0,
    "additions": 0.0,
    "deductions": 0.0,
    "takeHomePay": 0.0,
    "nonTaxOrNICPmt": 0.0,
    "itemsSubjectToClass1NIC": 0.0,
    "dednsFromNetPay": 0.0,
    "tcp_Tcls": 0.0,
    "tcp_Pp": 0.0,
    "tcp_Op": 0.0,
    "flexiDd_Death": 0.0,
    "flexiDd_Death_NonTax": 0.0,
    "flexiDd_Pension": 0.0,
    "flexiDd_Pension_NonTax": 0.0,
    "flexiDd_SeriousIllHealth": 0.0,
    "flexiDd_SeriousIllHealth_NonTax": 0.0,
    "smp": 0.0,
    "smpNonRti": 0.0,
    "spp": 0.0,
    "sppNonRti": 0.0,
    "sap": 0.0,
    "sapNonRti": 0.0,
    "shpp": 0.0,
    "shppNonRti": 0.0,
    "spbp": 0.0,
    "spbpNonRti": 0.0,
    "ssp": 0.0,
    "sspNonRti": 0.0,
    "studentLoanRecovered": 0.0,
    "studentLoanRecoveredNonRti": 0.0,
    "postgradLoanRecovered": 0.0,
    "postgradLoanRecoveredNonRti": 0.0,
    "pensionableEarnings": 0.0,
    "pensionablePay": 0.0,
    "nonTierablePay": 0.0,
    "employeePensionContribution": 0.0,
    "employeePensionContributionAvc": 0.0,
    "employerPensionContribution": 0.0,
    "empeePenContribnsNotPaid": 0.0,
    "empeePenContribnsPaid": 0.0,
    "attachmentOrderDeductions": 0.0,
    "cisDeduction": 0.0,
    "cisVat": 0.0,
    "cisUmbrellaFee": 0.0,
    "cisUmbrellaFeePostTax": 0.0,
    "pbik": 0.0,
    "mapsMiles": 0,
    "foreignTaxAmount": 0.0,
    "foreignTaxAmountReclaimed": 0.0,
    "umbrellaFee": 0.0,
    "appLevyDeduction": 0.0,
    "paymentAfterLeaving": 0.0,
    "taxOnPaymentAfterLeaving": 0.0,
    "nilPaid": 0,
    "leavers": 0,
    "starters": 0,
    "p45Gross": 0.0,
    "p45Tax": 0.0,
    "totalCost": 0.0,
    "recoverableAmounts": {
      "taxMonth": 0,
      "smpRecovered": 0.0,
      "sppRecovered": 0.0,
      "sapRecovered": 0.0,
      "shPPRecovered": 0.0,
      "spbpRecovered": 0.0,
      "nicCompensationOnSMP": 0.0,
      "nicCompensationOnSPP": 0.0,
      "nicCompensationOnSAP": 0.0,
      "nicCompensationOnShPP": 0.0,
      "nicCompensationOnSPBP": 0.0,
      "cisDeductionsSuffered": 0.0,
      "total": 0.0
    }
  },
  "totalsYtd": {
    "basicPay": 0.0,
    "gross": 0.0,
    "grossForNi": 0.0,
    "grossForNiNonRti": 0.0,
    "grossNotSubjectToEmployersNi": 0.0,
    "grossNotSubjectToEmployersNiNonRti": 0.0,
    "grossForTax": 0.0,
    "employerNi": 0.0,
    "employerNiNonRti": 0.0,
    "employeeNi": 0.0,
    "employeeNiNonRti": 0.0,
    "employerNiOffPayroll": 0.0,
    "realTimeClass1ANi": 0.0,
    "realTimeClass1ANiNonRti": 0.0,
    "tax": 0.0,
    "taxNonRti": 0.0,
    "netPay": 0.0,
    "adjustments": 0.0,
    "notionalPay": 0.0,
    "additions": 0.0,
    "deductions": 0.0,
    "takeHomePay": 0.0,
    "nonTaxOrNICPmt": 0.0,
    "itemsSubjectToClass1NIC": 0.0,
    "dednsFromNetPay": 0.0,
    "tcp_Tcls": 0.0,
    "tcp_Pp": 0.0,
    "tcp_Op": 0.0,
    "flexiDd_Death": 0.0,
    "flexiDd_Death_NonTax": 0.0,
    "flexiDd_Pension": 0.0,
    "flexiDd_Pension_NonTax": 0.0,
    "flexiDd_SeriousIllHealth": 0.0,
    "flexiDd_SeriousIllHealth_NonTax": 0.0,
    "smp": 0.0,
    "smpNonRti": 0.0,
    "spp": 0.0,
    "sppNonRti": 0.0,
    "sap": 0.0,
    "sapNonRti": 0.0,
    "shpp": 0.0,
    "shppNonRti": 0.0,
    "spbp": 0.0,
    "spbpNonRti": 0.0,
    "ssp": 0.0,
    "sspNonRti": 0.0,
    "studentLoanRecovered": 0.0,
    "studentLoanRecoveredNonRti": 0.0,
    "postgradLoanRecovered": 0.0,
    "postgradLoanRecoveredNonRti": 0.0,
    "pensionableEarnings": 0.0,
    "pensionablePay": 0.0,
    "nonTierablePay": 0.0,
    "employeePensionContribution": 0.0,
    "employeePensionContributionAvc": 0.0,
    "employerPensionContribution": 0.0,
    "empeePenContribnsNotPaid": 0.0,
    "empeePenContribnsPaid": 0.0,
    "attachmentOrderDeductions": 0.0,
    "cisDeduction": 0.0,
    "cisVat": 0.0,
    "cisUmbrellaFee": 0.0,
    "cisUmbrellaFeePostTax": 0.0,
    "pbik": 0.0,
    "mapsMiles": 0,
    "foreignTaxAmount": 0.0,
    "foreignTaxAmountReclaimed": 0.0,
    "umbrellaFee": 0.0,
    "appLevyDeduction": 0.0,
    "paymentAfterLeaving": 0.0,
    "taxOnPaymentAfterLeaving": 0.0,
    "nilPaid": 0,
    "leavers": 0,
    "starters": 0,
    "p45Gross": 0.0,
    "p45Tax": 0.0,
    "totalCost": 0.0,
    "recoverableAmounts": {
      "taxMonth": 0,
      "smpRecovered": 0.0,
      "sppRecovered": 0.0,
      "sapRecovered": 0.0,
      "shPPRecovered": 0.0,
      "spbpRecovered": 0.0,
      "nicCompensationOnSMP": 0.0,
      "nicCompensationOnSPP": 0.0,
      "nicCompensationOnSAP": 0.0,
      "nicCompensationOnShPP": 0.0,
      "nicCompensationOnSPBP": 0.0,
      "cisDeductionsSuffered": 0.0,
      "total": 0.0
    }
  },
  "lines": [
    {
      "type": "BasicPay",
      "code": "string",
      "description": "string",
      "secondaryDescription": "string",
      "value": 0.0,
      "multiplier": 0.0,
      "attachmentOrderId": "string",
      "pensionId": "string",
      "loanId": "string",
      "currencySymbol": "string",
      "formattedValue": "string",
      "isNetToGross": true,
      "targetNetToGrossValue": 0.0,
      "leaveId": "string",
      "roleId": "string",
      "isAutoCalculatedBackPayLine": true,
      "isAutomaticBackPay": true,
      "hasSecondaryDescription": true,
      "contributesToBasicPay": true,
      "isNotional": true
    }
  ],
  "employerNi": 0.0,
  "employerPensionContribs": 0.0,
  "depts": [
    {
      "key": "string",
      "value": 0.0
    }
  ],
  "umbrellaPayment": {
    "payrollCode": "string",
    "chargePerTimesheet": 0.0,
    "invoiceValue": 0.0,
    "mapsMiles": 0,
    "otherExpenses": 0.0,
    "numberOfTimesheets": 0,
    "hoursWorked": 0.0,
    "grossDeduction": 0.0,
    "grossAddition": 0.0
  },
  "costCentres": [
    {
      "key": "string",
      "value": 0.0
    }
  ],
  "employeeRoleAnalysisCategoryCodes": [
    {
      "code": "string",
      "color": "string",
      "title": "string",
      "isPrimary": true,
      "weighting": 0.0,
      "analysisCategoryName": "string",
      "analysisCategoryPublicId": "string",
      "employeeRolePublicId": "string",
      "employee": {
        "id": "string",
        "name": "string",
        "metadata": {},
        "url": "string"
      }
    }
  ],
  "employeeCostCentres": [
    {
      "code": "string",
      "color": "string",
      "title": "string",
      "isPrimary": true,
      "weighting": 0.0,
      "employeeRoleUniqueId": "string",
      "employee": {
        "id": "string",
        "name": "string",
        "metadata": {},
        "url": "string"
      }
    }
  ],
  "departmentMemberships": [
    {
      "code": "string",
      "color": "string",
      "title": "string",
      "primary": true,
      "weighting": 0.0,
      "employeeRoleUniqueId": "string"
    }
  ],
  "pensionContributionsByRole": [
    {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    }
  ],
  "employerPensionContributions": [
    {
      "pensionName": "string",
      "contributionAmount": 0.0,
      "contributionPercentage": 0.0,
      "isPercentage": true
    }
  ]
}

References

Contained in Models
PayslipReportResponse

Consumed by Operations

- none -

Returned by Operations

- none -

Payslips	Get Payslips
Payslips	Customise Payslips

Payslip

Related Guides