{"openapi":"3.1.0","info":{"title":"GET /api/v1/accounting-periods/nightly-close","version":"1.0.0","description":"Nightly soft close: status and the last 30 nights"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/accounting-periods/nightly-close":{"get":{"tags":["accounting-periods"],"summary":"Nightly soft close: status and the last 30 nights","description":"Whether the business closes its books every night (nightly_soft_close_enabled in Settings > Automation), the last night's run (readiness score, Trust Scorecard grade, pending changes filed, status) and up to the last 30 nights, oldest first.","operationId":"get_nightly_close_status","parameters":[{"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_NightlyCloseStatusResponse_"}}}},"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_nightly_close_status_api_v1_accounting_periods_nightly_close_get"}}},"components":{"schemas":{"NightlyCloseRunItem":{"properties":{"run_id":{"type":"string","title":"Run Id"},"run_date":{"type":"string","title":"Run Date","description":"YYYY-MM-DD, the night (UTC)"},"status":{"type":"string","title":"Status","description":"completed, skipped, failed or running"},"skip_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Skip Reason"},"prep_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prep Status","description":"proposed, already_proposed, blocked, no_approver or no_access"},"period_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period Id"},"period_start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period Start"},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period End"},"period_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period Label"},"readiness_score":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Readiness Score"},"readiness_color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Readiness Color"},"score_delta":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Score Delta","description":"Tonight's score minus the previous night's"},"trust_grade":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trust Grade"},"trust_provisional":{"type":"boolean","title":"Trust Provisional","default":true},"pending_changes_filed":{"type":"integer","title":"Pending Changes Filed","default":0},"notified":{"type":"boolean","title":"Notified","default":false},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"}},"additionalProperties":true,"type":"object","required":["run_id","run_date","status"],"title":"NightlyCloseRunItem","description":"What one night's soft close did."},"NightlyCloseStatusResponse":{"properties":{"business_id":{"type":"string","title":"Business Id"},"enabled":{"type":"boolean","title":"Enabled","description":"nightly_soft_close_enabled, Settings > Automation"},"last_run":{"anyOf":[{"$ref":"#/components/schemas/NightlyCloseRunItem"},{"type":"null"}]},"history":{"items":{"$ref":"#/components/schemas/NightlyCloseRunItem"},"type":"array","title":"History","description":"Up to the last 30 nights, oldest first"}},"additionalProperties":true,"type":"object","required":["business_id","enabled"],"title":"NightlyCloseStatusResponse","description":"Response for ``GET /accounting-periods/nightly-close``."},"SuccessEnvelope_NightlyCloseStatusResponse_":{"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/NightlyCloseStatusResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[NightlyCloseStatusResponse]"},"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":[]}]}