WSE · Schnittstellen

DATEV

Verbinden Sie WSE mit Ihren Anwendungen. Entdecken Sie Endpunkte, Datenmodelle und Schnittstellen – nach Funktionsbereichen und Add-ons geordnet.

OpenAPI herunterladen ↓
REST · JSONBearer-Authentifizierung
API docs by Redocly

DATEV

ERP API Dokumentation

DATEV-Anbindung

Add-on erforderlich: DATEV. Die Nutzung setzt das freigeschaltete Add-on und passende Benutzerberechtigungen voraus.

Get Connection

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/datev/connection' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "generation": "9f472193-7598-4291-926c-6d116edc9e9b",
  • "accounting_client": "string",
  • "state": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "authorized_by": "string",
  • "company_name": "string"
}

Connect

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request POST \
  --url 'https://your-instance.example.invalid/datev/connection' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "authorization_url": "string"
}

Disconnect

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request DELETE \
  --url 'https://your-instance.example.invalid/datev/connection' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Document Types

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/datev/document-types' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "document_types": [
    ]
}

Get Configuration

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/datev/configuration' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "account_length": 4,
  • "fiscal_year_month": 1,
  • "fiscal_year_day": 1,
  • "chart": "string",
  • "rules": [
    ],
  • "document_types": {
    }
}

Set Configuration

Authorizations:
BearerAuth
Request Body schema: application/json
required
account_length
required
integer (Account Length) [ 4 .. 8 ]
chart
required
string (Chart) ^\d{2}$
required
Array of objects (Rules) <= 1000 items
Array (<= 1000 items)
document_kind
required
string (Document Kind)
Enum: "invoice" "corrective_invoice" "self_billing_invoice"
source_account
required
string (Source Account) ^\d{4,8}$
required
Tax Rate (number) or Tax Rate (string) (Tax Rate)
target_account
required
string (Target Account) ^\d{4,8}$
Tax Key (string) or Tax Key (null) (Tax Key)
automatic_tax_account
boolean (Automatic Tax Account)
Default: false
fiscal_year_month
integer (Fiscal Year Month) [ 1 .. 12 ]
Default: 1
fiscal_year_day
integer (Fiscal Year Day) [ 1 .. 28 ]
Default: 1
object (Document Types)
property name*
additional property
string [ 1 .. 30 ] characters

Responses

Request samples

Content type
application/json
{
  • "account_length": 4,
  • "fiscal_year_month": 1,
  • "fiscal_year_day": 1,
  • "chart": "string",
  • "rules": [
    ],
  • "document_types": {
    }
}

Response samples

Content type
application/json
{
  • "account_length": 4,
  • "fiscal_year_month": 1,
  • "fiscal_year_day": 1,
  • "chart": "string",
  • "rules": [
    ],
  • "document_types": {
    }
}

Get Counterparty

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid> (Customer Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/datev/counterparties/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "creditor_account": "string",
  • "country_code": "string",
  • "vat_id": "string"
}

Set Counterparty

Authorizations:
BearerAuth
path Parameters
customer_id
required
string <uuid> (Customer Id)
Request Body schema: application/json
required
country_code
required
string (Country Code) ^[A-Z]{2}$
Creditor Account (string) or Creditor Account (null) (Creditor Account)
Any of
string (Creditor Account) ^[7-9]\d{4,8}$
Vat Id (string) or Vat Id (null) (Vat Id)
Any of
string (Vat Id) ^[A-Z]{2}[A-Za-z0-9]{2,13}$

Responses

Request samples

Content type
application/json
{
  • "creditor_account": "string",
  • "country_code": "string",
  • "vat_id": "string"
}

Response samples

Content type
application/json
{
  • "creditor_account": "string",
  • "country_code": "string",
  • "vat_id": "string"
}

Preview

Authorizations:
BearerAuth
Request Body schema: application/json
required
start_date
required
string <date> (Start Date)
end_date
required
string <date> (End Date)
master_data_only
boolean (Master Data Only)
Default: false
customer_ids
Array of strings <uuid> (Customer Ids) <= 1000 items [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "master_data_only": false,
  • "customer_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "state": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "config_snapshot": {
    },
  • "documents": [
    ],
  • "artifacts": [
    ],
  • "approved_by": "string",
  • "error_code": "string"
}

Approve

Authorizations:
BearerAuth
path Parameters
run_id
required
string <uuid> (Run Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request POST \
  --url 'https://your-instance.example.invalid/datev/runs/497f6eca-6276-4993-bfeb-53cbbbba6f08/approve' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "state": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "config_snapshot": {
    },
  • "documents": [
    ],
  • "artifacts": [
    ],
  • "approved_by": "string",
  • "error_code": "string"
}

Runs

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/datev/runs' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Run

Authorizations:
BearerAuth
path Parameters
run_id
required
string <uuid> (Run Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/datev/runs/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "state": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "config_snapshot": {
    },
  • "documents": [
    ],
  • "artifacts": [
    ],
  • "approved_by": "string",
  • "error_code": "string"
}

Download

Authorizations:
BearerAuth
path Parameters
run_id
required
string <uuid> (Run Id)
artifact_id
required
string <uuid> (Artifact Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/datev/runs/497f6eca-6276-4993-bfeb-53cbbbba6f08/artifacts/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  --header 'Accept: application/pdf' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Resend

Authorizations:
BearerAuth
path Parameters
run_id
required
string <uuid> (Run Id)
artifact_id
required
string <uuid> (Artifact Id)
Request Body schema: application/json
required
reason
required
string (Reason) [ 10 .. 500 ] characters

Responses

Request samples

Content type
application/json
{
  • "reason": "stringstri"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "state": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "config_snapshot": {
    },
  • "documents": [
    ],
  • "artifacts": [
    ],
  • "approved_by": "string",
  • "error_code": "string"
}

Reconcile

Authorizations:
BearerAuth
path Parameters
run_id
required
string <uuid> (Run Id)
artifact_id
required
string <uuid> (Artifact Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request POST \
  --url 'https://your-instance.example.invalid/datev/runs/497f6eca-6276-4993-bfeb-53cbbbba6f08/artifacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/reconcile' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "state": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "config_snapshot": {
    },
  • "documents": [
    ],
  • "artifacts": [
    ],
  • "approved_by": "string",
  • "error_code": "string"
}

Resume

Authorizations:
BearerAuth
path Parameters
run_id
required
string <uuid> (Run Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request POST \
  --url 'https://your-instance.example.invalid/datev/runs/497f6eca-6276-4993-bfeb-53cbbbba6f08/resume' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "state": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "config_snapshot": {
    },
  • "documents": [
    ],
  • "artifacts": [
    ],
  • "approved_by": "string",
  • "error_code": "string"
}