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