EIGENN.
docsguidesapichangelogpricingsign in
EIGENN.

Forecasts and Stress Tests API

Compute forecasts, save stress-test scenarios, and read runway through the public metrics and reports contract.

Forecast and stress-test operations are public under /metrics. Runway is public under /reports. Legacy /forecast and /stress-tests paths are not part of v1.

Endpoints

MethodEndpointScopePurpose
POST/metrics/stress-testmetrics.writeRun and save a stress-test scenario
GET/metrics/stress-test/{id}metrics.readRetrieve a saved stress test
POST/metrics/forecast/cash-flowmetrics.writeCompute a cash-flow forecast
GET/metrics/forecast/cash-flowmetrics.readRead a cash-flow forecast
POST/metrics/forecast/revenuemetrics.writeCompute a revenue forecast
GET/metrics/forecast/revenuemetrics.readRead a revenue forecast
GET/reports/runwayreports.readEstimate runway from cash and burn

Forecast Inputs

Forecast requests need:

  • from training start date
  • to training end date
  • horizonMonths from 1 to 60

currency is optional.

GET forecast operations use the same values as query parameters.

Stress-Test Inputs

A stress test needs:

  • from
  • to
  • horizonMonths from 1 to 24

Optional inputs include name, currency, startingCash, and drivers.

Documented drivers include:

  • RevenueShock
  • CollectionDelay
  • ExpenseSurge
  • OneTimeExpense
  • HiringPlan
  • FxShock

Each driver has its own necessary fields and limits. Use the OpenAPI schema. Do not send a generic assumptions object.

Idempotent Computation

POST forecast and stress-test operations accept an optional Idempotency-Key. Use a stable key for the same date window, horizon, currency, and assumptions when you retry an unknown outcome.

Use a new key after you change any input.

Runway

GET /reports/runway needs from and to. It also accepts an optional ISO 4217 currency. It estimates the months of operation that remain from current cash and average burn over the selected period.

Runway is a modeled output. Preserve the input window and the currency with the result. Do not combine currencies without an explicit conversion policy.

Legacy Endpoint Boundary

Replace:

  • POST /forecast with the correct /metrics/forecast operation
  • POST /stress-tests with POST /metrics/stress-test
  • GET /v1/reports/runway remains valid

There is no general scenarios collection in public v1.

Related Pages

  • Stress Tests
  • Runway Stress Test
  • Errors
  • Authentication

Errors

Interpret Eigenn API statuses, optional error fields, request IDs, and safe retry signals.

Invoice Payments API

Connect Stripe for a team, check connection status, and create a payment intent for a customer invoice.

On this page

EndpointsForecast InputsStress-Test InputsIdempotent ComputationRunwayLegacy Endpoint BoundaryRelated Pages

Eigenn docs

current product

Overview
Overview
OverviewAccount PreferencesAssistant AutomationAssistant Command CenterBank ConnectionsBilling and UsageBudgets and ForecastCommand CenterCustomer LifecycleCustomer RecordsCustomersDeveloper PlatformDocument Processing and ExtractionDocument VaultFinancial Analytics and ReportsFinancial OverviewInvoice InsightsInvoice ProductsInvoicesMarketplace IntegrationsNotifications and BrandingOnboarding and SupportOverviewReceivablesReceivables AnalyticsReceivables ControlsSecurity and AccessSettings OverviewStress TestsTeams and OrganizationsTone Profiles and ExperimentsTransaction Categories and RulesTransactionsWeekly Finance RitualWorkflow ExecutionsWorkflow PausesWorkflowsWorkspace Inbox and Approvals
OverviewBuild and Review a ForecastBuild Your First WorkflowConfigure Assistant OperationsConfigure Notifications and BrandingConfigure Receivables ControlsConnect Transaction RecordsCreate and Manage CustomersCreate and Send InvoicesDeveloper API SetupFirst Cash ReviewInvoice Collection WorkflowMaintain Transaction RulesManage Security and BillingManage Team AccessManage the Invoice LifecycleMCP WorkflowsMonitor and Recover WorkflowsOrganize and Share DocumentsProcess Inbox ItemsReconcile and Categorize TransactionsReview a Customer Finance RecordRun a Finance Operating ReviewRun a Receivables Tone ExperimentRun a Runway Stress TestRun Your First Command Center ReviewSet Up a WorkspaceTroubleshoot Account AccessWebhook DeliveryWeekly CFO Review
OverviewIntegrationsMCPSDKsWebhooks
OverviewAuthenticationBank Accounts APICustomers APIErrorsForecasts and Stress Tests APIInvoice Payments APIInvoices APIPaginationRate LimitsRemote Tracker API StatusTracker Categories APITracker Entries and Timers APITracker Projects APITransactions APIWebhooks API StatusWorkflows API Status
Overview
Overview