Skip to content

List GL close runs

GET/finance/gl-close-runs

Returns all general-ledger close runs ordered newest-first, together with period locks and reconciliations. Use this to review the history of close activity and current period statuses before initiating a new run.

Request

This endpoint takes no parameters and no request body.

Responses

200 A list of GL close runs with summary counts

Content type application/json, object.

FieldTypeRequiredDescription
dataarray of object · FinanceGlCloseRunV1No
data[].idintegerNo

Auto-incremented primary key.

data[].periodstringNo

Accounting period this run covers, in YYYY-MM format.

Example: "2026-03"

data[].statusstringNo

Current status of the close run. 'prepared' means checks are done but not yet locked; 'locked' means the period is frozen.

One of: "prepared", "locked" · Example: "locked"

data[].posted_entriesintegerNo

Number of journal entries posted during this close run.

Example: 418

data[].notesstring, nullableNo

Operator notes recorded at the time the run was created.

data[].started_byinteger, nullableNo

Tenant user ID of the user who initiated the close run.

data[].closed_byinteger, nullableNo

Tenant user ID of the user who locked the period.

data[].closed_atstring (date-time), nullableNo

Timestamp at which the period was locked.

data[].created_atstring (date-time)No

Record creation timestamp.

summaryobject · FinanceOpsummaryV1No

Aggregate counts for the finance ops dashboard.

summary.close_runsintegerNo

Total number of GL close run records.

summary.locked_periodsintegerNo

Number of currently locked accounting periods.

summary.reconciliationsintegerNo

Total number of bank reconciliation import records.

Example

{
  "data": [
    {
      "id": 12,
      "period": "2026-03",
      "status": "locked",
      "posted_entries": 418,
      "notes": "Q1 close — reviewed by CFO",
      "started_by": 3,
      "closed_by": 3,
      "closed_at": "2026-04-01T09:15:00Z",
      "created_at": "2026-03-31T18:00:00Z"
    }
  ],
  "summary": {
    "close_runs": 12,
    "locked_periods": 3,
    "reconciliations": 9
  }
}

401 Unauthenticated — valid tenant session required

Example request

curl -X GET "https://{tenant}.faciotech.net/api/v1/finance/gl-close-runs" \
  -H "Accept: application/json"
Loading