Budżety i wydatki – platforma deweloperska Flowtly

Korzystaj z kuratowanego wycinka schematu OpenAPI Flowtly, aby planować integracje, automatyzować procesy i synchronizować kluczowe dane.

Status dokumentacji

Ostatnia synchronizacja: 2024-07-08 12:00 (wersja aplikacji 2.0.0)

Publicznie udostępniamy tylko część encji. Po każdej aktualizacji Flowtly uruchom obie komendy synchronizacji, by odświeżyć dane.

Budżety i wydatki

Kontroluj plany finansowe, przydziały i transakcje.

Przegląd encji

Budżet

Udostępniaj budżety Flowtly narzędziom finansowym, aby limity, alerty i akceptacje były zsynchronizowane.

Endpointy

GET /api/budgets

Lista budżetów

Pobierz paginowane budżety z filtrami po typie i datach.

POST /api/budgets

Utwórz budżet

Dodaj budżet z zakresem dat, grupą i flagami konfiguracyjnymi.

GET /api/budgets/{id}

Pobierz budżet po ID

Odczytaj szczegóły budżetu oraz przydziały.

PATCH /api/budgets/{id}

Zaktualizuj budżet

Skoryguj daty, granularność lub konfigurację budżetu.

DELETE /api/budgets/{id}

Usuń budżet

Usuń budżet, którego nie trzeba dalej śledzić.

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.

Przypadki użycia

Twórz roczne centra kosztów w ERP i aktualizuj Flowtly najnowszymi limitami.
Synchronizuj budżety kampanii marketingowych, aby narzędzia performance zatrzymały wydatki przy alertach Flowtly.

Pola schematu

Budget-budget.read_budget_employee.read
Pole Typ Opis
id string Unikalny identyfikator budżetu.
name string Nazwa budżetu widoczna dla użytkowników.
type string Zakres budżetu (globalny lub pracowniczy).
granularity string Granularność raportowania, np. miesiąc.
budgetGroup string | null IRI grupy budżetowej.
dateFrom string | null Początek obowiązywania budżetu.
dateTo string | null Koniec obowiązywania budżetu.
config array Lista włączonych opcji (np. alerty wydatków).
budgetEmployees array Pracownicy przypisani do budżetu.

Przykłady

POST /api/budgets

Utwórz globalny budżet marketingowy

Zakłada budżet FY25 powiązany z grupą i automatycznymi alertami.

Ładunek żądania 
{
    "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"
    ]
}
Ładunek odpowiedzi 
{
    "@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"
    ]
}

Przegląd encji

Transakcja budżetowa

Udostępniaj dane o wydatkach, aby zakupy i Flowtly widziały te same kwoty.

Endpointy

GET /api/budget-transactions

Lista transakcji budżetowych

Pobierz dziennik zdarzeń finansowych wpływających na budżet.

POST /api/budget-transactions

Utwórz transakcję budżetową

Powiąż transakcję i opcjonalnego pracownika z budżetem Flowtly.

GET /api/budget-transactions/{id}

Pobierz transakcję budżetową

Odczytaj transakcję powiązaną z budżetem, aby zobaczyć wpływ na wydatki.

PATCH /api/budget-transactions/{id}

Zaktualizuj transakcję budżetową

Dostosuj powiązany budżet, pracownika lub kwotę.

DELETE /api/budget-transactions/{id}

Usuń transakcję budżetową

Usuń błędne powiązanie transakcji z budżetem.

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.

Przypadki użycia

Przesyłaj płatności faktur z systemu księgowego, by Flowtly pokazywało aktualne zużycie.
Dołączaj koszty HR i vendorów do budżetów natychmiast po zatwierdzeniu.

Pola schematu

BudgetTransaction-budget_transaction.read_transaction.read
Pole Typ Opis
budget string IRI budżetu, którego dotyczy wydatek.
transaction object IRI źródłowej transakcji ERP.
employee string | null Pracownik odpowiedzialny za wydatek (opcjonalnie).
amount integer | null Kwota zaksięgowana na budżet.

Przykłady

POST /api/budget-transactions

Powiąż transakcję ERP z budżetem

Przypisuje fakturę dostawcy do budżetu FY25 i zapisuje właściciela wydatku.

Ładunek żądania 
{
    "budget": "/api/budgets/bgt_fy25",
    "transaction": "/api/transactions/txn_904",
    "employee": "/api/employees/emp_777",
    "amount": 125000
}
Ładunek odpowiedzi 
{
    "@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