API v1 ReferenceRetainers

Endpoint to get a retainer for a project by id.

The user must have the ProjectMasterData read permission for the project to access this endpoint. <Check title="Required Permissions">Any authenticated user.</Check>

Path parameters

projectIdstringRequiredformat: "uuid"
The id of the project.
retainerIdstringRequiredformat: "uuid"
The id of the retainer.

Response

OK
timeBudgetinteger or null
The time budget per retainer period in seconds. The default budget amount for new budgets in this retainer.
timezonestring or null
The timezone for when new budgets are created.
rollOverUnderspentBudgetboolean or null
Whether underspent budgets should be rolled over to the next period.
rollOverOverspentBudgetboolean or null
Whether overspent budgets should be rolled over to the next period.
startDatestring or nullformat: "date-time"
The start of the retainer contract.
endDatestring or nullformat: "date-time"
The end of the retainer contract until new budgets will be created. Optional.
syncProjectDatesboolean or null
Whether the project start and due dates should be synced to the retainer start and end dates.
idstring or nullformat: "uuid"
The id of the retainer.
retainerPeriodstring or null
The period for new budgets in this retainer. Currently only 'monthly' is supported.
projectIdstring or nullformat: "uuid"
The project this retainer is associated with.
isExternalboolean or null
Whether the retainer belongs to an external project.
retainerBudgetslist of objects or null

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

createdOnstring or nullformat: "date-time"
The date this retainer was created.
createdBystring or nullformat: "uuid"
The id of the user who created this retainer.
updatedOnstring or nullformat: "date-time"
The date this retainer was last modified.
updatedBystring or nullformat: "uuid"
The id of the user who last modified this retainer.