Tax Filing Service

<back to all web services

BatchRegisterCustomers

RegisterCustomersBatchSync

Represents a service request to register one or more customers in a batch operation.

Requires Authentication
Required role:AdminRequired permissions:CanAccess, CanAdd
The following routes are available for this service:
POST/sync/customers/batch
"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 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 BatchRegisterCustomersBase {
    /** @param {{customers?:Customer[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Customer[]}
     * @description The customers to register. */
    customers;
}
export class BatchRegisterCustomers extends BatchRegisterCustomersBase {
    /** @param {{customers?:Customer[],customers?:Customer[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {Customer[]}
     * @description The customers to register. */
    customers;
}

JavaScript BatchRegisterCustomers DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /sync/customers/batch HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	customers: 
	[
		{
			id: 0,
			index: 0,
			name: String,
			country: String,
			type: Internal,
			accounts: 
			[
				{
					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: 0001-01-01,
					lockedDate: 0001-01-01,
					createdDate: 0001-01-01,
					modifiedDate: 0001-01-01,
					phoneNumber: String,
					birthDate: 0001-01-01,
					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
					}
				}
			]
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		customer: 
		{
			id: 0,
			index: 0,
			name: String,
			country: String,
			type: Internal,
			accounts: 
			[
				{
					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: 0001-01-01,
					lockedDate: 0001-01-01,
					createdDate: 0001-01-01,
					modifiedDate: 0001-01-01,
					phoneNumber: String,
					birthDate: 0001-01-01,
					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,
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		}
	}
]