Tax Filing Service

<back to all web services

BatchValidiereUndHoleDruckvorschauAsync

AsyncBearbeiteVorgangValidiereDruckeBatch

An asynchronous service to validate batch of tax data and preview its protocol printout.

Requires Authentication
The following routes are available for this service:
POST/BatchValidiereUndHoleDruckvorschauAsyncAn asynchronous service to validate batch of tax data and preview its protocol printout.
import Foundation
import ServiceStack

/**
* An asynchronous service to validate batch of tax data and preview its protocol printout.
*/
// @Api(Description="An asynchronous service to validate batch of tax data and preview its protocol printout.")
public class BatchValidiereUndHoleDruckvorschauAsync : BatchValidiereUndHoleDruckvorschauBase
{
    /**
    * 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 var duplexDruck:Bool?

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

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

    /**
    * The batch of tax data to process.
    */
    // @ApiMember(Description="The batch of tax data to process.", Name="Data")
    public var data:[TaxData] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case duplexDruck
        case protocolPrefix
        case fussText
        case data
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        duplexDruck = try container.decodeIfPresent(Bool.self, forKey: .duplexDruck)
        protocolPrefix = try container.decodeIfPresent(String.self, forKey: .protocolPrefix)
        fussText = try container.decodeIfPresent(String.self, forKey: .fussText)
        data = try container.decodeIfPresent([TaxData].self, forKey: .data) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if duplexDruck != nil { try container.encode(duplexDruck, forKey: .duplexDruck) }
        if protocolPrefix != nil { try container.encode(protocolPrefix, forKey: .protocolPrefix) }
        if fussText != nil { try container.encode(fussText, forKey: .fussText) }
        if data.count > 0 { try container.encode(data, forKey: .data) }
    }
}

/**
* A base service to validate batch of tax data and preview its protocol printout.
*/
// @Api(Description="A base service to validate batch of tax data and preview its protocol printout.")
public class BatchValidiereUndHoleDruckvorschauBase : BatchBearbeiteVorgangBase, IDruckRequest
{
    /**
    * 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 var duplexDruck:Bool?

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

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

    /**
    * The batch of tax data to process.
    */
    // @ApiMember(Description="The batch of tax data to process.", Name="Data")
    public var data:[TaxData] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case duplexDruck
        case protocolPrefix
        case fussText
        case data
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        duplexDruck = try container.decodeIfPresent(Bool.self, forKey: .duplexDruck)
        protocolPrefix = try container.decodeIfPresent(String.self, forKey: .protocolPrefix)
        fussText = try container.decodeIfPresent(String.self, forKey: .fussText)
        data = try container.decodeIfPresent([TaxData].self, forKey: .data) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if duplexDruck != nil { try container.encode(duplexDruck, forKey: .duplexDruck) }
        if protocolPrefix != nil { try container.encode(protocolPrefix, forKey: .protocolPrefix) }
        if fussText != nil { try container.encode(fussText, forKey: .fussText) }
        if data.count > 0 { try container.encode(data, forKey: .data) }
    }
}

/**
* A base service to process a batch of tax data.
*/
// @Api(Description="A base service to process a batch of tax data.")
public class BatchBearbeiteVorgangBase : IPost, Codable
{
    /**
    * The batch of tax data to process.
    */
    // @ApiMember(Description="The batch of tax data to process.", Name="Data")
    public var data:[TaxData] = []

    required public init(){}
}

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

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

    required public init(){}
}


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

<BatchValidiereUndHoleDruckvorschauAsync 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>
  <DuplexDruck>false</DuplexDruck>
  <FussText>String</FussText>
  <ProtocolPrefix>String</ProtocolPrefix>
</BatchValidiereUndHoleDruckvorschauAsync>
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>