Gestion des cycles de paiement

Lister les cycles

Récupère la liste des cycles de paiement avec filtres optionnels.

Endpoint

GET /api/paiements/cycles

Paramètres de requête

Paramètre	Type	Requis	Description
programme	UUID	Non	Filtrer par programme
statut	string	Non	Filtrer par statut
search	string	Non	Recherche textuelle

Exemple de requête

curl -X GET "https://api.pch-sig.org/api/paiements/cycles?statut=valide" \
  -H "Authorization: Bearer <token>"

Réponse

{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "code": "PCH-C001",
      "nom": "Cycle Janvier 2025",
      "numero": 1,
      "programme": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "nom": "Programme Capital Humain"
      },
      "dateDebut": "2025-01-01",
      "dateFin": "2025-01-31",
      "statut": "valide",
      "nbBeneficiairesPrevu": 3500,
      "nbBeneficiairesPaye": 3450,
      "montantTotalPrevu": 87500000,
      "montantTotalPaye": 86250000,
      "tauxExecution": 98.57
    }
  ]
}

---

Créer un cycle

Crée un nouveau cycle de paiement et génère automatiquement les paiements.

Endpoint

POST /api/paiements/cycles

Corps de la requête

{
  "programme_id": "550e8400-e29b-41d4-a716-446655440000",
  "periode_debut": "2025-02-01",
  "periode_fin": "2025-02-28"
}

Paramètres

Paramètre	Type	Requis	Description
programme_id	UUID	Oui	ID du programme
periode_debut	date	Oui	Date de début (YYYY-MM-DD)
periode_fin	date	Oui	Date de fin (YYYY-MM-DD)

Réponse

{
  "success": true,
  "data": {
    "cycle_id": "550e8400-e29b-41d4-a716-446655440002",
    "code": "PCH-C002",
    "paiements_generes": {
      "total": 3500,
      "montant_total": 87500000
    }
  }
}

Codes de réponse

Code	Description
200	Cycle créé avec succès
400	Données invalides
401	Non authentifié
403	Non autorisé (rôle insuffisant)
404	Programme non trouvé

---

Valider un cycle

Valide un cycle pour permettre son exécution.

Endpoint

POST /api/paiements/cycles/{id}/validate

Paramètres

Paramètre	Type	Requis	Description
id	UUID	Oui	ID du cycle (dans l'URL)

Exemple de requête

curl -X POST "https://api.pch-sig.org/api/paiements/cycles/550e8400-e29b-41d4-a716-446655440002/validate" \
  -H "Authorization: Bearer <token>"

Réponse

{
  "success": true,
  "data": {
    "statut": "valide"
  }
}

Erreurs possibles

Code	Message	Description
400	Cycle déjà validé ou en cours	Le cycle n'est pas en statut preparation
404	Cycle non trouvé	ID invalide