curl --request POST \
--url https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/pension/opt-out \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"optOutDate": "2023-12-25"
}
'{
"version": 123,
"enrolmentDate": "2023-12-25",
"optOutDate": "2023-12-25",
"enrolmentCommunicationDate": "2023-12-25",
"schemeId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>"
}Record employee opt-out
Records an employee’s decision to opt out of the pension scheme. The membership status is updated to OPTED_OUT and the opt-out date is stored. Contribution refunds (if within the statutory one-month opt-out window) are applied separately in the next payroll run and are not handled here. Returns 409 if the employee is not currently actively enrolled.
curl --request POST \
--url https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/pension/opt-out \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"optOutDate": "2023-12-25"
}
'{
"version": 123,
"enrolmentDate": "2023-12-25",
"optOutDate": "2023-12-25",
"enrolmentCommunicationDate": "2023-12-25",
"schemeId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.intermezzo.ai/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Get token from Auth0 and paste it here
Body
Request to record an employee's opt-out from the pension scheme.
Date on which the opt-out takes effect
Response
Successful Response
Current pension membership state for an employee.
Reflects the latest version of the membership history record.
ACTIVE, OPTED_OUT, NOT_ENROLLED ELIGIBLE_JOBHOLDER, NON_ELIGIBLE_JOBHOLDER, ENTITLED_WORKER, EXCLUDED AUTO_ENROLLED, OPTED_IN, JOINED Was this page helpful?