Saltar al contenido principal

kobana finance cash-flow

Obtener la proyección de flujo de caja

Comandos de kobana finance cash-flow. Toda opción global (Opciones globales) vale aquí.

ComandoHTTPDescripción
cash-flowGET /v1/cash-flowObtener la proyección de flujo de caja

cash-flow​

Obtener la proyección de flujo de caja

kobana finance cash-flow [OPCIONES]

GET /v1/cash-flow

Returns the cash-flow projection for the workspace tied to the token: a series of time buckets (realised + projected income/expenses, running balance) plus current_balance, the today_bucket seam and retroactive_overdue. Requires scope finance/cash_flow with access level read. Read-only.

Parámetros de consulta

NombreTipoObligatorioDescripción
fromstringsíWindow start (ISO 8601). Required.
tostringsíWindow end (ISO 8601). Required.
granularitystringnoBucket size. Default month. A range over the per-granularity cap is clipped (truncated: true). Valores: day, week, month, year.
company_idstringnoScope to one company. Omit for the consolidated (all-company) projection.
account_idstringnoScope to one financial account. Omit for all accounts.
tzstringnoIANA time zone that anchors the today seam (e.g. America/Sao_Paulo, the default). Only the seam is tz-aware; bucketing stays UTC. An unrecognized value falls back to the default.

Encabezados

NombreTipoObligatorioDescripción
X-Workspace-IdstringsíWorkspace to act on, as a UUID. The token identifies the organization; this header picks which of its workspaces the request reads or writes. It is checked against the token's organization, so a workspace owned by anyone else answers UNKNOWN_WORKSPACE — the same code as one that does not exist. Omitting it answers WORKSPACE_REQUIRED (400).

Respuestas

HTTPDescripción
200The cash-flow projection.
400Malformed query (missing/invalid from/to, bad granularity, non-uuid scope id, unknown param).
404The company_id or account_id is not in the tenant.