Client Roles

Create a standalone client role

Create a standalone client role with custom billing terms. To create a client role linked to a workspace role, use POST /client-roles/link instead.

post/client-roles

Request

  • Base URL: https://www.ruddr.io/api/workspace
  • URL: https://www.ruddr.io/api/workspace/client-roles
  • Auth: HTTP bearer

Request body

clientIdstring required

The uuid of the client this role belongs to.

namestring required

The name of the client role. Maximum 255 characters.

currencystring nullable

The three-letter ISO currency code for the role. Maximum 3 characters. Defaults to the client's currency if not provided.

isBillableboolean

Whether the role is billable. Defaults to true if not provided.

ratenumber nullable

The billing rate for the role.

disciplineIdstring nullable

The uuid of the discipline for this role.

practiceIdstring nullable

The uuid of the practice for this role.

locationIdstring nullable

The uuid of the location for this role.

Response

200

idstring

The unique identifier for the object.

namestring

The name of the client role. Reflects the workspace role's name when linked.

isBillableboolean

Whether the role is billable. Reflects the workspace role's value when linked.

ratenumber nullable

The billing rate for the role. null when the role is non-billable. Reflects the workspace role's value when linked.

currencystring nullable

The three-letter ISO currency code for the role. null when the role is non-billable. Reflects the workspace role's value when linked.

createdAtstring date-time

The timestamp when the object was created.

Changes

No recorded changes to this operation across all 1 revision of this API.