Ask the CFO portal AI assistant a question

POST/api/v1/businesses/{business_id}/cfo-portal/ask

Operation ID: cfo_portal_ask_api_v1_businesses__business_id__cfo_portal_ask_post·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

Request body

Schema: CfoPortalAskRequest

questionstringrequired
context_sectionstring: Slug of the CFO portal section the user is currently viewing (e.g. 'weekly-pulse', 'ap-aging'). Used to pick the data slice that grounds the answer.

Responses

201Successful Response

Schema: SuccessEnvelope_CfoPortalAskResponse_

successboolean
messagestring
codestring
dataCfoPortalAskResponse

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

Code samples

POST/api/v1/businesses/{business_id}/cfo-portal/ask

bash

curl -X POST 'https://api.ondayzero.com/api/v1/businesses/{business_id}/cfo-portal/ask' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "question": "string"
}'