Projets & delivery – 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.

Projets & delivery

Partagez les métadonnées projets, les membres et le contexte de facturation.

Vue d’ensemble

Projet

Utilisez les projets Flowtly comme référence unique pour PMO et finance.

Endpoints

GET /api/projects

Lister les projets

Récupère les projets filtrés par client, statut ou contrat.

POST /api/projects

Créer un projet

Crée un projet avec type de facturation, client et planning.

GET /api/projects/{id}

Obtenir un projet par ID

Consulte un projet précis pour voir membres et devise.

PATCH /api/projects/{id}

Mettre à jour un projet

Met à jour les métadonnées, dates ou modèle de facturation d’un projet.

GET /api/projects/preview

Preview projects

Preview project data before creation.

GET /api/projects/search

Search projects

Search projects by filters.

GET /api/projects/{id}/profitability

Get project profitability

Inspect profitability metrics for a project.

Cas d’usage

Créez un projet dès qu’une affaire est gagnée dans le CRM pour préparer le staffing.
Mettez à jour le cycle de vie projet depuis vos outils externes afin d’affiner les prévisions Flowtly.

Champs du schéma

Project-project.read
Champ Type Description
id integer Identifiant interne du projet.
client string | null IRI du client.
currency string | null Devise du projet.
dateFrom string | null Date de début prévue.
dateTo string | null Date de fin prévue.
name string Nom du projet.
publicDescription string | null Description visible par le client.
type string Modèle de facturation (fixed-price, T&M, etc.).
clientHash string Identifiant client haché utilisé par Flowtly.
notes string | null Notes internes.
color string Couleur utilisée dans l’interface.
priceNet string | null Prix net du projet (si renseigné).
taxGroup string | null IRI du groupe de taxes appliqué.
projectMembers array Liste des membres affectés (IRIs).
status string Statut du cycle de vie du projet.
flattenType string Type normalisé du projet dans Flowtly.

Exemples

POST /api/projects

Créer le projet Aurora Rollout

Ajoute un projet T&M lié à un client CRM avec dates prévues.

Charge utile de la requête
{
    "name": "Aurora Rollout",
    "type": "time-and-material",
    "currency": "/api/currencies/EUR",
    "client": "/api/clients/cl_901",
    "dateFrom": "2024-06-01T00:00:00+00:00",
    "dateTo": "2024-12-31T00:00:00+00:00",
    "notes": "Expansion to Germany and France"
}
Charge utile de la réponse
{
    "@id": "/api/projects/prj_aurora",
    "@type": "Project",
    "id": 9821,
    "name": "Aurora Rollout",
    "type": "time-and-material",
    "currency": "/api/currencies/EUR",
    "client": "/api/clients/cl_901",
    "dateFrom": "2024-06-01T00:00:00+00:00",
    "dateTo": "2024-12-31T00:00:00+00:00",
    "status": "active"
}

Vue d’ensemble

Attribut

Créez et gérez des attributs personnalisés pour étendre les modèles Flowtly.

Endpoints

GET /api/attributes

Lister les attributs

Récupère les attributs avec pagination et filtres.

POST /api/attributes

Créer un attribut

Définit un nouvel attribut avec slug, nom et type.

GET /api/attributes/{id}

Obtenir un attribut par ID

Lit une définition d’attribut précise.

PATCH /api/attributes/{id}

Mettre à jour un attribut

Modifie le nom ou la description d’un attribut.

DELETE /api/attributes/{id}

Supprimer un attribut

Supprime une définition d’attribut.

Champs du schéma

Attribute-attribute.read
Champ Type Description
id integer Identifiant de l’attribut.
name string Nom affiché de l’attribut.
slug string Slug utilisé pour référencer l’attribut.
type string Type de données de l’attribut.
description string | null Description optionnelle de l’attribut.
Whatsapp