Example

{
  "id": "7ad5a34a-07b7-48e9-a760-bd220d52e354",
  "name": "Project Manager",
  "isActive": true,
  "isBillable": true,
  "rate": 125,
  "createdAt": "2022-03-15T15:00:08.626Z",
  "project": {
    "id": "095e0780-48bf-472c-8deb-2fc3ebc7d90c",
    "name": "Vendor Portal",
    "client": {
      "id": "4cacdf11-71d1-4fbb-90ee-b091803581b0",
      "name": "Joe's Shop"
    }
  },
  "discipline": {
    "id": "14aa2bab-ea87-4ca3-9d5b-08aade12376e",
    "name": "Project Management"
  },
  "budget": {
    "billableHours": 150,
    "nonBillableHours": 10
  },
  "monthlyBudget": {
    "billableHours": 30,
    "nonBillableHours": 2
  }
}

Attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the project role.
`isActive`	`boolean`	Flag indicating if the role is still active on the project.
`isBillable`	`boolean`	Flag to indicate if this is a billable role or not.
`rate`	`number`	The rate of the project role. Will only be available for billable projects and roles.
`createdAt`	`timestamp`	The timestamp when the object was created.
`project`	`object`	A simple object to the related project. See attributes.
`discipline`	`object`	A simple object to the related discipline. See attributes.
`budget`	`object`	The role's budget for the project. Only available if the project is using a budget and the budget mode is either `"detailed"` or `"aggregated"`. See attributes.
`monthlyBudget`	`object`	The role's monthly budget for the project. Only available if the project is using a monthly budget and the monthly budget mode is `"detailed"`. See attributes.

Project attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the project.
`client`	`object`	A simple object to the related client. See attributes.

Client attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the client.

Discipline attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the discipline.

Budget attributes

Name	Type	Description
`billableHours`	`number`	The number of billable hours for the role's budget. Only set if the project is flagged as billable.
`nonBillableHours`	`number`	The number of non-billable hours for the role's budget.