Contexte
EN TANT QU’ Agent
JE PEUX disposer d’une documentation d’API sur le module « dossiersFinanciersExternes »
AFIN DE mettre à jour le statut d’un dossier financier externe (CREE ou EN_ERREUR)
Routes
L’accès au module des dossiers Financiers Externes permet d’accéder aux routes ci dessous :
| Action | Méthode | Path | Schéma du body de la requête | Schéma du body de la réponse |
|---|---|---|---|---|
| Mise à jour du statut du dossier | POST |
/api/tenants/{tenantId}/dossiers-financiers-externes/mettre-a-jour-statut-dossier
|
UpdateStatusDossierFInancierExterneType |
Droits
Le groupe du User utilisé devra avoir le rôle dossiersFinanciersExternes.
Types des objets
Requêtes
Mise à jour du statut du dossier
Le body d’une route de création ou de modification respectera le schéma UpdateStatusDossierFinancierExterneType :
| Nom | Type | Contenu | Obligatoire | Exemple |
|---|---|---|---|---|
|
typeGestionFinanciere
|
string | Type de la Gestion Financière | X | Enumeration parmi :
« grand-angle »
« astre »
« coriolis4 »
« coriolis5 »
« esedit-filien »
|
|
codeCollectivite
|
string | Code de la collectivité | X | 01 |
|
codeBudget
|
string | Code du budget | X | 01 |
|
referenceGestionFinanciere
|
string | Référence du dossier financier externe de la Gestion Financière | X | ReferenceDossierFinancier Externe |
| status | string | Statut du dossier financier externe |
Enumeration parmi : « CREE »
« EN_ERREUR »
|
|
|
detailStatus
|
string | Détail du statut lorsqu’il est en erreur |
Exemple :
{
"typeGestionFinanciere": "generique",
"codeCollectivite": "01",
"codeBudget": "01",
"referenceGestionFinanciere": "ReferenceDossierFinancierExterne",
"status": "EN_ERREUR",
"detailStatus": "Détail de l'erreur pour le statut"
}