List month-end packages — month-end-packages

Parameters

Query

status string

Filter by status: queued, in_progress, ready, failed

cursor string

Cursor for pagination

limit integer

Pagination limit

direction string default: next

Pagination direction: 'next' or 'prev'

include_total_count boolean default: False

Whether to include total count (expensive - avoid if possible)

sort_by string

Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.

descending boolean default: True

Sort direction: true for descending (newest/largest first), false for ascending

Responses

Schema: MonthEndPackagesListResponse

items array · MonthEndPackageResponse requiredMonthEndPackageResponse

List of items

17 fields

id string required: Month-end package UUID
business_id string required: Owning business UUID
accounting_period_id string: Linked accounting period UUID, if any
period_start string · date-time required: Start of the covered period
period_end string · date-time required: End of the covered period
status MonthEndPackageStatusEnum requiredMonthEndPackageStatusEnum: Build status: queued, in_progress, ready, or failed
report_format MonthEndPackageFormatEnum requiredMonthEndPackageFormatEnum: Per-report format inside the zip
selected_reports array · string: Report keys included in the package
workflow_id string: Temporal workflow id driving the build
file_size_bytes integer: Final zip size in bytes (set when ready)
filename string: Suggested attachment filename for the zip download
error_message string: Failure reason when status == 'failed'
requested_by_user_id string: User who requested the package
started_at string · date-time: When the build started
ready_at string · date-time: When the package became downloadable
created_at string · date-time required: Creation timestamp
updated_at string · date-time required: Last update timestamp

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

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields