---
title: "Check whether the next ended GL period can be closed"
method: GET
path: "/companies/{companyId}/close/readiness"
tags: ["GL Periods"]
---

# Check whether the next ended GL period can be closed

`GET /companies/{companyId}/close/readiness`

## Request

- Base URL: `https://api.medianfi.com/api/v1`
- URL: `https://api.medianfi.com/api/v1/companies/{companyId}/close/readiness`
- Auth: HTTP bearer

Read-only. Resolves the period named by `periodId`, or else the
earliest open GL period that ended before today, and lists what
blocks closing it: transactions in the period that still need
review, open blocking threads, and unresolved blocking-severity
close blockers. A period that has not ended reports only
`period_not_ended`; an already-closed period reports `ready: false`
with an `already_closed` blocker. When no period resolves, `periodId`
is null and the only blocker is `no_period`. Open to every company member.

## Query parameters

- `periodId` string, uuid

## Response `200`

Close readiness for the resolved period

- CloseReadinessResponse
  - `success` boolean, required
  - `data` CloseReadiness, required
    - `companyId` string, uuid, required
    - `ready` boolean, required: True when the resolved period has no blockers. An already-closed period is ready: false with an already_closed blocker.
    - `blockers` CloseReadinessBlocker[], required
      - `type` 'no_period' | 'period_not_ended' | 'already_closed' | 'uncategorized_transactions' | 'blocking_threads' | 'close_blockers', required
      - `count` integer, required
      - `message` string, required
    - `periodId` string, uuid, nullable, required: The resolved period. Null only together with the `no_period` blocker.
    - `latestClosedPeriodEndDate` string, date, nullable: Present only when no period resolves (end date of the latest ended closed period, or null) or when the resolved period is already closed (its own end date).

## Other responses

- `401`: Authentication required
- `403`: Insufficient permissions or not a company member

---

[API](https://skmtc.dev/medianfi/apis/median-api.md) · [All operations](https://skmtc.dev/medianfi/apis/median-api/llms.txt) · [OpenAPI document](https://skmtc.dev/medianfi/apis/median-api/revisions/20090ea32b0d?raw)
