{"openapi":"3.1.0","info":{"title":"POST /api/v1/accounting-periods/{period_id}/close-readiness","version":"1.0.0","description":"AI close readiness check"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/accounting-periods/{period_id}/close-readiness":{"post":{"tags":["accounting-periods"],"summary":"AI close readiness check","description":"Check period close readiness with AI-enhanced analysis.","operationId":"check_close_readiness","parameters":[{"name":"period_id","in":"path","required":true,"schema":{"type":"string","title":"Period Id"}},{"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":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_CloseReadinessResponse_"}}}},"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":"check_close_readiness_api_v1_accounting_periods__period_id__close_readiness_post"}}},"components":{"schemas":{"CloseReadinessItem":{"properties":{"check":{"type":"string","title":"Check","description":"Name of the readiness check"},"status":{"type":"string","title":"Status","description":"pass, warning, or fail"},"detail":{"type":"string","title":"Detail","description":"Explanation"},"count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count","description":"Number of items flagged"}},"type":"object","required":["check","status","detail"],"title":"CloseReadinessItem"},"CloseReadinessResponse":{"properties":{"score":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Score","description":"Overall readiness score 0-100"},"items":{"items":{"$ref":"#/components/schemas/CloseReadinessItem"},"type":"array","title":"Items"},"summary":{"$ref":"#/components/schemas/CloseReadinessSummary","description":"Period-scoped transaction counts to power dashboards without extra fetches"}},"type":"object","required":["score"],"title":"CloseReadinessResponse"},"CloseReadinessSummary":{"properties":{"transaction_count":{"type":"integer","minimum":0.0,"title":"Transaction Count","description":"Total non-deleted transactions in the period","default":0},"unreviewed_count":{"type":"integer","minimum":0.0,"title":"Unreviewed Count","description":"Transactions in the period that are still unreviewed","default":0},"uncategorized_count":{"type":"integer","minimum":0.0,"title":"Uncategorized Count","description":"Transactions in the period that are still uncategorized","default":0},"missing_receipt_count":{"type":"integer","minimum":0.0,"title":"Missing Receipt Count","description":"Expenses in the period that the receipt policy asks a receipt for and that have none (including ones requested from the client)","default":0}},"type":"object","title":"CloseReadinessSummary","description":"Period-scoped totals computed alongside the readiness checks."},"SuccessEnvelope_CloseReadinessResponse_":{"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/CloseReadinessResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[CloseReadinessResponse]"},"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":[]}]}