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"
    }
  ]
}

At a glance

Property	Behavior
Authentication	Required in X-API-Key
Tenant context	Optional; omit to query all authorized tenants
Dry run	Not supported
Request body	None
Response	JSON
Primary success	`200`
Side effects	None beyond reading or downloading the authorized resource
Retry guidance	Transient read failures are generally safe to retry with bounded backoff

Operational behavior

Lists payroll export documents in the API key’s scope. Filter and sort fields: tenant, type, startMonth, endMonth.

Filter by tenant, type, startMonth, and endMonth. Values for type are case-sensitive.

Common errors

Error code	Meaning
`VALIDATION_ERROR`	Schema or business validation failed
`INVALID_REQUEST_ID`	X-Request-ID is not UUID v4 or v7
`UNKNOWN_QUERY_PARAMETER`	Query parameter is not supported
`INVALID_FILTER_SYNTAX`	Filter expression cannot be parsed
`UNSUPPORTED_FILTER_FIELD`	Filter field is not supported
`UNSUPPORTED_FILTER_OPERATOR`	Operator is not supported for the field
`UNSUPPORTED_SORT_FIELD`	Sort field is not supported
`INVALID_API_KEY`	Missing, invalid, deleted, or inactive API key
`TENANT_NOT_IN_SCOPE`	Selected tenant is outside API-key scope
`NOT_ACCEPTABLE`	Requested response media type is unavailable
`RATE_LIMIT_EXCEEDED`	API-key rate limit was exceeded
`INTERNAL_SERVER_ERROR`	Unexpected server failure

The operation response list and Error handling page are authoritative for complete handling.

Before implementation

Generate and log a new X-Request-ID for the attempt.
Handle every documented response status.
Do not log X-API-Key or unnecessary personal data.
Reconcile current resource state before replaying an ambiguous write.

Related integration guidance

Review the complete process, state, retry, and operational pattern for this operation.

Authorizations

X-API-Key

string

header

required

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.

Headers

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}$

Query Parameters

page

integer

inactive

optional

server default: 1

not sent by default

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

Required range: x >= 1Must be a multiple of 1

Example:

1

pageSize

integer

inactive

optional

server default: 100

not sent by default

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

Required range: 1 <= x <= 1000Must be a multiple of 1

Example:

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.

Response

A page of payroll export documents.

One page of payroll export documents.

page

integer

required

Current one-based page number.

Must be a multiple of 1

Example:

1

pageSize

integer

required

Maximum number of resources returned per page.

Must be a multiple of 1

Example:

100

totalPages

integer

required

Number of available pages.

Must be a multiple of 1

Example:

1

totalElements

integer

required

Number of resources matching the request.

Must be a multiple of 1

Example:

2

items

object[]

required

Payroll export documents on the current page.

Show child attributes

Last modified on August 27, 2026

Overview

Data Models

Specification

List payroll export documents

At a glance

Operational behavior

Common errors

Before implementation

Related integration guidance

Authorizations

Headers

Query Parameters

Response

​At a glance

​Operational behavior

​Common errors

​Before implementation

Related integration guidance

Authorizations

Headers

Query Parameters

Response

At a glance

Operational behavior

Common errors

Before implementation