Tax Filing Service

<back to all web services

RetrieveAllCustomersAsync

RetrieveCustomersAsync

Represents a service request to retrieve all customers in an asynchronous operation.

Requires Authentication
Required role:AdminRequired permission:CanAccess
The following routes are available for this service:
GET/async/customers
RetrieveAllCustomersAsync Parameters:
NameParameterData TypeRequiredDescription
IncludeAccountsquerybool?NoShould related accounts be included in the retrieved customers?
SkipAccountsqueryint?NoSpecifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true.
TakeAccountsqueryint?NoSpecifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true.
Skipqueryint?NoThe number of query results to skip.
Takequeryint?NoThe number of query results to include.
RetrieveAllCustomersBase Parameters:
NameParameterData TypeRequiredDescription
IncludeAccountsformbool?NoShould related accounts be included in the retrieved customers?
SkipAccountsformint?NoSpecifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true.
TakeAccountsformint?NoSpecifies the number of products to include per customer. Applicable only when 'IncludeAccounts' 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.
CustomerQueryResponse Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<Customer>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
Customer Parameters:
NameParameterData TypeRequiredDescription
IdformintYesThe unique identifier of the customer.
IndexformintYesThe position of this instance in a collection of 'Customer' instances
NameformstringYesFull name or organization name of customer.
CountryformstringNoThe country of residence or business of customer.
TypeformCustomerTypeNoThe type of customer.
AccountsformList<Account>YesThe list of user accounts associated with this customer.
CustomerType Enum:
InternalPwC DE
NetworkPwC Network Firm
ExternalNon-PwC
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.

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

HTTP + CSV

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

GET /async/customers HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"offset":0,"total":0,"results":[{"id":0,"index":0,"name":"String","country":"String","type":"Internal","accounts":[{"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"}}]}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}