PapdisPayrollPeriod

Name / Description Type / Format Example
payPeriodStartDate string date "2024-07-13"
payPeriodEndDate string date "2024-07-13"
contributionDeductionDate string date "2024-07-13"
frequencyCode string "string"
taxPeriod integer int32 0
payReferenceStartDate string date "2024-07-13"
payReferenceEndDate string date "2024-07-13"
employees
Employees and contributions made in this period
PapdisEmployee[] {PapdisEmployee}
{
  "payPeriodStartDate": "2024-07-13",
  "payPeriodEndDate": "2024-07-13",
  "contributionDeductionDate": "2024-07-13",
  "frequencyCode": "string",
  "taxPeriod": 0,
  "payReferenceStartDate": "2024-07-13",
  "payReferenceEndDate": "2024-07-13",
  "employees": [
    {
      "id": 0,
      "employeeId": "string",
      "name": {
        "title": "string",
        "forename1": "string",
        "forename2": "string",
        "surname": "string"
      },
      "identity": {
        "employeeId": "string",
        "birthDate": "2024-07-13",
        "gender": "string",
        "nationalInsuranceNumber": "string",
        "employmentStartDate": "2024-07-13",
        "maritalStatus": "Single"
      },
      "contact": {
        "postalAddress": {
          "address1": "string",
          "address2": "string",
          "address3": "string",
          "address4": "string",
          "postcode": "string",
          "country": "string"
        },
        "emailAddress": "string",
        "secondaryEmailAddress": "string",
        "telephone": "string",
        "mobile": "string"
      },
      "pay": {
        "pensionableEarningsAmount": 0.0,
        "totalGrossQualifyingEarningsAmount": 0.0,
        "annualSalary": 0.0,
        "annualPensionableEarningsAmount": 0.0,
        "basis": "Hourly",
        "payAmountMultiplier": 0.0
      },
      "assessment": {
        "assessmentCode": 0,
        "eventCode": 0,
        "eventDate": "2024-07-13",
        "statutoryLetterCode": "string",
        "isIndividualAlreadyMemberOfQPS": true,
        "deferralDate": "2024-07-13",
        "enrolmentCommunicationsIssuedDate": "2024-07-13",
        "workerExclusionCode": "string",
        "reenrolmentIndicator": true,
        "optOutWindowEndDate": "2024-07-13",
        "pensionJoinReason": "Automatic",
        "pensionStartDate": "2024-07-13"
      },
      "contribution": {
        "employerContributionsAmount": 0.0,
        "employerContributionsPercent": 0.0,
        "employeeContributionsAmount": 0.0,
        "employeeContributionsPercent": 0.0,
        "additionalVoluntaryContributionsAmount": 0.0,
        "additionalVoluntaryContributionsPercent": 0.0,
        "salarySacrificeIndicator": true,
        "contributionStartDate": "2024-07-13",
        "employeeContributionIsPercentage": true,
        "employerContributionIsPercentage": true,
        "unadjustedEmployeeContributionsAmount": 0.0,
        "unadjustedEmployerContributionsAmount": 0.0,
        "unadjustedAdditionalVoluntaryContributionsAmount": 0.0,
        "employerContributionNiSavings": 0.0,
        "contributionLevelType": "UserDefined",
        "isAvcOnly": true,
        "employerContributionIncludesNiSaving": true,
        "unadjustedAdditionalVoluntaryContributionsPercent": 0.0,
        "isHalfContributionMember": true,
        "assumedPensionablePay": 0.0,
        "isPensionRefund": true,
        "lowerLimit": 0.0
      },
      "exit": {
        "exitDate": "2024-07-13",
        "exitReasonCode": 0,
        "aeOptOutDate": "2024-07-13",
        "aeOptOutReference": "string",
        "reasonForLeaving": "string"
      },
      "payrollCode": "string",
      "aeStateDate": "2024-07-13",
      "leaveDate": "2024-07-13",
      "statePensionAge": 0,
      "contractualJoinerIndicator": true,
      "jobTitle": "string",
      "pensionMemberReference": "string",
      "pensionUniqueId": "string",
      "employeeRoleUniqueId": "string",
      "lastPaymentDate": "2024-07-13",
      "hasPrevioulyLeftPension": true,
      "pensionablePayDefinition": "NotApplicable"
    }
  ]
}
Contained in Models
PapdisEmployer
Consumed by Operations

- none -

Returned by Operations

- none -