Monthly Register Closes

List all monthly time record closes

List the monthly closes of the time record register of your company with cursor-based pagination, ordered by period descending. Supports filtering by year. Each item exposes its status (closed/reopened), period bounds and employee count.

get/companies/{company}/monthly-time-record-closes

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/monthly-time-record-closes
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Query parameters

per_pageinteger

Page size, alias of limit (1 to 100, default 25).

limitinteger

Page size, between 1 and 100 (default 25); alias of per_page (limit wins when both are sent).

cursorstring

Pagination cursor (it encodes the next page number): the next_cursor of the previous page.

yearinteger

Filter monthly closes by calendar year.

Headers

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

has_moreboolean required

Whether more pages are available after this one.

next_cursorstring nullable required

Opaque cursor for the next page, or null when has_more is false. The example below shows the shape used by most listings; others return a different one, so pass the value back verbatim instead of validating it.

Example response

{
  "data": [
    {
      "id": "01933a40-04a9-73b5-9bc2-9c0d1e2f3a01",
      "object": "monthly_time_record_close",
      "year": 2026,
      "month": 4,
      "status": "closed",
      "period_start": "2026-04-01",
      "period_end": "2026-04-30",
      "closed_by_id": "01933a1f-8c21-7b3d-9e4f-1a2b3c4d5ecc",
      "closed_at": "2026-05-02T08:00:00Z",
      "employee_count": 12,
      "is_sealed": true
    }
  ],
  "has_more": true,
  "next_cursor": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0c"
}

Changes

No recorded changes to this operation across all 1 revision of this API.