Quickstart

From first look to first live call

Start in the playground so everyone sees the same JSON — no key required. When you are ready to wire your product, sign in, create a key, and call the API from a secure server.

The free plan includes 500 successful API calls per UTC month — enough to finish an integration and run real checks.

Our 8 core endpoints

Production traffic must use one of these slugs only (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). Every successful response uses the same top-level keys: endpoint, account_id, processing (ephemeral note), structured, and narrative. If you still have old paths in config, the API returns 410 Gone with error: "unknown_endpoint", available_endpoints, and migration_guide — see API Simplification – April 2026.

/api/v1/cashflow-health-score—Turn messy bank feeds into one 0–100 cash health score in a single POST.
/api/v1/forecast-30d-cash-position—Project where cash lands thirty days out with a defensible confidence band from recent net flow.
/api/v1/liquidity-runout-forecast—Answer when cash hits zero and what funding you need in the next thirty days if trends hold.
/api/v1/simulated-scenario-runner—Stress revenue, opex, and payable timing on the same envelope to compare base, stressed, and upside balances.
/api/v1/ar-aging-accelerator—Rank AR buckets so collections starts with the dollars that move the needle.
/api/v1/burn-rate-optimizer—Surface the top spend categories driving burn so cuts and negotiations line up on one list.
/api/v1/distress-early-warning—Collapse volatility, runway, and drain signals into one composite risk you can alert on.
/api/v1/early-payment-discount-leak—Quantify supplier early-pay discounts you can still capture—and the AP effort to go get them.

Workflow

Preview the output. Open the playground, run cashflow-health-score on the bundled sample book, then switch to forecast-30d-cash-position — same envelope, different slug. Same engine as production — no API key required.
Create a key from your account. Sign in, open the dashboard, and generate a secret starting with cyt_live_. Store it like any other production credential — never in a mobile app or public repo.
Call from your backend. Send the unified envelope documented in Envelope schema. Start with POST /api/v1/cashflow-health-score, then call POST /api/v1/forecast-30d-cash-position with the same JSON — the fastest way to show finance both a health score and a forward cash view while you are still on the free tier.

Copy-ready curl (our 8 core endpoints)

Replace cyt_live_YOUR_SECRET with your dashboard secret. Only the path changes between the eight slugs; the request body stays the same envelope.json. Production base URL: https://api.cashytics.com/api/v1/<slug>.

1 — Cash health score

curl -X POST https://api.cashytics.com/api/v1/cashflow-health-score \
  -H "Authorization: Bearer cyt_live_YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d @envelope.json

2 — Thirty-day cash position (same file)

curl -X POST https://api.cashytics.com/api/v1/forecast-30d-cash-position \
  -H "Authorization: Bearer cyt_live_YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d @envelope.json

Batch & async
Running batch checks? Add webhook_url to your envelope and we'll POST results back when ready — no held connections. See the webhooks guide.

Same call in code

Tabs below show cashflow-health-score with the same envelope shape.

curl -X POST https://api.cashytics.com/api/v1/cashflow-health-score \
  -H "Authorization: Bearer cyt_live_YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d @envelope.json

Self-hosting

Running Cashytics in your own cloud uses the same HTTP contract. Your platform team manages secrets and uptime; your product team consumes the API exactly as documented here.