Tax Filing Service

CreateUstVaXmlFromDefinitionAsync

AsyncUmsatzsteuerVoranmeldungReturnBuilderDefinition

An asynchronous service to create xml content that represents a preliminary VAT return (Umsatzsteuervoranmeldung) from the specified dictionary (hash map) of key/value definitions.

The following routes are available for this service:
POST	/CreateUstVaXmlFromDefinitionAsync


/** @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.")
export class CreateXmlFromDefinitionBase
{
    /** @description The 4-digit year of the tax assessment. */
    // @ApiMember(Description="The 4-digit year of the tax assessment.")
    public jahr: number;

    /** @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.")
    public properties: { [index: string]: string; };

    public constructor(init?: Partial<CreateXmlFromDefinitionBase>) { (Object as any).assign(this, init); }
}

/** @description Create XML content that  represents a preliminary VAT (Umsatzsteuervoranmeldung) return from the specified dictionary (hash map) of key/value definitions. */
// @Api(Description="Create XML content that  represents a preliminary VAT (Umsatzsteuervoranmeldung) return from the specified dictionary (hash map) of key/value definitions.")
export class CreateUstVaXmlFromDefinitionBase extends CreateXmlFromDefinitionBase implements IPost
{
    /** @description The 4-digit year of the tax assessment. */
    // @ApiMember(Description="The 4-digit year of the tax assessment.")
    public jahr: number;

    /** @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.")
    public properties: { [index: string]: string; };

    public constructor(init?: Partial<CreateUstVaXmlFromDefinitionBase>) { super(init); (Object as any).assign(this, init); }
}

/** @description Represents the response from a service that generates XML content. */
// @Api(Description="Represents the response from a service that generates XML content.")
export class XmlResponse
{
    /** @description The XML-based content of the response. */
    // @ApiMember(Description="The XML-based content of the response.")
    public content?: string;

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

    public constructor(init?: Partial<XmlResponse>) { (Object as any).assign(this, init); }
}

/** @description An asynchronous service to create xml content that represents a preliminary VAT return (Umsatzsteuervoranmeldung) from the specified dictionary (hash map) of key/value definitions. */
// @Api(Description="An asynchronous service to create xml content that represents a preliminary VAT return (Umsatzsteuervoranmeldung) from the specified dictionary (hash map) of key/value definitions.")
export class CreateUstVaXmlFromDefinitionAsync extends CreateUstVaXmlFromDefinitionBase
{
    /** @description The 4-digit year of the tax assessment. */
    // @ApiMember(Description="The 4-digit year of the tax assessment.")
    public jahr: number;

    /** @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.")
    public properties: { [index: string]: string; };

    public constructor(init?: Partial<CreateUstVaXmlFromDefinitionAsync>) { super(init); (Object as any).assign(this, init); }
}

TypeScript CreateUstVaXmlFromDefinitionAsync 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 /CreateUstVaXmlFromDefinitionAsync HTTP/1.1 
Host: taxfiling.staging.pwc.de 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"jahr":0,"properties":{"String":"String"}}

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