Browse documentation

FAQ

Common questions

Quick answers for developers integrating Cashytics. For step-by-step setup, see the Quickstart.

What is Cashytics?

Cashytics is a cashflow intelligence API. You send a normalized JSON envelope (transactions, balances, optional AR/AP blocks) and receive structured scores, forecasts, and action-oriented signals — without storing your ledger as Cashytics's system of record.

How do I try it without an API key?

Open the playground. It calls the same engine as production with sample data — no sign-in, no key, no usage against your monthly quota.

How do I get production API keys?

Sign in with a work email, verify your inbox, then open the dashboard and create a secret starting with cyt_live_. Use it only from your backend — never in mobile apps or public repos.

Which endpoints exist?

The product ships our 8 core endpoints — score → 30-day cash → runway → scenarios → AR → burn → distress → early-pay discount recovery:

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

See the endpoint reference for payloads and playground links per slug.

What JSON do I send?

One shared envelope for every route: account_id, transactions[], balances, plus optional blocks (e.g. ar_aging, payables, scenario) when an endpoint needs them. Details: Envelope schema.

How do I call the API?

POST https://api.cashytics.com/api/v1/<slug> with headers Authorization: Bearer cyt_live_… and Content-Type: application/json. Unknown or retired slugs return 410 Gone with unknown_endpoint and available_endpoints — see API Simplification – April 2026.

Does Cashytics support webhooks or async delivery?

Yes. Pass a webhook_url field in your envelope and the API returns 202 immediately, then POSTs the full response to your URL when ready. See Webhooks & async delivery in the docs.

What are the rate limits?

Successful production calls count toward your workspace's monthly quota. The free plan includes 500 successful calls per UTC month and returns 429 when the cap is reached. Paid Builder and Production plans meter overages instead of hard-stopping traffic — see Errors & limits and Pricing.

Do you store my transactions?

Requests are processed ephemerally for the response. Cashytics does not use your payload as a ledger of record; retention and compliance for customer data remain your responsibility.

Playground vs production — same output?

Same scoring engine. The playground uses POST /api/playground and skips API-key auth and monthly metering so you can demo safely.

Can I call the API from the browser?

Production keys are intended for server-side use. Keep secrets off the client; call Cashytics from your backend or edge worker.

How do I check if the deployment is up?

Use GET /api/health. The payload includes a deployment_ready style signal when the host is fully wired for accounts and metering. You can point external uptime monitors (Uptime Robot, Better Uptime, etc.) at this URL — see Errors & limits.

Magic link didn’t work or expired — what now?

Request a fresh link from the same browser you use to sign in. Email clients that prefetch links can burn one-time tokens — try a private window or paste the link manually. If you still see errors, wait a minute (rate limits) or ask your deployment admin to confirm Supabase email / SMTP settings.

Can I self-host?

Yes — the HTTP contract is the same in your cloud. Your team manages environment variables, Supabase, outbound email for magic links, and uptime on your infrastructure.

Where do I get help?

Start with this FAQ, the Quickstart, and per-endpoint docs. Technical questions: support@cashytics.com. Billing or enterprise: sales@cashytics.com.