Body Required

• ClientGUID string(uuid) Required

  ClientGUID must be in the household.

• LiabilityDescription string Required

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

  Maximum length is 50.

• LiabilityType 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}/liabilities/options

• Value number(float) Required
• ValueDate string(date) Required

  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

  JointOwnerClientGUID must be in the household.

• 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}/liabilities/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}/liabilities/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 Required

  This field is required if the LiabilityType != 5 or (LiabilityType = 5 with BackOffice Time4Advice Curo).

  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}/liabilities/options

• EndEventGUID string(uuid) | null

  This field is required if the value of EndBasis = 4. 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}/liabilities/options

• EndAge integer | null

  This field is required if the value of EndBasis = 2 or 7. EndAge end 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. EndDate end 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.

• 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.

  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.

• InterestRate number(float) Required

  This value must be a positive number.

• InterestRateChange 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}/liabilities/options

• InterestRateChangeBasis integer | null

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

• InterestRateChangeEventGUID string(uuid) | null

  This field is required if the value of InterestRateChangeBasis = 4 and the value of InterestRateChange = 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}/liabilities/options

• InterestRateChangeAge integer | null

  This field is required if the value of InterestRateChangeBasis = 2 or 7 and the value of InterestRateChange = 1. InterestRateChangeAge must be in the future

  Minimum value is 0, maximum value is 130.

• InterestRateChangeDate string | null

  This field is required if the value of InterestRateChangeBasis = 3 and the value of InterestRateChange = 1. InterestRateChangeDate 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.

• NewInterestRate number(float) | null

  This field is required if the value of InterestRateChange = 1. This value must be a positive number.

• ClearLiabilityAtEnd 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}/liabilities/options

• 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 100.

• ProviderCode 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}/liabilities/options

• LinkedAssetGUID 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}/liabilities/options

• ExcludeFormattedValues string | null

  If set to any value, formatted values will be excluded from the response.