Contract.PensionerPayroll

Schema

Name / Description Type / Format Example
inReceiptOfPension
If set to true then the FPS will have the OccPenInd flag set to 'yes'
 boolean true
bereaved
Indicator that Occupational Pension is being paid because they are a recently bereaved Spouse/Civil Partner
 boolean true
amount
Annual amount of occupational pension
 number double 0.0
startDate
Start date of occupational Pension
 string date "2024-11-21"

JSON Example 

{
  "inReceiptOfPension": true,
  "bereaved": true,
  "amount": 0.0,
  "startDate": "2024-11-21"
}

References

Contained in Models
Contract.StarterDetails
Consumed by Operations

- none -

Returned by Operations

- none -