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.

Name / Description Type / Format Example
taxYear string "Year2017" "Year2018" "Year2019" "Year2020"
taxMonth
The Tax Month that the Payment Date falls in
integer int32 0
startDate string date-time "2019-11-15T10:29:20"
endDate string date-time "2019-11-15T10:29:20"
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 "Monthly" "FourWeekly" "Fortnightly" "Weekly"
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-time "2019-11-15T10:29:20"
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"
payOptions
When the PayRunEntry is first created, the PayOptions is copied from the Employee record.
Adjustments to the basic pay may be made if the Employee is on leave. You can then make changes to the PayOptions here without it changing the PayOPtions on the Employee record, so any changes you make affect this pay period only.
PayOptions {PayOptions}
pensionSummary
A summary of the details for the Pension (if any) that the Employee is assigned to
PensionSummary {PensionSummary}
employee
The Employee this PayRunEntry relates to
Item {Item}
totals
The total values for this employee in the current period
PayRunTotals {PayRunTotals}
totalsYtd
The total values for this employee Year To Date, not including current period
PayRunTotals {PayRunTotals}
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
isClosed
Indicates whether or not the PayRun is closed and changes can no longer be made
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
nationalInsuranceCalculation
A breakdown of how the NI values were arrived at. This is read-only if ManualNi is false
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
Represents the FPS that relates to this Payment. A value will only be present once the PayRun is finalised.
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"
umbrellaPayment UmbrellaPayment {UmbrellaPayment}
id
The unique id of the object
string uuid "string"
personalDetails PersonalDetails {PersonalDetails}
employmentDetails EmploymentDetails {EmploymentDetails}
{
  "taxYear": "Year2017",
  "taxMonth": 0,
  "startDate": "2019-11-15T10:29:20",
  "endDate": "2019-11-15T10:29:20",
  "note": "string",
  "bacsSubReference": "string",
  "bacsHashCode": "string",
  "percentageOfWorkingDaysPaidAsNormal": 0.0,
  "workingDaysNotPaidAsNormal": 0.0,
  "payPeriod": "Monthly",
  "period": 0,
  "isNewStarter": true,
  "unpaidAbsence": true,
  "hasAttachmentOrders": true,
  "paymentDate": "2019-11-15T10:29:20",
  "priorPayrollCode": "string",
  "payOptions": {
    "period": "Monthly",
    "payAmount": 0.0,
    "basis": "Hourly",
    "nationalMinimumWage": true,
    "payAmountMultiplier": 0.0,
    "autoAdjustForLeave": true,
    "method": "Cash",
    "payCode": "string",
    "withholdTaxRefundIfPayIsZero": true,
    "mileageVehicleType": "Car",
    "mapsMiles": 0,
    "taxAndNi": {
      "niTable": "string",
      "secondaryClass1NotPayable": true,
      "postgradLoan": true,
      "studentLoan": "None",
      "taxCode": "string",
      "week1Month1": true
    },
    "fpsFields": {
      "irregularPaymentPattern": true,
      "nonIndividual": true,
      "hoursNormallyWorked": "LessThan16",
      "flexibleDrawdown": {
        "hasFlexibleDrawdown": true,
        "death": true,
        "pension": true,
        "taxablePayment": 0.0,
        "nonTaxablePayment": 0.0
      },
      "trivialCommutationPayment": {
        "hasTrivialCommutationPayment": true,
        "tcls": 0.0,
        "personalPension": 0.0,
        "occupationalPension": 0.0
      }
    },
    "regularPayLines": [
      {
        "value": 0.0,
        "rate": 0.0,
        "multiplier": 0.0,
        "description": "string",
        "code": "string"
      }
    ]
  },
  "pensionSummary": {
    "name": "string",
    "pensionSchemeId": "string",
    "startDate": "2019-11-15T10:29:20",
    "workerGroupId": "string",
    "pensionRule": "ReliefAtSource",
    "papdisPensionProviderId": "string",
    "papdisEmployerId": "string",
    "employeePensionContributionMultiplier": 0.0,
    "additionalVoluntaryContribution": 0.0,
    "avcIsPercentage": true,
    "autoEnrolled": true,
    "workerGroup": {
      "name": "string",
      "employeeContribution": 0.0,
      "employeeContributionIsPercentage": true,
      "employerContribution": 0.0,
      "employerContributionIsPercentage": true,
      "customThreshold": true,
      "lowerLimit": 0.0,
      "upperLimit": 0.0,
      "papdisGroup": "string",
      "papdisSubGroup": "string",
      "workerGroupId": "string",
      "id": "string"
    }
  },
  "employee": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "totals": {
    "basicPay": 0.0,
    "gross": 0.0,
    "grossForNi": 0.0,
    "grossForTax": 0.0,
    "employerNi": 0.0,
    "employeeNi": 0.0,
    "tax": 0.0,
    "netPay": 0.0,
    "adjustments": 0.0,
    "takeHomePay": 0.0,
    "nonTaxOrNICPmt": 0.0,
    "itemsSubjectToClass1NIC": 0.0,
    "dednsFromNetPay": 0.0,
    "smp": 0.0,
    "spp": 0.0,
    "sap": 0.0,
    "shpp": 0.0,
    "spbp": 0.0,
    "studentLoanRecovered": 0.0,
    "postgradLoanRecovered": 0.0,
    "pensionablePay": 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,
    "pbik": 0.0,
    "mapsMiles": 0,
    "totalCost": 0.0
  },
  "totalsYtd": {
    "basicPay": 0.0,
    "gross": 0.0,
    "grossForNi": 0.0,
    "grossForTax": 0.0,
    "employerNi": 0.0,
    "employeeNi": 0.0,
    "tax": 0.0,
    "netPay": 0.0,
    "adjustments": 0.0,
    "takeHomePay": 0.0,
    "nonTaxOrNICPmt": 0.0,
    "itemsSubjectToClass1NIC": 0.0,
    "dednsFromNetPay": 0.0,
    "smp": 0.0,
    "spp": 0.0,
    "sap": 0.0,
    "shpp": 0.0,
    "spbp": 0.0,
    "studentLoanRecovered": 0.0,
    "postgradLoanRecovered": 0.0,
    "pensionablePay": 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,
    "pbik": 0.0,
    "mapsMiles": 0,
    "totalCost": 0.0
  },
  "forcedCisVatAmount": 0.0,
  "isClosed": true,
  "manualNi": true,
  "nationalInsuranceCalculation": {
    "earningsUptoIncludingLEL": 0.0,
    "earningsAboveLELUptoIncludingPT": 0.0,
    "earningsAbovePTUptoIncludingST": 0.0,
    "earningsAboveSTUptoIncludingUEL": 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
  },
  "payrollCodeChanged": true,
  "aeNotEnroledWarning": true,
  "fps": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "emailId": "string",
  "umbrellaPayment": {
    "chargePerTimesheet": 0.0,
    "invoiceValue": 0.0,
    "mapsMiles": 0,
    "otherExpenses": 0.0,
    "numberOfTimesheets": 0,
    "hoursWorked": 0.0
  },
  "id": "string",
  "personalDetails": {
    "address": {
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "line4": "string",
      "line5": "string",
      "postCode": "string",
      "country": "England"
    },
    "maritalStatus": "Single",
    "title": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "email": "string",
    "emailPayslip": true,
    "passwordProtectPayslip": true,
    "emailStatement": true,
    "photoUrl": "string",
    "telephone": "string",
    "mobile": "string",
    "dateOfBirth": "2019-11-15T10:29:20",
    "statePensionAge": 0,
    "gender": "Male",
    "niNumber": "string",
    "passportNumber": "string",
    "partnerDetails": {
      "firstName": "string",
      "initials": "string",
      "lastName": "string",
      "niNumber": "string"
    }
  },
  "employmentDetails": {
    "cisSubContractor": true,
    "payrollCode": "string",
    "isApprentice": true,
    "workingPattern": "string",
    "forcePreviousPayrollCode": "string",
    "starterDetails": {
      "startDate": "2019-11-15T10:29:20",
      "starterDeclaration": "A",
      "overseasEmployerDetails": {
        "overseasEmployer": true,
        "overseasSecondmentStatus": "MoreThan183Days",
        "eeaCitizen": true,
        "epm6Scheme": true
      }
    },
    "directorshipDetails": {
      "isDirector": true,
      "startDate": "2019-11-15T10:29:20",
      "leaveDate": "2019-11-15T10:29:20",
      "niAlternativeMethod": true
    },
    "leaverDetails": {
      "hasLeft": true,
      "leaveDate": "2019-11-15T10:29:20",
      "isDeceased": true
    },
    "cis": {
      "type": "SoleTrader",
      "utr": "string",
      "tradingName": "string",
      "companyUtr": "string",
      "companyNumber": "string",
      "vatRegistered": true,
      "vatNumber": "string",
      "vatRate": 0.0,
      "verification": {
        "manuallyEntered": true,
        "matchInsteadOfVerify": true,
        "number": "string",
        "date": "2019-11-15T10:29:20",
        "taxStatus": "Gross",
        "verificationRequest": "string",
        "verificationResponse": {
          "employeeUniqueId": "string",
          "emailStatementTo": "string",
          "numberOfPayments": 0,
          "item": {
            "id": "string",
            "name": "string",
            "metadata": {},
            "url": "string"
          },
          "displayName": "string",
          "action": "string",
          "type": "string",
          "name": {
            "ttl": "string",
            "fore": [
              "string"
            ],
            "initials": "string",
            "sur": "string"
          },
          "tradingName": "string",
          "worksRef": "string",
          "unmatchedRate": "string",
          "utr": "string",
          "crn": "string",
          "nino": "string",
          "partnership": {
            "name": "string",
            "utr": "string"
          },
          "address": {
            "line": [
              "string"
            ],
            "postcode": "string",
            "postCode": "string",
            "ukPostcode": "string",
            "country": "string"
          },
          "telephone": "string",
          "totalPaymentsUnrounded": "string",
          "costOfMaterialsUnrounded": "string",
          "umbrellaFee": "string",
          "validationMsg": "string",
          "verificationNumber": "string",
          "totalPayments": "string",
          "costOfMaterials": "string",
          "totalDeducted": "string",
          "matched": "string",
          "taxTreatment": "string"
        }
      }
    }
  }
}
Contained in Models

- none -

Consumed by Operations
Update a PayRunEntry
Getting Started Understanding PayOptions
Completing a Payrun Review the PayRun