Body Required

• ClientGUID string(uuid) Required

  ClientGUID must be in the household.

• SavingsDescription string Required

  The following characters are not permitted: \:*"<>|

  Maximum length is 100.

• SavingsType integer Required

  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) Required

  Value must not be less than 0 if SavingsType value is not 1.

• ValueDate string(date) Required

  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.

  • For households with two clients, client 1 corresponds to the "ClientGUID" in the household record.
  • Leave the field unset or blank if Client 1 has no ownership.

  Maximum value is 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.

  Maximum value is 100.

• BackOfficeID string | null

  Maximum length is 255.

• 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

  Maximum length is 50.

• 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

  Minimum value is 0, maximum value is 130.

• 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