Queue a month-end package build

POST/api/v1/month-end-packages

Persist a queued package row and start the Temporal build workflow.

Operation ID: create_package_api_v1_month_end_packages_post·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.

Request body

accounting_period_idstring

Optional accounting period UUID. If omitted, period_start and period_end are used directly.

period_startstring · date

Required if accounting_period_id is not provided.

period_endstring · date

Required if accounting_period_id is not provided.

report_formatMonthEndPackageFormatEnumMonthEndPackageFormatEnum

Per-report format inside the zip (pdf or xlsx).

selected_reportsarray · stringrequired

Report keys to include in the package. Supported values: pl, balance_sheet, cash_flow, ar_aging, ap_aging, budget_vs_actual, bank_reconciliation.

Responses

201Successful Response

successboolean
messagestring
codestring
dataMonthEndPackageQueuedResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject