Tax Filing Service

<back to all web services

BatchValidiereUndSende

SyncBearbeiteVorgangValidiereSendeBatch

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

Requires Authentication
The following routes are available for this service:
POST/BatchValidiereUndSendeA synchronous service to validate and send batch of tax data.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    /**
    * A synchronous service to validate and send batch of tax data.
    */
    @Api(Description="A synchronous service to validate and send batch of tax data.")
    public static class BatchValidiereUndSende extends BatchValidiereUndSendeBase
    {
        /**
        * Name prefix of the generated transfer protocol file.
        */
        @ApiMember(Description="Name prefix of the generated transfer protocol file.", Name="ProtocolPrefix")
        public String protocolPrefix = null;

        /**
        * Footer text to be used on the printout (optional).
        */
        @ApiMember(Description="Footer text to be used on the printout (optional).", Name="FussText")
        public String fussText = null;

        /**
        * 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.", Name="DuplexDruck")
        public Boolean duplexDruck = null;

        /**
        * The details of the provider that submits batch of tax data.
        */
        @ApiMember(Description="The details of the provider that submits batch of tax data.", Name="DatenLieferant")
        public String datenLieferant = null;

        /**
        * 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="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")
        public Boolean stagingEnabled = null;

        /**
        * The batch of tax data to process.
        */
        @ApiMember(Description="The batch of tax data to process.", Name="Data")
        public ArrayList<TaxData> data = null;
        
        public String getProtocolPrefix() { return protocolPrefix; }
        public BatchValidiereUndSende setProtocolPrefix(String value) { this.protocolPrefix = value; return this; }
        public String getFussText() { return fussText; }
        public BatchValidiereUndSende setFussText(String value) { this.fussText = value; return this; }
        public Boolean isDuplexDruck() { return duplexDruck; }
        public BatchValidiereUndSende setDuplexDruck(Boolean value) { this.duplexDruck = value; return this; }
        public String getDatenLieferant() { return datenLieferant; }
        public BatchValidiereUndSende setDatenLieferant(String value) { this.datenLieferant = value; return this; }
        public Boolean isStagingEnabled() { return stagingEnabled; }
        public BatchValidiereUndSende setStagingEnabled(Boolean value) { this.stagingEnabled = value; return this; }
        public ArrayList<TaxData> getData() { return data; }
        public BatchValidiereUndSende setData(ArrayList<TaxData> value) { this.data = value; return this; }
    }

    /**
    * A base service to validate and send batch of tax data.
    */
    @Api(Description="A base service to validate and send batch of tax data.")
    public static class BatchValidiereUndSendeBase extends BatchBearbeiteVorgangBase implements ISendeRequest, IDruckRequest
    {
        /**
        * Name prefix of the generated transfer protocol file.
        */
        @ApiMember(Description="Name prefix of the generated transfer protocol file.", Name="ProtocolPrefix")
        public String protocolPrefix = null;

        /**
        * Footer text to be used on the printout (optional).
        */
        @ApiMember(Description="Footer text to be used on the printout (optional).", Name="FussText")
        public String fussText = null;

        /**
        * 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.", Name="DuplexDruck")
        public Boolean duplexDruck = null;

        /**
        * The details of the provider that submits batch of tax data.
        */
        @ApiMember(Description="The details of the provider that submits batch of tax data.", Name="DatenLieferant")
        public String datenLieferant = null;

        /**
        * 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="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")
        public Boolean stagingEnabled = null;

        /**
        * The batch of tax data to process.
        */
        @ApiMember(Description="The batch of tax data to process.", Name="Data")
        public ArrayList<TaxData> data = null;
        
        public String getProtocolPrefix() { return protocolPrefix; }
        public BatchValidiereUndSendeBase setProtocolPrefix(String value) { this.protocolPrefix = value; return this; }
        public String getFussText() { return fussText; }
        public BatchValidiereUndSendeBase setFussText(String value) { this.fussText = value; return this; }
        public Boolean isDuplexDruck() { return duplexDruck; }
        public BatchValidiereUndSendeBase setDuplexDruck(Boolean value) { this.duplexDruck = value; return this; }
        public String getDatenLieferant() { return datenLieferant; }
        public BatchValidiereUndSendeBase setDatenLieferant(String value) { this.datenLieferant = value; return this; }
        public Boolean isStagingEnabled() { return stagingEnabled; }
        public BatchValidiereUndSendeBase setStagingEnabled(Boolean value) { this.stagingEnabled = value; return this; }
        public ArrayList<TaxData> getData() { return data; }
        public BatchValidiereUndSendeBase setData(ArrayList<TaxData> value) { this.data = value; return this; }
    }

    /**
    * A base service to process a batch of tax data.
    */
    @Api(Description="A base service to process a batch of tax data.")
    public static class BatchBearbeiteVorgangBase implements IPost
    {
        /**
        * The batch of tax data to process.
        */
        @ApiMember(Description="The batch of tax data to process.", Name="Data")
        public ArrayList<TaxData> data = null;
        
        public ArrayList<TaxData> getData() { return data; }
        public BatchBearbeiteVorgangBase setData(ArrayList<TaxData> value) { this.data = value; return this; }
    }

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

        /**
        * The XML-based tax declaration.
        */
        @ApiMember(Description="The XML-based tax declaration.", IsRequired=true)
        public String content = null;
        
        public String getId() { return id; }
        public TaxData setId(String value) { this.id = value; return this; }
        public String getContent() { return content; }
        public TaxData setContent(String value) { this.content = value; return this; }
    }

}

Java BatchValidiereUndSende 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 /BatchValidiereUndSende HTTP/1.1 
Host: taxfiling.staging.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BatchValidiereUndSende 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>
  <DatenLieferant>String</DatenLieferant>
  <DuplexDruck>false</DuplexDruck>
  <FussText>String</FussText>
  <ProtocolPrefix>String</ProtocolPrefix>
  <StagingEnabled>false</StagingEnabled>
</BatchValidiereUndSende>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfBearbeiteVorgangResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Responses">
  <BearbeiteVorgangResponse>
    <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>
    <StatusCode>ERIC_OK</StatusCode>
    <StatusText>String</StatusText>
    <Rueckgabe>
      <Erfolg>
        <Telenummer>String</Telenummer>
        <Ordnungsbegriff>String</Ordnungsbegriff>
      </Erfolg>
      <Transfers>
        <Transfer>
          <TransferTicket>String</TransferTicket>
        </Transfer>
      </Transfers>
      <FehlerRegelpruefung>
        <Nutzdatenticket>String</Nutzdatenticket>
        <Feldidentifikator>String</Feldidentifikator>
        <Mehrfachzeilenindex>String</Mehrfachzeilenindex>
        <LfdNrVordruck>String</LfdNrVordruck>
        <VordruckZeilennummer>String</VordruckZeilennummer>
        <SemantischerIndex Name="String">String</SemantischerIndex>
        <Untersachbereich>String</Untersachbereich>
        <PrivateKennnummer>String</PrivateKennnummer>
        <RegelName>String</RegelName>
        <FachlicheFehlerId>String</FachlicheFehlerId>
        <Text>String</Text>
      </FehlerRegelpruefung>
      <Hinweis>
        <Nutzdatenticket>String</Nutzdatenticket>
        <Feldidentifikator>String</Feldidentifikator>
        <Mehrfachzeilenindex>String</Mehrfachzeilenindex>
        <LfdNrVordruck>String</LfdNrVordruck>
        <VordruckZeilennummer>String</VordruckZeilennummer>
        <SemantischerIndex Name="String">String</SemantischerIndex>
        <Untersachbereich>String</Untersachbereich>
        <PrivateKennnummer>String</PrivateKennnummer>
        <RegelName>String</RegelName>
        <FachlicheHinweisId>String</FachlicheHinweisId>
        <Text>String</Text>
      </Hinweis>
    </Rueckgabe>
    <Serverantwort>
      <TransferHeader version="String">
        <Verfahren>ElsterAnmeldung</Verfahren>
        <DatenArt>34a</DatenArt>
        <Vorgang>send-Auth</Vorgang>
        <TransferTicket>String</TransferTicket>
        <Testmerker>0</Testmerker>
        <SigUser />
        <Empfaenger id="String">
          <Ziel>BW</Ziel>
        </Empfaenger>
        <HerstellerID>String</HerstellerID>
        <DatenLieferant>String</DatenLieferant>
        <EingangsDatum>00010101000000</EingangsDatum>
        <Datei>
          <Verschluesselung>PKCS#7v1.5</Verschluesselung>
          <Kompression>GZIP</Kompression>
          <TransportSchluessel>String</TransportSchluessel>
          <Erstellung>
            <Eric />
          </Erstellung>
        </Datei>
        <RC>
          <Rueckgabe>
            <Code>String</Code>
            <Text>String</Text>
          </Rueckgabe>
          <Stack>
            <Code>String</Code>
            <Text>String</Text>
          </Stack>
        </RC>
        <VersionClient>String</VersionClient>
        <Zusatz>
          <Info>String</Info>
          <ElsterInfo>String</ElsterInfo>
        </Zusatz>
      </TransferHeader>
      <DatenTeil>
        <Nutzdatenblock>
          <NutzdatenHeader version="String">
            <NutzdatenTicket>String</NutzdatenTicket>
            <Empfaenger id="L">String</Empfaenger>
            <Hersteller>
              <ProduktName>String</ProduktName>
              <ProduktVersion>String</ProduktVersion>
            </Hersteller>
            <DatenLieferant>String</DatenLieferant>
            <RC>
              <Rueckgabe>
                <Code>String</Code>
                <Text>String</Text>
              </Rueckgabe>
              <Stack>
                <Code>String</Code>
                <Text>String</Text>
              </Stack>
            </RC>
            <Zusatz>
              <Info>String</Info>
              <ElsterInfo>String</ElsterInfo>
            </Zusatz>
          </NutzdatenHeader>
          <Nutzdaten />
        </Nutzdatenblock>
      </DatenTeil>
    </Serverantwort>
    <TransferProtocols xmlns:d3p1="http://schemas.datacontract.org/2004/07/PwC.DigitalHub.Utilities.IO.Concretes.Models">
      <d3p1:BinaryFile>
        <Content xmlns="http://schemas.datacontract.org/2004/07/PwC.DigitalHub.Utilities.IO.Core.Contracts.Models">AA==</Content>
        <d3p1:Metadata xmlns:d5p1="http://schemas.datacontract.org/2004/07/PwC.DigitalHub.Utilities.IO.Core.Concretes.Models">
          <d5p1:Extensions xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d5p1:Extensions>
          <d5p1:FullName>String</d5p1:FullName>
          <d5p1:GroupCanExecute>false</d5p1:GroupCanExecute>
          <d5p1:GroupCanRead>false</d5p1:GroupCanRead>
          <d5p1:GroupCanWrite>false</d5p1:GroupCanWrite>
          <d5p1:GroupId>0</d5p1:GroupId>
          <d5p1:LastAccessTime>0001-01-01T00:00:00</d5p1:LastAccessTime>
          <d5p1:LastAccessTimeUtc>0001-01-01T00:00:00</d5p1:LastAccessTimeUtc>
          <d5p1:LastWriteTime>0001-01-01T00:00:00</d5p1:LastWriteTime>
          <d5p1:LastWriteTimeUtc>0001-01-01T00:00:00</d5p1:LastWriteTimeUtc>
          <d5p1:Length>0</d5p1:Length>
          <d5p1:Name>String</d5p1:Name>
          <d5p1:OthersCanExecute>false</d5p1:OthersCanExecute>
          <d5p1:OthersCanRead>false</d5p1:OthersCanRead>
          <d5p1:OthersCanWrite>false</d5p1:OthersCanWrite>
          <d5p1:OwnerCanExecute>false</d5p1:OwnerCanExecute>
          <d5p1:OwnerCanRead>false</d5p1:OwnerCanRead>
          <d5p1:OwnerCanWrite>false</d5p1:OwnerCanWrite>
          <d5p1:UserId>0</d5p1:UserId>
        </d3p1:Metadata>
        <d3p1:Name>String</d3p1:Name>
      </d3p1:BinaryFile>
    </TransferProtocols>
  </BearbeiteVorgangResponse>
</ArrayOfBearbeiteVorgangResponse>