DATEV Document Sync Configuration Items

Dieser Inhalt ist noch nicht in deiner Sprache verfügbar.

List of valid attributes:

Attribute	Description	Specifics
datev_integration_id	ID of the DATEV integration this configuration item belongs to	Cannot be set
document_type	DATEV document type to sync	Required on create. Cannot be updated. Either `LOBN` or `LSTB`
label_assignments (create)	Array of account label IDs to attach to synced documents	Create only. Optional.
label_assignments (update)		Update only. Optional. Shape differs from create — see nested fields below
account_label_id	ID of the account label to add or delete	Update only (inside each `label_assignments` object)
_delete	Indicator to delete the label assignment	Update only. Omit unless deleting; set to `true` to remove

The following relationships can be included in requests:

Relationship	Type
label_assignments	has many

Meta data: Permissions

Group	Description
actions	Contains permissions if current user can `edit` or `delete` the configuration item

Create

Example request:

{
  "data": {
    "type": "datev_document_sync_configuration_item",
    "attributes": {
      "document_type": "LOBN",
      "label_assignments": ["8be72e8b-a021-4f17-9952-443ba965e31f"]
    }
  }
}

Example response:

{
  "data": {
    "id": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
    "type": "datev_document_sync_configuration_item",
    "attributes": {
      "datev_integration_id": "1b0f5d3c-e612-43fe-bd0d-4bf9cd903873",
      "document_type": "LOBN"
    }
  }
}

This endpoint creates a new configuration item for a payroll documents DATEV integration.

HTTP Request

POST /api/v1/datev_integrations/:datev_integration_id/configuration_items

URL Parameters

Parameter	Description
datev_integration_id	The ID of the DATEV integration to add a configuration item to

List

Example response:

{
  "data": [
    {
      "id": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
      "type": "datev_document_sync_configuration_item",
      "attributes": {
        "datev_integration_id": "1b0f5d3c-e612-43fe-bd0d-4bf9cd903873",
        "document_type": "LOBN"
      }
    }
  ]
}

This endpoint returns all datev_document_sync_configuration_items associated with a DATEV integration.

HTTP Request

GET /api/v1/datev_integrations/:datev_integration_id/configuration_items

URL Parameters

Parameter	Description
datev_integration_id	The ID of the DATEV integration whose configuration items you want to retrieve

Update

Example request:

{
  "data": {
    "type": "datev_document_sync_configuration_item",
    "attributes": {
      "label_assignments": [
        { "account_label_id": "2dfdd8d7-418b-40fd-b98a-f8e531a363e0" },
        {
          "account_label_id": "99a7c77d-fecc-4a2e-9e7c-f1b44e475ac0",
          "_delete": true
        }
      ]
    }
  }
}

Example response:

{
  "data": {
    "id": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
    "type": "datev_document_sync_configuration_item",
    "attributes": {
      "datev_integration_id": "1b0f5d3c-e612-43fe-bd0d-4bf9cd903873",
      "document_type": "LOBN"
    }
  }
}

This endpoint updates the label assignments of an existing configuration item. Labels are added or removed (_delete: true) accordingly. The document_type cannot be changed via this endpoint.

HTTP Request

PUT /api/v1/datev_integrations/:datev_integration_id/configuration_items/:configuration_item_id

URL Parameters

Parameter	Description
datev_integration_id	The ID of the DATEV integration
configuration_item_id	The ID of the DATEV document sync configuration item

Show

Example response:

{
  "data": {
    "id": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
    "type": "datev_document_sync_configuration_item",
    "attributes": {
      "datev_integration_id": "1b0f5d3c-e612-43fe-bd0d-4bf9cd903873",
      "document_type": "LOBN"
    }
  }
}

This endpoint returns a configuration item.

HTTP Request

GET /api/v1/datev_integrations/:datev_integration_id/configuration_items/:configuration_item_id

URL Parameters

Parameter	Description
datev_integration_id	The ID of the DATEV integration
configuration_item_id	The ID of the DATEV document sync configuration item to retrieve

Delete

Example response:

{
  "data": {
    "id": "278c7d3-eb7d-4150-867b-dd8e77de9abf",
    "type": "datev_document_sync_configuration_item",
    "attributes": {
      ...
    }
  }
}

This endpoint deletes the specified DATEV document sync configuration item.

HTTP Request

DELETE /api/v1/datev_integrations/:datev_integration_id/configuration_items/:configuration_item_id

URL Parameters

Parameter	Description
datev_integration_id	The ID of the DATEV integration
configuration_item_id	The ID of the DATEV document sync configuration item to delete