Budget

Get a budget

Returns the budget's visible phases, totals, lines, and editable phase data. Use path or accountId to select an account and its descendants. Use parentId to build the line tree.

get/projects/{projectId}/budget

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/projects/{projectId}/budget
  • Auth: HTTP bearer

Path parameters

projectIdstring required

Project ID or slug.

Query parameters

pathstring

Select this account path and its descendants, such as 1100/1110.

accountIdstring

Select this account number and its descendants. An account number used by multiple lines returns 409 account_code_ambiguous.

phasestring

Select a visible phase by ID, alias, name, or type. An ambiguous value returns 400 validation.

Headers

If-None-Matchstring

A previous ETag. Returns 304 Not Modified when the budget is unchanged.

Response

The budget document.

idstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

computedAtstring date-time required
totalsobject required

Totals keyed by visible phase ID.

Example response

{
  "id": "txn_8f2a1c9e",
  "phases": [
    {
      "id": "phs_estimate",
      "type": "estimate",
      "name": "Estimate",
      "alias": "EST",
      "color": "blue",
      "sort": 0,
      "isHidden": false
    }
  ],
  "lines": [
    {
      "id": "txn_8f2a1c9e",
      "parentId": "txn_8f2a1c9e"
    }
  ]
}

Changes

No recorded changes to this operation across all 4 revisions of this API.