Verträge
Jedes Tool rufst du mit POST /api/app-tools und dem Tool-Namen auf. Klapp ein Tool auf, um Eingabefelder, nötige Rechte und eine Beispiel-Anfrage zu sehen. Ob dein API-Key ein Tool nutzen darf, zeigt der Katalog deiner Instanz (App-Tools-API).
20 Tools
Kein Tool passt zu deiner Eingabe.
Datenobjekte
Die Standard-Aktionen je Datenobjekt: list (suchen und blättern), get (einen Datensatz lesen), create, update und delete. Nicht jedes Objekt bietet alle fünf an.
Verträge vertraege.vertrag.*
vertraege.vertrag.list Lesen Liste/Suche: Verträge
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
search | string | nein | Freitextsuche |
filters | object | nein | Feld=Wert-Filter |
limit | integer | nein | |
offset | integer | nein | |
orderBy | string | nein |
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
"name": "vertraege.vertrag.list",
"input": {}
} vertraege.vertrag.get Lesen Detail: Verträge
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
"name": "vertraege.vertrag.get",
"input": {
"id": "<id>"
}
} vertraege.vertrag.create Anlegen Bestätigung Anlegen: Verträge
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
nummer | string | nein | |
bezeichnung | string | ja | |
vertragsartCode | string | ja | |
statusCode | string | nein | |
kontoId | string | ja | |
kontaktId | string | nein | |
objektId | string | nein | |
rolleTenant | string | nein | |
gegenstand | string | nein | |
beginn | string | nein | |
ende | string | nein | |
laufzeitMonate | number | nein | |
autoVerlaengerung | boolean | nein | |
verlaengerungMonate | number | nein | |
kuendigungsfristMonate | number | nein | |
gekuendigtAm | string | nein | |
gekuendigtZum | string | nein | |
unterzeichnetAm | string | nein | |
wert | number | nein | |
waehrung | string | nein | |
abrechnungsrhythmus | string | nein | |
verantwortlichUserId | string | nein | |
bemerkung | string | nein |
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
"name": "vertraege.vertrag.create",
"input": {
"bezeichnung": "<bezeichnung>",
"vertragsartCode": "<vertragsartCode>",
"kontoId": "<kontoId>"
}
} vertraege.vertrag.update Ändern Bestätigung Ändern: Verträge
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | ID des Datensatzes |
nummer | string | nein | |
bezeichnung | string | nein | |
vertragsartCode | string | nein | |
statusCode | string | nein | |
kontoId | string | nein | |
kontaktId | string | nein | |
objektId | string | nein | |
rolleTenant | string | nein | |
gegenstand | string | nein | |
beginn | string | nein | |
ende | string | nein | |
laufzeitMonate | number | nein | |
autoVerlaengerung | boolean | nein | |
verlaengerungMonate | number | nein | |
kuendigungsfristMonate | number | nein | |
gekuendigtAm | string | nein | |
gekuendigtZum | string | nein | |
unterzeichnetAm | string | nein | |
wert | number | nein | |
waehrung | string | nein | |
abrechnungsrhythmus | string | nein | |
verantwortlichUserId | string | nein | |
bemerkung | string | nein |
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
"name": "vertraege.vertrag.update",
"input": {
"id": "<id>"
}
} vertraege.vertrag.delete Löschen Bestätigung Löschen: Verträge
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
"name": "vertraege.vertrag.delete",
"input": {
"id": "<id>"
}
} Vertragspositionen vertraege.position.*
vertraege.position.list Lesen Liste/Suche: Vertragspositionen
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
search | string | nein | Freitextsuche |
filters | object | nein | Feld=Wert-Filter |
limit | integer | nein | |
offset | integer | nein | |
orderBy | string | nein |
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
"name": "vertraege.position.list",
"input": {}
} vertraege.position.get Lesen Detail: Vertragspositionen
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
"name": "vertraege.position.get",
"input": {
"id": "<id>"
}
} vertraege.position.create Anlegen Bestätigung Anlegen: Vertragspositionen
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
vertragId | string | ja | |
position | number | nein | |
artikelId | string | nein | |
bezeichnung | string | ja | |
beschreibung | string | nein | |
menge | number | nein | |
einheit | string | nein | |
einzelpreis | number | nein | |
rabattProzent | number | nein | |
intervall | string | nein | |
gesamt | number | nein |
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
"name": "vertraege.position.create",
"input": {
"vertragId": "<vertragId>",
"bezeichnung": "<bezeichnung>"
}
} vertraege.position.update Ändern Bestätigung Ändern: Vertragspositionen
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | ID des Datensatzes |
vertragId | string | nein | |
position | number | nein | |
artikelId | string | nein | |
bezeichnung | string | nein | |
beschreibung | string | nein | |
menge | number | nein | |
einheit | string | nein | |
einzelpreis | number | nein | |
rabattProzent | number | nein | |
intervall | string | nein | |
gesamt | number | nein |
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
"name": "vertraege.position.update",
"input": {
"id": "<id>"
}
} vertraege.position.delete Löschen Bestätigung Löschen: Vertragspositionen
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
"name": "vertraege.position.delete",
"input": {
"id": "<id>"
}
} Wertelisten
Auswahllisten der App wie Status, Arten oder Kategorien. Du pflegst sie mit denselben fünf Aktionen. Die Werte (code) nutzt du in den Feldern der Datenobjekte.
Vertragsarten vertraege.vertragsart.* list · get · create · update · delete
vertraege.vertragsart.list Lesen Liste/Suche: Katalog „Vertragsarten" (vertraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
onlyAktiv | boolean | nein | Nur aktive Einträge |
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
"name": "vertraege.vertragsart.list",
"input": {}
} vertraege.vertragsart.get Lesen Detail: Katalog „Vertragsarten" (vertraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
"name": "vertraege.vertragsart.get",
"input": {
"id": "<id>"
}
} vertraege.vertragsart.create Anlegen Bestätigung Anlegen: Katalog „Vertragsarten" (vertraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
label | string | ja | Anzeige-Text |
code | string | nein | Optional, sonst aus label abgeleitet. Immutable. |
color | string | nein | Tailwind-Paar, z.B. "bg-blue-100 text-blue-700" |
icon | string | nein | Lucide-Icon-Name |
beschreibung | string | nein |
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
"name": "vertraege.vertragsart.create",
"input": {
"label": "<label>"
}
} vertraege.vertragsart.update Ändern Bestätigung Ändern: Katalog „Vertragsarten" (vertraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | |
label | string | nein | |
color | string | nein | |
icon | string | nein | |
beschreibung | string | nein | |
aktiv | boolean | nein |
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
"name": "vertraege.vertragsart.update",
"input": {
"id": "<id>"
}
} vertraege.vertragsart.delete Löschen Bestätigung Löschen: Katalog „Vertragsarten" (vertraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
"name": "vertraege.vertragsart.delete",
"input": {
"id": "<id>"
}
} Vertragsstatus vertraege.status.* list · get · create · update · delete
vertraege.status.list Lesen Liste/Suche: Katalog „Vertragsstatus" (vertraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
onlyAktiv | boolean | nein | Nur aktive Einträge |
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
"name": "vertraege.status.list",
"input": {}
} vertraege.status.get Lesen Detail: Katalog „Vertragsstatus" (vertraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
"name": "vertraege.status.get",
"input": {
"id": "<id>"
}
} vertraege.status.create Anlegen Bestätigung Anlegen: Katalog „Vertragsstatus" (vertraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
label | string | ja | Anzeige-Text |
code | string | nein | Optional, sonst aus label abgeleitet. Immutable. |
color | string | nein | Tailwind-Paar, z.B. "bg-blue-100 text-blue-700" |
icon | string | nein | Lucide-Icon-Name |
beschreibung | string | nein |
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
"name": "vertraege.status.create",
"input": {
"label": "<label>"
}
} vertraege.status.update Ändern Bestätigung Ändern: Katalog „Vertragsstatus" (vertraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | |
label | string | nein | |
color | string | nein | |
icon | string | nein | |
beschreibung | string | nein | |
aktiv | boolean | nein |
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
"name": "vertraege.status.update",
"input": {
"id": "<id>"
}
} vertraege.status.delete Löschen Bestätigung Löschen: Katalog „Vertragsstatus" (vertraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
"name": "vertraege.status.delete",
"input": {
"id": "<id>"
}
} Als Klartext für KI-Assistenten: diese App, alle Apps und Artikel zur API in einer Datei: /api/llms.txt