Allocation object

A resource allocation for a member or placeholder.

Example

Allocation

{
  "id": "212b8272-ed2a-4a91-950a-8a06b3546144",
  "resourceTypeId": "placeholder",
  "assignmentTypeId": "project",
  "start": "2022-06-01",
  "end": "2022-08-31",
  "unit": "day",
  "hoursPerDay": 8,
  "hoursPerWeek": null,
  "hoursPerMonth": null,
  "totalHours": 528,
  "isBillable": true,
  "notes": "Resourcing the PM for Joe's Shop.",
  "readOnly": false,
  "entity": "allocation",
  "createdAt": "2022-03-02T17:40:03.633Z",
  "member": {
    "id": "ec5543de-3b0f-47a0-b8ef-a6e18dc4b885",
    "name": "John Smith"
  },  
  "placeholder": {
    "id": "e804cd57-8b98-437d-86f4-90e920a41774",
    "name": "Project Manager"
  },
  "project": {
    "id": "095e0780-48bf-472c-8deb-2fc3ebc7d90c",
    "name": "Vendor Portal",
    "client": {
      "id": "4cacdf11-71d1-4fbb-90ee-b091803581b0",
      "name": "Joe's Shop"
    }
  },
  "role": {
    "id": "7ad5a34a-07b7-48e9-a760-bd220d52e354",
    "name": "Project Manager"
  },
  "task": {
    "id": "9a7097a0-d71e-4ed2-9bc3-2dd7d797edc4",
    "name": "Project Status Reporting"
  },
  "timeOffType": {
    "id": "8fc28b3d-e179-4193-bbdd-09387be8a1e9",
    "name": "Holiday"
  }
}

Attributes

Name	Type	Description
id	uuid	The unique identifier for the object.
resourceTypeId	string	The resource type of the allocation. Can be either "member" (Member) or "placeholder" (Placeholder).
assignmentTypeId	string	The assignment type of the allocation. Can be either "project" (Project) or "time_off" (Time Off).
start	date	The start date of the allocation. Will be in the form YYYY-MM-DD.
end	date	The end date of the allocation. Will be in the form YYYY-MM-DD.
unit	string	The unit associated with the allocation, can either be "day" (Day), "week" (Week), or "month" (Month).
hoursPerDay	number	Total hours per day of the allocation. Only available if the unit is set to "day".
hoursPerWeek	number	Total hours per week of the allocation. Only available if the unit is set to "week".
hoursPerMonth	number	Total hours per week of the allocation. Only available if the unit is set to "month".
totalHours	number	A calculated field based off the start, end, and either hoursPerDay, hoursPerWeek, or hoursPerMonth, and the working capacity of the workspace member or the default capacity for the workspace when a placeholder.
isBillable	boolean	A flag to indicate if the allocation should be billable. This is calculated based on related objects and statuses.
readOnly	boolean	A flag to indicate if the allocation is read-only. Allocations with the entity property set to either time_entry or holiday are read-only.
entity	string	The entity type of the allocation. Can be allocation, time_entry or holiday.
notes	string	Any notes for the allocation.
createdAt	timestamp	The timestamp when the object was created.
member	object	A simple object to the related workspace member. Only available if the resourceTypeId is "member". See attributes.
placeholder	object	A simple object to the related resource placeholder. Only available if the resourceTypeId is "placeholder". See attributes.
project	object	A simple object to the related project. Only available if the assignmentTypeId is "project". See attributes.
role	object	A simple object to the related project role. Only available if the assignmentTypeId is "project" and the project set is using roles. See attributes.
task	object	A simple object to the related project task. Only available if the assignmentTypeId is "project" and the set project has tasks. See attributes.
timeOffType	object	A simple object to the related time-off type. Only available if the assignmentTypeId is "time_off". See attributes.

Member attributes

Name	Type	Description
id	uuid	The unique identifier for the object.
name	string	The name of the workspace member.

Placeholder attributes

Name	Type	Description
id	uuid	The unique identifier for the object.
name	string	The name of the resource placeholder.

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.

Role attributes

Name	Type	Description
id	uuid	The unique identifier for the object.
name	string	The name of the project role.

Task attributes

Name	Type	Description
id	uuid	The unique identifier for the object.
name	string	The name of the project task.

Time off type attributes

Name	Type	Description
id	uuid	The unique identifier for the object.
name	string	The name of the time-off type.