Tax Filing Service

<back to all web services

BatchCheckElsterAsync

AsyncBearbeiteVorgangÜberprüfung

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

Requires Authentication
The following routes are available for this service:
POST/BatchCheckElsterAsyncAn 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


# @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 BatchCheckElsterBase(IReturn[List[ElsterCheckResponse]], IPost):
    """
    A base service to perform basic checks on a batch of tax data.
    """

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


# @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 BatchCheckElsterAsync(BatchCheckElsterBase):
    """
    An asynchronous service to perform basic checks on a batch of tax data.
    """

    # @ApiMember(Description="The batch of ELSTER tax data to check.", Name="Data")
    data: Optional[List[TaxData]] = None
    """
    The batch of ELSTER tax data to check.
    """

Python BatchCheckElsterAsync DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /BatchCheckElsterAsync HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BatchCheckElsterAsync xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Requests">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Domain.Concretes.Models">
    <d2p1:TaxData>
      <d2p1:Content>String</d2p1:Content>
      <d2p1:Id>String</d2p1:Id>
    </d2p1:TaxData>
  </Data>
</BatchCheckElsterAsync>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfElsterCheckResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Responses">
  <ElsterCheckResponse>
    <Id>String</Id>
    <Index>0</Index>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <HatDatenlieferant>false</HatDatenlieferant>
    <HatHerstellerId>false</HatHerstellerId>
    <StagingEnabled>false</StagingEnabled>
    <TransferProtokollDruckbar>false</TransferProtokollDruckbar>
    <ZertifikatErforderlich>false</ZertifikatErforderlich>
  </ElsterCheckResponse>
</ArrayOfElsterCheckResponse>