Tax Filing Service
| POST | /CheckElster | A synchronous service to perform basic checks on a batch of tax data. |
|---|
using System;
using System.IO;
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.xEric.Core.Services.Contracts.Responses;
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 CheckElster
: CheckElsterBase
{
}
///<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 CheckElsterBase
: IPost
{
///<summary>
///The ELSTER tax data to check.
///</summary>
[ApiMember(Description="The ELSTER tax data to check.", Name="Data")]
public virtual TaxData Data { get; set; }
}
}
namespace PwC.xEric.Core.Services.Contracts.Responses
{
///<summary>
///Represents a type that encapulates the state of a provided ELSTER tax data.
///</summary>
[Api(Description="Represents a type that encapulates the state of a provided ELSTER tax data.")]
public partial class ElsterCheckResponse
: ServiceReponseBase
{
///<summary>
///Checks whether a portal certificate is required to sign the tax data.
///</summary>
[ApiMember(Description="Checks whether a portal certificate is required to sign the tax data.")]
public virtual bool ZertifikatErforderlich { get; set; }
///<summary>
///Checks whether a Manufacturer ID has been provided for the tax data.
///</summary>
[ApiMember(Description="Checks whether a Manufacturer ID has been provided for the tax data.")]
public virtual bool HatHerstellerId { get; set; }
///<summary>
///Checks whether a data provider has been provided for the tax data.
///</summary>
[ApiMember(Description="Checks whether a data provider has been provided for the tax data.")]
public virtual bool HatDatenlieferant { get; set; }
///<summary>
///Checks whether the PDF-based transfer protocol for the tax data can be printed out for the type of tax data.
///</summary>
[ApiMember(Description="Checks whether the PDF-based transfer protocol for the tax data can be printed out for the type of tax data.")]
public virtual bool TransferProtokollDruckbar { get; set; }
}
///<summary>
///Specifies a service response from an ERiC service operation.
///</summary>
[Api(Description="Specifies a service response from an ERiC service operation.")]
public partial class ServiceReponseBase
: IHasIndex
{
///<summary>
///The unique identifier of the response.
///</summary>
[ApiMember(Description="The unique identifier of the response.")]
public virtual string Id { get; set; }
///<summary>
///The position of the response element in an indexed collection.
///</summary>
[ApiMember(Description="The position of the response element in an indexed collection.")]
public virtual int Index { get; set; }
///<summary>
///Metadata that contains structured error information on the service response.
///</summary>
[ApiMember(Description="Metadata that contains structured error information on the service response.")]
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: 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>