AI close readiness check

POST /api/v1/accounting-periods/{period_id}/close-readiness

Check period close readiness with AI-enhanced analysis.

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

Responses

201 Successful Response

Schema: CloseReadinessResponse

score number required

Overall readiness score 0-100

items array · CloseReadinessItem CloseReadinessItem

4 fields

check string required: Name of the readiness check
status string required: pass, warning, or fail
detail string required: Explanation
count integer: Number of items flagged

summary CloseReadinessSummary CloseReadinessSummary

Period-scoped transaction counts to power dashboards without extra fetches

3 fields

transaction_count integer: Total non-deleted transactions in the period
unreviewed_count integer: Transactions in the period that are still unreviewed
uncategorized_count integer: Transactions in the period that are still uncategorized

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}/close-readiness

bash

curl -X POST 'https://api.ondayzero.com/api/v1/accounting-periods/{period_id}/close-readiness' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/accounting-periods/{period_id}/close-readiness', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();

python

import httpx

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

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