CreateSavedClientFilterRequest

Request model for creating a new saved client filter

Properties

Name	Type	Description
name*	string	User-friendly name for this saved filter (e.g., "Active Limited Companies", "My Managed Clients")
User-friendly name for this saved filter (e.g., "Active Limited Companies", "My Managed Clients")
description	string	Optional description providing more details about this filter's purpose
Optional description providing more details about this filter's purpose
includeInMenu	boolean	Whether this filter should be included in the current user's menu/quick access list. This is a per-user preference — it does not affect other users of a shared filter.
Whether this filter should be included in the current user's menu/quick access list. This is a per-user preference — it does not affect other users of a shared filter.
isShared	boolean	Whether this filter is shared with all users in the tenant. Shared filters are visible (read-only) to everyone; only the owner can modify or delete them.
Whether this filter is shared with all users in the tenant. Shared filters are visible (read-only) to everyone; only the owner can modify or delete them.
managerCodes	array of string	Filter by manager code(s)
Filter by manager code(s)
partnerCodes	array of string	Filter by partner code(s)
Filter by partner code(s)
associateCodes	array of string	Filter by associate code(s)
Filter by associate code(s)
statuses	array of enum	Filter by client status(es) Active Inactive Prospect LostProspect
Filter by client status(es) Active Inactive Prospect LostProspect
types	array of enum	Filter by client type(s) PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader Association
Filter by client type(s) PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader Association
serviceCodes	array of string	Filter by billable service code(s)
Filter by billable service code(s)
packageCodes	array of string	Filter by service package code(s)
Filter by service package code(s)
teamCodes	array of string	Filter by team code(s)
Filter by team code(s)
serviceStageCodes	array of string	Filter by service stage composite codes (format: "serviceCode:stageCode")
Filter by service stage composite codes (format: "serviceCode:stageCode")
customFieldFilters	array of string	Filter by custom field composite values (format: "fieldCode:value", or "fieldCode:" for blank)
Filter by custom field composite values (format: "fieldCode:value", or "fieldCode:" for blank)
keyDateType	enum	IncorporationDate YearEnd AccountsNextDue AccountsNextPeriodStart AccountsNextPeriodEnd AccountsLastPeriodFiled AccountsLastPeriodStart AccountsLastPeriodEnd AccountsLastMadeUpTo ConfirmationStatementDue ConfirmationStatementNextMadeUpTo LastConfirmationStatementFiled LastConfirmationStatementMadeUpTo NextVatReturnDueAnnual NextVatPeriodEndQuarterly NextVatReturnDueQuarterly NextVatPeriodEndMonthly NextVatReturnDueMonthly NextTaxQuarterPeriodEnd NextTaxQuarterSubmissionDeadline NextPayeCisFilingDue PensionReEnrolmentDate
IncorporationDate YearEnd AccountsNextDue AccountsNextPeriodStart AccountsNextPeriodEnd AccountsLastPeriodFiled AccountsLastPeriodStart AccountsLastPeriodEnd AccountsLastMadeUpTo ConfirmationStatementDue ConfirmationStatementNextMadeUpTo LastConfirmationStatementFiled LastConfirmationStatementMadeUpTo NextVatReturnDueAnnual NextVatPeriodEndQuarterly NextVatReturnDueQuarterly NextVatPeriodEndMonthly NextVatReturnDueMonthly NextTaxQuarterPeriodEnd NextTaxQuarterSubmissionDeadline NextPayeCisFilingDue PensionReEnrolmentDate
keyDateRange	enum	ThisWeek NextWeek Last7Days Next7Days Last30Days Next30Days PreviousMonth ThisMonth NextMonth PreviousQuarter ThisQuarter NextQuarter PreviousYear ThisYear NextYear YearToDate PreviousTaxYear ThisTaxYear NextTaxYear TaxYearToDate Today PreviousWeek CustomDateRange
ThisWeek NextWeek Last7Days Next7Days Last30Days Next30Days PreviousMonth ThisMonth NextMonth PreviousQuarter ThisQuarter NextQuarter PreviousYear ThisYear NextYear YearToDate PreviousTaxYear ThisTaxYear NextTaxYear TaxYearToDate Today PreviousWeek CustomDateRange
keyDateFrom	string	Start of the key date window. Only set when KeyDateRange is CustomDateRange.
Start of the key date window. Only set when KeyDateRange is CustomDateRange.
keyDateTo	string	End of the key date window. Only set when KeyDateRange is CustomDateRange.
End of the key date window. Only set when KeyDateRange is CustomDateRange.
defaultSortKeyDateType	enum	IncorporationDate YearEnd AccountsNextDue AccountsNextPeriodStart AccountsNextPeriodEnd AccountsLastPeriodFiled AccountsLastPeriodStart AccountsLastPeriodEnd AccountsLastMadeUpTo ConfirmationStatementDue ConfirmationStatementNextMadeUpTo LastConfirmationStatementFiled LastConfirmationStatementMadeUpTo NextVatReturnDueAnnual NextVatPeriodEndQuarterly NextVatReturnDueQuarterly NextVatPeriodEndMonthly NextVatReturnDueMonthly NextTaxQuarterPeriodEnd NextTaxQuarterSubmissionDeadline NextPayeCisFilingDue PensionReEnrolmentDate
IncorporationDate YearEnd AccountsNextDue AccountsNextPeriodStart AccountsNextPeriodEnd AccountsLastPeriodFiled AccountsLastPeriodStart AccountsLastPeriodEnd AccountsLastMadeUpTo ConfirmationStatementDue ConfirmationStatementNextMadeUpTo LastConfirmationStatementFiled LastConfirmationStatementMadeUpTo NextVatReturnDueAnnual NextVatPeriodEndQuarterly NextVatReturnDueQuarterly NextVatPeriodEndMonthly NextVatReturnDueMonthly NextTaxQuarterPeriodEnd NextTaxQuarterSubmissionDeadline NextPayeCisFilingDue PensionReEnrolmentDate
defaultSortField	enum	Name InternalReference KeyDate
Name InternalReference KeyDate
defaultSortDesc	boolean	Sort in descending order (true) or ascending order (false)
Sort in descending order (true) or ascending order (false)
iconName	string	Optional Lucide icon name for visual identification (e.g., "Calendar", "Users", "Star")
Optional Lucide icon name for visual identification (e.g., "Calendar", "Users", "Star")
color	string	Optional hex color for visual identification (e.g., "#FF5733")
Optional hex color for visual identification (e.g., "#FF5733")
columnConfigJson	string	Optional JSON column configuration for the saved view. When set, overrides the user's default client column preferences.
Optional JSON column configuration for the saved view. When set, overrides the user's default client column preferences.

JSON Example

{
  "name": "string",
  "description": "string",
  "includeInMenu": false,
  "isShared": false,
  "managerCodes": [
    "string"
  ]
}

Used By Operations

POST Create SavedClientFilter
/tenants/{tenant}/saved-client-filters