# Update income **PUT /api/v2/household/{HouseholdGUID}/incomes/{IncomeGUID}** This endpoint allows users to update an income for a household. ## Servers - https://api.fincalc.co.uk: https://api.fincalc.co.uk () ## Authentication methods - Bearer auth ## Parameters ### Path parameters - **HouseholdGUID** (string(uuid)) The HouseholdGUID of the client. - **IncomeGUID** (string(uuid)) The IncomeGUID you want to update. ### Body: application/json (object) - **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)) ClientGUID must be in the household. See Owner for details on what to set. - **IncomeDescription** (string) The following characters are not permitted: \\:*"<>| - **IncomeType** (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 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)) - **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) 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) 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. - **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) 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. - **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. - **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. - **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) - **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. - **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. - **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 - **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. ## Responses ### 200 Success #### Body: application/json (object) - **success** (boolean) - **data** (object) ### 403 Permission error. #### Body: application/json (object) - **success** (boolean) - **message** (string) ### 404 Household not found #### Body: application/json (object) - **success** (boolean) - **message** (string) ### 422 Validation error. #### Body: application/json (object) - **success** (boolean) - **message** (string) - **data** (object) Example validation error message. ### 500 Internal server error. #### Body: application/json (object) - **success** (boolean) - **message** (string) [Powered by Bump.sh](https://bump.sh)