# Update saving **PUT /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}** This endpoint allows users to update a saving 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. - **SavingsGUID** (string(uuid)) The SavingsGUID you want to update. ## Body parameters Content-type: application/json - **ClientGUID** (string(uuid)) ClientGUID must be in the household. - **SavingsDescription** (string) The following characters are not permitted: \\:*"<>| - **SavingsType** (integer) Savings type cannot be changed if saving has a contribution or withdrawal or is the default account. 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}/savings/options - **Value** (number(float)) Value must not be less than 0 if SavingsType value is not 1. - **ValueDate** (string(date)) Date must be before or equal to today. 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. - **JointOwnerClientGUID** (string(uuid) | null) The following SavingsType can not have a joint owner: 3, 4, 6, 10, 14, 18, 19 and 21. JointOwnerClientGUID must be in the household. - **MinimumBalance** (number(float) | null) Value must not be less than 0. - **DependantGUID** (string(uuid) | null) Must be a dependant of one of the clients within the household. 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}/savings/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}/savings/options - **OriginalInvestmentValue** (number(float) | null) - **OriginalInvestmentDate** (string(date) | null) 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. - **OriginalInvestmentPercentageWithdrawn** (number(float) | null) - **UseAnnualExemptAmount** (integer) - **Client1PercentageOwned** (number(float) | null) Percentage of ownership attributed to client 1. - Client 1 corresponds to the “ClientGUID” in the household record. - This is not a required field (and NULL is accepted) unless Client2PercentageOwned is greater than 0. - When set, the value must be greater than 0 and not exceed 100. Values can include 2 decimal places. - The total of Client1PercentageOwned + Client2PercentageOwned cannot exceed 100. - **Client2PercentageOwned** (number(float) | null) Percentage of ownership attributed to client 2. This is only applicable for joint households. - Client 2 corresponds to the “RelatedClientGUID” in the household record. - This is not a required field (and NULL is accepted) unless Client1PercentageOwned is greater than 0. - When set, the value must be greater than 0 and not exceed 100. Values can include 2 decimal places. - The total of Client2PercentageOwned + Client1PercentageOwned cannot exceed 100. - This field should not be set for single-client households. - **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 - **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}/savings/options - **ISASpecialType** (integer | null) Only relevant in the cashflow when the savings type is 3 or 6. - **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 SavingsType > 5 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}/savings/options - **FutureRiskDateOfChangeBasis** (integer) This field is required if the value of SavingsType > 5 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 SavingsType > 5, 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 SavingsType > 5, FutureRiskLevelChange = 1 and FutureRiskDateOfChangeBasis = 2 or 7. FutureRiskDateOfChangeAge must be in the future - **FutureRiskDateOfChangeDate** (string | null) This field is required if the value of SavingsType > 5, 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. - **NeverTouch** (integer | null) NeverTouch cannot be changed if saving is the default account. 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}/savings/options ## 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)