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

Deals lesen

GET https://api.propstack.de/v1/client_properties

Query Parameters

Name	Type	Description
include	string	Liste von möglichen Assoziationen, die in der Antwort mit übergeben werden (kommagetrennt). Kann den Wert client und/oder property haben
sort_by	string	Sortierkriterium Standard: created_at
order	string	Aufsteigend oder absteigend sortieren. Entweder asc oder desc
reservation_reason_ids	array	Array aus Absagegründen (dessen IDs), um nur verlorene Deals mit bestimmten Absagegründen aufzurufen
category	string	Art des Deals. Kann eines von qualified, unqualified, lost sein
deal_stage_ids	array	Array aus IDs, um nur Deals in bestimmten Phasen aufzurufen.
deal_pipeline_id	integer	Nur Deals aus einer bestimmten Pipeline aufrufen
project_id	integer	ID eines Projektes, um nur Deals mit Objekten, die zu dem Projekt gehören, aufzurufen
broker_id	integer	ID eines Nutzers, um nur Deals, wo er der Besitzer ist aufzurufen
client_id	integer	ID des Interessenten (Kontakt), um nur die Deals eines bestimmten Kontaktes aufzurufen
property_id	integer	ID des Objektes, um nur dessen Interessenten aufzurufen
client_source_id	integer	ID der Anfrage-Quelle
team_id	integer	ID der Abteilung
property_broker_ids	array	IDs der Objektbetreuer
client_broker_ids	array	IDs der Kontakt Betreuer
feeling_from	integer	Mindestwert des Bauchgefühls
feeling_to	integer	Höchstwert des Bauchgefühls
created_at_from	string	Format: 2022-12-07T10:00:00+01:00
created_at_to	string	Format: 2022-12-07T23:59:59+01:00
start_date_from	string	Format: 2022-12-07T10:00:00+01:00
start_date_to	string	Format: 2022-12-07T10:00:00+01:00
show_archived_clients	boolean	Archivierte Kontakte anzeigen
hide_archived_properties	boolean	Archivierte Eigenschaften ausblenden

200

{
    "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
    }
}

Deal anlegen

POST https://api.propstack.de/v1/client_properties

Path Parameters

Name	Type	Description
client_property	object	das Deal-Objekt mit 3 Pflicht-Feldern: client_id, property_id und deal_stage_id

Anfrageformat

{
   "client_property": {
       "property_id": 123,
       "client_id": 456,
       "note" : "some note"
   }
}

Deal aktualisieren

PUT https://api.propstack.de/v1/client_properties/:id

Anfrageformat

{
   "client_property": {
       "property_id": 123,
       "client_id": 456,
       "note" : "updated note"
   }
}

Absage erfassen

POST https://api.propstack.de/v1/tasks

Anfrageformat

{
  "task": {
    "title": "Absage",
    "reservation_reason_id": 1,
    "client_ids": [123],
    "property_ids": [456],
    "body": "Das ist ein Test"
  }
}