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