Skip to main content
The schema below is rendered directly from the published OpenAPI 3.1 contract.

Payroll export document metadata.

id
string
required
read-only

Payroll export document ID.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"700000000000000000000101"

tenant
string
required
read-only

ID of the tenant that owns the document.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"68a000000000000000000010"

type
enum<string>
required

Payroll export format. Values are case-sensitive.

Available options:
sap_hcm,
personio_csv,
hrworks_csv,
diamant_software_diamant_4,
universal_csv,
universal_txt,
datev_lodas,
datev_lug
Minimum string length: 1
Example:

"datev_lodas"

startMonth
string
required

First payroll period covered by the document in YYYY-MM format.

Minimum string length: 1
Pattern: ^\d{4}-(?:0[1-9]|1[0-2])$
Example:

"2026-01"

endMonth
string
required

Last payroll period covered by the document in YYYY-MM format.

Minimum string length: 1
Pattern: ^\d{4}-(?:0[1-9]|1[0-2])$
Example:

"2026-01"

fileName
string | null
required
nullable

Download filename, or null when no file was produced.

Minimum string length: 1
Example:

"datev_lodas_export_202601.csv"

mimeType
string
required

Media type derived from the payroll export format.

Minimum string length: 1
Example:

"text/csv"

createdAt
string<date-time>
required
read-only

UTC creation timestamp.

Minimum string length: 1
Pattern: Z$
Example:

"2026-02-01T08:00:00.000Z"

updatedAt
string<date-time>
required
read-only

UTC timestamp of the latest update.

Minimum string length: 1
Pattern: Z$
Example:

"2026-02-01T08:00:00.000Z"

Last modified on August 26, 2026