CashflowPot

Retrieve the saved source properties of one active activity in an accessible project. Returns timing, costs and billing parameters without changing the activity.

get_activity

List available Work activity categories and their backend forecasting presets, including cost-distribution and billing parameters. Returns guidance for creating activities; no project data is changed.

get_activity_types

Retrieve the complete forecast scenario for detailed activity, financing and period-by-period analysis. Includes all properties and arrays. For funding requirements, financing comparisons or contract negotiation, prefer get_cashflow_results with detail=summary. Read-only.

get_cashflow

Retrieve one accessible project and compact summaries of its active forecast scenarios. Use scenario IDs to request detailed properties or calculated results.

get_cashflow_project

Determine project funding needs, compare financing costs and evaluate payment terms for contract negotiations. Default detail=summary returns authoritative KPIs and compact Cashflow Properties without arrays or activity definitions. Set detail=full for period analysis, charts or complete properties. Read-only.

get_cashflow_results

Retrieve one financing definition by its scenario-local ID, including rates, fees, schedules and limits. May assign and persist missing legacy facility IDs before lookup; financial properties are retained.

get_financing_facility

Permanently delete the identified activity and recalculate its parent scenario. This cannot be undone. Requires confirm_permanent=true after explicit user authorization.

hard_delete_activity

Permanently delete the identified forecast scenario, all its activities and embedded financing definitions. This cannot be undone. Requires confirm_permanent=true after explicit user authorization.

hard_delete_cashflow

Permanently delete the identified project, all its scenarios, their activities and embedded financing definitions. This cannot be undone. Requires confirm_permanent=true after explicit user authorization.

hard_delete_cashflow_project

Import a version-1 CashflowPot source document as a new scenario in the selected project. The backend validates inputs, resolves omitted defaults and recalculates results. Existing scenarios are retained; retrying creates another copy.

import_cashflow_json

List projects accessible to the connected user, with scenario IDs and names. Supports pagination; returns compact summaries without activity arrays.

list_cashflow_projects

List soft-deleted activities in the selected forecast scenario, including IDs and saved properties needed to choose items to restore. Permanently deleted activities are unavailable.

list_deleted_activities

List saved financing definitions for the selected scenario, including costs, limits and repayment methods. May assign and persist stable IDs to legacy facilities missing them; does not alter financial properties.

list_financing_facilities

List editable financing product presets and their illustrative interest and fixed-fee modeling defaults. Rates are per model period, not bank quotations. Does not modify project data.

list_financing_facility_presets

Restore the selected deleted activities within the accessible project and recalculate affected scenarios. Each parent scenario is permission checked; does not recover permanently deleted activities.

restore_activities

Restore one soft-deleted activity and recalculate its scenario including it. Permanently deleted activities cannot be recovered; project edit permission is required.

restore_activity

Restore a soft-deleted forecast scenario to its project. Retains the saved activities and financing definitions; permanently deleted scenarios cannot be restored.

restore_cashflow

Reactivate a previously deactivated project, retaining its saved scenarios and activities. Requires permission to restore that project; does not recover permanently deleted data.

restore_cashflow_project

Replace the scenario facility order and set sweep repayment priorities to that order, then recalculate. Supply every current facility ID exactly once; ordering can change funding and repayment results.

set_financing_facility_order

Change supplied source properties of one active activity and return the recalculated scenario. Omitted fields are retained; supplied values overwrite current timing, costs or billing properties. mobilization_period is the optional pre-work/no-work delay (0 for new activities by default); changing it shifts actual work without changing duration.

update_activity

Model how changes in advance, retention, payment delay or other contract/forecast properties affect funding needs. Supplied fields overwrite saved values; omitted fields are retained. Returns recalculated results; activity and facility edits have separate tools.

update_cashflow

Change the selected project name, description or color. Supplied fields overwrite current metadata; omitted fields are retained. Does not change scenario contract terms.

update_cashflow_project

Change one modeled financing facility and recalculate the forecast. Supplied fields overwrite its definition and omitted fields are retained. Rates are per model period; fees are fixed currency amounts. No bank transaction occurs.

update_financing_facility