Tax Filing Service

<back to all web services

BatchValidiereAuthentifiziereUndSende

SyncBearbeiteVorgangValidiereAuthentifiziereSendeBatch

A synchronous service to validate, authenticate and send tax data to the fiscal authorities.

Requires Authentication
The following routes are available for this service:
POST/BatchValidiereAuthentifiziereUndSende
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using PwC.xEric.Core.Services.Contracts.Requests;
using PwC.xEric.Core.Domain.Concretes.Models;
using PwC.DigitalHub.Utilities.IO.Core.Contracts.Models;

namespace PwC.DigitalHub.Utilities.IO.Core.Contracts.Models
{
    ///<summary>
    ///Represents a base class for a file with raw data.
    ///</summary>
    [Api(Description="Represents a base class for a file with raw data.")]
    public partial class FileBase
    {
        public FileBase()
        {
            Content = new byte[]{};
        }

        ///<summary>
        ///The raw data content of the file.
        ///</summary>
        [ApiMember(Description="The raw data content of the file.", Name="Content")]
        public virtual byte[] Content { get; set; }
    }

}

namespace PwC.xEric.Core.Domain.Concretes.Models
{
    ///<summary>
    ///Represents a portal certificate that is protected by a password.
    ///</summary>
    [Api(Description="Represents a portal certificate that is protected by a password.")]
    public partial class PortalCertificate
        : FileBase, ISecuredCertificate, IHasIndex
    {
        public PortalCertificate()
        {
            Tags = new List<string>{};
            Content = new byte[]{};
        }

        ///<summary>
        ///The unique identifier of the certificate.
        ///</summary>
        [ApiMember(Description="The unique identifier of the certificate.")]
        public virtual Guid Id { get; set; }

        ///<summary>
        ///The position of the certificate element in an indexed collection of certificates.
        ///</summary>
        [ApiMember(Description="The position of the certificate element in an indexed collection of certificates.")]
        public virtual int Index { get; set; }

        ///<summary>
        ///The password to protect the certificate from unauthorized access.
        ///</summary>
        [StringLength(255)]
        [ApiMember(Description="The password to protect the certificate from unauthorized access.")]
        public virtual string Pin { get; set; }

        ///<summary>
        ///The description of the certificate.
        ///</summary>
        [StringLength(int.MaxValue)]
        [ApiMember(Description="The description of the certificate.")]
        public virtual string Description { get; set; }

        ///<summary>
        ///Tags that can be used to label or identify the certificate.
        ///</summary>
        [ApiMember(Description="Tags that can be used to label or identify the certificate.")]
        public virtual List<string> Tags { get; set; }

        ///<summary>
        ///Gets or sets the file name of the certificate.
        ///</summary>
        [ApiMember(Description="Gets or sets the file name of the certificate.")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The raw data content of the file.
        ///</summary>
        [ApiMember(Description="The raw data content of the file.", Name="Content")]
        public virtual byte[] Content { get; set; }
    }

    ///<summary>
    ///Represents a structure that encapsulates a tax declaration.
    ///</summary>
    [Api(Description="Represents a structure that encapsulates a tax declaration.")]
    public partial class TaxData
    {
        ///<summary>
        ///The unique identifier of the tax data.
        ///</summary>
        [ApiMember(Description="The unique identifier of the tax data.", IsRequired=true)]
        public virtual string Id { get; set; }

        ///<summary>
        ///The XML-based tax declaration.
        ///</summary>
        [ApiMember(Description="The XML-based tax declaration.", IsRequired=true)]
        public virtual string Content { get; set; }
    }

}

namespace PwC.xEric.Core.Services.Contracts.Requests
{
    ///<summary>
    ///A base service to process a batch of tax data.
    ///</summary>
    [Api(Description="A base service to process a batch of tax data.")]
    public partial class BatchBearbeiteVorgangBase
        : IPost
    {
        public BatchBearbeiteVorgangBase()
        {
            Data = new List<TaxData>{};
        }

        ///<summary>
        ///The batch of tax data to process.
        ///</summary>
        [ApiMember(Description="The batch of tax data to process.", Name="Data")]
        public virtual List<TaxData> Data { get; set; }
    }

    ///<summary>
    ///A synchronous service to validate, authenticate and send tax data to the fiscal authorities.
    ///</summary>
    [Api(Description="A synchronous service to validate, authenticate and send tax data to the fiscal authorities.")]
    public partial class BatchValidiereAuthentifiziereUndSende
        : BatchValidiereAuthentifiziereUndSendeBase
    {
        public BatchValidiereAuthentifiziereUndSende()
        {
            Data = new List<TaxData>{};
        }

        ///<summary>
        ///The authentification certificate.
        ///</summary>
        [ApiMember(Description="The authentification certificate.", Name="Zertifikat")]
        public virtual PortalCertificate Zertifikat { get; set; }

        ///<summary>
        ///Gets or sets the retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax data type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by  '-'. Example: 'K6FG5 - RS32P'.
        ///</summary>
        [ApiMember(Description="Gets or sets the retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax data type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by  '-'. Example: 'K6FG5 - RS32P'.", Name="AbrufCode")]
        public virtual string AbrufCode { get; set; }

        ///<summary>
        ///The details of the provider that submits tax data.
        ///</summary>
        [ApiMember(Description="The details of the provider that submits tax data.", Name="DatenLieferant")]
        public virtual string DatenLieferant { get; set; }

        ///<summary>
        ///Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers.
        ///</summary>
        [ApiMember(Description="Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers.", Name="StagingEnabled")]
        public virtual bool? StagingEnabled { get; set; }

        ///<summary>
        ///The batch of tax data to process.
        ///</summary>
        [ApiMember(Description="The batch of tax data to process.", Name="Data")]
        public virtual List<TaxData> Data { get; set; }
    }

    ///<summary>
    ///A base service to validate, authenticate and send tax data to the fiscal authorities.
    ///</summary>
    [Api(Description="A base service to validate, authenticate and send tax data to the fiscal authorities.")]
    public partial class BatchValidiereAuthentifiziereUndSendeBase
        : BatchBearbeiteVorgangBase, IVeschlueselungsRequest, ISendeRequest
    {
        public BatchValidiereAuthentifiziereUndSendeBase()
        {
            Data = new List<TaxData>{};
        }

        ///<summary>
        ///The authentification certificate.
        ///</summary>
        [ApiMember(Description="The authentification certificate.", Name="Zertifikat")]
        public virtual PortalCertificate Zertifikat { get; set; }

        ///<summary>
        ///Gets or sets the retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax data type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by  '-'. Example: 'K6FG5 - RS32P'.
        ///</summary>
        [ApiMember(Description="Gets or sets the retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax data type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by  '-'. Example: 'K6FG5 - RS32P'.", Name="AbrufCode")]
        public virtual string AbrufCode { get; set; }

        ///<summary>
        ///The details of the provider that submits tax data.
        ///</summary>
        [ApiMember(Description="The details of the provider that submits tax data.", Name="DatenLieferant")]
        public virtual string DatenLieferant { get; set; }

        ///<summary>
        ///Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers.
        ///</summary>
        [ApiMember(Description="Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers.", Name="StagingEnabled")]
        public virtual bool? StagingEnabled { get; set; }

        ///<summary>
        ///The batch of tax data to process.
        ///</summary>
        [ApiMember(Description="The batch of tax data to process.", Name="Data")]
        public virtual List<TaxData> Data { get; set; }
    }

}

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

<BatchValidiereAuthentifiziereUndSende 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>
  <AbrufCode>String</AbrufCode>
  <DatenLieferant>String</DatenLieferant>
  <StagingEnabled>false</StagingEnabled>
  <Zertifikat xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Domain.Concretes.Models">
    <Content xmlns="http://schemas.datacontract.org/2004/07/PwC.DigitalHub.Utilities.IO.Core.Contracts.Models">AA==</Content>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
    <d2p1:Index>0</d2p1:Index>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Pin>String</d2p1:Pin>
    <d2p1:Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Tags>
  </Zertifikat>
</BatchValidiereAuthentifiziereUndSende>
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>