Zum Inhalt springen
API-Dokumentation

Avos Externe API

RESTful-API zur Integration Ihrer Systeme mit der Lohnabrechnung. API-Key-Authentifizierung, vollständige Swagger-Dokumentation.

Schnellstart

1

API Key erstellen

Im Dashboard zu API Keys → Neuer Schlüssel. Definieren Sie die erforderlichen Bereiche.

2

Authentifizieren

Senden Sie den Header Authorization: Bearer pk_live_... in allen Anfragen.

3

Ersten Aufruf machen

GET /api/external/v1/employees um Mitarbeiter des Unternehmens aufzulisten.

Authentifizierungsbeispiel
curl https://api.useavos.app/api/external/v1/employees \
  -H "Authorization: Bearer pk_live_sua_chave_aqui" \
  -H "Content-Type: application/json"

Verfügbare Ressourcen

Mitarbeiter

Mitarbeiterdaten über API lesen und verwalten.

GETPOSTPATCHemployees:reademployees:write

Abteilungen

Unternehmensabteilungen abfragen und erstellen.

GETPOSTdepartments:readdepartments:write

Positionen

Positionen und Stellenstruktur abrufen.

GETPOSTpositions:readpositions:write

Lohnabrechnung

Lohnabrechnung per API abfragen, berechnen und freigeben.

GETPOSTpayroll:readpayroll:write

Zeiterfassung

Stempelungen abfragen und Kommen/Gehen buchen.

GETPOSTtimeclock:readtimeclock:write

Berichte

Lohn- und Mitarbeiterzahlberichte exportieren.

GETreports:read