Tax Filing Service
| Required role: | Admin | Required permissions: | CanAccess, CanAdd |
| POST | /sync/customers/details |
|---|
"use strict";
/** @typedef {'Internal'|'Network'|'External'} */
export var CustomerType;
(function (CustomerType) {
CustomerType["Internal"] = "Internal"
CustomerType["Network"] = "Network"
CustomerType["External"] = "External"
})(CustomerType || (CustomerType = {}));
export class Account {
/** @param {{id?:number,index?:number,refId?:number,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?:number,lastLoginAttempt?:string,lockedDate?:string,createdDate?:string,modifiedDate?:string,phoneNumber?:string,birthDate?:string,birthDateRaw?:string,address?:string,address2?:string,city?:string,state?:string,country?:string,culture?:string,mailAddress?:string,nickname?:string,postalCode?:string,timeZone?:string,meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The unique identifier of the user account. */
id;
/**
* @type {number}
* @description The position of this instance in a collection of 'Account' instances */
index;
/**
* @type {number}
* @description The unique identifier of the customer associated with this account. */
refId;
/**
* @type {?string}
* @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'. */
refIdStr;
/**
* @type {string}
* @description The unique user name of the user account. */
userName;
/**
* @type {?string}
* @description The electronic mail address of the user account. */
email;
/**
* @type {?string}
* @description The friendly name of the user account. */
displayName;
/**
* @type {?string}
* @description The first name of the owner (natural person) of the user account. */
firstName;
/**
* @type {?string}
* @description The last name of the owner (natural person) of the user account. */
lastName;
/**
* @type {?string}
* @description The unique identifier of the customer associated with this account. */
fullName;
/**
* @type {?string}
* @description The gender of the owner (natural person) of the user account. */
gender;
/**
* @type {?string}
* @description The language of the owner of teh user account. */
language;
/**
* @type {?string}
* @description The company, where the user is an employee. */
company;
/**
* @type {string}
* @description The profile URL of the user account. */
profileUrl;
/**
* @type {string[]}
* @description The roles assigned to the user account. */
roles;
/**
* @type {string[]}
* @description The permissions assigned to the user account. */
permissions;
/**
* @type {?string}
* @description The primary e-mail address of the user. */
primaryEmail;
/**
* @type {?string}
* @description Random data to enhance the security of the user password. */
salt;
/**
* @type {?string}
* @description The hash value of the user password that the PBKDF2 algorithm produces. */
passwordHash;
/**
* @type {?string}
* @description The hash value of the user password that the DigestHa1 algorithm produces. */
digestHa1Hash;
/**
* @type {number}
* @description The number of times the user account tried to sign in but failed. */
invalidLoginAttempts;
/**
* @type {?string}
* @description The last time the user account attempted a sign in. */
lastLoginAttempt;
/**
* @type {?string}
* @description The date and time when the user acount was denied access. */
lockedDate;
/**
* @type {string}
* @description The date and time when the user account was created. */
createdDate;
/**
* @type {string}
* @description The date and time when the user account was last modified. */
modifiedDate;
/**
* @type {?string}
* @description The telephone number of the owner of the user account. */
phoneNumber;
/**
* @type {?string}
* @description The birth date of the owner of the user account */
birthDate;
/**
* @type {?string}
* @description The string representation of the birth date of the user account. */
birthDateRaw;
/**
* @type {?string}
* @description The mail address of the user account. */
address;
/**
* @type {?string}
* @description Additional information for the specified 'Address' of the user. */
address2;
/**
* @type {?string}
* @description The city of the owner of the user account. */
city;
/**
* @type {?string}
* @description The state of the owner of the user account. */
state;
/**
* @type {?string}
* @description The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'. */
country;
/**
* @type {?string}
* @description The locale of the user account. */
culture;
/**
* @type {?string}
* @description The mail address of the user account. */
mailAddress;
/**
* @type {?string}
* @description The nickname of the user of the user account. */
nickname;
/**
* @type {?string}
* @description The postal code of the user account. */
postalCode;
/**
* @type {?string}
* @description The time zone of the user of the user account. */
timeZone;
/**
* @type {?{ [index: string]: string; }}
* @description Additional information to attach to the user account. */
meta;
}
export class RegisterCustomerBase {
/** @param {{name?:string,country?:string,customerType?:CustomerType,accounts?:Account[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The name of the customer. */
name;
/**
* @type {?string}
* @description The country of residence or headquarters of the customer. */
country;
/**
* @type {CustomerType}
* @description The type of customer. */
customerType;
/**
* @type {Account[]}
* @description The list of accounts associated with the customer. */
accounts;
}
export class ServiceResponseBase {
/** @param {{responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?ResponseStatus}
* @description Data structure that holds error information from a service operation. */
responseStatus;
}
export class Customer {
/** @param {{id?:number,index?:number,name?:string,country?:string,type?:CustomerType,accounts?:Account[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The unique identifier of the customer. */
id;
/**
* @type {number}
* @description The position of this instance in a collection of 'Customer' instances */
index;
/**
* @type {string}
* @description Full name or organization name of customer. */
name;
/**
* @type {?string}
* @description The country of residence or business of customer. */
country;
/**
* @type {CustomerType}
* @description The type of customer. */
type;
/**
* @type {Account[]}
* @description The list of user accounts associated with this customer. */
accounts;
}
export class CustomerResponse extends ServiceResponseBase {
/** @param {{customer?:Customer,index?:number,responseStatus?:ResponseStatus,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {?Customer}
* @description The customer data of the response. */
customer;
/**
* @type {number}
* @description The index position of the reponse in a collection, if it were returned together with other responses. */
index;
/**
* @type {?ResponseStatus}
* @description Data structure that holds error information from a service operation. */
responseStatus;
}
export class RegisterCustomer extends RegisterCustomerBase {
/** @param {{name?:string,country?:string,customerType?:CustomerType,accounts?:Account[],name?:string,country?:string,customerType?:CustomerType,accounts?:Account[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description The name of the customer. */
name;
/**
* @type {?string}
* @description The country of residence or headquarters of the customer. */
country;
/**
* @type {CustomerType}
* @description The type of customer. */
customerType;
/**
* @type {Account[]}
* @description The list of accounts associated with the customer. */
accounts;
}
JavaScript RegisterCustomer DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>