Tax Filing Service

<back to all web services

SearchCustomers

SearchCustomersSync

Represents a service request to query customer data.

Requires Authentication
Required role:AdminRequired permission:CanAccess
The following routes are available for this service:
GET/sync/customers/search
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @Api(Description="The number of query results to skip.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaginationBase(IPaginate):
    """
    The number of query results to skip.
    """

    # @ApiMember(Description="The number of query results to skip.")
    skip: Optional[int] = None
    """
    The number of query results to skip.
    """


    # @ApiMember(Description="The number of query results to include.")
    take: Optional[int] = None
    """
    The number of query results to include.
    """


class CustomerType(str, Enum):
    INTERNAL = 'Internal'
    NETWORK = 'Network'
    EXTERNAL = 'External'


# @Api(Description="Specifies a service to search for customers.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchCustomersBase(PaginationBase, IReturn[CustomerQueryResponse], IGet):
    """
    Specifies a service to search for customers.
    """

    # @ApiMember(Description="The unique identifier of the customer.")
    customer_id: Optional[int] = None
    """
    The unique identifier of the customer.
    """


    # @ApiMember(Description="The name of the customer.")
    name: Optional[str] = None
    """
    The name of the customer.
    """


    # @ApiMember(Description="Search by using the name of the customer that starts with the specified value.")
    name_starts_with: Optional[str] = None
    """
    Search by using the name of the customer that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the name of the customer that ends with the specified value.")
    name_ends_with: Optional[str] = None
    """
    Search by using the name of the customer that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the name of the customer that contains the specified value.")
    name_contains: Optional[str] = None
    """
    Search by using the name of the customer that contains the specified value.
    """


    # @ApiMember(Description="The country of residence or headquarters of customer.")
    country: Optional[str] = None
    """
    The country of residence or headquarters of customer.
    """


    # @ApiMember(Description="Search by using the country of the customer that starts with the specified value.")
    country_starts_with: Optional[str] = None
    """
    Search by using the country of the customer that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the country of the customer that ends with the specified value.")
    country_ends_with: Optional[str] = None
    """
    Search by using the country of the customer that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the country of the customer that contains the specified value.")
    country_contains: Optional[str] = None
    """
    Search by using the country of the customer that contains the specified value.
    """


    # @ApiMember(Description="The type of customer.")
    type: Optional[CustomerType] = None
    """
    The type of customer.
    """


    # @ApiMember(Description="Should related accounts be included in the retrieved customers?")
    include_accounts: Optional[bool] = None
    """
    Should related accounts be included in the retrieved customers?
    """


    # @ApiMember(Description="Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. ")
    skip_accounts: Optional[int] = None
    """
    Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. 
    """


    # @ApiMember(Description="Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. ")
    take_accounts: Optional[int] = None
    """
    Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. 
    """


    # @ApiMember(Description="The number of query results to skip.")
    skip: Optional[int] = None
    """
    The number of query results to skip.
    """


    # @ApiMember(Description="The number of query results to include.")
    take: Optional[int] = None
    """
    The number of query results to include.
    """
    @staticmethod
    def response_type(): return CustomerQueryResponse


# @Api(Description="Represents a user account.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Account(IHasUserName):
    """
    Represents a user account.
    """

    # @ApiMember(Description="The unique identifier of the user account.", IsRequired=true)
    id: int = 0
    """
    The unique identifier of the user account.
    """


    # @ApiMember(Description="The position of this instance in a collection of 'Account' instances", IsRequired=true)
    index: int = 0
    """
    The position of this instance in a collection of 'Account' instances
    """


    # @ApiMember(Description="The unique identifier of the customer associated with this account.", IsRequired=true)
    ref_id: Optional[int] = None
    """
    The unique identifier of the customer associated with this account.
    """


    # @ApiMember(Description="The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.")
    ref_id_str: Optional[str] = None
    """
    The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.
    """


    # @ApiMember(Description="The unique user name of the user account.", IsRequired=true)
    user_name: Optional[str] = None
    """
    The unique user name of the user account.
    """


    # @ApiMember(Description="The electronic mail address of the user account.")
    email: Optional[str] = None
    """
    The electronic mail address of the user account.
    """


    # @ApiMember(Description="The friendly name of the user account.")
    display_name: Optional[str] = None
    """
    The friendly name of the user account.
    """


    # @ApiMember(Description="The first name of the owner (natural person) of the user account.")
    first_name: Optional[str] = None
    """
    The first name of the owner (natural person) of the user account.
    """


    # @ApiMember(Description="The last name of the owner (natural person) of the user account.")
    last_name: Optional[str] = None
    """
    The last name of the owner (natural person) of the user account.
    """


    # @ApiMember(Description="The unique identifier of the customer associated with this account.")
    full_name: Optional[str] = None
    """
    The unique identifier of the customer associated with this account.
    """


    # @ApiMember(Description="The gender of the owner (natural person) of the user account.")
    gender: Optional[str] = None
    """
    The gender of the owner (natural person) of the user account.
    """


    # @ApiMember(Description="The language of the owner of teh user account.")
    language: Optional[str] = None
    """
    The language of the owner of teh user account.
    """


    # @ApiMember(Description="The company, where the user is an employee.")
    company: Optional[str] = None
    """
    The company, where the user is an employee.
    """


    # @ApiMember(Description="The profile URL of the user account.", IsRequired=true)
    profile_url: Optional[str] = None
    """
    The profile URL of the user account.
    """


    # @ApiMember(Description="The roles assigned to the user account.")
    roles: Optional[List[str]] = None
    """
    The roles assigned to the user account.
    """


    # @ApiMember(Description="The permissions assigned to the user account.")
    permissions: Optional[List[str]] = None
    """
    The permissions assigned to the user account.
    """


    # @ApiMember(Description="The primary e-mail address of the user.")
    primary_email: Optional[str] = None
    """
    The primary e-mail address of the user.
    """


    # @ApiMember(Description="Random data to enhance the security of the user password.")
    salt: Optional[str] = None
    """
    Random data to enhance the security of the user password.
    """


    # @ApiMember(Description="The hash value of the user password that the PBKDF2 algorithm produces.")
    password_hash: Optional[str] = None
    """
    The hash value of the user password that the PBKDF2 algorithm produces.
    """


    # @ApiMember(Description="The hash value of the user password that the DigestHa1 algorithm produces.")
    digest_ha1_hash: Optional[str] = None
    """
    The hash value of the user password that the DigestHa1 algorithm produces.
    """


    # @ApiMember(Description="The number of times the user account tried to sign in but failed.")
    invalid_login_attempts: int = 0
    """
    The number of times the user account tried to sign in but failed.
    """


    # @ApiMember(Description="The last time the user account attempted a sign in.")
    last_login_attempt: Optional[datetime.datetime] = None
    """
    The last time the user account attempted a sign in.
    """


    # @ApiMember(Description="The date and time when the user acount was denied access.")
    locked_date: Optional[datetime.datetime] = None
    """
    The date and time when the user acount was denied access.
    """


    # @ApiMember(Description="The date and time when the user account was created.")
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    The date and time when the user account was created.
    """


    # @ApiMember(Description="The date and time when the user account was last modified.")
    modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    The date and time when the user account was last modified.
    """


    # @ApiMember(Description="The telephone number of the owner of the user account.")
    phone_number: Optional[str] = None
    """
    The telephone number of the owner of the user account.
    """


    # @ApiMember(Description="The birth date of the owner of the user account")
    birth_date: Optional[datetime.datetime] = None
    """
    The birth date of the owner of the user account
    """


    # @ApiMember(Description="The string representation of the birth date of the user account.")
    birth_date_raw: Optional[str] = None
    """
    The string representation of the birth date of the user account.
    """


    # @ApiMember(Description="The mail address of the user account.")
    address: Optional[str] = None
    """
    The mail address of the user account.
    """


    # @ApiMember(Description="Additional information for the specified 'Address' of the user.")
    address2: Optional[str] = None
    """
    Additional information for the specified 'Address' of the user.
    """


    # @ApiMember(Description="The city of the owner of the user account.")
    city: Optional[str] = None
    """
    The city of the owner of the user account.
    """


    # @ApiMember(Description="The state of the owner of the user account.")
    state: Optional[str] = None
    """
    The state of the owner of the user account.
    """


    # @ApiMember(Description="The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.")
    country: Optional[str] = None
    """
    The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.
    """


    # @ApiMember(Description="The locale of the user account.")
    culture: Optional[str] = None
    """
    The locale of the user account.
    """


    # @ApiMember(Description="The mail address of the user account.")
    mail_address: Optional[str] = None
    """
    The mail address of the user account.
    """


    # @ApiMember(Description="The nickname of the user of the user account.")
    nickname: Optional[str] = None
    """
    The nickname of the user of the user account.
    """


    # @ApiMember(Description="The postal code of the user account.")
    postal_code: Optional[str] = None
    """
    The postal code of the user account.
    """


    # @ApiMember(Description="The time zone of the user of the user account.")
    time_zone: Optional[str] = None
    """
    The time zone of the user of the user account.
    """


    # @ApiMember(Description="Additional information to attach to the user account.")
    meta: Optional[Dict[str, str]] = None
    """
    Additional information to attach to the user account.
    """


# @Api(Description="Represents a customer (business organization or entrepreneur).")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Customer(IHasName):
    """
    Represents a customer (business organization or entrepreneur).
    """

    # @ApiMember(Description="The unique identifier of the customer.", IsRequired=true)
    id: int = 0
    """
    The unique identifier of the customer.
    """


    # @ApiMember(Description="The position of this instance in a collection of 'Customer' instances", IsRequired=true)
    index: int = 0
    """
    The position of this instance in a collection of 'Customer' instances
    """


    # @ApiMember(Description="Full name or organization name of customer.", IsRequired=true)
    # @Validate(Validator="NotEmpty")
    name: Optional[str] = None
    """
    Full name or organization name of customer.
    """


    # @ApiMember(Description="The country of residence or business of customer.")
    country: Optional[str] = None
    """
    The country of residence or business of customer.
    """


    # @ApiMember(Description="The type of customer.")
    type: Optional[CustomerType] = None
    """
    The type of customer.
    """


    # @ApiMember(Description="The list of user accounts associated with this customer.")
    # @Ignore()
    accounts: Optional[List[Account]] = None
    """
    The list of user accounts associated with this customer.
    """


# @Api(Description="Represents a query response that contains a structured error information and encapsulates customers.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerQueryResponse(QueryResponse[Customer]):
    """
    Represents a query response that contains a structured error information and encapsulates customers.
    """

    offset: int = 0
    total: int = 0
    results: Optional[List[Customer]] = None
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None


# @Api(Description="Represents a service request to query customer data.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchCustomers(SearchCustomersBase):
    """
    Represents a service request to query customer data.
    """

    # @ApiMember(Description="The unique identifier of the customer.")
    customer_id: Optional[int] = None
    """
    The unique identifier of the customer.
    """


    # @ApiMember(Description="The name of the customer.")
    name: Optional[str] = None
    """
    The name of the customer.
    """


    # @ApiMember(Description="Search by using the name of the customer that starts with the specified value.")
    name_starts_with: Optional[str] = None
    """
    Search by using the name of the customer that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the name of the customer that ends with the specified value.")
    name_ends_with: Optional[str] = None
    """
    Search by using the name of the customer that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the name of the customer that contains the specified value.")
    name_contains: Optional[str] = None
    """
    Search by using the name of the customer that contains the specified value.
    """


    # @ApiMember(Description="The country of residence or headquarters of customer.")
    country: Optional[str] = None
    """
    The country of residence or headquarters of customer.
    """


    # @ApiMember(Description="Search by using the country of the customer that starts with the specified value.")
    country_starts_with: Optional[str] = None
    """
    Search by using the country of the customer that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the country of the customer that ends with the specified value.")
    country_ends_with: Optional[str] = None
    """
    Search by using the country of the customer that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the country of the customer that contains the specified value.")
    country_contains: Optional[str] = None
    """
    Search by using the country of the customer that contains the specified value.
    """


    # @ApiMember(Description="The type of customer.")
    type: Optional[CustomerType] = None
    """
    The type of customer.
    """


    # @ApiMember(Description="Should related accounts be included in the retrieved customers?")
    include_accounts: Optional[bool] = None
    """
    Should related accounts be included in the retrieved customers?
    """


    # @ApiMember(Description="Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. ")
    skip_accounts: Optional[int] = None
    """
    Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. 
    """


    # @ApiMember(Description="Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. ")
    take_accounts: Optional[int] = None
    """
    Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. 
    """


    # @ApiMember(Description="The number of query results to skip.")
    skip: Optional[int] = None
    """
    The number of query results to skip.
    """


    # @ApiMember(Description="The number of query results to include.")
    take: Optional[int] = None
    """
    The number of query results to include.
    """


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[T]):
    offset: int = 0
    total: int = 0
    results: Optional[List[T]] = None
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

Python SearchCustomers DTOs

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/customers/search HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml

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

<CustomerQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Services.Contracts.Responses">
  <Offset xmlns="http://schemas.servicestack.net/types">0</Offset>
  <Total xmlns="http://schemas.servicestack.net/types">0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models" xmlns="http://schemas.servicestack.net/types">
    <d2p1:Customer>
      <d2p1:Accounts>
        <d2p1:Account>
          <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:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1: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:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1: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:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d2p1:Roles>
          <d2p1:Salt>String</d2p1:Salt>
          <d2p1:State>String</d2p1:State>
          <d2p1:TimeZone>String</d2p1:TimeZone>
          <d2p1:UserName>String</d2p1:UserName>
        </d2p1:Account>
      </d2p1:Accounts>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Index>0</d2p1:Index>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Type>Internal</d2p1:Type>
    </d2p1:Customer>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus xmlns="http://schemas.servicestack.net/types">
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <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>
        </Meta>
      </ResponseError>
    </Errors>
    <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>
    </Meta>
  </ResponseStatus>
</CustomerQueryResponse>
© 2021 - 2024 PwC. All rights reserved.
PwC refers to the PwC network and/or one or more of its member firms, each of which is a separate legal entity. Please see www.pwc.com/structure for further details. Any use of third party IP such as ELSTER is governed by the respective third party terms.