Tax Filing Service
| Requires the role: | AllowAnyUser | Required permission: | CanAccess |
| GET | /sync/accounts/retrieve |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserName | query | string | No | The user name of the account. |
| IncludeProducts | query | bool? | No | Should the related products of the account be included in the retrieved account? |
| IncludeOrders | query | bool? | No | Should the related orders of the account be included in the retrieved account? |
| SkipProducts | query | int? | No | Specifies the number of products to skip. Applicable only when 'IncludeProducts' is true. |
| TakeProducts | query | int? | No | Specifies the number of products to include. Applicable only when 'IncludeProducts' is true. |
| SkipOrders | query | int? | No | Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. |
| TakeOrders | query | int? | No | Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. |
| Skip | query | int? | No | The number of query results to skip. |
| Take | query | int? | No | The number of query results to include. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserName | form | string | No | The user name of the account. |
| IncludeProducts | form | bool? | No | Should the related products of the account be included in the retrieved account? |
| IncludeOrders | form | bool? | No | Should the related orders of the account be included in the retrieved account? |
| SkipProducts | form | int? | No | Specifies the number of products to skip. Applicable only when 'IncludeProducts' is true. |
| TakeProducts | form | int? | No | Specifies the number of products to include. Applicable only when 'IncludeProducts' is true. |
| SkipOrders | form | int? | No | Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. |
| TakeOrders | form | int? | No | Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. |
| Skip | form | int? | No | The number of query results to skip. |
| Take | form | int? | No | The number of query results to include. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | The number of query results to skip. |
| Take | form | int? | No | The number of query results to include. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Account | form | Account | No | The user account encapsulated in the response. |
| Index | form | long | No | The index position of the reponse in a collection, if it were returned together with other responses. |
| Products | form | List<Product> | Yes | The list of products associated with the encapsulated user account. |
| Orders | form | List<Order> | Yes | The list of orders associated with the encapsulated user account. |
| ResponseStatus | form | ResponseStatus | No | Data structure that holds error information from a service operation. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | Data structure that holds error information from a service operation. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | Yes | The unique identifier of the user account. |
| Index | form | int | Yes | The position of this instance in a collection of 'Account' instances |
| RefId | form | int? | Yes | The unique identifier of the customer associated with this account. |
| RefIdStr | form | string | No | The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'. |
| UserName | form | string | Yes | The unique user name of the user account. |
| form | string | No | The electronic mail address of the user account. | |
| DisplayName | form | string | No | The friendly name of the user account. |
| FirstName | form | string | No | The first name of the owner (natural person) of the user account. |
| LastName | form | string | No | The last name of the owner (natural person) of the user account. |
| FullName | form | string | No | The unique identifier of the customer associated with this account. |
| Gender | form | string | No | The gender of the owner (natural person) of the user account. |
| Language | form | string | No | The language of the owner of teh user account. |
| Company | form | string | No | The company, where the user is an employee. |
| ProfileUrl | form | string | Yes | The profile URL of the user account. |
| Roles | form | List<string> | Yes | The roles assigned to the user account. |
| Permissions | form | List<string> | Yes | The permissions assigned to the user account. |
| PrimaryEmail | form | string | No | The primary e-mail address of the user. |
| Salt | form | string | No | Random data to enhance the security of the user password. |
| PasswordHash | form | string | No | The hash value of the user password that the PBKDF2 algorithm produces. |
| DigestHa1Hash | form | string | No | The hash value of the user password that the DigestHa1 algorithm produces. |
| InvalidLoginAttempts | form | int | No | The number of times the user account tried to sign in but failed. |
| LastLoginAttempt | form | DateTime? | No | The last time the user account attempted a sign in. |
| LockedDate | form | DateTime? | No | The date and time when the user acount was denied access. |
| CreatedDate | form | DateTime | No | The date and time when the user account was created. |
| ModifiedDate | form | DateTime | No | The date and time when the user account was last modified. |
| PhoneNumber | form | string | No | The telephone number of the owner of the user account. |
| BirthDate | form | DateTime? | No | The birth date of the owner of the user account |
| BirthDateRaw | form | string | No | The string representation of the birth date of the user account. |
| Address | form | string | No | The mail address of the user account. |
| Address2 | form | string | No | Additional information for the specified 'Address' of the user. |
| City | form | string | No | The city of the owner of the user account. |
| State | form | string | No | The state of the owner of the user account. |
| Country | form | string | No | The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'. |
| Culture | form | string | No | The locale of the user account. |
| MailAddress | form | string | No | The mail address of the user account. |
| Nickname | form | string | No | The nickname of the user of the user account. |
| PostalCode | form | string | No | The postal code of the user account. |
| TimeZone | form | string | No | The time zone of the user of the user account. |
| Meta | form | Dictionary<string, string> | No | Additional information to attach to the user account. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | Yes | The unique identifier of the product. |
| Index | form | int | Yes | The position of this instance in a collection of 'Product' instances |
| Name | form | string | Yes | The name of the product. |
| Version | form | string | Yes | The version of the product. |
| Description | form | string | No | The version of the product. |
| Tags | form | List<string> | Yes | Tags associated with the product. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | Yes | The unique identifier of the order. |
| ProductId | form | int | Yes | The unique identifier of the product, for which the order is made. |
| AccountId | form | int | Yes | The unique identifier of the user account, who placed the order. |
| Name | form | string | Yes | A name to identify the order. |
| ServiceName | form | string | No | The name of the service, for which the order was made. |
| RequestTimestamp | form | DateTime? | No | The time stamp at which the order was initiated. |
| ResponseTimestamp | form | DateTime? | No | The time stamp at which the order was completed. |
| RequestUri | form | string | No | The URI from which the order was initiated. |
| RequestHttpMethod | form | string | No | The HTTP method of the order request. |
| RequestDuration | form | TimeSpan? | No | The duration of the order request. |
| ResponseStatusCode | form | HttpStatusCode | No | The HTTP status code of the order request. |
| ClientIPAddress | form | string | No | The IP address of client, who placed the order. |
| UnitOfMeasurement | form | string | No | The unit of measurement for the order. |
| ProcessType | form | string | No | The type of process, for which the order is charged. |
| DataType | form | string | No | The type of data, for which the order is charged. |
| DataName | form | string | No | The name of the data, for which the order is charged. |
| CreationDate | form | DateTime | No | The date of creation of the order. |
| ExpiryDate | form | DateTime? | No | The final date to retain the order in the records. After this date, the order is expunged from the records. |
| IsTest | form | bool | No | 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. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /sync/accounts/retrieve HTTP/1.1 Host: taxfiling.staging.pwc.de Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"account":{"id":0,"index":0,"refId":0,"refIdStr":"String","userName":"String","email":"String","displayName":"String","firstName":"String","lastName":"String","fullName":"String","gender":"String","language":"String","company":"String","profileUrl":"String","roles":["String"],"permissions":["String"],"primaryEmail":"String","salt":"String","passwordHash":"String","digestHa1Hash":"String","invalidLoginAttempts":0,"lastLoginAttempt":"\/Date(-62135596800000-0000)\/","lockedDate":"\/Date(-62135596800000-0000)\/","createdDate":"\/Date(-62135596800000-0000)\/","modifiedDate":"\/Date(-62135596800000-0000)\/","phoneNumber":"String","birthDate":"\/Date(-62135596800000-0000)\/","birthDateRaw":"String","address":"String","address2":"String","city":"String","state":"String","country":"String","culture":"String","mailAddress":"String","nickname":"String","postalCode":"String","timeZone":"String","meta":{"String":"String"}},"index":0,"products":[{"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"}}}