Compute projection

GET /api/v1/cfo-projection/scenarios/{scenario_id}/projection

Compute a full N-month projected income statement from scenario drivers.

Operation ID: compute_projection_api_v1_cfo_projection_scenarios__scenario_id__projection_get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

scenario_id string required

Responses

200 Successful Response

Schema: ProjectionResponse

scenario_id string required
months array · string required

Projected month labels

revenue ProjectionSection requiredProjectionSection
4 fields
label string required
items array · ProjectionLineItem requiredProjectionLineItem
total array · integer required

Section total per month in cents

grand_total integer
cogs ProjectionSection requiredProjectionSection
4 fields
label string required
items array · ProjectionLineItem requiredProjectionLineItem
total array · integer required

Section total per month in cents

grand_total integer
gross_profit array · integer required
opex ProjectionSection requiredProjectionSection
4 fields
label string required
items array · ProjectionLineItem requiredProjectionLineItem
total array · integer required

Section total per month in cents

grand_total integer
operating_income array · integer required
other_income array · ProjectionOtherLineItem ProjectionOtherLineItem
5 fields
ledger_id string
name string required
data array · integer required

Projected amounts in cents, per month

total integer

Sum across all months

neg boolean

True if expense (negative in net calc)

other_expense array · ProjectionOtherLineItem ProjectionOtherLineItem
5 fields
ledger_id string
name string required
data array · integer required

Projected amounts in cents, per month

total integer

Sum across all months

neg boolean

True if expense (negative in net calc)

other_net array · integer required
pre_tax_income array · integer required
tax array · integer required
net_income array · integer required
gross_margin_pct array · number required
operating_margin_pct array · number required
net_margin_pct array · number required

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError
5 fields
loc array · string | integer required
msg string required
type string required
input object
ctx object