Tax Filing Service

<back to all web services

RetrieveAccount

RetrieveAccountsSync

Represents a service request to retrieve an account.

Requires Authentication
Requires the role:AllowAnyUserRequired permission:CanAccess
The following routes are available for this service:
GET/sync/accounts/retrieve
RetrieveAccount Parameters:
NameParameterData TypeRequiredDescription
UserNamequerystringNoThe user name of the account.
IncludeProductsquerybool?NoShould the related products of the account be included in the retrieved account?
IncludeOrdersquerybool?NoShould the related orders of the account be included in the retrieved account?
SkipProductsqueryint?NoSpecifies the number of products to skip. Applicable only when 'IncludeProducts' is true.
TakeProductsqueryint?NoSpecifies the number of products to include. Applicable only when 'IncludeProducts' is true.
SkipOrdersqueryint?NoSpecifies the number of orders to skip. Applicable only when 'IncludeOrders' is true.
TakeOrdersqueryint?NoSpecifies the number of orders to include. Applicable only when 'IncludeOrders' is true.
Skipqueryint?NoThe number of query results to skip.
Takequeryint?NoThe number of query results to include.
RetrieveAccountBase Parameters:
NameParameterData TypeRequiredDescription
UserNameformstringNoThe user name of the account.
IncludeProductsformbool?NoShould the related products of the account be included in the retrieved account?
IncludeOrdersformbool?NoShould the related orders of the account be included in the retrieved account?
SkipProductsformint?NoSpecifies the number of products to skip. Applicable only when 'IncludeProducts' is true.
TakeProductsformint?NoSpecifies the number of products to include. Applicable only when 'IncludeProducts' is true.
SkipOrdersformint?NoSpecifies the number of orders to skip. Applicable only when 'IncludeOrders' is true.
TakeOrdersformint?NoSpecifies the number of orders to include. Applicable only when 'IncludeOrders' is true.
Skipformint?NoThe number of query results to skip.
Takeformint?NoThe number of query results to include.
PaginationBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?NoThe number of query results to skip.
Takeformint?NoThe number of query results to include.
AccountResponse Parameters:
NameParameterData TypeRequiredDescription
AccountformAccountNoThe user account encapsulated in the response.
IndexformlongNoThe index position of the reponse in a collection, if it were returned together with other responses.
ProductsformList<Product>YesThe list of products associated with the encapsulated user account.
OrdersformList<Order>YesThe list of orders associated with the encapsulated user account.
ResponseStatusformResponseStatusNoData structure that holds error information from a service operation.
ServiceResponseBase Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNoData structure that holds error information from a service operation.
Account Parameters:
NameParameterData TypeRequiredDescription
IdformintYesThe unique identifier of the user account.
IndexformintYesThe position of this instance in a collection of 'Account' instances
RefIdformint?YesThe unique identifier of the customer associated with this account.
RefIdStrformstringNoThe string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.
UserNameformstringYesThe unique user name of the user account.
EmailformstringNoThe electronic mail address of the user account.
DisplayNameformstringNoThe friendly name of the user account.
FirstNameformstringNoThe first name of the owner (natural person) of the user account.
LastNameformstringNoThe last name of the owner (natural person) of the user account.
FullNameformstringNoThe unique identifier of the customer associated with this account.
GenderformstringNoThe gender of the owner (natural person) of the user account.
LanguageformstringNoThe language of the owner of teh user account.
CompanyformstringNoThe company, where the user is an employee.
ProfileUrlformstringYesThe profile URL of the user account.
RolesformList<string>YesThe roles assigned to the user account.
PermissionsformList<string>YesThe permissions assigned to the user account.
PrimaryEmailformstringNoThe primary e-mail address of the user.
SaltformstringNoRandom data to enhance the security of the user password.
PasswordHashformstringNoThe hash value of the user password that the PBKDF2 algorithm produces.
DigestHa1HashformstringNoThe hash value of the user password that the DigestHa1 algorithm produces.
InvalidLoginAttemptsformintNoThe number of times the user account tried to sign in but failed.
LastLoginAttemptformDateTime?NoThe last time the user account attempted a sign in.
LockedDateformDateTime?NoThe date and time when the user acount was denied access.
CreatedDateformDateTimeNoThe date and time when the user account was created.
ModifiedDateformDateTimeNoThe date and time when the user account was last modified.
PhoneNumberformstringNoThe telephone number of the owner of the user account.
BirthDateformDateTime?NoThe birth date of the owner of the user account
BirthDateRawformstringNoThe string representation of the birth date of the user account.
AddressformstringNoThe mail address of the user account.
Address2formstringNoAdditional information for the specified 'Address' of the user.
CityformstringNoThe city of the owner of the user account.
StateformstringNoThe state of the owner of the user account.
CountryformstringNoThe country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.
CultureformstringNoThe locale of the user account.
MailAddressformstringNoThe mail address of the user account.
NicknameformstringNoThe nickname of the user of the user account.
PostalCodeformstringNoThe postal code of the user account.
TimeZoneformstringNoThe time zone of the user of the user account.
MetaformDictionary<string, string>NoAdditional information to attach to the user account.
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 .other suffix or ?format=other

HTTP + OTHER

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.pwc.de 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}