DATEV Document Syncs

This API handles DATEV document synchronization for your DATEV integration. Each time a sync schedule triggers, a DATEV document sync is created to manage the actual synchronization process.

General

General information about the DATEV Document Syncs API that applies to all endpoints.

List of attributes

Attribute	Description	Specifics
created_at	Timestamp when the document sync was created	Can’t be set, ISO 8601 date-time string
document_types	Types of documents that were synchronized during the document sync	Can’t be set, Array (can be empty), Supported values: LOBN, LSTB
notice	Notice related to the document sync, mainly to provide additional information about the sync	Can’t be set, Optional
range_in_months	Amount of months the initial document sync covers	Must be set on creation, Integer between 1 and 12
status	Status of the document sync	Can’t be set, One of: running, succeeded, succeeded_partially, failed

Example response

{
  "data": {
    "id": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
    "type": "datev_document_sync",
    "attributes": {
      ...
    }
  }
}

Create

This endpoint creates an initial DATEV document sync for a DATEV integration. It returns status 422 if an initial sync already exists for the given integration.

Endpoint

POST /api/v1/datev_integrations/:integration_id/datev_document_syncs

URL Parameters

Parameter	Description
integration_id	ID of the integration to create the document sync for

Example Request Body

{
  "data": {
    "type": "datev_document_sync",
    "attributes": {
      "range_in_months": 6
    }
  }
}

List

This endpoint returns all datev_document_syncs associated with a DATEV integration.

Endpoint

GET /api/v1/datev_integrations/:integration_id/datev_document_syncs

URL Parameters

Parameter	Description
integration_id	ID of the integration of the document syncs to return