Sign in

v1

latestOpenAPI 3.1.02026-08-066984441.1 MB
retainers

Endpoint to update the retainer for a project.

The end date of the retainer can only be updated via the POST /setDates endpoint. The start date, the retainer period, and the timezone can not be updated. Delete the retainer and create a new one instead.

        The user needs to have the ProjectMasterData write permission for the project to access this endpoint.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

put/projects/{projectId}/retainers/{retainerId}

Path parameters

projectIdstring uuid required

The id of the project to update the retainer for.

retainerIdstring uuid required

The id of the retainer.

Headers

Authorizationstring required

Bearer authentication

Request body

timeBudgetinteger

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

timezonestring nullable

The timezone for when new budgets are created.

rollOverUnderspentBudgetboolean

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

rollOverOverspentBudgetboolean

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

startDatestring date-time

The start of the retainer contract.

endDatestring date-time nullable

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

syncProjectDatesboolean

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

Response

OK

timeBudgetinteger

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

timezonestring nullable

The timezone for when new budgets are created.

rollOverUnderspentBudgetboolean

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

rollOverOverspentBudgetboolean

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

startDatestring date-time

The start of the retainer contract.

endDatestring date-time nullable

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

syncProjectDatesboolean

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

idstring uuid

The id of the retainer.

retainerPeriodstring nullable

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

projectIdstring uuid

The project this retainer is associated with.

isExternalboolean

Whether the retainer belongs to an external project.

createdOnstring date-time

The date this retainer was created.

createdBystring uuid

The id of the user who created this retainer.

updatedOnstring date-time

The date this retainer was last modified.

updatedBystring uuid

The id of the user who last modified this retainer.