Orçamento

REST API — Todos os endpoints requerem autenticação via Bearer token. Inclua Authorization: Bearer {token} em cada requisição. Os tokens são gerenciados em Configurações do GitScrum → API. Base URL: https://services.gitscrum.com — Todos os caminhos de requisição nesta documentação são relativos a esta URL base.

Acompanhe orçamentos de projetos com detalhamento de consumo, gráficos de burn-down, alertas de limites e monitoramento de riscos.

URL Base: https://services.gitscrum.com

Todos os endpoints requerem o header Authorization: Bearer {token}.

Projetos em risco

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

Retorna projetos que estão em risco de exceder seu orçamento no workspace.

Resposta

{
  "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
    }
  ]
}

Visão geral do orçamento

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

Retorna a visão geral do orçamento de um projeto específico com filtros de data opcionais.

Parâmetros de caminho

Parâmetros de query

Resposta

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

Consumo do orçamento

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

Retorna o detalhamento de consumo do orçamento por categoria, membro da equipe ou período.

Resposta

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

Gráfico de burn-down

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

Retorna dados de burn-down para visualização do orçamento.

Parâmetros de query

Resposta

{
  "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 }
    ]
  }
}

Alertas de orçamento

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

Retorna alertas de limites de orçamento do projeto.

Resposta

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

Eventos do orçamento

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

Retorna o log de eventos relacionados ao orçamento.

Parâmetros de query

Resposta

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

Referência de campos