API Docs / Schemas / UpdateTenantUserRequest

UpdateTenantUserRequest

DTO for Updating a user within a tenant. Does not include email as it cannot be changed.
FirstName/LastName are managed via User updates and synced to TenantUser automatically.

Properties

Name Type Description
roleTypeenum

System Custom

System Custom

roleCodestring

The code of the custom role (only used if RoleType is Custom)

The code of the custom role (only used if RoleType is Custom)

systemRoleTypeenum

Admin StandardUser Viewer

Admin StandardUser Viewer

isClientManagerboolean

Whether the user is a client manager within the tenant

Whether the user is a client manager within the tenant

isPartnerboolean

Whether the user is a partner within the tenant

Whether the user is a partner within the tenant

isAssociateboolean

Whether the user is an associate within the tenant

Whether the user is an associate within the tenant

isRestrictedToTeamClientsboolean

Whether the user can only see clients belonging to their teams

Whether the user can only see clients belonging to their teams

isRestrictedToAssignedClientsboolean

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

isRestrictedToOwnTimeboolean

Whether the user can only see and edit their own time entries

Whether the user can only see and edit their own time entries

isPaidForTrackedTimeboolean

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

workingPatternCodestring

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.

JSON Example

{
  "roleType": "System",
  "roleCode": "string",
  "systemRoleType": "Admin",
  "isClientManager": false,
  "isPartner": false
}

Used By Operations