Response parameters

General

Every response has a general part (see below). The element "data" is individual for each endpoint (see tab "Response" of each end point).

All endpoints

HEAD http://host/*

See Response tab

200 General part of the response. Same structure for all endpoints.

{
    "success": Was the request successful; true when yes; false if not,
    "code": Response code of the API; 0 when successful; for possible response codes see https://github.com/MarcinOrlowski/laravel-api-response-builder/blob/master/src/BaseApiCodes.php,
    "locale": Language of the response; „en“ for english,
    "message": Message with the result of the request; „OK“ when successful,
    "data": {
        // returned data, individually determined for every endpoint
        // see Response tab of the endpoint for details
    }    
}

Individuell

USt-VA/ZM/UStE

POST http://host/v1/(ustva|zm|uste)

See tab response

200

{
    ...
    "data": {
        "status": Which processing step the request is at,
        "messages": {
            "text": Message text to the status,
            "data": Additional data for the status,
        },
        "ticket": External given ticket ID (unique for every request),
        "filename": File name of the PDF transfer protocol (if successfully created)
    }
}

Protocol

GET http://host/v1/protocol/:ticket

Get the PDF transfer protocol for the ticket

Path Parameters

Name	Type	Description
ticket	string	Unique ID provided with original request

200 Transfer protocol exists with following content

{
    ...
    "data": {
        "id": Internal ID of transfer protocol,
        "file_name": File name of the pdf transfer protocol,
        "file_content": Content of the pdf transfer protocol as base64-encoded String,
        "log_content": Content of the ERiC log file protocol as text (when present in database),
        "transfer_ticket": ID of the submission process with the tax authorities (printed on the PDF transfer protocol),
        "created_at": Time of creation of the pdf transfer protocol,
        "ticket": {
            // metadata of ticket
            // cf. endpoint ticket
        }
    }
}

Status

GET http://host/v1/status/:ticket

Get internal processing for ticket

Path Parameters

Name	Type	Description
ticket	string	Unique ID provided with original request

200 The ticket has the following status

{
    ...
    "data": {
        "status_type_id": Internal ID of the status type
        "text": Description of the current status and useful information,
        "data": Data related to current state,
        "created_at": Time of creation of the entry with the status for the ticket,
        "updated_at": Time of the last change to the status entry,
        "status_type": {
            "name": Title of the current status,
            "description": Description of the current status,
            "comment": Comment on the current status (optional)
        },
        "ticket": {
            // metadata of ticket
            // cf. endpoint Ticket
        },
        "protocol": {
            // metadata of protocol
            // cf. endpoint Protocol
        }
    }
}

Ticket

GET http://host/v1/ticket/:ticket

Get metadata for ticket

Path Parameters

Name	Type	Description
ticket	string	Unique ID provided with original request

200

{
    ...
    "data": {
        "id": Internal ID (autoincrimented by API),
        "ticket": External given ticket ID (unique for every request),
        "filing": Type of filing,
        "usecase": Use case (validate oder send),
        "client_id": Client ID to identify the end user (optionally passed with every request),
        "client_user": Client name to identify the end user (optionally passed with every request),
        "created_at": Date and time of ticket creation
    }
}

Version

GET http://host/v1/version

Return versions of utilized software

200 Following versions are used

{
    ...
    "data": {
        "api": Internal api version,
        "core": ERiC libraries version,
        "php": PHP version
    }
}

Hook

For the description of the webhook parameters see Webhook.