Skip to main content
PATCH
/
gb
/
organizations
/
{organization_id}
/
pension
/
scheme
Update pension scheme
curl --request PATCH \
  --url https://preview.intermezzo.ai/gb/organizations/{organization_id}/pension/scheme \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "validFrom": "2023-12-25"
}
'
{
  "validFrom": "2023-12-25",
  "schemeName": "<string>",
  "provider": "NEST",
  "taxTreatment": "NET_PAY",
  "pensionableEarningsDefinition": "QUALIFYING_EARNINGS",
  "employeeRate": "<string>",
  "employerRate": "<string>",
  "employeeCap": "<string>",
  "employerCap": "<string>",
  "postponementPeriodMonths": 123,
  "entitledWorkerEmployerContributes": true,
  "reEnrolmentDate": "2023-12-25",
  "reEnrolmentWindowStart": "2023-12-25",
  "reEnrolmentWindowEnd": "2023-12-25",
  "validTo": "2023-12-25"
}

Authorizations

​
Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

​
organization_id
required

Body

application/json

Create a new version of the pension scheme configuration effective from valid_from.

​
validFrom
string<date>
required

Date from which the updated configuration takes effect

​
schemeName
string | null
​
provider
enum<string> | null
Available options:
NEST,
OTHER
​
taxTreatment
enum<string> | null
Available options:
NET_PAY,
RELIEF_AT_SOURCE,
SALARY_SACRIFICE
​
pensionableEarningsDefinition
enum<string> | null
Available options:
QUALIFYING_EARNINGS,
PENSIONABLE_PAY
​
employeeRate
Required range: 0.05 <= x <= 1
​
employerRate
Required range: 0.03 <= x <= 1
​
employeeCap
​
employerCap
​
postponementPeriodMonths
integer | null
Required range: 0 <= x <= 3
​
entitledWorkerEmployerContributes
boolean | null
​
reEnrolmentDate
string<date> | null
​
reEnrolmentWindowStart
string<date> | null
​
reEnrolmentWindowEnd
string<date> | null

Response

Successful Response

Organisation's pension scheme configuration.

​
validFrom
string<date>
required
​
schemeName
string
required
​
provider
enum<string>
required
Available options:
NEST,
OTHER
​
taxTreatment
enum<string>
required
Available options:
NET_PAY,
RELIEF_AT_SOURCE,
SALARY_SACRIFICE
​
pensionableEarningsDefinition
enum<string>
required
Available options:
QUALIFYING_EARNINGS,
PENSIONABLE_PAY
​
employeeRate
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
employerRate
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
employeeCap
string | null
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
employerCap
string | null
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
postponementPeriodMonths
integer
required
​
entitledWorkerEmployerContributes
boolean
required
​
reEnrolmentDate
string<date> | null
required
​
reEnrolmentWindowStart
string<date> | null
required
​
reEnrolmentWindowEnd
string<date> | null
required
​
validTo
string<date> | null