Contract.PensionNoticeDetailResponse

Full notice detail for the row-click popup.

Schema

Name / Description Type / Format Example
id string uuid "string"
noticeType string "OptOut" "StoppedContributions" "Refund"
issueDate string date "2026-08-26"
effectiveDate string date "2026-08-26"
appliedOn string date "2026-08-26"
pensionReference string "string"
groupName string "string"
status string "Stored" "Unmatched" "Applied" "Failed" "Applying"
employeeId string uuid "string"
employeeDisplayName string "string"
employeePayrollCode string "string"
isMatched boolean true
niNo string "string"
alternativeUniqueId string "string"
refundTotalAmount number double 0.0
refundEmployerAmount number double 0.0
refundEmployeeAmount number double 0.0
statusReason string "string"
instructionText string "string"
statusBannerText string "string"
statusBannerCssClass string "string"
canRetry boolean true
canMarkAsActioned boolean true
isDeferredPending boolean true
statusDisplayName string "string"

JSON Example 

{
  "id": "string",
  "noticeType": "OptOut",
  "issueDate": "2026-08-26",
  "effectiveDate": "2026-08-26",
  "appliedOn": "2026-08-26",
  "pensionReference": "string",
  "groupName": "string",
  "status": "Stored",
  "employeeId": "string",
  "employeeDisplayName": "string",
  "employeePayrollCode": "string",
  "isMatched": true,
  "niNo": "string",
  "alternativeUniqueId": "string",
  "refundTotalAmount": 0.0,
  "refundEmployerAmount": 0.0,
  "refundEmployeeAmount": 0.0,
  "statusReason": "string",
  "instructionText": "string",
  "statusBannerText": "string",
  "statusBannerCssClass": "string",
  "canRetry": true,
  "canMarkAsActioned": true,
  "isDeferredPending": true,
  "statusDisplayName": "string"
}

References

Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Get Pension Notice Detail (Beta)
Retry Pension Notice (Beta)
Mark Pension Notice as Actioned (Beta)