Proyectos y entrega – plataforma para desarrolladores de Flowtly

Usa esta instantánea curada del esquema OpenAPI de Flowtly para planear integraciones, automatizar procesos y sincronizar los datos críticos.

Estado de la documentación

Última sincronización: 2024-07-08 12:00 (versión de la app 2.0.0)

Solo exponemos un conjunto limitado de entidades. Ejecuta ambos comandos de sincronización cuando Flowtly lance novedades para actualizar los datos.

Proyectos y entrega

Comparte datos de proyectos, miembros y contexto de facturación.

Resumen de la entidad

Proyecto

Usa los proyectos de Flowtly como referencia única para PMO y finanzas.

Endpoints

GET /api/projects

Listar proyectos

Recupera proyectos filtrando por cliente, estado o tipo contractual.

POST /api/projects

Crear proyecto

Da de alta un proyecto con tipo de facturación, cliente y fechas.

GET /api/projects/{id}

Obtener proyecto por ID

Consulta miembros, divisa y campos clave de un proyecto.

PATCH /api/projects/{id}

Actualizar proyecto

Actualiza metadatos, fechas o tipo de facturación de un proyecto.

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.

Casos de uso

Crea proyectos desde el CRM cuando se gana una oportunidad y prepara la asignación.
Actualiza el ciclo de vida desde herramientas externas para que Flowtly proyecte costes reales.

Campos del esquema

Project-project.read
Campo Tipo Descripción
id integer Identificador interno del proyecto.
client string | null IRI del cliente asociado.
currency string | null Moneda utilizada para el proyecto.
dateFrom string | null Fecha prevista de inicio.
dateTo string | null Fecha prevista de finalización.
name string Nombre del proyecto.
publicDescription string | null Descripción visible para el cliente.
type string Modelo de facturación (precio fijo, T&M, etc.).
clientHash string Identificador del cliente hasheado que usa Flowtly.
notes string | null Notas internas.
color string Color que se muestra en la interfaz.
priceNet string | null Precio neto del proyecto (si existe).
taxGroup string | null IRI del grupo fiscal aplicado.
projectMembers array Lista de miembros (IRIs) asignados.
status string Estado de ciclo de vida del proyecto.
flattenType string Tipo normalizado de proyecto en Flowtly.

Ejemplos

POST /api/projects

Crear el proyecto Aurora Rollout

Añade un proyecto T&M vinculado a un cliente del CRM con fechas planificadas.

Carga del request
{
    "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"
}
Carga de la respuesta
{
    "@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"
}

Resumen de la entidad

Atributo

Crea y gestiona atributos personalizados para ampliar los modelos de Flowtly.

Endpoints

GET /api/attributes

Listar atributos

Recupera atributos con paginación y filtros.

POST /api/attributes

Crear atributo

Define un nuevo atributo con slug, nombre y tipo.

GET /api/attributes/{id}

Obtener atributo por ID

Consulta una definición de atributo específica.

PATCH /api/attributes/{id}

Actualizar atributo

Actualiza nombre o descripción de un atributo.

DELETE /api/attributes/{id}

Eliminar atributo

Elimina una definición de atributo.

Campos del esquema

Attribute-attribute.read
Campo Tipo Descripción
id integer Identificador del atributo.
name string Nombre visible del atributo.
slug string Slug usado para referenciar el atributo.
type string Tipo de dato del atributo.
description string | null Descripción opcional del uso del atributo.
Whatsapp