Tax Filing Service

<back to all web services

CreateUstSvXmlFromDefinitionAsync

AsyncUmsatzsteuerSondervorauszahlungReturnBuilderDefinition

An asynchronous service to create xml content that represents a filing of the special advance payment for VAT (Umsatzsteuersondervorauszahlung) from the specified dictionary (hash map) of key/value definitions.

Requires Authentication
The following routes are available for this service:
POST/CreateUstSvXmlFromDefinitionAsyncAn asynchronous service to create xml content that represents a filing of the special advance payment for VAT (Umsatzsteuersondervorauszahlung) from the specified dictionary (hash map) of key/value definitions
import Foundation
import ServiceStack

/**
* An asynchronous service to create xml content that represents a filing of the special advance payment for VAT (Umsatzsteuersondervorauszahlung) from the specified dictionary (hash map) of key/value definitions.
*/
// @Api(Description="An asynchronous service to create xml content that represents a filing of the special advance payment for VAT (Umsatzsteuersondervorauszahlung) from the specified dictionary (hash map) of key/value definitions.")
public class CreateUstSvXmlFromDefinitionAsync : CreateUstSvXmlFromDefinitionBase
{
    /**
    * The 4-digit year of the tax assessment.
    */
    // @ApiMember(Description="The 4-digit year of the tax assessment.")
    public var jahr:Int

    /**
    * Dictionary of key-value pairs that represent the intrinsic properties of the VAT return. Each key represents a name of the VAT property.Each value of the pair represents the VAT property value.
    */
    // @ApiMember(Description="Dictionary of key-value pairs that represent the intrinsic properties of the VAT return. Each key represents a name of the VAT property.Each value of the pair represents the VAT property value.")
    public var properties:[String:String] = [:]

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

    private enum CodingKeys : String, CodingKey {
        case jahr
        case properties
    }

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

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

/**
* Create XML content that  represents a special advance payment for VAT (Umsatzsteuersondervorauszahlung) return from the specified dictionary (hash map) of key/value definitions.
*/
// @Api(Description="Create XML content that  represents a special advance payment for VAT (Umsatzsteuersondervorauszahlung) return from the specified dictionary (hash map) of key/value definitions.")
public class CreateUstSvXmlFromDefinitionBase : CreateXmlFromDefinitionBase, IPost
{
    /**
    * The 4-digit year of the tax assessment.
    */
    // @ApiMember(Description="The 4-digit year of the tax assessment.")
    public var jahr:Int

    /**
    * Dictionary of key-value pairs that represent the intrinsic properties of the VAT return. Each key represents a name of the VAT property.Each value of the pair represents the VAT property value.
    */
    // @ApiMember(Description="Dictionary of key-value pairs that represent the intrinsic properties of the VAT return. Each key represents a name of the VAT property.Each value of the pair represents the VAT property value.")
    public var properties:[String:String] = [:]

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

    private enum CodingKeys : String, CodingKey {
        case jahr
        case properties
    }

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

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

/**
* Create a VAT return from a dictionary (hash map) of key/value definitions with a dictionary (hash map) of properties.
*/
// @Api(Description="Create a VAT return from a dictionary (hash map) of key/value definitions with a dictionary (hash map) of properties.")
public class CreateXmlFromDefinitionBase : Codable
{
    /**
    * The 4-digit year of the tax assessment.
    */
    // @ApiMember(Description="The 4-digit year of the tax assessment.")
    public var jahr:Int

    /**
    * Dictionary of key-value pairs that represent the intrinsic properties of the VAT return. Each key represents a name of the VAT property.Each value of the pair represents the VAT property value.
    */
    // @ApiMember(Description="Dictionary of key-value pairs that represent the intrinsic properties of the VAT return. Each key represents a name of the VAT property.Each value of the pair represents the VAT property value.")
    public var properties:[String:String] = [:]

    required public init(){}
}

/**
* Represents the response from a service that generates XML content.
*/
// @Api(Description="Represents the response from a service that generates XML content.")
public class XmlResponse : Codable
{
    /**
    * The XML-based content of the response.
    */
    // @ApiMember(Description="The XML-based content of the response.")
    public var content:String

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

    required public init(){}
}


Swift CreateUstSvXmlFromDefinitionAsync DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /CreateUstSvXmlFromDefinitionAsync HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	jahr: 0,
	properties: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	content: String,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}