Tax Filing Service

<back to all web services



Represents a service request to retrieve all orders.

Requires Authentication
Required role:AdminRequired permission:CanAccess
The following routes are available for this service:
PaginationBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?NoThe number of query results to skip.
Takeformint?NoThe number of query results to include.
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
MetaformDictionary<string, string>No
Order Parameters:
NameParameterData TypeRequiredDescription
IdformintYesThe unique identifier of the order.
ProductIdformintYesThe unique identifier of the product, for which the order is made.
AccountIdformintYesThe unique identifier of the user account, who placed the order.
NameformstringYesA name to identify the order.
ServiceNameformstringNoThe name of the service, for which the order was made.
RequestTimestampformDateTime?NoThe time stamp at which the order was initiated.
ResponseTimestampformDateTime?NoThe time stamp at which the order was completed.
RequestUriformstringNoThe URI from which the order was initiated.
RequestHttpMethodformstringNoThe HTTP method of the order request.
RequestDurationformTimeSpan?NoThe duration of the order request.
ResponseStatusCodeformHttpStatusCodeNoThe HTTP status code of the order request.
ClientIPAddressformstringNoThe IP address of client, who placed the order.
UnitOfMeasurementformstringNoThe unit of measurement for the order.
ProcessTypeformstringNoThe type of process, for which the order is charged.
DataTypeformstringNoThe type of data, for which the order is charged.
DataNameformstringNoThe name of the data, for which the order is charged.
CreationDateformDateTimeNoThe date of creation of the order.
ExpiryDateformDateTime?NoThe final date to retain the order in the records. After this date, the order is expunged from the records.
IsTestformboolNoIndicates 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.

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


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

GET /sync/orders HTTP/1.1 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

	offset: 0,
	total: 0,
			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
		String: String
		errorCode: String,
		message: String,
		stackTrace: String,
				errorCode: String,
				fieldName: String,
				message: String,
					String: String
			String: String