Allocations
Allocation progress tracking for tasks and assigned resources.
externalpermissionstable4 procedures
query
allocations.getByIdInferred outputGet allocation by ID with progress info.
Input
{
id: string;
}Output
{
id: string;
resourceId: string | null;
organizationId: string;
taskId: string;
rootTaskId: string | null;
versionId: string;
taskHoursId: string | null;
name: string | null;
assignmentType: "unassigned" | "resource" | "resource_pool";
resourcePoolId: string | null;
slotId: string | null;
createdAt: Date;
updatedAt: Date | null;
deletedAt: Date | null;
trackId: string | null;
startDate: string;
endDate: string;
segments: Array<{
start: string;
end: string;
}> | null;
formula: string | null;
calculationType: "fixed" | "fixed_periodic" | "from_expenses" | "from_hours" | "from_allocations" | "sum_of_children_auto" | "formula";
hours: string | null;
hoursPerDay: string | null;
frequency: "one_time" | "daily" | "weekly" | "fortnightly" | "monthly" | "quarterly" | "yearly" | null;
percentage: string | null;
basePercentage: string | null;
rateId: string | null;
modifiers: unknown;
dependentTaskIds: Array<string> | null;
dependentAllocationIds: Array<string> | null;
calculatedHours: string | null;
billingRateId: string | null;
costRateId: string | null;
billingRateVersionId: string | null;
costRateVersionId: string | null;
projectBillingRateId: string | null;
projectCostRateId: string | null;
locked: boolean | null;
visible: boolean | null;
notes: string | null;
progressPercent: string | null;
startedAt: Date | null;
completedAt: Date | null;
} | nullmutation
allocations.updateProgressInferred outputUpdate allocation progress percentage.
Input
{
id: string;
progressPercent: number;
}Output
{
id: string;
resourceId: string | null;
organizationId: string;
taskId: string;
rootTaskId: string | null;
versionId: string;
taskHoursId: string | null;
name: string | null;
assignmentType: "unassigned" | "resource" | "resource_pool";
resourcePoolId: string | null;
slotId: string | null;
createdAt: Date;
updatedAt: Date | null;
deletedAt: Date | null;
trackId: string | null;
startDate: string;
endDate: string;
segments: Array<{
start: string;
end: string;
}> | null;
formula: string | null;
calculationType: "fixed" | "fixed_periodic" | "from_expenses" | "from_hours" | "from_allocations" | "sum_of_children_auto" | "formula";
hours: string | null;
hoursPerDay: string | null;
frequency: "one_time" | "daily" | "weekly" | "fortnightly" | "monthly" | "quarterly" | "yearly" | null;
percentage: string | null;
basePercentage: string | null;
rateId: string | null;
modifiers: unknown;
dependentTaskIds: Array<string> | null;
dependentAllocationIds: Array<string> | null;
calculatedHours: string | null;
billingRateId: string | null;
costRateId: string | null;
billingRateVersionId: string | null;
costRateVersionId: string | null;
projectBillingRateId: string | null;
projectCostRateId: string | null;
locked: boolean | null;
visible: boolean | null;
notes: string | null;
progressPercent: string | null;
startedAt: Date | null;
completedAt: Date | null;
} | nullmutation
allocations.markCompleteInferred outputMark allocation as complete.
Input
{
id: string;
}Output
{
id: string;
resourceId: string | null;
organizationId: string;
taskId: string;
rootTaskId: string | null;
versionId: string;
taskHoursId: string | null;
name: string | null;
assignmentType: "unassigned" | "resource" | "resource_pool";
resourcePoolId: string | null;
slotId: string | null;
createdAt: Date;
updatedAt: Date | null;
deletedAt: Date | null;
trackId: string | null;
startDate: string;
endDate: string;
segments: Array<{
start: string;
end: string;
}> | null;
formula: string | null;
calculationType: "fixed" | "fixed_periodic" | "from_expenses" | "from_hours" | "from_allocations" | "sum_of_children_auto" | "formula";
hours: string | null;
hoursPerDay: string | null;
frequency: "one_time" | "daily" | "weekly" | "fortnightly" | "monthly" | "quarterly" | "yearly" | null;
percentage: string | null;
basePercentage: string | null;
rateId: string | null;
modifiers: unknown;
dependentTaskIds: Array<string> | null;
dependentAllocationIds: Array<string> | null;
calculatedHours: string | null;
billingRateId: string | null;
costRateId: string | null;
billingRateVersionId: string | null;
costRateVersionId: string | null;
projectBillingRateId: string | null;
projectCostRateId: string | null;
locked: boolean | null;
visible: boolean | null;
notes: string | null;
progressPercent: string | null;
startedAt: Date | null;
completedAt: Date | null;
} | nullmutation
allocations.reopenInferred outputReopen a completed allocation.
Input
{
id: string;
}Output
{
id: string;
resourceId: string | null;
organizationId: string;
taskId: string;
rootTaskId: string | null;
versionId: string;
taskHoursId: string | null;
name: string | null;
assignmentType: "unassigned" | "resource" | "resource_pool";
resourcePoolId: string | null;
slotId: string | null;
createdAt: Date;
updatedAt: Date | null;
deletedAt: Date | null;
trackId: string | null;
startDate: string;
endDate: string;
segments: Array<{
start: string;
end: string;
}> | null;
formula: string | null;
calculationType: "fixed" | "fixed_periodic" | "from_expenses" | "from_hours" | "from_allocations" | "sum_of_children_auto" | "formula";
hours: string | null;
hoursPerDay: string | null;
frequency: "one_time" | "daily" | "weekly" | "fortnightly" | "monthly" | "quarterly" | "yearly" | null;
percentage: string | null;
basePercentage: string | null;
rateId: string | null;
modifiers: unknown;
dependentTaskIds: Array<string> | null;
dependentAllocationIds: Array<string> | null;
calculatedHours: string | null;
billingRateId: string | null;
costRateId: string | null;
billingRateVersionId: string | null;
costRateVersionId: string | null;
projectBillingRateId: string | null;
projectCostRateId: string | null;
locked: boolean | null;
visible: boolean | null;
notes: string | null;
progressPercent: string | null;
startedAt: Date | null;
completedAt: Date | null;
} | null