settlementIdstringrequired
Example:stl_7c53
Record a payment
Partial payments are allowed; the status only moves to paid once the balance is settled in full.
post
Path Parameters
Body
application/json
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
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
Authentication
Path Parameters
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
Response
application/pdf
PDF document
string
get/invoices/{invoiceId}/pdf
Authentication
Path Parameters
application/pdf
Commission
Calculate a commission upfront
Runs a commission calculation without creating a settlement - useful for
sales conversations and for the figure shown in the listing.
post
Body
application/json
Body
application/json
assessment_basis_eurintegerrequired
Example:645000
buyer_percentnumber(float)required
Example:3.57
seller_percentnumber(float)
Example:3.57
tax_percentnumber(float)
Default:19
Response
application/json
Response
application/json
Calculation
line_itemsarray[object]
Show Child Parameters
gross_total_eurnumber(float)
Example:46061
post/commission/calculator
Authentication
Body
{
"assessment_basis_eur": 645000,
"buyer_percent": 3.57
}
application/json