<back to all web services

CheckElster

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

import Foundation
import ServiceStack

/**
* 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 class CheckElster : CheckElsterBase
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

/**
* 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 class CheckElsterBase : IPost, Codable
{
    /**
    * The ELSTER tax data to check.
    */
    // @ApiMember(Description="The ELSTER tax data to check.", Name="Data")
    public var data:TaxData

    required public init(){}
}

/**
* Represents a structure that encapsulates a tax declaration.
*/
// @Api(Description="Represents a structure that encapsulates a tax declaration.")
public class TaxData : Codable
{
    /**
    * The unique identifier of the tax data.
    */
    // @ApiMember(Description="The unique identifier of the tax data.", IsRequired=true)
    public var id:String

    /**
    * The XML-based tax declaration.
    */
    // @ApiMember(Description="The XML-based tax declaration.", IsRequired=true)
    public var content:String

    required public init(){}
}

/**
* 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 class ElsterCheckResponse : 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 var zertifikatErforderlich:Bool

    /**
    * 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 var hatHerstellerId:Bool

    /**
    * 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 var hatDatenlieferant:Bool

    /**
    * 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 var transferProtokollDruckbar:Bool

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case zertifikatErforderlich
        case hatHerstellerId
        case hatDatenlieferant
        case transferProtokollDruckbar
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        zertifikatErforderlich = try container.decodeIfPresent(Bool.self, forKey: .zertifikatErforderlich)
        hatHerstellerId = try container.decodeIfPresent(Bool.self, forKey: .hatHerstellerId)
        hatDatenlieferant = try container.decodeIfPresent(Bool.self, forKey: .hatDatenlieferant)
        transferProtokollDruckbar = try container.decodeIfPresent(Bool.self, forKey: .transferProtokollDruckbar)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if zertifikatErforderlich != nil { try container.encode(zertifikatErforderlich, forKey: .zertifikatErforderlich) }
        if hatHerstellerId != nil { try container.encode(hatHerstellerId, forKey: .hatHerstellerId) }
        if hatDatenlieferant != nil { try container.encode(hatDatenlieferant, forKey: .hatDatenlieferant) }
        if transferProtokollDruckbar != nil { try container.encode(transferProtokollDruckbar, forKey: .transferProtokollDruckbar) }
    }
}

/**
* Specifies a service response from an ERiC service operation.
*/
// @Api(Description="Specifies a service response from an ERiC service operation.")
public class ServiceReponseBase : IHasIndex, Codable
{
    /**
    * The unique identifier of the response.
    */
    // @ApiMember(Description="The unique identifier of the response.")
    public var id:String

    /**
    * The position of the response element in an indexed collection.
    */
    // @ApiMember(Description="The position of the response element in an indexed collection.")
    public var index:Int

    /**
    * Metadata that contains structured error information on the service response.
    */
    // @ApiMember(Description="Metadata that contains structured error information on the service response.")
    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift CheckElster DTOs

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"}}}