Tax Filing Service

RetrieveOrderAsync

RetrieveOrdersAsync

Represents a service request to retrieve an order in an asynchronous operation.

**Requires Authentication**
Required role:	Admin	Required permission:	CanAccess

The following routes are available for this service:
GET	/async/orders/{Id}

"use strict";
export class RetrieveOrderBase {
    /** @param {{id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The unique identifier of the order. */
    id;
}
export class ServiceResponseBase {
    /** @param {{responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?ResponseStatus}
     * @description Data structure that holds error information from a service operation. */
    responseStatus;
}
export class Order {
    /** @param {{id?:number,productId?:number,accountId?:number,name?:string,serviceName?:string,requestTimestamp?:string,responseTimestamp?:string,requestUri?:string,requestHttpMethod?:string,requestDuration?:string,responseStatusCode?:HttpStatusCode,clientIPAddress?:string,unitOfMeasurement?:string,processType?:string,dataType?:string,dataName?:string,creationDate?:string,expiryDate?:string,isTest?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The unique identifier of the order. */
    id;
    /**
     * @type {number}
     * @description The unique identifier of the product, for which the order is made. */
    productId;
    /**
     * @type {number}
     * @description The unique identifier of the user account, who placed the order. */
    accountId;
    /**
     * @type {string}
     * @description A name to identify the order. */
    name;
    /**
     * @type {?string}
     * @description The name of the service, for which the order was made. */
    serviceName;
    /**
     * @type {?string}
     * @description The time stamp at which the order was initiated. */
    requestTimestamp;
    /**
     * @type {?string}
     * @description The time stamp at which the order was completed. */
    responseTimestamp;
    /**
     * @type {?string}
     * @description The URI from which the order was initiated. */
    requestUri;
    /**
     * @type {?string}
     * @description The HTTP method of the order request. */
    requestHttpMethod;
    /**
     * @type {?string}
     * @description The duration of the order request. */
    requestDuration;
    /**
     * @type {HttpStatusCode}
     * @description The HTTP status code of the order request. */
    responseStatusCode;
    /**
     * @type {?string}
     * @description The IP address of client, who placed the order. */
    clientIPAddress;
    /**
     * @type {?string}
     * @description The unit of measurement for the order. */
    unitOfMeasurement;
    /**
     * @type {?string}
     * @description The type of process, for which the order is charged. */
    processType;
    /**
     * @type {?string}
     * @description The type of data, for which the order is charged. */
    dataType;
    /**
     * @type {?string}
     * @description The name of the data, for which the order is charged. */
    dataName;
    /**
     * @type {string}
     * @description The date of creation of the order. */
    creationDate;
    /**
     * @type {?string}
     * @description The final date to retain the order in the records. After this date, the order is expunged from the records. */
    expiryDate;
    /**
     * @type {boolean}
     * @description Indicates whether the order is simulated for test purposes. True if the order is simulated for test purposes; otherwise it is a false order for production purposes. */
    isTest;
}
export class OrderResponse extends ServiceResponseBase {
    /** @param {{order?:Order,responseStatus?:ResponseStatus,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?Order}
     * @description The order data of the response. */
    order;
    /**
     * @type {?ResponseStatus}
     * @description Data structure that holds error information from a service operation. */
    responseStatus;
}
export class RetrieveOrderAsync extends RetrieveOrderBase {
    /** @param {{id?:number,id?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {number}
     * @description The unique identifier of the order. */
    id;
}

JavaScript RetrieveOrderAsync 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.

GET /async/orders/{Id} HTTP/1.1 
Host: taxfiling.staging.pwc.de 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	order: 
	{
		id: 0,
		productId: 0,
		accountId: 0,
		name: String,
		serviceName: String,
		requestTimestamp: 0001-01-01,
		responseTimestamp: 0001-01-01,
		requestUri: String,
		requestHttpMethod: String,
		requestDuration: PT0S,
		responseStatusCode: Continue,
		clientIPAddress: String,
		unitOfMeasurement: String,
		processType: String,
		dataType: String,
		dataName: String,
		creationDate: 0001-01-01,
		expiryDate: 0001-01-01,
		isTest: False
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}