API Docs / Schemas / CsvExportFilterDto

CsvExportFilterDto

Filter criteria for selecting which clients to export.
Matches the same filters available on the client list endpoint.

Properties

Name Type Description
managerCodesarray of string

Filter clients by their assigned manager's code(s).

Filter clients by their assigned manager's code(s).

partnerCodesarray of string

Filter clients by their assigned partner's code(s).

Filter clients by their assigned partner's code(s).

associateCodesarray of string

Filter clients by their assigned associate's code(s).

Filter clients by their assigned associate's code(s).

statusesarray of enum

Filter clients by status(es).
Values: Active, Inactive, Prospect, LostProspect

Active Inactive Prospect LostProspect

Filter clients by status(es).
Values: Active, Inactive, Prospect, LostProspect

Active Inactive Prospect LostProspect

typesarray of enum

Filter clients by their organization type(s).
Values: Individual, Partnership, LLP, PrivateLimitedCompany, PublicLimitedCompany, Charity, Club, Trust, PublicSectorBody, OverseasCompany

PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader

Filter clients by their organization type(s).
Values: Individual, Partnership, LLP, PrivateLimitedCompany, PublicLimitedCompany, Charity, Club, Trust, PublicSectorBody, OverseasCompany

PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader

serviceCodesarray of string

Filter clients by billable service code(s) they have assigned.

Filter clients by billable service code(s) they have assigned.

searchstring

Search across client code, name and internal reference.
Minimum 3 characters.

Search across client code, name and internal reference.
Minimum 3 characters.

JSON Example

{
  "managerCodes": [
    "string"
  ],
  "partnerCodes": [
    "string"
  ],
  "associateCodes": [
    "string"
  ],
  "statuses": [
    "Active"
  ],
  "types": [
    "PrivateLimitedCompany"
  ]
}

Contained in Schemas