<back to all web services

CreateZmXmlFromDefinitionAsync

An asynchronous service to create xml content that represents a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions.

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


/** @description 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.")
class CreateXmlFromDefinitionBase implements JsonSerializable
{
    public function __construct(
        /** @description The 4-digit year of the tax assessment. */
        // @ApiMember(Description="The 4-digit year of the tax assessment.")
        /** @var int */
        public int $jahr=0,

        /** @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. */
        // @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.")
        /** @var array<string,string>|null */
        public ?array $properties=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['jahr'])) $this->jahr = $o['jahr'];
        if (isset($o['properties'])) $this->properties = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['properties']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->jahr)) $o['jahr'] = $this->jahr;
        if (isset($this->properties)) $o['properties'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->properties);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Create XML content that represents a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions. */
// @Api(Description="Create XML content that represents a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions.")
class CreateZmXmlFromDefinitionBase extends CreateXmlFromDefinitionBase implements IPost, JsonSerializable
{
    /**
     * @param int $jahr
     * @param array<string,string>|null $properties
     */
    public function __construct(
        int $jahr=0,
        ?array $properties=null
    ) {
        parent::__construct($jahr,$properties);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['jahr'])) $this->jahr = $o['jahr'];
        if (isset($o['properties'])) $this->properties = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['properties']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->jahr)) $o['jahr'] = $this->jahr;
        if (isset($this->properties)) $o['properties'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->properties);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Represents the response from a service that generates XML content. */
// @Api(Description="Represents the response from a service that generates XML content.")
class XmlResponse implements JsonSerializable
{
    public function __construct(
        /** @description The XML-based content of the response. */
        // @ApiMember(Description="The XML-based content of the response.")
        /** @var string|null */
        public ?string $content=null,

        /** @description Metadata that contains structured error information on the XML response. */
        // @ApiMember(Description="Metadata that contains structured error information on the XML response.")
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['content'])) $this->content = $o['content'];
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->content)) $o['content'] = $this->content;
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description An asynchronous service to create xml content that represents a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions. */
// @Api(Description="An asynchronous service to create xml content that represents a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions.")
class CreateZmXmlFromDefinitionAsync extends CreateZmXmlFromDefinitionBase implements JsonSerializable
{
    /**
     * @param int $jahr
     * @param array<string,string>|null $properties
     * @param int $jahr
     * @param array<string,string>|null $properties
     */
    public function __construct(
        int $jahr=0,
        ?array $properties=null,
        int $jahr=0,
        ?array $properties=null
    ) {
        parent::__construct($jahr,$properties,$jahr,$properties);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['jahr'])) $this->jahr = $o['jahr'];
        if (isset($o['properties'])) $this->properties = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['properties']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->jahr)) $o['jahr'] = $this->jahr;
        if (isset($this->properties)) $o['properties'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->properties);
        return empty($o) ? new class(){} : $o;
    }
}

PHP CreateZmXmlFromDefinitionAsync DTOs

POST /CreateZmXmlFromDefinitionAsync 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
		}
	}
}