# Update pension **PUT /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}** This endpoint allows users to update a pension for a household. ## Servers - https://api.fincalc.co.uk: https://api.fincalc.co.uk () ## Authentication methods - Bearer auth ## Parameters #### Path parameters - **HouseholdGUID** (string(uuid)) The HouseholdGUID of the client. - **PensionGUID** (string(uuid)) The PensionGUID you want to update. ## Body parameters Content-type: application/json - **ClientGUID** (string(uuid)) ClientGUID must be in the household. - **PensionDescription** (string) Pension description can not be changed if the pension type is 9 (Defined Benefit Deferred Pension Transvas Linked). - **PensionType** (integer) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/options Pension type can not be changed if pension has a linked Income, Contribution or Withdrawal - **DependantGUID** (string(uuid) | null) Must be a dependant of one of the clients within the household. This field is only needed for pension type 3 but is not required. To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/options - **DCSpecialType** (integer) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/options This input is only required if PensionType == 3 (DC Contribution Fund). - **CurrentValue** (number(float)) - **CrystallisedFundValue** (number(float) | null) If input, needs to be equal to or lower than the CurrentValue. - **ValueDate** (string(date)) This field is required if any of the following conditions are met: - The value of PensionType = 2,3,4,5,6 or 7 (ValueDate must be before or equal to now). - The value of PensionType = 8 and The value of EndBasis = 1 (ValueDate must be before or equal to now). - If the value of PensionType = 1 (ValueDate must be before retirement age/date or equal to normal retirement age). - If the value of PensionType = 8 and the value of EndBasis is not = 1 (ValueDate must be before retirement age/date or equal to the next 6th April). Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023. - **EndBasis** (integer | null) This field is required if the value of PensionType is not = 3. The value of EndBasis: - must be 1 when the value of PensionType = 4, 5, or 7 - must be 2, 3, or 4 when the value of PensionType = 1, 2, or 3 - must be 1, 2, 3, or 4 when the value of PensionType = 8 To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/options - **EndEventGUID** (string(uuid) | null) This field is required if the value of EndBasis = 4 The value of EndEventGUID: - Cannot be before minimum pension age unless protected when the value of PensionType = 1 or 2. - Cannot be before State Pension Age when the value of PensionType = 8. To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/options - **EndAge** (integer | null) This field is required if the value of EndBasis = 2 or 7. The value of EndAge: - Cannot have a past retirement date with an annuity retirement choice when the value of PensionType = 3. - Must be in future when the value of PensionType = 3 or 8. - Cannot be before minimum pension age unless protected when the value of PensionType = 1, 2 or 3. - Must not be before State Pension Age when the value of PensionType = 8. - **EndDate** (string | null) This field is required if the value of EndBasis = 3. The value of EndDate: - Must be after now when the value of PensionType = 3 or 8. - Cannot be before minimum pension age unless protected when the value of PensionType = 1, 2 or 3. - Must not be before State Pension Age when the value of PensionType = 8. Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023. - **Frequency** (integer | null) This field is required if any of the following conditions are met: - The value of PensionType = 4, 5, 6 or 7. - The value of PensionType = 8 and the value of EndBasis = 1 To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/options - **TaxBasis** (integer | null) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/options - **ATRGUID** (string(uuid) | null) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/options - **NRA** (integer | null) This field is required if the value of PensionType = 1 or 2. - **LinkedIncomeGUID** (string(uuid) | null) The value of LinkedIncomeGUID: - Must be owned by the owner of the pension. - Cannot be edited if pension has a contribution. To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/options - **ProtectedAge** (integer | null) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/options - **ProtectedTFC** (integer | null) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/options - **ProtectedTFCADayValue** (number(float) | null) This field is required if the value of ProtectedTFC = 1. - **ProtectedTFCADayFundPension** (number(float) | null) This field is required if the value of ProtectedTFC = 1. - **SpousePension** (number(float) | null) - **GuaranteePeriodYears** (integer | null) - **GuaranteePeriodMonths** (integer | null) - **DBRetirementBasis** (integer | null) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/options - **AdditionalCash** (number(float) | null) - **DCRetirementBasis** (integer | null) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/options - **DBAccrualBasis** (integer | null) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/options - **BackOfficeID** (string | null) - **BackOfficeSync** (integer | null) An integer representing the status of the back office sync: - 1: Yes - 2: No - 3: Only update from back office - **CrystallisedPreviously** (number(float) | null) - **SumAssured** (number(float) | null) This field is required if the value of PensionType = 1 or 2 and the value of LumpSumDeathBenefitBasis = 2. - **LumpSumDeathBenefitBasis** (integer | null) This field is required if the value of PensionType = 1 or 2. To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/options - **DeathMultiple** (number(float) | null) This field is required if the value of PensionType = 1 or 2 and the value of LumpSumDeathBenefitBasis = 3. The value of DeathMultiple must be greater than or equal to 1 and less than or equal to 50. - **PolicyNumber** (string | null) - **ProviderCode** (string | null) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/options - **FutureRiskLevelChange** (integer | null) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/options - **FutureRiskATRGUID** (string(uuid) | null) This field is required if the value of PensionType = 3 and FutureRiskLevelChange = 1. To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/options - **FutureRiskDateOfChangeBasis** (integer) This field is required if the value of PensionType = 3 and FutureRiskLevelChange = 1. To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/options - **FutureRiskDateOfChangeEventGUID** (string(uuid) | null) This field is required if the value of PensionType = 3, FutureRiskLevelChange = 1 and FutureRiskDateOfChangeBasis = 4. To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/pensions/options - **FutureRiskDateOfChangeAge** (integer | null) This field is required if the value of PensionType = 3, FutureRiskLevelChange = 1 and FutureRiskDateOfChangeBasis = 2 or 7. FutureRiskDateOfChangeAge must be in the future - **FutureRiskDateOfChangeDate** (string | null) This field is required if the value of PensionType = 3, FutureRiskLevelChange = 1 and FutureRiskDateOfChangeBasis = 3. FutureRiskDateOfChangeDate must be in the future Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023. - **ExcludeFormattedValues** (string | null) If set to any value, formatted values will be excluded from the response. ## Responses ### 200: Success #### Body Parameters: application/json (object) - **success** (boolean) - **data** (object) ### 403: Permission error. #### Body Parameters: application/json (object) - **success** (boolean) - **message** (string) ### 404: Household not found #### Body Parameters: application/json (object) - **success** (boolean) - **message** (string) ### 422: Validation error. #### Body Parameters: application/json (object) - **success** (boolean) - **message** (string) - **data** (object) Example validation error message. ### 500: Internal server error. #### Body Parameters: application/json (object) - **success** (boolean) - **message** (string) [Powered by Bump.sh](https://bump.sh)