Clearing API (v1)

Download OpenAPI specification:

Introduction

Clearing API allows the agent to manage the clearing of a realty trade and a realty rental.

Contact

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

Trade Settlement

Trade Settlement API allows you to initiate and complete a trade settlement for a set of assets.

Search trade settlements

Search trade settlement matching specified query parameters.

Authorizations:

bearerAuth

query Parameters

tradeSettlementId	Array of strings <uuid> (TradeSettlementId) [ items <uuid >^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... ] Example: tradeSettlementId=4a30bb37-96a7-47cc-9dec-f369c5651db4 Search by trade settlement identifier to get a list of trade settlements.
realtyId	string <uuid> Example: realtyId=212114ec-819e-483c-a8e0-f82289ac6e19 Search by realty identifier to get a list of trade settlements for the realty.
assignmentId	Array of strings <uuid> [ items <uuid > ] Example: assignmentId=212114ec-819e-483c-a8e0-f82289ac6e19 Search by assignment identifiers to get a list of trade settlements that belong to certain assignments.
agentId	string <uuid> (AgentId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: agentId=5d2a6d47-da73-4b11-8940-27cffabb6de5 Search by the agent identifier to get a list of trade settlements the agent is related to.
agencyOfficeId	Array of strings <uuid> (AgencyOfficeId) [ items <uuid >^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... ] Example: agencyOfficeId=212114ec-819e-483c-a8e0-f82289ac6e19 Search by the agency office identifiers to get a list of trade settlements that belong to certain agency offices.
partyId	Array of strings <uuid> (PartyId) [ items <uuid >^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... ] Example: partyId=62701576-2621-4a27-8d2b-63cea492abb6 Search by party identifiers to get a list of trade settlements that have given party as buyer, seller or consentor.
statusCode	Array of strings (TradeSettlementStatusCode) Items Enum: "IN_PROGRESS" "COMPLETED" "DISMANTLED" Example: statusCode=COMPLETED Search by the trade settlement status code to fetch trade settlements having specific statuses.
modifiedAfter	string <date-time> (Timestamp) Example: modifiedAfter=2024-09-05T13:50:22.204Z Search by a timestamp to get a list of trade settlements which were modified after the specified time.
tradeDateBefore	string <date> (Date) Example: tradeDateBefore=2021-01-15 Search by a date to get a list of trade settlements which have trade date before or equal to the specified date.
tradeDateAfter	string <date> (Date) Example: tradeDateAfter=2021-01-15 Search by a date to get a list of trade settlements which have trade date after or equal to the specified date.
startIndex	integer <int32> >= 0 Default: 0 Example: startIndex=20 Paginate returned trade settlements starting from this index. Index starts from 0.
size	integer <int32> [ 1 .. 100 ] Default: 50 Example: size=40 Trade settlements returned per page.
sort	Array of strings[ items^(creationTime\|modificationTime\|tradeDate)\\|(... ] Example: sort=modificationTime\|desc Sort trade settlements based on the specified fields. Available sort fields: `creationTime` - Sort by trade settlement creation time `modificationTime` - Sort by trade settlement modification time `tradeDate` - Sort by the trade date when the sale deed or contract was signed Default sorting: If no sort parameter is provided, results are sorted by `creationTime\|desc` (newest trade settlements first).

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

{"totalCount": 2,
"tradeSettlements": [{"tradeSettlementId": "4a30bb37-96a7-47cc-9dec-f369c5651db4",
"statusCode": "IN_PROGRESS",
"agencyOfficeId": "4a30bb37-96a7-47cc-9dec-f369c5651db4",
"agents": [{"agentId": "b8b9bc07-72c6-4241-a1a4-530ead372435",
"roleCode": "RESPONSIBLE_AGENT"
}
],
"assignmentId": "4a30bb37-96a7-47cc-9dec-f369c5651db4",
"tradeDate": "2022-01-01",
"digitalTrading": true,
"assets": [{"realtyId": "4a30bb37-96a7-47cc-9dec-f369c5651db4",
"realtyTypeCode": "RESIDENTIAL_SHARE",
"subcategoryCode": "SHARE",
"address": {"addressLine1": "Hämeentie 6",
"postcode": "33100",
"postalArea": "Tampere",
"localityCode": "FI_PIRKANMAA_TAMPERE",
"regionCode": "FI_PIRKANMAA",
"countryCode": "FI"
},
"price": {"sellingPrice": 250000,
"debtFreePriceAmount": 200000,
"debtAmount": 50000,
"currencyCode": "EUR",
"housingCompanyDebtDate": "2022-01-01",
"housingManagerCertificateDate": "2022-02-02"
}
}
],
"parties": [{"partyId": "4220476a-96b8-423e-bc0b-d80a3c21577c",
"partyRoleCode": "BUYER_CUSTOMER"
}
],
"creationTime": "2022-01-01T12:00:00Z",
"modificationTime": "2022-01-01T12:30:00Z"
},
{"tradeSettlementId": "4a30bb37-96a7-47cc-9dec-f369c5651db4",
"statusCode": "COMPLETED",
"agencyOfficeId": "4a30bb37-96a7-47cc-9dec-f369c5651db4",
"agents": [{"agentId": "b8b9bc07-72c6-4241-a1a4-530ead372435",
"roleCode": "RESPONSIBLE_AGENT"
}
],
"assignmentId": "4a30bb37-96a7-47cc-9dec-f369c5651db4",
"tradeDate": "2022-02-01",
"digitalTrading": false,
"assets": [{"realtyId": "4a30bb37-96a7-47cc-9dec-f369c5651db4",
"realtyTypeCode": "RESIDENTIAL_PROPERTY",
"subcategoryCode": "PROPERTY",
"address": {"addressLine1": "Satakunnankatu 16",
"postcode": "33100",
"postalArea": "Tampere",
"localityCode": "FI_PIRKANMAA_TAMPERE",
"regionCode": "FI_PIRKANMAA",
"countryCode": "FI"
},
"price": {"sellingPrice": 150000,
"currencyCode": "EUR"
}
}
],
"parties": [{"partyId": "c70f3cf4-353b-449c-a409-ef2f9872b7dd",
"partyRoleCode": "BUYER_CUSTOMER"
}
],
"creationTime": "2022-02-01T10:00:00Z",
"modificationTime": "2022-02-01T10:30:00Z"
}
]
}

Create a trade settlement

Create a new trade settlement.

Authorizations:

bearerAuth

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 details for the trade settlement.

required	object (TradeSettlement) Details for the trade settlement.
sourceSystemCreationTime	string <date-time> (SourceSystemCreationTime) Timestamp as defined by ISO 8601 with time offset. Creation time of the party in the source system. Intended to be used in data migration scenarios.

Responses

Request samples

Payload

Content type

application/json

{"tradeSettlement": {"agencyOfficeId": "7bdffe48-0077-4de0-acd4-d9b9b1ab49f8",
"agents": [{"agentId": "5d2a6d47-da73-4b11-8940-27cffabb6de5",
"roleCode": "RESPONSIBLE_AGENT"
}
],
"trade": {"marketingTimeInDays": 46,
"assignmentId": "9238cf7b-b86a-49a5-b54f-cbdfcd03e9c9",
"officialAssignmentId": "201252021",
"assignmentStartDate": "2022-10-11",
"acceptedOfferId": "1064fb85-6948-4a6b-8cd0-de80189e5252",
"offerAcceptanceDate": "2022-12-04",
"offersReceived": 7,
"tradeDate": "2022-12-30",
"digitalTrading": true,
"deadlineForSigningBillOfSale": "2023-08-31T10:19:34Z",
"compensationUponDelayedPayment": 30000,
"description": "DIAS-kauppa osapuolten välillä"
},
"realEstateTransferNotice": {"purposeOfUse": "OTHER_USE",
"isTransferBetweenRelatives": false,
"isShorePlot": false,
"buildingInformation": "TRANSFER_PART_OF_BUILDINGS",
"zoningType": "CITY_PLAN"
},
"sellerCustomerParties": [{"partyId": "62701576-2621-4a27-8d2b-63cea492abb6",
"partyTypeCode": "PERSON_PARTY",
"primaryContact": true,
"transferTaxDetails": {"interestCorporateBuyerIndividualSeller": false,
"interestIndividualBuyerCorporateSeller": false,
"interestCorporateBuyerSeller": false
}
}
],
"buyerCustomerParties": [{"partyId": "7172e9e1-0beb-49ab-a553-c1c3022d93f3",
"partyTypeCode": "PERSON_PARTY",
"primaryContact": true,
"transferTaxDetails": {"bankAuthorizedToPayTransferTax": true,
"preliminaryRulingForBuyer": false,
"paymentIdentifier": "20231500154"
}
},
{"partyId": "8a89c381-2188-412f-8226-f07649a90df4",
"partyTypeCode": "ORGANIZATION_PARTY",
"transferTaxDetails": {"bankAuthorizedToPayTransferTax": true,
"preliminaryRulingForBuyer": false,
"paymentIdentifier": "20231500154"
}
}
],
"consentorParties": [{"partyId": "ace3c93a-c347-41e8-a069-6a4e550258f7",
"consentorType": "WIDOW"
}
],
"assets": [{"realtyId": "9fd9124c-e6c1-4368-9f17-6938f0e2f524",
"realtyTypeCode": "RESIDENTIAL_SHARE",
"subcategoryCode": "SHARE",
"address": {"addressLine1": "Hämeenkatu 24",
"stairwell": "B",
"apartmentNumber": "55",
"postcode": "33100",
"postalArea": "Tampere",
"localityCode": "FI_PIRKANMAA_TAMPERE",
"regionCode": "FI_PIRKANMAA",
"countryCode": "FI"
},
"share": {"quantityOfShares": 65,
"shareGroupIdentifiers": ["300-365"
],
"digitalShareGroupIdentifiers": ["OH96D7L5KFMSP421"
],
"sellerShareCertificateStatus": "ONE_OF_SELLERS_HAS_SHARE_CERTIFICATE",
"shareCertificateFormCode": "DIGITAL",
"shareCertificateLocation": "Tampereen Seudun Osuuspankki",
"redemptionClauseExists": false
},
"price": {"sellingPrice": 190000,
"debtFreePriceAmount": 230000,
"debtAmount": 40000,
"currencyCode": "EUR",
"housingCompanyDebtDate": "2022-12-31",
"housingManagerCertificateDate": "2022-12-31"
},
"termsAndConditions": {"shareCertificateUsedAsPledge": true,
"pledgeHolder": "Tampereen Seudun Osuuspankki",
"realtySoldAsLeased": true,
"leaseConditions": {"rentPayableToBuyerSinceDate": "2022-12-31",
"depositTransferDate": "2022-12-31",
"rentAmount": 1000,
"currencyCode": "EUR"
}
},
"paymentTermsCode": "CASH",
"highestRejectedOfferPrice": 165000,
"ownershipTransferDate": "2022-12-31",
"assetIdentifier": "A6",
"includesAdditionalConditionForPrice": false,
"hasEstimationForAdditionalPrice": false,
"hspTransferEnabled": false,
"sellerCustomerParties": [{"partyId": "62701576-2621-4a27-8d2b-63cea492abb6",
"partyTypeCode": "PERSON_PARTY",
"shareOfOwnership": {"divisible": 1,
"divider": 1,
"percentage": 100
}
}
],
"buyerCustomerParties": [{"partyId": "7172e9e1-0beb-49ab-a553-c1c3022d93f3",
"partyTypeCode": "PERSON_PARTY",
"shareOfOwnership": {"divisible": 1,
"divider": 2,
"percentage": 50
},
"transferTaxRequiredCode": "TRANSFER_TAX_REQUIRED"
},
{"partyId": "8a89c381-2188-412f-8226-f07649a90df4",
"partyTypeCode": "ORGANIZATION_PARTY",
"shareOfOwnership": {"divisible": 1,
"divider": 2,
"percentage": 50
}
}
]
},
{"realtyId": "c948184b-0c53-41c3-ab45-82990bc59af2",
"realtyTypeCode": "RESIDENTIAL_PROPERTY",
"subcategoryCode": "PROPERTY",
"address": {"addressLine1": "Hämeentie 6",
"postcode": "33100",
"postalArea": "Tampere",
"localityCode": "FI_PIRKANMAA_TAMPERE",
"regionCode": "FI_PIRKANMAA",
"countryCode": "FI"
},
"property": {"facilityId": "323-123-5423-8234-L1",
"holdingTypeCode": "LEASEHOLD",
"realEstateTypeCode": "WHOLE_PROPERTY",
"propertyId": "323-123-5423-8234-L2",
"mortgageDeedCodes": ["AAA",
"BBB"
],
"nonTransferableMortgageDeedCodes": ["CCC",
"DDD"
]
},
"price": {"debtFreePriceAmount": 120000,
"currencyCode": "EUR"
},
"termsAndConditions": {"realtySoldAsLeased": true,
"leaseConditions": {"rentPayableToBuyerSinceDate": "2023-01-31",
"depositTransferDate": "2022-12-31",
"rentAmount": 900,
"currencyCode": "EUR"
}
},
"paymentTermsCode": "CASH",
"highestRejectedOfferPrice": 99000,
"ownershipTransferDate": "2022-12-31",
"includesAdditionalConditionForPrice": false,
"hasEstimationForAdditionalPrice": false,
"sellerCustomerParties": [{"partyId": "62701576-2621-4a27-8d2b-63cea492abb6",
"partyTypeCode": "PERSON_PARTY",
"shareOfOwnership": {"divisible": 1,
"divider": 1,
"percentage": 100
}
}
],
"buyerCustomerParties": [{"partyId": "7172e9e1-0beb-49ab-a553-c1c3022d93f3",
"partyTypeCode": "PERSON_PARTY",
"shareOfOwnership": {"divisible": 1,
"divider": 2,
"percentage": 50
},
"transferTaxRequiredCode": "TRANSFER_TAX_REQUIRED"
},
{"partyId": "8a89c381-2188-412f-8226-f07649a90df4",
"partyTypeCode": "ORGANIZATION_PARTY",
"shareOfOwnership": {"divisible": 1,
"divider": 2,
"percentage": 50
}
}
]
}
]
}
}

Response samples

Content type

application/json

{"tradeSettlementId": "4a30bb37-96a7-47cc-9dec-f369c5651db4"
}

Fetch a trade settlement

Fetch details for the specified trade settlement.

Authorizations:

bearerAuth

path Parameters

tradeSettlementId

required

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

Example: 6d9d4946-d170-4730-b818-37901edb961b

Unique trade settlement identifier in UUID format.

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

{"tradeSettlementId": "4a30bb37-96a7-47cc-9dec-f369c5651db4",
"statusCode": "COMPLETED",
"tradeSettlement": {"agencyOfficeId": "7bdffe48-0077-4de0-acd4-d9b9b1ab49f8",
"agents": [{"agentId": "5d2a6d47-da73-4b11-8940-27cffabb6de5",
"roleCode": "RESPONSIBLE_AGENT"
}
],
"trade": {"marketingTimeInDays": 46,
"assignmentId": "9238cf7b-b86a-49a5-b54f-cbdfcd03e9c9",
"officialAssignmentId": "201252021",
"assignmentStartDate": "2022-10-11",
"acceptedOfferId": "1064fb85-6948-4a6b-8cd0-de80189e5252",
"offerAcceptanceDate": "2022-12-04",
"offersReceived": 7,
"tradeDate": "2022-12-30",
"digitalTrading": true,
"deadlineForSigningBillOfSale": "2023-08-31T10:19:34Z",
"compensationUponDelayedPayment": 30000,
"description": "DIAS-kauppa osapuolten välillä"
},
"realEstateTransferNotice": {"purposeOfUse": "OTHER_USE",
"isTransferBetweenRelatives": false,
"isShorePlot": false,
"buildingInformation": "TRANSFER_PART_OF_BUILDINGS",
"zoningType": "CITY_PLAN"
},
"sellerCustomerParties": [{"partyId": "62701576-2621-4a27-8d2b-63cea492abb6",
"partyTypeCode": "PERSON_PARTY",
"primaryContact": true,
"transferTaxDetails": {"interestCorporateBuyerIndividualSeller": false,
"interestIndividualBuyerCorporateSeller": false,
"interestCorporateBuyerSeller": false
}
}
],
"buyerCustomerParties": [{"partyId": "7172e9e1-0beb-49ab-a553-c1c3022d93f3",
"partyTypeCode": "PERSON_PARTY",
"primaryContact": true,
"transferTaxDetails": {"bankAuthorizedToPayTransferTax": true,
"preliminaryRulingForBuyer": false,
"paymentIdentifier": "20231500154"
}
},
{"partyId": "8a89c381-2188-412f-8226-f07649a90df4",
"partyTypeCode": "ORGANIZATION_PARTY",
"transferTaxDetails": {"bankAuthorizedToPayTransferTax": true,
"preliminaryRulingForBuyer": true,
"paymentIdentifier": "20231500154",
"preliminaryRulingDetails": "Preliminary ruling details"
}
}
],
"consentorParties": [{"partyId": "ace3c93a-c347-41e8-a069-6a4e550258f7",
"consentorType": "WIDOW"
}
],
"assets": [{"realtyId": "9fd9124c-e6c1-4368-9f17-6938f0e2f524",
"realtyTypeCode": "RESIDENTIAL_SHARE",
"subcategoryCode": "SHARE",
"address": {"addressLine1": "Hämeenkatu 24",
"stairwell": "B",
"apartmentNumber": "55",
"postcode": "33100",
"postalArea": "Tampere",
"localityCode": "FI_PIRKANMAA_TAMPERE",
"regionCode": "FI_PIRKANMAA",
"countryCode": "FI"
},
"share": {"quantityOfShares": 65,
"shareGroupIdentifiers": ["300-365"
],
"digitalShareGroupIdentifiers": ["OH96D7L5KFMSP421"
],
"sellerShareCertificateStatus": "ONE_OF_SELLERS_HAS_SHARE_CERTIFICATE",
"shareCertificateFormCode": "DIGITAL",
"shareCertificateLocation": "Tampereen Seudun Osuuspankki",
"redemptionClauseExists": false
},
"price": {"sellingPrice": 190000,
"debtFreePriceAmount": 230000,
"debtAmount": 40000,
"currencyCode": "EUR",
"housingCompanyDebtDate": "2022-12-31",
"housingManagerCertificateDate": "2022-12-31"
},
"termsAndConditions": {"shareCertificateUsedAsPledge": true,
"pledgeHolder": "Tampereen Seudun Osuuspankki",
"realtySoldAsLeased": true,
"leaseConditions": {"rentPayableToBuyerSinceDate": "2022-12-31",
"depositTransferDate": "2022-12-31",
"rentAmount": 1000,
"currencyCode": "EUR"
}
},
"paymentTermsCode": "CASH",
"highestRejectedOfferPrice": 165000,
"ownershipTransferDate": "2022-12-31",
"assetIdentifier": "A6",
"includesAdditionalConditionForPrice": false,
"hasEstimationForAdditionalPrice": false,
"hspTransferEnabled": false,
"sellerCustomerParties": [{"partyId": "62701576-2621-4a27-8d2b-63cea492abb6",
"partyTypeCode": "PERSON_PARTY",
"shareOfOwnership": {"divisible": 1,
"divider": 1,
"percentage": 100
}
}
],
"buyerCustomerParties": [{"partyId": "7172e9e1-0beb-49ab-a553-c1c3022d93f3",
"partyTypeCode": "PERSON_PARTY",
"shareOfOwnership": {"divisible": 1,
"divider": 2,
"percentage": 50
},
"transferTaxRequiredCode": "TRANSFER_TAX_REQUIRED"
},
{"partyId": "8a89c381-2188-412f-8226-f07649a90df4",
"partyTypeCode": "ORGANIZATION_PARTY",
"shareOfOwnership": {"divisible": 1,
"divider": 2,
"percentage": 50
}
}
]
},
{"realtyId": "c948184b-0c53-41c3-ab45-82990bc59af2",
"realtyTypeCode": "RESIDENTIAL_PROPERTY",
"subcategoryCode": "PROPERTY",
"address": {"addressLine1": "Hämeentie 6",
"postcode": "33100",
"postalArea": "Tampere",
"localityCode": "FI_PIRKANMAA_TAMPERE",
"regionCode": "FI_PIRKANMAA",
"countryCode": "FI"
},
"property": {"facilityId": "323-123-5423-8234-L1",
"holdingTypeCode": "LEASEHOLD",
"realEstateTypeCode": "WHOLE_PROPERTY",
"propertyId": "323-123-5423-8234-L2",
"mortgageDeedCodes": ["AAA",
"BBB"
],
"nonTransferableMortgageDeedCodes": ["CCC",
"DDD"
]
},
"price": {"debtFreePriceAmount": 120000,
"currencyCode": "EUR"
},
"termsAndConditions": {"realtySoldAsLeased": true,
"leaseConditions": {"rentPayableToBuyerSinceDate": "2023-01-31",
"depositTransferDate": "2022-12-31",
"rentAmount": 900,
"currencyCode": "EUR"
}
},
"paymentTermsCode": "CASH",
"highestRejectedOfferPrice": 99000,
"ownershipTransferDate": "2022-12-31",
"includesAdditionalConditionForPrice": false,
"hasEstimationForAdditionalPrice": false,
"sellerCustomerParties": [{"partyId": "62701576-2621-4a27-8d2b-63cea492abb6",
"partyTypeCode": "PERSON_PARTY",
"shareOfOwnership": {"divisible": 1,
"divider": 1,
"percentage": 100
}
}
],
"buyerCustomerParties": [{"partyId": "8a89c381-2188-412f-8226-f07649a90df4",
"partyTypeCode": "ORGANIZATION_PARTY",
"shareOfOwnership": {"divisible": 1,
"divider": 1,
"percentage": 100
}
}
]
}
]
},
"creationTime": "2022-12-30T17:32:28Z",
"modificationTime": "2022-12-30T17:32:28Z",
"relatedDocuments": [{"documentId": "a1b2c3d4-e5f6-4789-a012-b3c4d5e6f7a8",
"isReadOnly": true
},
{"documentId": "f7e6d5c4-b3a2-4109-8765-fedcba098765",
"isReadOnly": false
}
]
}

Update a trade settlement

Update details for the specified trade settlement. The trade settlement contents can be updated only if it is in a IN_PROGRESS state.

Authorizations:

bearerAuth

path Parameters

tradeSettlementId

required

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

Example: 6d9d4946-d170-4730-b818-37901edb961b

Unique trade settlement identifier in UUID format.

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 details for the trade settlement.

tradeSettlementId	string <uuid> (TradeSettlementId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... A unique id which identifies the trade settlement.
statusCode	string (TradeSettlementStatusCode) Enum: "IN_PROGRESS" "COMPLETED" "DISMANTLED" Trade settlement status. The status defines what actions can be performed for trade settlement. Possible values are: `IN_PROGRESS`. The trade settlement has been initiated and can be modified. `COMPLETED`. The trade settlement has been completed. A completed trade settlement cannot be modified. If a change is required, the trade settlement must be dismantled. `DISMANTLED`. The trade settlement has been dismantled.
required	object (TradeSettlement) Details for the trade settlement.

Responses

Request samples

Payload

Content type

application/json

{"tradeSettlementId": "4a30bb37-96a7-47cc-9dec-f369c5651db4",
"statusCode": "COMPLETED",
"tradeSettlement": {"agencyOfficeId": "7bdffe48-0077-4de0-acd4-d9b9b1ab49f8",
"agents": [{"agentId": "5d2a6d47-da73-4b11-8940-27cffabb6de5",
"roleCode": "RESPONSIBLE_AGENT"
}
],
"trade": {"marketingTimeInDays": 46,
"assignmentId": "9238cf7b-b86a-49a5-b54f-cbdfcd03e9c9",
"officialAssignmentId": "201252021",
"assignmentStartDate": "2022-10-11",
"acceptedOfferId": "1064fb85-6948-4a6b-8cd0-de80189e5252",
"offerAcceptanceDate": "2022-12-04",
"offersReceived": 7,
"tradeDate": "2022-12-30",
"digitalTrading": true,
"deadlineForSigningBillOfSale": "2023-08-31T10:19:34Z",
"compensationUponDelayedPayment": 30000,
"description": "DIAS-kauppa osapuolten välillä"
},
"realEstateTransferNotice": {"purposeOfUse": "OTHER_USE",
"isTransferBetweenRelatives": false,
"isShorePlot": false,
"buildingInformation": "TRANSFER_PART_OF_BUILDINGS",
"zoningType": "CITY_PLAN"
},
"sellerCustomerParties": [{"partyId": "62701576-2621-4a27-8d2b-63cea492abb6",
"partyTypeCode": "PERSON_PARTY",
"primaryContact": true,
"transferTaxDetails": {"interestCorporateBuyerIndividualSeller": false,
"interestIndividualBuyerCorporateSeller": false,
"interestCorporateBuyerSeller": false
}
}
],
"buyerCustomerParties": [{"partyId": "7172e9e1-0beb-49ab-a553-c1c3022d93f3",
"partyTypeCode": "PERSON_PARTY",
"primaryContact": true,
"transferTaxDetails": {"bankAuthorizedToPayTransferTax": true,
"preliminaryRulingForBuyer": false,
"paymentIdentifier": "20231500154"
}
},
{"partyId": "8a89c381-2188-412f-8226-f07649a90df4",
"partyTypeCode": "ORGANIZATION_PARTY",
"transferTaxDetails": {"bankAuthorizedToPayTransferTax": true,
"preliminaryRulingForBuyer": false,
"paymentIdentifier": "20231500154"
}
}
],
"consentorParties": [{"partyId": "ace3c93a-c347-41e8-a069-6a4e550258f7",
"consentorType": "WIDOW"
}
],
"assets": [{"realtyId": "9fd9124c-e6c1-4368-9f17-6938f0e2f524",
"realtyTypeCode": "RESIDENTIAL_SHARE",
"subcategoryCode": "SHARE",
"address": {"addressLine1": "Hämeenkatu 24",
"stairwell": "B",
"apartmentNumber": "55",
"postcode": "33100",
"postalArea": "Tampere",
"localityCode": "FI_PIRKANMAA_TAMPERE",
"regionCode": "FI_PIRKANMAA",
"countryCode": "FI"
},
"share": {"quantityOfShares": 65,
"shareGroupIdentifiers": ["300-365"
],
"digitalShareGroupIdentifiers": ["OH96D7L5KFMSP421"
],
"sellerShareCertificateStatus": "ONE_OF_SELLERS_HAS_SHARE_CERTIFICATE",
"shareCertificateFormCode": "DIGITAL",
"shareCertificateLocation": "Tampereen Seudun Osuuspankki",
"redemptionClauseExists": false
},
"price": {"sellingPrice": 190000,
"debtFreePriceAmount": 230000,
"debtAmount": 40000,
"currencyCode": "EUR",
"housingCompanyDebtDate": "2022-12-31",
"housingManagerCertificateDate": "2022-12-31"
},
"termsAndConditions": {"shareCertificateUsedAsPledge": true,
"pledgeHolder": "Tampereen Seudun Osuuspankki",
"realtySoldAsLeased": true,
"leaseConditions": {"rentPayableToBuyerSinceDate": "2022-12-31",
"depositTransferDate": "2022-12-31",
"rentAmount": 1000,
"currencyCode": "EUR"
}
},
"paymentTermsCode": "CASH",
"highestRejectedOfferPrice": 165000,
"ownershipTransferDate": "2022-12-31",
"assetIdentifier": "A6",
"includesAdditionalConditionForPrice": false,
"hasEstimationForAdditionalPrice": false,
"hspTransferEnabled": false,
"sellerCustomerParties": [{"partyId": "62701576-2621-4a27-8d2b-63cea492abb6",
"partyTypeCode": "PERSON_PARTY",
"shareOfOwnership": {"divisible": 1,
"divider": 1,
"percentage": 100
}
}
],
"buyerCustomerParties": [{"partyId": "7172e9e1-0beb-49ab-a553-c1c3022d93f3",
"partyTypeCode": "PERSON_PARTY",
"shareOfOwnership": {"divisible": 1,
"divider": 2,
"percentage": 50
},
"transferTaxRequiredCode": "TRANSFER_TAX_REQUIRED"
},
{"partyId": "8a89c381-2188-412f-8226-f07649a90df4",
"partyTypeCode": "ORGANIZATION_PARTY",
"shareOfOwnership": {"divisible": 1,
"divider": 2,
"percentage": 50
}
}
]
},
{"realtyId": "c948184b-0c53-41c3-ab45-82990bc59af2",
"realtyTypeCode": "RESIDENTIAL_PROPERTY",
"subcategoryCode": "PROPERTY",
"address": {"addressLine1": "Hämeentie 6",
"postcode": "33100",
"postalArea": "Tampere",
"localityCode": "FI_PIRKANMAA_TAMPERE",
"regionCode": "FI_PIRKANMAA",
"countryCode": "FI"
},
"property": {"facilityId": "323-123-5423-8234-L1",
"holdingTypeCode": "LEASEHOLD",
"realEstateTypeCode": "WHOLE_PROPERTY",
"propertyId": "323-123-5423-8234-L2",
"mortgageDeedCodes": ["AAA",
"BBB"
],
"nonTransferableMortgageDeedCodes": ["CCC",
"DDD"
]
},
"price": {"debtFreePriceAmount": 120000,
"currencyCode": "EUR"
},
"termsAndConditions": {"realtySoldAsLeased": true,
"leaseConditions": {"rentPayableToBuyerSinceDate": "2023-01-31",
"depositTransferDate": "2022-12-31",
"rentAmount": 900,
"currencyCode": "EUR"
}
},
"paymentTermsCode": "CASH",
"highestRejectedOfferPrice": 99000,
"ownershipTransferDate": "2022-12-31",
"includesAdditionalConditionForPrice": false,
"hasEstimationForAdditionalPrice": false,
"sellerCustomerParties": [{"partyId": "62701576-2621-4a27-8d2b-63cea492abb6",
"partyTypeCode": "PERSON_PARTY",
"shareOfOwnership": {"divisible": 1,
"divider": 1,
"percentage": 100
}
}
],
"buyerCustomerParties": [{"partyId": "7172e9e1-0beb-49ab-a553-c1c3022d93f3",
"partyTypeCode": "PERSON_PARTY",
"shareOfOwnership": {"divisible": 1,
"divider": 2,
"percentage": 50
},
"transferTaxRequiredCode": "TRANSFER_TAX_REQUIRED"
},
{"partyId": "8a89c381-2188-412f-8226-f07649a90df4",
"partyTypeCode": "ORGANIZATION_PARTY",
"shareOfOwnership": {"divisible": 1,
"divider": 2,
"percentage": 50
}
}
]
}
]
}
}

Response samples

Content type

application/json

{ }

Create a trade settlement correction

This endpoint allows to amend trade settlements which have been completed in the past.

Authorizations:

bearerAuth

path Parameters

tradeSettlementId

required

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

Example: 6d9d4946-d170-4730-b818-37901edb961b

Unique trade settlement identifier in UUID format.

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 details for the trade settlement correction.

tradeDate required	string <date> (tradeDate) The date when the sale deed or other contract is signed.
required	Array of objects non-empty Specifies corrections for the assets of the trade settlement. All assets of the trade settlement must be included in the array.

Responses

Request samples

Payload

Content type

application/json

{"tradeDate": "2019-08-24",
"assets": [{"realtyId": "9fd9124c-e6c1-4368-9f17-6938f0e2f524",
"assetIdentifier": "A6",
"ownershipTransferDate": "2019-08-24",
"price": {"sellingPrice": 190000,
"debtFreePriceAmount": 230000,
"debtAmount": 40000,
"currencyCode": "EUR"
},
"buyerCustomerParties": [{"partyId": "62701576-2621-4a27-8d2b-63cea492abb6",
"shareOfOwnership": {"divisible": 1,
"divider": 3
}
}
],
"sellerCustomerParties": [{"partyId": "62701576-2621-4a27-8d2b-63cea492abb6",
"shareOfOwnership": {"divisible": 1,
"divider": 3
}
}
]
}
]
}

Response samples

Content type

application/json

{ }

Add a related document to trade settlement

Associates a document with the specified trade settlement. The document must already exist in the Document API. If the document is already associated with this trade settlement, a 400 error is returned.

Authorizations:

bearerAuth

path Parameters

tradeSettlementId

required

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

Example: 6d9d4946-d170-4730-b818-37901edb961b

Unique trade settlement identifier in UUID format.

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 document identifier to associate with the trade settlement.

documentId

required

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

Unique identifier of the document to associate with the trade settlement.

Responses

Request samples

Payload

Content type

application/json

{"documentId": "9fd9124c-e6c1-4368-9f17-6938f0e2f524"
}

Response samples

Content type

application/json

{ }

Transfer Terms

Transfer Terms API allows you to create transfer terms document for trade settlement.

Fetch trade settlement's transfer terms contents

Fetch contents of the transfer terms for given trade settlement.

Authorizations:

bearerAuth

path Parameters

tradeSettlementId

required

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

Example: 6d9d4946-d170-4730-b818-37901edb961b

Unique trade settlement identifier in UUID format.

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

{"tradeSettlementId": "2bad0571-1d9e-49b6-af7a-61ab73f330b6",
"transferTermsContent": "# **KAUPAN EHDOT**\r\n\r\n\r\n\r\n# KAUPAN OSAPUOLET\r\n\r\n\r\n\r\n**Myyjä:** Etunimi Sukunimi\r\n\r\n**Henkilötunnus:**...",
"transferTermsDocumentId": "20a61558-71a7-4672-9533-8b3b8a5812dc",
"transferTermsContentModificationTime": "2024-08-24T14:59:22Z",
"transferTermsDocumentCreationTime": "2024-08-24T15:01:22Z"
}

Save a contents of a transfer terms

Save contents of transfer terms for given trade settlement. Note: Related transfer terms PDF document is not updated automatically.

Authorizations:

bearerAuth

path Parameters

tradeSettlementId

required

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

Example: 6d9d4946-d170-4730-b818-37901edb961b

Unique trade settlement identifier in UUID format.

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 content of the transfer terms.

transferTermsContent

required

string

JSON escaped markdown content for transfer terms.

Responses

Request samples

Payload

Content type

application/json

{"transferTermsContent": "# **KAUPAN EHDOT**\r\n\r\n\r\n\r\n# KAUPAN OSAPUOLET\r\n\r\n\r\n\r\n**Myyjä:**..."
}

Response samples

Content type

application/json

{ }

Generate and save PDF using transfer terms content

Generates a PDF document using transfer terms content and saves it to Document API. If trade settlement has existing transfer terms PDF it will be overwritten.

Authorizations:

bearerAuth

path Parameters

tradeSettlementId

required

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

Example: 6d9d4946-d170-4730-b818-37901edb961b

Unique trade settlement identifier in UUID format.

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

Empty body

object (PostTransferTermsDocument)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{"transferTermsDocumentId": "77ac2031-8c8f-43e1-8ab6-6f0dd7c1d1d6"
}

Rental Settlement

Rental Settlement API allows you to initiate and complete a rental settlement for a set of assets.

Create a rental settlement

Create a new rental settlement.

Authorizations:

bearerAuth

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 details for the rental settlement.

required	object (RentalSettlement) Details for the rental settlement.
sourceSystemCreationTime	string <date-time> (SourceSystemCreationTime) Timestamp as defined by ISO 8601 with time offset. Creation time of the party in the source system. Intended to be used in data migration scenarios.

Responses

Request samples

Payload

Content type

application/json

{"rentalSettlement": {"agencyOfficeId": "7bdffe48-0077-4de0-acd4-d9b9b1ab49f8",
"agents": [{"agentId": "5d2a6d47-da73-4b11-8940-27cffabb6de5",
"roleCode": "RESPONSIBLE_AGENT"
}
],
"rental": {"assignmentId": "9238cf7b-b86a-49a5-b54f-cbdfcd03e9c9",
"assignmentStartDate": "2023-10-31",
"marketingTimeInDays": 16,
"rentalDate": "2023-11-18",
"rentalStartDate": "2023-12-31",
"description": "Vuokrasopimuksessa useampi vuokranantaja"
},
"lessorCustomerParties": [{"partyId": "62701576-2621-4a27-8d2b-63cea492abb6",
"partyTypeCode": "PERSON_PARTY"
},
{"partyId": "fed513ce-2626-447d-91ad-d8788dc89447",
"partyTypeCode": "PERSON_PARTY"
}
],
"tenantCustomerParties": [{"partyId": "a4f0f4d1-aa16-4bc7-92ce-7edac11085fc",
"partyTypeCode": "PERSON_PARTY",
"underageTenant": true,
"guardianParties": [{"partyId": "ddf2c76a-d9f8-446a-b80f-c781736dab89",
"partyTypeCode": "PERSON_PARTY"
}
]
}
],
"otherResidentDescription": "Kolme lasta",
"assets": [{"realtyId": "9fd9124c-e6c1-4368-9f17-6938f0e2f524",
"realtyTypeCode": "RESIDENTIAL_SHARE",
"subcategoryCode": "SHARE",
"address": {"addressLine1": "Yliopistonkatu 55",
"stairwell": "C",
"apartmentNumber": "55",
"postcode": "33100",
"postalArea": "Tampere",
"localityName": "Tampere",
"localityCode": "FI_PIRKANMAA_TAMPERE",
"regionCode": "FI_PIRKANMAA",
"countryCode": "FI"
},
"rentalPrice": {"monthlyRent": 890,
"currencyCode": "EUR"
}
}
]
}
}

Response samples

Content type

application/json

{"rentalSettlementId": "48978afa-bebb-4226-8ff0-c38ec5e05512"
}

Search rental settlements

Search rental settlements matching specified query parameters. You can combine the search criteria, for example to search for completed rental settlements by a specified agency office.

Authorizations:

bearerAuth

query Parameters

rentalSettlementId	Array of strings <uuid> (RentalSettlementId) [ items <uuid >^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... ] Example: rentalSettlementId=48978afa-bebb-4226-8ff0-c38ec5e05512 Search by rental settlement identifiers to get a list of rental settlements.
realtyId	string <uuid> Example: realtyId=b482a6a0-34cb-41e1-9817-1f734d7d3a06 Search by realty identifier to get a list of rental settlements for the realty.
agentId	string <uuid> (AgentId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: agentId=5d2a6d47-da73-4b11-8940-27cffabb6de5 Search by the agent identifier to get a list of rental settlements the for agent.
agencyOfficeId	Array of strings <uuid> (AgencyOfficeId) [ items <uuid >^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... ] Example: agencyOfficeId=212114ec-819e-483c-a8e0-f82289ac6e19 Search by the agency office identifiers to get a list of rental settlements that belong to certain agency offices.
statusCode	Array of strings (RentalSettlementStatusCode) Items Enum: "IN_PROGRESS" "COMPLETED" "DISMANTLED" Example: statusCode=COMPLETED Search by the status code to fetch rental settlements having specific statuses.
modifiedAfter	string <date-time> (Timestamp) Example: modifiedAfter=2024-09-05T13:50:22.204Z Search by a timestamp to get a list of rental settlements which were modified after the specified time.
startIndex	integer <int32> >= 0 Default: 0 Example: startIndex=20 Return rental settlements starting from this index. Index starts from 0.
size	integer <int32> [ 1 .. 100 ] Default: 50 Example: size=40 Specify the maximum number of items to return for this request.
sort	Array of strings[ items^(creationTime\|modificationTime)\\|(asc\|ASC\|de... ] Example: sort=creationTime\|desc Sort rental settlements based on the specified fields. Each field to be sorted must also include a sort order as follows: `sort={fieldName}\|{asc\|desc}&sort={anotherFieldName}\|{asc\|desc}`

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

{"totalCount": 8,
"rentalSettlements": [{"rentalSettlementId": "48978afa-bebb-4226-8ff0-c38ec5e05512",
"statusCode": "IN_PROGRESS",
"agencyOfficeId": "7bdffe48-0077-4de0-acd4-d9b9b1ab49f8",
"agents": [{"agentId": "5d2a6d47-da73-4b11-8940-27cffabb6de5",
"roleCode": "RESPONSIBLE_AGENT"
}
],
"assignmentId": "9238cf7b-b86a-49a5-b54f-cbdfcd03e9c9",
"rentalDate": "2022-12-31",
"assets": [{"realtyId": "9fd9124c-e6c1-4368-9f17-6938f0e2f524",
"realtyTypeCode": "RESIDENTIAL_SHARE",
"subcategoryCode": "SHARE",
"address": {"addressLine1": "Yliopistonkatu 55",
"stairwell": "C",
"apartmentNumber": "55",
"postcode": "33100",
"postalArea": "Tampere",
"localityName": "Tampere",
"localityCode": "FI_PIRKANMAA_TAMPERE",
"regionCode": "FI_PIRKANMAA",
"countryCode": "FI"
},
"rentalPrice": {"monthlyRent": 690,
"currencyCode": "EUR"
}
}
],
"creationTime": "2023-11-17T17:23:08Z",
"modificationTime": "2023-11-19T13:32:28Z"
}
]
}

Fetch a rental settlement

Fetch details for the specified rental settlement.

Authorizations:

bearerAuth

path Parameters

rentalSettlementId

required

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

Example: a82e4fdd-a3d8-440b-987c-b1c24f62d3b6

Unique rental settlement identifier in UUID format.

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

{"rentalSettlementId": "48978afa-bebb-4226-8ff0-c38ec5e05512",
"statusCode": "IN_PROGRESS",
"rentalSettlement": {"agencyOfficeId": "7bdffe48-0077-4de0-acd4-d9b9b1ab49f8",
"agents": [{"agentId": "5d2a6d47-da73-4b11-8940-27cffabb6de5",
"roleCode": "RESPONSIBLE_AGENT"
}
],
"rental": {"assignmentId": "9238cf7b-b86a-49a5-b54f-cbdfcd03e9c9",
"assignmentStartDate": "2023-10-31",
"marketingTimeInDays": 16,
"rentalDate": "2023-11-18",
"rentalStartDate": "2023-12-31",
"description": "Vuokrasopimuksessa useampi vuokranantaja"
},
"lessorCustomerParties": [{"partyId": "62701576-2621-4a27-8d2b-63cea492abb6",
"partyTypeCode": "PERSON_PARTY"
},
{"partyId": "fed513ce-2626-447d-91ad-d8788dc89447",
"partyTypeCode": "PERSON_PARTY"
}
],
"tenantCustomerParties": [{"partyId": "a4f0f4d1-aa16-4bc7-92ce-7edac11085fc",
"partyTypeCode": "PERSON_PARTY",
"underageTenant": true,
"guardianParties": [{"partyId": "ddf2c76a-d9f8-446a-b80f-c781736dab89",
"partyTypeCode": "PERSON_PARTY"
}
]
}
],
"otherResidentDescription": "Kolme lasta",
"assets": [{"realtyId": "9fd9124c-e6c1-4368-9f17-6938f0e2f524",
"realtyTypeCode": "RESIDENTIAL_SHARE",
"subcategoryCode": "SHARE",
"address": {"addressLine1": "Yliopistonkatu 55",
"stairwell": "C",
"apartmentNumber": "55",
"postcode": "33100",
"postalArea": "Tampere",
"localityName": "Tampere",
"localityCode": "FI_PIRKANMAA_TAMPERE",
"regionCode": "FI_PIRKANMAA",
"countryCode": "FI"
},
"rentalPrice": {"monthlyRent": 890,
"currencyCode": "EUR"
}
}
]
},
"creationTime": "2023-11-17T17:23:08Z",
"modificationTime": "2023-11-19T13:32:28Z"
}

Update a rental settlement

Update details for the specified rental settlement. The rental settlement contents can be updated only if it is in a IN_PROGRESS state.

Authorizations:

bearerAuth

path Parameters

rentalSettlementId

required

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

Example: a82e4fdd-a3d8-440b-987c-b1c24f62d3b6

Unique rental settlement identifier in UUID format.

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 details for the rental settlement.

rentalSettlementId	string <uuid> (RentalSettlementId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... A unique id that identifies the rental settlement.
statusCode	string (RentalSettlementStatusCode) Enum: "IN_PROGRESS" "COMPLETED" "DISMANTLED" Rental settlement status. The status defines what actions can be performed for rental settlement. Possible values are: `IN_PROGRESS`. The rental settlement has been initiated and can be modified. `COMPLETED`. The rental settlement has been completed. A completed rental settlement cannot be modified. If a change is required, the rental settlement must be dismantled. `DISMANTLED`. The rental settlement has been dismantled.
required	object (RentalSettlement) Details for the rental settlement.

Responses

Request samples

Payload

Content type

application/json

{"rentalSettlementId": "48978afa-bebb-4226-8ff0-c38ec5e05512",
"statusCode": "IN_PROGRESS",
"rentalSettlement": {"agencyOfficeId": "7bdffe48-0077-4de0-acd4-d9b9b1ab49f8",
"agents": [{"agentId": "5d2a6d47-da73-4b11-8940-27cffabb6de5",
"roleCode": "RESPONSIBLE_AGENT"
}
],
"rental": {"assignmentId": "9238cf7b-b86a-49a5-b54f-cbdfcd03e9c9",
"assignmentStartDate": "2023-10-31",
"marketingTimeInDays": 16,
"rentalDate": "2023-11-18",
"rentalStartDate": "2023-12-31",
"description": "Vuokrasopimuksessa useampi vuokranantaja"
},
"lessorCustomerParties": [{"partyId": "62701576-2621-4a27-8d2b-63cea492abb6",
"partyTypeCode": "PERSON_PARTY"
},
{"partyId": "fed513ce-2626-447d-91ad-d8788dc89447",
"partyTypeCode": "PERSON_PARTY"
}
],
"tenantCustomerParties": [{"partyId": "a4f0f4d1-aa16-4bc7-92ce-7edac11085fc",
"partyTypeCode": "PERSON_PARTY",
"underageTenant": true,
"guardianParties": [{"partyId": "ddf2c76a-d9f8-446a-b80f-c781736dab89",
"partyTypeCode": "PERSON_PARTY"
}
]
}
],
"otherResidentDescription": "Kolme lasta",
"assets": [{"realtyId": "9fd9124c-e6c1-4368-9f17-6938f0e2f524",
"realtyTypeCode": "RESIDENTIAL_SHARE",
"subcategoryCode": "SHARE",
"address": {"addressLine1": "Yliopistonkatu 55",
"stairwell": "C",
"apartmentNumber": "55",
"postcode": "33100",
"postalArea": "Tampere",
"localityName": "Tampere",
"localityCode": "FI_PIRKANMAA_TAMPERE",
"regionCode": "FI_PIRKANMAA",
"countryCode": "FI"
},
"rentalPrice": {"monthlyRent": 890,
"currencyCode": "EUR"
}
}
]
}
}

Response samples

Content type

application/json

{ }

Lease Agreement

Lease Agreement API allows you to create lease agreement document for rental settlement.

Fetch rental settlement's lease agreement contents

Fetch contents of the lease agreement for given rental settlement.

Authorizations:

bearerAuth

path Parameters

rentalSettlementId

required

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

Example: a82e4fdd-a3d8-440b-987c-b1c24f62d3b6

Unique rental settlement identifier in UUID format.

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

{"rentalSettlementId": "2bad0571-1d9e-49b6-af7a-61ab73f330b6",
"leaseAgreementContent": "# **VUOKRASOPIMUS**\r\n\r\n\r\n\r\n# OSAPUOLET\r\n\r\n\r\n\r\n**Vuokraaja:** Etunimi Sukunimi\r\n\r\n**Henkilötunnus:**...",
"leaseAgreementDocumentId": "20a61558-71a7-4672-9533-8b3b8a5812dc",
"leaseAgreementContentModificationTime": "2024-08-24T14:59:22Z",
"leaseAgreementDocumentCreationTime": "2024-08-24T15:01:22Z"
}

Save contents of a lease agreement

Save contents of lease agreement for given rental settlement. Note: Related lease agreement PDF document is not updated automatically.

Authorizations:

bearerAuth

path Parameters

rentalSettlementId

required

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

Example: a82e4fdd-a3d8-440b-987c-b1c24f62d3b6

Unique rental settlement identifier in UUID format.

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 content of the lease agreement.

leaseAgreementContent

required

string

JSON escaped markdown content for lease agreement.

Responses

Request samples

Payload

Content type

application/json

{"leaseAgreementContent": "# **KAUPPAKIRJA**\r\n\r\n\r\n\r\n# KAUPAN OSAPUOLET\r\n\r\n\r\n\r\n**Myyjä:**..."
}

Response samples

Content type

application/json

{ }

Generate and save PDF using lease agreement content

Generates a PDF document using lease agreement content and saves it to Document API. If rental settlement has existing lease agreement PDF it will be overwritten.

Authorizations:

bearerAuth

path Parameters

rentalSettlementId

required

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

Example: a82e4fdd-a3d8-440b-987c-b1c24f62d3b6

Unique rental settlement identifier in UUID format.

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

Empty body

object (PostLeaseAgreementDocument)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{"leaseAgreementDocumentId": "77ac2031-8c8f-43e1-8ab6-6f0dd7c1d1d6"
}

Transfer Tax Return

Transfer tax return API allows you to file transfer tax return for trade settlement buyers.

Fetch transfer tax statuses

Fetch list of trade settlement buyers (taxpayers) with their transfer tax return statuses. The endpoint returns all buyers regardless of whether they have filed transfer tax return or not.

Authorizations:

bearerAuth

path Parameters

tradeSettlementId

required

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

Example: 6d9d4946-d170-4730-b818-37901edb961b

Unique trade settlement identifier in UUID format.

query Parameters

taxpayerPartyId

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

Example: taxpayerPartyId=15bd5398-420e-461f-884f-4af99b3d05d6

Unique taxpayer buyer party identifier in UUID format.

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

{"tradeSettlementId": "1397e367-b49c-4d4b-b624-9d0ee97e3a93",
"tradeSettlementCorrectionTime": "2025-01-15T10:30:00Z",
"taxpayerParties": [{"party": {"partyId": "50b0517e-4bc6-447f-8013-9dded9f3fdb2",
"partyTypeCode": "PERSON_PARTY",
"name": "Veikko Viljanen"
},
"transferTaxPayment": {"paymentReferenceNumber": "mcio3n3e309d3d13er44225deo",
"totalTransferTaxAmount": 1234.56,
"currencyCode": "EUR"
},
"transferTaxReturns": [{"transferTaxReturnId": "97cfcf15-679a-4f49-91fc-5bf8951ffcc2",
"receiptDocumentId": "5be9dc64-807b-459a-b7f0-663857f05385",
"acceptedTime": "2021-09-21T17:32:28Z"
},
{"transferTaxReturnId": "72393117-853f-4d60-a282-3aeab8018a15",
"receiptDocumentId": "6be9dc64-807b-459a-b7f0-663857f05386",
"acceptedTime": "2021-09-23T15:12:28Z"
}
]
},
{"party": {"partyId": "fae961b8-34f5-41b5-8b12-403f5c143d42",
"partyTypeCode": "PERSON_PARTY",
"name": "Virpi Viljanen"
},
"transferTaxPayment": {"paymentReferenceNumber": "mcio3n3e309d3d13er44225deo",
"totalTransferTaxAmount": 5678.9,
"currencyCode": "EUR"
},
"transferTaxReturns": [ ]
}
]
}

Fetch transfer tax return preview

Fetch transfer tax return preview for the specified party in specified trade settlement. The transferTaxReturnFilingV1 element in response body is specified and required by Finnish tax authority.

Authorizations:

bearerAuth

path Parameters

tradeSettlementId

required

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

Example: 6d9d4946-d170-4730-b818-37901edb961b

Unique trade settlement identifier in UUID format.

query Parameters

taxpayerPartyId

required

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

Example: taxpayerPartyId=15bd5398-420e-461f-884f-4af99b3d05d6

Unique taxpayer buyer party identifier in UUID format.

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

{"tradeSettlementId": "82570f0d-39cf-4306-a0d3-65d4415e8e7a",
"taxpayerPartyId": "15bd5398-420e-461f-884f-4af99b3d05d6",
"transferTaxReturnFilingV1": {"ReplacementReturn": true,
"PreviousReturnKey": "1234567890",
"Sender": 1,
"BuyerID": "310183-123A",
"BuyerDateOfBirth": "1980-01-31",
"BuyerIndividualForeignID": "1234567890",
"BuyerName": "Matti Meikäläinen",
"RealEstateAgencyID": "FI12345678",
"RealEstateAgencyName": "Asuntovälitys Oy",
"AgencyContactPersonName": "Anna Asuntonen",
"RealEstateAgencyPhone": "0401234567",
"RealEstateAgencyAddress": "Esimerkkikatu 123",
"RealEstateAgencyPostCode": "00100",
"SigningDate": "2023-10-11",
"TransferType": 1,
"AdvanceRuling": false,
"AssetDetails": [{"Asset": 1,
"AcquiredPortionFractions": "1/2",
"AcquiredPortionPercentage": 50,
"CompanyID": "1234567-8",
"CompanyName": "AS Oy Taloyhtiö",
"ShareNumbers": "123-456",
"AreaM2": 100.5,
"QuantityOfShares": 10,
"ResidentialID": "ASD123",
"NewConstruction": true,
"OwnershipTransferDate": "2023-11-01",
"BuyerShareSellingPrice": 500000,
"BuyerShareLoan": 200000,
"BuyerShareSellerHouseLoan": 100000,
"BuyerShareSellerDebt": 50000,
"BuyerShareOtherCompensation": 0,
"AddSellingPrice": true,
"AdditionalSellingPrice": [{"AddSellingPriceWhenClarified": false,
"BuyerShareAddSellingPrice": 10000,
"AddSellingPriceClarifiedDate": "2023-11-01"
},
{"AddSellingPriceWhenClarified": true,
"BuyerShareAddSellingPrice": 20000,
"AddSellingPriceClarifiedDate": "2023-11-15"
}
],
"BuyerShareTotalSellingPrice": 250000,
"AmountTransferTax": 10000,
"SellerDetails": [{"SellerIndividualOrCorporate": 1,
"SellerID": "010191-123B",
"SellerDateOfBirth": "1991-01-01",
"SellerIndividualForeignID": "0987654321",
"SellerName": "Maija Myyjäinen",
"InterestCorporateBuyerIndividualSeller": true,
"InterestIndividualBuyerCorporateSeller": false,
"InterestCorporateBuyerSeller": false,
"SellerOwnershipShareFractions": "1/1",
"SellerOwnershipSharePercentage": 100,
"NonresidentSellerBuyer": false
}
],
"FirstTimeHomebuyer": [{"Conditions": 1,
"PortionOfSellingPrice": 250000
}
]
}
]
}
}

File transfer tax return

File transfer tax return for trade settlement buyer party. In addition to the validation performed by this endpoint, the Finnish tax authority API will perform additional validation and may reject the filing. In case of rejection, 400 INVALID_ENTITY_STATE error is returned including rejection reasons in the errors field of the response body.

Authorizations:

bearerAuth

path Parameters

tradeSettlementId

required

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

Example: 6d9d4946-d170-4730-b818-37901edb961b

Unique trade settlement identifier in UUID format.

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

taxpayerPartyId required	string <uuid> (TaxpayerPartyId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... The unique identifier of the taxpayer party.
replacedReturnId	string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... When executing a replacement filing this is the unique identifier of the transfer tax return which is being replaced. The value must reference to the most recent return of the trade settlement buyer.

Responses

Request samples

Payload

Content type

application/json

{"taxpayerPartyId": "8fa1f7a6-db1d-41c7-b074-3e08bb10aff8",
"replacedReturnId": "03c56d7e-b03c-4aac-850d-3f735c6ed145"
}

Response samples

Content type

application/json

{"transferTaxReturnId": "73aa1c0d-8fa3-4a9b-b987-ef34a8cce12d"
}

Fetch transfer tax return

Fetch transfer tax return data which was filed to tax authority. The transferTaxReturnFilingV1 element in response body is specified and required by Finnish tax authority.

Authorizations:

bearerAuth

path Parameters

tradeSettlementId required	string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: 6d9d4946-d170-4730-b818-37901edb961b Unique trade settlement identifier in UUID format.
transferTaxReturnId required	string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: 374c97dc-6a08-43ea-b1f7-371509726634 Unique transfer tax return identifier in UUID format.

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

{"transferTaxReturnId": "8c0a1ec6-b81e-442d-a960-a7f739f74fa9",
"tradeSettlementId": "82570f0d-39cf-4306-a0d3-65d4415e8e7a",
"taxpayerPartyId": "15bd5398-420e-461f-884f-4af99b3d05d6",
"veroId": "abcd1234",
"acceptedTime": "2023-12-11T12:00:00.000Z",
"receiptDocumentId": "6726d5d6-b591-496f-9d4e-b5adbbb3f100",
"transferTaxReturnFilingV1": {"ReplacementReturn": true,
"PreviousReturnKey": "1234567890",
"Sender": 1,
"BuyerID": "310183-123A",
"BuyerDateOfBirth": "1980-01-31",
"BuyerIndividualForeignID": "1234567890",
"BuyerName": "Matti Meikäläinen",
"RealEstateAgencyID": "FI12345678",
"RealEstateAgencyName": "Asuntovälitys Oy",
"AgencyContactPersonName": "Anna Asuntonen",
"RealEstateAgencyPhone": "0401234567",
"RealEstateAgencyAddress": "Esimerkkikatu 123",
"RealEstateAgencyPostCode": "00100",
"SigningDate": "2023-10-11",
"TransferType": 1,
"AdvanceRuling": false,
"AssetDetails": [{"Asset": 1,
"AcquiredPortionFractions": "1/2",
"AcquiredPortionPercentage": 50,
"CompanyID": "1234567-8",
"CompanyName": "AS Oy Taloyhtiö",
"ShareNumbers": "123-456",
"AreaM2": 100.5,
"QuantityOfShares": 10,
"ResidentialID": "ASD123",
"NewConstruction": true,
"OwnershipTransferDate": "2023-11-01",
"BuyerShareSellingPrice": 500000,
"BuyerShareLoan": 200000,
"BuyerShareSellerHouseLoan": 100000,
"BuyerShareSellerDebt": 50000,
"BuyerShareOtherCompensation": 0,
"AddSellingPrice": true,
"AdditionalSellingPrice": [{"AddSellingPriceWhenClarified": false,
"BuyerShareAddSellingPrice": 10000,
"AddSellingPriceClarifiedDate": "2023-11-01"
},
{"AddSellingPriceWhenClarified": true,
"BuyerShareAddSellingPrice": 20000,
"AddSellingPriceClarifiedDate": "2023-11-15"
}
],
"BuyerShareTotalSellingPrice": 250000,
"AmountTransferTax": 10000,
"SellerDetails": [{"SellerIndividualOrCorporate": 1,
"SellerID": "010191-123B",
"SellerDateOfBirth": "1991-01-01",
"SellerIndividualForeignID": "0987654321",
"SellerName": "Maija Myyjäinen",
"InterestCorporateBuyerIndividualSeller": true,
"InterestIndividualBuyerCorporateSeller": false,
"InterestCorporateBuyerSeller": false,
"SellerOwnershipShareFractions": "1/1",
"SellerOwnershipSharePercentage": 100,
"NonresidentSellerBuyer": false
}
],
"FirstTimeHomebuyer": [{"Conditions": 1,
"PortionOfSellingPrice": 250000
}
]
}
]
}
}

Fetch transfer tax payment reference

Fetch transfer tax payment reference for specified party. The reference is fetched from third party service and request may fail if the service is down.

Authorizations:

bearerAuth

query Parameters

taxpayerPartyId

required

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

Example: taxpayerPartyId=15bd5398-420e-461f-884f-4af99b3d05d6

Unique taxpayer buyer party identifier in UUID format.

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

{"taxpayerPartyId": "8fa1f7a6-db1d-41c7-b074-3e08bb10aff8",
"referenceNumber": "mcio3n3e309d3d13er44225deo"
}

Trade Date

Admin endpoint for correcting trade date for completed trades

Admin endpoint for correcting trade date for completed trades.

Authorizations:

bearerAuth

path Parameters

tradeSettlementId

required

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

Example: 6d9d4946-d170-4730-b818-37901edb961b

Unique trade settlement identifier in UUID format.

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 new trade date used for correcting existing trade date of completed trade.

tradeDate

required

string <date>

Timestamp when the completed trade date is corrected.

Responses

Request samples

Payload

Content type

application/json

{"tradeDate": "2024-11-01"
}

Response samples

Content type

application/json

{ }

Clearing API (v1)

Introduction

Contact

Trade Settlement

Search trade settlements

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Create a trade settlement

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Fetch a trade settlement

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update a trade settlement

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create a trade settlement correction

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Add a related document to trade settlement

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Remove a related document from trade settlement

Authorizations:

path Parameters

query Parameters

header Parameters

Responses

Response samples

Transfer Terms

Fetch trade settlement's transfer terms contents

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Save a contents of a transfer terms

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Generate and save PDF using transfer terms content

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Rental Settlement

Create a rental settlement

Authorizations:

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required