Body Required

• Owner

  Not set directly. Can be set as belonging to: the main client (ClientGUID from Household) ; the related client (RelatedClientGUID from Household); jointly owned by the main client and the related client. If IncomeType = 1 there should only be one owner.

  To set owned by the main client set ClientGUID as ClientGUID. To set owned by the related client set ClientGUID as RelatedClientGUID. To set as jointly owned set ClientGUID as ClientGUID, set JointOwnerClientGUID as RelatedClientGUID.

• ClientGUID string(uuid) Required

  ClientGUID must be in the household. See Owner for details on what to set.

• IncomeDescription string Required

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

  Maximum length is 50.

• IncomeType 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}/incomes/options

  IncomeType can not be changed if income has a contribution.

• TaxBasis integer | null

  This field is required if the value of IncomeType = 3 or the value of IncomeType = 6.

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

• IncomeAmount number(float) Required
• JointOwnerClientGUID string(uuid) | null

  JointOwnerClientGUID must be in the household. Should not be set when IncomeType = 1. See Owner for details on what to set.

• Frequency 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}/incomes/options

• BenefitInKindAmount number(float) | null
• 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}/incomes/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}/incomes/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

  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}/incomes/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}/incomes/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.

• 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}/incomes/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
• SumAssured number(float) | null

  This field is required if the value of IncomeType = 1 and the value of DeathInService = 1 and the value of DeathMultiple is empty.

  Minimum value is 1.

• DeathInService integer | null

  The value can not be negative.

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

• DeathMultiple number(float) | null

  This field is required if the value of IncomeType = 1 and the value of DeathInService = 1 and the value of SumAssured is empty or 0.

  Minimum value is 1, maximum value is 50.

• DeathPolicyType integer | null

  This field is required if the value of IncomeType = 1 and the value of DeathInService = 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}/incomes/options

• FutureLevelChange 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}/incomes/options

• FutureGrossAmount number(float) | null

  This field is required if the value of FutureLevelChange = 1.

• FutureDateOfChangeBasis integer

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

• FutureDateOfChangeEventGUID string(uuid) | null

  This field is required if the value of FutureLevelChange = 1 and FutureDateOfChangeBasis = 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}/incomes/options

• FutureDateOfChangeAge integer | null

  This field is required if the value of FutureLevelChange = 1 and FutureDateOfChangeBasis = 2 or 7. FutureDateOfChangeAge must be in the future

  Minimum value is 0, maximum value is 130.

• FutureDateOfChangeDate string | null

  This field is required if the value of FutureLevelChange = 1 and FutureDateOfChangeBasis = 3. FutureDateOfChangeDate 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.