Contrats & conformité – plateforme développeur Flowtly

Utilisez cet instantané du schéma OpenAPI de Flowtly pour préparer vos intégrations, automatiser des workflows et synchroniser les données critiques.

Statut de la documentation

Dernière synchronisation : 2024-07-08 12:00 (version de l’app 2.0.0)

Seule une partie des entités est publique. Exécutez les deux commandes de synchronisation lorsque Flowtly publie de nouvelles fonctions.

Contrats & conformité

Gérez contrats, politiques de conservation et achats.

Vue d’ensemble

Contrat

Exposez les métadonnées contractuelles afin que budgets, achats et RH partagent la même source d’information.

Endpoints

GET /api/agreements

Lister les contrats

Récupère les collections Hydra filtrées par type, collaborateur ou statut.

GET /api/agreements/action-needed

Lister les contrats à actionner

Récupère les contrats signalés pour approbation ou données manquantes.

POST /api/agreements

Créer un contrat

Crée un contrat avec données fournisseur/client, cadence de facturation et montant.

GET /api/agreements/{id}

Obtenir un contrat par ID

Lit un contrat précis pour vérifier son statut, sa valeur et les responsables.

PATCH /api/agreements/{id}

Mettre à jour un contrat

Ajuste le statut, les dates ou les responsables d’un contrat.

Cas d’usage

Synchronisez les contrats clients signés depuis votre CLM pour aligner prévisions de revenus et contrôles de conformité.
Poussez les contrats fournisseurs avec plafonds de dépenses pour que la finance surveille les renouvellements automatiquement.

Champs du schéma

Agreement-agreement.read
Champ Type Description
id integer Identifiant interne du contrat dans Flowtly.
employee string | null IRI du collaborateur responsable.
type string Type de contrat (fournisseur, client, emploi).
variant string Sous-type personnalisé utilisé dans vos automatisations.
amount number Montant enregistré (net ou brut).
minutesPerWeek integer Minutes prévues par semaine.
jobSize integer Taille de poste utilisée pour les prévisions.
amountType string Indique si la somme est nette ou brute.
billingType string Fréquence de facturation (mensuelle, horaire…).
positionName string | null Libellé libre du poste.
position string | null IRI pointant vers le référentiel de postes.
dateFrom string Date de début de validité.
dateTo string | null Date de fin (facultative).
currency string Référence de devise utilisée pour les montants.
cost string | null IRI du coût associé.
active boolean Indique si Flowtly considère le contrat actif.
hoursPerWeek integer Heures prévues par semaine.
status string Statut du workflow (draft, active…).

Exemples

POST /api/agreements

Enregistrer un contrat fournisseur

Crée un contrat fournisseur récurrent et le relie au collaborateur responsable ainsi qu’à la référence de devise dans Flowtly.

Charge utile de la requête 
{
    "employee": "/api/employees/emp_439",
    "type": "vendor",
    "variant": "software",
    "amount": 18500,
    "currency": "/api/currencies/EUR",
    "dateFrom": "2024-07-01T00:00:00+00:00",
    "dateTo": "2024-12-31T00:00:00+00:00",
    "amountType": "netto",
    "billingType": "per-month",
    "positionName": "Implementation partner",
    "hoursPerWeek": 12
}
Charge utile de la réponse 
{
    "@id": "/api/agreements/agr_Y29H",
    "@type": "Agreement",
    "id": 5021,
    "employee": "/api/employees/emp_439",
    "type": "vendor",
    "variant": "software",
    "amount": 18500,
    "currency": "/api/currencies/EUR",
    "dateFrom": "2024-07-01T00:00:00+00:00",
    "dateTo": "2024-12-31T00:00:00+00:00",
    "amountType": "netto",
    "billingType": "per-month",
    "positionName": "Implementation partner",
    "hoursPerWeek": 12,
    "active": true,
    "status": "draft"
}

Vue d’ensemble

Employé

Créez et gérez des employés pour les affectations, validations et accès.

Endpoints

GET /api/employees

Lister les employés

Récupère les profils employés avec pagination et filtres.

POST /api/employees

Créer un employé

Ajoute un employé avec nom, email et avatar optionnel.

GET /api/employees/{id}

Obtenir un employé par ID

Lit un profil employé précis.

PATCH /api/employees/{id}

Mettre à jour un employé

Modifie les informations d’un employé comme le nom ou l’email.

DELETE /api/employees/{id}

Supprimer un employé

Supprime un profil employé.

GET /api/employees/{id}/working-hours-stats/{date}

Statistiques d’heures travaillées

Récupère les statistiques agrégées d’heures pour une date donnée.

Champs du schéma

User-user.read
Champ Type Description
id integer Identifiant interne de l’employé.
email string Adresse email de l’employé.
firstname string Prénom de l’employé.
lastname string Nom de l’employé.
avatarUrl string | null URL de l’avatar de l’employé.
Whatsapp