Budget

REST API — Tous les endpoints nécessitent une authentification par Bearer token. Incluez Authorization: Bearer {token} dans chaque requête. Les tokens sont gérés dans Paramètres GitScrum → API. Base URL: https://services.gitscrum.com — Tous les chemins de requête dans cette documentation sont relatifs à cette URL de base.

Suivez les budgets des projets avec des détails de consommation, graphiques de burn-down, alertes de seuil et surveillance des risques.

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

Tous les endpoints nécessitent l'en-tête Authorization: Bearer {token}.

Projets à risque

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

Retourne les projets à risque de dépassement de budget dans le workspace.

Réponse

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

Vue d'ensemble du budget

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

Retourne la vue d'ensemble du budget d'un projet spécifique avec des filtres de date optionnels.

Paramètres de chemin

Paramètres de requête

Réponse

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

Consommation du budget

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

Retourne la répartition de la consommation du budget par catégorie, membre de l'équipe ou période.

Réponse

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

Graphique de burn-down

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

Retourne les données de burn-down pour la visualisation du budget.

Paramètres de requête

Réponse

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

Alertes de budget

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

Retourne les alertes de seuil de budget pour le projet.

Réponse

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

Événements du budget

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

Retourne le journal des événements liés au budget.

Paramètres de requête

Réponse

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

Référence des champs