Deals

Ein Deal ist eine Beziehung zwischen einem Interessenten und einem Objekt und beschreibt in welcher Phase sich der Interessent im Verkaufsprozess befindet.

Attribut

Typ

Beschreibung

broker_id

integer

Besitzer des Deals

client_id

integer

ID zum Interessenten (Kontakt)

property_id

integer

ID zum Objekt

project_id

integer

ID zum Projekt (muss nicht selber gesetzt werden, wird über das Objekt automatisch gesetzt)

deal_stage_id

integer

ID zur Deal-Phase

deal_pipeline_id

integer

ID zur Deal-Pipeline (muss nicht selber gesetzt werden, wird über die Deal-Phase automatisch gesetzt)

date

date

Datum des Deals

price

float

(voraussichtlicher) realisierter Preis des Deals

note

string

Interne Notiz zum Deal

get
Deals lesen

https://api.propstack.de/v1/client_properties
Request
Response
Request
Query Parameters
include
optional
string
Liste von möglichen Assoziationen, die in der Antwort mit übergeben werden (kommagetrennt). Kann den Wert client und/oder property haben
reservation_reason_ids
optional
array
Array aus Absagegründen (dessen IDs), um nur verlorene Deals mit bestimmten Absagegründen aufzurufen
category
optional
string
Art des Deals. Kann eines von qualified, unqualified, lost sein
deal_stage_ids
optional
array
Array aus IDs, um nur Deals in bestimmten Phasen aufzurufen.
deal_pipeline_id
optional
integer
Nur Deals aus einer bestimmten Pipeline aufrufen
project_id
optional
integer
ID eines Projektes, um nur Deals mit Objekten, die zu dem Projekt gehören, aufzurufen
broker_id
optional
integer
ID eines Nutzers, um nur Deals, wo er der Besitzer ist aufzurufen
client_id
optional
integer
ID des Interessenten (Kontakt), um nur die Deals eines bestimmten Kontaktes aufzurufen
property_id
optional
integer
ID des Objektes, um nur dessen Interessenten aufzurufen
Response
200: OK
{
"data": [
{
"id": 8145,
"sold_price": null,
"note": "",
"created_at": "2019-02-04T10:37:46.060+01:00",
"start_date": "2019-02-04T10:37:36.360+01:00",
"broker_id": 1,
"client_id": 29934,
"property_id": 9884,
"project_id": null,
"deal_pipeline_id": 2,
"deal_stage_id": 3,
"reservation_reason_id": null
}
],
"meta": {
"total_count": 120
}
}

post
Deal anlegen

https://api.propstack.de/v1/client_properties
Request
Response
Request
Path Parameters
client_property
required
object
das Deal-Objekt mit 3 Pflicht-Feldern: client_id, property_id und deal_stage_id
Response
200: OK

put
Deal aktualisieren

https://api.propstack.de/v1/client_properties/:id
Request
Response
Request
Response
200: OK