Tax Filing Service
| Required role: | Admin | Required permissions: | CanAccess, CanEdit |
| PUT | /sync/accounts/{Id} |
|---|
"use strict";
export class AdminUpdateAccountBase {
/** @param {{id?:number,userName?:string,displayName?:string,email?:string,profileUrl?:string,roles?:string[],permissions?:string[],meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The unique identifier of the user account. */
id;
/**
* @type {?string}
* @description The user name of the user account. */
userName;
/**
* @type {?string}
* @description The display name of the user account. */
displayName;
/**
* @type {?string}
* @description The e-mail address of the user account. */
email;
/** @type {?string} */
profileUrl;
/**
* @type {string[]}
* @description The roles of the user account. */
roles;
/**
* @type {string[]}
* @description The roles of the user account. */
permissions;
/**
* @type {{ [index: string]: string; }}
* @description Extra information for the user account. */
meta;
}
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 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 Product {
/** @param {{id?:number,index?:number,name?:string,version?:string,description?:string,tags?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The unique identifier of the product. */
id;
/**
* @type {number}
* @description The position of this instance in a collection of 'Product' instances */
index;
/**
* @type {string}
* @description The name of the product. */
name;
/**
* @type {string}
* @description The version of the product. */
version;
/**
* @type {?string}
* @description The version of the product. */
description;
/**
* @type {string[]}
* @description Tags associated with the product. */
tags;
}
export class Order {
/** @param {{id?:number,productId?:number,accountId?:number,name?:string,serviceName?:string,requestTimestamp?:string,responseTimestamp?:string,requestUri?:string,requestHttpMethod?:string,requestDuration?:string,responseStatusCode?:HttpStatusCode,clientIPAddress?:string,unitOfMeasurement?:string,processType?:string,dataType?:string,dataName?:string,creationDate?:string,expiryDate?:string,isTest?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The unique identifier of the order. */
id;
/**
* @type {number}
* @description The unique identifier of the product, for which the order is made. */
productId;
/**
* @type {number}
* @description The unique identifier of the user account, who placed the order. */
accountId;
/**
* @type {string}
* @description A name to identify the order. */
name;
/**
* @type {?string}
* @description The name of the service, for which the order was made. */
serviceName;
/**
* @type {?string}
* @description The time stamp at which the order was initiated. */
requestTimestamp;
/**
* @type {?string}
* @description The time stamp at which the order was completed. */
responseTimestamp;
/**
* @type {?string}
* @description The URI from which the order was initiated. */
requestUri;
/**
* @type {?string}
* @description The HTTP method of the order request. */
requestHttpMethod;
/**
* @type {?string}
* @description The duration of the order request. */
requestDuration;
/**
* @type {HttpStatusCode}
* @description The HTTP status code of the order request. */
responseStatusCode;
/**
* @type {?string}
* @description The IP address of client, who placed the order. */
clientIPAddress;
/**
* @type {?string}
* @description The unit of measurement for the order. */
unitOfMeasurement;
/**
* @type {?string}
* @description The type of process, for which the order is charged. */
processType;
/**
* @type {?string}
* @description The type of data, for which the order is charged. */
dataType;
/**
* @type {?string}
* @description The name of the data, for which the order is charged. */
dataName;
/**
* @type {string}
* @description The date of creation of the order. */
creationDate;
/**
* @type {?string}
* @description The final date to retain the order in the records. After this date, the order is expunged from the records. */
expiryDate;
/**
* @type {boolean}
* @description Indicates whether the order is simulated for test purposes. True if the order is simulated for test purposes; otherwise it is a false order for production purposes. */
isTest;
}
export class AccountResponse extends ServiceResponseBase {
/** @param {{account?:Account,index?:number,products?:Product[],orders?:Order[],responseStatus?:ResponseStatus,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {?Account}
* @description The user account encapsulated in the response. */
account;
/**
* @type {number}
* @description The index position of the reponse in a collection, if it were returned together with other responses. */
index;
/**
* @type {Product[]}
* @description The list of products associated with the encapsulated user account. */
products;
/**
* @type {Order[]}
* @description The list of orders associated with the encapsulated user account. */
orders;
/**
* @type {?ResponseStatus}
* @description Data structure that holds error information from a service operation. */
responseStatus;
}
export class AdminUpdateAccount extends AdminUpdateAccountBase {
/** @param {{id?:number,userName?:string,displayName?:string,email?:string,profileUrl?:string,roles?:string[],permissions?:string[],meta?:{ [index: string]: string; },id?:number,userName?:string,displayName?:string,email?:string,profileUrl?:string,roles?:string[],permissions?:string[],meta?:{ [index: string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {number}
* @description The unique identifier of the user account. */
id;
/**
* @type {?string}
* @description The user name of the user account. */
userName;
/**
* @type {?string}
* @description The display name of the user account. */
displayName;
/**
* @type {?string}
* @description The e-mail address of the user account. */
email;
/** @type {?string} */
profileUrl;
/**
* @type {string[]}
* @description The roles of the user account. */
roles;
/**
* @type {string[]}
* @description The roles of the user account. */
permissions;
/**
* @type {{ [index: string]: string; }}
* @description Extra information for the user account. */
meta;
}
JavaScript AdminUpdateAccount DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /sync/accounts/{Id} HTTP/1.1
Host: taxfiling.pwc.de
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"id":0,"userName":"String","displayName":"String","email":"String","profileUrl":"String","roles":["String"],"permissions":["String"],"meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"account":{"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"}},"index":0,"products":[{"id":0,"index":0,"name":"String","version":"String","description":"String","tags":["String"]}],"orders":[{"id":0,"productId":0,"accountId":0,"name":"String","serviceName":"String","requestTimestamp":"\/Date(-62135596800000-0000)\/","responseTimestamp":"\/Date(-62135596800000-0000)\/","requestUri":"String","requestHttpMethod":"String","requestDuration":"PT0S","responseStatusCode":"Continue","clientIPAddress":"String","unitOfMeasurement":"String","processType":"String","dataType":"String","dataName":"String","creationDate":"\/Date(-62135596800000-0000)\/","expiryDate":"\/Date(-62135596800000-0000)\/","isTest":false}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}