Acknowledge a checklist step

PUT /api/v1/accounting-periods/{period_id}/checklist-acks/{step_id}

Record (or update) a manual-step ack so the dashboard treats the step as done. Idempotent — re-calling updates the notes.

Operation ID: acknowledge_checklist_step_api_v1_accounting_periods__period_id__checklist_acks__step_id__put · 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
step_id string required

Request body

Schema: AcknowledgeCloseStepRequest

notes string: Optional free-form note

Responses

200 Successful Response

Schema: CloseChecklistAckResponse

id string required: Ack row UUID
business_id string required: Business UUID
period_start string · date required: Period start the ack is keyed to
step_id string required: Checklist step ID (e.g. trial_balance_review)
notes string: Optional free-form note
acked_by string: User who acknowledged
created_at string · date-time required: When the ack was first recorded
updated_at string · date-time required: When the ack was last updated

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

PUT /api/v1/accounting-periods/{period_id}/checklist-acks/{step_id}

bash

curl -X PUT 'https://api.ondayzero.com/api/v1/accounting-periods/{period_id}/checklist-acks/{step_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "notes": "string"
}'

javascript

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

python

import httpx

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

payload = {
  "notes": "string"
}

response = httpx.put("https://api.ondayzero.com/api/v1/accounting-periods/{period_id}/checklist-acks/{step_id}", headers=headers, json=payload)
data = response.json()