swissfintechinnovations / ca-mortgage

Common API for Mortgages
Apache License 2.0
0 stars 1 forks source link

New Setup: Additional Properties #84

Closed simonbbaumgartner closed 1 year ago

simonbbaumgartner commented 1 year ago

The income and costs of other properties held by the applicant need to be considered in the affordability calculation. So, the FI needs to know the situation of additional properties.

In the object "financialSituation" we would like to have a new object "additionalProperties" as a list/array: description: Information about additional property required fields: valueAdditionalProperty, propertyTypeAdditionalProperty

In the new object "additionalProperties" are the following fields:

streetNameAdditionalProperty description: Street name of the additional property type: String, max. 70

valueAdditionalProperty description Value of the additional property type: see Amount

propertyTypeAdditionalProperty description: The type of the additional property type: string, enum: [single_family_house, condominium, vacation_house, vacation_condominium, agricultural_farm, 2or3_family_house, multi_family_house, residential_building_plot, building_plot_other, mixed_property, commercial_condominium, office_building, industrial_building, special_object]

simonbbaumgartner commented 1 year ago

should be done

simonbbaumgartner commented 1 year ago

2 reasons to list it separately (and not as an asset):

we use the street name as an identifier. It doesn't need to be a proper address. It may be a better way to just call it "nameAdditionalProperty". changed it in the yaml.