Tax Filing Service
| Required role: | Admin | Required permission: | CanAccess |
| GET | /sync/customers |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IncludeAccounts | query | bool? | No | Should related accounts be included in the retrieved customers? |
| SkipAccounts | query | int? | No | Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. |
| TakeAccounts | query | int? | No | Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' 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 |
|---|---|---|---|---|
| IncludeAccounts | form | bool? | No | Should related accounts be included in the retrieved customers? |
| SkipAccounts | form | int? | No | Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. |
| TakeAccounts | form | int? | No | Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' 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 |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<Customer> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | Yes | The unique identifier of the customer. |
| Index | form | int | Yes | The position of this instance in a collection of 'Customer' instances |
| Name | form | string | Yes | Full name or organization name of customer. |
| Country | form | string | No | The country of residence or business of customer. |
| Type | form | CustomerType | No | The type of customer. |
| Accounts | form | List<Account> | Yes | The list of user accounts associated with this customer. |
| Internal | PwC DE |
| Network | PwC Network Firm |
| External | Non-PwC |
| 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. |
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/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"}}}