Tax Filing Service

<back to all web services

RegisterCustomer

RegisterCustomersSync

Represents a service request to register a customer.

Requires Authentication
Required role:AdminRequired permissions:CanAccess, CanAdd
The following routes are available for this service:
POST/sync/customers/details
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Represents a service request to register a customer.
*/
@Api(Description="Represents a service request to register a customer.")
open class RegisterCustomer : RegisterCustomerBase()
{
    /**
    * The name of the customer.
    */
    @ApiMember(Description="The name of the customer.")
    @Validate(Validator="NotEmpty")
    var name:String? = null

    /**
    * The country of residence or headquarters of the customer.
    */
    @ApiMember(Description="The country of residence or headquarters of the customer.")
    var country:String? = null

    /**
    * The type of customer.
    */
    @ApiMember(Description="The type of customer.")
    var customerType:CustomerType? = null

    /**
    * The list of accounts associated with the customer.
    */
    @ApiMember(Description="The list of accounts associated with the customer.")
    var accounts:ArrayList<Account> = ArrayList<Account>()
}

/**
* Specifies a base service request to register a customer.
*/
@Api(Description="Specifies a base service request to register a customer.")
open class RegisterCustomerBase : IPost
{
    /**
    * The name of the customer.
    */
    @ApiMember(Description="The name of the customer.")
    @Validate(Validator="NotEmpty")
    var name:String? = null

    /**
    * The country of residence or headquarters of the customer.
    */
    @ApiMember(Description="The country of residence or headquarters of the customer.")
    var country:String? = null

    /**
    * The type of customer.
    */
    @ApiMember(Description="The type of customer.")
    var customerType:CustomerType? = null

    /**
    * The list of accounts associated with the customer.
    */
    @ApiMember(Description="The list of accounts associated with the customer.")
    var accounts:ArrayList<Account> = ArrayList<Account>()
}

enum class CustomerType
{
    Internal,
    Network,
    External,
}

/**
* Represents a user account.
*/
@Api(Description="Represents a user account.")
open class Account : IHasUserName
{
    /**
    * The unique identifier of the user account.
    */
    @ApiMember(Description="The unique identifier of the user account.", IsRequired=true)
    var id:Int? = null

    /**
    * The position of this instance in a collection of 'Account' instances
    */
    @ApiMember(Description="The position of this instance in a collection of 'Account' instances", IsRequired=true)
    var index:Int? = null

    /**
    * The unique identifier of the customer associated with this account.
    */
    @ApiMember(Description="The unique identifier of the customer associated with this account.", IsRequired=true)
    var refId:Int? = null

    /**
    * 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 string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.")
    var refIdStr:String? = null

    /**
    * The unique user name of the user account.
    */
    @ApiMember(Description="The unique user name of the user account.", IsRequired=true)
    var userName:String? = null

    /**
    * The electronic mail address of the user account.
    */
    @ApiMember(Description="The electronic mail address of the user account.")
    var email:String? = null

    /**
    * The friendly name of the user account.
    */
    @ApiMember(Description="The friendly name of the user account.")
    var displayName:String? = null

    /**
    * The first name of the owner (natural person) of the user account.
    */
    @ApiMember(Description="The first name of the owner (natural person) of the user account.")
    var firstName:String? = null

    /**
    * The last name of the owner (natural person) of the user account.
    */
    @ApiMember(Description="The last name of the owner (natural person) of the user account.")
    var lastName:String? = null

    /**
    * The unique identifier of the customer associated with this account.
    */
    @ApiMember(Description="The unique identifier of the customer associated with this account.")
    var fullName:String? = null

    /**
    * The gender of the owner (natural person) of the user account.
    */
    @ApiMember(Description="The gender of the owner (natural person) of the user account.")
    var gender:String? = null

    /**
    * The language of the owner of teh user account.
    */
    @ApiMember(Description="The language of the owner of teh user account.")
    var language:String? = null

    /**
    * The company, where the user is an employee.
    */
    @ApiMember(Description="The company, where the user is an employee.")
    var company:String? = null

    /**
    * The profile URL of the user account.
    */
    @ApiMember(Description="The profile URL of the user account.", IsRequired=true)
    var profileUrl:String? = null

    /**
    * The roles assigned to the user account.
    */
    @ApiMember(Description="The roles assigned to the user account.")
    var roles:ArrayList<String> = ArrayList<String>()

    /**
    * The permissions assigned to the user account.
    */
    @ApiMember(Description="The permissions assigned to the user account.")
    var permissions:ArrayList<String> = ArrayList<String>()

    /**
    * The primary e-mail address of the user.
    */
    @ApiMember(Description="The primary e-mail address of the user.")
    var primaryEmail:String? = null

    /**
    * Random data to enhance the security of the user password.
    */
    @ApiMember(Description="Random data to enhance the security of the user password.")
    var salt:String? = null

    /**
    * The hash value of the user password that the PBKDF2 algorithm produces.
    */
    @ApiMember(Description="The hash value of the user password that the PBKDF2 algorithm produces.")
    var passwordHash:String? = null

    /**
    * The hash value of the user password that the DigestHa1 algorithm produces.
    */
    @ApiMember(Description="The hash value of the user password that the DigestHa1 algorithm produces.")
    var digestHa1Hash:String? = null

    /**
    * The number of times the user account tried to sign in but failed.
    */
    @ApiMember(Description="The number of times the user account tried to sign in but failed.")
    var invalidLoginAttempts:Int? = null

    /**
    * The last time the user account attempted a sign in.
    */
    @ApiMember(Description="The last time the user account attempted a sign in.")
    var lastLoginAttempt:Date? = null

    /**
    * The date and time when the user acount was denied access.
    */
    @ApiMember(Description="The date and time when the user acount was denied access.")
    var lockedDate:Date? = null

    /**
    * The date and time when the user account was created.
    */
    @ApiMember(Description="The date and time when the user account was created.")
    var createdDate:Date? = null

    /**
    * The date and time when the user account was last modified.
    */
    @ApiMember(Description="The date and time when the user account was last modified.")
    var modifiedDate:Date? = null

    /**
    * The telephone number of the owner of the user account.
    */
    @ApiMember(Description="The telephone number of the owner of the user account.")
    var phoneNumber:String? = null

    /**
    * The birth date of the owner of the user account
    */
    @ApiMember(Description="The birth date of the owner of the user account")
    var birthDate:Date? = null

    /**
    * The string representation of the birth date of the user account.
    */
    @ApiMember(Description="The string representation of the birth date of the user account.")
    var birthDateRaw:String? = null

    /**
    * The mail address of the user account.
    */
    @ApiMember(Description="The mail address of the user account.")
    var address:String? = null

    /**
    * Additional information for the specified 'Address' of the user.
    */
    @ApiMember(Description="Additional information for the specified 'Address' of the user.")
    var address2:String? = null

    /**
    * The city of the owner of the user account.
    */
    @ApiMember(Description="The city of the owner of the user account.")
    var city:String? = null

    /**
    * The state of the owner of the user account.
    */
    @ApiMember(Description="The state of the owner of the user account.")
    var state:String? = null

    /**
    * The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.
    */
    @ApiMember(Description="The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.")
    var country:String? = null

    /**
    * The locale of the user account.
    */
    @ApiMember(Description="The locale of the user account.")
    var culture:String? = null

    /**
    * The mail address of the user account.
    */
    @ApiMember(Description="The mail address of the user account.")
    var mailAddress:String? = null

    /**
    * The nickname of the user of the user account.
    */
    @ApiMember(Description="The nickname of the user of the user account.")
    var nickname:String? = null

    /**
    * The postal code of the user account.
    */
    @ApiMember(Description="The postal code of the user account.")
    var postalCode:String? = null

    /**
    * The time zone of the user of the user account.
    */
    @ApiMember(Description="The time zone of the user of the user account.")
    var timeZone:String? = null

    /**
    * Additional information to attach to the user account.
    */
    @ApiMember(Description="Additional information to attach to the user account.")
    var meta:HashMap<String,String> = HashMap<String,String>()
}

/**
* Represents a response from a service operation that encapsulates customer data.
*/
@Api(Description="Represents a response from a service operation that encapsulates customer data.")
open class CustomerResponse : ServiceResponseBase()
{
    /**
    * The customer data of the response.
    */
    @ApiMember(Description="The customer data of the response.")
    var customer:Customer? = null

    /**
    * The index position of the reponse in a collection, if it were returned together with other responses.
    */
    @ApiMember(Description="The index position of the reponse in a collection, if it were returned together with other responses.")
    var index:Long? = null

    /**
    * Data structure that holds error information from a service operation.
    */
    @ApiMember(Description="Data structure that holds error information from a service operation.")
    var responseStatus:ResponseStatus? = null
}

/**
* Specifies a base service response class that contains a structured error information.
*/
@Api(Description="Specifies a base service response class that contains a structured error information.")
open class ServiceResponseBase
{
    /**
    * Data structure that holds error information from a service operation.
    */
    @ApiMember(Description="Data structure that holds error information from a service operation.")
    var responseStatus:ResponseStatus? = null
}

/**
* Represents a customer (business organization or entrepreneur).
*/
@Api(Description="Represents a customer (business organization or entrepreneur).")
open class Customer : IHasName
{
    /**
    * The unique identifier of the customer.
    */
    @ApiMember(Description="The unique identifier of the customer.", IsRequired=true)
    var id:Int? = null

    /**
    * The position of this instance in a collection of 'Customer' instances
    */
    @ApiMember(Description="The position of this instance in a collection of 'Customer' instances", IsRequired=true)
    var index:Int? = null

    /**
    * Full name or organization name of customer.
    */
    @ApiMember(Description="Full name or organization name of customer.", IsRequired=true)
    @Validate(Validator="NotEmpty")
    var name:String? = null

    /**
    * The country of residence or business of customer.
    */
    @ApiMember(Description="The country of residence or business of customer.")
    var country:String? = null

    /**
    * The type of customer.
    */
    @ApiMember(Description="The type of customer.")
    @SerializedName("type") var Type:CustomerType? = null

    /**
    * The list of user accounts associated with this customer.
    */
    @ApiMember(Description="The list of user accounts associated with this customer.")
    @Ignore()
    var accounts:ArrayList<Account> = ArrayList<Account>()
}

Kotlin RegisterCustomer 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.

POST /sync/customers/details HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RegisterCustomer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Services.Contracts.Requests">
  <Accounts xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models">
    <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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1: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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1: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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1: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>
  </Accounts>
  <Country>String</Country>
  <CustomerType>Internal</CustomerType>
  <Name>String</Name>
</RegisterCustomer>

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

<CustomerResponse 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>
  <Customer xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models">
    <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: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:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
        <d2p1:Nickname>String</d2p1:Nickname>
        <d2p1:PasswordHash>String</d2p1:PasswordHash>
        <d2p1:Permissions xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1: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:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1: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>
  </Customer>
  <Index>0</Index>
</CustomerResponse>
© 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.