jolvAPI
jolv.app Open Jolv
API reference / Valuations

Distribution waterfall

Returns a company's persisted waterfall: distributable amount, allocation by layer (debt / preference / ratchet / residual) and by holder. Read-only, output of the V4 engine (no recomputation).

GET/v1/get_waterfall

Query parameters

  • company_iduuidrequired
    Company UUID.
  • campaign_iduuidoptional
    Campaign UUID (optional).

Response

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

  • company_idstring
  • exit_value_eurnumber · nullable
    Distributable equity at exit (€)
  • total_distributed_eurnumber · nullable
  • undistributed_eurnumber · nullable
  • reconciledboolean
    Σ distributions == distributable (gap ≈ 0)
  • by_layerobject[]
    Show child attributes
    • layerstring
    • amount_eurnumber
  • by_holderobject[]
    Show child attributes
    • holderstring
    • amount_eurnumber
  • engine_versionstring · nullable

Errors

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