{ "openapi": "3.0.0", "info": { "title": "API Phil\u00e9as Gestion - Notes de frais", "description": "### \u00c0 propos\nL\u2019API **\"Phil\u00e9as Gestion \u2013 Notes de frais\"** centralise la gestion des utilisateurs,\ndes collaborateurs, et des entit\u00e9s juridiques\n\n#### Fonctionnalit\u00e9s principales\n- Administration des **droits et habilitations** via OAuth2\n- Gestion des **collaborateurs** _(donn\u00e9es administratives et analytiques)_\n- Gestion des **soci\u00e9t\u00e9s**, **\u00e9tablissements** et **r\u00e9f\u00e9rentiels**\n- Int\u00e9gration fluide avec les syst\u00e8mes tiers _(RH, comptabilit\u00e9, analytique)_\n", "version": "1.1.68+20260724T152041Z" }, "paths": { "/v1/collaborateurs": { "get": { "tags": [ "Collaborateurs" ], "summary": "Liste des collaborateurs", "operationId": "get_henrietta_v1_collaborateurscollection", "responses": { "200": { "description": "Liste des collaborateurs", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CollaborateurLectureDto" } } } } } }, "security": [ { "OAuth2": [ "collaborateur.lire" ] } ] }, "post": { "tags": [ "Collaborateurs" ], "summary": "Cr\u00e9ation d'un collaborateur", "operationId": "post_henrietta_v1_collaborateurscreation", "requestBody": { "description": "D\u00e9tail du collaborateur", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborateurEcritureDto" } } } }, "responses": { "201": { "description": "Collaborateur cr\u00e9\u00e9 avec succ\u00e8s", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborateurLectureDto" } } } } }, "security": [ { "OAuth2": [ "collaborateur.ecrire" ] } ] } }, "/v1/collaborateurs/{uid}": { "get": { "tags": [ "Collaborateurs" ], "summary": "D\u00e9tail d'un collaborateur", "operationId": "get_henrietta_v1_collaborateursdetail", "parameters": [ { "name": "uid", "in": "path", "description": "UID du collaborateur", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "D\u00e9tail d'un collaborateur", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborateurLectureDto" } } } } }, "security": [ { "OAuth2": [ "collaborateur.lire" ] } ] }, "put": { "tags": [ "Collaborateurs" ], "summary": "Modification d'un collaborateur", "operationId": "put_henrietta_v1_collaborateursmodification", "parameters": [ { "name": "uid", "in": "path", "description": "UID du collaborateur", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "D\u00e9tail du collaborateur", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborateurEcritureDto" } } } }, "responses": { "200": { "description": "Collaborateur modifi\u00e9 avec succ\u00e8s", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborateurLectureDto" } } } } }, "security": [ { "OAuth2": [ "collaborateur.ecrire" ] } ] } }, "/v1/collaborateurs/{uid}/donnees-bancaires": { "get": { "tags": [ "Collaborateurs" ], "summary": "Donn\u00e9es bancaires d'un collaborateur", "operationId": "get_henrietta_v1_collaborateursdetail-donnees-bancaires", "parameters": [ { "name": "uid", "in": "path", "description": "UID du collaborateur", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Donn\u00e9es bancaires d'un collaborateur", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborateurDonneesBancairesLectureDto" } } } } }, "security": [ { "OAuth2": [ "collaborateur-donneeBancaire.lire" ] } ] }, "put": { "tags": [ "Collaborateurs" ], "summary": "Modification des donn\u00e9es bancaires d'un collaborateur", "operationId": "put_henrietta_v1_collaborateursmodification-donnees-bancaires", "parameters": [ { "name": "uid", "in": "path", "description": "UID du collaborateur", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "D\u00e9tail des donn\u00e9es bancaires du collaborateur", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborateurDonneesBancairesEcritureDto" } } } }, "responses": { "200": { "description": "Donn\u00e9es bancaires du collaborateur modifi\u00e9es avec succ\u00e8s", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborateurDonneesBancairesLectureDto" } } } } }, "security": [ { "OAuth2": [ "collaborateur-donneeBancaire.ecrire" ] } ] } }, "/v1/collaborateurs/{uid}/groupes-valideurs": { "get": { "tags": [ "Collaborateurs" ], "summary": "Liste des groupes de valideurs d\u00e9sign\u00e9s sur un collaborateur", "operationId": "get_henrietta_v1_collaborateursgroupes_valideurs", "parameters": [ { "name": "uid", "in": "path", "description": "UID du collaborateur", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Liste des groupes de valideurs d\u00e9sign\u00e9s sur un collaborateur", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupeValideursDto" } } } } } }, "security": [ { "OAuth2": [ "collaborateur.lire" ] } ] } }, "/v1/collaborateurs/{uid}/donnees-complementaires": { "get": { "tags": [ "Collaborateurs" ], "summary": "Liste des donn\u00e9es compl\u00e9mentaires d'un collaborateur", "operationId": "get_henrietta_v1_collaborateur_donnee_complementaire_collection", "parameters": [ { "name": "uid", "in": "path", "description": "UID du collaborateur", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Liste des donn\u00e9es compl\u00e9mentaires d'un collaborateur", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DonneeComplementaireLectureDto" } } } } } }, "security": [ { "OAuth2": [ "collaborateur.lire" ] } ] } }, "/v1/collaborateurs/{uid}/donnees-complementaires/{cle}": { "get": { "tags": [ "Collaborateurs" ], "summary": "D\u00e9tail d'une donn\u00e9e compl\u00e9mentaire d'un collaborateur", "operationId": "get_henrietta_v1_collaborateur_donnee_complementaire_detail", "parameters": [ { "name": "uid", "in": "path", "description": "UID du collaborateur", "required": true, "schema": { "type": "string" } }, { "name": "cle", "in": "path", "description": "Cl\u00e9 permettant d'identifier le type de donn\u00e9e compl\u00e9mentaire", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "D\u00e9tail d'une donn\u00e9e compl\u00e9mentaire d'un collaborateur", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DonneeComplementaireLectureDto" } } } } }, "security": [ { "OAuth2": [ "collaborateur.lire" ] } ] }, "put": { "tags": [ "Collaborateurs" ], "summary": "Cr\u00e9ation / mise \u00e0 jour d'une donn\u00e9e compl\u00e9mentaire d'un collaborateur", "description": "Supprime et remplace une donn\u00e9e compl\u00e9mentaire pour un collaborateur", "operationId": "put_henrietta_v1_collaborateur_donnee_complementaire_remplace", "parameters": [ { "name": "uid", "in": "path", "description": "UID du collaborateur", "required": true, "schema": { "type": "string" } }, { "name": "cle", "in": "path", "description": "Cl\u00e9 permettant d'identifier le type de donn\u00e9e compl\u00e9mentaire", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Nouvelle valeur de la donn\u00e9e compl\u00e9mentaire du collaborateur", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DonneeComplementaireEcritureDto" } } } }, "responses": { "201": { "description": "Donn\u00e9e compl\u00e9mentaire cr\u00e9\u00e9e avec succ\u00e8s", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DonneeComplementaireLectureDto" } } } }, "200": { "description": "Donn\u00e9e compl\u00e9mentaire mise \u00e0 jour avec succ\u00e8s", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DonneeComplementaireLectureDto" } } } } }, "security": [ { "OAuth2": [ "collaborateur.ecrire" ] } ] }, "delete": { "tags": [ "Collaborateurs" ], "summary": "Suppression d'une donn\u00e9e compl\u00e9mentaire d'un collaborateur", "operationId": "delete_henrietta_v1_collaborateur_donnee_complementaire_suppression", "parameters": [ { "name": "uid", "in": "path", "description": "UID du collaborateur", "required": true, "schema": { "type": "string" } }, { "name": "cle", "in": "path", "description": "Cl\u00e9 permettant d'identifier le type de donn\u00e9e compl\u00e9mentaire", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Donn\u00e9e compl\u00e9mentaire supprim\u00e9e avec succ\u00e8s" }, "404": { "description": "Donn\u00e9e compl\u00e9mentaire non trouv\u00e9e" } }, "security": [ { "OAuth2": [ "collaborateur.ecrire" ] } ] } }, "/v1/collaborateurs/{uid}/mandat-periodes": { "get": { "tags": [ "Collaborateurs" ], "summary": "Liste des p\u00e9riodes de mandat d'un collaborateur", "operationId": "get_henrietta_v1_collaborateur_mandat_periode_collection", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Liste des p\u00e9riodes de mandat d'un collaborateur", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MandatPeriodeDto" } } } } } }, "security": [ { "OAuth2": [ "collaborateur.lire" ] } ] }, "put": { "tags": [ "Collaborateurs" ], "summary": "Mise \u00e0 jour des p\u00e9riodes de mandat d'un collaborateur", "description": "Supprime et remplace les anciennes p\u00e9riodes de mandat", "operationId": "put_henrietta_v1_collaborateur_mandat_periode_remplace", "parameters": [ { "name": "uid", "in": "path", "description": "UID du collaborateur", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Nouvelles p\u00e9riodes de mandat du collaborateur", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MandatPeriodeDto" } } } } }, "responses": { "200": { "description": "P\u00e9riodes de mandat du collaborateur mises \u00e0 jour avec succ\u00e8s", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MandatPeriodeDto" } } } } } }, "security": [ { "OAuth2": [ "collaborateur.ecrire" ] } ] } }, "/v1/collaborateurs/{uid}/repartitions-analytiques": { "get": { "tags": [ "Collaborateurs" ], "summary": "R\u00e9partition analytique d'un collaborateur", "operationId": "get_henrietta_v1_collaborateur_repartition_analytique_collection", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "R\u00e9partition analytique d'un collaborateur", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RepartitionAnalytiqueDto" } } } } } }, "security": [ { "OAuth2": [ "collaborateur.lire" ] } ] }, "put": { "tags": [ "Collaborateurs" ], "summary": "Mise \u00e0 jour des r\u00e9partitions analytiques d'un collaborateur", "description": "Supprime et remplace les anciennes valeurs de r\u00e9partition. (Les nouvelles valeurs ne sont effectives qu'au lendemain de la date de mise \u00e0 jour)", "operationId": "put_henrietta_v1_collaborateur_repartition_analytique_remplace", "parameters": [ { "name": "uid", "in": "path", "description": "UID du collaborateur", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Nouvelle r\u00e9partition analytique du collaborateur", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RepartitionAnalytiqueDto" } } } } }, "responses": { "200": { "description": "R\u00e9partitions analytiques du collaborateur mises \u00e0 jour avec succ\u00e8s", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RepartitionAnalytiqueDto" } } } } } }, "security": [ { "OAuth2": [ "collaborateur.ecrire" ] } ] } }, "/v1/groupes-utilisateurs/{code}/est-valideur-de": { "get": { "tags": [ "Groupes d'utilisateurs" ], "summary": "Liste des collaborateurs sur lesquels le groupe est habilit\u00e9 comme valideur (pour la fonction de validation port\u00e9e par le groupe)", "description": "La fonction de validation est d\u00e9finie par la sous-cat\u00e9gorie du groupe de validation.", "operationId": "get_henrietta_v1_groupe_valideurs_collaborateurs_collection", "parameters": [ { "name": "code", "in": "path", "description": "Code du groupe d'utilisateurs", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Liste des collaborateurs dont le groupe est valideur", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CollaborateurLectureDto" } } } } } }, "security": [ { "OAuth2": [ "habilitation.lire" ] } ] }, "put": { "tags": [ "Groupes d'utilisateurs" ], "summary": "Mise \u00e0 jour des collaborateurs sur lesquelles le groupe de valideurs est habilit\u00e9", "description": "Habilite le groupe de valideurs sur la nouvelle liste de collaborateurs. La fonction de validation est d\u00e9finie par la sous-cat\u00e9gorie du groupe. (Un collaborateur ne peut avoir qu'un seul groupe de valideurs d\u00e9sign\u00e9 pour une fonction de validation donn\u00e9e. La mise \u00e0 jour de la d\u00e9signation du groupe de valideurs sur un collaborateur pour une fonction donn\u00e9e \u00e9crase la pr\u00e9c\u00e9dente)", "operationId": "put_henrietta_v1_groupe_valideurs_collaborateurs_remplace", "parameters": [ { "name": "code", "in": "path", "description": "Code du groupe d'utilisateurs", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Liste des nouveaux collaborateurs sur lesquels le groupe de valideurs est habilit\u00e9", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CollaborateurMajHabilitationsGroupeValideursDto" } } } } }, "responses": { "200": { "description": "Habilitations du groupe de valideurs mises \u00e0 jour avec succ\u00e8s", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CollaborateurLectureDto" } } } } } }, "security": [ { "OAuth2": [ "habilitation.ecrire" ] } ] } }, "/v1/groupes-utilisateurs": { "get": { "tags": [ "Groupes d'utilisateurs" ], "summary": "Liste des groupes d'utilisateurs", "operationId": "get_henrietta_v1_groupe_utilisateurs_collection", "parameters": [ { "name": "categorie", "in": "query", "description": "Permet d'appliquer un filtre de type '\u00e9gale' sur la cat\u00e9gorie des groupes", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Liste des groupes d'utilisateurs", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupeUtilisateursDto" } } } } } }, "security": [ { "OAuth2": [ "habilitation.lire" ] } ] }, "post": { "tags": [ "Groupes d'utilisateurs" ], "summary": "Cr\u00e9ation d'un groupe d'utilisateurs", "operationId": "post_henrietta_v1_groupe_utilisateurs_creation", "requestBody": { "description": "D\u00e9tail du groupe d'utilisateurs", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupeUtilisateursDto" } } } }, "responses": { "201": { "description": "Groupe d'utilisateurs cr\u00e9\u00e9 avec succ\u00e8s", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupeUtilisateursDto" } } } } }, "security": [ { "OAuth2": [ "habilitation.ecrire" ] } ] } }, "/v1/groupes-utilisateurs/{code}": { "get": { "tags": [ "Groupes d'utilisateurs" ], "summary": "D\u00e9tail d'un groupe d'utilisateurs", "operationId": "get_henrietta_v1_groupe_utilisateurs_detail", "parameters": [ { "name": "code", "in": "path", "description": "Code du groupe d'utilisateurs", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "D\u00e9tail d'un groupe d'utilisateurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupeUtilisateursDto" } } } } }, "security": [ { "OAuth2": [ "habilitation.lire" ] } ] }, "put": { "tags": [ "Groupes d'utilisateurs" ], "summary": "Modification d'un groupe d'utilisateurs", "operationId": "put_henrietta_v1_groupe_utilisateurs_modification", "parameters": [ { "name": "code", "in": "path", "description": "Code du groupe d'utilisateurs", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "D\u00e9tail du groupe d'utilisateurs", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupeUtilisateursDto2" } } } }, "responses": { "200": { "description": "Groupe d'utilisateurs modifi\u00e9 avec succ\u00e8s", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupeUtilisateursDto" } } } } }, "security": [ { "OAuth2": [ "habilitation.ecrire" ] } ] }, "delete": { "tags": [ "Groupes d'utilisateurs" ], "summary": "Suppression d'un groupe d'utilisateurs", "operationId": "delete_henrietta_v1_groupe_utilisateurs_suppression", "parameters": [ { "name": "code", "in": "path", "description": "Code du groupe d'utilisateurs", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Groupe d'utilisateurs supprim\u00e9 avec succ\u00e8s" }, "404": { "description": "Groupe d'utilisateurs non trouv\u00e9" } }, "security": [ { "OAuth2": [ "habilitation.ecrire" ] } ] } }, "/v1/groupes-utilisateurs/{code}/membres": { "get": { "tags": [ "Groupes d'utilisateurs" ], "summary": "Liste des membres du groupe d'utilisateurs", "operationId": "get_henrietta_v1_groupe_utilisateurs_membre_collection", "parameters": [ { "name": "code", "in": "path", "description": "Code du groupe d'utilisateurs", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Liste des membres du groupe d'utilisateurs", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UtilisateurLectureDto" } } } } } }, "security": [ { "OAuth2": [ "habilitation.lire" ] } ] }, "put": { "tags": [ "Groupes d'utilisateurs" ], "summary": "Mise \u00e0 jour des membres d'un groupe d'utilisateurs", "description": "Retire les anciens membres du groupe et ajoute les nouveaux membres. Si la nouvelle liste est vide, tous les anciens membres sont retir\u00e9s du groupe.", "operationId": "put_henrietta_v1_groupe_utilisateurs_membre_remplace", "parameters": [ { "name": "code", "in": "path", "description": "Code du groupe d'utilisateurs", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Liste des utilisateurs membres du groupe (supprime et remplace les anciens membres)", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UtilisateurMajMembreGroupeDto" } } } } }, "responses": { "200": { "description": "Membres du groupe mis \u00e0 jour avec succ\u00e8s", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UtilisateurLectureDto" } } } } } }, "security": [ { "OAuth2": [ "habilitation.ecrire" ] } ] } }, "/v1/groupes-utilisateurs/{code}/est-gestionnaire-de-populations": { "get": { "tags": [ "Groupes d'utilisateurs" ], "summary": "Liste des populations dont le groupe d'utilisateurs est gestionnaire", "operationId": "get_henrietta_v1_groupe_gestionnaires_de_populations_collection", "parameters": [ { "name": "code", "in": "path", "description": "Code du groupe d'utilisateurs", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Liste des populations dont le groupe d'utilisateurs est gestionnaire", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PopulationLectureDto" } } } } } }, "security": [ { "OAuth2": [ "habilitation.lire" ] } ] }, "put": { "tags": [ "Groupes d'utilisateurs" ], "summary": "Mise \u00e0 jour des populations sur lesquelles le groupe de gestionnaires est habilit\u00e9", "description": "Habilite le groupe de gestionnaires sur la nouvelle liste de populations", "operationId": "put_henrietta_v1_groupe_gestionnaires_de_populations_remplace", "parameters": [ { "name": "code", "in": "path", "description": "Code du groupe d'utilisateurs", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Liste des nouvelles populations sur lesquelles le groupe de gestionnaires est habilit\u00e9", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PopulationMajHabilitationsGroupeGestDto" } } } } }, "responses": { "200": { "description": "Habilitations du groupe de gestionnaires mises \u00e0 jour avec succ\u00e8s", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PopulationLectureDto" } } } } } }, "security": [ { "OAuth2": [ "habilitation.ecrire" ] } ] } }, "/v1/groupes-utilisateurs/{code}/est-gestionnaire-de-types-notes": { "get": { "tags": [ "Groupes d'utilisateurs" ], "summary": "Liste des types de notes dont le groupe d'utilisateurs est gestionnaire", "operationId": "get_henrietta_v1_groupe_gestionnaires_de_types_notes_collection", "parameters": [ { "name": "code", "in": "path", "description": "Code du groupe d'utilisateurs", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Liste des types de notes dont le groupe d'utilisateurs est gestionnaire", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TypeNoteLectureDto" } } } } } }, "security": [ { "OAuth2": [ "habilitation.lire" ] } ] }, "put": { "tags": [ "Groupes d'utilisateurs" ], "summary": "Mise \u00e0 jour des types de notes sur lesquelles le groupe de gestionnaires est habilit\u00e9", "description": "Habilite le groupe de gestionnaires sur la nouvelle liste de types de notes", "operationId": "put_henrietta_v1_groupe_gestionnaires_de_types_notes_remplace", "parameters": [ { "name": "code", "in": "path", "description": "Code du groupe d'utilisateurs", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Liste des nouveaux types de notes sur lesquels le groupe de gestionnaires est habilit\u00e9", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TypeNoteMajHabilitationsGroupeGestDto" } } } } }, "responses": { "200": { "description": "Habilitations du groupe de gestionnaires mises \u00e0 jour avec succ\u00e8s", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TypeNoteLectureDto" } } } } } }, "security": [ { "OAuth2": [ "habilitation.ecrire" ] } ] } }, "/v1/donnees-complementaires-defs": { "get": { "tags": [ "Param\u00e9trage" ], "summary": "Dictionnaire de d\u00e9finition des donn\u00e9es compl\u00e9mentaires", "operationId": "get_henrietta_v1_donnee_complementaire_def_collection", "responses": { "200": { "description": "Liste des d\u00e9finitions des donn\u00e9es compl\u00e9mentaires", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DonneeComplementaireDefDto" } } } } } }, "security": [ { "OAuth2": [ "parametrage.lire" ] } ] } }, "/v1/fonctions-validation": { "get": { "tags": [ "Param\u00e9trage" ], "summary": "Param\u00e9trage des fonctions de validation servant \u00e0 qualifier les groupes de valideurs", "operationId": "get_henrietta_v1_fonction_validation_collection", "responses": { "200": { "description": "Liste des fonctions de validation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FonctionValidationDto" } } } } } }, "security": [ { "OAuth2": [ "parametrage.lire" ] } ] } }, "/v1/locales": { "get": { "tags": [ "Param\u00e9trage" ], "summary": "Liste des langues accept\u00e9es pour la localisation (Ex: fr_FR, en_GB)", "operationId": "get_henrietta_v1_locale_collection", "responses": { "200": { "description": "Liste des langues accept\u00e9es", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocaleDto" } } } } } }, "security": [ { "OAuth2": [ "parametrage.lire" ] } ] } }, "/v1/rattachement-natures": { "get": { "tags": [ "Param\u00e9trage" ], "summary": "Param\u00e9trage des natures de rattachement de type sp\u00e9cifique (Ex: Territoire, d\u00e9partement...)", "operationId": "get_henrietta_v1_nature_rattachement_collection", "responses": { "200": { "description": "Liste des natures de rattachement de type sp\u00e9cifique", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RattachementNatureDto" } } } } } }, "security": [ { "OAuth2": [ "rattachement-specif.lire" ] } ] } }, "/v1/populations": { "get": { "tags": [ "Populations" ], "summary": "Liste des populations", "operationId": "get_henrietta_v1_population_collection", "responses": { "200": { "description": "Liste des populations", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PopulationLectureDto" } } } } } }, "security": [ { "OAuth2": [ "population.lire" ] } ] } }, "/v1/elements-analytiques": { "get": { "tags": [ "R\u00e9f\u00e9rentiel" ], "summary": "Liste des \u00e9l\u00e9ments analytiques (r\u00e9f\u00e9rentiel)", "operationId": "get_henrietta_v1_element_analytique_collection", "parameters": [ { "name": "archive", "in": "query", "description": "Applique un filtre (par d\u00e9fault false) pour s\u00e9lectionner les \u00e9l\u00e9ments archiv\u00e9s ou non archiv\u00e9s", "required": false, "schema": { "type": "boolean" }, "example": true } ], "responses": { "200": { "description": "Liste des \u00e9l\u00e9ments analytiques (r\u00e9f\u00e9rentiel)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ElementAnalytiqueDto" } } } } } }, "security": [ { "OAuth2": [ "referentiel.lire" ] } ] }, "post": { "tags": [ "R\u00e9f\u00e9rentiel" ], "summary": "Cr\u00e9ation d'un \u00e9l\u00e9ment analytique", "operationId": "post_henrietta_v1_element_analytique_creation", "requestBody": { "description": "D\u00e9tail de l'\u00e9l\u00e9ment analytique", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementAnalytiqueDto" } } } }, "responses": { "201": { "description": "El\u00e9ment analytique cr\u00e9\u00e9 avec succ\u00e8s", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementAnalytiqueDto" } } } } }, "security": [ { "OAuth2": [ "referentiel.ecrire" ] } ] } }, "/v1/elements-analytiques/{code}": { "get": { "tags": [ "R\u00e9f\u00e9rentiel" ], "summary": "D\u00e9tail d'un \u00e9l\u00e9ment analytique", "operationId": "get_henrietta_v1_element_analytique_detail", "parameters": [ { "name": "code", "in": "path", "description": "Code de l'\u00e9l\u00e9ment analytique", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "D\u00e9tail d'un \u00e9l\u00e9ment analytique", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementAnalytiqueDto" } } } } }, "security": [ { "OAuth2": [ "referentiel.lire" ] } ] }, "put": { "tags": [ "R\u00e9f\u00e9rentiel" ], "summary": "Modification d'un \u00e9l\u00e9ment analytique", "operationId": "put_henrietta_v1_element_analytique_modification", "parameters": [ { "name": "code", "in": "path", "description": "Code de l'\u00e9l\u00e9ment analytique", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "D\u00e9tail de l'\u00e9l\u00e9ment analytique", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementAnalytiqueModificationDto" } } } }, "responses": { "200": { "description": "El\u00e9ment analytique modifi\u00e9 avec succ\u00e8s", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementAnalytiqueDto" } } } } }, "security": [ { "OAuth2": [ "referentiel.ecrire" ] } ] } }, "/v1/types-notes": { "get": { "tags": [ "R\u00e9f\u00e9rentiel" ], "summary": "Liste des types de notes de frais", "operationId": "get_henrietta_v1_type_note_collection", "responses": { "200": { "description": "Liste des types de notes de frais", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TypeNoteLectureDto" } } } } } }, "security": [ { "OAuth2": [ "referentiel.lire" ] } ] } }, "/v1/etablissements": { "get": { "tags": [ "Soci\u00e9t\u00e9s" ], "summary": "Liste des \u00e9tablissements", "operationId": "get_henrietta_v1_etablissement_collection", "parameters": [ { "name": "archive", "in": "query", "description": "Applique un filtre (par d\u00e9fault false) pour s\u00e9lectionner les \u00e9l\u00e9ments archiv\u00e9s ou non archiv\u00e9s", "required": false, "schema": { "type": "boolean" }, "example": true } ], "responses": { "200": { "description": "Liste des \u00e9tablissements", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EtablissementLectureDto" } } } } } }, "security": [ { "OAuth2": [ "etablissement.lire" ] } ] }, "post": { "tags": [ "Soci\u00e9t\u00e9s" ], "summary": "Cr\u00e9ation d'un \u00e9tablissement", "operationId": "post_henrietta_v1_etablissement_creation", "requestBody": { "description": "D\u00e9tail de l'\u00e9tablissement'", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EtablissementCreationDto" } } } }, "responses": { "201": { "description": "Etablissement cr\u00e9\u00e9 avec succ\u00e8s", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EtablissementLectureDto" } } } } }, "security": [ { "OAuth2": [ "etablissement.ecrire" ] } ] } }, "/v1/etablissements/{code}": { "get": { "tags": [ "Soci\u00e9t\u00e9s" ], "summary": "D\u00e9tail d'un \u00e9tablissement", "operationId": "get_henrietta_v1_etablissement_detail", "parameters": [ { "name": "code", "in": "path", "description": "Code de l'\u00e9tablissement", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "D\u00e9tail d'un \u00e9tablissement", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EtablissementLectureDto" } } } } }, "security": [ { "OAuth2": [ "etablissement.lire" ] } ] }, "put": { "tags": [ "Soci\u00e9t\u00e9s" ], "summary": "Modification d'un \u00e9tablissement", "operationId": "put_henrietta_v1_etablissement_modification", "parameters": [ { "name": "code", "in": "path", "description": "Code de l'\u00e9tablissement", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "D\u00e9tail de l'\u00e9tablissement", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EtablissementModificationDto" } } } }, "responses": { "200": { "description": "Etablissement modifi\u00e9 avec succ\u00e8s", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EtablissementLectureDto" } } } } }, "security": [ { "OAuth2": [ "etablissement.ecrire" ] } ] } }, "/v1/rattachement-specifs/{rattachementNature}": { "get": { "tags": [ "Soci\u00e9t\u00e9s" ], "summary": "Liste des \u00e9l\u00e9ments de rattachement de type sp\u00e9cifique (Ex: Territoire, d\u00e9partement...)", "operationId": "get_henrietta_v1_rattachement_specif_collection", "parameters": [ { "name": "rattachementNature", "in": "path", "description": "Code de la nature de rattachement", "required": true, "schema": { "type": "string" } }, { "name": "archive", "in": "query", "description": "Applique un filtre (par d\u00e9fault false) pour s\u00e9lectionner les \u00e9l\u00e9ments archiv\u00e9s ou non archiv\u00e9s", "required": false, "schema": { "type": "boolean" }, "example": true } ], "responses": { "200": { "description": "Liste des \u00e9l\u00e9ments de rattachement de type sp\u00e9cifique", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RattachementSpecifLectureDto" } } } } } }, "security": [ { "OAuth2": [ "rattachement-specif.lire" ] } ] }, "post": { "tags": [ "Soci\u00e9t\u00e9s" ], "summary": "Cr\u00e9ation d'un \u00e9l\u00e9ment de rattachement de type sp\u00e9cifique", "operationId": "post_henrietta_v1_rattachement_specif_creation", "parameters": [ { "name": "rattachementNature", "in": "path", "description": "Code de la nature de rattachement", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "D\u00e9tail de l'\u00e9l\u00e9ment de rattachement", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RattachementSpecifCreationDto" } } } }, "responses": { "201": { "description": "El\u00e9ment de rattachement cr\u00e9\u00e9 avec succ\u00e8s", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RattachementSpecifLectureDto" } } } } }, "security": [ { "OAuth2": [ "rattachement-specif.ecrire" ] } ] } }, "/v1/rattachement-specifs/{rattachementNature}/{code}": { "get": { "tags": [ "Soci\u00e9t\u00e9s" ], "summary": "D\u00e9tail d'un \u00e9l\u00e9ment de rattachement de type sp\u00e9cifique", "operationId": "get_henrietta_v1_rattachement_specif_detail", "parameters": [ { "name": "rattachementNature", "in": "path", "description": "Code de la nature de rattachement", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "path", "description": "Code de l'\u00e9l\u00e9ment de rattachement'", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "D\u00e9tail d'un \u00e9l\u00e9ment de rattachement de type sp\u00e9cifique", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RattachementSpecifLectureDto" } } } } }, "security": [ { "OAuth2": [ "rattachement-specif.lire" ] } ] }, "put": { "tags": [ "Soci\u00e9t\u00e9s" ], "summary": "Modification d'un \u00e9l\u00e9ment de rattachement de type sp\u00e9cifique", "operationId": "put_henrietta_v1_rattachement_specif_modification", "parameters": [ { "name": "rattachementNature", "in": "path", "description": "Code de la nature de rattachement", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "path", "description": "Code de l'\u00e9l\u00e9ment de rattachement", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "D\u00e9tail de l'\u00e9l\u00e9ment de rattachement", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RattachementSpecifModificationDto" } } } }, "responses": { "200": { "description": "El\u00e9ment de rattachement modifi\u00e9 avec succ\u00e8s", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RattachementSpecifLectureDto" } } } } }, "security": [ { "OAuth2": [ "rattachement-specif.ecrire" ] } ] } }, "/v1/societes": { "get": { "tags": [ "Soci\u00e9t\u00e9s" ], "summary": "Liste des soci\u00e9t\u00e9s", "operationId": "get_henrietta_v1_societe_collection", "parameters": [ { "name": "archive", "in": "query", "description": "Applique un filtre (par d\u00e9fault false) pour s\u00e9lectionner les \u00e9l\u00e9ments archiv\u00e9s ou non archiv\u00e9s", "required": false, "schema": { "type": "boolean" }, "example": true } ], "responses": { "200": { "description": "Liste des soci\u00e9t\u00e9s", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SocieteLectureDto" } } } } } }, "security": [ { "OAuth2": [ "societe.lire" ] } ] }, "post": { "tags": [ "Soci\u00e9t\u00e9s" ], "summary": "Cr\u00e9ation d'une soci\u00e9t\u00e9", "operationId": "post_henrietta_v1_societe_creation", "requestBody": { "description": "D\u00e9tail de la soci\u00e9t\u00e9", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocieteCreationDto" } } } }, "responses": { "201": { "description": "Soci\u00e9t\u00e9 cr\u00e9\u00e9e avec succ\u00e8s", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocieteLectureDto" } } } } }, "security": [ { "OAuth2": [ "societe.ecrire" ] } ] } }, "/v1/societes/{code}": { "get": { "tags": [ "Soci\u00e9t\u00e9s" ], "summary": "D\u00e9tail d'une soci\u00e9t\u00e9", "operationId": "get_henrietta_v1_societe_detail", "parameters": [ { "name": "code", "in": "path", "description": "Code de la soci\u00e9t\u00e9", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "D\u00e9tail d'une soci\u00e9t\u00e9", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocieteLectureDto" } } } } }, "security": [ { "OAuth2": [ "societe.lire" ] } ] }, "put": { "tags": [ "Soci\u00e9t\u00e9s" ], "summary": "Modification d'une soci\u00e9t\u00e9", "operationId": "put_henrietta_v1_societe_modification", "parameters": [ { "name": "code", "in": "path", "description": "COde de la soci\u00e9t\u00e9", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "D\u00e9tail de la soci\u00e9t\u00e9", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocieteModificationDto" } } } }, "responses": { "200": { "description": "Soci\u00e9t\u00e9 modifi\u00e9e avec succ\u00e8s", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocieteLectureDto" } } } } }, "security": [ { "OAuth2": [ "societe.ecrire" ] } ] } }, "/v1/utilisateurs": { "get": { "tags": [ "Utilisateurs" ], "summary": "Liste des utilisateurs", "operationId": "get_henrietta_v1_utilisateur_collection", "responses": { "200": { "description": "Liste des utilisateurs", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UtilisateurLectureDto" } } } } } }, "security": [ { "OAuth2": [ "utilisateur.lire" ] } ] }, "post": { "tags": [ "Utilisateurs" ], "summary": "Cr\u00e9ation d'un utilisateur", "operationId": "post_henrietta_v1_utilisateur_creation", "requestBody": { "description": "D\u00e9tail de l'utilisateur", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtilisateurCreationDto" } } } }, "responses": { "201": { "description": "Utilisateur cr\u00e9\u00e9 avec succ\u00e8s", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtilisateurLectureDto" } } } } }, "security": [ { "OAuth2": [ "utilisateur.ecrire" ] } ] } }, "/v1/utilisateurs/{uid}": { "get": { "tags": [ "Utilisateurs" ], "summary": "D\u00e9tail d'un utilisateur", "operationId": "get_henrietta_v1_utilisateur_detail", "parameters": [ { "name": "uid", "in": "path", "description": "UID de l'utilisateur", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "D\u00e9tail d'un utilisateur", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtilisateurLectureDto" } } } } }, "security": [ { "OAuth2": [ "utilisateur.lire" ] } ] }, "put": { "tags": [ "Utilisateurs" ], "summary": "Modification d'un utilisateur", "operationId": "put_henrietta_v1_utilisateur_modification", "parameters": [ { "name": "uid", "in": "path", "description": "UID de l'utilisateur", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "D\u00e9tail de l'utilisateur", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtilisateurModificationDto" } } } }, "responses": { "200": { "description": "Utilisateur modifi\u00e9 avec succ\u00e8s", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtilisateurLectureDto" } } } } }, "security": [ { "OAuth2": [ "utilisateur.ecrire" ] } ] } }, "/v1/utilisateurs/{uid}/habilitations": { "get": { "tags": [ "Utilisateurs" ], "summary": "Habilitations d'un utilisateur", "operationId": "get_henrietta_v1_utilisateur_habilitations", "parameters": [ { "name": "uid", "in": "path", "description": "UID de l'utilisateur", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Habilitations d'un utilisateur", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtilisateurHabilitationsDto" } } } } }, "security": [ { "OAuth2": [ "utilisateur.lire" ] } ] } }, "/v1/utilisateurs/{uid}/groupes": { "get": { "tags": [ "Utilisateurs" ], "summary": "Liste des groupes dont un utilisateur est membre", "operationId": "get_henrietta_v1_utilisateur_groupes", "parameters": [ { "name": "uid", "in": "path", "description": "UID de l'utilisateur", "required": true, "schema": { "type": "string" } }, { "name": "categorie", "in": "query", "description": "Permet d'appliquer un filtre de type '\u00e9gale' sur la cat\u00e9gorie des groupes", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Liste des groupes dont un utilisateur est membre", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupeUtilisateursDto" } } } } } }, "security": [ { "OAuth2": [ "utilisateur.lire" ] } ] } }, "/v1/approvals/queue": { "get": { "operationId": "get_reform-club_v1_approval_queue", "responses": { "default": { "description": "" } } } }, "/v1/approvals/{approvalId}": { "get": { "operationId": "get_reform-club_v1_approval_get", "parameters": [ { "name": "approvalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/approvals/{approvalId}/expenses/{expenseId}": { "get": { "operationId": "get_reform-club_v1_approval_get_expense", "parameters": [ { "name": "approvalId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expenseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "operationId": "patch_reform-club_v1_approval_update_expense", "parameters": [ { "name": "approvalId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expenseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/approvals/{approvalId}/expenses/{expenseId}/management-bypass": { "patch": { "operationId": "patch_reform-club_v1_approval_update_expense_management_bypass", "parameters": [ { "name": "approvalId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expenseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/approvals/{approvalId}/accept": { "post": { "operationId": "post_reform-club_v1_approval_accept", "parameters": [ { "name": "approvalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/approvals/{approvalId}/reject": { "post": { "operationId": "post_reform-club_v1_approval_reject", "parameters": [ { "name": "approvalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/approvals/{approvalId}/receipts/{receiptId}/image": { "get": { "operationId": "get_reform-club_v1_approval_receipt_image", "parameters": [ { "name": "approvalId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "receiptId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "default": { "description": "" } } } }, "/v1/approvals/{approvalId}/undo-last-decision": { "post": { "operationId": "post_reform-club_v1_approval_undo_last_decision", "parameters": [ { "name": "approvalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/approvals/{approvalId}/expenses/{expenseId}/message": { "post": { "operationId": "post_reform-club_v1_approval_create_expense_message", "parameters": [ { "name": "approvalId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expenseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/auth/discover": { "post": { "operationId": "post_reform-club_v1_auth_discover", "responses": { "default": { "description": "" } } } }, "/v1/auth/login": { "post": { "operationId": "post_reform-club_v1_auth_login", "responses": { "default": { "description": "" } } } }, "/v1/auth/refresh": { "post": { "operationId": "post_reform-club_v1_auth_refresh", "responses": { "default": { "description": "" } } } }, "/v1/auth/logout": { "post": { "operationId": "post_reform-club_v1_auth_logout", "responses": { "default": { "description": "" } } } }, "/v1/billing-intents": { "post": { "operationId": "post_reform-club_v1_billing_intent_create", "responses": { "default": { "description": "" } } } }, "/v1/billing-intents/{billingToken}/confirm": { "post": { "operationId": "post_reform-club_v1_billing_intent_confirm", "parameters": [ { "name": "billingToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/billing-intents/{billingToken}": { "get": { "operationId": "get_reform-club_v1_billing_intent_get", "parameters": [ { "name": "billingToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/claims": { "get": { "tags": [ "ReformClub" ], "operationId": "get_reform-club_v1_claim_list", "responses": { "default": { "description": "" } } }, "post": { "tags": [ "ReformClub" ], "operationId": "post_reform-club_v1_claim_create", "responses": { "default": { "description": "" } } } }, "/v1/claims/{claimId}": { "get": { "tags": [ "ReformClub" ], "operationId": "get_reform-club_v1_claim_get", "parameters": [ { "name": "claimId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "delete": { "tags": [ "ReformClub" ], "operationId": "delete_reform-club_v1_claim_delete", "parameters": [ { "name": "claimId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "ReformClub" ], "operationId": "patch_reform-club_v1_claim_update", "parameters": [ { "name": "claimId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/claims/{claimId}/submit": { "post": { "tags": [ "ReformClub" ], "operationId": "post_reform-club_v1_claim_submit", "parameters": [ { "name": "claimId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/claims/{claimId}/recall": { "post": { "tags": [ "ReformClub" ], "operationId": "post_reform-club_v1_claim_recall", "parameters": [ { "name": "claimId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/claims/{claimId}/expenses": { "post": { "tags": [ "ReformClub" ], "operationId": "post_reform-club_v1_claim_create_expense", "parameters": [ { "name": "claimId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/claims/{claimId}/expenses/{expenseId}": { "get": { "tags": [ "ReformClub" ], "operationId": "get_reform-club_v1_claim_get_expense", "parameters": [ { "name": "claimId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expenseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "delete": { "tags": [ "ReformClub" ], "operationId": "delete_reform-club_v1_claim_delete_expense", "parameters": [ { "name": "claimId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expenseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "ReformClub" ], "summary": "Modifier une d\u00e9pense et ses d\u00e9tails, dont les affectations analytiques simples ou multiples", "operationId": "patch_reform-club_v1_claim_update_expense", "parameters": [ { "name": "claimId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expenseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "detailFields": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/SingleAnalyticAllocationFieldDto" }, { "$ref": "#/components/schemas/AnalyticAllocationFieldDto" } ] } } }, "type": "object" } } } }, "responses": { "200": { "description": "D\u00e9pense mise \u00e0 jour" }, "422": { "description": "Affectation analytique ou autre r\u00e8gle m\u00e9tier invalide", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } } } }, "/v1/claims/{claimId}/expenses/mileage": { "post": { "tags": [ "ReformClub" ], "operationId": "post_reform-club_v1_claim_create_mileage_expense", "parameters": [ { "name": "claimId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/claims/{claimId}/risk-summary": { "get": { "tags": [ "ReformClub" ], "operationId": "get_reform-club_v1_claim_risk_summary", "parameters": [ { "name": "claimId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/claims/{claimId}/expenses/{expenseId}/risk": { "get": { "tags": [ "ReformClub" ], "operationId": "get_reform-club_v1_claim_expense_risk", "parameters": [ { "name": "claimId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expenseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/completion-tasks": { "get": { "operationId": "get_reform-club_v1_completion_task_list", "responses": { "default": { "description": "" } } } }, "/v1/completion-tasks/{taskId}": { "get": { "operationId": "get_reform-club_v1_completion_task_get", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/completion-tasks/{taskId}/convert-to-expense": { "post": { "operationId": "post_reform-club_v1_completion_task_convert_to_expense", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/devices": { "post": { "operationId": "post_reform-club_v1_device_create", "responses": { "default": { "description": "" } } } }, "/v1/etat": { "get": { "tags": [ "ReformClub" ], "summary": "\u00c9tat du connecteur ReformClub", "operationId": "get_reform-club_v1_etatindex", "responses": { "200": { "description": "\u00c9tat courant du connecteur ReformClub", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReformClubEtatDto" } } } }, "400": { "description": "Requete JSON ou query parameters invalides", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Session absente ou expiree", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Droit insuffisant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "404": { "description": "Ressource inexistante ou inaccessible", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "409": { "description": "Conflit de workflow", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "413": { "description": "Fichier trop volumineux", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "415": { "description": "Type de fichier refuse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "422": { "description": "Validation DTO ou regle metier non respectee", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "429": { "description": "Limite de debit atteinte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } } } }, "/v1/expense-zones/detect": { "post": { "operationId": "post_reform-club_v1_expense_zone_detect", "responses": { "default": { "description": "" } } } }, "/v1/files/upload-url": { "post": { "operationId": "post_reform-club_v1_file_upload_url", "responses": { "default": { "description": "" } } } }, "/v1/files/{fileId}/complete": { "post": { "operationId": "post_reform-club_v1_file_complete", "parameters": [ { "name": "fileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/files/{fileId}/download-url": { "get": { "operationId": "get_reform-club_v1_file_download_url", "parameters": [ { "name": "fileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/files/{fileId}": { "delete": { "operationId": "delete_reform-club_v1_file_delete", "parameters": [ { "name": "fileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/me/bootstrap": { "get": { "tags": [ "ReformClub" ], "summary": "Bootstrap mobile utilisateur", "operationId": "get_reform-club_v1_me_bootstrap", "responses": { "200": { "description": "Donnees agregees de demarrage pour l'utilisateur courant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrentUserDataBootstrapResponseDto" } } } } } } }, "/v1/me/features": { "get": { "tags": [ "ReformClub" ], "summary": "Capacites utilisateur", "operationId": "get_reform-club_v1_me_features", "responses": { "200": { "description": "Features disponibles pour l'utilisateur courant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeaturesResponseDto" } } } } } } }, "/v1/me/profile": { "get": { "tags": [ "ReformClub" ], "summary": "Profil utilisateur", "operationId": "get_reform-club_v1_me_profile", "responses": { "200": { "description": "Profil, roles et preferences de l'utilisateur courant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileResponseDto" } } } } } } }, "/v1/me/preferences": { "patch": { "tags": [ "ReformClub" ], "summary": "Mise a jour des preferences mobiles", "operationId": "patch_reform-club_v1_me_preferences", "responses": { "200": { "description": "Preferences mobiles mises a jour", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePreferencesResponseDto" } } } } } } }, "/v1/me/receipts": { "get": { "tags": [ "ReformClub" ], "summary": "Justificatifs disponibles pour une nouvelle depense", "operationId": "get_reform-club_v1_me_receipt_library", "responses": { "200": { "description": "Bibliotheque paginee des justificatifs disponibles", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceiptLibraryResponseDto" } } } } } } }, "/v1/me/receipts/{receiptId}/ocr": { "get": { "tags": [ "ReformClub" ], "summary": "Donnees OCR existantes d'un justificatif utilisateur", "operationId": "get_reform-club_v1_me_receipt_ocr", "parameters": [ { "name": "receiptId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Resultat OCR deja calcule, ou statut unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceiptOcrResponseDto" } } } }, "404": { "description": "Justificatif introuvable" } } } }, "/v1/me/receipts/{receiptId}/image": { "get": { "tags": [ "ReformClub" ], "summary": "Fichier d'un justificatif utilisateur", "operationId": "get_reform-club_v1_me_receipt_image", "parameters": [ { "name": "receiptId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Image ou PDF du justificatif", "content": { "image/jpg": {}, "image/jpeg": {}, "image/png": {}, "image/webp": {}, "application/pdf": {} } }, "404": { "description": "Justificatif introuvable" } } } }, "/v1/messages/summary": { "get": { "operationId": "get_reform-club_v1_message_summary", "responses": { "default": { "description": "" } } } }, "/v1/notifications": { "get": { "operationId": "get_reform-club_v1_message_notifications", "responses": { "default": { "description": "" } } } }, "/v1/conversations": { "get": { "operationId": "get_reform-club_v1_message_list_conversations", "responses": { "default": { "description": "" } } }, "post": { "operationId": "post_reform-club_v1_message_create_conversation", "responses": { "default": { "description": "" } } } }, "/v1/conversations/{conversationId}": { "get": { "operationId": "get_reform-club_v1_message_get_conversation", "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "pattern": ".+" } } ], "responses": { "default": { "description": "" } } } }, "/v1/conversations/{conversationId}/messages": { "post": { "operationId": "post_reform-club_v1_message_create_conversation_message", "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "pattern": ".+" } } ], "responses": { "default": { "description": "" } } } }, "/v1/messages/{messageId}/read": { "post": { "operationId": "post_reform-club_v1_message_read", "parameters": [ { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/messages/{messageId}/archive": { "post": { "operationId": "post_reform-club_v1_message_archive", "parameters": [ { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/messages/{messageId}/unarchive": { "post": { "operationId": "post_reform-club_v1_message_unarchive", "parameters": [ { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/mileage/estimate": { "post": { "operationId": "post_reform-club_v1_mileage_estimate", "responses": { "default": { "description": "" } } } }, "/v1/ocr/jobs": { "post": { "operationId": "post_reform-club_v1_ocr_job_create", "responses": { "default": { "description": "" } } } }, "/v1/ocr/jobs/{jobId}": { "get": { "operationId": "get_reform-club_v1_ocr_job_get", "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/reference/internal-guests": { "get": { "operationId": "get_reform-club_v1_reference_internal_guests", "responses": { "default": { "description": "" } } } }, "/v1/reference/expense-categories": { "get": { "operationId": "get_reform-club_v1_reference_expense_categories", "responses": { "default": { "description": "" } } } }, "/v1/reference/expense-natures": { "get": { "operationId": "get_reform-club_v1_reference_expense_natures", "responses": { "default": { "description": "" } } } }, "/v1/reference/expense-natures/{natureId}/details": { "get": { "operationId": "get_reform-club_v1_reference_expense_nature_details", "parameters": [ { "name": "natureId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/v1/reference/currencies": { "get": { "operationId": "get_reform-club_v1_reference_currencies", "responses": { "default": { "description": "" } } } }, "/v1/reference/exchange-rates/{currencyId}": { "get": { "operationId": "get_reform-club_v1_reference_exchange_rates", "parameters": [ { "name": "currencyId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "default": { "description": "" } } } }, "/v1/risk/jobs": { "post": { "operationId": "post_reform-club_v1_risk_job_create", "responses": { "default": { "description": "" } } } }, "/v1/search/claims": { "get": { "operationId": "get_reform-club_v1_search_claims", "responses": { "default": { "description": "" } } } }, "/v1/search/expenses": { "get": { "operationId": "get_reform-club_v1_search_expenses", "responses": { "default": { "description": "" } } } }, "/v1/security/login-experience/{codeClient}": { "get": { "tags": [ "ReformClub" ], "summary": "Exp\u00e9rience de connexion mobile associ\u00e9e au code client", "operationId": "get_reform-club_v1_security_login_experience", "parameters": [ { "name": "codeClient", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Configuration de connexion mobile", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginExperienceResponseDto" } } } }, "404": { "description": "Code client inconnu" } } } }, "/v1/security/password": { "put": { "tags": [ "ReformClub" ], "summary": "Modification du mot de passe de l\u2019utilisateur courant", "operationId": "put_reform-club_v1_security_reset_password", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequestDto" } } } }, "responses": { "200": { "description": "Mot de passe modifi\u00e9", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordResponseDto" } } } }, "422": { "description": "Mot de passe refus\u00e9" } } } }, "/v1/me/vehicles": { "get": { "operationId": "get_reform-club_v1_vehicle_list", "responses": { "default": { "description": "" } } } } }, "components": { "schemas": { "CollaborateurEcritureDto": { "title": "Collaborateur (\u00e9criture)", "description": "Repr\u00e9sente un collaborateur en \u00e9criture", "required": [ "nom", "prenom", "actif", "identifiant_externe", "date_embauche" ], "properties": { "nom": { "title": "Nom", "description": "la modification de cet attribut modifie \u00e9galement le nom de l'utilisateur associ\u00e9", "type": "string", "example": "Passepartout", "maxLength": 50 }, "prenom": { "title": "Pr\u00e9nom", "description": "la modification de cet attribut modifie \u00e9galement le pr\u00e9nom de l'utilisateur associ\u00e9", "type": "string", "example": "Jean", "maxLength": 50 }, "actif": { "title": "Actif", "description": "Cet attribut est directement li\u00e9 \u00e0 l'attribut \"bloqu\u00e9\" de l'utilisateur. Si un collaborateur est actif ou inactif, alors il sera r\u00e9ciproquement d\u00e9bloqu\u00e9 ou bloqu\u00e9 en tant qu'utilisateur", "type": "boolean", "example": true }, "email": { "title": "Adresse email", "description": "la modification de cet attribut modifie \u00e9galement l'email de l'utilisateur associ\u00e9", "type": "string", "example": "jean.passepartout@ma-societe.com", "nullable": true, "maxLength": 255 }, "identifiant_externe": { "title": "Identifiant externe", "type": "string", "example": "00000080", "maxLength": 50 }, "date_embauche": { "title": "Date d'embauche", "description": "Date au format AAAA-MM-JJ", "type": "string", "format": "date", "example": "2015-01-01" }, "date_sortie": { "title": "Date de sortie", "description": "Date au format AAAA-MM-JJ", "type": "string", "format": "date", "example": "2023-12-31", "nullable": true }, "rue": { "title": "Adresse postale (rue)", "type": "string", "example": "10 rue Fr\u00e9d\u00e9ric Mistral", "nullable": true, "maxLength": 255 }, "ville": { "title": "Adresse postale (Ville)", "type": "string", "example": "Lyon", "nullable": true, "maxLength": 100 }, "code_postal": { "title": "Adresse postale (Code postal)", "type": "string", "example": "69000", "nullable": true, "maxLength": 10 }, "pays": { "title": "Adresse postale (Pays)", "type": "string", "example": "France", "nullable": true, "maxLength": 50 }, "code_societe": { "title": "Code de la soci\u00e9t\u00e9", "type": "string", "example": "SIEGE", "nullable": true }, "code_etablissement": { "title": "Code de l'\u00e9tablissement", "type": "string", "example": null, "nullable": true }, "code_rattachement_specif": { "title": "Code de l'\u00e9l\u00e9ment de rattachement sp\u00e9cifique", "type": "string", "example": null, "nullable": true } }, "type": "object" }, "CollaborateurDonneesBancairesEcritureDto": { "title": "CollaborateurDonneesBancaires (\u00e9criture)", "description": "Repr\u00e9sente les donn\u00e9es bancaires d'un collaborateur en \u00e9criture", "properties": { "bic": { "title": "BIC", "type": "string", "nullable": true, "maxLength": 11 }, "iban": { "title": "IBAN", "type": "string", "nullable": true, "maxLength": 34 } }, "type": "object" }, "DonneeComplementaireEcritureDto": { "title": "DonneeComplementaire (\u00e9criture)", "description": "Repr\u00e9sente une donn\u00e9e compl\u00e9mentaire d'un collaborateur en \u00e9criture", "properties": { "valeur": { "title": "Valeur de la donn\u00e9e compl\u00e9mentaire", "type": "string", "example": "O", "nullable": true, "maxLength": 100 } }, "type": "object" }, "MandatPeriodeDto": { "title": "MandatPeriode", "description": "P\u00e9riode de mandat d'un collaborateur en tant que d\u00e9l\u00e9gu\u00e9 du personnel", "required": [ "date_debut", "date_fin" ], "properties": { "date_debut": { "title": "Date de d\u00e9but", "description": "Date au format AAAA-MM-JJ", "type": "string", "format": "date", "example": "2023-01-01" }, "date_fin": { "title": "Date de fin", "description": "Date au format AAAA-MM-JJ", "type": "string", "format": "date", "example": "2023-12-31" } }, "type": "object" }, "RepartitionAnalytiqueDto": { "title": "RepartitionAnalytique", "description": "R\u00e9partition analytique d'un collaborateur", "required": [ "code", "pourcentage" ], "properties": { "code": { "title": "Code", "type": "string", "example": "1325", "maxLength": 45 }, "pourcentage": { "title": "Pourcentage", "type": "number", "format": "float", "example": "45", "maximum": 100, "minimum": 0 } }, "type": "object" }, "CollaborateurMajHabilitationsGroupeValideursDto": { "title": "Collaborateur (m\u00e0j habilitations groupe de valideurs)", "description": "Repr\u00e9sente un collaborateur (pour la mise \u00e0 jour des habilitations des groupes de valideurs)", "required": [ "uid" ], "properties": { "uid": { "title": "UID du collaborateur", "type": "string", "example": "jwz7m89d" } }, "type": "object" }, "GroupeUtilisateursCategorie": { "type": "string", "enum": [ "valideur", "gestionnaire", "expert" ] }, "GroupeUtilisateursSousCategorie": { "type": "string", "enum": [ "valideur-fonction-1", "valideur-fonction-2", "valideur-fonction-3", "valideur-fonction-4", "valideur-fonction-5", "valideur-fonction-6", "gestionnaire-population", "gestionnaire-type-de-note" ] }, "GroupeUtilisateursDto": { "title": "GroupeUtilisateurs", "description": "Repr\u00e9sente un groupe d'utilisateurs", "required": [ "code", "categorie", "libelle" ], "properties": { "code": { "title": "Code", "type": "string", "example": "valideurs-equipe-xxx", "maxLength": 50 }, "categorie": { "$ref": "#/components/schemas/GroupeUtilisateursCategorie" }, "sous_categorie": { "title": "Sous-cat\u00e9gorie", "description": "Le combinaison \"categorie + sous_categorie\" permet par exemple de d\u00e9finir le r\u00f4le et le p\u00e9rim\u00e8tre des utilisateurs membres du groupe", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/GroupeUtilisateursSousCategorie" } ] }, "libelle": { "title": "Libell\u00e9", "type": "string", "example": "Valideurs \u00e9quipe XXX", "maxLength": 255 } }, "type": "object" }, "GroupeUtilisateursModificationDto": { "title": "GroupeUtilisateurs (modification)", "description": "Repr\u00e9sente un groupe d'utilisateurs en modification", "required": [ "libelle" ], "properties": { "libelle": { "title": "Libell\u00e9", "type": "string", "example": "Valideurs \u00e9quipe XXX", "maxLength": 255 } }, "type": "object" }, "UtilisateurMajMembreGroupeDto": { "title": "Utilisateur (m\u00e0j membres groupe)", "description": "Repr\u00e9sente un utilisateur (pour la mise \u00e0 jour des membres du groupe)", "required": [ "uid" ], "properties": { "uid": { "title": "UID de l'utilisateur", "type": "string", "example": "7250mydD" } }, "type": "object" }, "PopulationMajHabilitationsGroupeGestDto": { "title": "Population (m\u00e0j habilitations groupe de gestionnaires)", "description": "Repr\u00e9sente une population (pour la mise \u00e0 jour des habilitations des groupes de gestionnaires)", "required": [ "uid" ], "properties": { "uid": { "title": "UID de la population", "type": "string", "example": "jwz7m89d" } }, "type": "object" }, "TypeNoteMajHabilitationsGroupeGestDto": { "title": "TypeNote (m\u00e0j habilitations groupe de gestionnaires)", "description": "Repr\u00e9sente un type de note de frais (pour la mise \u00e0 jour des habilitations des groupes de gestionnaires)", "required": [ "uid" ], "properties": { "uid": { "title": "UID du type de note", "type": "string", "example": "jwz7m89d" } }, "type": "object" }, "ElementAnalytiqueDto": { "title": "ElementAnalytique", "description": "El\u00e9ment analytique (r\u00e9f\u00e9rentiel)", "required": [ "code", "libelle" ], "properties": { "code": { "title": "Code", "type": "string", "example": "1325", "maxLength": 45 }, "libelle": { "title": "Libelle", "type": "string", "example": "SECTEUR LYON", "maxLength": 255 }, "code_societe": { "title": "Code de la soci\u00e9t\u00e9", "type": "string", "example": "SIEGE", "nullable": true }, "code_etablissement": { "title": "Code de l'\u00e9tablissement", "type": "string", "example": null, "nullable": true }, "code_rattachement_specif": { "title": "Code de l'\u00e9l\u00e9ment de rattachement sp\u00e9cifique", "type": "string", "example": null, "nullable": true }, "archive": { "title": "Permet l'archivage d'un \u00e9l\u00e9ment", "type": "boolean", "example": false, "nullable": true, "default": false } }, "type": "object" }, "ElementAnalytiqueModificationDto": { "title": "ElementAnalytique (modification)", "description": "El\u00e9ment analytique en modification (r\u00e9f\u00e9rentiel)", "required": [ "libelle" ], "properties": { "libelle": { "title": "Libelle", "type": "string", "example": "SECTEUR LYON", "maxLength": 255 }, "code_societe": { "title": "Code de la soci\u00e9t\u00e9", "type": "string", "example": "SIEGE", "nullable": true }, "code_etablissement": { "title": "Code de l'\u00e9tablissement", "type": "string", "example": null, "nullable": true }, "code_rattachement_specif": { "title": "Code de l'\u00e9l\u00e9ment de rattachement sp\u00e9cifique", "type": "string", "example": null, "nullable": true }, "archive": { "title": "Permet l'archivage d'un \u00e9l\u00e9ment", "type": "boolean", "example": false, "nullable": true, "default": false } }, "type": "object" }, "EtablissementCreationDto": { "title": "Etablissement (cr\u00e9ation)", "description": "Repr\u00e9sente un \u00e9tablissement en cr\u00e9ation", "required": [ "code", "libelle" ], "properties": { "code": { "title": "Code", "type": "string", "example": "LYON_1", "maxLength": 10, "uniqueItems": true }, "libelle": { "title": "Libell\u00e9", "type": "string", "example": "Etablissement Lyon 1", "maxLength": 255 }, "rue": { "title": "Adresse postale (rue)", "type": "string", "example": "10 rue Fr\u00e9d\u00e9ric Mistral", "nullable": true, "maxLength": 255 }, "ville": { "title": "Adresse postale (Ville)", "type": "string", "example": "Lyon", "nullable": true, "maxLength": 100 }, "code_postal": { "title": "Adresse postale (Code postal)", "type": "string", "example": "69000", "nullable": true, "maxLength": 10 }, "pays": { "title": "Adresse postale (Pays)", "type": "string", "example": "France", "nullable": true, "maxLength": 50 }, "archive": { "title": "Permet l'archivage d'un \u00e9l\u00e9ment", "type": "boolean", "example": false, "nullable": true, "default": false } }, "type": "object" }, "EtablissementModificationDto": { "title": "Etablissement (modification)", "description": "Repr\u00e9sente un \u00e9tablissement en modification", "required": [ "libelle" ], "properties": { "libelle": { "title": "Libell\u00e9", "type": "string", "example": "Etablissement Lyon 1", "maxLength": 255 }, "archive": { "title": "Permet l'archivage d'un \u00e9l\u00e9ment", "type": "boolean", "example": false, "nullable": true, "default": false } }, "type": "object" }, "RattachementSpecifCreationDto": { "title": "RattachementSpecif (cr\u00e9ation)", "description": "Repr\u00e9sente un \u00e9l\u00e9ment de rattachement de type sp\u00e9cifique en cr\u00e9ation (Ex: Territoire, d\u00e9partement...)", "required": [ "code", "libelle" ], "properties": { "code": { "title": "Code", "type": "string", "example": "TER_001", "maxLength": 10, "uniqueItems": true }, "libelle": { "title": "Libell\u00e9", "type": "string", "example": "Territoire 001", "maxLength": 255 }, "archive": { "title": "Permet l'archivage d'un \u00e9l\u00e9ment", "type": "boolean", "example": false, "nullable": true, "default": false } }, "type": "object" }, "RattachementSpecifModificationDto": { "title": "RattachementSpecif (modification)", "description": "Repr\u00e9sente un \u00e9l\u00e9ment de rattachement de type sp\u00e9cifique en modification (Ex: Territoire, d\u00e9partement...)", "required": [ "libelle" ], "properties": { "libelle": { "title": "Libell\u00e9", "type": "string", "example": "Territoire 001", "maxLength": 255 }, "archive": { "title": "Permet l'archivage d'un \u00e9l\u00e9ment", "type": "boolean", "example": false, "nullable": true, "default": false } }, "type": "object" }, "SocieteCreationDto": { "title": "Societe (cr\u00e9ation)", "description": "Repr\u00e9sente une soci\u00e9t\u00e9 en cr\u00e9ation", "required": [ "code", "libelle" ], "properties": { "code": { "title": "Code", "type": "string", "example": "SIEGE", "maxLength": 10, "uniqueItems": true }, "libelle": { "title": "Libell\u00e9", "type": "string", "example": "Ma soci\u00e9t\u00e9", "maxLength": 255 }, "archive": { "title": "Permet l'archivage d'un \u00e9l\u00e9ment", "type": "boolean", "example": false, "nullable": true, "default": false } }, "type": "object" }, "SocieteModificationDto": { "title": "Societe (modification)", "description": "Repr\u00e9sente une soci\u00e9t\u00e9 en modification", "required": [ "libelle" ], "properties": { "libelle": { "title": "Libell\u00e9", "type": "string", "example": "Ma soci\u00e9t\u00e9", "maxLength": 255 }, "archive": { "title": "Permet l'archivage d'un \u00e9l\u00e9ment", "type": "boolean", "example": false, "nullable": true, "default": false } }, "type": "object" }, "Locale": { "type": "string", "enum": [ "fr_FR", "en_GB" ] }, "UtilisateurCreationDto": { "title": "Utilisateur (cr\u00e9ation)", "description": "Repr\u00e9sente un utilisateur en cr\u00e9ation", "required": [ "login", "bloque", "nom", "prenom", "uniquement_sso", "uid_collaborateur" ], "properties": { "login": { "title": "Login", "description": "Identifiant unique parmi tous les utilisateurs de Phileas Gestion (l'adresse email peut \u00eatre utilis\u00e9e comme login)", "type": "string", "example": "jean.passepartout@ma-societe.com", "maxLength": 64 }, "bloque": { "title": "Bloqu\u00e9", "description": "Cet attribut est directement li\u00e9 \u00e0 l'attribut \"actif\" du collaborateur. Si un utilisateur est bloqu\u00e9 ou d\u00e9bloqu\u00e9, alors il sera r\u00e9ciproquement inactif ou actif en tant que collaborateur", "type": "boolean", "example": true }, "nom": { "title": "Nom", "description": "la modification de cet attribut modifie \u00e9galement le nom du collaborateur associ\u00e9", "type": "string", "example": "Passepartout", "maxLength": 50 }, "prenom": { "title": "Pr\u00e9nom", "description": "la modification de cet attribut modifie \u00e9galement le pr\u00e9nom du collaborateur associ\u00e9", "type": "string", "example": "Jean", "maxLength": 50 }, "email": { "title": "Adresse email", "description": "la modification de cet attribut modifie \u00e9galement l'email du collaborateur associ\u00e9", "type": "string", "example": "jean.passepartout@ma-societe.com", "nullable": true, "maxLength": 255 }, "locale": { "title": "Langue", "example": "fr_FR", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Locale" } ] }, "uniquement_sso": { "title": "Uniquement SSO", "description": "Indique si l'utilisateur se connecte uniquement en SSO", "type": "boolean", "example": false }, "uid_collaborateur": { "title": "UID du collaborateur associ\u00e9", "description": "L'association d'un collaborateur \u00e0 un utilisateur habilite l'utilisateur sur le r\u00f4le \"Collaborateur\"", "type": "string", "example": "jwz7m89d", "uniqueItems": true } }, "type": "object" }, "UtilisateurModificationDto": { "title": "Utilisateur (modification)", "description": "Repr\u00e9sente un utilisateur en modification", "required": [ "bloque", "nom", "prenom", "uniquement_sso" ], "properties": { "bloque": { "title": "Bloqu\u00e9", "description": "Cet attribut est directement li\u00e9 \u00e0 l'attribut \"actif\" du collaborateur. Si un utilisateur est bloqu\u00e9 ou d\u00e9bloqu\u00e9, alors il sera r\u00e9ciproquement inactif ou actif en tant que collaborateur", "type": "boolean", "example": true }, "nom": { "title": "Nom", "description": "la modification de cet attribut modifie \u00e9galement le nom du collaborateur associ\u00e9", "type": "string", "example": "Passepartout", "maxLength": 50 }, "prenom": { "title": "Pr\u00e9nom", "description": "la modification de cet attribut modifie \u00e9galement le pr\u00e9nom du collaborateur associ\u00e9", "type": "string", "example": "Jean", "maxLength": 50 }, "email": { "title": "Adresse email", "description": "la modification de cet attribut modifie \u00e9galement l'email du collaborateur associ\u00e9", "type": "string", "example": "jean.passepartout@ma-societe.com", "nullable": true, "maxLength": 255 }, "locale": { "title": "Langue", "example": "fr_FR", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Locale" } ] }, "uniquement_sso": { "title": "Uniquement SSO", "description": "Indique si l'utilisateur se connecte uniquement en SSO", "type": "boolean", "example": false } }, "type": "object" }, "NdfUserState": { "type": "string", "enum": [ "TO_BE_PROCESSED", "VALID", "ON_ERROR" ] }, "CollaborateurLectureDto": { "title": "Collaborateur (lecture)", "description": "Repr\u00e9sente un collaborateur en lecture", "required": [ "uid", "nom", "prenom", "actif", "identifiant_externe", "date_embauche", "etat", "lecture_seule" ], "properties": { "uid": { "title": "UID du collaborateur", "type": "string", "example": "jwz7m89d" }, "nom": { "title": "Nom", "description": "la modification de cet attribut modifie \u00e9galement le nom de l'utilisateur associ\u00e9", "type": "string", "example": "Passepartout", "maxLength": 50 }, "prenom": { "title": "Pr\u00e9nom", "description": "la modification de cet attribut modifie \u00e9galement le pr\u00e9nom de l'utilisateur associ\u00e9", "type": "string", "example": "Jean", "maxLength": 50 }, "actif": { "title": "Actif", "description": "Cet attribut est directement li\u00e9 \u00e0 l'attribut \"bloqu\u00e9\" de l'utilisateur. Si un collaborateur est actif ou inactif, alors il sera r\u00e9ciproquement d\u00e9bloqu\u00e9 ou bloqu\u00e9 en tant qu'utilisateur", "type": "boolean", "example": true }, "email": { "title": "Adresse email", "description": "la modification de cet attribut modifie \u00e9galement l'email de l'utilisateur associ\u00e9", "type": "string", "example": "jean.passepartout@ma-societe.com", "nullable": true, "maxLength": 255 }, "identifiant_externe": { "title": "Identifiant externe", "type": "string", "example": "00000080", "maxLength": 50 }, "date_embauche": { "title": "Date d'embauche", "description": "Date au format AAAA-MM-JJ", "type": "string", "format": "date", "example": "2015-01-01" }, "date_sortie": { "title": "Date de sortie", "description": "Date au format AAAA-MM-JJ", "type": "string", "format": "date", "example": "2023-12-31", "nullable": true }, "rue": { "title": "Adresse postale (rue)", "type": "string", "example": "10 rue Fr\u00e9d\u00e9ric Mistral", "nullable": true, "maxLength": 255 }, "ville": { "title": "Adresse postale (Ville)", "type": "string", "example": "Lyon", "nullable": true, "maxLength": 100 }, "code_postal": { "title": "Adresse postale (Code postal)", "type": "string", "example": "69000", "nullable": true, "maxLength": 10 }, "pays": { "title": "Adresse postale (Pays)", "type": "string", "example": "France", "nullable": true, "maxLength": 50 }, "code_societe": { "title": "Code de la soci\u00e9t\u00e9", "type": "string", "example": "SIEGE", "nullable": true }, "code_etablissement": { "title": "Code de l'\u00e9tablissement", "type": "string", "example": null, "nullable": true }, "code_rattachement_specif": { "title": "Code de l'\u00e9l\u00e9ment de rattachement sp\u00e9cifique", "type": "string", "example": null, "nullable": true }, "etat": { "$ref": "#/components/schemas/NdfUserState" }, "lecture_seule": { "title": "Lecture seule", "description": "Seuls les collaborateurs cr\u00e9\u00e9s par l'API sont modifiables par l'API", "type": "boolean", "example": false } }, "type": "object" }, "CollaborateurDonneesBancairesLectureDto": { "title": "CollaborateurDonneesBancaires (lecture)", "description": "Repr\u00e9sente les donn\u00e9es bancaires d'un collaborateur en lecture", "required": [ "uid" ], "properties": { "uid": { "title": "UID du collaborateur", "type": "string", "example": "jwz7m89d" }, "bic": { "title": "BIC", "type": "string", "nullable": true, "maxLength": 11 }, "iban": { "title": "IBAN", "type": "string", "nullable": true, "maxLength": 34 } }, "type": "object" }, "SousCategorieGroupeValideur": { "type": "string", "enum": [ "valideur-fonction-1", "valideur-fonction-2", "valideur-fonction-3", "valideur-fonction-4", "valideur-fonction-5", "valideur-fonction-6" ] }, "FonctionValidationDto": { "title": "FonctionValidation", "description": "Param\u00e9trage des fonctions de validation permettant de qualifier les groupes de valideurs", "required": [ "code" ], "properties": { "code": { "$ref": "#/components/schemas/SousCategorieGroupeValideur" }, "libelle": { "title": "Libell\u00e9", "type": "string", "example": "Valideur N+1", "nullable": true, "maxLength": 255 } }, "type": "object" }, "GroupeValideursDto": { "title": "GroupeValideurs", "description": "Repr\u00e9sente un groupe de valideurs", "required": [ "code", "libelle" ], "properties": { "fonction_validation": { "title": "Fonction de validation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FonctionValidationDto" } ] }, "code": { "title": "Code", "type": "string", "example": "valideurs-equipe-xxx", "maxLength": 50 }, "libelle": { "title": "Libell\u00e9", "type": "string", "example": "Valideurs \u00e9quipe XXX", "maxLength": 255 } }, "type": "object" }, "DonneeComplementaireLectureDto": { "title": "DonneeComplementaire (lecture)", "description": "Repr\u00e9sente une donn\u00e9e compl\u00e9mentaire d'un collaborateur en lecture", "required": [ "cle" ], "properties": { "cle": { "title": "Cl\u00e9 permettant d'identifier le type de donn\u00e9e compl\u00e9mentaire", "type": "string", "example": "ticket-resto" }, "valeur": { "title": "Valeur de la donn\u00e9e compl\u00e9mentaire", "type": "string", "example": "O", "nullable": true, "maxLength": 100 } }, "type": "object" }, "GroupeUtilisateursDto2": { "title": "GroupeUtilisateurs", "description": "Repr\u00e9sente un groupe d'utilisateurs", "required": [ "libelle" ], "properties": { "libelle": { "title": "Libell\u00e9", "type": "string", "example": "Valideurs \u00e9quipe XXX", "maxLength": 255 } }, "type": "object" }, "UtilisateurLectureDto": { "title": "Utilisateur (lecture)", "description": "Repr\u00e9sente un utilisateur en lecture", "required": [ "uid", "login", "bloque", "nom", "prenom", "uniquement_sso", "uid_collaborateur", "lecture_seule" ], "properties": { "uid": { "title": "UID de l'utilisateur", "type": "string", "example": "7250mydD" }, "login": { "title": "Login", "description": "Identifiant unique parmi tous les utilisateurs de Phileas Gestion (l'adresse email peut \u00eatre utilis\u00e9e comme login)", "type": "string", "example": "jean.passepartout@ma-societe.com", "maxLength": 64 }, "bloque": { "title": "Bloqu\u00e9", "description": "Cet attribut est directement li\u00e9 \u00e0 l'attribut \"actif\" du collaborateur. Si un utilisateur est bloqu\u00e9 ou d\u00e9bloqu\u00e9, alors il sera r\u00e9ciproquement inactif ou actif en tant que collaborateur", "type": "boolean", "example": true }, "nom": { "title": "Nom", "description": "la modification de cet attribut modifie \u00e9galement le nom du collaborateur associ\u00e9", "type": "string", "example": "Passepartout", "maxLength": 50 }, "prenom": { "title": "Pr\u00e9nom", "description": "la modification de cet attribut modifie \u00e9galement le pr\u00e9nom du collaborateur associ\u00e9", "type": "string", "example": "Jean", "maxLength": 50 }, "email": { "title": "Adresse email", "description": "la modification de cet attribut modifie \u00e9galement l'email du collaborateur associ\u00e9", "type": "string", "example": "jean.passepartout@ma-societe.com", "nullable": true, "maxLength": 255 }, "locale": { "title": "Langue", "example": "fr_FR", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Locale" } ] }, "uniquement_sso": { "title": "Uniquement SSO", "description": "Indique si l'utilisateur se connecte uniquement en SSO", "type": "boolean", "example": false }, "uid_collaborateur": { "title": "UID du collaborateur associ\u00e9", "description": "L'association d'un collaborateur \u00e0 un utilisateur habilite l'utilisateur sur le r\u00f4le \"Collaborateur\"", "type": "string", "example": "jwz7m89d", "uniqueItems": true }, "lecture_seule": { "title": "Lecture seule", "description": "Seuls les utilisateurs cr\u00e9\u00e9s par l'API sont modifiables par l'API", "type": "boolean", "example": false } }, "type": "object" }, "PopulationLectureDto": { "title": "Population (lecture)", "description": "Repr\u00e9sente une population de collaborateurs", "required": [ "uid", "code", "libelle" ], "properties": { "uid": { "title": "UID de la population", "type": "string", "example": "jwz7m89d" }, "code": { "title": "Code", "type": "string", "example": "LYON", "maxLength": 45 }, "libelle": { "title": "Libelle", "type": "string", "example": "Collaborateurs des \u00e9tablissements lyonnais", "maxLength": 255 } }, "type": "object" }, "TypeNoteLectureDto": { "title": "TypeNote (lecture)", "description": "Repr\u00e9sente un type de note de frais", "required": [ "uid", "code", "libelle" ], "properties": { "uid": { "title": "UID du type de note", "type": "string", "example": "jwz7m89d" }, "code": { "title": "Code", "type": "string", "example": "hebergement", "maxLength": 45 }, "libelle": { "title": "Libell\u00e9", "type": "string", "example": "H\u00e9bergement", "maxLength": 2048 } }, "type": "object" }, "DonneeComplementaireDefDto": { "title": "DonneeComplementaireDef", "description": "D\u00e9finition d'une donn\u00e9e compl\u00e9mentaire", "required": [ "cle", "libelle" ], "properties": { "cle": { "title": "Cl\u00e9 permettant d'identifier un type de donn\u00e9e compl\u00e9mentaire", "type": "string", "example": "eligible-ticket-resto", "maxLength": 50 }, "libelle": { "title": "Libell\u00e9 du type de donn\u00e9e compl\u00e9mentaire", "type": "string", "example": "Eligible aux tickets restaurant (O/N)", "maxLength": 255 }, "description": { "title": "Description du type de donn\u00e9e compl\u00e9mentaire", "type": "string", "example": "Permet de cr\u00e9er des populations de collaborateurs en fonction de leur \u00e9ligibilit\u00e9 aux tickets restaurant", "nullable": true, "maxLength": 1000 } }, "type": "object" }, "LocaleDto": { "title": "Langue", "description": "Liste des langues accept\u00e9es pour la localisation (Ex: fr_FR, en_GB)", "required": [ "code" ], "properties": { "code": { "$ref": "#/components/schemas/Locale" } }, "type": "object" }, "RattachementNatureDto": { "title": "RattachementNature", "description": "Param\u00e9trage des natures de rattachement sp\u00e9cifiques (Ex: Territoire, d\u00e9partement...)", "required": [ "code", "libelle" ], "properties": { "code": { "title": "Code", "type": "string", "example": "territoire" }, "libelle": { "title": "Libell\u00e9", "type": "string", "example": "Territoire", "maxLength": 255 } }, "type": "object" }, "EtablissementLectureDto": { "title": "Etablissement (lecture)", "description": "Repr\u00e9sente un \u00e9tablissement en lecture", "required": [ "code", "libelle" ], "properties": { "code": { "title": "Code", "type": "string", "example": "LYON_1", "maxLength": 10, "uniqueItems": true }, "libelle": { "title": "Libell\u00e9", "type": "string", "example": "Etablissement Lyon 1", "maxLength": 255 }, "rue": { "title": "Adresse postale (rue)", "type": "string", "example": "10 rue Fr\u00e9d\u00e9ric Mistral", "nullable": true, "maxLength": 255 }, "ville": { "title": "Adresse postale (Ville)", "type": "string", "example": "Lyon", "nullable": true, "maxLength": 100 }, "code_postal": { "title": "Adresse postale (Code postal)", "type": "string", "example": "69000", "nullable": true, "maxLength": 10 }, "pays": { "title": "Adresse postale (Pays)", "type": "string", "example": "France", "nullable": true, "maxLength": 50 }, "archive": { "title": "Permet l'archivage d'un \u00e9l\u00e9ment", "type": "boolean", "example": false, "nullable": true, "default": false } }, "type": "object" }, "RattachementSpecifLectureDto": { "title": "RattachementSpecif (lecture)", "description": "Repr\u00e9sente un \u00e9l\u00e9ment de rattachement de type sp\u00e9cifique en lecture (Ex: Territoire, d\u00e9partement...)", "required": [ "code", "libelle" ], "properties": { "code": { "title": "Code", "type": "string", "example": "TER_001", "maxLength": 10, "uniqueItems": true }, "libelle": { "title": "Libell\u00e9", "type": "string", "example": "Territoire 001", "maxLength": 255 }, "archive": { "title": "Permet l'archivage d'un \u00e9l\u00e9ment", "type": "boolean", "example": false, "nullable": true, "default": false } }, "type": "object" }, "SocieteLectureDto": { "title": "Societe (lecture)", "description": "Repr\u00e9sente une soci\u00e9t\u00e9 en lecture", "required": [ "code", "libelle" ], "properties": { "code": { "title": "Code", "type": "string", "example": "SIEGE", "maxLength": 10, "uniqueItems": true }, "libelle": { "title": "Libell\u00e9", "type": "string", "example": "Ma soci\u00e9t\u00e9", "maxLength": 255 }, "archive": { "title": "Permet l'archivage d'un \u00e9l\u00e9ment", "type": "boolean", "example": false, "nullable": true, "default": false } }, "type": "object" }, "UtilisateurHabilitationsDto": { "title": "Habilitations d'un utilisateur", "description": "Repr\u00e9sente les habilitations d'un utilisateur", "required": [ "est_collaborateur", "est_valideur", "est_gestionnaire", "est_expert" ], "properties": { "est_collaborateur": { "title": "Habilitation du collaborateur sur le r\u00f4le \"collaborateur\"", "type": "boolean", "example": true }, "est_valideur": { "title": "Habilitation du collaborateur sur le r\u00f4le \"valideur\"", "type": "boolean", "example": true }, "est_gestionnaire": { "title": "Habilitation du collaborateur sur le r\u00f4le \"gestionnaire\"", "type": "boolean", "example": true }, "est_expert": { "title": "Habilitation du collaborateur sur le r\u00f4le \"expert\"", "type": "boolean", "example": false } }, "type": "object" }, "SingleAnalyticAllocationFieldDto": { "description": "Affectation analytique simple : un code porte implicitement 100 %, sans pourcentage dans le contrat.", "required": [ "id", "expense_definition_detail_id", "expense_element_number", "expense_element_id" ], "properties": { "id": { "type": "string", "example": "definition-1234" }, "expense_definition_detail_id": { "type": "string", "example": "1234" }, "expense_element_number": { "type": "integer", "example": 12 }, "expense_element_id": { "type": "integer", "example": 18 }, "value": { "type": "string", "example": "S603", "nullable": true } }, "type": "object" }, "AnalyticAllocationFieldDto": { "description": "Champ agr\u00e9g\u00e9 de r\u00e9partition analytique expos\u00e9 dans detail_fields.", "required": [ "id", "label", "type", "value", "required", "writable", "visible" ], "properties": { "id": { "type": "string", "example": "analytic-allocations" }, "label": { "type": "string", "example": "R\u00e9partition analytique" }, "type": { "type": "string", "example": "analytic_allocations", "enum": [ "analytic_allocations" ] }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/AnalyticAllocationDto" }, "maxItems": 5 }, "required": { "type": "boolean" }, "writable": { "type": "boolean" }, "visible": { "type": "boolean" } }, "type": "object" }, "ErrorDetailDto": { "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "default": [], "additionalProperties": { "nullable": true } } }, "type": "object" }, "ErrorResponseDto": { "required": [ "error" ], "properties": { "error": { "$ref": "#/components/schemas/ErrorDetailDto" } }, "type": "object" }, "ReformClubEtatDto": { "required": [ "service", "statut", "date_verification" ], "properties": { "service": { "type": "string" }, "statut": { "type": "string" }, "date_verification": { "type": "string", "format": "date-time" } }, "type": "object" }, "BootstrapCurrentUserDto": { "required": [ "id", "full_name", "email", "need_reset_password", "role", "avatar_initials", "preferred_locale", "habilitations" ], "properties": { "id": { "type": "string" }, "full_name": { "type": "string" }, "email": { "type": "string" }, "need_reset_password": { "type": "boolean" }, "role": { "type": "string" }, "avatar_initials": { "type": "string", "maxLength": 4, "minLength": 1 }, "preferred_locale": { "type": "string", "enum": [ "fr_FR", "en_GB" ] }, "habilitations": { "$ref": "#/components/schemas/UtilisateurHabilitationsDto" }, "role_ids": { "type": "array", "items": { "type": "integer" }, "default": [] }, "organization_name": { "type": "string", "nullable": true, "default": null }, "employee_id": { "type": "string", "nullable": true, "default": null } }, "type": "object" }, "BootstrapExpenseAssistantAvailabilityDto": { "required": [ "has_factur_x", "has_corporate_card", "has_mileage_allowance" ], "properties": { "has_factur_x": { "type": "boolean" }, "has_corporate_card": { "type": "boolean" }, "has_mileage_allowance": { "type": "boolean" } }, "type": "object" }, "UserVehicleDto": { "required": [ "fleet_id", "brand", "model", "plate_number", "fiscal_power" ], "properties": { "fleet_id": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "brand": { "type": "string" }, "model": { "type": "string" }, "plate_number": { "type": "string" }, "fiscal_power": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } }, "type": "object" }, "BootstrapDashboardDto": { "required": [ "expense_completion_tasks", "expense_assistant_availability", "mileage_vehicles", "expense_history_entries", "workflow_updates", "validation_conversations", "approval_requests" ], "properties": { "expense_completion_tasks": { "type": "array", "items": { "type": "object", "additionalProperties": { "nullable": true } } }, "expense_assistant_availability": { "$ref": "#/components/schemas/BootstrapExpenseAssistantAvailabilityDto" }, "mileage_vehicles": { "type": "array", "items": { "$ref": "#/components/schemas/UserVehicleDto" } }, "expense_history_entries": { "type": "array", "items": { "type": "object", "additionalProperties": { "nullable": true } } }, "workflow_updates": { "type": "array", "items": { "type": "object", "additionalProperties": { "nullable": true } } }, "validation_conversations": { "type": "array", "items": { "type": "object", "additionalProperties": { "nullable": true } } }, "approval_requests": { "type": "array", "items": { "type": "object", "additionalProperties": { "nullable": true } } } }, "type": "object" }, "ValidatorOptionDto": { "required": [ "duty_id", "can_bypass_rules", "can_edit_expenses", "assignment_type" ], "properties": { "group_id": { "type": "integer", "nullable": true, "minimum": 0, "exclusiveMinimum": true }, "duty_id": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "can_bypass_rules": { "type": "boolean" }, "can_edit_expenses": { "type": "boolean" }, "assignment_type": { "type": "string", "enum": [ "direct_duty", "group_member", "group_backup" ] } }, "type": "object" }, "CurrentUserDataBootstrapResponseDto": { "required": [ "user", "dashboard", "validator_options" ], "properties": { "user": { "$ref": "#/components/schemas/BootstrapCurrentUserDto" }, "dashboard": { "$ref": "#/components/schemas/BootstrapDashboardDto" }, "validator_options": { "type": "array", "items": { "$ref": "#/components/schemas/ValidatorOptionDto" } } }, "type": "object" }, "FeatureFlagsDto": { "required": [ "has_mileage_allowance", "has_electronic_invoices", "has_corporate_card_feed", "has_validator_role", "has_default_vehicle", "can_submit_claims", "can_create_claims" ], "properties": { "has_mileage_allowance": { "type": "boolean" }, "has_electronic_invoices": { "type": "boolean" }, "has_corporate_card_feed": { "type": "boolean" }, "has_validator_role": { "type": "boolean" }, "has_default_vehicle": { "type": "boolean" }, "can_submit_claims": { "type": "boolean" }, "can_create_claims": { "type": "boolean" } }, "type": "object" }, "FeaturesResponseDto": { "required": [ "features" ], "properties": { "features": { "$ref": "#/components/schemas/FeatureFlagsDto" } }, "type": "object" }, "ProfileResponseDto": { "required": [ "id", "full_name", "email", "avatar_initials", "roles", "locale", "theme_mode" ], "properties": { "id": { "type": "string" }, "full_name": { "type": "string" }, "email": { "type": "string" }, "avatar_initials": { "type": "string" }, "avatar_url": { "type": "string", "nullable": true }, "roles": { "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "object", "additionalProperties": { "type": "string" } } ] }, "locale": { "type": "string", "enum": [ "fr", "en" ] }, "theme_mode": { "type": "string", "enum": [ "system", "light", "dark" ] }, "permissions": { "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "object", "additionalProperties": { "type": "string" } } ], "default": [] } }, "type": "object" }, "UpdatePreferencesResponseDto": { "required": [ "preferred_locale", "theme_mode", "updated_at" ], "properties": { "preferred_locale": { "type": "string", "enum": [ "fr_FR", "en_GB" ] }, "theme_mode": { "type": "string", "enum": [ "system", "light", "dark" ] }, "updated_at": { "type": "string" } }, "type": "object" }, "ReceiptLibraryItemDto": { "required": [ "id", "file_name", "file_extension", "content_type", "content_url" ], "properties": { "id": { "type": "string" }, "file_name": { "type": "string" }, "file_extension": { "type": "string" }, "content_type": { "type": "string" }, "scan_date": { "type": "string", "nullable": true }, "content_url": { "type": "string" } }, "type": "object" }, "ReceiptLibraryResponseDto": { "required": [ "items" ], "properties": { "items": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ReceiptLibraryItemDto" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ReceiptLibraryItemDto" } } ] }, "next_offset": { "type": "integer", "nullable": true } }, "type": "object" }, "ReceiptOcrVatDto": { "required": [ "rate", "amount_minor" ], "properties": { "code": { "type": "string", "nullable": true }, "rate": { "type": "number", "format": "float" }, "amount_minor": { "type": "integer" } }, "type": "object" }, "ReceiptOcrDetectedDataDto": { "required": [ "vat_amounts" ], "properties": { "expense_date": { "type": "string", "nullable": true }, "time": { "type": "string", "nullable": true }, "amount_minor": { "type": "integer", "nullable": true }, "currency": { "type": "string", "nullable": true }, "expense_category": { "type": "string", "nullable": true }, "merchant_name": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "postal_code": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "vat_amounts": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ReceiptOcrVatDto" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ReceiptOcrVatDto" } } ] } }, "type": "object" }, "ReceiptOcrResponseDto": { "required": [ "receipt_id", "status" ], "properties": { "receipt_id": { "type": "string" }, "status": { "type": "string" }, "detected_data": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ReceiptOcrDetectedDataDto" } ] } }, "type": "object" }, "LoginExperienceResponseDto": { "type": "object" }, "ResetPasswordRequestDto": { "required": [ "current_password", "new_password" ], "properties": { "current_password": { "type": "string", "maxLength": 4096 }, "new_password": { "type": "string", "maxLength": 4096, "minLength": 12 } }, "type": "object" }, "ResetPasswordResponseDto": { "required": [ "password_reset", "need_reset_password", "updated_at" ], "properties": { "password_reset": { "type": "boolean" }, "need_reset_password": { "type": "boolean" }, "updated_at": { "type": "string" } }, "type": "object" } }, "securitySchemes": { "OAuth2": { "type": "oauth2", "flows": { "clientCredentials": { "scopes": { "utilisateur.lire": "Utilisateurs Phil\u00e9as-Gestion (lecture)", "utilisateur.ecrire": "Utilisateurs Phil\u00e9as-Gestion (\u00e9criture)", "habilitation.lire": "Habilitations accord\u00e9es aux utilisateurs (lecture)", "habilitation.ecrire": "Habilitations accord\u00e9es aux utilisateurs (\u00e9criture)", "habilitation.supprimer": "Habilitations accord\u00e9es aux utilisateurs (suppression)", "collaborateur.lire": "Collaborateurs (lecture)", "collaborateur.ecrire": "Collaborateurs (\u00e9criture)", "collaborateur-donneeBancaire:lire": "Donn\u00e9es bancaires des collaborateurs (lecture)", "collaborateur-donneeBancaire.ecrire": "Donn\u00e9es bancaires des collaborateurs (\u00e9criture)", "societe.lire": "Soci\u00e9t\u00e9s (lecture)", "societe.ecrire": "Soci\u00e9t\u00e9s (\u00e9criture)", "societe.supprimer": "Soci\u00e9t\u00e9s (suppression)", "etablissement.lire": "Etablissements (lecture)", "etablissement.ecrire": "Etablissements (\u00e9criture)", "etablissement.supprimer": "Etablissements (suppression)", "rattachement-specif.lire": "El\u00e9ments de rattachement de type sp\u00e9cifique (lecture)", "rattachement-specif.ecrire": "El\u00e9ments de rattachement de type sp\u00e9cifique (\u00e9criture)", "rattachement-specif.supprimer": "El\u00e9ments de rattachement de type sp\u00e9cifique (suppression)", "referentiel.lire": "R\u00e9f\u00e9rentiel (lecture)", "referentiel.ecrire": "R\u00e9f\u00e9rentiel (\u00e9criture)", "referentiel.supprimer": "R\u00e9f\u00e9rentiel (suppression)", "parametrage.lire": "Param\u00e9trage de l'application Phil\u00e9as-Gestion (lecture)" } } } } } }, "tags": [ { "name": "Utilisateurs", "description": "#### Gestion des utilisateurs Phil\u00e9as-Gestion\n" }, { "name": "Groupes d'utilisateurs", "description": "#### Gestion des habilitations accord\u00e9es aux utilisateurs via les groupes\n" }, { "name": "Collaborateurs", "description": "#### Gestion des collaborateurs\nLa modification des donn\u00e9es d'un collaborateur peut avoir des impacts fonctionnels dans l'application Phil\u00e9as Gestion.
\n*(Voir la description de l'attribut \"etat\" pour plus d'informations.)*\n" }, { "name": "Populations", "description": "#### Gestion des populations de collaborateurs\n" }, { "name": "Soci\u00e9t\u00e9s", "description": "#### Gestion des soci\u00e9t\u00e9s\n" }, { "name": "R\u00e9f\u00e9rentiel", "description": "#### Gestion des r\u00e9f\u00e9rentiels\n" }, { "name": "Param\u00e9trage", "description": "#### Param\u00e9trage de l'application Phil\u00e9as-Gestion\n" }, { "name": "ReformClub" } ] }