Payroll-Exportdokumente auflisten

List payroll export documents

curl --request GET \
  --url https://api.jobhandy.io/v1/payroll/export-documents \
  --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', 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");
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);

{
  "page": 1,
  "pageSize": 100,
  "totalPages": 1,
  "totalElements": 2,
  "items": [
    {
      "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"
    },
    {
      "id": "700000000000000000000102",
      "tenant": "68a000000000000000000010",
      "type": "universal_txt",
      "startMonth": "2026-02",
      "endMonth": "2026-02",
      "fileName": "universal_export_202602.txt",
      "mimeType": "text/plain",
      "createdAt": "2026-03-01T08:00:00.000Z",
      "updatedAt": "2026-03-01T08:00:00.000Z"
    }
  ]
}

GET

https://api.jobhandy.io/v1

payroll

export-documents

List payroll export documents

curl --request GET \
  --url https://api.jobhandy.io/v1/payroll/export-documents \
  --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', 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");
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);

{
  "page": 1,
  "pageSize": 100,
  "totalPages": 1,
  "totalElements": 2,
  "items": [
    {
      "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"
    },
    {
      "id": "700000000000000000000102",
      "tenant": "68a000000000000000000010",
      "type": "universal_txt",
      "startMonth": "2026-02",
      "endMonth": "2026-02",
      "fileName": "universal_export_202602.txt",
      "mimeType": "text/plain",
      "createdAt": "2026-03-01T08:00:00.000Z",
      "updatedAt": "2026-03-01T08:00:00.000Z"
    }
  ]
}

Auf einen Blick

Eigenschaft	Verhalten
Authentifizierung	Erforderlich in `X-API-Key`
Tenant-Kontext	Optional; weglassen, um alle autorisierten Tenants abzufragen
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

Listet Payroll-Exportdokumente im Scope des API-Keys auf. Filter- und Sortierfelder: tenant, type, startMonth, endMonth.

Filtern Sie nach Tenant, Typ, startMonth und endMonth. Werte für type sind case-sensitive.

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
`UNKNOWN_QUERY_PARAMETER`	Query-Parameter wird nicht unterstützt
`INVALID_FILTER_SYNTAX`	Filterausdruck kann nicht geparst werden
`UNSUPPORTED_FILTER_FIELD`	Filterfeld wird nicht unterstützt
`UNSUPPORTED_FILTER_OPERATOR`	Operator wird für das Feld nicht unterstützt
`UNSUPPORTED_SORT_FIELD`	Sortierfeld wird nicht unterstützt
`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_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

Restricts results to one tenant in the API key's scope. Omit the header to query all tenants in scope. 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}$

Abfrageparameter

page

integer

inactive

optional

server default: 1

not sent by default

One-based page number. When omitted, the server uses 1.

Erforderlicher Bereich: x >= 1Muss ein Vielfaches sein von 1

Beispiel:

1

pageSize

integer

inactive

optional

server default: 100

not sent by default

Number of resources per page. When omitted, the server uses 100.

Erforderlicher Bereich: 1 <= x <= 1000Muss ein Vielfaches sein von 1

Beispiel:

100

sort

string

inactive

optional

not sent by default

One endpoint-supported public scalar field. Prefix with - for descending order. Multiple fields and whitespace are rejected. Null values sort first in ascending order and last in descending order.

filter

string

inactive

optional

not sent by default

Expression over endpoint-supported public scalar fields. Operators: =, !=, >, >=, <, <=, IN (...), CONTAINS, STARTS_WITH, ENDS_WITH, IS NULL, IS NOT NULL. AND binds before OR; parentheses override precedence. Whitespace outside quoted values is ignored. String comparisons are case-insensitive. String values may be unquoted, single-quoted, or double-quoted. Values containing whitespace must be enclosed in single or double quotes. An apostrophe may be escaped as ' in either quote style; the escape backslash is not part of the matched value. Nested, object, and array fields are rejected. Examples show decoded filter expressions; URL-encode the query parameter value when constructing a raw URL.

Antwort

A page of payroll export documents.

One page of payroll export documents.

page

integer

erforderlich

Current one-based page number.

Muss ein Vielfaches sein von 1

Beispiel:

1

pageSize

integer

erforderlich

Maximum number of resources returned per page.

Muss ein Vielfaches sein von 1

Beispiel:

100

totalPages

integer

erforderlich

Number of available pages.

Muss ein Vielfaches sein von 1

Beispiel:

1

totalElements

integer

erforderlich

Number of resources matching the request.

Muss ein Vielfaches sein von 1

Beispiel:

2

items

object[]

erforderlich

Payroll export documents on the current page.

Show child attributes

Zuletzt geändert am 27. August 2026

Übersicht

Datenmodelle

Spezifikation

Payroll-Exportdokumente auflisten

Auf einen Blick

Betriebsverhalten

Häufige Fehler

Vor der Implementierung

Zugehöriger Integrationsleitfaden

Autorisierungen

Header

Abfrageparameter

Antwort

​Auf einen Blick

​Betriebsverhalten

​Häufige Fehler

​Vor der Implementierung

Zugehöriger Integrationsleitfaden

Autorisierungen

Header

Abfrageparameter

Antwort

Auf einen Blick

Betriebsverhalten

Häufige Fehler

Vor der Implementierung