plnnrlydevelopers

Deze referentie is alleen in het Engels. Naar het Nederlandse REST API-overzicht

Diese Referenz gibt es nur auf Englisch. Zur deutschen REST-API-Übersicht

Cette référence existe uniquement en anglais. Aller à la présentation de l'API REST en français

Esta referencia solo está en inglés. Ir a la introducción de la API REST en español

Budget

Budget

A budget: a named pot of minutes on a project that tasks are filed under and time is logged against, optionally filed in an organisation-wide budget group.

View as Markdown
Summary view
BudgetList, 18 fields. What a list returns by default.
Detail view
Budget, 18 fields. The default for a single read and for every write.
Read with
api:read:budgetsandbudgets::read
Write with
api:write:budgetsandbudgets::create

Deleting one is permanent and takes its tasks with it; a budget with logged time cannot be deleted.

Used by

GETList budgets/budgetsBudgetList
POSTCreate a budget/budgetsBudget
GETRead a budget/budgets/{budget}Budget
PATCHUpdate a budget/budgets/{budget}Budget

Fields

Detail only
Only in the detail view.
Only with include
Only when you ask for it with include.
Server-assigned
Set by plnnrly, never by a request.
idinteger

Unique identifier.

project_idinteger

Owning project. Settable at create time only; a budget cannot be moved to another project.

budget_group_idinteger or null

Budget group this budget is filed under, null when ungrouped.

order_columnintegerServer-assigned

Position within the project as arranged in plnnrly. Set on create to the highest existing position plus one, and renumbered 1..n per project whenever the project's budget page is saved in plnnrly. Not writable.

descriptionstring≤ 255

Budget description as shown in the UI. This is the budget's label and the only field ?q= searches; a budget has no title.

start_datedate (YYYY-MM-DD) or null

First day the budget covers, null when it has no start.

end_datedate (YYYY-MM-DD) or null

Last day the budget covers, null when it has no end.

budgetinteger

Budgeted amount of work, in minutes.

spendableinteger

The portion of the budget that may be allocated to tasks, in minutes. A stored value, never decremented by logged time.

statusstring

Lifecycle status of the budget.

activeinactiveblocked

New values may be added.

Variants

BudgetList 18 fields

What a collection returns, and what ?view=summary returns on a single record.

The same fields as the detail object.

BudgetSummary 2 fields

The embedded form: what you get when another resource carries this one and you did not include it.

Leaves out: project_id, budget_group_id, order_column, start_date, end_date, budget, spendable, status, is_open, is_billable, created_at, updated_at, project, budget_group, tasks_count, links

BudgetLinks 2 fields

The links object on this resource.

Keys: self, tasks