Explanatory Appendix API (v1)

Download OpenAPI specification:

Introduction

Explanatory Appendix API allows an agent to provide content for explanatory appendix. Explanatory appendix can be for following types of realties:

Residential share
Other share
Residential property
Estate property
Other property (includes also plot property)
Commercial property

Contact

If you have any questions, comments or feedback regarding our APIs, please contact developer@ovipro.fi.

Explanatory Appendix

Explanatory Appendix API allows you to create and manage explanatory appendixes. An explanatory appendix is specific to a single realty within an assignment.

Get an explanatory appendix

Gets the explanatory appendix data for given realty within an assignment.

Authorizations:

bearerAuth

path Parameters

assignmentId required	string <uuid> Example: 123e4567-e89b-12d3-a456-426614174000 The id of the assignment.
realtyId required	string <uuid> Example: 123e4567-e89b-12d3-a456-426614174001 The id of the realty.

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type

application/json

Example

GetResidentialShare

{"assignmentId": "9238cf7b-b86a-49a5-b54f-cbdfcd03e9c9",
"realtyId": "9fd9124c-e6c1-4368-9f17-6938f0e2f524",
"categoryCode": "SALE",
"statusCode": "DRAFT",
"documentId": "123e4567-e89b-12d3-a456-426614174000",
"creationTime": "2022-12-31T13:00:00Z",
"modificationTime": "2022-12-31T13:00:00Z",
"realtyTypeCode": "RESIDENTIAL_SHARE",
"content": {"subcategoryCode": "SHARE",
"propertyTypeCode": "LEISURE",
"realty": {"newBuilding": "YES",
"costs": [{"amount": 20,
"currencyCode": "EUR",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"typeCode": "WATER",
"waterChargeTypeCode": "BY_USE",
"chargePeriodCode": "MONTH_PER_PERSON",
"typeOtherDescription": "string"
}
],
"costsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"monthlyRent": 439,
"rentPayment": {"rentAmount": 439,
"rentPaymentPeriodCode": "MONTH"
},
"startingPriceAmount": 190000,
"sellingPrice": 250100,
"currencyCode": "EUR",
"availability": {"code": "AVAILABLE",
"date": "2022-12-31",
"monthsAfterTransaction": 2,
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"tenantName": "John",
"tenantContactDetails": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"rentPayment": {"rentAmount": 439,
"rentPaymentPeriodCode": "MONTH"
}
},
"rentChange": {"date": "2022-12-31",
"rentAmount": 439,
"rentPaymentPeriodCode": "MONTH"
},
"basisForPossession": {"typeCode": "TENANCY",
"tenancyDescription": "Rented on fixed term"
},
"isRented": "YES",
"roommateCount": 2,
"address": {"streetAddress": "Yliopistonkatu 55",
"stairwell": "C",
"apartmentNumber": "55",
"district": "Hervanta",
"districtCode": "FI_PIRKANMAA_TAMPERE_HERVANTA",
"region": "Pirkanmaa",
"regionCode": "FI_PIRKANMAA",
"postcode": "33100",
"postalArea": "Tampere",
"locality": "Tampere",
"localityCode": "FI_PIRKANMAA_TAMPERE",
"country": "Suomi",
"countryCode": "FI",
"location": {"latitude": 61.48662,
"longitude": 23.24047,
"coordinateAccuracy": "STREET",
"coordinateSource": "GEO_CODING"
},
"showMapOnAnnouncement": "YES"
},
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"title": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"transactionDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"transactionDoesNotInclude": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"transactionIncludes": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"condition": {"code": "GOOD",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"additionalAreaMeasurementInformation": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"additionalInformation": {"activitiesAndRecreationDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"additionalDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"additionalRealtyDetailLinks": [{"title": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"url": "http://example.com",
"typeCode": "VIDEO_PRESENTATION"
}
],
"drivingInstructions": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"nearbyAmenitiesDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"transportationServicesDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"damages": [{"damageExistsCode": "YES",
"damageTypeCode": "WATER_DAMAGE",
"damageDate": "2022-01-15",
"causeDescription": "Vesivahinko katossa",
"extentDescription": "Olohuoneen nurkan katto",
"repairDescription": "Kuivatus ja sisäkaton maalaus",
"attachmentId": "63df9455-3d05-40d4-aeb4-9f5a4ee7f720",
"hasAttachment": true
}
],
"livingComfortFactors": [{"livingComfortFactorCode": "NOISE_SMELL_VIBRATION_ETC",
"description": "Heikko television antennisignaali"
}
],
"keyManagement": {"keysToBeOrderedFromHousingManager": "YES",
"keysHandedOverByHousingCompany": "YES",
"numberOfKeysHandedOverByHousingCompany": 2,
"keycardAvailable": "YES",
"description": "Avainkortti luovutetaan siirron yhteydessä ostajalle",
"keys": [{"keyUsageCode": "SAFETY_LOCK",
"keyTypeCode": "MECHANICAL_KEY",
"description": "Emännän avain",
"keyCount": 1
}
]
},
"leaseDetails": {"paymentDate": "First day of every month",
"depositDescription": "2kk vuokra",
"depositAmount": 0,
"currencyCode": "EUR",
"leaseTypeCode": "FIXED_TERM",
"fixedLeaseStartDate": "2022-03-15",
"fixedLeaseEndDate": "2024-03-15",
"leaseStartDate": "2022-03-15",
"leaseContractDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"noticePeriodStartDate": "2022-03-15",
"noticePeriodCanBegin": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"penaltyForEarlyTermination": "1kk vuokra + 1000 euro",
"basisForRentIncrease": {"typeCode": "PERCENT",
"indexDescription": "Rent is increased by 2%",
"increasePercent": 2,
"otherDescription": "Rent is increased annually",
"rentReviewDate": "Once a year in January"
}
},
"livingFormTypeCode": "NONSUBSIDISED",
"sharedLivingTypeCode": "MALE_TENANTS",
"attachmentsDescription": "string",
"planningToSell": "YES",
"tenantResponsibleFor": ["FLOOR_DRAINS"
]
},
"residentialShare": {"residentialTypeCode": "APARTMENT_HOUSE",
"ownershipTypeCode": "OWN",
"administration": {"typeCode": "APARTMENT_HOUSING_COMPANY",
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"apartment": {"officialRoomStructure": "2H + K",
"roomCountCode": "3H",
"area": {"areaBasisCodes": ["ARTICLES_OF_ASSOCIATION"
],
"livingArea": {"value": 2.3,
"areaUnitCode": "M2"
},
"otherSpaceArea": {"value": 2.3,
"areaUnitCode": "M2"
},
"totalArea": {"value": 2.3,
"areaUnitCode": "M2"
},
"livingAreaNotKnown": true,
"otherSpaceAreaNotKnown": true,
"totalAreaNotKnown": true
},
"floors": {"floorLevel": 2,
"floorLevelCode": "ON_MIDDLE_FLOOR",
"livingFloorCount": 2,
"livingFloorCountCode": "TWO_FLOORS",
"totalFloorCount": 5
},
"asbestosMapping": {"isAsbestosMappingDone": "YES",
"isAsbestosMappingReportAvailable": "YES",
"constructionMaterialsMightHaveAsbestos": "YES",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"hearth": {"typeCodes": ["FIREPLACE"
],
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"hasBalcony": "YES",
"balcony": {"typeCodes": ["FRENCH_WINDOW"
],
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"compassPoints": ["NORTH"
],
"balconyGlassMaintenanceResponsibilityCode": "HOUSING_COMPANY"
},
"hasTerrace": "YES",
"terrace": {"isGlazedTerrace": "YES",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"compassPoints": ["NORTH"
],
"terraceGlassMaintenanceResponsibilityCode": "HOUSING_COMPANY"
},
"yard": {"hasPrivateYard": "YES",
"basisForPossessionCode": "ARTICLES_OF_ASSOCIATION",
"basisForPossessionOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"rooms": [{"typeCode": "KITCHEN",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"features": [{"featureCode": "INDUCTION_STOVE",
"description": [{"languageCode": null,
"text": null
}
]
}
],
"floorMaterialCodes": ["PARQUET"
],
"wallMaterialCodes": ["WALLPAPER"
],
"ceilingMaterialCodes": ["PANEL"
],
"floorMaterialDescription": "string",
"wallMaterialDescription": "string"
}
],
"numberOfToilets": 2,
"numberOfBedrooms": 3,
"boilerRoomDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"livingQuartersDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"interiorMaterialDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"isFitForWinterHabitation": "YES",
"hasOwnSauna": "YES",
"heatingDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"inspections": [{"date": "05/2025",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"typeCode": "CONDITION_INSPECTION"
}
],
"inspectionsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"modificationDocuments": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"patioDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"refrigeratedCellarDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"renovations": [{"date": "05/2025",
"decidedByGeneralMeeting": "YES",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"isHousingCompanyNotified": "YES",
"statusCode": "FINISHED",
"typeCode": "string",
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
],
"renovationsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"shareholderInstallationDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"storageDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"underfloorHeatingDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"utilityServicesRoomDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"thingsEffectingHousingComfort": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"viewDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"smokingAllowed": "YES",
"petsAllowed": "YES",
"suitableForDisabled": "YES",
"furnished": "YES",
"inspectionsDone": "YES"
},
"debtFreePrice": 360000,
"debtShareAmount": 2000.45,
"debtShareDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"debtShareCheckDate": "2022-12-31",
"isDebtSharePayable": "YES",
"currencyCode": "EUR",
"startingDebtFreePrice": 2000.45,
"storages": [{"typeCode": "CELLAR",
"basisForPossessionCodes": ["BELONGS_TO_APARTMENT_ACCORDING_TO_THE_ARTICLES_OF_ASSOCIATION"
],
"transferCode": "NON_TRANSFERABLE",
"basisForAllocationDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
],
"limitsOfStorageUsage": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"parkingSpaces": [{"typeCode": "SPACE_IN_PARKING_HALL",
"basisForPossessionCodes": ["BELONGS_TO_APARTMENT_ACCORDING_TO_THE_ARTICLES_OF_ASSOCIATION"
],
"transferCode": "NON_TRANSFERABLE",
"basisForAllocationDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
],
"parkingSpaceDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"shareCertificate": {"shareCertificateAvailable": "YES",
"mortgageDeclaredSeparately": "YES",
"shareCertificateUsedAsMortgage": "YES",
"mortgageHolder": "Pantin haltija ja yhteystiedot\n(tämä täytetään, jos osakekirja on pantattu).\n",
"liabilityAmount": 25000,
"currencyCode": "EUR",
"shareCertificateLocation": "osakekirjan säilytyspaikka",
"shareGroupIdentifiers": ["1-300"
],
"quantityOfShares": 300,
"shareCertificateFormCode": "DIGITAL",
"permanentDwellingIdentifier": "223456789A"
},
"redemption": {"redeemableByHousingCompany": "YES",
"redeemableByExistingShareholders": "YES",
"redemptionRightAppliesToAllShares": "YES",
"otherRestrictions": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
},
"housingCompany": {"businessIdentification": {"businessId": "FI02472382",
"schemeId": "VAT"
},
"name": "As Oy Tammentie",
"address": {"streetAddress": "Yliopistonkatu 55",
"stairwell": "C",
"apartmentNumber": "55",
"district": "Hervanta",
"districtCode": "FI_PIRKANMAA_TAMPERE_HERVANTA",
"region": "Pirkanmaa",
"regionCode": "FI_PIRKANMAA",
"postcode": "33100",
"postalArea": "Tampere",
"locality": "Tampere",
"localityCode": "FI_PIRKANMAA_TAMPERE",
"country": "Suomi",
"countryCode": "FI",
"location": {"latitude": 61.48662,
"longitude": 23.24047,
"coordinateAccuracy": "STREET",
"coordinateSource": "GEO_CODING"
},
"showMapOnAnnouncement": "YES"
},
"managerContactDetails": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"maintenance": {"typeCodes": ["PROPERTY_MAINTENANCE_COMPANY"
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"propertyIdentifier": "092-416-11-123",
"construction": {"builder": "YIT Suomi Oy",
"constructionYear": 2010,
"developmentPhaseCode": "IN_CONSTRUCTION",
"usageStartYear": 2011,
"constructionAndUsageYearDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"buildings": {"constructionMaterial": {"typeCode": "WOOD",
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"heating": {"systemCodes": ["DISTRICT_HEATING"
],
"systemOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"distributionSystemCodes": ["WATER_UNDERFLOOR_HEATING"
],
"distributionSystemOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"ventilation": {"systemCodes": ["GRAVITY_BASED"
],
"systemsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"outerRoof": {"typeCode": "FLAT",
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"materialCode": "SHEET_METAL",
"otherMaterialDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"hasElevator": "YES",
"elevatorTakesToApartment": "YES",
"hasSauna": "YES",
"premises": {"typeCodes": ["CELLAR_STORAGE"
],
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
},
"yardDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"plot": {"plotPropertyTypeCode": "HOLIDAY_PLOT",
"holdingTypeCode": "OWN",
"holdingTypeDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"landlord": "City of Tampere",
"yearlyRent": 1200,
"yearlyRentNotKnown": true,
"currencyCode": "EUR",
"isRedeemable": "YES",
"redemptionPortion": 10000,
"optionalRentalPlot": "YES",
"optionalRentalPlotDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"leaseEndDate": "05/2025",
"leaseEndDateNotKnown": true,
"leasePeriodDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"leaseAgreementDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"leaseAgreementUrl": "https://www.example.com/lease-agreement",
"plotNumber": "10634/1",
"identificationNumberOfLandCharge": "999-8-77-6-L1",
"leaseHolder": "Lisa Leaseholder",
"leaseHoldTransferLimitation": "YES",
"leaseHoldTransferLimitationDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"legalConfirmationOfTitleToRealProperty": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"area": {"value": 2.3,
"areaUnitCode": "M2"
},
"areaNotKnown": true,
"zoning": {"typeCodes": ["CITY_PLAN"
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"beach": {"code": "OWN_BEACH",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"typeCode": "LAKE",
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"waterBodyName": "Lake Laihia",
"shorelineLength": {"lengthInMeters": 100,
"lengthNotKnown": false
}
},
"constructionRight": {"densityRate": 0.2,
"floorArea": {"value": 2.3,
"areaUnitCode": "M2"
},
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"unbuiltPlot": true
},
"internetConnections": {"broadbandAvailable": "YES",
"fiberOpticInternet": "YES",
"housingCompanyBroadband": "YES",
"broadbandOperator": "string",
"internalNetworkCabling": "YES",
"networkDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"television": {"typeCodes": ["CABLE"
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"lastAnnualGeneralMeetingDate": "2022-12-31",
"nextAnnualGeneralMeetingDate": "2022-12-31",
"identifiedDeficiencies": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"costIncurringLiabilities": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"repairsAndMaintenanceAgreements": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"houseManagerCertificateDate": "2022-12-31",
"finances": {"loanAmount": 250000,
"mortgageAmount": 10000,
"rentRevenue": 2000,
"bankAccountCreditLimit": 100000,
"currencyCode": "EUR"
},
"exteriorDoors": {"typeCode": "LOCKED",
"openingHours": "9-17",
"doorCode": "1234"
},
"energyCertificate": {"typeCode": "A_2018",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"asbestosMapping": {"isAsbestosMappingDone": "YES",
"isAsbestosMappingReportAvailable": "YES",
"constructionMaterialsMightHaveAsbestos": "YES",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"parkingSpaces": [{"parkingSpaceTypeCode": "PARKING_SPACE_SHARE",
"count": 1
}
],
"parkingSpaceDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"housingCompanyPremiseStatistics": [{"premiseTypeCode": "APARTMENT",
"count": 1,
"area": {"value": 2.3,
"areaUnitCode": "M2"
},
"managedByHousingCompanyCount": 2,
"areaManagedByHousingCompany": {"value": 2.3,
"areaUnitCode": "M2"
}
}
],
"housingCompanyPremiseStatisticsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"renovations": [{"date": "05/2025",
"decidedByGeneralMeeting": "YES",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"isHousingCompanyNotified": "YES",
"statusCode": "FINISHED",
"typeCode": "string",
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
],
"renovationsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"renovationsPlannedDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"inspections": [{"date": "05/2025",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"typeCode": "LONG_TERM_PLAN"
}
],
"inspectionsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"additionalDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"listOfSharesTransferred": "YES",
"digitalShareGroupIdentifiers": ["KRD7AR4QP2NRHP97"
],
"inspectionsDone": "YES"
},
"housingCompanyCharges": {"managementCharge": 200.34,
"managementChargeNotKnown": true,
"financingCharge": {"amount": 250,
"amountNotKnown": true,
"includesOnlyInterest": "YES",
"amountDuringRepaymentFreePeriod": 20,
"repaymentFreePeriodStartDate": "2022-12-31",
"repaymentFreePeriodEndDate": "2022-12-31"
},
"plot": {"rentCharge": 300,
"rentChargeNotKnown": true,
"isPlotRedeemable": "YES",
"isPlotRedeemed": "YES",
"redemptionShare": 10000.35,
"redemptionDetailsUrl": "https://www.example.com/redemption-details"
},
"specialCharge": 100,
"specialChargeNotKnown": true,
"maintenanceCharge": 200.15,
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"detailsUrl": "https://www.asoy.fi/charges",
"currencyCode": "EUR"
},
"schemaVersion": "1"
}
}

Create an explanatory appendix

Creates a new explanatory appendix for given realty within an assignment.

Authorizations:

bearerAuth

path Parameters

assignmentId required	string <uuid> Example: 123e4567-e89b-12d3-a456-426614174000 The id of the assignment.
realtyId required	string <uuid> Example: 123e4567-e89b-12d3-a456-426614174001 The id of the realty.

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json
required

Contains the explanatory appendix data.

realtyTypeCode required	string (ResidentialShareRealtyTypeCode) Determines the type of the realty and the data schema. RESIDENTIAL_SHARE
categoryCode required	string (RealtyCategoryCode) Enum: "SALE" "RENTAL" Describes if the assignment and realty are for sale or rental.
required	object (ResidentialShareContent)

Responses

Request samples

Payload

Content type

application/json

Example

RESIDENTIAL_SHARE

{"realtyTypeCode": "RESIDENTIAL_SHARE",
"categoryCode": "SALE",
"content": {"subcategoryCode": "SHARE",
"propertyTypeCode": "LEISURE",
"realty": {"newBuilding": "YES",
"costs": [{"amount": 20,
"currencyCode": "EUR",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"typeCode": "WATER",
"waterChargeTypeCode": "BY_USE",
"chargePeriodCode": "MONTH_PER_PERSON",
"typeOtherDescription": "string"
}
],
"costsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"monthlyRent": 439,
"rentPayment": {"rentAmount": 439,
"rentPaymentPeriodCode": "MONTH"
},
"startingPriceAmount": 190000,
"sellingPrice": 250100,
"currencyCode": "EUR",
"availability": {"code": "AVAILABLE",
"date": "2022-12-31",
"monthsAfterTransaction": 2,
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"tenantName": "John",
"tenantContactDetails": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"rentPayment": {"rentAmount": 439,
"rentPaymentPeriodCode": "MONTH"
}
},
"rentChange": {"date": "2022-12-31",
"rentAmount": 439,
"rentPaymentPeriodCode": "MONTH"
},
"basisForPossession": {"typeCode": "TENANCY",
"tenancyDescription": "Rented on fixed term"
},
"isRented": "YES",
"roommateCount": 2,
"address": {"streetAddress": "Yliopistonkatu 55",
"stairwell": "C",
"apartmentNumber": "55",
"district": "Hervanta",
"districtCode": "FI_PIRKANMAA_TAMPERE_HERVANTA",
"region": "Pirkanmaa",
"regionCode": "FI_PIRKANMAA",
"postcode": "33100",
"postalArea": "Tampere",
"locality": "Tampere",
"localityCode": "FI_PIRKANMAA_TAMPERE",
"country": "Suomi",
"countryCode": "FI",
"location": {"latitude": 61.48662,
"longitude": 23.24047,
"coordinateAccuracy": "STREET",
"coordinateSource": "GEO_CODING"
},
"showMapOnAnnouncement": "YES"
},
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"title": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"transactionDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"transactionDoesNotInclude": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"transactionIncludes": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"condition": {"code": "GOOD",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"additionalAreaMeasurementInformation": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"additionalInformation": {"activitiesAndRecreationDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"additionalDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"additionalRealtyDetailLinks": [{"title": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"url": "http://example.com",
"typeCode": "VIDEO_PRESENTATION"
}
],
"drivingInstructions": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"nearbyAmenitiesDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"transportationServicesDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"damages": [{"damageExistsCode": "YES",
"damageTypeCode": "WATER_DAMAGE",
"damageDate": "2022-01-15",
"causeDescription": "Vesivahinko katossa",
"extentDescription": "Olohuoneen nurkan katto",
"repairDescription": "Kuivatus ja sisäkaton maalaus",
"attachmentId": "63df9455-3d05-40d4-aeb4-9f5a4ee7f720",
"hasAttachment": true
}
],
"livingComfortFactors": [{"livingComfortFactorCode": "NOISE_SMELL_VIBRATION_ETC",
"description": "Heikko television antennisignaali"
}
],
"keyManagement": {"keysToBeOrderedFromHousingManager": "YES",
"keysHandedOverByHousingCompany": "YES",
"numberOfKeysHandedOverByHousingCompany": 2,
"keycardAvailable": "YES",
"description": "Avainkortti luovutetaan siirron yhteydessä ostajalle",
"keys": [{"keyUsageCode": "SAFETY_LOCK",
"keyTypeCode": "MECHANICAL_KEY",
"description": "Emännän avain",
"keyCount": 1
}
]
},
"leaseDetails": {"paymentDate": "First day of every month",
"depositDescription": "2kk vuokra",
"depositAmount": 0,
"currencyCode": "EUR",
"leaseTypeCode": "FIXED_TERM",
"fixedLeaseStartDate": "2022-03-15",
"fixedLeaseEndDate": "2024-03-15",
"leaseStartDate": "2022-03-15",
"leaseContractDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"noticePeriodStartDate": "2022-03-15",
"noticePeriodCanBegin": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"penaltyForEarlyTermination": "1kk vuokra + 1000 euro",
"basisForRentIncrease": {"typeCode": "PERCENT",
"indexDescription": "Rent is increased by 2%",
"increasePercent": 2,
"otherDescription": "Rent is increased annually",
"rentReviewDate": "Once a year in January"
}
},
"livingFormTypeCode": "NONSUBSIDISED",
"sharedLivingTypeCode": "MALE_TENANTS",
"attachmentsDescription": "string",
"planningToSell": "YES",
"tenantResponsibleFor": ["FLOOR_DRAINS"
]
},
"residentialShare": {"residentialTypeCode": "APARTMENT_HOUSE",
"ownershipTypeCode": "OWN",
"administration": {"typeCode": "APARTMENT_HOUSING_COMPANY",
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"apartment": {"officialRoomStructure": "2H + K",
"roomCountCode": "3H",
"area": {"areaBasisCodes": ["ARTICLES_OF_ASSOCIATION"
],
"livingArea": {"value": 2.3,
"areaUnitCode": "M2"
},
"otherSpaceArea": {"value": 2.3,
"areaUnitCode": "M2"
},
"totalArea": {"value": 2.3,
"areaUnitCode": "M2"
},
"livingAreaNotKnown": true,
"otherSpaceAreaNotKnown": true,
"totalAreaNotKnown": true
},
"floors": {"floorLevel": 2,
"floorLevelCode": "ON_MIDDLE_FLOOR",
"livingFloorCount": 2,
"livingFloorCountCode": "TWO_FLOORS",
"totalFloorCount": 5
},
"asbestosMapping": {"isAsbestosMappingDone": "YES",
"isAsbestosMappingReportAvailable": "YES",
"constructionMaterialsMightHaveAsbestos": "YES",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"hearth": {"typeCodes": ["FIREPLACE"
],
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"hasBalcony": "YES",
"balcony": {"typeCodes": ["FRENCH_WINDOW"
],
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"compassPoints": ["NORTH"
],
"balconyGlassMaintenanceResponsibilityCode": "HOUSING_COMPANY"
},
"hasTerrace": "YES",
"terrace": {"isGlazedTerrace": "YES",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"compassPoints": ["NORTH"
],
"terraceGlassMaintenanceResponsibilityCode": "HOUSING_COMPANY"
},
"yard": {"hasPrivateYard": "YES",
"basisForPossessionCode": "ARTICLES_OF_ASSOCIATION",
"basisForPossessionOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"rooms": [{"typeCode": "KITCHEN",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"features": [{"featureCode": "INDUCTION_STOVE",
"description": [{"languageCode": null,
"text": null
}
]
}
],
"floorMaterialCodes": ["PARQUET"
],
"wallMaterialCodes": ["WALLPAPER"
],
"ceilingMaterialCodes": ["PANEL"
],
"floorMaterialDescription": "string",
"wallMaterialDescription": "string"
}
],
"numberOfToilets": 2,
"numberOfBedrooms": 3,
"boilerRoomDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"livingQuartersDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"interiorMaterialDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"isFitForWinterHabitation": "YES",
"hasOwnSauna": "YES",
"heatingDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"inspections": [{"date": "05/2025",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"typeCode": "CONDITION_INSPECTION"
}
],
"inspectionsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"modificationDocuments": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"patioDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"refrigeratedCellarDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"renovations": [{"date": "05/2025",
"decidedByGeneralMeeting": "YES",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"isHousingCompanyNotified": "YES",
"statusCode": "FINISHED",
"typeCode": "string",
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
],
"renovationsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"shareholderInstallationDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"storageDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"underfloorHeatingDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"utilityServicesRoomDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"thingsEffectingHousingComfort": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"viewDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"smokingAllowed": "YES",
"petsAllowed": "YES",
"suitableForDisabled": "YES",
"furnished": "YES",
"inspectionsDone": "YES"
},
"debtFreePrice": 360000,
"debtShareAmount": 2000.45,
"debtShareDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"debtShareCheckDate": "2022-12-31",
"isDebtSharePayable": "YES",
"currencyCode": "EUR",
"startingDebtFreePrice": 2000.45,
"storages": [{"typeCode": "CELLAR",
"basisForPossessionCodes": ["BELONGS_TO_APARTMENT_ACCORDING_TO_THE_ARTICLES_OF_ASSOCIATION"
],
"transferCode": "NON_TRANSFERABLE",
"basisForAllocationDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
],
"limitsOfStorageUsage": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"parkingSpaces": [{"typeCode": "SPACE_IN_PARKING_HALL",
"basisForPossessionCodes": ["BELONGS_TO_APARTMENT_ACCORDING_TO_THE_ARTICLES_OF_ASSOCIATION"
],
"transferCode": "NON_TRANSFERABLE",
"basisForAllocationDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
],
"parkingSpaceDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"shareCertificate": {"shareCertificateAvailable": "YES",
"mortgageDeclaredSeparately": "YES",
"shareCertificateUsedAsMortgage": "YES",
"mortgageHolder": "Pantin haltija ja yhteystiedot\n(tämä täytetään, jos osakekirja on pantattu).\n",
"liabilityAmount": 25000,
"currencyCode": "EUR",
"shareCertificateLocation": "osakekirjan säilytyspaikka",
"shareGroupIdentifiers": ["1-300"
],
"quantityOfShares": 300,
"shareCertificateFormCode": "DIGITAL",
"permanentDwellingIdentifier": "223456789A"
},
"redemption": {"redeemableByHousingCompany": "YES",
"redeemableByExistingShareholders": "YES",
"redemptionRightAppliesToAllShares": "YES",
"otherRestrictions": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
},
"housingCompany": {"businessIdentification": {"businessId": "FI02472382",
"schemeId": "VAT"
},
"name": "As Oy Tammentie",
"address": {"streetAddress": "Yliopistonkatu 55",
"stairwell": "C",
"apartmentNumber": "55",
"district": "Hervanta",
"districtCode": "FI_PIRKANMAA_TAMPERE_HERVANTA",
"region": "Pirkanmaa",
"regionCode": "FI_PIRKANMAA",
"postcode": "33100",
"postalArea": "Tampere",
"locality": "Tampere",
"localityCode": "FI_PIRKANMAA_TAMPERE",
"country": "Suomi",
"countryCode": "FI",
"location": {"latitude": 61.48662,
"longitude": 23.24047,
"coordinateAccuracy": "STREET",
"coordinateSource": "GEO_CODING"
},
"showMapOnAnnouncement": "YES"
},
"managerContactDetails": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"maintenance": {"typeCodes": ["PROPERTY_MAINTENANCE_COMPANY"
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"propertyIdentifier": "092-416-11-123",
"construction": {"builder": "YIT Suomi Oy",
"constructionYear": 2010,
"developmentPhaseCode": "IN_CONSTRUCTION",
"usageStartYear": 2011,
"constructionAndUsageYearDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"buildings": {"constructionMaterial": {"typeCode": "WOOD",
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"heating": {"systemCodes": ["DISTRICT_HEATING"
],
"systemOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"distributionSystemCodes": ["WATER_UNDERFLOOR_HEATING"
],
"distributionSystemOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"ventilation": {"systemCodes": ["GRAVITY_BASED"
],
"systemsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"outerRoof": {"typeCode": "FLAT",
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"materialCode": "SHEET_METAL",
"otherMaterialDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"hasElevator": "YES",
"elevatorTakesToApartment": "YES",
"hasSauna": "YES",
"premises": {"typeCodes": ["CELLAR_STORAGE"
],
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
},
"yardDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"plot": {"plotPropertyTypeCode": "HOLIDAY_PLOT",
"holdingTypeCode": "OWN",
"holdingTypeDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"landlord": "City of Tampere",
"yearlyRent": 1200,
"yearlyRentNotKnown": true,
"currencyCode": "EUR",
"isRedeemable": "YES",
"redemptionPortion": 10000,
"optionalRentalPlot": "YES",
"optionalRentalPlotDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"leaseEndDate": "05/2025",
"leaseEndDateNotKnown": true,
"leasePeriodDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"leaseAgreementDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"leaseAgreementUrl": "https://www.example.com/lease-agreement",
"plotNumber": "10634/1",
"identificationNumberOfLandCharge": "999-8-77-6-L1",
"leaseHolder": "Lisa Leaseholder",
"leaseHoldTransferLimitation": "YES",
"leaseHoldTransferLimitationDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"legalConfirmationOfTitleToRealProperty": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"area": {"value": 2.3,
"areaUnitCode": "M2"
},
"areaNotKnown": true,
"zoning": {"typeCodes": ["CITY_PLAN"
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"beach": {"code": "OWN_BEACH",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"typeCode": "LAKE",
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"waterBodyName": "Lake Laihia",
"shorelineLength": {"lengthInMeters": 100,
"lengthNotKnown": false
}
},
"constructionRight": {"densityRate": 0.2,
"floorArea": {"value": 2.3,
"areaUnitCode": "M2"
},
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"unbuiltPlot": true
},
"internetConnections": {"broadbandAvailable": "YES",
"fiberOpticInternet": "YES",
"housingCompanyBroadband": "YES",
"broadbandOperator": "string",
"internalNetworkCabling": "YES",
"networkDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"television": {"typeCodes": ["CABLE"
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"lastAnnualGeneralMeetingDate": "2022-12-31",
"nextAnnualGeneralMeetingDate": "2022-12-31",
"identifiedDeficiencies": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"costIncurringLiabilities": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"repairsAndMaintenanceAgreements": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"houseManagerCertificateDate": "2022-12-31",
"finances": {"loanAmount": 250000,
"mortgageAmount": 10000,
"rentRevenue": 2000,
"bankAccountCreditLimit": 100000,
"currencyCode": "EUR"
},
"exteriorDoors": {"typeCode": "LOCKED",
"openingHours": "9-17",
"doorCode": "1234"
},
"energyCertificate": {"typeCode": "A_2018",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"asbestosMapping": {"isAsbestosMappingDone": "YES",
"isAsbestosMappingReportAvailable": "YES",
"constructionMaterialsMightHaveAsbestos": "YES",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"parkingSpaces": [{"parkingSpaceTypeCode": "PARKING_SPACE_SHARE",
"count": 1
}
],
"parkingSpaceDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"housingCompanyPremiseStatistics": [{"premiseTypeCode": "APARTMENT",
"count": 1,
"area": {"value": 2.3,
"areaUnitCode": "M2"
},
"managedByHousingCompanyCount": 2,
"areaManagedByHousingCompany": {"value": 2.3,
"areaUnitCode": "M2"
}
}
],
"housingCompanyPremiseStatisticsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"renovations": [{"date": "05/2025",
"decidedByGeneralMeeting": "YES",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"isHousingCompanyNotified": "YES",
"statusCode": "FINISHED",
"typeCode": "string",
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
],
"renovationsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"renovationsPlannedDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"inspections": [{"date": "05/2025",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"typeCode": "LONG_TERM_PLAN"
}
],
"inspectionsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"additionalDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"listOfSharesTransferred": "YES",
"digitalShareGroupIdentifiers": ["KRD7AR4QP2NRHP97"
],
"inspectionsDone": "YES"
},
"housingCompanyCharges": {"managementCharge": 200.34,
"managementChargeNotKnown": true,
"financingCharge": {"amount": 250,
"amountNotKnown": true,
"includesOnlyInterest": "YES",
"amountDuringRepaymentFreePeriod": 20,
"repaymentFreePeriodStartDate": "2022-12-31",
"repaymentFreePeriodEndDate": "2022-12-31"
},
"plot": {"rentCharge": 300,
"rentChargeNotKnown": true,
"isPlotRedeemable": "YES",
"isPlotRedeemed": "YES",
"redemptionShare": 10000.35,
"redemptionDetailsUrl": "https://www.example.com/redemption-details"
},
"specialCharge": 100,
"specialChargeNotKnown": true,
"maintenanceCharge": 200.15,
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"detailsUrl": "https://www.asoy.fi/charges",
"currencyCode": "EUR"
},
"schemaVersion": "1"
}
}

Response samples

Content type

application/json

{"errorCode": "BAD_REQUEST_PARAMETERS",
"message": "Invalid request parameters",
"description": "Request parameters are missing or have invalid type.",
"errors": [{"target": "assignmentId",
"errorCode": "VALUE_REQUIRED",
"message": "Mandatory request parameter assignmentId is missing"
},
{"target": "authorId",
"errorCode": "INVALID_TYPE",
"message": "Request parameter authorId must be a string"
}
]
}

Update an explanatory appendix

Updates the explanatory appendix data for given realty within an assignment.

Authorizations:

bearerAuth

path Parameters

assignmentId required	string <uuid> Example: 123e4567-e89b-12d3-a456-426614174000 The id of the assignment.
realtyId required	string <uuid> Example: 123e4567-e89b-12d3-a456-426614174001 The id of the realty.

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json
required

Contains the updated explanatory appendix data.

One of

required

object (ResidentialShareContent)

Responses

Request samples

Payload

Content type

application/json

Example

PutResidentialShare

{"content": {"subcategoryCode": "SHARE",
"propertyTypeCode": "LEISURE",
"realty": {"newBuilding": "YES",
"costs": [{"amount": 20,
"currencyCode": "EUR",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"typeCode": "WATER",
"waterChargeTypeCode": "BY_USE",
"chargePeriodCode": "MONTH_PER_PERSON",
"typeOtherDescription": "string"
}
],
"costsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"monthlyRent": 439,
"rentPayment": {"rentAmount": 439,
"rentPaymentPeriodCode": "MONTH"
},
"startingPriceAmount": 190000,
"sellingPrice": 250100,
"currencyCode": "EUR",
"availability": {"code": "AVAILABLE",
"date": "2022-12-31",
"monthsAfterTransaction": 2,
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"tenantName": "John",
"tenantContactDetails": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"rentPayment": {"rentAmount": 439,
"rentPaymentPeriodCode": "MONTH"
}
},
"rentChange": {"date": "2022-12-31",
"rentAmount": 439,
"rentPaymentPeriodCode": "MONTH"
},
"basisForPossession": {"typeCode": "TENANCY",
"tenancyDescription": "Rented on fixed term"
},
"isRented": "YES",
"roommateCount": 2,
"address": {"streetAddress": "Yliopistonkatu 55",
"stairwell": "C",
"apartmentNumber": "55",
"district": "Hervanta",
"districtCode": "FI_PIRKANMAA_TAMPERE_HERVANTA",
"region": "Pirkanmaa",
"regionCode": "FI_PIRKANMAA",
"postcode": "33100",
"postalArea": "Tampere",
"locality": "Tampere",
"localityCode": "FI_PIRKANMAA_TAMPERE",
"country": "Suomi",
"countryCode": "FI",
"location": {"latitude": 61.48662,
"longitude": 23.24047,
"coordinateAccuracy": "STREET",
"coordinateSource": "GEO_CODING"
},
"showMapOnAnnouncement": "YES"
},
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"title": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"transactionDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"transactionDoesNotInclude": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"transactionIncludes": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"condition": {"code": "GOOD",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"additionalAreaMeasurementInformation": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"additionalInformation": {"activitiesAndRecreationDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"additionalDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"additionalRealtyDetailLinks": [{"title": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"url": "http://example.com",
"typeCode": "VIDEO_PRESENTATION"
}
],
"drivingInstructions": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"nearbyAmenitiesDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"transportationServicesDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"damages": [{"damageExistsCode": "YES",
"damageTypeCode": "WATER_DAMAGE",
"damageDate": "2022-01-15",
"causeDescription": "Vesivahinko katossa",
"extentDescription": "Olohuoneen nurkan katto",
"repairDescription": "Kuivatus ja sisäkaton maalaus",
"attachmentId": "63df9455-3d05-40d4-aeb4-9f5a4ee7f720",
"hasAttachment": true
}
],
"livingComfortFactors": [{"livingComfortFactorCode": "NOISE_SMELL_VIBRATION_ETC",
"description": "Heikko television antennisignaali"
}
],
"keyManagement": {"keysToBeOrderedFromHousingManager": "YES",
"keysHandedOverByHousingCompany": "YES",
"numberOfKeysHandedOverByHousingCompany": 2,
"keycardAvailable": "YES",
"description": "Avainkortti luovutetaan siirron yhteydessä ostajalle",
"keys": [{"keyUsageCode": "SAFETY_LOCK",
"keyTypeCode": "MECHANICAL_KEY",
"description": "Emännän avain",
"keyCount": 1
}
]
},
"leaseDetails": {"paymentDate": "First day of every month",
"depositDescription": "2kk vuokra",
"depositAmount": 0,
"currencyCode": "EUR",
"leaseTypeCode": "FIXED_TERM",
"fixedLeaseStartDate": "2022-03-15",
"fixedLeaseEndDate": "2024-03-15",
"leaseStartDate": "2022-03-15",
"leaseContractDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"noticePeriodStartDate": "2022-03-15",
"noticePeriodCanBegin": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"penaltyForEarlyTermination": "1kk vuokra + 1000 euro",
"basisForRentIncrease": {"typeCode": "PERCENT",
"indexDescription": "Rent is increased by 2%",
"increasePercent": 2,
"otherDescription": "Rent is increased annually",
"rentReviewDate": "Once a year in January"
}
},
"livingFormTypeCode": "NONSUBSIDISED",
"sharedLivingTypeCode": "MALE_TENANTS",
"attachmentsDescription": "string",
"planningToSell": "YES",
"tenantResponsibleFor": ["FLOOR_DRAINS"
]
},
"residentialShare": {"residentialTypeCode": "APARTMENT_HOUSE",
"ownershipTypeCode": "OWN",
"administration": {"typeCode": "APARTMENT_HOUSING_COMPANY",
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"apartment": {"officialRoomStructure": "2H + K",
"roomCountCode": "3H",
"area": {"areaBasisCodes": ["ARTICLES_OF_ASSOCIATION"
],
"livingArea": {"value": 2.3,
"areaUnitCode": "M2"
},
"otherSpaceArea": {"value": 2.3,
"areaUnitCode": "M2"
},
"totalArea": {"value": 2.3,
"areaUnitCode": "M2"
},
"livingAreaNotKnown": true,
"otherSpaceAreaNotKnown": true,
"totalAreaNotKnown": true
},
"floors": {"floorLevel": 2,
"floorLevelCode": "ON_MIDDLE_FLOOR",
"livingFloorCount": 2,
"livingFloorCountCode": "TWO_FLOORS",
"totalFloorCount": 5
},
"asbestosMapping": {"isAsbestosMappingDone": "YES",
"isAsbestosMappingReportAvailable": "YES",
"constructionMaterialsMightHaveAsbestos": "YES",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"hearth": {"typeCodes": ["FIREPLACE"
],
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"hasBalcony": "YES",
"balcony": {"typeCodes": ["FRENCH_WINDOW"
],
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"compassPoints": ["NORTH"
],
"balconyGlassMaintenanceResponsibilityCode": "HOUSING_COMPANY"
},
"hasTerrace": "YES",
"terrace": {"isGlazedTerrace": "YES",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"compassPoints": ["NORTH"
],
"terraceGlassMaintenanceResponsibilityCode": "HOUSING_COMPANY"
},
"yard": {"hasPrivateYard": "YES",
"basisForPossessionCode": "ARTICLES_OF_ASSOCIATION",
"basisForPossessionOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"rooms": [{"typeCode": "KITCHEN",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"features": [{"featureCode": "INDUCTION_STOVE",
"description": [{"languageCode": null,
"text": null
}
]
}
],
"floorMaterialCodes": ["PARQUET"
],
"wallMaterialCodes": ["WALLPAPER"
],
"ceilingMaterialCodes": ["PANEL"
],
"floorMaterialDescription": "string",
"wallMaterialDescription": "string"
}
],
"numberOfToilets": 2,
"numberOfBedrooms": 3,
"boilerRoomDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"livingQuartersDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"interiorMaterialDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"isFitForWinterHabitation": "YES",
"hasOwnSauna": "YES",
"heatingDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"inspections": [{"date": "05/2025",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"typeCode": "CONDITION_INSPECTION"
}
],
"inspectionsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"modificationDocuments": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"patioDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"refrigeratedCellarDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"renovations": [{"date": "05/2025",
"decidedByGeneralMeeting": "YES",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"isHousingCompanyNotified": "YES",
"statusCode": "FINISHED",
"typeCode": "string",
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
],
"renovationsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"shareholderInstallationDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"storageDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"underfloorHeatingDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"utilityServicesRoomDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"thingsEffectingHousingComfort": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"viewDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"smokingAllowed": "YES",
"petsAllowed": "YES",
"suitableForDisabled": "YES",
"furnished": "YES",
"inspectionsDone": "YES"
},
"debtFreePrice": 360000,
"debtShareAmount": 2000.45,
"debtShareDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"debtShareCheckDate": "2022-12-31",
"isDebtSharePayable": "YES",
"currencyCode": "EUR",
"startingDebtFreePrice": 2000.45,
"storages": [{"typeCode": "CELLAR",
"basisForPossessionCodes": ["BELONGS_TO_APARTMENT_ACCORDING_TO_THE_ARTICLES_OF_ASSOCIATION"
],
"transferCode": "NON_TRANSFERABLE",
"basisForAllocationDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
],
"limitsOfStorageUsage": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"parkingSpaces": [{"typeCode": "SPACE_IN_PARKING_HALL",
"basisForPossessionCodes": ["BELONGS_TO_APARTMENT_ACCORDING_TO_THE_ARTICLES_OF_ASSOCIATION"
],
"transferCode": "NON_TRANSFERABLE",
"basisForAllocationDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
],
"parkingSpaceDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"shareCertificate": {"shareCertificateAvailable": "YES",
"mortgageDeclaredSeparately": "YES",
"shareCertificateUsedAsMortgage": "YES",
"mortgageHolder": "Pantin haltija ja yhteystiedot\n(tämä täytetään, jos osakekirja on pantattu).\n",
"liabilityAmount": 25000,
"currencyCode": "EUR",
"shareCertificateLocation": "osakekirjan säilytyspaikka",
"shareGroupIdentifiers": ["1-300"
],
"quantityOfShares": 300,
"shareCertificateFormCode": "DIGITAL",
"permanentDwellingIdentifier": "223456789A"
},
"redemption": {"redeemableByHousingCompany": "YES",
"redeemableByExistingShareholders": "YES",
"redemptionRightAppliesToAllShares": "YES",
"otherRestrictions": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
},
"housingCompany": {"businessIdentification": {"businessId": "FI02472382",
"schemeId": "VAT"
},
"name": "As Oy Tammentie",
"address": {"streetAddress": "Yliopistonkatu 55",
"stairwell": "C",
"apartmentNumber": "55",
"district": "Hervanta",
"districtCode": "FI_PIRKANMAA_TAMPERE_HERVANTA",
"region": "Pirkanmaa",
"regionCode": "FI_PIRKANMAA",
"postcode": "33100",
"postalArea": "Tampere",
"locality": "Tampere",
"localityCode": "FI_PIRKANMAA_TAMPERE",
"country": "Suomi",
"countryCode": "FI",
"location": {"latitude": 61.48662,
"longitude": 23.24047,
"coordinateAccuracy": "STREET",
"coordinateSource": "GEO_CODING"
},
"showMapOnAnnouncement": "YES"
},
"managerContactDetails": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"maintenance": {"typeCodes": ["PROPERTY_MAINTENANCE_COMPANY"
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"propertyIdentifier": "092-416-11-123",
"construction": {"builder": "YIT Suomi Oy",
"constructionYear": 2010,
"developmentPhaseCode": "IN_CONSTRUCTION",
"usageStartYear": 2011,
"constructionAndUsageYearDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"buildings": {"constructionMaterial": {"typeCode": "WOOD",
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"heating": {"systemCodes": ["DISTRICT_HEATING"
],
"systemOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"distributionSystemCodes": ["WATER_UNDERFLOOR_HEATING"
],
"distributionSystemOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"ventilation": {"systemCodes": ["GRAVITY_BASED"
],
"systemsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"outerRoof": {"typeCode": "FLAT",
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"materialCode": "SHEET_METAL",
"otherMaterialDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"hasElevator": "YES",
"elevatorTakesToApartment": "YES",
"hasSauna": "YES",
"premises": {"typeCodes": ["CELLAR_STORAGE"
],
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
},
"yardDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"plot": {"plotPropertyTypeCode": "HOLIDAY_PLOT",
"holdingTypeCode": "OWN",
"holdingTypeDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"landlord": "City of Tampere",
"yearlyRent": 1200,
"yearlyRentNotKnown": true,
"currencyCode": "EUR",
"isRedeemable": "YES",
"redemptionPortion": 10000,
"optionalRentalPlot": "YES",
"optionalRentalPlotDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"leaseEndDate": "05/2025",
"leaseEndDateNotKnown": true,
"leasePeriodDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"leaseAgreementDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"leaseAgreementUrl": "https://www.example.com/lease-agreement",
"plotNumber": "10634/1",
"identificationNumberOfLandCharge": "999-8-77-6-L1",
"leaseHolder": "Lisa Leaseholder",
"leaseHoldTransferLimitation": "YES",
"leaseHoldTransferLimitationDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"legalConfirmationOfTitleToRealProperty": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"area": {"value": 2.3,
"areaUnitCode": "M2"
},
"areaNotKnown": true,
"zoning": {"typeCodes": ["CITY_PLAN"
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"beach": {"code": "OWN_BEACH",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"typeCode": "LAKE",
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"waterBodyName": "Lake Laihia",
"shorelineLength": {"lengthInMeters": 100,
"lengthNotKnown": false
}
},
"constructionRight": {"densityRate": 0.2,
"floorArea": {"value": 2.3,
"areaUnitCode": "M2"
},
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"unbuiltPlot": true
},
"internetConnections": {"broadbandAvailable": "YES",
"fiberOpticInternet": "YES",
"housingCompanyBroadband": "YES",
"broadbandOperator": "string",
"internalNetworkCabling": "YES",
"networkDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"television": {"typeCodes": ["CABLE"
],
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"lastAnnualGeneralMeetingDate": "2022-12-31",
"nextAnnualGeneralMeetingDate": "2022-12-31",
"identifiedDeficiencies": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"costIncurringLiabilities": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"repairsAndMaintenanceAgreements": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"houseManagerCertificateDate": "2022-12-31",
"finances": {"loanAmount": 250000,
"mortgageAmount": 10000,
"rentRevenue": 2000,
"bankAccountCreditLimit": 100000,
"currencyCode": "EUR"
},
"exteriorDoors": {"typeCode": "LOCKED",
"openingHours": "9-17",
"doorCode": "1234"
},
"energyCertificate": {"typeCode": "A_2018",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"asbestosMapping": {"isAsbestosMappingDone": "YES",
"isAsbestosMappingReportAvailable": "YES",
"constructionMaterialsMightHaveAsbestos": "YES",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
},
"parkingSpaces": [{"parkingSpaceTypeCode": "PARKING_SPACE_SHARE",
"count": 1
}
],
"parkingSpaceDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"housingCompanyPremiseStatistics": [{"premiseTypeCode": "APARTMENT",
"count": 1,
"area": {"value": 2.3,
"areaUnitCode": "M2"
},
"managedByHousingCompanyCount": 2,
"areaManagedByHousingCompany": {"value": 2.3,
"areaUnitCode": "M2"
}
}
],
"housingCompanyPremiseStatisticsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"renovations": [{"date": "05/2025",
"decidedByGeneralMeeting": "YES",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"isHousingCompanyNotified": "YES",
"statusCode": "FINISHED",
"typeCode": "string",
"typeOtherDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
],
"renovationsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"renovationsPlannedDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"inspections": [{"date": "05/2025",
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"typeCode": "LONG_TERM_PLAN"
}
],
"inspectionsDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"additionalDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"listOfSharesTransferred": "YES",
"digitalShareGroupIdentifiers": ["KRD7AR4QP2NRHP97"
],
"inspectionsDone": "YES"
},
"housingCompanyCharges": {"managementCharge": 200.34,
"managementChargeNotKnown": true,
"financingCharge": {"amount": 250,
"amountNotKnown": true,
"includesOnlyInterest": "YES",
"amountDuringRepaymentFreePeriod": 20,
"repaymentFreePeriodStartDate": "2022-12-31",
"repaymentFreePeriodEndDate": "2022-12-31"
},
"plot": {"rentCharge": 300,
"rentChargeNotKnown": true,
"isPlotRedeemable": "YES",
"isPlotRedeemed": "YES",
"redemptionShare": 10000.35,
"redemptionDetailsUrl": "https://www.example.com/redemption-details"
},
"specialCharge": 100,
"specialChargeNotKnown": true,
"maintenanceCharge": 200.15,
"description": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"detailsUrl": "https://www.asoy.fi/charges",
"currencyCode": "EUR"
},
"schemaVersion": "1"
}
}

Response samples

Content type

application/json

{"errorCode": "BAD_REQUEST_PARAMETERS",
"message": "Invalid request parameters",
"description": "Request parameters are missing or have invalid type.",
"errors": [{"target": "assignmentId",
"errorCode": "VALUE_REQUIRED",
"message": "Mandatory request parameter assignmentId is missing"
},
{"target": "authorId",
"errorCode": "INVALID_TYPE",
"message": "Request parameter authorId must be a string"
}
]
}

Execute an explanatory appendix action

Executes an explanatory appendix action.

Authorizations:

bearerAuth

path Parameters

assignmentId required	string <uuid> Example: 123e4567-e89b-12d3-a456-426614174000 The id of the assignment.
realtyId required	string <uuid> Example: 123e4567-e89b-12d3-a456-426614174001 The id of the realty.

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json
required

Contains the explanatory appendix action data.

actionCode

required

string

Enum: "LOCK" "UNLOCK" "APPROVE"

The action to be performed on the explanatory appendix. Possible values are:

LOCK: Generates explanatory appendix PDF document and sets the status to READY_FOR_SIGNING. Only available if the explanatory appendix is in DRAFT state.
UNLOCK: Sets the status to DRAFT. Only available if the explanatory appendix is in READY_FOR_SIGNING state.
APPROVE: Sets the status to APPROVED. Only available if the explanatory appendix is in READY_FOR_SIGNING state.

Responses

Request samples

Payload

Content type

application/json

{"actionCode": "LOCK"
}

Response samples

Content type

application/json

{"errorCode": "BAD_REQUEST_PARAMETERS",
"message": "Invalid request parameters",
"description": "Request parameters are missing or have invalid type.",
"errors": [{"target": "assignmentId",
"errorCode": "VALUE_REQUIRED",
"message": "Mandatory request parameter assignmentId is missing"
},
{"target": "authorId",
"errorCode": "INVALID_TYPE",
"message": "Request parameter authorId must be a string"
}
]
}

Import explanatory appendix from another system

Imports explanatory appendix from another system. The imported explanatory appendix must be signed by the assignee and the ID of the signed document must be provided in the request body. The explanatory appendix will be created into APPROVED state. The actual content of the explanatory appendix is not needed and cannot be provided in a structured format. A specific permission is required to use this endpoint.

Authorizations:

bearerAuth

path Parameters

assignmentId required	string <uuid> Example: 123e4567-e89b-12d3-a456-426614174000 The id of the assignment.
realtyId required	string <uuid> Example: 123e4567-e89b-12d3-a456-426614174001 The id of the realty.

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json
required

Contains the explanatory appendix data.

realtyTypeCode required	string (RealtyTypeCode) Enum: "RESIDENTIAL_SHARE" "OTHER_SHARE" "RESIDENTIAL_PROPERTY" "ESTATE_PROPERTY" "COMMERCIAL_PROPERTY" "OTHER_PROPERTY" Describes the type of the realty in terms of used endpoint. Possible values are: `RESIDENTIAL_SHARE` is a share type of realty meant for living. `OTHER_SHARE` is any other share type of realty. `RESIDENTIAL_PROPERTY` is a property type of realty meant for living. `ESTATE_PROPERTY` is a large area of land that can include buildings. `COMMERCIAL_PROPERTY` is commercial property type of realty. `OTHER_PROPERTY` is any other property type of realty.
categoryCode required	string (RealtyCategoryCode) Enum: "SALE" "RENTAL" Describes if the assignment and realty are for sale or rental.
documentId required	string The id of the signed explanatory appendix document.

Responses

Request samples

Payload

Content type

application/json

{"realtyTypeCode": "RESIDENTIAL_SHARE",
"categoryCode": "SALE",
"documentId": "123e4567-e89b-12d3-a456-426614174000"
}

Response samples

Content type

application/json

{"errorCode": "BAD_REQUEST_PARAMETERS",
"message": "Invalid request parameters",
"description": "Request parameters are missing or have invalid type.",
"errors": [{"target": "assignmentId",
"errorCode": "VALUE_REQUIRED",
"message": "Mandatory request parameter assignmentId is missing"
},
{"target": "authorId",
"errorCode": "INVALID_TYPE",
"message": "Request parameter authorId must be a string"
}
]
}

Explanatory Appendix API (v1)

Introduction

Contact

Explanatory Appendix

Get an explanatory appendix

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Create an explanatory appendix

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update an explanatory appendix

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Execute an explanatory appendix action

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Import explanatory appendix from another system

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required