Commission Settlement

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

Record a payment

Partial payments are allowed; the status only moves to paid once the balance is settled in full.

post

Path Parameters

settlementIdstringrequired

Example:stl_7c53

Body

application/json
amount_eurnumber(float)required

Example:23030.5

value_datestring(date)required

Example:2026-08-26

referencestring

Example:INV-2026-0418

Response

application/json

Recorded

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/{settlementId}/payments

Body

{ "amount_eur": 23030.5, "value_date": "2026-08-26" }
 
application/json

Invoices

Download an invoice as PDF

get

Path Parameters

invoiceIdstringrequired

Example:inv_a920

Response

application/pdf

PDF document

string
get/invoices/{invoiceId}/pdf
 
application/pdf