PensionMembershipsReportReportResponse

Used to encapsulate a response for any of the reports.
See the Introduction Guide for Reports for more details

Schema

Name / Description Type / Format Example
type
The content-type, this would usually be the same as the accept header you provided when you requested the report
 string "string"
content
This could contain a link to a PDF file, HTML content or other content, depending on the Type value.
 string "string"
model PensionMembershipsReport {PensionMembershipsReport}
stream
byte array
 string byte "string"

JSON Example 

{
  "type": "string",
  "content": "string",
  "model": {
    "lines": [
      {
        "payrollCode": "string",
        "pensionScheme": "string",
        "workerGroup": "string",
        "joinDate": "string",
        "joinReason": "Automatic",
        "isPensionJoinerActionReported": true,
        "endDate": "string",
        "endReason": "OptOut",
        "isPensionLeaverActionReported": true,
        "aeStatusAtJoining": "Eligible",
        "roleRefs": "string",
        "pensionEmployeeContribution": 0.0,
        "isEmployeeContributionPercentage": true,
        "pensionTiers": "string",
        "pensionAVCContribution": 0.0,
        "isAvcPercentage": true,
        "pensionEmployerContribution": 0.0,
        "isEmployerContributionPercentage": true,
        "pensionMembershipNo": "string",
        "mcrRoleID1": "string",
        "mcrRoleID2": "string",
        "isHalfContributionMember": true,
        "tpAdminNino": "string",
        "pensionableEarningsYTD": 0.0,
        "pensionablePayYTD": 0.0,
        "employeePensionYTD": 0.0,
        "avcPensionYTD": 0.0,
        "employerPensionYTD": 0.0,
        "assumedPensionablePayYTD": 0.0,
        "employee": {
          "id": "string",
          "name": "string",
          "metadata": {},
          "url": "string"
        },
        "department": "string"
      }
    ],
    "employer": {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    },
    "payPeriod": "Custom",
    "ordinal": 0,
    "period": 0,
    "periodTo": 0,
    "startPeriodName": "string",
    "endPeriodName": "string",
    "startDate": "2024-11-21",
    "endDate": "2024-11-21",
    "report": "GrossToNet",
    "taxYear": "Year2017",
    "title": "string",
    "isDraft": true
  },
  "stream": "string"
}

References

Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Export Multiple Pension Memberships Report