Skip to main content

Record Close Override

POST 

/api/ledger/close/periods/:period/checklist/:item/override

Record an override on a failing blocking check before the month is closed, with the reason it can close anyway. Whoever closes the month accepts the override by closing, and it stays on the month's record under the name of the person who made it. While it stands, that person cannot close a month that needs an independent reviewer.

Required scope: accounting:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Only checks that allow overrides accept one, and only while the month is in review.

Authentication: Bearer token. Requires the accounting sync permission and the check's override permission (accounting.period.override).

Request body:

  • reason (string, required, max 2000): why the month can close with this check failing.

Errors: 403 without the override permission. 422 when the reason is missing, the check is passing, the check cannot be overridden, or the month is not in review.

Request​

Responses​

OK

Response Headers
    Content-Type