Body Required

• TransactionType integer Required

  If SavingsType is any of the following: 7, 8, 9, 10, 11, 12, 14, 17, 18, 19, or 21 then the allowed types are 2, 3, and 12. Otherwise, if SavingsType = 3 then the allowed types are 2, 11, and 12. Otherwise, if SavingsType = 6 then the allowed types are 2, 3, 11, and 12. Finally, if none of the above conditions are met then the allowed types are 2 and 12.

• LinkedSavingsGUID string(uuid) | null

  This field is required if the value of TransactionType = 11 or the value of TransactionType = 12. The value of LinkedSavingsGUID can not be the same as the SavingsGUID that this contribution is linked to.

  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/contributions/options

• TransactionAmount number(float) | null

  This field is required except where the value of TransactionType = 11 or the TransactionType = 3 and the value of TransactionPercentage is not = 0 or TransactionType = 13 and UseAvailableUnusedAllowance = 1. TransactionAmount must be greater than 0.

• UseAvailableUnusedAllowance 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}/savings/contributions/options

• TransactionPercentage number(float) | null

  This field is required where the value of TransactionType = 3 except where the value of TransactionAmount is not = 0. TransactionPercentage must be greater than 0.

• Frequency integer | null

  This field is required if TransactionType is not = 11.

  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/contributions/options

• StartBasis integer 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}/savings/contributions/options

• StartEventGUID string(uuid) | null

  This field is required if the value of StartBasis = 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}/savings/contributions/options

• StartAge integer | null

  This field is required if the value of StartBasis = 2 or 7.

  Minimum value is 0, maximum value is 130.

• StartDate string | null

  This field is required if the value of StartBasis = 3.

  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 Frequency is not = 120.

  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/contributions/options

• EndEventGUID string(uuid) | null

  This field is required if the value of EndBasis = 4 and the value of Frequency is not = 120 and the value of TransactionType is not = 8. Event end must be after starting.

  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/contributions/options

• EndAge integer | null

  This field is required if the value of EndBasis = 2 or 7 and the value of Frequency is not = 120 and the value of TransactionType is not = 8. EndAge must be after starting.

  Minimum value is 0, maximum value is 130.

• EndDate string | null

  This field is required if the value of EndBasis = 3 and the value of Frequency is not = 120 and the value of TransactionType is not = 8. EndDate must be after starting.

  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.

• 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