Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsGet Period
Search the full API reference Esc to close

Get Period

Billing · REST API reference

Get support
GET/v1/periods/{period_id}

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request example

Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.

cURL
curl --request GET \
  --url 'https://api.staging.facily.ai/v1/periods/<PERIOD_ID>' \
  --header "Authorization: Bearer $FACILY_API_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Try a request

Staging · read-only

Explore your organization with a read-only request to staging.

Kept in this tab only. Sent directly to api.staging.facily.ai.

GET

Replace the {placeholders} in the path with your resource IDs.

Response
Your response will appear here.

Parameters

period_idpath · stringrequired

Format: uuid

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "data": {
    "created_at": "2026-10-29T12:00:00Z",
    "facility_id": "00000000-0000-4000-8000-000000000001",
    "hard_closed_at": "2026-10-29T12:00:00Z",
    "hard_closed_by": "00000000-0000-4000-8000-000000000001",
    "id": "00000000-0000-4000-8000-000000000001",
    "notes": "string",
    "period_end": "2026-10-29",
    "period_start": "2026-10-29",
    "soft_closed_at": "2026-10-29T12:00:00Z",
    "soft_closed_by": "00000000-0000-4000-8000-000000000001",
    "status": "open",
    "updated_at": "2026-10-29T12:00:00Z"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataPeriodCloseResponserequired
Show data schema
created_atstringrequired

When the period record was created.

Format: date-time

facility_idstringrequired

The facility the period belongs to.

Format: uuid

hard_closed_atstring | nullrequired

When the period was hard closed. After a hard close no further entries may be posted into it.

Format: date-time

Show hard_closed_at schema
string | null

When the period was hard closed. After a hard close no further entries may be posted into it.

Variant 1: string
string
Variant 2: null
null
hard_closed_bystring | nullrequired

The user who hard closed the period.

Format: uuid

Show hard_closed_by schema
string | null

The user who hard closed the period.

Variant 1: string
string
Variant 2: null
null
idstringrequired

Unique identifier for this accounting period.

Format: uuid

notesstring | nullrequired

Notes recorded during the close, such as an explanation of an adjustment.

Show notes schema
string | null

Notes recorded during the close, such as an explanation of an adjustment.

Variant 1: string
string
Variant 2: null
null
period_endstringrequired

Last business date in the period.

Format: date

period_startstringrequired

First business date in the period.

Format: date

soft_closed_atstring | nullrequired

When the period was soft closed. A soft close signals that routine work is finished while still allowing corrections.

Format: date-time

Show soft_closed_at schema
string | null

When the period was soft closed. A soft close signals that routine work is finished while still allowing corrections.

Variant 1: string
string
Variant 2: null
null
soft_closed_bystring | nullrequired

The user who soft closed the period.

Format: uuid

Show soft_closed_by schema
string | null

The user who soft closed the period.

Variant 1: string
string
Variant 2: null
null
statusstringrequired

Whether the period is open, soft closed, or hard closed.

Values: "open", "soft_closed", "hard_closed"

updated_atstringrequired

When the period record was last modified.

Format: date-time

metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll billing operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Get Period | Facily Developers