Presupuestos y gasto – 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.

Presupuestos y gasto

Controla planes financieros, asignaciones y transacciones.

Resumen de la entidad

Presupuesto

Expón los presupuestos de Flowtly para que las herramientas financieras mantengan límites y alertas alineados.

Endpoints

GET /api/budgets

Listar presupuestos

Recupera presupuestos paginados con filtros por tipo o fechas.

POST /api/budgets

Crear presupuesto

Publica un presupuesto con ventana de fechas, grupo y banderas de configuración.

GET /api/budgets/{id}

Obtener presupuesto por ID

Consulta los detalles y asignaciones de un presupuesto.

PATCH /api/budgets/{id}

Actualizar presupuesto

Actualiza fechas, granularidad o configuración de un presupuesto.

DELETE /api/budgets/{id}

Eliminar presupuesto

Borra un presupuesto que ya no necesites seguir.

GET /api/budget-contractors

List budget-contractors

Retrieve budget-contractor records.

POST /api/budget-contractors

Create budget-contractor

Create a new budget-contractor mapping.

GET /api/budget-contractors/{id}

Get budget-contractor

Fetch a budget-contractor by ID.

DELETE /api/budget-contractors/{id}

Delete budget-contractor

Remove a budget-contractor mapping.

GET /api/budget-employees

List budget-employees

Retrieve employee budget allocations.

POST /api/budget-employees

Create budget-employee

Create a new budget-employee allocation.

GET /api/budget-employees/{id}

Get budget-employee

Fetch a budget-employee allocation.

DELETE /api/budget-employees/{id}

Delete budget-employee

Remove a budget-employee allocation.

GET /api/budget-groups

List budget-groups

Retrieve budget groups.

POST /api/budget-groups

Create budget-group

Create a new budget group.

GET /api/budget-groups/{id}

Get budget-group

Fetch a budget group by ID.

PATCH /api/budget-groups/{id}

Update budget-group

Patch a budget group.

DELETE /api/budget-groups/{id}

Delete budget-group

Remove a budget group.

GET /api/budget-invoices

List budget-invoices

Retrieve budget-linked invoices.

POST /api/budget-invoices

Create budget-invoice

Create a budget invoice mapping.

GET /api/budget-invoices/{id}

Get budget-invoice

Fetch a budget invoice mapping.

DELETE /api/budget-invoices/{id}

Delete budget-invoice

Remove a budget invoice mapping.

GET /api/budget-projects

List budget-projects

Retrieve project allocations under budgets.

POST /api/budget-projects

Create budget-project

Create a budget-project allocation.

GET /api/budget-projects/{id}

Get budget-project

Fetch a budget-project allocation.

DELETE /api/budget-projects/{id}

Delete budget-project

Remove a budget-project allocation.

Casos de uso

Provisiona centros de coste anuales desde tu ERP y mantén Flowtly actualizado con los límites vigentes.
Sincroniza presupuestos de marketing para que las plataformas de performance detengan el gasto cuando Flowtly avise.

Campos del esquema

Budget-budget.read_budget_employee.read
Campo Tipo Descripción
id string Identificador único del presupuesto.
name string Nombre legible del presupuesto.
type string Alcance del presupuesto (global o por empleado).
granularity string Granularidad de reporting, por ejemplo mes.
budgetGroup string | null IRI del grupo presupuestario.
dateFrom string | null Inicio de la ventana de vigencia.
dateTo string | null Fin de la ventana de vigencia.
config array Opciones activadas, como alertas de gasto.
budgetEmployees array Empleados asignados al presupuesto.

Ejemplos

POST /api/budgets

Crear un presupuesto global de marketing

Configura el presupuesto FY25 enlazado a su grupo con alertas automáticas.

Carga del request 
{
    "name": "EMEA Marketing FY25",
    "type": "global",
    "granularity": "month",
    "dateFrom": "2024-01-01T00:00:00+00:00",
    "dateTo": "2024-12-31T00:00:00+00:00",
    "budgetGroup": "/api/budget-groups/emarketing",
    "config": [
        "spend_alerts",
        "auto-freeze"
    ]
}
Carga de la respuesta 
{
    "@id": "/api/budgets/bgt_fy25",
    "@type": "Budget",
    "id": "bgt_fy25",
    "name": "EMEA Marketing FY25",
    "type": "global",
    "granularity": "month",
    "dateFrom": "2024-01-01T00:00:00+00:00",
    "dateTo": "2024-12-31T00:00:00+00:00",
    "budgetGroup": "/api/budget-groups/emarketing",
    "config": [
        "spend_alerts",
        "auto-freeze"
    ]
}

Resumen de la entidad

Transacción de presupuesto

Comparte datos de gasto para que compras y Flowtly trabajen con los mismos importes.

Endpoints

GET /api/budget-transactions

Listar transacciones de presupuesto

Obtén el libro de movimientos que afectan a un presupuesto.

POST /api/budget-transactions

Crear transacción de presupuesto

Vincula una transacción externa y, si aplica, al empleado responsable.

GET /api/budget-transactions/{id}

Obtener transacción de presupuesto

Consulta una transacción vinculada a un presupuesto para revisar el impacto de gasto.

PATCH /api/budget-transactions/{id}

Actualizar transacción de presupuesto

Ajusta el presupuesto vinculado, el empleado o el importe.

DELETE /api/budget-transactions/{id}

Eliminar transacción de presupuesto

Elimina una vinculación incorrecta de transacción y presupuesto.

GET /api/income-transactions

List income-transactions

Retrieve income transactions.

POST /api/income-transactions

Create income-transaction

Create an income transaction entry.

GET /api/income-transactions/{id}

Get income-transaction

Fetch an income transaction by ID.

PATCH /api/income-transactions/{id}

Update income-transaction

Patch an income transaction entry.

DELETE /api/income-transactions/{id}

Delete income-transaction

Delete an income transaction entry.

GET /api/project-transactions

List project-transactions

Retrieve project transactions.

POST /api/project-transactions

Create project-transaction

Create a project transaction entry.

PATCH /api/project-transactions/{id}

Update project-transaction

Patch a project transaction entry.

DELETE /api/project-transactions/{id}

Delete project-transaction

Delete a project transaction entry.

GET /api/transactions

List transactions

Retrieve generic transactions.

POST /api/transactions

Create transaction

Create a generic transaction.

GET /api/transactions/{id}

Get transaction

Fetch a transaction by ID.

PATCH /api/transactions/{id}

Update transaction

Patch a transaction.

POST /api/transactions/import

Import transactions

Bulk import transactions.

GET /api/transactions/unassigned

List unassigned transactions

Retrieve transactions not yet linked to a budget.

GET /api/transaction-attachments

List transaction-attachments

Retrieve transaction attachments.

POST /api/transaction-attachments

Create transaction-attachment

Create a transaction attachment.

GET /api/transaction-attachments/{id}

Get transaction-attachment

Fetch a transaction attachment by ID.

PATCH /api/transaction-attachments/{id}

Update transaction-attachment

Patch a transaction attachment.

DELETE /api/transaction-attachments/{id}

Delete transaction-attachment

Delete a transaction attachment.

POST /api/transaction-attachments/create

Upload transaction-attachment

Upload a new transaction attachment.

GET /api/transaction-attachments/search

Search transaction-attachments

Search transaction attachments by query.

Casos de uso

Envía pagos de facturas desde contabilidad para reflejar el gasto acumulado en Flowtly.
Asocia gastos de RR. HH. o proveedores al presupuesto nada más aprobarlos.

Campos del esquema

BudgetTransaction-budget_transaction.read_transaction.read
Campo Tipo Descripción
budget string IRI del presupuesto afectado.
transaction object IRI de la transacción original del ERP.
employee string | null Empleado responsable del gasto (opcional).
amount integer | null Importe imputado al presupuesto.

Ejemplos

POST /api/budget-transactions

Vincular una transacción ERP a un presupuesto

Asocia una factura de proveedor al presupuesto FY25 y guarda el owner.

Carga del request 
{
    "budget": "/api/budgets/bgt_fy25",
    "transaction": "/api/transactions/txn_904",
    "employee": "/api/employees/emp_777",
    "amount": 125000
}
Carga de la respuesta 
{
    "@id": "/api/budget-transactions/btr_11",
    "@type": "BudgetTransaction",
    "id": "btr_11",
    "budget": "/api/budgets/bgt_fy25",
    "transaction": "/api/transactions/txn_904",
    "employee": "/api/employees/emp_777",
    "amount": 125000
}
Whatsapp