Search
K
Provisionsabrechnung

Provisionsabrechnung

1.0.0OAS 3.0

Rechnet die Courtage nach erfolgreicher Vermittlung ab: Abrechnung erzeugen,
Rechnung abrufen, Zahlungseingang verbuchen.

Die Provision entsteht mit dem Zustandekommen des Hauptvertrags. Beim Verkauf
von Wohnungen und Einfamilienhäusern an Verbraucher gilt das Prinzip der
geteilten Courtage – die API prüft die Aufteilung beim Anlegen der Abrechnung.

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

    Produktion

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

    Sandbox

Security
apiKey (apiKey)

Jeder Aufruf trägt einen API-Schlüssel im Header apikey. Den Schlüssel
erzeugen Sie im Maklerportal unter “Meine Anwendungen”; er wird genau einmal
angezeigt.

An jedem Schlüssel hängen die Scopes, die er nutzen darf. Fehlt einer,
antwortet die API mit 403 und code: "scope_fehlt"; der fehlende Scope
steht in details[].feld.

Additional Information
Contact API-Support Objektwerk GmbH (api-support@objektwerk.example)

Abrechnungen

Abrechnungen auflisten

get

Query Parameters

statusstring

Allowed values:entwurfoffenteilweise_bezahltbezahltstorniert

Example:offen

objekt_idstring

Example:obj_8f2c1a

zeitraum_vonstring(date)
zeitraum_bisstring(date)

Response

application/json

Trefferliste

datenarray[object]
Show Child Parameters
seiteobject

Cursor-basierte Paginierung.

Show Child Parameters
get/abrechnungen
 
application/json

Abrechnung erstellen

Erzeugt die Abrechnung zu einem abgeschlossenen Vermittlungsvorgang.
Grundlage ist der beurkundete Kaufpreis bzw. die vereinbarte Miete.

post

Body

application/json

AbrechnungAnlegen

objekt_idstringrequired

Example:obj_8f2c1a

geschaeftsartstringrequired

Allowed values:verkaufvermietunggewerbevermietung

Example:verkauf

bemessungsgrundlage_eurintegerrequired

Beurkundeter Kaufpreis bzw. Jahresnettokaltmiete.

Example:645000

kaeufer_prozentnumber(float)required

Example:3.57

verkaeufer_prozentnumber(float)

Example:3.57

vertragsdatumstring(date)required

Example:2026-08-14

kaeuferobject
Show Child Parameters
verkaeuferobject
Show Child Parameters

Response

application/json

Erstellt

Abrechnung

idstring

Example:abr_7c53

objekt_idstring

Example:obj_8f2c1a

statusstring

Allowed values:entwurfoffenteilweise_bezahltbezahltstorniert

Example:offen

geschaeftsartstring

Allowed values:verkaufvermietunggewerbevermietung

Example:verkauf

bemessungsgrundlage_eurinteger

Example:645000

positionenarray[object]
Show Child Parameters
rechnung_idstring

Example:rec_a920

faellig_amstring(date)

Example:2026-08-28

bezahlt_eurnumber(float)

Example:0

erstellt_amstring(date-time)

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

post/abrechnungen

Body

{ "objekt_id": "obj_8f2c1a", "geschaeftsart": "verkauf", "bemessungsgrundlage_eur": 645000, "kaeufer_prozent": 3.57, "verkaeufer_prozent": 3.57, "vertragsdatum": "2026-08-14", "kaeufer": { "name": "Anna Bergmann", "interessent_id": "int_71ab" } }
 
application/json

Abrechnung abrufen

get

Path Parameters

abrechnungIdstringrequired

Example:abr_7c53

Response

application/json

Abrechnung

Abrechnung

idstring

Example:abr_7c53

objekt_idstring

Example:obj_8f2c1a

statusstring

Allowed values:entwurfoffenteilweise_bezahltbezahltstorniert

Example:offen

geschaeftsartstring

Allowed values:verkaufvermietunggewerbevermietung

Example:verkauf

bemessungsgrundlage_eurinteger

Example:645000

positionenarray[object]
Show Child Parameters
rechnung_idstring

Example:rec_a920

faellig_amstring(date)

Example:2026-08-28

bezahlt_eurnumber(float)

Example:0

erstellt_amstring(date-time)

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

get/abrechnungen/{abrechnungId}
 
application/json