Introduction
Precondition
- The API requires an installed DATEV Document Mangement application within the DATEVconnect server.
- It is necessary that the user opens the application once before the use of the API, for the user to get registered at the application and for the datapath to be detected.
- To use the API the following applications are required: DATEVconnect and DATEVconnect Dokumentenmanagement. They can be order at the DATEV-Shop with the Art.-Nr. 95280 and Art.-Nr 63218.
Access control
This section describes which access rights in the DATEV IAM have an effect on the requests and commands when using the document management API.
The composition of DATEV IAM depends on the different DATEV programs. Each program has its own node where the access rights can be administrated. Therefore, not only the DATEVconnect access rights, which control access to the API resources, but also the master data and DATEV Document Management access rights.
It is the responsibility of the administrator of the DATEV application to give access to the necessary rights.
Menu-extention at the desktop application (available in Version 15.0 SR upwards )
It is possible to start a process directly in DATEV Document Management. In conjunction with the API it is possible to aquire the documents or rather the structure-items that are selected in the application.
This is realised, in a context menu for the listed documents in the Desktop Application, by adding a context menu element beneath the already existing entry „Senden“. Thus, it is possible to retrieve execution data, which has been defined in the registry, as Json data containing the selection of the documents.
The path to register your application in the registry:
Computer\HKEY_LOCAL_MACHINE\SOFTWARE\DATEVRegisteredApplications\DATEV DMS
Registry parameter
| Registry parameter | Description |
| Standard | path to your execution data |
| DisplayName | name of the context menu element |
| Parameters | Replacement character for Command line parameter and Json |
| SupportsSingleDocument | In the result list at the application you can select one document |
| SupportsMultipleDocuments | In the result list at the application you can select one or more documents |
| SupportsSingleStructureItem | In the structure of a document you can select one structure-item (file) |
| SupportsMultipleStructureItems | In the structure of a document you can select one or more structure-items (file) |
Setting of the Json, which include the selection of DATEV Dokumentenmanagement.
| Parameter | Value |
| Meta_data | Area of the information that have nothing to do with the requiring of the documents or rather files. |
| Version | Program version of DATEV Dokumentenmanagement |
| Feature | Type of DATEV Dokumentenmanagement is install |
| Selection | Area describing the selection of documents or structure-items |
| Type | Type of resource |
| Resource | URL to get the selected document respectively structure-item via the API |
| Document_id | GUID of the selected document |
Example for a document selection:
{"meta_data":
{ "version":"12.0", "feature":"DMS" }, "selection": [{ "type":"document", "resource":"https://VAA1DLI0053:58452/datev/api/dms/v1/documents/d787f1bf-a7bb-4bb3-8de1-d5167917afb3", "document_id":"d787f1bf-a7bb-4bb3-8de1-d5167917afb3" }]}