SavedClientFilterDto
A saved client filter belonging to a tenant user, defining reusable criteria for filtering client lists
Properties
| Name | Type | Description |
|---|---|---|
| code | string | Unique identifier within the tenant |
Unique identifier within the tenant | ||
| name | string | User-friendly name for this saved filter |
User-friendly name for this saved filter | ||
| 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 filter menu/quick access list |
Whether this filter should be included in the filter menu/quick access list | ||
| 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) |
Filter by client status(es) | ||
| types | array of enum | Filter by client type(s) |
Filter by client type(s) | ||
| 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") | ||
| defaultSortField | enum | Name InternalReference Team |
Name InternalReference Team | ||
| 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") | ||
| createdDate | string | When the filter was created |
When the filter was created | ||
| updatedDate | string | When the filter was last updated |
When the filter was last updated | ||
JSON Example
{
"code": "string",
"name": "string",
"description": "string",
"includeInMenu": false,
"managerCodes": [
"string"
]
}