Skip to main content
GET
/
custom
/
datev
/
available-documents
Retrieve available documents
curl --request GET \
  --url https://api.kombo.dev/v1/custom/datev/available-documents \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Integration-Id: <x-integration-id>'
{
  "status": "success",
  "data": {
    "results": [
      {
        "document_type": "LOBN",
        "available_for_employees": [
          {
            "id": "8Xi6iZrwusZqJmDGXs49GBmJ",
            "remote_id": "123456"
          }
        ],
        "is_company_document": false
      },
      {
        "document_type": "LOJO",
        "available_for_employees": [],
        "is_company_document": true
      }
    ]
  },
  "warnings": [
    {
      "message": "This is an example warning!"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Create an API key on the Secrets page in the Kombo dashboard.

Headers

​
X-Integration-Id
string
required

ID of the integration you want to interact with.

Query Parameters

​
period
string
required

Provide the period in the format YYYY-MM-DD for which to check for available documents.

Response

GET /custom/datev/available-documents Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required
Example:
{
  "results": [
    {
      "document_type": "LOBN",
      "available_for_employees": [
        {
          "id": "8Xi6iZrwusZqJmDGXs49GBmJ",
          "remote_id": "123456"
        }
      ],
      "is_company_document": false
    },
    {
      "document_type": "LOJO",
      "available_for_employees": [],
      "is_company_document": true
    }
  ]
}
​
warnings
object[]
required

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.