<back to all web services

CheckElster

A synchronous service to perform basic checks on a batch of tax data.

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* A synchronous service to perform basic checks on a batch of tax data.
*/
@Api(Description="A synchronous service to perform basic checks on a batch of tax data.")
open class CheckElster : CheckElsterBase()
{
}

/**
* A base service to perform basic checks on a batch of tax data.
*/
@Api(Description="A base service to perform basic checks on a batch of tax data.")
open class CheckElsterBase : IPost
{
    /**
    * The ELSTER tax data to check.
    */
    @ApiMember(Description="The ELSTER tax data to check.", Name="Data")
    @SerializedName("data") open var Data:TaxData? = null
}

/**
* 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)
    open var id:String? = null

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

/**
* Represents a type that encapulates the state of a provided ELSTER tax data.
*/
@Api(Description="Represents a type that encapulates the state of a provided ELSTER tax data.")
open class ElsterCheckResponse : ServiceReponseBase()
{
    /**
    * Checks whether a portal certificate is required to sign the tax data.
    */
    @ApiMember(Description="Checks whether a portal certificate is required to sign the tax data.")
    open var zertifikatErforderlich:Boolean? = null

    /**
    * Checks whether a Manufacturer ID has been provided for the tax data.
    */
    @ApiMember(Description="Checks whether a Manufacturer ID has been provided for the tax data.")
    open var hatHerstellerId:Boolean? = null

    /**
    * Checks whether a data provider has been provided for the tax data.
    */
    @ApiMember(Description="Checks whether a data provider has been provided for the tax data.")
    open var hatDatenlieferant:Boolean? = null

    /**
    * Checks whether the PDF-based transfer protocol for the tax data can be printed out for the type of tax data.
    */
    @ApiMember(Description="Checks whether the PDF-based transfer protocol for the tax data can be printed out for the type of tax data.")
    open var transferProtokollDruckbar:Boolean? = null
}

/**
* Specifies a service response from an ERiC service operation.
*/
@Api(Description="Specifies a service response from an ERiC service operation.")
open class ServiceReponseBase : IHasIndex
{
    /**
    * The unique identifier of the response.
    */
    @ApiMember(Description="The unique identifier of the response.")
    open var id:String? = null

    /**
    * The position of the response element in an indexed collection.
    */
    @ApiMember(Description="The position of the response element in an indexed collection.")
    override var index:Int? = null

    /**
    * Metadata that contains structured error information on the service response.
    */
    @ApiMember(Description="Metadata that contains structured error information on the service response.")
    open var responseStatus:ResponseStatus? = null
}

Kotlin CheckElster DTOs

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

<CheckElster 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:Content>String</d2p1:Content>
    <d2p1:Id>String</d2p1:Id>
  </Data>
</CheckElster>

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

<ElsterCheckResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Responses">
  <Id>String</Id>
  <Index>0</Index>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <HatDatenlieferant>false</HatDatenlieferant>
  <HatHerstellerId>false</HatHerstellerId>
  <TransferProtokollDruckbar>false</TransferProtokollDruckbar>
  <ZertifikatErforderlich>false</ZertifikatErforderlich>
</ElsterCheckResponse>