# Create liability **POST /api/v2/household/{HouseholdGUID}/liabilities** This endpoint allows users to create a new liability 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. ## Body parameters Content-type: application/json - **ClientGUID** (string(uuid)) ClientGUID must be in the household. - **LiabilityDescription** (string) The following characters are not permitted: \\:*"<>| - **LiabilityType** (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}/liabilities/options - **Value** (number(float)) - **ValueDate** (string(date)) 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) 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. - **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) 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. - **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. - **InterestRate** (number(float)) 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 - **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) - **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) - **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. ## Responses ### 201: Success #### Body Parameters: application/json (object) - **success** (boolean) - **data** (object) ### 403: Permission error. #### Body Parameters: application/json (object) - **success** (boolean) - **message** (string) ### 404: Household not found #### Body Parameters: application/json (object) - **success** (boolean) - **message** (string) ### 422: Validation error. #### Body Parameters: application/json (object) - **success** (boolean) - **message** (string) - **data** (object) Example validation error message. ### 500: Internal server error. #### Body Parameters: application/json (object) - **success** (boolean) - **message** (string) [Powered by Bump.sh](https://bump.sh)