Record a reviewer sign-off

POST/api/v1/accounting-periods/{period_id}/sign-offs

Record (or update) a reviewer's sign-off on the period. Idempotent on (user_id, role) — re-signing refreshes the snapshot score + notes. Side-effect: triggers a close-score recompute so the gauge updates immediately.

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

Parameters

Path

period_idstringrequired

Request body

Schema: SignOffRequest

rolestringrequired: Role of the reviewer signing off (preparer, reviewer, controller, partner).
notesstring: Optional reviewer notes captured at sign-off.

Responses

201Successful Response

Schema: SuccessEnvelope_CreatePeriodSignOffResponse_

successboolean
messagestring
codestring
dataCreatePeriodSignOffResponse

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

Code samples

POST/api/v1/accounting-periods/{period_id}/sign-offs

bash

curl -X POST 'https://api.ondayzero.com/api/v1/accounting-periods/{period_id}/sign-offs' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "role": "string"
}'