Tax Filing Service

CheckElster

SyncÜberprüfung

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

The following routes are available for this service:
POST	/CheckElster	A synchronous service to perform basic checks on a batch of tax data.

namespace PwC.xEric.Core.Domain.Concretes.Models

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Specifies a service response from an ERiC service operation.
    ///</summary>
    [<Api(Description="Specifies a service response from an ERiC service operation.")>]
    [<AllowNullLiteral>]
    type ServiceReponseBase() = 
        ///<summary>
        ///The unique identifier of the response.
        ///</summary>
        [<ApiMember(Description="The unique identifier of the response.")>]
        member val Id:String = null with 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.")>]
        member val Index:Int32 = new Int32() with 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.")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<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.")>]
    [<AllowNullLiteral>]
    type ElsterCheckResponse() = 
        inherit 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.")>]
        member val ZertifikatErforderlich:Boolean = new Boolean() with 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.")>]
        member val HatHerstellerId:Boolean = new Boolean() with 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.")>]
        member val HatDatenlieferant:Boolean = new Boolean() with 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.")>]
        member val TransferProtokollDruckbar:Boolean = new Boolean() with get,set

    ///<summary>
    ///Represents a structure that encapsulates a tax declaration.
    ///</summary>
    [<Api(Description="Represents a structure that encapsulates a tax declaration.")>]
    [<AllowNullLiteral>]
    type TaxData() = 
        ///<summary>
        ///The unique identifier of the tax data.
        ///</summary>
        [<ApiMember(Description="The unique identifier of the tax data.", IsRequired=true)>]
        member val Id:String = null with get,set

        ///<summary>
        ///The XML-based tax declaration.
        ///</summary>
        [<ApiMember(Description="The XML-based tax declaration.", IsRequired=true)>]
        member val Content:String = null with 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.")>]
    [<AllowNullLiteral>]
    type CheckElsterBase() = 
        interface IPost
        ///<summary>
        ///The ELSTER tax data to check.
        ///</summary>
        [<ApiMember(Description="The ELSTER tax data to check.", Name="Data")>]
        member val Data:TaxData = null with get,set

    ///<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.")>]
    [<AllowNullLiteral>]
    type CheckElster() = 
        inherit CheckElsterBase()

F# CheckElster DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}