Tax Filing Service

<back to all web services

CheckElster

SyncÜberprüfung

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

Requires Authentication
The following routes are available for this service:
POST/CheckElsterA 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.*;

public class dtos
{

    /**
    * 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.")
    public static class CheckElster extends 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.")
    public static class CheckElsterBase implements IPost
    {
        /**
        * The ELSTER tax data to check.
        */
        @ApiMember(Description="The ELSTER tax data to check.", Name="Data")
        public TaxData data = null;
        
        public TaxData getData() { return data; }
        public CheckElsterBase setData(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; }
    }

    /**
    * 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.")
    public static class ElsterCheckResponse extends 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.")
        public Boolean zertifikatErforderlich = 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.")
        public Boolean hatHerstellerId = 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.")
        public Boolean hatDatenlieferant = 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.")
        public Boolean transferProtokollDruckbar = null;
        
        public Boolean isZertifikatErforderlich() { return zertifikatErforderlich; }
        public ElsterCheckResponse setZertifikatErforderlich(Boolean value) { this.zertifikatErforderlich = value; return this; }
        public Boolean isHatHerstellerId() { return hatHerstellerId; }
        public ElsterCheckResponse setHatHerstellerId(Boolean value) { this.hatHerstellerId = value; return this; }
        public Boolean isHatDatenlieferant() { return hatDatenlieferant; }
        public ElsterCheckResponse setHatDatenlieferant(Boolean value) { this.hatDatenlieferant = value; return this; }
        public Boolean isTransferProtokollDruckbar() { return transferProtokollDruckbar; }
        public ElsterCheckResponse setTransferProtokollDruckbar(Boolean value) { this.transferProtokollDruckbar = value; return this; }
    }

    /**
    * Specifies a service response from an ERiC service operation.
    */
    @Api(Description="Specifies a service response from an ERiC service operation.")
    public static class ServiceReponseBase implements IHasIndex
    {
        /**
        * The unique identifier of the response.
        */
        @ApiMember(Description="The unique identifier of the response.")
        public String id = null;

        /**
        * The position of the response element in an indexed collection.
        */
        @ApiMember(Description="The position of the response element in an indexed collection.")
        public Integer index = null;

        /**
        * Metadata that contains structured error information on the service response.
        */
        @ApiMember(Description="Metadata that contains structured error information on the service response.")
        public ResponseStatus responseStatus = null;
        
        public String getId() { return id; }
        public ServiceReponseBase setId(String value) { this.id = value; return this; }
        public Integer getIndex() { return index; }
        public ServiceReponseBase setIndex(Integer value) { this.index = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public ServiceReponseBase setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

Java CheckElster 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 /CheckElster 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
		}
	}
}