HmrcFormsViewModel resource

Methods

  • get - Gets hmrc forms view model for employee

Resource

{
    "autoEnrolmentData": {
        "assessmentDate": "date-time",
        "autoEnrolmentNotices": [
            {
                "assessmentStatus": "string",
                "downloadUrl": "string",
                "emailUrl": "string",
                "enrolledDate": "date-time",
                "enrolmentDeferralDate": "date-time",
                "id": "int32",
                "noticeSentDate": "date-time"
            }
        ],
        "currentAssessmentStatus": "string",
        "deferralDate": "date-time",
        "downloadUrl": "string",
        "hasNotice": "boolean",
        "hasPensionSchemeContributionPlan": "boolean",
        "noticeSentDate": "date-time",
        "validPensionAssessmentStatusTypes": [
            "int32"
        ]
    },
    "hasNationalInsuranceBackCalculation": "boolean",
    "hasP11ds": "boolean",
    "hasP45": "boolean",
    "hasP60s": "boolean",
    "hmrcNotices": [
        {
            "dateApplied": "string",
            "newValue": "string",
            "noticeType": "string",
            "taxPeriod": "string",
            "taxYear": "string"
        }
    ],
    "nationalInsuranceBackCalculation": {
        "downloadUrl": "string"
    },
    "p11ds": [
        {
            "currentState": "string",
            "dateGenerated": "date-time",
            "downloadUrl": "string",
            "employeeId": "int32",
            "id": "int32",
            "isPublished": "boolean",
            "notificationDate": "date-time",
            "taxYear": "int32",
            "taxYearEnding": "int32",
            "text": "string"
        }
    ],
    "p45": {
        "employeeEndDate": "date-time",
        "notificationDate": "date-time",
        "p45Url": "string"
    },
    "p60": {
        "employeeEndDate": "date-time",
        "financialYearEnding": "int32",
        "notificationDate": "date-time",
        "p60Url": "string"
    },
    "p60s": [
        {
            "dateGenerated": "date-time",
            "downloadUrl": "string",
            "financialYearEnding": "int32",
            "id": "int32",
            "notificationDate": "date-time",
            "status": "string",
            "text": "string"
        }
    ],
    "prevP45": {
        "exists": "boolean",
        "p45Url": "string",
        "uploadDate": "date-time"
    },
    "urls": {
        "checkForInformallyPayrollingEnabledUrl": "string",
        "downloadAll": "string",
        "downloadFile": "string",
        "downloadSubmission": "string",
        "haveAllEmployeeP11dsBeenPublished": "string",
        "haveEmployeeP11dsBeenSubmitted": "string",
        "load": "string",
        "notify": "string",
        "notifyAll": "string",
        "paymentUrl": "string",
        "publish": "string",
        "publishAll": "string",
        "submit": "string",
        "unpublish": "string",
        "unpublishAll": "string"
    }
}

Properties

Name Type Description
autoEnrolmentData object AutoEnrolmentNoticeViewModel
autoEnrolmentData.assessmentDate date-time Nullable
autoEnrolmentData.autoEnrolmentNotices[] array
autoEnrolmentData.autoEnrolmentNotices[].assessmentStatus string PensionAssessmentStatusEnum

Possible values are:

  • NotAssessed
  • EligibleJobHolder
  • NonEligibleJobHolder
  • EntitledWorker
  • Postponed
autoEnrolmentData.autoEnrolmentNotices[].downloadUrl string String
autoEnrolmentData.autoEnrolmentNotices[].emailUrl string String
autoEnrolmentData.autoEnrolmentNotices[].enrolledDate date-time Nullable
autoEnrolmentData.autoEnrolmentNotices[].enrolmentDeferralDate date-time Nullable
autoEnrolmentData.autoEnrolmentNotices[].id int32 Nullable
autoEnrolmentData.autoEnrolmentNotices[].noticeSentDate date-time Nullable
autoEnrolmentData.currentAssessmentStatus string Nullable

Possible values are:

  • NotAssessed
  • EligibleJobHolder
  • NonEligibleJobHolder
  • EntitledWorker
  • Postponed
autoEnrolmentData.deferralDate date-time Nullable
autoEnrolmentData.downloadUrl string String
autoEnrolmentData.hasNotice boolean Boolean
autoEnrolmentData.hasPensionSchemeContributionPlan boolean Boolean
autoEnrolmentData.noticeSentDate date-time Nullable
autoEnrolmentData.validPensionAssessmentStatusTypes[] array of int32
hasNationalInsuranceBackCalculation boolean Boolean
hasP11ds boolean Boolean
hasP45 boolean Boolean
hasP60s boolean Boolean
hmrcNotices[] array
hmrcNotices[].dateApplied string String
hmrcNotices[].newValue string String
hmrcNotices[].noticeType string String
hmrcNotices[].taxPeriod string String
hmrcNotices[].taxYear string String
nationalInsuranceBackCalculation object NationalInsuranceBackCalculationViewModel
nationalInsuranceBackCalculation.downloadUrl string String
p11ds[] array
p11ds[].currentState string P11DStatus

Possible values are:

  • Unknown
  • Unpublished
  • Published
p11ds[].dateGenerated date-time DateTime
p11ds[].downloadUrl string String
p11ds[].employeeId int32 Int32
p11ds[].id int32 Int32
p11ds[].isPublished boolean Boolean
p11ds[].notificationDate date-time Nullable
p11ds[].taxYear int32 Int32
p11ds[].taxYearEnding int32 Int32
p11ds[].text string String
p45 object P45ViewModel
p45.employeeEndDate date-time Nullable
p45.notificationDate date-time Nullable
p45.p45Url string String
p60 object P60ViewModel
p60.employeeEndDate date-time Nullable
p60.financialYearEnding int32 Int32
p60.notificationDate date-time Nullable
p60.p60Url string String
p60s[] array
p60s[].dateGenerated date-time DateTime
p60s[].downloadUrl string String
p60s[].financialYearEnding int32 Int32
p60s[].id int32 Int32
p60s[].notificationDate date-time Nullable
p60s[].status string P60Status

Possible values are:

  • Generated
  • Published
  • Unpublished
p60s[].text string String
prevP45 object PrevP45ViewModel
prevP45.exists boolean Boolean
prevP45.p45Url string String
prevP45.uploadDate date-time Nullable
urls object P11dFormsUrls
urls.checkForInformallyPayrollingEnabledUrl string String
urls.downloadAll string String
urls.downloadFile string String
urls.downloadSubmission string String
urls.haveAllEmployeeP11dsBeenPublished string String
urls.haveEmployeeP11dsBeenSubmitted string String
urls.load string String
urls.notify string String
urls.notifyAll string String
urls.paymentUrl string String
urls.publish string String
urls.publishAll string String
urls.submit string String
urls.unpublish string String
urls.unpublishAll string String