Start free trial

Close accounting period

POST/api/v1/accounting-periods/close

Close an accounting period to prevent modifications.

Operation ID: close_period_api_v1_accounting_periods_close_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

Schema: ClosePeriodRequest

period_endstring · daterequired

End date of the period to close

lock_reasonstring

Reason for closing the period

forceboolean

Bypass soft client-side blockers (unresolved checklist items) and force the close. Backend still rejects already-closed periods. Required for historical migration when the period was reviewed offline.

Responses

201Successful Response

Schema: SuccessEnvelope_AccountingPeriodResponse_

successboolean
messagestring
codestring
dataAccountingPeriodResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

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