{"openapi":"3.1.0","info":{"title":"GET /api/v1/advisory-firms/{firm_id}/reports/close-board","version":"1.0.0","description":"Get the firm's monthly close board"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/advisory-firms/{firm_id}/reports/close-board":{"get":{"tags":["advisory-firm-reports"],"summary":"Get the firm's monthly close board","description":"Period-specific stages, owners, waiting-on, overdue work and report packages.","operationId":"get_firm_close_board","parameters":[{"name":"firm_id","in":"path","required":true,"schema":{"type":"string","title":"Firm Id"}},{"name":"period_start","in":"query","required":true,"schema":{"type":"string","format":"date","description":"First day of the month being closed","title":"Period Start"},"description":"First day of the month being closed"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_FirmCloseBoard_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"error":"validation_error","message":"Validation failed: due_date: Input should be a valid date","errors":{"due_date":"Input should be a valid date"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"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"}}}},"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":"get_firm_close_board_api_v1_advisory_firms__firm_id__reports_close_board_get"}}},"components":{"schemas":{"FirmCloseBoard":{"properties":{"period_start":{"type":"string","format":"date","title":"Period Start"},"period_end":{"type":"string","format":"date","title":"Period End"},"as_of":{"type":"string","format":"date-time","title":"As Of"},"items":{"items":{"$ref":"#/components/schemas/FirmCloseRow"},"type":"array","title":"Items"}},"type":"object","required":["period_start","period_end","as_of","items"],"title":"FirmCloseBoard"},"FirmCloseRow":{"properties":{"business_id":{"type":"string","title":"Business Id"},"business_name":{"type":"string","title":"Business Name"},"period_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period Id"},"stage":{"type":"string","enum":["prepare","in_progress","review","done"],"title":"Stage"},"period_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period Status"},"owners":{"items":{"type":"string"},"type":"array","title":"Owners"},"current_step":{"type":"string","title":"Current Step"},"waiting_on":{"items":{"type":"string"},"type":"array","title":"Waiting On"},"blockers":{"items":{"type":"string"},"type":"array","title":"Blockers"},"completed_steps":{"type":"integer","title":"Completed Steps","default":0},"total_steps":{"type":"integer","title":"Total Steps","default":0},"overdue_steps":{"type":"integer","title":"Overdue Steps","default":0},"open_questions":{"type":"integer","title":"Open Questions","default":0},"open_documents_business":{"type":"integer","title":"Open Documents Business","default":0},"signoffs":{"type":"integer","title":"Signoffs","default":0},"score":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Score"},"score_as_of":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Score As Of"},"package_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Package Status"},"package_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Package Id"},"close_deadline":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Close Deadline"},"business_days_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Business Days Remaining"},"on_time":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"On Time"}},"type":"object","required":["business_id","business_name","stage","current_step"],"title":"FirmCloseRow"},"SuccessEnvelope_FirmCloseBoard_":{"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/FirmCloseBoard"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[FirmCloseBoard]"},"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":[]}]}