Payroll-Exportdokument abrufen

Get a payroll export document

curl --request GET \
  --url https://api.jobhandy.io/v1/payroll/export-documents/{id} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.jobhandy.io/v1/payroll/export-documents/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://api.jobhandy.io/v1/payroll/export-documents/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-API-Key", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "id": "700000000000000000000101",
  "tenant": "68a000000000000000000010",
  "type": "datev_lodas",
  "startMonth": "2026-01",
  "endMonth": "2026-01",
  "fileName": "datev_lodas_export_202601.csv",
  "mimeType": "text/csv",
  "createdAt": "2026-02-01T08:00:00.000Z",
  "updatedAt": "2026-02-01T08:00:00.000Z"
}

GET

https://api.jobhandy.io/v1

payroll

export-documents

{id}

Get a payroll export document

curl --request GET \
  --url https://api.jobhandy.io/v1/payroll/export-documents/{id} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.jobhandy.io/v1/payroll/export-documents/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://api.jobhandy.io/v1/payroll/export-documents/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-API-Key", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "id": "700000000000000000000101",
  "tenant": "68a000000000000000000010",
  "type": "datev_lodas",
  "startMonth": "2026-01",
  "endMonth": "2026-01",
  "fileName": "datev_lodas_export_202601.csv",
  "mimeType": "text/csv",
  "createdAt": "2026-02-01T08:00:00.000Z",
  "updatedAt": "2026-02-01T08:00:00.000Z"
}

Auf einen Blick

Eigenschaft	Verhalten
Authentifizierung	Erforderlich in `X-API-Key`
Tenant-Kontext	Optionale Einschränkung; Ressource und Referenzen müssen im Scope bleiben
Dry Run	Nicht unterstützt
Request-Body	Keiner
Response	JSON
Primärer Erfolg	`200`
Side Effects	Keine außer dem Lesen autorisierter Ressourcen
Retry-Empfehlung	Transiente Read-Fehler können in der Regel mit begrenztem Backoff sicher wiederholt werden

Betriebsverhalten

Gibt Metadaten des Payroll-Exportdokuments zurück, wenn es im Scope des API-Keys liegt.

Prüfen Sie fileName, bevor Sie den Download starten; null bedeutet, dass keine Datei erzeugt wurde.

Häufige Fehler

Fehlercode	Bedeutung
`VALIDATION_ERROR`	Schema- oder fachliche Validierung ist fehlgeschlagen
`INVALID_REQUEST_ID`	`X-Request-ID` ist keine UUID v4 oder v7
`INVALID_API_KEY`	API-Key fehlt, ist ungültig, gelöscht oder inaktiv
`TENANT_NOT_IN_SCOPE`	Ausgewählter Tenant liegt außerhalb des API-Key-Scopes
`NOT_FOUND`	Ressource fehlt oder ist im Scope nicht zugänglich
`NOT_ACCEPTABLE`	Angeforderter Response-Medientyp ist nicht verfügbar
`RATE_LIMIT_EXCEEDED`	Rate Limit des API-Keys wurde überschritten
`INTERNAL_SERVER_ERROR`	Unerwarteter Serverfehler

Die Response-Liste der Operation und die Seite Fehlerbehandlung sind für die vollständige Behandlung maßgeblich.

Vor der Implementierung

Erzeugen und protokollieren Sie für den Versuch eine neue X-Request-ID.
Behandeln Sie jeden dokumentierten Response-Status.
Protokollieren Sie weder X-API-Key noch unnötige personenbezogene Daten.

Zugehöriger Integrationsleitfaden

Prüfen Sie den vollständigen Prozess sowie Status-, Retry- und Betriebsmuster für diese Operation.

Autorisierungen

X-API-Key

string

header

erforderlich

JobHandy integration API key. Send the credential in the X-API-Key header. Treat the key as a secret and use it only from trusted server-side environments.

Header

X-Tenant-ID

string

inactive

optional

not sent by default

Narrows the operation to one tenant in the API key's scope. Any referenced or target resource must be accessible through that tenant. In interactive clients, use the {{tenantId}} variable when a tenant must be selected. Keep the header disabled when tenant selection is not required.

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

X-Request-ID

string<uuid>

inactive

optional

not sent by default

Optional request identifier. If supplied, it must be a UUID v4 or v7 and is returned unchanged in every response. If omitted, the API generates one. Invalid values return 400 INVALID_REQUEST_ID. If your client uses a {{requestId}} variable, refresh it with a new UUID version 4 or 7 for every HTTP request attempt. Keep the header disabled to let the API generate the request identifier.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[47][0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Pfadparameter

string

erforderlich

Payroll export document ID.

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

Beispiel:

"700000000000000000000101"

Antwort

The requested payroll export document.

Payroll export document metadata.

string

erforderlich

read-only

Payroll export document ID.

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

Beispiel:

"700000000000000000000101"

tenant

string

erforderlich

read-only

ID of the tenant that owns the document.

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

Beispiel:

"68a000000000000000000010"

type

enum<string>

erforderlich

Payroll export format. Values are case-sensitive.

Verfügbare Optionen:

sap_hcm,

personio_csv,

hrworks_csv,

diamant_software_diamant_4,

universal_csv,

universal_txt,

datev_lodas,

datev_lug

Minimum string length: 1

Beispiel:

"datev_lodas"

startMonth

string

erforderlich

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

Minimum string length: 1

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

Beispiel:

"2026-01"

endMonth

string

erforderlich

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

Minimum string length: 1

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

Beispiel:

"2026-01"

fileName

string | null

erforderlich

nullable

Download filename, or null when no file was produced.

Minimum string length: 1

Beispiel:

"datev_lodas_export_202601.csv"

mimeType

string

erforderlich

Media type derived from the payroll export format.

Minimum string length: 1

Beispiel:

"text/csv"

createdAt

string<date-time>

erforderlich

read-only

UTC creation timestamp.

Minimum string length: 1

Pattern: Z$

Beispiel:

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

updatedAt

string<date-time>

erforderlich

read-only

UTC timestamp of the latest update.

Minimum string length: 1

Pattern: Z$

Beispiel:

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

Zuletzt geändert am 27. August 2026

Übersicht

Datenmodelle

Spezifikation

Auf einen Blick

Betriebsverhalten

Häufige Fehler

Vor der Implementierung

Zugehöriger Integrationsleitfaden

Autorisierungen

Header

Pfadparameter

Antwort

​Auf einen Blick

​Betriebsverhalten

​Häufige Fehler

​Vor der Implementierung

Zugehöriger Integrationsleitfaden

Autorisierungen

Header

Pfadparameter

Antwort

Auf einen Blick

Betriebsverhalten

Häufige Fehler

Vor der Implementierung