Zurück zur API-Übersicht

Zeitbuchungen

5 Endpunkte unter /api/rest/2.0

Time entry management - individual time tracking records

Endpunkte

Alle Pfade sind relativ zur Basis /api/rest/2.0 Ihrer ameax-Installation. Die Antworten folgen dem JSON:API-Format mit data, links und meta.

MethodePfadBeschreibung
GET /time-entries List all time-entrys
POST /time-entries Create a time-entry
GET /time-entries/{id} Get a time-entry
PUT /time-entries/{id} Update a time-entry
DELETE /time-entries/{id} Delete a time-entry

Felder

Diese Felder liefert die API zu Zeitbuchungen. Dazu kommen die Zusatzfelder Ihrer eigenen Installation — sie werden nach denselben Regeln geprüft wie in der Oberfläche und erscheinen in der Spezifikation Ihres Mandanten.

FeldTypBeschreibung
timeproject_id integer Time project ID
user_id integer User ID who performed the work
person_id integer Contact person ID
timetype_id integer Time type (Leistungsart) ID
date date Date of the time entry
time string Time range (e.g., "09:00-12:00")
duration integer Duration in minutes
description string Description of work performed
kindness integer Courtesy deduction in minutes
pause integer Break/pause deduction in minutes
nonchargeable integer Non-chargeable time in minutes
chargeable integer Chargeable time in minutes (calculated)
included_hours_applied integer Minutes covered by included hours
draft boolean Whether entry is a draft
cleared_at date-time When entry was cleared/invoiced
reported_at date-time When entry was reported
created_at date-time Creation timestamp
created_by integer User ID who created the entry

Zugriff

Jede Anfrage braucht ein API-Token im Kopf Authorization: Bearer <token>, wahlweise als Basic-Auth mit dem Benutzernamen api und dem Token als Passwort.

Das Token hängt an einem Benutzer und erbt dessen Rechte: Was dieser Benutzer in der Oberfläche nicht sehen darf, liefert die API auch nicht. Zusätzlich lassen sich je Token ein Ablaufdatum und eine IP-Beschränkung hinterlegen. Mehr dazu auf der API-Übersicht.

Anbindung besprechen.

Sie wollen ein System anbinden und wissen nicht, ob die Schnittstelle abdeckt, was Sie brauchen? Wir schauen es uns gemeinsam an — kostenlos und ohne Verpflichtung.

Kostenfreie Beratung: +49 9454 94905420