# API-Referenz Arbeitszeit (App-Kennung arbeitszeit)

> 30 App-Tools. Aufruf immer mit `POST /api/app-tools`, Header `X-API-KEY`, Body `{"name": "<tool>", "input": {…}}`. Welche Tools ein Schlüssel nutzen darf, zeigt `GET /api/app-tools` der Instanz.

Quelle: https://support.unitedsynergy.com/api/referenz/arbeitszeit/

## 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.

### Schichtplan: `arbeitszeit.schicht.*`

#### arbeitszeit.schicht.list

Liste/Suche: Schichtplan

- Art: Lesen
- Rechte: Arbeitszeit lesen
- Datenklassen: C (vertraulich)
- Eingabe:
  - `search` (string): Freitextsuche
  - `filters` (object): Feld=Wert-Filter
  - `limit` (integer)
  - `offset` (integer)
  - `orderBy` (string)
- Beispiel: `{"name":"arbeitszeit.schicht.list","input":{}}`

#### arbeitszeit.schicht.get

Detail: Schichtplan

- Art: Lesen
- Rechte: Arbeitszeit lesen
- Datenklassen: C (vertraulich)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"name":"arbeitszeit.schicht.get","input":{"id":"<id>"}}`

#### arbeitszeit.schicht.create

Anlegen: Schichtplan

- Art: Anlegen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Arbeitszeit anlegen
- Datenklassen: C (vertraulich)
- Eingabe:
  - `schichtartCode` (string)
  - `von` (string, Pflicht)
  - `bis` (string, Pflicht)
  - `bezeichnung` (string)
  - `bemerkung` (string)
  - `standortId` (string)
  - `kostenstelleId` (string)
- Beispiel: `{"name":"arbeitszeit.schicht.create","input":{"von":"<von>","bis":"<bis>"}}`

#### arbeitszeit.schicht.update

Ändern: Schichtplan

- Art: Ändern, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Arbeitszeit ändern
- Datenklassen: C (vertraulich)
- Eingabe:
  - `id` (string, Pflicht): ID des Datensatzes
  - `schichtartCode` (string)
  - `von` (string)
  - `bis` (string)
  - `bezeichnung` (string)
  - `bemerkung` (string)
  - `standortId` (string)
  - `kostenstelleId` (string)
- Beispiel: `{"name":"arbeitszeit.schicht.update","input":{"id":"<id>"}}`

#### arbeitszeit.schicht.delete

Löschen: Schichtplan

- Art: Löschen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Arbeitszeit löschen
- Datenklassen: C (vertraulich)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"name":"arbeitszeit.schicht.delete","input":{"id":"<id>"}}`

### Zeiterfassung: `arbeitszeit.eintrag.*`

#### arbeitszeit.eintrag.list

Liste/Suche: Zeiterfassung

- Art: Lesen
- Rechte: Arbeitszeit lesen
- Datenklassen: C (vertraulich)
- Eingabe:
  - `search` (string): Freitextsuche
  - `filters` (object): Feld=Wert-Filter
  - `limit` (integer)
  - `offset` (integer)
  - `orderBy` (string)
- Beispiel: `{"name":"arbeitszeit.eintrag.list","input":{}}`

#### arbeitszeit.eintrag.get

Detail: Zeiterfassung

- Art: Lesen
- Rechte: Arbeitszeit lesen
- Datenklassen: C (vertraulich)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"name":"arbeitszeit.eintrag.get","input":{"id":"<id>"}}`

#### arbeitszeit.eintrag.create

Anlegen: Zeiterfassung

- Art: Anlegen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Arbeitszeit anlegen
- Datenklassen: C (vertraulich)
- Eingabe:
  - `personId` (string, Pflicht)
  - `datum` (string, Pflicht)
  - `beginn` (string)
  - `ende` (string)
  - `pauseMinuten` (number)
  - `statusCode` (string)
  - `bereichCode` (string)
  - `kommentar` (string)
- Beispiel: `{"name":"arbeitszeit.eintrag.create","input":{"personId":"<personId>","datum":"<datum>"}}`

#### arbeitszeit.eintrag.update

Ändern: Zeiterfassung

- Art: Ändern, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Arbeitszeit ändern
- Datenklassen: C (vertraulich)
- Eingabe:
  - `id` (string, Pflicht): ID des Datensatzes
  - `personId` (string)
  - `datum` (string)
  - `beginn` (string)
  - `ende` (string)
  - `pauseMinuten` (number)
  - `statusCode` (string)
  - `bereichCode` (string)
  - `kommentar` (string)
- Beispiel: `{"name":"arbeitszeit.eintrag.update","input":{"id":"<id>"}}`

#### arbeitszeit.eintrag.delete

Löschen: Zeiterfassung

- Art: Löschen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Arbeitszeit löschen
- Datenklassen: C (vertraulich)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"name":"arbeitszeit.eintrag.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.

### Arbeitsbereiche: `arbeitszeit.bereich.*`

#### arbeitszeit.bereich.list

Liste/Suche: Katalog „Arbeitsbereiche" (arbeitszeit)

- Art: Lesen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `onlyAktiv` (boolean): Nur aktive Einträge
- Beispiel: `{"name":"arbeitszeit.bereich.list","input":{}}`

#### arbeitszeit.bereich.get

Detail: Katalog „Arbeitsbereiche" (arbeitszeit)

- Art: Lesen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"name":"arbeitszeit.bereich.get","input":{"id":"<id>"}}`

#### arbeitszeit.bereich.create

Anlegen: Katalog „Arbeitsbereiche" (arbeitszeit)

- Art: Anlegen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `label` (string, Pflicht): Anzeige-Text
  - `code` (string): Optional, sonst aus label abgeleitet. Immutable
  - `color` (string): Tailwind-Paar, z.B. "bg-blue-100 text-blue-700"
  - `icon` (string): Lucide-Icon-Name
  - `beschreibung` (string)
- Beispiel: `{"name":"arbeitszeit.bereich.create","input":{"label":"<label>"}}`

#### arbeitszeit.bereich.update

Ändern: Katalog „Arbeitsbereiche" (arbeitszeit)

- Art: Ändern, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht)
  - `label` (string)
  - `color` (string)
  - `icon` (string)
  - `beschreibung` (string)
  - `aktiv` (boolean)
- Beispiel: `{"name":"arbeitszeit.bereich.update","input":{"id":"<id>"}}`

#### arbeitszeit.bereich.delete

Löschen: Katalog „Arbeitsbereiche" (arbeitszeit)

- Art: Löschen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"name":"arbeitszeit.bereich.delete","input":{"id":"<id>"}}`

### Lohnarten: `arbeitszeit.lohnart.*`

#### arbeitszeit.lohnart.list

Liste/Suche: Katalog „Lohnarten" (arbeitszeit)

- Art: Lesen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `onlyAktiv` (boolean): Nur aktive Einträge
- Beispiel: `{"name":"arbeitszeit.lohnart.list","input":{}}`

#### arbeitszeit.lohnart.get

Detail: Katalog „Lohnarten" (arbeitszeit)

- Art: Lesen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"name":"arbeitszeit.lohnart.get","input":{"id":"<id>"}}`

#### arbeitszeit.lohnart.create

Anlegen: Katalog „Lohnarten" (arbeitszeit)

- Art: Anlegen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `label` (string, Pflicht): Anzeige-Text
  - `code` (string): Optional, sonst aus label abgeleitet. Immutable
  - `color` (string): Tailwind-Paar, z.B. "bg-blue-100 text-blue-700"
  - `icon` (string): Lucide-Icon-Name
  - `beschreibung` (string)
- Beispiel: `{"name":"arbeitszeit.lohnart.create","input":{"label":"<label>"}}`

#### arbeitszeit.lohnart.update

Ändern: Katalog „Lohnarten" (arbeitszeit)

- Art: Ändern, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht)
  - `label` (string)
  - `color` (string)
  - `icon` (string)
  - `beschreibung` (string)
  - `aktiv` (boolean)
- Beispiel: `{"name":"arbeitszeit.lohnart.update","input":{"id":"<id>"}}`

#### arbeitszeit.lohnart.delete

Löschen: Katalog „Lohnarten" (arbeitszeit)

- Art: Löschen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"name":"arbeitszeit.lohnart.delete","input":{"id":"<id>"}}`

### Schichtarten: `arbeitszeit.schichtart.*`

#### arbeitszeit.schichtart.list

Liste/Suche: Katalog „Schichtarten" (arbeitszeit)

- Art: Lesen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `onlyAktiv` (boolean): Nur aktive Einträge
- Beispiel: `{"name":"arbeitszeit.schichtart.list","input":{}}`

#### arbeitszeit.schichtart.get

Detail: Katalog „Schichtarten" (arbeitszeit)

- Art: Lesen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"name":"arbeitszeit.schichtart.get","input":{"id":"<id>"}}`

#### arbeitszeit.schichtart.create

Anlegen: Katalog „Schichtarten" (arbeitszeit)

- Art: Anlegen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `label` (string, Pflicht): Anzeige-Text
  - `code` (string): Optional, sonst aus label abgeleitet. Immutable
  - `color` (string): Tailwind-Paar, z.B. "bg-blue-100 text-blue-700"
  - `icon` (string): Lucide-Icon-Name
  - `beschreibung` (string)
- Beispiel: `{"name":"arbeitszeit.schichtart.create","input":{"label":"<label>"}}`

#### arbeitszeit.schichtart.update

Ändern: Katalog „Schichtarten" (arbeitszeit)

- Art: Ändern, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht)
  - `label` (string)
  - `color` (string)
  - `icon` (string)
  - `beschreibung` (string)
  - `aktiv` (boolean)
- Beispiel: `{"name":"arbeitszeit.schichtart.update","input":{"id":"<id>"}}`

#### arbeitszeit.schichtart.delete

Löschen: Katalog „Schichtarten" (arbeitszeit)

- Art: Löschen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"name":"arbeitszeit.schichtart.delete","input":{"id":"<id>"}}`

### Status: `arbeitszeit.status.*`

#### arbeitszeit.status.list

Liste/Suche: Katalog „Status" (arbeitszeit)

- Art: Lesen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `onlyAktiv` (boolean): Nur aktive Einträge
- Beispiel: `{"name":"arbeitszeit.status.list","input":{}}`

#### arbeitszeit.status.get

Detail: Katalog „Status" (arbeitszeit)

- Art: Lesen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"name":"arbeitszeit.status.get","input":{"id":"<id>"}}`

#### arbeitszeit.status.create

Anlegen: Katalog „Status" (arbeitszeit)

- Art: Anlegen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `label` (string, Pflicht): Anzeige-Text
  - `code` (string): Optional, sonst aus label abgeleitet. Immutable
  - `color` (string): Tailwind-Paar, z.B. "bg-blue-100 text-blue-700"
  - `icon` (string): Lucide-Icon-Name
  - `beschreibung` (string)
- Beispiel: `{"name":"arbeitszeit.status.create","input":{"label":"<label>"}}`

#### arbeitszeit.status.update

Ändern: Katalog „Status" (arbeitszeit)

- Art: Ändern, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht)
  - `label` (string)
  - `color` (string)
  - `icon` (string)
  - `beschreibung` (string)
  - `aktiv` (boolean)
- Beispiel: `{"name":"arbeitszeit.status.update","input":{"id":"<id>"}}`

#### arbeitszeit.status.delete

Löschen: Katalog „Status" (arbeitszeit)

- Art: Löschen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"name":"arbeitszeit.status.delete","input":{"id":"<id>"}}`