API v1 ReferenceRetainers

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

projectIdUUIDRequired

The id of the project to create the retainer for.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
timeBudgetintegerOptional

The time budget per retainer period in seconds. The default budget amount for new budgets in this retainer.

timezonestring or nullOptional

The timezone for when new budgets are created.

rollOverUnderspentBudgetbooleanOptional

Whether underspent budgets should be rolled over to the next period.

rollOverOverspentBudgetbooleanOptional

Whether overspent budgets should be rolled over to the next period.

startDatedatetimeOptional

The start of the retainer contract.

endDatedatetime or nullOptional

The end of the retainer contract until new budgets will be created. Optional.

syncProjectDatesbooleanOptional

Whether the project start and due dates should be synced to the retainer start and end dates.

Response

OK

timeBudgetintegerOptional

The time budget per retainer period in seconds. The default budget amount for new budgets in this retainer.

timezonestring or nullOptional

The timezone for when new budgets are created.

rollOverUnderspentBudgetbooleanOptional

Whether underspent budgets should be rolled over to the next period.

rollOverOverspentBudgetbooleanOptional

Whether overspent budgets should be rolled over to the next period.

startDatedatetimeOptional

The start of the retainer contract.

endDatedatetime or nullOptional

The end of the retainer contract until new budgets will be created. Optional.

syncProjectDatesbooleanOptional

Whether the project start and due dates should be synced to the retainer start and end dates.

idUUIDOptional

The id of the retainer.

retainerPeriodstring or nullOptional

The period for new budgets in this retainer. Currently only ‘monthly’ is supported.

projectIdUUIDOptional

The project this retainer is associated with.

isExternalbooleanOptional

Whether the retainer belongs to an external project.

retainerBudgetslist of objectsOptional

The budgets for this retainer. Each budget period (month) gets its own budget.

createdOndatetimeOptional

The date this retainer was created.

createdByUUIDOptional

The id of the user who created this retainer.

updatedOndatetimeOptional

The date this retainer was last modified.

updatedByUUIDOptional

The id of the user who last modified this retainer.