{"openapi":"3.1.0","info":{"title":"GET /api/v1/month-end-packages","version":"1.0.0","description":"List month-end packages"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/month-end-packages":{"get":{"tags":["month-end-packages"],"summary":"List month-end packages","description":"List all month-end packages requested for the business.","operationId":"list_packages_api_v1_month_end_packages_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by status: queued, in_progress, ready, failed","title":"Status"},"description":"Filter by status: queued, in_progress, ready, failed"},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for pagination","title":"Cursor"},"description":"Cursor for pagination"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":1000,"minimum":1},{"type":"null"}],"description":"Pagination limit","title":"Limit"},"description":"Pagination limit"},{"name":"direction","in":"query","required":false,"schema":{"type":"string","description":"Pagination direction: 'next' or 'prev'","default":"next","title":"Direction"},"description":"Pagination direction: 'next' or 'prev'"},{"name":"include_total_count","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include total count (expensive - avoid if possible)","default":false,"title":"Include Total Count"},"description":"Whether to include total count (expensive - avoid if possible)"},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.","title":"Sort By"},"description":"Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None."},{"name":"descending","in":"query","required":false,"schema":{"type":"boolean","description":"Sort direction: true for descending (newest/largest first), false for ascending","default":true,"title":"Descending"},"description":"Sort direction: true for descending (newest/largest first), false for ascending"},{"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/MonthEndPackagesListResponse"}}}},"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"}}}},"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"},"MonthEndPackageFormatEnum":{"type":"string","enum":["pdf","xlsx"],"title":"MonthEndPackageFormatEnum","description":"Per-report file format inside the zip."},"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."},"MonthEndPackagesListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/MonthEndPackageResponse"},"type":"array","title":"Items","description":"List of items"},"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total","description":"Total number of items (null when not calculated for performance)"},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit","description":"Pagination limit"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"Cursor for next page"},"prev_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Cursor","description":"Cursor for previous page"},"has_next":{"type":"boolean","title":"Has Next","description":"Whether there are more items"},"has_prev":{"type":"boolean","title":"Has Prev","description":"Whether there are previous items"}},"type":"object","required":["items","has_next","has_prev"],"title":"MonthEndPackagesListResponse","description":"Paginated list of month-end packages."},"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":[]}]}