Entity · payroll_exports

Payroll Export Schema

Schema-ID

payroll_export

Collection

payroll_exports

Permissions

Lesenpayroll_view
Anlegenpayroll_export
Ändernpayroll_export
Löschenpayroll_export

Felder

Payroll Export Schema

payroll_exports4 Permissions

Audit log entry for a payroll period export to the Steuerberater.

periodstringerforderlich

Exported payroll period (YYYY-MM)

Pattern

formatstringerforderlich

Export format used

Werte

DATEV_LODAS_CSVDATEV_ASCIIDATEV_XML

employeeCountintegererforderlich

Number of employees included in the export

≥ 0

sha256stringerforderlich

SHA-256 hash of the generated file (lowercase hex)

Patternread-only

fileSizeintegeroptional

Size of the generated file in bytes

≥ 0read-onlynullable

exportedByuuiderforderlich

User UUID of the HR member who triggered the export

read-only

exportedAtdatetimeerforderlich

read-only

deliveryMethodstringoptional

How the file left the browser

Werte

DOWNLOADEMAIL

recipientEmailemailoptional

Steuerberater email address (only for EMAIL deliveries)

max 200 Zeichennullable

notesstringoptional

Optional notes attached to the export

max 1000 Zeichennullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

GET /api/v1/payroll_exports — Liste, paginiert + filterbar
GET /api/v1/payroll_exports/<id> — Einzelne Entity
POST /api/v1/payroll_exports — Anlegen
PATCH /api/v1/payroll_exports/<id> — Teil-Update
DELETE /api/v1/payroll_exports/<id> — Soft-Delete
GET /api/v1/payroll_exports/<id>/timeline — Audit + Aktivitäten