PayRunEntry

A PayRun contains multiple PayRunEntries, one for each Employee that is being paid.
The value for ```PersonalDetails``` and ```EmploymentDetails``` is copied from the Employee record.
So to change them you should update the Employee, not the PayRunEntry.
Changes made to the Employee are only reflected whilst the PayRun is still open.
Once you finalise and close the PayRun then a snapshot is taken of these values which is stored with the PayRunEntry for future reference.

Schema

Name / Description Type / Format Example
taxYear string "Year2017" "Year2018" "Year2019" "Year2020" "Year2021" "Year2022" "Year2023" "Year2024"
taxMonth
The Tax Month that the Payment Date falls in
 integer int32 0
startDate string date "2024-11-21"
endDate string date "2024-11-21"
note
Any note that you'd like to appear on the payslip
 string "string"
bacsSubReference
A randomly generated string for use with the RTI Hash Cross Reference
 string "string"
bacsHashCode
A Hash Code used for RTI BACS Hash Cross Reference
 string "string"
percentageOfWorkingDaysPaidAsNormal
If the employee is paid a set amount per period (ie, not an hourly or daily rate) and there is any Leave that is either Not Paid or Statutory Pay then this value
will give the percentage of working days (based on the Working Pattern) that should be paid as normal.
If there is no Leave in the period or PayOptions.AutoAdjustForLeave is false, then this will be 1.
 number double 0.0
workingDaysNotPaidAsNormal
If PercentageOfWorkingDaysPaidAsNormal has a value other than 1
then this property will tell you how many working days have been deducted from the basic pay
due to either being Not Paid or Statutory Pay
 number double 0.0
payPeriod string "Custom" "Monthly" "FourWeekly" "Fortnightly" "Weekly" "Daily"
ordinal
Indicates whether this uses the first, second, third (etc) PaySchedule for this PayPeriod.
 integer int32 0
period
The Tax Week or Tax Month number this PayRunEntry relates to
 integer int32 0
isNewStarter
Determines whether or not this Employee will be declared as a new starter on the resulting FPS
 boolean true
unpaidAbsence
Indicates that there was unpaid absence in the pay period
 boolean true
hasAttachmentOrders
Indicates that there are AttachmentOrders for this Employee in this entry
 boolean true
paymentDate
The date this payment was or will be made
 string date "2024-11-21"
priorPayrollCode
If the FPS needs to declare a change of PayId then this will contain the previous code
It's worked out automatically but can also be set from the Employees EmploymentDetails property.
 string "string"
pensionSummary
If a PayRunEntry contains pension contributions then it'll also include a PensionSummary model
giving further information about the Pension Scheme and the contributions made
 PensionSummary {PensionSummary}
pensionSummaries
A summary of the details for the Pensions (if any) that the Employee is assigned to.
 PensionSummary[] {PensionSummary}
employee Item {Item}
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}
periodOverrides
Any calculated values for this period that should be overridden with a different value
 ValueOverride[] {ValueOverride}
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}
totalsYtdOverrides
Any values of TotalsYtd that should be overridden with a different value
 ValueOverride[] {ValueOverride}
forcedCisVatAmount
If this employee is a CIS Subcontractor registered for VAT, we'll automatically work out VAT at the set rate.
If you want to override this calculations then set this property to anything other than null.
 number double 0.0
holidayAccrued
The amount of holiday days or hours accrued in the period.
 number double 0.0
state string "Opening" "Open" "ReOpening" "RollingBack" "RolledBack" "SubmittedForProcessing" "Processing" "AwaitingApproval" "Approved" "Finalising" "Finalised" "Deleting"
isClosed
Set to True if the PayRun is Finalised and changes can no longer be made to the PayRunEntries
 boolean true
manualNi
If set to true then you must provide your own value for NationalInsuranceCalculation.
You'd normally leave this set to false and let us automatically calculate NI amounts.
 boolean true
niSplit
If set to true Ni calculations are done for backdated pay for each pay period separately and then summed up
 boolean true
nationalInsuranceCalculation
Included as part of the PayRunEntry model to provide details of how the National Insurance Contribution was calculated.
Unless the PayRunEntry.ManualNi property is set to true then these value will all be read-only and are recalculated everytime a payrun is updated.
This calculation could be made up of one or more calculations made on different NI table letters.
Where more than NI table letter affects the calculation, the calculation for each NI table letter will be contain in the Breakdown.
 NationalInsuranceCalculation {NationalInsuranceCalculation}
payrollCodeChanged
Indicates whether or not the Payroll Code for this Employee has changed since the last FPS
 boolean true
aeNotEnroledWarning
If true then this Employee needs to be on an Auto Enrolment pension but isn't yet.
 boolean true
fps Item {Item}
emailId
If the Payslip for this PayRunEntry has been emailed to the employee then the Id for an EmployerEmail will be provided here.
if the value is all zeroes then the email is in the process of being created.
 string uuid "string"
recievingOffsetPay
If the pay is being topped up due to an applied Leave having the offset value set to true then
this will be set to true
 boolean true
paymentAfterLeaving
If this payment is for an employee that has left then this is set to true.
 boolean true
umbrellaPayment UmbrellaPayment {UmbrellaPayment}
isRemoved
Has the entry been removed from the payrun
 boolean true
isRolledBack
Set to True if the Pay Run Entry is currently rolled back
 boolean true
periodsCovered
The amount of periods that the Pay Run Entry covers. This can be > 1 when back pay for previous periods is paid in the current period
 integer int32 0
employeeRolePayItems
Automatically populated.
Array of base hourly and daily rates for the employee roles
 EmployeeRolePayItem[] {EmployeeRolePayItem}
warnings string "MissingBankDetails" "MissingAddressLines" "AddressInvalid" "NinoInvalid" "BelowNationalMinimumWage" "HighGrossPay" "HighNetPay" "InReceiptOfTaxRefund" "NetToGrossDiscrepancyAboveThreshold" "StatutoryMaternity" "TeachersPensionNotAutoCalculated" "JointTeachersPensionsNotAutoCalculated" "MissingNiNumber" "OpenEndedAbsences" "SspHasExpired" "SspDueToExpire" "InvalidBankDetails" "DuplicateEmployee" "TeachersPensionAge"
niLetterError string "XNotUsedForPensionersPayroll" "BUsedForMale" "CUsedBeforeStatePensionAge" "AUsedForUnder21" "AUsedOverStatePensionAge" "HUsedForOver24" "MUsedForOver20" "ZUsedForOver20" "IUsedForMale" "FUsedForNonFreeportWorker" "IUsedForNonFreeportWorker" "LUsedForNonFreeportWorker" "SUsedForNonFreeportWorker" "VUsedForNonVeteran" "VUsedForVeteransFirstEmploymentDateOverOneYearOld" "FUsedForFreeportWorkerOverThreeYearsOld" "IUsedForFreeportWorkerOverThreeYearsOld" "LUsedForFreeportWorkerOverThreeYearsOld" "SUsedForFreeportWorkerOverThreeYearsOld" "XNotUsedForUnder16" "DUsedForNonInvestmentZoneWorker" "EUsedForNonInvestmentZoneWorker" "KUsedForNonInvestmentZoneWorker" "NUsedForNonInvestmentZoneWorker"
teachersPensionAgeWarning string "EmployeeUnder16" "EmployeeTurns16" "EmployeeOver75" "EmployeeTurns75"
id
The unique id of the object
 string uuid "string"
personalDetails PersonalDetails {PersonalDetails}
employmentDetails EmploymentDetails {EmploymentDetails}
payOptions
This object forms the basis of the Employees payment.
 PayOptions {PayOptions}

JSON Example 

{
  "taxYear": "Year2017",
  "taxMonth": 0,
  "startDate": "2024-11-21",
  "endDate": "2024-11-21",
  "note": "string",
  "bacsSubReference": "string",
  "bacsHashCode": "string",
  "percentageOfWorkingDaysPaidAsNormal": 0.0,
  "workingDaysNotPaidAsNormal": 0.0,
  "payPeriod": "Custom",
  "ordinal": 0,
  "period": 0,
  "isNewStarter": true,
  "unpaidAbsence": true,
  "hasAttachmentOrders": true,
  "paymentDate": "2024-11-21",
  "priorPayrollCode": "string",
  "pensionSummary": {
    "pensionId": "string",
    "name": "string",
    "pensionSchemeId": "string",
    "startDate": "2024-11-21",
    "endDate": "2024-11-21",
    "workerGroupId": "string",
    "pensionRule": "ReliefAtSource",
    "subtractedBasicRateTax": true,
    "papdisPensionProviderId": "string",
    "papdisEmployerId": "string",
    "employeePensionContributionMultiplier": 0.0,
    "additionalVoluntaryContribution": 0.0,
    "avcIsPercentage": true,
    "autoEnrolled": true,
    "workerGroup": {
      "name": "string",
      "contributionLevelType": "UserDefined",
      "employeeContribution": 0.0,
      "employeeContributionIsPercentage": true,
      "employerContribution": 0.0,
      "employerContributionIsPercentage": true,
      "employerContributionTopUpPercentage": 0.0,
      "employerContributionIncludesNiSaving": true,
      "employerContributionNiSavingPercentage": 0.0,
      "isAvc": true,
      "additionalVoluntaryContribution": 0.0,
      "avcIsPercentage": true,
      "employerContributionNiSaving": 0.0,
      "customThreshold": true,
      "lowerLimit": 0.0,
      "upperLimit": 0.0,
      "papdisGroup": "string",
      "papdisSubGroup": "string",
      "localAuthorityNumber": "string",
      "schoolEmployerType": "string",
      "matIdentifier": "string",
      "matUniqueNumber": "string",
      "employerReference": "string",
      "lgpsFund": "Avon",
      "workerGroupId": "string",
      "assumedPensionablePay": "AssumedPensionablePay",
      "pensionablePayDefinition": "NotApplicable",
      "payslipDescription": "string",
      "id": "string"
    },
    "forcedTier": "string",
    "tiers": [
      {
        "name": "string",
        "description": "string",
        "rangeStart": 0.0,
        "rate": 0.0
      }
    ],
    "assumedPensionablePay": 0.0,
    "pensionablePayCodes": [
      "string"
    ],
    "tierablePayPayCodes": [
      "string"
    ],
    "isHalfContributionMember": true,
    "pensionableEarnings": 0.0,
    "pensionablePay": 0.0,
    "nonTierablePay": 0.0,
    "employeePensionContribution": 0.0,
    "employeePensionContributionAvc": 0.0,
    "employerPensionContribution": 0.0,
    "isForEndedPension": true,
    "associatedEmployeeRoles": [
      {
        "id": "string",
        "name": "string",
        "metadata": {},
        "url": "string"
      }
    ],
    "notionalPay": 0.0,
    "pensionableEarningsBfd": 0.0,
    "pensionablePayBfd": 0.0,
    "employeePensionContributionBfd": 0.0,
    "assumedPensionablePayBfd": 0.0,
    "employerPensionContributionBfd": 0.0,
    "employeePensionContributionAvcBfd": 0.0,
    "whenEarnedPensionSummaries": [
      {
        "pensionId": "string",
        "name": "string",
        "pensionSchemeId": "string",
        "startDate": "2024-11-21",
        "endDate": "2024-11-21",
        "workerGroupId": "string",
        "pensionRule": "ReliefAtSource",
        "subtractedBasicRateTax": true,
        "papdisPensionProviderId": "string",
        "papdisEmployerId": "string",
        "employeePensionContributionMultiplier": 0.0,
        "additionalVoluntaryContribution": 0.0,
        "avcIsPercentage": true,
        "autoEnrolled": true,
        "workerGroup": {
          "name": "string",
          "contributionLevelType": "UserDefined",
          "employeeContribution": 0.0,
          "employeeContributionIsPercentage": true,
          "employerContribution": 0.0,
          "employerContributionIsPercentage": true,
          "employerContributionTopUpPercentage": 0.0,
          "employerContributionIncludesNiSaving": true,
          "employerContributionNiSavingPercentage": 0.0,
          "isAvc": true,
          "additionalVoluntaryContribution": 0.0,
          "avcIsPercentage": true,
          "employerContributionNiSaving": 0.0,
          "customThreshold": true,
          "lowerLimit": 0.0,
          "upperLimit": 0.0,
          "papdisGroup": "string",
          "papdisSubGroup": "string",
          "localAuthorityNumber": "string",
          "schoolEmployerType": "string",
          "matIdentifier": "string",
          "matUniqueNumber": "string",
          "employerReference": "string",
          "lgpsFund": "Avon",
          "workerGroupId": "string",
          "assumedPensionablePay": "AssumedPensionablePay",
          "pensionablePayDefinition": "NotApplicable",
          "payslipDescription": "string",
          "id": "string"
        },
        "forcedTier": "string",
        "tiers": [
          {
            "name": "string",
            "description": "string",
            "rangeStart": 0.0,
            "rate": 0.0
          }
        ],
        "assumedPensionablePay": 0.0,
        "pensionablePayCodes": [
          "string"
        ],
        "tierablePayPayCodes": [
          "string"
        ],
        "isHalfContributionMember": true,
        "pensionableEarnings": 0.0,
        "pensionablePay": 0.0,
        "nonTierablePay": 0.0,
        "employeePensionContribution": 0.0,
        "employeePensionContributionAvc": 0.0,
        "employerPensionContribution": 0.0,
        "isForEndedPension": true,
        "associatedEmployeeRoles": [
          {
            "id": "string",
            "name": "string",
            "metadata": {},
            "url": "string"
          }
        ],
        "notionalPay": 0.0,
        "pensionableEarningsBfd": 0.0,
        "pensionablePayBfd": 0.0,
        "employeePensionContributionBfd": 0.0,
        "assumedPensionablePayBfd": 0.0,
        "employerPensionContributionBfd": 0.0,
        "employeePensionContributionAvcBfd": 0.0,
        "whenEarnedPensionSummaries": [
          {
            "pensionId": "string",
            "name": "string",
            "pensionSchemeId": "string",
            "startDate": "2024-11-21",
            "endDate": "2024-11-21",
            "workerGroupId": "string",
            "pensionRule": "ReliefAtSource",
            "subtractedBasicRateTax": true,
            "papdisPensionProviderId": "string",
            "papdisEmployerId": "string",
            "employeePensionContributionMultiplier": 0.0,
            "additionalVoluntaryContribution": 0.0,
            "avcIsPercentage": true,
            "autoEnrolled": true,
            "workerGroup": "error too many levels",
            "forcedTier": "string",
            "tiers": "error too many levels",
            "assumedPensionablePay": 0.0,
            "pensionablePayCodes": [
              "string"
            ],
            "tierablePayPayCodes": [
              "string"
            ],
            "isHalfContributionMember": true,
            "pensionableEarnings": 0.0,
            "pensionablePay": 0.0,
            "nonTierablePay": 0.0,
            "employeePensionContribution": 0.0,
            "employeePensionContributionAvc": 0.0,
            "employerPensionContribution": 0.0,
            "isForEndedPension": true,
            "associatedEmployeeRoles": "error too many levels",
            "notionalPay": 0.0,
            "pensionableEarningsBfd": 0.0,
            "pensionablePayBfd": 0.0,
            "employeePensionContributionBfd": 0.0,
            "assumedPensionablePayBfd": 0.0,
            "employerPensionContributionBfd": 0.0,
            "employeePensionContributionAvcBfd": 0.0,
            "whenEarnedPensionSummaries": "error too many levels",
            "periodFrom": "2024-11-21",
            "periodTo": "2024-11-21",
            "whenEarnedPensionableEarningsCorrection": 0.0,
            "whenEarnedPensionablePayCorrection": 0.0,
            "whenEarnedEmployeePensionContributionCorrection": 0.0,
            "whenEarnedEmployerPensionContributionCorrection": 0.0,
            "whenEarnedEmployeePensionContributionAvcCorrection": 0.0,
            "whenEarnedPensionableEarningsCorrectionBfd": 0.0,
            "whenEarnedPensionablePayCorrectionBfd": 0.0,
            "whenEarnedEmployeePensionContributionCorrectionBfd": 0.0,
            "whenEarnedEmployerPensionContributionCorrectionBfd": 0.0,
            "whenEarnedEmployeePensionContributionAvcCorrectionBfd": 0.0,
            "nominalCodeMappings": "error too many levels"
          }
        ],
        "periodFrom": "2024-11-21",
        "periodTo": "2024-11-21",
        "whenEarnedPensionableEarningsCorrection": 0.0,
        "whenEarnedPensionablePayCorrection": 0.0,
        "whenEarnedEmployeePensionContributionCorrection": 0.0,
        "whenEarnedEmployerPensionContributionCorrection": 0.0,
        "whenEarnedEmployeePensionContributionAvcCorrection": 0.0,
        "whenEarnedPensionableEarningsCorrectionBfd": 0.0,
        "whenEarnedPensionablePayCorrectionBfd": 0.0,
        "whenEarnedEmployeePensionContributionCorrectionBfd": 0.0,
        "whenEarnedEmployerPensionContributionCorrectionBfd": 0.0,
        "whenEarnedEmployeePensionContributionAvcCorrectionBfd": 0.0,
        "nominalCodeMappings": [
          {
            "nominalCode": "string",
            "nominalName": "string",
            "journalNarrative": "string",
            "payCode": "string"
          }
        ]
      }
    ],
    "periodFrom": "2024-11-21",
    "periodTo": "2024-11-21",
    "whenEarnedPensionableEarningsCorrection": 0.0,
    "whenEarnedPensionablePayCorrection": 0.0,
    "whenEarnedEmployeePensionContributionCorrection": 0.0,
    "whenEarnedEmployerPensionContributionCorrection": 0.0,
    "whenEarnedEmployeePensionContributionAvcCorrection": 0.0,
    "whenEarnedPensionableEarningsCorrectionBfd": 0.0,
    "whenEarnedPensionablePayCorrectionBfd": 0.0,
    "whenEarnedEmployeePensionContributionCorrectionBfd": 0.0,
    "whenEarnedEmployerPensionContributionCorrectionBfd": 0.0,
    "whenEarnedEmployeePensionContributionAvcCorrectionBfd": 0.0,
    "nominalCodeMappings": [
      {
        "nominalCode": "string",
        "nominalName": "string",
        "journalNarrative": "string",
        "payCode": "string"
      }
    ]
  },
  "pensionSummaries": [
    {
      "pensionId": "string",
      "name": "string",
      "pensionSchemeId": "string",
      "startDate": "2024-11-21",
      "endDate": "2024-11-21",
      "workerGroupId": "string",
      "pensionRule": "ReliefAtSource",
      "subtractedBasicRateTax": true,
      "papdisPensionProviderId": "string",
      "papdisEmployerId": "string",
      "employeePensionContributionMultiplier": 0.0,
      "additionalVoluntaryContribution": 0.0,
      "avcIsPercentage": true,
      "autoEnrolled": true,
      "workerGroup": {
        "name": "string",
        "contributionLevelType": "UserDefined",
        "employeeContribution": 0.0,
        "employeeContributionIsPercentage": true,
        "employerContribution": 0.0,
        "employerContributionIsPercentage": true,
        "employerContributionTopUpPercentage": 0.0,
        "employerContributionIncludesNiSaving": true,
        "employerContributionNiSavingPercentage": 0.0,
        "isAvc": true,
        "additionalVoluntaryContribution": 0.0,
        "avcIsPercentage": true,
        "employerContributionNiSaving": 0.0,
        "customThreshold": true,
        "lowerLimit": 0.0,
        "upperLimit": 0.0,
        "papdisGroup": "string",
        "papdisSubGroup": "string",
        "localAuthorityNumber": "string",
        "schoolEmployerType": "string",
        "matIdentifier": "string",
        "matUniqueNumber": "string",
        "employerReference": "string",
        "lgpsFund": "Avon",
        "workerGroupId": "string",
        "assumedPensionablePay": "AssumedPensionablePay",
        "pensionablePayDefinition": "NotApplicable",
        "payslipDescription": "string",
        "id": "string"
      },
      "forcedTier": "string",
      "tiers": [
        {
          "name": "string",
          "description": "string",
          "rangeStart": 0.0,
          "rate": 0.0
        }
      ],
      "assumedPensionablePay": 0.0,
      "pensionablePayCodes": [
        "string"
      ],
      "tierablePayPayCodes": [
        "string"
      ],
      "isHalfContributionMember": true,
      "pensionableEarnings": 0.0,
      "pensionablePay": 0.0,
      "nonTierablePay": 0.0,
      "employeePensionContribution": 0.0,
      "employeePensionContributionAvc": 0.0,
      "employerPensionContribution": 0.0,
      "isForEndedPension": true,
      "associatedEmployeeRoles": [
        {
          "id": "string",
          "name": "string",
          "metadata": {},
          "url": "string"
        }
      ],
      "notionalPay": 0.0,
      "pensionableEarningsBfd": 0.0,
      "pensionablePayBfd": 0.0,
      "employeePensionContributionBfd": 0.0,
      "assumedPensionablePayBfd": 0.0,
      "employerPensionContributionBfd": 0.0,
      "employeePensionContributionAvcBfd": 0.0,
      "whenEarnedPensionSummaries": [
        {
          "pensionId": "string",
          "name": "string",
          "pensionSchemeId": "string",
          "startDate": "2024-11-21",
          "endDate": "2024-11-21",
          "workerGroupId": "string",
          "pensionRule": "ReliefAtSource",
          "subtractedBasicRateTax": true,
          "papdisPensionProviderId": "string",
          "papdisEmployerId": "string",
          "employeePensionContributionMultiplier": 0.0,
          "additionalVoluntaryContribution": 0.0,
          "avcIsPercentage": true,
          "autoEnrolled": true,
          "workerGroup": {
            "name": "string",
            "contributionLevelType": "UserDefined",
            "employeeContribution": 0.0,
            "employeeContributionIsPercentage": true,
            "employerContribution": 0.0,
            "employerContributionIsPercentage": true,
            "employerContributionTopUpPercentage": 0.0,
            "employerContributionIncludesNiSaving": true,
            "employerContributionNiSavingPercentage": 0.0,
            "isAvc": true,
            "additionalVoluntaryContribution": 0.0,
            "avcIsPercentage": true,
            "employerContributionNiSaving": 0.0,
            "customThreshold": true,
            "lowerLimit": 0.0,
            "upperLimit": 0.0,
            "papdisGroup": "string",
            "papdisSubGroup": "string",
            "localAuthorityNumber": "string",
            "schoolEmployerType": "string",
            "matIdentifier": "string",
            "matUniqueNumber": "string",
            "employerReference": "string",
            "lgpsFund": "Avon",
            "workerGroupId": "string",
            "assumedPensionablePay": "AssumedPensionablePay",
            "pensionablePayDefinition": "NotApplicable",
            "payslipDescription": "string",
            "id": "string"
          },
          "forcedTier": "string",
          "tiers": [
            {
              "name": "string",
              "description": "string",
              "rangeStart": 0.0,
              "rate": 0.0
            }
          ],
          "assumedPensionablePay": 0.0,
          "pensionablePayCodes": [
            "string"
          ],
          "tierablePayPayCodes": [
            "string"
          ],
          "isHalfContributionMember": true,
          "pensionableEarnings": 0.0,
          "pensionablePay": 0.0,
          "nonTierablePay": 0.0,
          "employeePensionContribution": 0.0,
          "employeePensionContributionAvc": 0.0,
          "employerPensionContribution": 0.0,
          "isForEndedPension": true,
          "associatedEmployeeRoles": [
            {
              "id": "string",
              "name": "string",
              "metadata": {},
              "url": "string"
            }
          ],
          "notionalPay": 0.0,
          "pensionableEarningsBfd": 0.0,
          "pensionablePayBfd": 0.0,
          "employeePensionContributionBfd": 0.0,
          "assumedPensionablePayBfd": 0.0,
          "employerPensionContributionBfd": 0.0,
          "employeePensionContributionAvcBfd": 0.0,
          "whenEarnedPensionSummaries": [
            {
              "pensionId": "string",
              "name": "string",
              "pensionSchemeId": "string",
              "startDate": "2024-11-21",
              "endDate": "2024-11-21",
              "workerGroupId": "string",
              "pensionRule": "ReliefAtSource",
              "subtractedBasicRateTax": true,
              "papdisPensionProviderId": "string",
              "papdisEmployerId": "string",
              "employeePensionContributionMultiplier": 0.0,
              "additionalVoluntaryContribution": 0.0,
              "avcIsPercentage": true,
              "autoEnrolled": true,
              "workerGroup": "error too many levels",
              "forcedTier": "string",
              "tiers": "error too many levels",
              "assumedPensionablePay": 0.0,
              "pensionablePayCodes": [
                "string"
              ],
              "tierablePayPayCodes": [
                "string"
              ],
              "isHalfContributionMember": true,
              "pensionableEarnings": 0.0,
              "pensionablePay": 0.0,
              "nonTierablePay": 0.0,
              "employeePensionContribution": 0.0,
              "employeePensionContributionAvc": 0.0,
              "employerPensionContribution": 0.0,
              "isForEndedPension": true,
              "associatedEmployeeRoles": "error too many levels",
              "notionalPay": 0.0,
              "pensionableEarningsBfd": 0.0,
              "pensionablePayBfd": 0.0,
              "employeePensionContributionBfd": 0.0,
              "assumedPensionablePayBfd": 0.0,
              "employerPensionContributionBfd": 0.0,
              "employeePensionContributionAvcBfd": 0.0,
              "whenEarnedPensionSummaries": "error too many levels",
              "periodFrom": "2024-11-21",
              "periodTo": "2024-11-21",
              "whenEarnedPensionableEarningsCorrection": 0.0,
              "whenEarnedPensionablePayCorrection": 0.0,
              "whenEarnedEmployeePensionContributionCorrection": 0.0,
              "whenEarnedEmployerPensionContributionCorrection": 0.0,
              "whenEarnedEmployeePensionContributionAvcCorrection": 0.0,
              "whenEarnedPensionableEarningsCorrectionBfd": 0.0,
              "whenEarnedPensionablePayCorrectionBfd": 0.0,
              "whenEarnedEmployeePensionContributionCorrectionBfd": 0.0,
              "whenEarnedEmployerPensionContributionCorrectionBfd": 0.0,
              "whenEarnedEmployeePensionContributionAvcCorrectionBfd": 0.0,
              "nominalCodeMappings": "error too many levels"
            }
          ],
          "periodFrom": "2024-11-21",
          "periodTo": "2024-11-21",
          "whenEarnedPensionableEarningsCorrection": 0.0,
          "whenEarnedPensionablePayCorrection": 0.0,
          "whenEarnedEmployeePensionContributionCorrection": 0.0,
          "whenEarnedEmployerPensionContributionCorrection": 0.0,
          "whenEarnedEmployeePensionContributionAvcCorrection": 0.0,
          "whenEarnedPensionableEarningsCorrectionBfd": 0.0,
          "whenEarnedPensionablePayCorrectionBfd": 0.0,
          "whenEarnedEmployeePensionContributionCorrectionBfd": 0.0,
          "whenEarnedEmployerPensionContributionCorrectionBfd": 0.0,
          "whenEarnedEmployeePensionContributionAvcCorrectionBfd": 0.0,
          "nominalCodeMappings": [
            {
              "nominalCode": "string",
              "nominalName": "string",
              "journalNarrative": "string",
              "payCode": "string"
            }
          ]
        }
      ],
      "periodFrom": "2024-11-21",
      "periodTo": "2024-11-21",
      "whenEarnedPensionableEarningsCorrection": 0.0,
      "whenEarnedPensionablePayCorrection": 0.0,
      "whenEarnedEmployeePensionContributionCorrection": 0.0,
      "whenEarnedEmployerPensionContributionCorrection": 0.0,
      "whenEarnedEmployeePensionContributionAvcCorrection": 0.0,
      "whenEarnedPensionableEarningsCorrectionBfd": 0.0,
      "whenEarnedPensionablePayCorrectionBfd": 0.0,
      "whenEarnedEmployeePensionContributionCorrectionBfd": 0.0,
      "whenEarnedEmployerPensionContributionCorrectionBfd": 0.0,
      "whenEarnedEmployeePensionContributionAvcCorrectionBfd": 0.0,
      "nominalCodeMappings": [
        {
          "nominalCode": "string",
          "nominalName": "string",
          "journalNarrative": "string",
          "payCode": "string"
        }
      ]
    }
  ],
  "employee": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "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
    }
  },
  "periodOverrides": [
    {
      "type": "BasicPay",
      "value": 0.0,
      "originalValue": 0.0,
      "note": "string",
      "attachmentOrderId": "string",
      "pensionId": "string",
      "leaveId": "string"
    }
  ],
  "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
    }
  },
  "totalsYtdOverrides": [
    {
      "type": "BasicPay",
      "value": 0.0,
      "originalValue": 0.0,
      "note": "string",
      "attachmentOrderId": "string",
      "pensionId": "string",
      "leaveId": "string"
    }
  ],
  "forcedCisVatAmount": 0.0,
  "holidayAccrued": 0.0,
  "state": "Opening",
  "isClosed": true,
  "manualNi": true,
  "niSplit": true,
  "nationalInsuranceCalculation": {
    "breakdown": [
      {
        "niCategory": "string",
        "asDirector": true,
        "earningsUptoIncludingLEL": 0.0,
        "earningsAboveLELUptoIncludingPT": 0.0,
        "earningsAbovePTUptoIncludingST": 0.0,
        "earningsAbovePTUptoIncludingUEL": 0.0,
        "earningsAboveSTUptoIncludingUEL": 0.0,
        "earningsAboveSTUptoIncludingFUST": 0.0,
        "earningsAboveFUSTUptoIncludingUEL": 0.0,
        "earningsAboveUEL": 0.0,
        "employeeNiGross": 0.0,
        "employeeNiRebate": 0.0,
        "employerNiGross": 0.0,
        "employerNiRebate": 0.0,
        "employeeNi": 0.0,
        "employerNi": 0.0,
        "netNi": 0.0,
        "niablePay": 0.0
      }
    ],
    "niCategory": "string",
    "asDirector": true,
    "earningsUptoIncludingLEL": 0.0,
    "earningsAboveLELUptoIncludingPT": 0.0,
    "earningsAbovePTUptoIncludingST": 0.0,
    "earningsAbovePTUptoIncludingUEL": 0.0,
    "earningsAboveSTUptoIncludingUEL": 0.0,
    "earningsAboveSTUptoIncludingFUST": 0.0,
    "earningsAboveFUSTUptoIncludingUEL": 0.0,
    "earningsAboveUEL": 0.0,
    "employeeNiGross": 0.0,
    "employeeNiRebate": 0.0,
    "employerNiGross": 0.0,
    "employerNiRebate": 0.0,
    "employeeNi": 0.0,
    "employerNi": 0.0,
    "netNi": 0.0,
    "niablePay": 0.0
  },
  "payrollCodeChanged": true,
  "aeNotEnroledWarning": true,
  "fps": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "emailId": "string",
  "recievingOffsetPay": true,
  "paymentAfterLeaving": true,
  "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
  },
  "isRemoved": true,
  "isRolledBack": true,
  "periodsCovered": 0,
  "employeeRolePayItems": [
    {
      "roleId": "string",
      "isPrimary": true,
      "baseDailyRate": 0.0,
      "baseHourlyRate": 0.0,
      "weight": 0.0
    }
  ],
  "warnings": "MissingBankDetails",
  "niLetterError": "XNotUsedForPensionersPayroll",
  "teachersPensionAgeWarning": "EmployeeUnder16",
  "id": "string",
  "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"
    }
  },
  "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
  },
  "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"
      }
    ]
  }
}

References

Contained in Models

- none -

Consumed by Operations
Update a PayRunEntry
Returned by Operations
Get a PayRunEntry
Update a PayRunEntry
PayRunEntry Umbrella Payment
Gets the last closed pay run entry for an employee.
Gets last PayRunEntry for a Pension
Get last PayRunEntry for a Pension (deprecated)
Getting Started Understanding PayOptions
Getting Started The Ordinal property
Completing a Pay Run Review the PayRun