Endpoint to create a new retainer for a project.
As soon as a retainer is created for a project, the project will be marked as a retainer project. Based on the Start and End dates of the retainer, the retainer budgets will be created automatically. Retainers cannot overlap. There can only be one active retainer per project at a time (no end date and/or including the current date).
The user needs to have the ProjectMasterData write permission for the project to access this endpoint.
Required Permissions
Any authenticated user.Path parameters
projectId
The id of the project to create the retainer for.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
timeBudget
The time budget per retainer period in seconds. The default budget amount for new budgets in this retainer.
timezone
The timezone for when new budgets are created.
rollOverUnderspentBudget
Whether underspent budgets should be rolled over to the next period.
rollOverOverspentBudget
Whether overspent budgets should be rolled over to the next period.
startDate
The start of the retainer contract.
endDate
The end of the retainer contract until new budgets will be created. Optional.
syncProjectDates
Whether the project start and due dates should be synced to the retainer start and end dates.
Response
OK
timeBudget
The time budget per retainer period in seconds. The default budget amount for new budgets in this retainer.
timezone
The timezone for when new budgets are created.
rollOverUnderspentBudget
Whether underspent budgets should be rolled over to the next period.
rollOverOverspentBudget
Whether overspent budgets should be rolled over to the next period.
startDate
The start of the retainer contract.
endDate
The end of the retainer contract until new budgets will be created. Optional.
syncProjectDates
Whether the project start and due dates should be synced to the retainer start and end dates.
id
The id of the retainer.
retainerPeriod
The period for new budgets in this retainer.
Currently only 'monthly' is supported.
projectId
The project this retainer is associated with.
isExternal
Whether the retainer belongs to an external project.
retainerBudgets
The budgets for this retainer. Each budget period (month) gets its own budget.
createdOn
The date this retainer was created.
createdBy
The id of the user who created this retainer.
updatedOn
The date this retainer was last modified.
updatedBy
The id of the user who last modified this retainer.