Tax Filing Service

<back to all web services

BatchCheckElster

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/BatchCheckElsterA synchronous service to perform basic checks on a batch of tax data.
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;

namespace PwC.xEric.Core.Domain.Concretes.Models
{
    ///<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 synchronous service to perform basic checks on a batch of tax data.
    ///</summary>
    [Api(Description="A synchronous service to perform basic checks on a batch of tax data.")]
    public partial class BatchCheckElster
        : BatchCheckElsterBase
    {
        public BatchCheckElster()
        {
            Data = new List<TaxData>{};
        }

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

    ///<summary>
    ///A base service to perform basic checks on a batch of tax data.
    ///</summary>
    [Api(Description="A base service to perform basic checks on a batch of tax data.")]
    public partial class BatchCheckElsterBase
        : IPost
    {
        public BatchCheckElsterBase()
        {
            Data = new List<TaxData>{};
        }

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

}

C# BatchCheckElster 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 /BatchCheckElster HTTP/1.1 
Host: taxfiling.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,
		stagingEnabled: 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
			}
		}
	}
]