> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Download Employee Document
> Download a document from DATEV
This endpoint requires the permission **Manage documents** to be enabled in [your scope config](/scopes).
### Example Request Body
```json theme={null}
{
"accounting_month": "2001-12-01",
"document_type": "LOJE"
}
```
## OpenAPI
````yaml POST /custom/datev/employees/{employee_id}/download-document
openapi: 3.1.0
info:
title: Kombo API
version: 1.0.0
servers:
- url: https://api.kombo.dev/v1
description: Kombo EU API
- url: https://api.us.kombo.dev/v1
description: Kombo US API
security:
- ApiKey: []
tags:
- name: General
- name: Kombo Connect
description: >-
Endpoints for Kombo Connect, our end-user-facing flow for setting up new
integrations.
- name: Unified HRIS API
description: Unified endpoints to access all the HR concepts you might need.
- name: Unified ATS API
description: Unified endpoints to access all the ATS concepts you might need.
- name: Unified ATS (Assessment & Background Check) API
description: >-
Unified endpoints to operate Assessments and Background Checks for many
applicant tracking systems.
- name: Unified LMS API
description: Unified endpoints to access all the LMS concepts you might need.
- name: AI Apply
description: Endpoints for AI-powered job application features.
- name: Custom Endpoints
description: Custom integration-specific endpoints.
paths:
/custom/datev/employees/{employee_id}/download-document:
post:
tags:
- Custom Endpoints
summary: Download Payroll Document
description: |-
Download a document from DATEV
This endpoint requires the permission **Manage documents** to be enabled in [your scope config](/scopes).
### Example Request Body
```json
{
"accounting_month": "2001-12-01",
"document_type": "LOJE"
}
```
operationId: PostCustomDatevEmployeesEmployeeIdDownloadDocument
parameters:
- in: header
name: X-Integration-Id
schema:
type: string
description: ID of the integration you want to interact with.
example: datev:HWUTwvyx2wLoSUHphiWVrp28
required: true
- name: employee_id
in: path
required: true
description: >-
POST /custom/datev/employees/:employee_id/download-document
Parameter
schema:
$ref: >-
#/components/schemas/PostCustomDatevEmployeesEmployeeIdDownloadDocumentParameterEmployeeId
examples:
example1:
value: null
example2:
value: remote:200
requestBody:
description: >-
POST /custom/datev/employees/:employee_id/download-document Request
body
content:
application/json:
schema:
$ref: >-
#/components/schemas/PostCustomDatevEmployeesEmployeeIdDownloadDocumentRequestBody
examples:
example1:
value:
accounting_month: '2001-12-01'
document_type: LOJE
example2:
value:
accounting_month: '2001-12-01'
document_type: LSTB
responses:
'200':
description: >-
POST /custom/datev/employees/:employee_id/download-document Positive
response
content:
application/json:
schema:
$ref: >-
#/components/schemas/PostCustomDatevEmployeesEmployeeIdDownloadDocumentPositiveResponse
default:
$ref: '#/components/responses/ErrorResponseGeneral'
components:
schemas:
PostCustomDatevEmployeesEmployeeIdDownloadDocumentParameterEmployeeId:
type:
- string
- 'null'
PostCustomDatevEmployeesEmployeeIdDownloadDocumentRequestBody:
type: object
properties:
accounting_month:
description: The month to request the document for.
type: string
format: date-time
pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$
externalDocs:
url: >-
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
document_type:
type: string
enum:
- AANB
- ABEG
- BUBE
- DAWE
- KBNW
- KOST
- KOTR
- LKTO
- LOBN
- LJOE
- LOJE
- LOJO
- LOPE
- LOPN
- LOPS
- LORE
- LOWE
- LSTA
- LSTB
- LSTE
- PDAT
- PFAN
- PRZA
- SBNW
- SVNW
- WEAN
- ZABR
- ZAKF
- ZAUW
description: |-
Brutto/Netto (LOBN)
Lohnsteuerbescheinigung (german/english) (LSTB/LSTE)
SV-Nachweis (SVNW)
A1-Bescheinigung (ABEG)
Antragsbestätigung A1-Bescheinigung (AANB)
Buchungsbeleg (BUBE)
Lohnjournal (german/english) (LOJO/LJOE)
Lohnsteueranmeldung (LSTA)
Beitragsnachweis (KBNW)
Beitragsnachweis-Erläuterung (SBNW)
Übersicht Zahlungen (ZAKF)
DÜ Zahlungen (PRZA)
Barauszahlungswerte (ZABR)
Überzahlungen-Werte (ZAUW)
Personalkostenübersicht (german/english) (LOPS/LOPE)
Kostenstellenwerte (KOST)
Kostenträgerwerte (KOTR)
Lohnartenwerte einfach/erweitert (LOWE/LOPN)
Lohnkonto (LKTO)
Personalreport (LORE)
Mitarbeiterstammdaten (PDAT)
Pfändungswerte (PFAN)
Darlehenswerte (DAWE)
Wertguthaben je Arbeitnehmer (WEAN)
required:
- accounting_month
- document_type
description: >-
The data to request an electronic certificate of incapacity for work
(eAU).
examples:
- accounting_month: '2001-12-01'
document_type: LOJE
- accounting_month: '2001-12-01'
document_type: LSTB
PostCustomDatevEmployeesEmployeeIdDownloadDocumentPositiveResponse:
type: object
properties:
status:
type: string
const: success
data:
type: object
properties:
data_url:
type: string
format: uri
description: The URL to download the document from.
file_name:
type: string
content_type:
type: string
required:
- data_url
- file_name
- content_type
warnings:
type: array
items:
type: object
properties:
message:
type: string
required:
- message
description: >-
These are the interaction warnings that are shown in the dashboard.
They are meant to provide debug information to you. We recommend
logging them to the console.
required:
- status
- data
- warnings
responses:
ErrorResponseGeneral:
description: The standard error response with just the platform error codes.
content:
application/json:
schema:
type: object
properties:
status:
type: string
enum:
- error
error:
type: object
properties:
code:
type:
- string
- 'null'
enum:
- PLATFORM.RATE_LIMIT_EXCEEDED
- PLATFORM.CONCURRENCY_LIMIT_EXCEEDED
- PLATFORM.INTEGRATION_NOT_FOUND
- PLATFORM.INPUT_INVALID
- PLATFORM.UNKNOWN_ERROR
- PLATFORM.IP_NOT_WHITELISTED
- PLATFORM.AUTHENTICATION_INVALID
- PLATFORM.TASK_TIMED_OUT
example: PLATFORM.RATE_LIMIT_EXCEEDED
description: >-
Some errors include an error code that can be used to
identify their cause. See the [Error Handling
Docs](https://docs.kombo.dev/guides/errors) for more
information. For your error handling logic please use the
error `code` instead of other properties (e.g. message,
http status code, ...).
title:
type:
- string
- 'null'
description: A static, human-readable label.
message:
type: string
description: >-
A dynamic, detailed description of what went wrong in this
specific instance.
log_url:
type:
- string
- 'null'
format: uri
description: >-
The log page in the Kombo UI lists every interaction with
full details. If you need assistance, share that link with
our support team.
required:
- code
- title
- message
- log_url
description: Error details with structured code for programmatic handling.
required:
- status
- error
examples:
Error Response:
description: >-
When building error handling logic, always use the `code` field
to identify specific error types programmatically. See the
complete list of error codes in the
[docs](https://docs.kombo.dev/guides/errors).
value:
status: error
error:
code: INTEGRATION.MODEL_NOT_AVAILABLE
title: >-
This data model isn't supported for the selected
integration.
message: >-
The "employees" model is not yet available for Greenhouse.
Please reach out to Kombo if you need this functionality.
log_url: https://app.kombo.dev/my-prod/logs?interactionId=123456
Minimal Error Response:
description: >-
The "message" is always required while other fields can also be
`null`. See the [docs](https://docs.kombo.dev/guides/errors) for
more information.
value:
status: error
error:
code: null
title: null
message: The message is always in the response.
log_url: null
securitySchemes:
ApiKey:
type: http
scheme: bearer
description: >-
Create an API key on the [Secrets](https://app.kombo.dev/secrets) page
in the Kombo dashboard.
````