Tax Filing Service

<back to all web services

RegisterProduct

RegisterProductsSync

Represents a service request to register a product.

Requires Authentication
Required role:AdminRequired permissions:CanAccess, CanAdd
The following routes are available for this service:
POST/sync/products
RegisterProduct Parameters:
NameParameterData TypeRequiredDescription
NamebodystringNoThe name of the product.
DescriptionbodystringNoThe description of the product.
VersionbodystringNoThe version of the product.
TagsbodyList<string>YesTags associated with the product.
RegisterProductBase Parameters:
NameParameterData TypeRequiredDescription
NameformstringNoThe name of the product.
DescriptionformstringNoThe description of the product.
VersionformstringNoThe version of the product.
TagsformList<string>YesTags associated with the product.
ProductResponse Parameters:
NameParameterData TypeRequiredDescription
ProductformProductNoThe product data of the response.
OrdersformList<Order>YesThe list of orders associated with the encapsulated product.
ResponseStatusformResponseStatusNoData structure that holds error information from a service operation.
ServiceResponseBase Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNoData structure that holds error information from a service operation.
Product Parameters:
NameParameterData TypeRequiredDescription
IdformintYesThe unique identifier of the product.
IndexformintYesThe position of this instance in a collection of 'Product' instances
NameformstringYesThe name of the product.
VersionformstringYesThe version of the product.
DescriptionformstringNoThe version of the product.
TagsformList<string>YesTags associated with the product.
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 .x-msgpack suffix or ?format=x-msgpack

HTTP + X-MSGPACK

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

POST /sync/products HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length

{"name":"String","description":"String","version":"String","tags":["String"]}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length

{"product":{"id":0,"index":0,"name":"String","version":"String","description":"String","tags":["String"]},"orders":[{"id":0,"productId":0,"accountId":0,"name":"String","serviceName":"String","requestTimestamp":"\/Date(-62135596800000-0000)\/","responseTimestamp":"\/Date(-62135596800000-0000)\/","requestUri":"String","requestHttpMethod":"String","requestDuration":"PT0S","responseStatusCode":"Continue","clientIPAddress":"String","unitOfMeasurement":"String","processType":"String","dataType":"String","dataName":"String","creationDate":"\/Date(-62135596800000-0000)\/","expiryDate":"\/Date(-62135596800000-0000)\/","isTest":false}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}