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.

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports PwC.xEric.Core.Services.Contracts.Requests
Imports PwC.xEric.Core.Domain.Concretes.Models
Imports PwC.xEric.Core.Services.Contracts.Responses

Namespace Global

    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 Overridable Property Id As String

            '''<Summary>
            '''The XML-based tax declaration.
            '''</Summary>
            <ApiMember(Description:="The XML-based tax declaration.", IsRequired:=true)>
            Public Overridable Property Content As String
        End Class
    End Namespace

    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
            Inherits CheckElsterBase
        End Class

        '''<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
            Implements IPost
            '''<Summary>
            '''The ELSTER tax data to check.
            '''</Summary>
            <ApiMember(Description:="The ELSTER tax data to check.", Name:="Data")>
            Public Overridable Property Data As TaxData
        End Class
    End Namespace

    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
            Inherits 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 Overridable Property ZertifikatErforderlich As Boolean

            '''<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 Overridable Property HatHerstellerId As Boolean

            '''<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 Overridable Property HatDatenlieferant As Boolean

            '''<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 Overridable Property TransferProtokollDruckbar As Boolean
        End Class

        '''<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
            Implements IHasIndex
            '''<Summary>
            '''The unique identifier of the response.
            '''</Summary>
            <ApiMember(Description:="The unique identifier of the response.")>
            Public Overridable Property Id As String

            '''<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 Overridable Property Index As Integer Implements IHasIndex.Index

            '''<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 Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET CheckElster DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

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

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