Search
K
Commission Settlement

Commission Settlement

1.0.0OAS 3.0

Settles the commission after a transaction closes successfully: create a
settlement, retrieve the invoice, record incoming payments.

The commission arises once the main contract is concluded. For a regulated
consumer transaction - such as the sale of an apartment or single-family home
to a consumer - a split-commission principle typically applies, requiring the
buyer’s share not to exceed the seller’s share. The API validates the split
when a settlement is created.

API Base URL
  • Server 1:https://api.realestateagency.example/v1

    Production

  • Server 2:https://sandbox.api.realestateagency.example/v1

    Sandbox

Security
apiKey (apiKey)

Every call carries an API key in the apikey header. You generate the
key in the Real Estate portal under “My Apps”; it’s shown exactly once.

Each key has the scopes it’s allowed to use attached to it. If one is
missing, the API responds with 403 and code: "scope_missing"; the
missing scope is in details[].field.

Additional Information
Contact API Support - Real Estate Agency (api-support@realestateagency.example)

Settlements

List settlements

get

Query Parameters

statusstring

Allowed values:draftopenpartially_paidpaidcanceled

Example:open

property_idstring

Example:prop_8f2c1a

period_fromstring(date)
period_tostring(date)

Response

application/json

Results list

dataarray[object]
Show Child Parameters
pageobject

Cursor-based pagination.

Show Child Parameters
get/settlements
 
application/json

Create a settlement

Creates the settlement for a completed transaction. The basis is the
notarized purchase price, or the agreed rent.

post

Body

application/json

SettlementCreate

property_idstringrequired

Example:prop_8f2c1a

deal_typestringrequired

Allowed values:salerentalcommercial_rental

Example:sale

assessment_basis_eurintegerrequired

Notarized purchase price, or annual net cold rent.

Example:645000

buyer_percentnumber(float)required

Example:3.57

seller_percentnumber(float)

Example:3.57

contract_datestring(date)required

Example:2026-08-14

buyerobject
Show Child Parameters
sellerobject
Show Child Parameters

Response

application/json

Created

Settlement

idstring

Example:stl_7c53

property_idstring

Example:prop_8f2c1a

statusstring

Allowed values:draftopenpartially_paidpaidcanceled

Example:open

deal_typestring

Allowed values:salerentalcommercial_rental

Example:sale

assessment_basis_eurinteger

Example:645000

line_itemsarray[object]
Show Child Parameters
invoice_idstring

Example:inv_a920

due_datestring(date)

Example:2026-08-28

paid_eurnumber(float)

Example:0

created_atstring(date-time)

Example:2026-08-15T07:30:00Z

post/settlements

Body

{ "property_id": "prop_8f2c1a", "deal_type": "sale", "assessment_basis_eur": 645000, "buyer_percent": 3.57, "seller_percent": 3.57, "contract_date": "2026-08-14", "buyer": { "name": "Anna Bergman", "prospect_id": "lead_71ab" } }
 
application/json

Retrieve a settlement

get

Path Parameters

settlementIdstringrequired

Example:stl_7c53

Response

application/json

Settlement

Settlement

idstring

Example:stl_7c53

property_idstring

Example:prop_8f2c1a

statusstring

Allowed values:draftopenpartially_paidpaidcanceled

Example:open

deal_typestring

Allowed values:salerentalcommercial_rental

Example:sale

assessment_basis_eurinteger

Example:645000

line_itemsarray[object]
Show Child Parameters
invoice_idstring

Example:inv_a920

due_datestring(date)

Example:2026-08-28

paid_eurnumber(float)

Example:0

created_atstring(date-time)

Example:2026-08-15T07:30:00Z

get/settlements/{settlementId}
 
application/json