ClientDto
Response DTO for client information
Properties
| Name | Type | Description |
|---|---|---|
| code | string | The client's unique Code within the tenant |
The client's unique Code within the tenant | ||
| name | string | The name of the client |
The name of the client | ||
| type | enum | PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader |
PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader | ||
| manager | CodeAndNameDto | |
| partner | CodeAndNameDto | |
| associate | CodeAndNameDto | |
| team | CodeAndNameDto | |
| internalReference | string | Optional internal reference number/code for the client |
Optional internal reference number/code for the client | ||
| 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 | ||
| amlClientId | string | The client/account ID from the connected AML platform |
The client/account ID from the connected AML platform | ||
| amlClientName | string | The display name of the client in the connected AML platform |
The display name of the client in the connected AML platform | ||
| 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 | ||
| companiesHouseLink | enum | None Pending Completed Failed |
None Pending Completed Failed | ||
| companiesHouseSync | enum | None Auto |
None Auto | ||
| companiesHouseLastSyncedDate | string | When Companies House data was last synced for this client |
When Companies House data was last synced for this client | ||
| documentsPendingClientApprovalCount | integer | Number of documents awaiting client approval |
Number of documents awaiting client approval | ||
| documentsPendingUserReviewCount | integer | Number of documents uploaded by client via portal awaiting user review |
Number of documents uploaded by client via portal awaiting user review | ||
| portalUserCount | integer | Number of portal users with access to this client |
Number of portal users with access to this client | ||
| outstandingDocumentRequestCount | integer | Number of document requests in Open or Submitted status |
Number of document requests in Open or Submitted status | ||
| documentRequestsPendingReviewCount | integer | Number of document requests in Submitted status awaiting staff review |
Number of document requests in Submitted status awaiting staff review | ||
| pendingConfirmationCount | integer | Number of client confirmation workflow steps awaiting the client's response |
Number of client confirmation workflow steps awaiting the client's response | ||
| createdDate | string | When the client was created |
When the client was created | ||
| updatedDate | string | When the client was last updated |
When the client was last updated | ||
JSON Example
{
"code": "string",
"name": "string",
"type": "PrivateLimitedCompany",
"manager": {
"code": "string",
"name": "string"
},
"partner": {
"code": "string",
"name": "string"
}
}