Tax Filing Service

AdminRetrieveAccount

RetrieveAccountsSync

Represents a service request from an admin user to retrieve an account.

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

The following routes are available for this service:
GET	/sync/accounts/{Id}

**AdminRetrieveAccount** Parameters:
Name	Parameter	Data Type	Required	Description
Id	path	int?	No	The unique identifier of the account.
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.

**AdminRetrieveAccountBase** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int?	No	The unique identifier of the account.
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.

**AccountResponse** Parameters:
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.

**ServiceResponseBase** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No	Data structure that holds error information from a service operation.

**Account** Parameters:
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.
Email	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.

**Product** Parameters:
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.

**Order** Parameters:
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 .xml suffix or ?format=xml

HTTP + XML

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

GET /sync/accounts/{Id} HTTP/1.1 
Host: taxfiling.staging.pwc.de 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Services.Contracts.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Account xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models">
    <d2p1:Address>String</d2p1:Address>
    <d2p1:Address2>String</d2p1:Address2>
    <d2p1:BirthDate>0001-01-01T00:00:00</d2p1:BirthDate>
    <d2p1:BirthDateRaw>String</d2p1:BirthDateRaw>
    <d2p1:City>String</d2p1:City>
    <d2p1:Company>String</d2p1:Company>
    <d2p1:Country>String</d2p1:Country>
    <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
    <d2p1:Culture>String</d2p1:Culture>
    <d2p1:DigestHa1Hash>String</d2p1:DigestHa1Hash>
    <d2p1:DisplayName>String</d2p1:DisplayName>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:FullName>String</d2p1:FullName>
    <d2p1:Gender>String</d2p1:Gender>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:Index>0</d2p1:Index>
    <d2p1:InvalidLoginAttempts>0</d2p1:InvalidLoginAttempts>
    <d2p1:Language>String</d2p1:Language>
    <d2p1:LastLoginAttempt>0001-01-01T00:00:00</d2p1:LastLoginAttempt>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:LockedDate>0001-01-01T00:00:00</d2p1:LockedDate>
    <d2p1:MailAddress>String</d2p1:MailAddress>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
    <d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
    <d2p1:Nickname>String</d2p1:Nickname>
    <d2p1:PasswordHash>String</d2p1:PasswordHash>
    <d2p1:Permissions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Permissions>
    <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
    <d2p1:PostalCode>String</d2p1:PostalCode>
    <d2p1:PrimaryEmail>String</d2p1:PrimaryEmail>
    <d2p1:ProfileUrl>String</d2p1:ProfileUrl>
    <d2p1:RefId>0</d2p1:RefId>
    <d2p1:RefIdStr>String</d2p1:RefIdStr>
    <d2p1:Roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Roles>
    <d2p1:Salt>String</d2p1:Salt>
    <d2p1:State>String</d2p1:State>
    <d2p1:TimeZone>String</d2p1:TimeZone>
    <d2p1:UserName>String</d2p1:UserName>
  </Account>
  <Index>0</Index>
  <Orders xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models">
    <d2p1:Order>
      <d2p1:AccountId>0</d2p1:AccountId>
      <d2p1:ClientIPAddress>String</d2p1:ClientIPAddress>
      <d2p1:CreationDate>0001-01-01T00:00:00</d2p1:CreationDate>
      <d2p1:DataName>String</d2p1:DataName>
      <d2p1:DataType>String</d2p1:DataType>
      <d2p1:ExpiryDate>0001-01-01T00:00:00</d2p1:ExpiryDate>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsTest>false</d2p1:IsTest>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:ProcessType>String</d2p1:ProcessType>
      <d2p1:ProductId>0</d2p1:ProductId>
      <d2p1:RequestDuration>PT0S</d2p1:RequestDuration>
      <d2p1:RequestHttpMethod>String</d2p1:RequestHttpMethod>
      <d2p1:RequestTimestamp>0001-01-01T00:00:00</d2p1:RequestTimestamp>
      <d2p1:RequestUri>String</d2p1:RequestUri>
      <d2p1:ResponseStatusCode>Continue</d2p1:ResponseStatusCode>
      <d2p1:ResponseTimestamp>0001-01-01T00:00:00</d2p1:ResponseTimestamp>
      <d2p1:ServiceName>String</d2p1:ServiceName>
      <d2p1:UnitOfMeasurement>String</d2p1:UnitOfMeasurement>
    </d2p1:Order>
  </Orders>
  <Products xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models">
    <d2p1:Product>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Index>0</d2p1:Index>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Tags>
      <d2p1:Version>String</d2p1:Version>
    </d2p1:Product>
  </Products>
</AccountResponse>