DATEV Document Sync Schedules

This API endpoint allows you to manage the synchronization schedules for DATEV documents. You can create, read, update, and delete schedules as part of your DATEV integration and depending on the rights you have.

General

General information about the DATEV Document Sync Schedules API that applies to all endpoints. index returns an array of datev_document_sync_schedules, all other endpoints return a single datev_document_sync_schedule.

List of valid attributes

Attribute	Description	Specifics
day	Day of the month when the document sync is scheduled	Required. Integer. Range: 1 – 31, Unique per integration

Meta data: Permissions

Group	Description
actions	Contains permissions if current user can edit or delete the schedule

Example response

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "type": "datev_document_sync_schedule",
    "attributes": {
      ...
    }
  }
}

Create

This endpoint creates a datev_document_sync_schedule.

Endpoint

POST /api/v1/datev_integrations/:integration_id/datev_document_sync_schedules

URL Parameters

Parameter	Description
integration_id	ID of the integration to return

Example request

{
  "data": {
    "type": "datev_document_sync_schedule",
    "attributes": {
      "day": 15
    }
  }
}

Update

This endpoint updates a datev_document_sync_schedule.

Endpoint

PATCH /api/v1/datev_integrations/:integration_id/datev_document_sync_schedules/:id

URL Parameters

Parameter	Description
integration_id	ID of the integration of the document sync schedule to update
id	ID of the document sync schedule to update

Example request

{
  "data": {
    "type": "datev_document_sync_schedule",
    "attributes": {
      "day": 20
    }
  }
}

Delete

This endpoint deletes a datev_document_sync_schedule.

Endpoint

DELETE /api/v1/datev_integrations/:integration_id/datev_document_sync_schedules/:id

URL Parameters

Parameter	Description
integration_id	ID of the integration of the document sync schedule to delete
id	ID of the document sync schedule to delete

Show

This endpoint returns a single datev_document_sync_schedule.

Endpoint

GET /api/v1/datev_integrations/:integration_id/datev_document_sync_schedules/:id

URL Parameters

Parameter	Description
integration_id	ID of the integration of the document sync schedule to return
id	ID of the document sync schedule to return

List

This endpoint returns all datev_document_sync_schedules associated with a DATEV integration.

Endpoint

GET /api/v1/datev_integrations/:integration_id/datev_document_sync_schedules

URL Parameters

Parameter	Description
integration_id	ID of the integration of the document sync schedules to return