{"openapi":"3.1.0","info":{"title":"POST /api/v1/accounting-periods","version":"1.0.0","description":"Create accounting period"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/accounting-periods":{"post":{"tags":["accounting-periods"],"summary":"Create accounting period","description":"Create a new accounting period. Idempotent on the exact range: an existing period with the same start and end is returned with 200 and `created` false. A range that overlaps another period any other way is a 400 naming that period.","operationId":"create_period","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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingPeriodCreateRequest"},"example":{"period_end":"2026-01-31","period_start":"2026-01-01"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_AccountingPeriodCreateResponse_"}}}},"200":{"description":"The period already existed; `created` is false.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_AccountingPeriodCreateResponse_"}}}},"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":"create_period_api_v1_accounting_periods_post"}}},"components":{"schemas":{"AccountingPeriodCreateRequest":{"properties":{"period_start":{"type":"string","format":"date","title":"Period Start","description":"Start date of the accounting period"},"period_end":{"type":"string","format":"date","title":"Period End","description":"End date of the accounting period"}},"type":"object","required":["period_start","period_end"],"title":"AccountingPeriodCreateRequest","description":"Request schema for creating an accounting period.","example":{"period_end":"2026-01-31","period_start":"2026-01-01"},"examples":[{"period_end":"2026-01-31","period_start":"2026-01-01"}]},"AccountingPeriodCreateResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Period UUID"},"business_id":{"type":"string","title":"Business Id","description":"Business UUID"},"period_start":{"type":"string","format":"date","title":"Period Start","description":"Start date of the period"},"period_end":{"type":"string","format":"date","title":"Period End","description":"End date of the period"},"status":{"type":"string","title":"Status","description":"Status: open, closed, or locked"},"closed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Closed At","description":"When period was closed"},"closed_by_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Closed By User Id","description":"User who closed the period"},"lock_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lock Reason","description":"Reason period was closed"},"reopen_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reopen Reason","description":"Reason period was reopened"},"reopened_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reopened At","description":"When period was reopened"},"reopened_by_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reopened By User Id","description":"User who reopened the period"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"Last update timestamp"},"created":{"type":"boolean","title":"Created","description":"False when the exact range already existed and was returned unchanged","default":true}},"type":"object","required":["id","business_id","period_start","period_end","status","created_at","updated_at"],"title":"AccountingPeriodCreateResponse","description":"The period a create call resolved to, and whether this call made it."},"SuccessEnvelope_AccountingPeriodCreateResponse_":{"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/AccountingPeriodCreateResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[AccountingPeriodCreateResponse]"},"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":[]}]}