Get supported report types

GET /api/v1/reports/types

Retrieve a list of all supported report types with their metadata.

Operation ID: get_report_types_api_v1_reports_types_get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Responses

200 Successful Response

Schema: ReportTypesResponse

items array · ReportTypeResponse requiredReportTypeResponse

List of items

4 fields
report_name string required

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 string required

Human-readable display title for the report. Shown in UI and report headers. Example: 'Master Transactions Report', 'Trial Balance Report'.

description string required

Detailed description of what the report contains, its purpose, and typical use cases. Helps users understand when to use this report.

input_type string required

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).

total integer

Total number of items (null when not calculated for performance)

limit integer

Pagination limit

next_cursor string

Cursor for next page

prev_cursor string

Cursor for previous page

has_next boolean required

Whether there are more items

has_prev boolean required

Whether there are previous items

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError
5 fields
loc array · string | integer required
msg string required
type string required
input object
ctx object