UpdateClientRequest

Request DTO for updating an existing client

Properties

Name	Type	Description
name*	string	The name of the client
The name of the client
type*	enum	PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust
PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust
internalReference	string	Optional internal reference number/code for the client
Optional internal reference number/code for the client
managerCode	string	Code of the user who will manage this client. The user must exist and have access to the tenant.
Code of the user who will manage this client. The user must exist and have access to the tenant.
partnerCode	string	Code of the user who will be the partner for this client. The user must exist and have access to the tenant.
Code of the user who will be the partner for this client. The user must exist and have access to the tenant.
associateCode	string	Code of the user who will be the associate for this client. The user must exist and have access to the tenant.
Code of the user who will be the associate for this client. The user must exist and have access to the tenant.
revenueRangeCode	string	The revenue range code for this client
The revenue range code for this client
status	enum	Active Inactive Prospect LostProspect
Active Inactive Prospect LostProspect
accountingCustomerCode	string	The customer code/ID from the connected accounting platform
The customer code/ID from the connected accounting platform
directDebitMandateId	string	The mandate ID from the connected direct debit platform
The mandate ID from the connected direct debit platform
email	string	The email address for the client
The email address for the client
telephone	string	The telephone number for the client
The telephone number for the client
contactPreferences	ContactPreferencesDto
pclSent	boolean	Indicates whether a Professional Clearance Letter has been sent for this client
Indicates whether a Professional Clearance Letter has been sent for this client

JSON Example

{
  "name": "string",
  "type": "PrivateLimitedCompany",
  "internalReference": "string",
  "managerCode": "string",
  "partnerCode": "string"
}

Used By Operations

PUT Update Client
/api/tenants/{tenant}/clients/{code}