Browse documentation

April 2026

API Simplification – April 2026

Cashytics is live with our 8 core endpoints (cashflow-health-score, forecast-30d-cash-position, liquidity-runout-forecast, simulated-scenario-runner, ar-aging-accelerator, burn-rate-optimizer, distress-early-warning, early-payment-discount-leak)—one envelope, one predictable JSON shape on every success, and clear errors when a path is not supported.

Unsupported slugs receive HTTP 410 Gone, a structured unknown_endpoint body, and a Warning header so clients can retarget without guesswork.

Why eight focused routes

  • Focus — one POST answers one cash question; fewer paths mean faster reviews and cleaner ownership in your codebase.
  • Lower latency — a compact surface keeps responses steady for dashboards and jobs (target <800ms on typical books).
  • Higher value per call — each route returns structured fields you can wire directly into product, risk, and finance workflows without chasing overlapping micro-responses.

Neutral mapping guidance

Most cash questions you used to spread across several calls now resolve through one of three entry points: cashflow-health-score for a composite health read, forecast-30d-cash-position for a forward balance view, or simulated-scenario-runner when you need explicit knobs on the same envelope.

The full live surface is exactly the eight slugs above—add liquidity-runout-forecast, ar-aging-accelerator, burn-rate-optimizer, distress-early-warning, and early-payment-discount-leak when those outcomes match the question you are shipping.

Before / after

The JSON envelope is the same for every supported slug. Only the path changes between the eight live routes—or triggers a migration response when the slug is not one of them.

Unsupported slug → 410 Gone

POST /api/v1/<unsupported-slug>
Authorization: Bearer cyt_live_…
Content-Type: application/json

{ "account_id": "…", "transactions": [ … ], "balances": { … } }

HTTP/1.1 410 Gone
Warning: 299 - "Cashytics: unknown or retired API slug; see https://www.cashytics.com/docs/migration"

{
  "error": "unknown_endpoint",
  "message": "This endpoint was retired as part of our focus on the 8 core cash flow intelligence endpoints.",
  "available_endpoints": [
    "cashflow-health-score",
    "forecast-30d-cash-position",
    "liquidity-runout-forecast",
    "simulated-scenario-runner",
    "ar-aging-accelerator",
    "burn-rate-optimizer",
    "distress-early-warning",
    "early-payment-discount-leak"
  ],
  "migration_guide": "https://www.cashytics.com/docs/migration",
  "note": "Old endpoints will be permanently removed soon. Contact support if you need help migrating."
}

Supported slug → 200 (example: cashflow-health-score, same envelope)

POST /api/v1/cashflow-health-score
Authorization: Bearer cyt_live_…
Content-Type: application/json

{ "account_id": "…", "transactions": [ … ], "balances": { … } }

HTTP/1.1 200 OK

{
  "endpoint": "cashflow-health-score",
  "account_id": "…",
  "processing": { "mode": "ephemeral", "note": "…" },
  "structured": { "score": 0, "drivers": { … } },
  "narrative": "…"
}

Canonical migration_guide URL in errors: https://www.cashytics.com/docs/migration

Our 8 core endpoints

POST /api/v1/cashflow-health-score

Composite 0–100 score summarizing real-time cash health — your primary conversion endpoint.

Route guide →

POST /api/v1/forecast-30d-cash-position

Linear projection of net cash thirty days forward with a confidence band.

Route guide →

POST /api/v1/liquidity-runout-forecast

Calendar-time path to zero cash and the 30-day funding gap if recent daily net continues — treasury-grade triage in one response.

Route guide →

POST /api/v1/simulated-scenario-runner

Deterministic stress / upside scenarios against the supplied envelope.

Route guide →

POST /api/v1/ar-aging-accelerator

Prioritized collection list across AR buckets.

Route guide →

POST /api/v1/burn-rate-optimizer

Observed monthly burn with ranked reduction opportunities by category.

Route guide →

POST /api/v1/distress-early-warning

Composite early warning rail with tripped structural signals.

Route guide →

POST /api/v1/early-payment-discount-leak

Discounts suppliers already offered that finance rarely captures — dollars and AP clerk hours to reclaim them.

Route guide →

Quickstart · Endpoints index