Get unified close readiness score

GET/api/v1/accounting-periods/{period_id}/close-score

Return the persisted close-as-score gauge value for the period. If no score has been computed yet (or upstream state has changed) the score is recomputed in-line. Components include: txn_review, categorization, reconciliation, checklist, anomalies.

Operation ID: get_close_score_api_v1_accounting_periods__period_id__close_score_get·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

Responses

200Successful Response

Schema: SuccessEnvelope_GetCloseScoreResponse_

successboolean
messagestring
codestring
dataGetCloseScoreResponse

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

GET/api/v1/accounting-periods/{period_id}/close-score

bash

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