hasContractualEnrolment

Synopsis Whether an admin account uses contractual enrolment.
Where used

/accounts response

This mandatory field indicates whether an admin account receives contributions from employees who are enrolled in the scheme as a result of a contractual agreement with their employer.

Accounts with contractual enrolment are not currently supported by the Payroll Integration API. Your software should use this field to detect this kind of account and explain to the user that the account is not yet supported.

Our Understanding contractual enrolment guide for employers contains more details about this kind of admin account. The Pensions Regulator also provides detailed guidance.

Data type

Boolean

Example

...
"hasContractualEnrolment": false,
...

See also

api.isSupported

api.reason