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_id string required

Request body

Schema: SignOffRequest

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

Responses

201 Successful Response

400 Bad Request - Invalid input

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

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"
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/accounting-periods/{period_id}/sign-offs', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "role": "string"
}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "role": "string"
}

response = httpx.post("https://api.ondayzero.com/api/v1/accounting-periods/{period_id}/sign-offs", headers=headers, json=payload)
data = response.json()