Body Required

• TransactionType 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/repayments/options

• TransactionAmount number(float) | null

  This field is required if TransactionType = not 8.

• InterestPayment 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/repayments/options

• Frequency integer | null

  This field is required if TransactionType = not 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}/liabilities/repayments/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}/liabilities/repayments/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/repayments/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 = not 120 and the value of TransactionType = not 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}/liabilities/repayments/options

• EndEventGUID string(uuid) | null

  This field is required if the value of EndBasis = 4 and the value of Frequency = not 120 and the value of TransactionType = 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}/liabilities/repayments/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
• ExcludeFormattedValues string | null

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

• CalculatedRepayment integer | null

  This is an optional field. When provided, it must be set to 1. Once set, it overrides all other existing validation rules. Only one calculated repayment can exist for the corresponding liability. Additionally, when set, the transaction type will be automatically updated to 4. If the field is not provided, other validations will be applied as usual.