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.
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 BatchCheckElster : BatchCheckElsterBase
{
    /**
    * The batch of ELSTER tax data to check.
    */
    // @ApiMember(Description="The batch of ELSTER tax data to check.", Name="Data")
    public var data:[TaxData] = []

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

    private enum CodingKeys : String, CodingKey {
        case data
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        data = try container.decodeIfPresent([TaxData].self, forKey: .data) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if data.count > 0 { try container.encode(data, forKey: .data) }
    }
}

/**
* 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 BatchCheckElsterBase : IPost, Codable
{
    /**
    * The batch of ELSTER tax data to check.
    */
    // @ApiMember(Description="The batch of 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(){}
}


Swift BatchCheckElster DTOs

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

HTTP + X-MSGPACK

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

{"data":[{"id":"String","content":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
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"}}}]