Budget

REST API — All endpoints require authentication via Bearer token. Include Authorization: Bearer {token} in every request. Tokens are managed in GitScrum Settings → API. Base URL: https://services.gitscrum.com — All request paths in this documentation are relative to this base URL.

Track project budgets with consumption breakdowns, burn-down charts, threshold alerts, and risk monitoring.

Projects at risk

GET /budget/projects-at-risk?company_slug={slug}

Returns projects that are at risk of exceeding their budget across the workspace.

Response

{
  "data": [
    {
      "project_uuid": "proj-abc-123",
      "name": "Web App Redesign",
      "total_budget": 50000,
      "consumed": 47500,
      "remaining": 2500,
      "percentage": 95,
      "burn_rate": 1200,
      "estimated_completion": "2026-02-15",
      "at_risk": true
    }
  ]
}

Budget overview

GET /projects/{project_uuid}/budget/overview?company_slug={slug}

Returns budget overview for a specific project with optional date filters.

Path parameters

Query parameters

Response

{
  "data": {
    "project_uuid": "proj-abc-123",
    "total_budget": 50000,
    "consumed": 32000,
    "remaining": 18000,
    "percentage": 64,
    "burn_rate": 850,
    "estimated_completion": "2026-03-10"
  }
}

Budget consumption

GET /projects/{project_uuid}/budget/consumption?company_slug={slug}

Returns budget consumption breakdown by category, team member, or time period.

Response

{
  "data": {
    "total_budget": 50000,
    "consumed": 32000,
    "remaining": 18000,
    "percentage": 64,
    "by_member": [],
    "by_period": []
  }
}

Burn-down chart

GET /projects/{project_uuid}/budget/burn-down?company_slug={slug}

Returns burn-down data for budget visualization.

Query parameters

Response

{
  "data": {
    "ideal": [
      { "date": "2026-01-01", "value": 50000 },
      { "date": "2026-01-15", "value": 37500 }
    ],
    "actual": [
      { "date": "2026-01-01", "value": 50000 },
      { "date": "2026-01-15", "value": 38200 }
    ]
  }
}

Budget alerts

GET /projects/{project_uuid}/budget/alerts?company_slug={slug}

Returns budget threshold alerts for the project.

Response

{
  "data": [
    {
      "type": "threshold",
      "severity": "warning",
      "message": "Budget consumption reached 90%",
      "percentage": 90,
      "created_at": "2026-02-05T10:00:00Z"
    }
  ]
}

Budget events

GET /projects/{project_uuid}/budget/events?company_slug={slug}

Returns the budget-related events log.

Query parameters

Response

{
  "data": [
    {
      "event": "budget_updated",
      "description": "Budget increased from $40,000 to $50,000",
      "user": "johndoe",
      "created_at": "2026-02-01T08:00:00Z"
    }
  ]
}

Field reference