Tax Filing Service

<back to all web services

BatchValidiereSendeUndDrucke

SyncBearbeiteVorgangValidiereSendeDruckeBatch

A synchronous service to validate tax data and print its transfer protocol.

Requires Authentication
The following routes are available for this service:
POST/BatchValidiereSendeUndDrucke
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* A synchronous service to validate tax data and print its transfer protocol.
*/
@Api(Description="A synchronous service to validate tax data and print its transfer protocol.")
open class BatchValidiereSendeUndDrucke : BatchValidiereSendeUndDruckeBase()
{
    /**
    * 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="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.")
    var duplexDruck:Boolean? = null

    /**
    * Name prefix of the generated transfer protocol file.
    */
    @ApiMember(Description="Name prefix of the generated transfer protocol file.")
    var protocolPrefix:String? = null

    /**
    * Footer text to be used on the printout (optional).
    */
    @ApiMember(Description="Footer text to be used on the printout (optional).")
    var fussText:String? = null

    /**
    * The details of the provider that submits tax data.
    */
    @ApiMember(Description="The details of the provider that submits tax data.")
    var datenLieferant:String? = null

    /**
    * Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers.
    */
    @ApiMember(Description="Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers.")
    var stagingEnabled:Boolean? = null

    /**
    * The batch of tax data to process.
    */
    @ApiMember(Description="The batch of tax data to process.", Name="Data")
    @SerializedName("data") var Data:ArrayList<TaxData> = ArrayList<TaxData>()
}

/**
* A base service to validate tax data and print its transfer protocol.
*/
@Api(Description="A base service to validate tax data and print its transfer protocol.")
open class BatchValidiereSendeUndDruckeBase : BatchBearbeiteVorgangBase(), IDruckRequest, ISendeRequest
{
    /**
    * 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="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.")
    var duplexDruck:Boolean? = null

    /**
    * Name prefix of the generated transfer protocol file.
    */
    @ApiMember(Description="Name prefix of the generated transfer protocol file.")
    var protocolPrefix:String? = null

    /**
    * Footer text to be used on the printout (optional).
    */
    @ApiMember(Description="Footer text to be used on the printout (optional).")
    var fussText:String? = null

    /**
    * The details of the provider that submits tax data.
    */
    @ApiMember(Description="The details of the provider that submits tax data.")
    var datenLieferant:String? = null

    /**
    * Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers.
    */
    @ApiMember(Description="Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers.")
    var stagingEnabled:Boolean? = null

    /**
    * The batch of tax data to process.
    */
    @ApiMember(Description="The batch of tax data to process.", Name="Data")
    @SerializedName("data") var Data:ArrayList<TaxData> = ArrayList<TaxData>()
}

/**
* A base service to process a batch of tax data.
*/
@Api(Description="A base service to process a batch of tax data.")
open class BatchBearbeiteVorgangBase : IPost
{
    /**
    * The batch of tax data to process.
    */
    @ApiMember(Description="The batch of tax data to process.", Name="Data")
    @SerializedName("data") var Data:ArrayList<TaxData> = ArrayList<TaxData>()
}

/**
* Represents a structure that encapsulates a tax declaration.
*/
@Api(Description="Represents a structure that encapsulates a tax declaration.")
open class TaxData
{
    /**
    * The unique identifier of the tax data.
    */
    @ApiMember(Description="The unique identifier of the tax data.", IsRequired=true)
    var id:String? = null

    /**
    * The XML-based tax declaration.
    */
    @ApiMember(Description="The XML-based tax declaration.", IsRequired=true)
    var content:String? = null
}

Kotlin BatchValidiereSendeUndDrucke DTOs

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

HTTP + X-MSGPACK

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

POST /BatchValidiereSendeUndDrucke HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length

{"duplexDruck":false,"protocolPrefix":"String","fussText":"String","datenLieferant":"String","stagingEnabled":false,"data":[{"id":"String","content":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
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"}}}]