Presupuesto

REST API — Todos los endpoints requieren autenticación mediante Bearer token. Incluye Authorization: Bearer {token} en cada solicitud. Los tokens se gestionan en Configuración de GitScrum → API. Base URL: https://services.gitscrum.com — Todas las rutas de solicitud en esta documentación son relativas a esta URL base.

Realiza seguimiento de presupuestos de proyectos con desgloses de consumo, gráficos de burn-down, alertas de umbrales y monitoreo de riesgos.

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

Todos los endpoints requieren el header Authorization: Bearer {token}.

Proyectos en riesgo

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

Devuelve los proyectos que están en riesgo de exceder su presupuesto en todo el workspace.

Respuesta

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

Resumen del presupuesto

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

Devuelve el resumen del presupuesto de un proyecto específico con filtros de fecha opcionales.

Parámetros de ruta

Parámetros de query

Respuesta

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

Consumo del presupuesto

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

Devuelve el desglose de consumo del presupuesto por categoría, miembro del equipo o período de tiempo.

Respuesta

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

Devuelve datos de burn-down para visualización del presupuesto.

Parámetros de query

Respuesta

{
  "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 presupuesto

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

Devuelve alertas de umbrales de presupuesto del proyecto.

Respuesta

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

Eventos de presupuesto

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

Devuelve el registro de eventos relacionados con el presupuesto.

Parámetros de query

Respuesta

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

Referencia de campos