jolvAPI
jolv.app Open Jolv
API reference / Valuations

Waterfall scenarios

Lists a company's distribution waterfall scenarios (base and alternatives): exit date and value, distributable equity, price per share, dilution method, engine version, linked campaign. The detail of one scenario is served by get_waterfall with scenario_id. Read-only.

GET/v1/list_waterfall_scenarios

Query parameters

  • company_iduuidrequired
    Company UUID.
  • campaign_iduuidoptional
    Campaign UUID (optional): scenarios attached to that campaign.

Response

Status 200, application/json. Resources outside your rights are absent, never an error.

  • scenariosobject[]
    Show child attributes
    • scenario_idstring
      Scenario UUID, to pass to get_waterfall.
    • namestring
    • is_baseboolean
      Base scenario (the one served by get_waterfall without scenario_id).
    • campaign_idstring · nullable
    • as_of_datestring
    • exit_datestring
    • exit_value_eurnumber · nullable
      Exit value retained by the scenario (€).
    • equity_value_eurnumber · nullable
      Distributable equity (€).
    • price_per_share_eurnumber · nullable
    • fully_diluted_sharesnumber · nullable
    • fd_methodstring · nullable
      Dilution method retained.
    • engine_versionstring · nullable
    • computedboolean
      Engine output present (engine_output).
    • created_atstring · nullable

Errors

400 invalid parameter · 401 missing or expired token · 429 too many requests · 500 read failed. See Errors.