API v1 ReferenceRetainers

Endpoint to get all retainers for a project.

The user must have the ProjectMasterData read permission for the project to access this endpoint.

Required Permissions
Any authenticated user.

Path parameters

projectIdUUIDRequired
The id of the project.

Headers

AuthorizationstringRequired

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

Query parameters

pageintegerOptionalDefaults to 1
Page number for pagination
pageSizeintegerOptionalDefaults to 10
Number of items per page
orderbystringOptional
The properties to order by
filterbystringOptional
The filter expression to filter by

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.
startDatedatetime or null
The start of the retainer contract.
endDatedatetime or null
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.
idUUID or null
The id of the retainer.
retainerPeriodstring or null
The period for new budgets in this retainer. Currently only 'monthly' is supported.
projectIdUUID or null
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.

createdOndatetime or null
The date this retainer was created.
createdByUUID or null
The id of the user who created this retainer.
updatedOndatetime or null
The date this retainer was last modified.
updatedByUUID or null
The id of the user who last modified this retainer.