{"openapi":"3.1.0","info":{"title":"GET /api/v1/reports/types","version":"1.0.0","description":"Get supported report types"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/reports/types":{"get":{"tags":["reports"],"summary":"Get supported report types","description":"Retrieve a list of all supported report types with their metadata.","operationId":"get_report_types_api_v1_reports_types_get","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/ReportTypesResponse"}}}},"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"},"ReportTypeResponse":{"properties":{"report_name":{"type":"string","title":"Report Name","description":"Unique report identifier used in API requests. Examples: 'master_transactions', 'trial_balance', 'general_ledger', 'profit_and_loss_comparative', 'ar_report', 'cogs_report'. Use this value in the report_name field when generating reports."},"title":{"type":"string","title":"Title","description":"Human-readable display title for the report. Shown in UI and report headers. Example: 'Master Transactions Report', 'Trial Balance Report'."},"description":{"type":"string","title":"Description","description":"Detailed description of what the report contains, its purpose, and typical use cases. Helps users understand when to use this report."},"input_type":{"type":"string","title":"Input Type","description":"Specifies which request fields are required for this report. Values: 'no_params' (no additional fields needed), 'date_start_end' (requires start_date and end_date), 'date_end_only' (requires only end_date for point-in-time reports), 'date_start_end_with_ledger' (date range plus optional ledger_id filter), 'date_start_end_with_comparison' (two date ranges for variance analysis), 'date_start_end_with_customer' (date range plus optional customer filter), 'date_start_end_with_vendor' (date range plus optional vendor filter), 'date_start_end_with_tag_group' (date range plus optional tag group filter), 'date_start_end_with_options' (date range with additional options like include_zero_balances), 'date_start_end_with_grouping' (date range with period grouping like monthly or quarterly), 'forecast_params' (forecast configuration like forecast_days), 'file_upload' (requires file_s3_key or s3_keys for uploaded data)."}},"type":"object","required":["report_name","title","description","input_type"],"title":"ReportTypeResponse","description":"Schema for a supported report type.\n\nDescribes what reports can be generated and their required inputs.\nEach report type has a unique identifier, display title, description,\nand input type that determines which request fields are required.\n\nSee REPORTS_CATALOG.md for detailed documentation of each report type,\nincluding output columns, tabs, and use cases."},"ReportTypesResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ReportTypeResponse"},"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":"ReportTypesResponse","description":"Paginated list of available report types."},"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":[]}]}