API Docs / Schemas / CreateSavedClientFilterRequest

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")

descriptionstring

Optional description providing more details about this filter's purpose

Optional description providing more details about this filter's purpose

includeInMenuboolean

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.

isSharedboolean

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.

managerCodesarray of string

Filter by manager code(s)

Filter by manager code(s)

partnerCodesarray of string

Filter by partner code(s)

Filter by partner code(s)

associateCodesarray of string

Filter by associate code(s)

Filter by associate code(s)

statusesarray of enum

Filter by client status(es)

Active Inactive Prospect LostProspect

Filter by client status(es)

Active Inactive Prospect LostProspect

typesarray 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

serviceCodesarray of string

Filter by billable service code(s)

Filter by billable service code(s)

packageCodesarray of string

Filter by service package code(s)

Filter by service package code(s)

teamCodesarray of string

Filter by team code(s)

Filter by team code(s)

serviceStageCodesarray of string

Filter by service stage composite codes (format: "serviceCode:stageCode")

Filter by service stage composite codes (format: "serviceCode:stageCode")

defaultSortFieldenum

Name InternalReference

Name InternalReference

defaultSortDescboolean

Sort in descending order (true) or ascending order (false)

Sort in descending order (true) or ascending order (false)

iconNamestring

Optional Lucide icon name for visual identification (e.g., "Calendar", "Users", "Star")

Optional Lucide icon name for visual identification (e.g., "Calendar", "Users", "Star")

colorstring

Optional hex color for visual identification (e.g., "#FF5733")

Optional hex color for visual identification (e.g., "#FF5733")

columnConfigJsonstring

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