Tax Filing Service

<back to all web services

UpdateCustomer

UpdateCustomersSync

Represents a service request to update product data.

Requires Authentication
Required role:AdminRequired permissions:CanAccess, CanEdit
The following routes are available for this service:
PUT/sync/customers/{Id}
UpdateCustomerBase Parameters:
NameParameterData TypeRequiredDescription
IdformintYesThe unique identifier of the customer.
NameformstringNoThe name of the customer.
CountryformstringNoThe country of residence or headquarters of the customer.
CustomerTypeformCustomerType?NoThe type of customer.

Allowable Values

  • Internal
  • Network
  • External
AccountsformList<Account>YesAccounts the customer holds.
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.
CustomerResponse Parameters:
NameParameterData TypeRequiredDescription
CustomerformCustomerNoThe customer data of the response.
IndexformlongNoThe index position of the reponse in a collection, if it were returned together with other responses.
ServiceResponseBase Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNoData structure that holds error information from a service operation.
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.

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.

PUT /sync/customers/{Id} HTTP/1.1 
Host: taxfiling.staging.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateCustomer 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>
  <Id>0</Id>
  <Name>String</Name>
</UpdateCustomer>

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.