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 Association
PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader Association
manager	CodeAndNameDto
partner	CodeAndNameDto
associate	CodeAndNameDto
teams	array of CodeAndNameDto	The teams assigned to this client
The teams assigned to this client
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
email	string	The email address for the client
The email address for the client
alternativeEmails	array of string	Additional email addresses for the client. Email remains the primary address.
Additional email addresses for the client. Email remains the primary address.
telephone	string	The telephone number for the client
The telephone number for the client
alternativePhoneNumbers	array of string	Additional phone numbers for the client. Telephone remains the primary number.
Additional phone numbers for the client. Telephone remains the primary number.
contactPreferences	ContactPreferencesDto
invoiceDayOfMonth	integer	Day of month (1-28) for automatic invoicing. Null disables auto-invoicing.
Day of month (1-28) for automatic invoicing. Null disables auto-invoicing.
invoicePaymentTermDays	integer	Payment terms in days for generated invoices
Payment terms in days for generated invoices
lineItemApprovalRequired	boolean	Null = use tenant default. True = require manual approval. False = auto-approve.
Null = use tenant default. True = require manual approval. False = auto-approve.
vatTreatment	enum	Standard OutsideScope
Standard OutsideScope
primaryContactName	string	The full name of the primary (main) contact for this client
The full name of the primary (main) contact for this client
primaryContactEmail	string	The email address of the primary (main) contact for this client
The email address of the primary (main) contact for this client
latestNoteContent	string	The most recent note/comment on this client
The most recent note/comment on this client
latestNoteDate	string	When the most recent note was created
When the most recent note was created
pinnedNoteContent	string	The most prominently pinned note on this client (highest pin level, then most recent)
The most prominently pinned note on this client (highest pin level, then most recent)
pinnedNoteDate	string	When the pinned note was created
When the pinned note was created
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
snoozeChasesUntil	string	Automated chase emails are suppressed until this date (chasing resumes on the date itself). Null = not snoozed.
Automated chase emails are suppressed until this date (chasing resumes on the date itself). Null = not snoozed.
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
pendingBillingLineItemCount	integer	Number of billing line items waiting for someone to approve them
Number of billing line items waiting for someone to approve them
failedInvoiceSubmissionCount	integer	Number of invoice submissions that failed to reach the accounting platform
Number of invoice submissions that failed to reach the accounting platform
keyDates	array of ClientDateDto	The client's key dates. Populated on list responses only (single-client reads use the dedicated key dates endpoint). Includes the engine-computed VAT dates, flagged with isComputed — those are derived from the client's VAT reporting period, not stored.
The client's key dates. Populated on list responses only (single-client reads use the dedicated key dates endpoint). Includes the engine-computed VAT dates, flagged with isComputed — those are derived from the client's VAT reporting period, not stored.
requiredAgentAuthorisations	array of enum	HMRC agent authorisation types required by this client's active or proposed services. Populated on single-client reads only (the list endpoint would run this per row). Uses the same rule as the IsRequired flag on the agent authorisations endpoint. SelfAssessment CorporationTax PayeForEmployers IndividualPayAsYouEarn VAT ConstructionIndustryScheme TaxCredits HighIncomeChildBenefitCharge MakingTaxDigitalIncomeTax MakingTaxDigitalVat Trusts
HMRC agent authorisation types required by this client's active or proposed services. Populated on single-client reads only (the list endpoint would run this per row). Uses the same rule as the IsRequired flag on the agent authorisations endpoint. SelfAssessment CorporationTax PayeForEmployers IndividualPayAsYouEarn VAT ConstructionIndustryScheme TaxCredits HighIncomeChildBenefitCharge MakingTaxDigitalIncomeTax MakingTaxDigitalVat Trusts
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"
  }
}

ClientDto

Properties

JSON Example

Used By Operations

Contained in Schemas