{"openapi":"3.1.0","info":{"title":"GET /api/v1/businesses/{business_id}/cfo-portal/flux/narrative-packet","version":"1.0.0","description":"Get CFO narrative flux close packet for a business"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/businesses/{business_id}/cfo-portal/flux/narrative-packet":{"get":{"tags":["cfo-portal"],"summary":"Get CFO narrative flux close packet for a business","description":"Build a live narrative flux close packet for ``business_id``.","operationId":"cfo_portal_get_narrative_flux_packet","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"period_end","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Period End"}},{"name":"materiality_bps","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":0,"default":200,"title":"Materiality Bps"}},{"name":"redact_pii","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Redact Pii"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_NarrativeFluxPacketResponse_"}}}},"401":{"description":"Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"error":"not_found","message":"Resource not found","code":"NOT_FOUND_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"cfo_portal_get_narrative_flux_packet_api_v1_businesses__business_id__cfo_portal_flux_narrative_packet_get"}}},"components":{"schemas":{"NarrativeFluxDriver":{"properties":{"date":{"type":"string","format":"date","title":"Date"},"counterparty_or_source":{"type":"string","title":"Counterparty Or Source","description":"Counterparty, vendor, or campaign name; redacted to 'Counterparty #1', 'Vendor #2', etc. when redact_pii=True"},"amount_cents":{"type":"integer","title":"Amount Cents"},"description":{"type":"string","title":"Description"},"source_type":{"type":"string","title":"Source Type","description":"transaction, journal_line, bill, or meta_ads","default":"transaction"},"entity_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity Id"}},"type":"object","required":["date","counterparty_or_source","amount_cents","description"],"title":"NarrativeFluxDriver","description":"Single underlying subledger driver for a material account variance."},"NarrativeFluxMover":{"properties":{"ledger_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ledger Id"},"account_name":{"type":"string","title":"Account Name"},"category_group":{"type":"string","title":"Category Group","description":"Revenue, COGS, Operating Expenses, or Net Income"},"current_cents":{"type":"integer","title":"Current Cents"},"prior_cents":{"type":"integer","title":"Prior Cents"},"variance_cents":{"type":"integer","title":"Variance Cents"},"variance_bps":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Variance Bps"},"variance_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Variance Pct"},"favorable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Favorable"},"is_material":{"type":"boolean","title":"Is Material","default":false},"narrative":{"type":"string","title":"Narrative","default":""},"top_drivers":{"items":{"$ref":"#/components/schemas/NarrativeFluxDriver"},"type":"array","title":"Top Drivers"}},"type":"object","required":["account_name","category_group","current_cents","prior_cents","variance_cents"],"title":"NarrativeFluxMover","description":"Account or category-group variance row with narrative and drill-through drivers."},"NarrativeFluxPacketResponse":{"properties":{"business_id":{"type":"string","title":"Business Id"},"period_start":{"type":"string","format":"date","title":"Period Start"},"period_end":{"type":"string","format":"date","title":"Period End"},"prior_start":{"type":"string","format":"date","title":"Prior Start"},"prior_end":{"type":"string","format":"date","title":"Prior End"},"materiality_bps":{"type":"integer","title":"Materiality Bps","default":200},"materiality_cents":{"type":"integer","title":"Materiality Cents","default":50000},"redact_pii":{"type":"boolean","title":"Redact Pii","default":false},"category_groups":{"items":{"$ref":"#/components/schemas/NarrativeFluxMover"},"type":"array","title":"Category Groups"},"account_flux":{"items":{"$ref":"#/components/schemas/NarrativeFluxMover"},"type":"array","title":"Account Flux"},"material_movers":{"items":{"$ref":"#/components/schemas/NarrativeFluxMover"},"type":"array","title":"Material Movers"},"executive_summary":{"items":{"type":"string"},"type":"array","title":"Executive Summary"},"markdown_brief":{"type":"string","title":"Markdown Brief","default":""},"generated_at":{"type":"string","format":"date-time","title":"Generated At"}},"type":"object","required":["business_id","period_start","period_end","prior_start","prior_end","generated_at"],"title":"NarrativeFluxPacketResponse","description":"Live narrative flux close packet with subledger drill-through and PII redaction."},"SuccessEnvelope_NarrativeFluxPacketResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/NarrativeFluxPacketResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[NarrativeFluxPacketResponse]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}