Start free trial

Get CFO portal summary

GET/api/v1/businesses/{business_id}/cfo-portal/summary
Operation ID: cfo_portal_get_summary_api_v1_businesses__business_id__cfo_portal_summary_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

business_idstringrequired

Query

include_seriesbooleandefault: False

When true, include the 13-week trailing P&L series in data.pulse.weekly_series and run the heavier DB fan-out.

include_weekly_plbooleandefault: True

When true, include the 4-week P&L table rows in data.weekly_pl_rows.

Responses

200Successful Response

Schema: SuccessEnvelope_CfoPortalSectionResponse_

successboolean
messagestring
codestring
dataCfoPortalSectionResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject