Tax Filing Service

BatchValidiereUndSende

SyncBearbeiteVorgangValidiereSendeBatch

A synchronous service to validate and send batch of tax data.

The following routes are available for this service:
POST	/BatchValidiereUndSende	A synchronous service to validate and send 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 process a batch of tax data.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BatchBearbeiteVorgangBase(IReturn[List[BearbeiteVorgangResponse]], IPost):
    """
    A base service to process a batch of tax data.
    """

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


# @Api(Description="A base service to validate and send batch of tax data.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BatchValidiereUndSendeBase(BatchBearbeiteVorgangBase, ISendeRequest, IDruckRequest):
    """
    A base service to validate and send batch of tax data.
    """

    # @ApiMember(Description="Name prefix of the generated transfer protocol file.", Name="ProtocolPrefix")
    protocol_prefix: Optional[str] = None
    """
    Name prefix of the generated transfer protocol file.
    """


    # @ApiMember(Description="Footer text to be used on the printout (optional).", Name="FussText")
    fuss_text: Optional[str] = None
    """
    Footer text to be used on the printout (optional).
    """


    # @ApiMember(Description="Should the PDF file be prepared for a double-sided printout with a margin for punching?.  True: The straight sides are indented to the left for a stitching margin for punching. False: There is no indentation of the straight sides. The created PDF is only intended for printing pages page by page.", Name="DuplexDruck")
    duplex_druck: Optional[bool] = None
    """
    Should the PDF file be prepared for a double-sided printout with a margin for punching?.  True: The straight sides are indented to the left for a stitching margin for punching. False: There is no indentation of the straight sides. The created PDF is only intended for printing pages page by page.
    """


    # @ApiMember(Description="The details of the provider that submits batch of tax data.", Name="DatenLieferant")
    daten_lieferant: Optional[str] = None
    """
    The details of the provider that submits batch of tax data.
    """


    # @ApiMember(Description="Should the processing of the batch of tax data be staged? If true, batch of tax data is not sent to the production ELSTER servers.", Name="StagingEnabled")
    staging_enabled: Optional[bool] = None
    """
    Should the processing of the batch of tax data be staged? If true, batch of tax data is not sent to the production ELSTER servers.
    """


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


# @Api(Description="A synchronous service to validate and send batch of tax data.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BatchValidiereUndSende(BatchValidiereUndSendeBase):
    """
    A synchronous service to validate and send batch of tax data.
    """

    # @ApiMember(Description="Name prefix of the generated transfer protocol file.", Name="ProtocolPrefix")
    protocol_prefix: Optional[str] = None
    """
    Name prefix of the generated transfer protocol file.
    """


    # @ApiMember(Description="Footer text to be used on the printout (optional).", Name="FussText")
    fuss_text: Optional[str] = None
    """
    Footer text to be used on the printout (optional).
    """


    # @ApiMember(Description="Should the PDF file be prepared for a double-sided printout with a margin for punching?.  True: The straight sides are indented to the left for a stitching margin for punching. False: There is no indentation of the straight sides. The created PDF is only intended for printing pages page by page.", Name="DuplexDruck")
    duplex_druck: Optional[bool] = None
    """
    Should the PDF file be prepared for a double-sided printout with a margin for punching?.  True: The straight sides are indented to the left for a stitching margin for punching. False: There is no indentation of the straight sides. The created PDF is only intended for printing pages page by page.
    """


    # @ApiMember(Description="The details of the provider that submits batch of tax data.", Name="DatenLieferant")
    daten_lieferant: Optional[str] = None
    """
    The details of the provider that submits batch of tax data.
    """


    # @ApiMember(Description="Should the processing of the batch of tax data be staged? If true, batch of tax data is not sent to the production ELSTER servers.", Name="StagingEnabled")
    staging_enabled: Optional[bool] = None
    """
    Should the processing of the batch of tax data be staged? If true, batch of tax data is not sent to the production ELSTER servers.
    """


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

Python BatchValidiereUndSende DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /BatchValidiereUndSende HTTP/1.1 
Host: taxfiling.staging.pwc.de 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"protocolPrefix":"String","fussText":"String","duplexDruck":false,"datenLieferant":"String","stagingEnabled":false,"data":[{"id":"String","content":"String"}]}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[{"rueckgabe":{"erfolg":{"telenummer":["String"],"ordnungsbegriffe":["String"]},"transfers":{"transferList":[{"transferTicket":"String"}]},"fehlerRegelpruefungen":[{"nutzdatenticket":"String","feldidentifikator":"String","mehrfachzeilenindex":"String","lfdNrVordruck":"String","vordruckZeilennummer":"String","semantischeIndexes":[{"name":"String","value":"String"}],"untersachbereich":"String","privateKennnummer":"String","regelName":"String","fachlicheFehlerId":"String","text":"String"}],"hinweise":[{"nutzdatenticket":"String","feldidentifikator":"String","mehrfachzeilenindex":"String","lfdNrVordruck":"String","vordruckZeilennummer":"String","semantischeIndexes":[{"name":"String","value":"String"}],"untersachbereich":"String","privateKennnummer":"String","regelName":"String","fachlicheHinweisId":"String","text":"String"}]},"serverantwort":{"transferHeader":{"version":"String","verfahren":"ElsterAnmeldung","datenArt":"34a","vorgang":"send-Auth","transferTicket":"String","testmerker":"0","sigUser":{"inhalt":{}},"empfaenger":{"id":"String","ziel":"BW"},"herstellerID":"String","datenLieferant":"String","eingangsDatum":"\/Date(-62135596800000-0000)\/","datei":{"verschluesselung":"PKCS#7v1.5","kompression":"GZIP","transportSchluessel":"String","erstellung":{"eric":{"inhalt":{}}}},"rc":{"rueckgabe":{"code":"String","text":"String"},"stack":{"code":"String","text":"String"}},"versionClient":"String","zusatz":{"infos":["String"],"elsterInfos":["String"]}},"datenTeil":{"nutzdatenbloecke":[{"nutzdatenHeader":{"version":"String","nutzdatenTicket":"String","empfaenger":{"id":"L","value":"String"},"hersteller":{"produktName":"String","produktVersion":"String"},"datenLieferant":"String","rc":{"rueckgabe":{"code":"String","text":"String"},"stack":{"code":"String","text":"String"}},"zusatz":{"infos":["String"],"elsterInfos":["String"]}},"nutzdaten":{"inhalt":{}}}]}},"transferProtocols":[{"metadata":{"name":"String","fullName":"String","lastAccessTime":"\/Date(-62135596800000-0000)\/","lastAccessTimeUtc":"\/Date(-62135596800000-0000)\/","lastWriteTime":"\/Date(-62135596800000-0000)\/","lastWriteTimeUtc":"\/Date(-62135596800000-0000)\/","length":0,"userId":0,"groupId":0,"othersCanRead":false,"groupCanExecute":false,"groupCanWrite":false,"groupCanRead":false,"ownerCanExecute":false,"ownerCanWrite":false,"ownerCanRead":false,"othersCanExecute":false,"othersCanWrite":false,"extensions":{"String":"String"}},"name":"String","content":"AA=="}],"statusCode":"ERIC_OK","statusText":"String","id":"String","index":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}]