{"openapi":"3.1.0","info":{"title":"POST /api/v1/month-end-packages","version":"1.0.0","description":"Queue a month-end package build"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/month-end-packages":{"post":{"tags":["month-end-packages"],"summary":"Queue a month-end package build","description":"Persist a queued package row and start the Temporal build workflow.","operationId":"create_package_api_v1_month_end_packages_post","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/MonthEndPackageCreateRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonthEndPackageQueuedResponse"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"detail":"Invalid request parameters"}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"detail":"Not enough permissions"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"detail":"Resource not found"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"MonthEndPackageCreateRequest":{"properties":{"accounting_period_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounting Period Id","description":"Optional accounting period UUID. If omitted, ``period_start`` and ``period_end`` are used directly."},"period_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Period Start","description":"Required if ``accounting_period_id`` is not provided."},"period_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Period End","description":"Required if ``accounting_period_id`` is not provided."},"report_format":{"$ref":"#/components/schemas/MonthEndPackageFormatEnum","description":"Per-report format inside the zip (``pdf`` or ``xlsx``).","default":"pdf"},"selected_reports":{"items":{"type":"string"},"type":"array","minItems":1,"title":"Selected Reports","description":"Report keys to include in the package. Supported values: pl, balance_sheet, cash_flow, ar_aging, ap_aging, budget_vs_actual, bank_reconciliation."}},"type":"object","required":["selected_reports"],"title":"MonthEndPackageCreateRequest","description":"Request schema for queuing a new month-end package build.","example":{"accounting_period_id":"01952c2e-7e7f-7c8e-9f00-000000000001","report_format":"pdf","selected_reports":["pl","balance_sheet","cash_flow","ar_aging","ap_aging"]}},"MonthEndPackageFormatEnum":{"type":"string","enum":["pdf","xlsx"],"title":"MonthEndPackageFormatEnum","description":"Per-report file format inside the zip."},"MonthEndPackageQueuedResponse":{"properties":{"package":{"$ref":"#/components/schemas/MonthEndPackageResponse","description":"The freshly created package record"},"workflow_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflow Id","description":"Temporal workflow id (also on ``package``)"}},"type":"object","required":["package"],"title":"MonthEndPackageQueuedResponse","description":"Returned immediately after enqueuing a package build."},"MonthEndPackageResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Month-end package UUID"},"business_id":{"type":"string","title":"Business Id","description":"Owning business UUID"},"accounting_period_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounting Period Id","description":"Linked accounting period UUID, if any"},"period_start":{"type":"string","format":"date-time","title":"Period Start","description":"Start of the covered period"},"period_end":{"type":"string","format":"date-time","title":"Period End","description":"End of the covered period"},"status":{"$ref":"#/components/schemas/MonthEndPackageStatusEnum","description":"Build status: queued, in_progress, ready, or failed"},"report_format":{"$ref":"#/components/schemas/MonthEndPackageFormatEnum","description":"Per-report format inside the zip"},"selected_reports":{"items":{"type":"string"},"type":"array","title":"Selected Reports","description":"Report keys included in the package"},"workflow_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflow Id","description":"Temporal workflow id driving the build"},"file_size_bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Size Bytes","description":"Final zip size in bytes (set when ready)"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filename","description":"Suggested attachment filename for the zip download"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message","description":"Failure reason when ``status == 'failed'``"},"requested_by_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Requested By User Id","description":"User who requested the package"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At","description":"When the build started"},"ready_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Ready At","description":"When the package became downloadable"},"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"}},"type":"object","required":["id","business_id","period_start","period_end","status","report_format","created_at","updated_at"],"title":"MonthEndPackageResponse","description":"Response schema for a single month-end package record."},"MonthEndPackageStatusEnum":{"type":"string","enum":["queued","in_progress","ready","failed"],"title":"MonthEndPackageStatusEnum","description":"Lifecycle of a month-end package build job."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}