CreateTenantUserRequest

DTO for creating a user within a tenant. Inherits update fields and adds email/name for creation.

Properties

Name	Type	Description
roleType	enum	System Custom
System Custom
roleCode	string	The code of the custom role (only used if RoleType is Custom)
The code of the custom role (only used if RoleType is Custom)
systemRoleType	enum	Admin StandardUser Viewer
Admin StandardUser Viewer
isClientManager	boolean	Whether the user is a client manager within the tenant
Whether the user is a client manager within the tenant
isPartner	boolean	Whether the user is a partner within the tenant
Whether the user is a partner within the tenant
isAssociate	boolean	Whether the user is an associate within the tenant
Whether the user is an associate within the tenant
isRestrictedToTeamClients	boolean	Whether the user can only see clients belonging to their teams
Whether the user can only see clients belonging to their teams
isRestrictedToAssignedClients	boolean	Whether the user can only see clients where they are Manager, Partner, or Associate
Whether the user can only see clients where they are Manager, Partner, or Associate
isRestrictedToOwnTime	boolean	Whether the user can only see and edit their own time entries
Whether the user can only see and edit their own time entries
isPaidForTrackedTime	boolean	Whether the practice pays this user for their tracked time (contract basis) — puts them on the Unpaid Time pay surfaces
Whether the practice pays this user for their tracked time (contract basis) — puts them on the Unpaid Time pay surfaces
workingPatternCode	string	The code of the working pattern this user is on — how many hours they're expected to log each day. Null puts them on the practice's default pattern.
The code of the working pattern this user is on — how many hours they're expected to log each day. Null puts them on the practice's default pattern.
email*	string
firstName	string	The user's first name (required for creating new users)
The user's first name (required for creating new users)
lastName	string	The user's last name (required for creating new users)
The user's last name (required for creating new users)
teamCodes	array of string	Optional list of team codes to assign the user to on creation
Optional list of team codes to assign the user to on creation
hourlyRate	number	Charge-out rate per hour, seeding the user's first rate entry. Null gives the user no rate of their own, so the practice default applies. After creation, rates are managed via the user's rates endpoints.
Charge-out rate per hour, seeding the user's first rate entry. Null gives the user no rate of their own, so the practice default applies. After creation, rates are managed via the user's rates endpoints.
costRate	number	Internal cost rate per hour, seeding the user's first rate entry. Requires the Cost Rates permission.
Internal cost rate per hour, seeding the user's first rate entry. Requires the Cost Rates permission.

JSON Example

{
  "roleType": "System",
  "roleCode": "string",
  "systemRoleType": "Admin",
  "isClientManager": false,
  "isPartner": false,
  "email": "user@example.com"
}

Used By Operations

POST Create TenantUser
/tenants/{tenant}/users