Budgets & dépenses – 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.

Budgets & dépenses

Pilotez plans financiers, allocations et transactions.

Vue d’ensemble

Budget

Exposez les budgets Flowtly à vos outils financiers pour garder les limites et alertes alignées.

Endpoints

GET /api/budgets

Lister les budgets

Récupère des budgets paginés avec filtres par type ou période.

POST /api/budgets

Créer un budget

Crée un budget avec fenêtre temporelle, groupe et options.

GET /api/budgets/{id}

Obtenir un budget par ID

Consulte les détails et allocations d’un budget.

PATCH /api/budgets/{id}

Mettre à jour un budget

Ajuste les dates, la granularité ou la configuration d’un budget.

DELETE /api/budgets/{id}

Supprimer un budget

Supprime un budget qui ne doit plus être suivi.

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.

Cas d’usage

Créez des centres de coûts annuels dans l’ERP et synchronisez les limites vers Flowtly.
Synchronisez les budgets marketing afin d’arrêter la dépense quand Flowtly déclenche une alerte.

Champs du schéma

Budget-budget.read_budget_employee.read
Champ Type Description
id string Identifiant unique du budget.
name string Nom du budget affiché aux utilisateurs.
type string Portée du budget (global ou employé).
granularity string Granularité de reporting, par exemple mensuelle.
budgetGroup string | null IRI du groupe budgétaire.
dateFrom string | null Début de la fenêtre de validité.
dateTo string | null Fin de la fenêtre de validité.
config array Options activées comme les alertes de dépense.
budgetEmployees array Collaborateurs rattachés au budget.

Exemples

POST /api/budgets

Créer un budget marketing global

Met en place le budget FY25 lié à son groupe avec alertes automatiques.

Charge utile de la requête 
{
    "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"
    ]
}
Charge utile de la réponse 
{
    "@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"
    ]
}

Vue d’ensemble

Transaction budgétaire

Partagez les données de dépense pour que achats et Flowtly utilisent les mêmes montants.

Endpoints

GET /api/budget-transactions

Lister les transactions budgétaires

Récupère le journal des événements financiers d’un budget.

POST /api/budget-transactions

Créer une transaction budgétaire

Lie une transaction externe et, si besoin, le collaborateur responsable.

GET /api/budget-transactions/{id}

Obtenir une transaction budgétaire

Consulte une transaction liée à un budget pour vérifier son impact.

PATCH /api/budget-transactions/{id}

Mettre à jour une transaction budgétaire

Ajuste le budget lié, le collaborateur ou le montant enregistré.

DELETE /api/budget-transactions/{id}

Supprimer une transaction budgétaire

Supprime un lien de transaction budgétaire incorrect.

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.

Cas d’usage

Poussez les paiements de factures depuis la compta afin que Flowtly reflète la dépense réelle.
Associez les coûts RH ou fournisseurs au budget dès leur approbation.

Champs du schéma

BudgetTransaction-budget_transaction.read_transaction.read
Champ Type Description
budget string IRI du budget concerné.
transaction object IRI de la transaction ERP d’origine.
employee string | null Collaborateur associé à la dépense (facultatif).
amount integer | null Montant imputé au budget.

Exemples

POST /api/budget-transactions

Lier une transaction ERP à un budget

Associe une facture fournisseur au budget FY25 et enregistre le propriétaire.

Charge utile de la requête 
{
    "budget": "/api/budgets/bgt_fy25",
    "transaction": "/api/transactions/txn_904",
    "employee": "/api/employees/emp_777",
    "amount": 125000
}
Charge utile de la réponse 
{
    "@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