<back to all web services

CheckElsterAsync

An asynchronous service to perform basic checks on a batch of tax data.

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')


# @Api(Description="Represents a structure that encapsulates a tax declaration.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TaxData:
    """
    Represents a structure that encapsulates a tax declaration.
    """

    # @ApiMember(Description="The unique identifier of the tax data.", IsRequired=true)
    id: Optional[str] = None
    """
    The unique identifier of the tax data.
    """


    # @ApiMember(Description="The XML-based tax declaration.", IsRequired=true)
    content: Optional[str] = None
    """
    The XML-based tax declaration.
    """


# @Api(Description="A base service to perform basic checks on a batch of tax data.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CheckElsterBase(IReturn[ElsterCheckResponse], IPost):
    """
    A base service to perform basic checks on a batch of tax data.
    """

    # @ApiMember(Description="The ELSTER tax data to check.", Name="Data")
    data: Optional[TaxData] = None
    """
    The ELSTER tax data to check.
    """
    @staticmethod
    def response_type(): return ElsterCheckResponse


# @Api(Description="Specifies a service response from an ERiC service operation.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ServiceReponseBase(IHasIndex):
    """
    Specifies a service response from an ERiC service operation.
    """

    # @ApiMember(Description="The unique identifier of the response.")
    id: Optional[str] = None
    """
    The unique identifier of the response.
    """


    # @ApiMember(Description="The position of the response element in an indexed collection.")
    index: int = 0
    """
    The position of the response element in an indexed collection.
    """


    # @ApiMember(Description="Metadata that contains structured error information on the service response.")
    response_status: Optional[ResponseStatus] = None
    """
    Metadata that contains structured error information on the service response.
    """


# @Api(Description="Represents a type that encapulates the state of a provided ELSTER tax data.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ElsterCheckResponse(ServiceReponseBase):
    """
    Represents a type that encapulates the state of a provided ELSTER tax data.
    """

    # @ApiMember(Description="Checks whether a portal certificate is required to sign the tax data.")
    zertifikat_erforderlich: bool = False
    """
    Checks whether a portal certificate is required to sign the tax data.
    """


    # @ApiMember(Description="Checks whether a Manufacturer ID has been provided for the tax data.")
    hat_hersteller_id: bool = False
    """
    Checks whether a Manufacturer ID has been provided for the tax data.
    """


    # @ApiMember(Description="Checks whether a data provider has been provided for the tax data.")
    hat_datenlieferant: bool = False
    """
    Checks whether a data provider has been provided for the tax data.
    """


    # @ApiMember(Description="Checks whether the PDF-based transfer protocol for the tax data can be printed out for the type of tax data.")
    transfer_protokoll_druckbar: bool = False
    """
    Checks whether the PDF-based transfer protocol for the tax data can be printed out for the type of tax data.
    """


# @Api(Description="An asynchronous service to perform basic checks on a batch of tax data.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CheckElsterAsync(CheckElsterBase):
    """
    An asynchronous service to perform basic checks on a batch of tax data.
    """

    pass

Python CheckElsterAsync DTOs

POST /CheckElsterAsync HTTP/1.1 
Host: taxfiling.staging.pwc.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	data: 
	{
		id: String,
		content: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	zertifikatErforderlich: False,
	hatHerstellerId: False,
	hatDatenlieferant: False,
	transferProtokollDruckbar: False,
	id: String,
	index: 0,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}