Tax Filing Service

CheckElsterAsync

AsyncBearbeiteVorgangÜberprüfung

An asynchronous service to perform basic checks on a batch of tax data.

The following routes are available for this service:
POST	/CheckElsterAsync	An asynchronous 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.*


/**
* An asynchronous service to perform basic checks on a batch of tax data.
*/
@Api(Description="An asynchronous service to perform basic checks on a batch of tax data.")
open class CheckElsterAsync : 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 CheckElsterAsync DTOs

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

HTTP + JSV

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

POST /CheckElsterAsync HTTP/1.1 
Host: taxfiling.staging.pwc.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	data: 
	{
		id: String,
		content: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	zertifikatErforderlich: False,
	hatHerstellerId: False,
	hatDatenlieferant: False,
	transferProtokollDruckbar: False,
	id: String,
	index: 0,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}