Contratos y cumplimiento – 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.

Contratos y cumplimiento

Gestiona contratos, retención y procesos de compras.

Resumen de la entidad

Acuerdo

Expón los metadatos de contratos para que presupuestos, compras y RR. HH. trabajen sobre la misma fuente de datos.

Endpoints

GET /api/agreements

Listar acuerdos

Recupera colecciones Hydra con filtros sobre tipo, empleado o estado.

GET /api/agreements/action-needed

Listar acuerdos con acciones pendientes

Recupera acuerdos marcados por aprobaciones o datos faltantes.

POST /api/agreements

Crear acuerdo

Publica un nuevo acuerdo con metadatos del proveedor/cliente y parámetros de facturación.

GET /api/agreements/{id}

Obtener acuerdo por ID

Consulta un acuerdo específico para revisar estado, valor y responsables.

PATCH /api/agreements/{id}

Actualizar acuerdo

Actualiza estado, fechas o responsables de un acuerdo.

Casos de uso

Sincroniza contratos firmados desde tu CLM para alinear previsiones de ingresos y revisiones de compliance.
Empuja acuerdos de proveedores con topes de gasto para que finanzas controle renovaciones de forma automática.

Campos del esquema

Agreement-agreement.read
Campo Tipo Descripción
id integer Identificador interno del contrato en Flowtly.
employee string | null IRI del empleado responsable.
type string Tipo de contrato: proveedor, cliente o empleo.
variant string Subtipo personalizado usado en automatizaciones.
amount number Importe registrado para el contrato (neto o bruto).
minutesPerWeek integer Minutos previstos por semana.
jobSize integer Tamaño de puesto utilizado en la planificación.
amountType string Indica si el importe es neto o bruto.
billingType string Frecuencia de facturación (mensual, por hora, etc.).
positionName string | null Etiqueta de puesto en texto libre.
position string | null IRI que apunta al registro estándar de puestos.
dateFrom string Fecha de inicio de la vigencia.
dateTo string | null Fecha fin (puede ser nula).
currency string Referencia de moneda usada en los importes.
cost string | null IRI del coste asociado.
active boolean Indica si Flowtly considera el contrato activo.
hoursPerWeek integer Horas previstas por semana.
status string Estado del workflow (draft, active…).

Ejemplos

POST /api/agreements

Registrar un acuerdo con proveedor

Crea un contrato de suscripción con proveedor y lo asocia al empleado responsable y a la referencia de moneda en Flowtly.

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

Resumen de la entidad

Empleado

Crea y gestiona empleados para asignaciones, aprobaciones y acceso.

Endpoints

GET /api/employees

Listar empleados

Recupera perfiles de empleados con paginación y filtros.

POST /api/employees

Crear empleado

Añade un empleado con nombre, email y avatar opcional.

GET /api/employees/{id}

Obtener empleado por ID

Consulta un perfil de empleado concreto.

PATCH /api/employees/{id}

Actualizar empleado

Actualiza datos como nombre o email del empleado.

DELETE /api/employees/{id}

Eliminar empleado

Elimina un perfil de empleado.

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

Estadísticas de horas trabajadas

Recupera estadísticas agregadas de horas para una fecha dada.

Campos del esquema

User-user.read
Campo Tipo Descripción
id integer Identificador interno del empleado.
email string Correo electrónico del empleado.
firstname string Nombre del empleado.
lastname string Apellidos del empleado.
avatarUrl string | null URL del avatar del empleado.
Whatsapp