Close a month

Close a month

POST /api/v1/gl/close-month

cURL

curl --silent --show-error --fail-with-body --request POST \
  --url 'https://api.stateset.com/api/v1/gl/close-month' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "closed_by": "string",
  "dry_run": false,
  "fail_on_warnings": true,
  "period_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "skip_depreciation": true,
  "skip_fx_revaluation": true,
  "skip_period_close": true,
  "skip_revenue_recognition": true
}'

200

{
  "closing_entry": {
    "created_at": "2026-08-31T14:22:05Z",
    "description": "Two-person tent, green — replacement for damaged pole set.",
    "entry_date": "2026-08-31T14:22:05Z",
    "entry_number": "string",
    "entry_type": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "is_balanced": true,
    "lines": [
      {
        "account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "account_name": "string",
        "account_number": "string",
        "credit_amount": "49.00",
        "currency": "USD",
        "debit_amount": "49.00",
        "description": "Two-person tent, green — replacement for damaged pole set.",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "line_number": 1001
      }
    ],
    "period_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "posted_at": "2026-08-31T14:22:05Z",
    "posted_by": "string",
    "reversed_entry_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "reversing_entry_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "source": "string",
    "status": "pending",
    "total_credits": "string",
    "total_debits": "string"
  },
  "depreciation": {
    "entry_count": 1,
    "failed_item_count": 1,
    "status": "pending",
    "total_amount": "102.12",
    "warnings": [
      "string"
    ]
  },
  "dry_run": false,
  "fx_revaluation": {
    "entry_count": 1,
    "failed_item_count": 1,
    "status": "pending",
    "total_amount": "102.12",
    "warnings": [
      "string"
    ]
  },
  "period_close": {
    "entry_count": 1,
    "failed_item_count": 1,
    "status": "pending",
    "total_amount": "102.12",
    "warnings": [
      "string"
    ]
  },
  "period_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "period_name": "string",
  "period_status": "string",
  "revenue_recognition": {
    "entry_count": 1,
    "failed_item_count": 1,
    "status": "pending",
    "total_amount": "102.12",
    "warnings": [
      "string"
    ]
  }
}

Confirm your deployment before running this request. This page describes an API contract; a published reference does not establish hosted availability. Check the dated host report and obtain your deployment URL and credentials. Replace the example host if your provisioned service uses a different URL.

Request body

CloseMonthRequest

closed_by · string,null

Actor recorded as the closer. Defaults to api.

dry_run · boolean,null

Compute counts/amounts per step without writing anything.

fail_on_warnings · boolean,null

Refuse with 422 when any step reports warnings (strict mode).

period_id · string · required

Accounting period to close.

skip_depreciation · boolean,null

Skip posting scheduled fixed-asset depreciation.

skip_fx_revaluation · boolean,null

Skip FX revaluation of foreign-currency accounts.

skip_period_close · boolean,null

Skip the final period close (closing entries + close period).

skip_revenue_recognition · boolean,null

Skip recognizing deferred revenue through period end.

Response

CloseMonthResponse

closing_entry · JournalEntryResponse,null

Show JournalEntryResponse

created_at · string · required

description · string · required

entry_date · string · required

entry_number · string · required

entry_type · string · required

id · string · required

is_balanced · boolean · required

lines · JournalEntryLineResponse[] · required

Show JournalEntryLineResponse

account_id · string · required

account_name · string,null

account_number · string,null

credit_amount · string · required

Decimal credit amount as a string.

currency · string · required

debit_amount · string · required

Decimal debit amount as a string.

description · string,null

id · string · required

line_number · integer (int32) · required

period_id · string · required

posted_at · string,null

posted_by · string,null

reversed_entry_id · string,null

reversing_entry_id · string,null

source · string · required

status · string · required

total_credits · string · required

Decimal total credits as a string.

total_debits · string · required

Decimal total debits as a string.

depreciation · CloseMonthStepResponse · required

Step 1: scheduled depreciation due through period end.

Show CloseMonthStepResponse

entry_count · integer (int64) · required

Entries posted (or that would be posted in a dry run). Minimum: 0.

failed_item_count · integer (int64) · required

Warnings that record a per-item failure (vs informational skip notes). Minimum: 0.

status · string · required

One of executed, skipped, dry_run.

total_amount · string · required

Decimal total amount for the step as a string.

warnings · string[] · required

Per-item failures that did not abort the close.

dry_run · boolean · required

fx_revaluation · CloseMonthStepResponse · required

Step 3: FX revaluation as of period end.

Show CloseMonthStepResponse

entry_count · integer (int64) · required

Entries posted (or that would be posted in a dry run). Minimum: 0.

failed_item_count · integer (int64) · required

Warnings that record a per-item failure (vs informational skip notes). Minimum: 0.

status · string · required

One of executed, skipped, dry_run.

total_amount · string · required

Decimal total amount for the step as a string.

warnings · string[] · required

Per-item failures that did not abort the close.

period_close · CloseMonthStepResponse · required

Step 4: closing entries + close period.

Show CloseMonthStepResponse

entry_count · integer (int64) · required

Entries posted (or that would be posted in a dry run). Minimum: 0.

failed_item_count · integer (int64) · required

Warnings that record a per-item failure (vs informational skip notes). Minimum: 0.

status · string · required

One of executed, skipped, dry_run.

total_amount · string · required

Decimal total amount for the step as a string.

warnings · string[] · required

Per-item failures that did not abort the close.

period_id · string · required

period_name · string · required

period_status · string · required

Period status after the run (closed after a real close).

revenue_recognition · CloseMonthStepResponse · required

Step 2: deferred revenue recognized through period end.

Show CloseMonthStepResponse

entry_count · integer (int64) · required

Entries posted (or that would be posted in a dry run). Minimum: 0.

failed_item_count · integer (int64) · required

Warnings that record a per-item failure (vs informational skip notes). Minimum: 0.

status · string · required

One of executed, skipped, dry_run.

total_amount · string · required

Decimal total amount for the step as a string.

warnings · string[] · required

Per-item failures that did not abort the close.

Status codes

Code	Meaning
200	—
400	—
404	—
422	—

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.

cURL

curl --silent --show-error --fail-with-body --request POST \
  --url 'https://api.stateset.com/api/v1/gl/close-month' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "closed_by": "string",
  "dry_run": false,
  "fail_on_warnings": true,
  "period_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "skip_depreciation": true,
  "skip_fx_revaluation": true,
  "skip_period_close": true,
  "skip_revenue_recognition": true
}'

200

{
  "closing_entry": {
    "created_at": "2026-08-31T14:22:05Z",
    "description": "Two-person tent, green — replacement for damaged pole set.",
    "entry_date": "2026-08-31T14:22:05Z",
    "entry_number": "string",
    "entry_type": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "is_balanced": true,
    "lines": [
      {
        "account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "account_name": "string",
        "account_number": "string",
        "credit_amount": "49.00",
        "currency": "USD",
        "debit_amount": "49.00",
        "description": "Two-person tent, green — replacement for damaged pole set.",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "line_number": 1001
      }
    ],
    "period_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "posted_at": "2026-08-31T14:22:05Z",
    "posted_by": "string",
    "reversed_entry_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "reversing_entry_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "source": "string",
    "status": "pending",
    "total_credits": "string",
    "total_debits": "string"
  },
  "depreciation": {
    "entry_count": 1,
    "failed_item_count": 1,
    "status": "pending",
    "total_amount": "102.12",
    "warnings": [
      "string"
    ]
  },
  "dry_run": false,
  "fx_revaluation": {
    "entry_count": 1,
    "failed_item_count": 1,
    "status": "pending",
    "total_amount": "102.12",
    "warnings": [
      "string"
    ]
  },
  "period_close": {
    "entry_count": 1,
    "failed_item_count": 1,
    "status": "pending",
    "total_amount": "102.12",
    "warnings": [
      "string"
    ]
  },
  "period_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "period_name": "string",
  "period_status": "string",
  "revenue_recognition": {
    "entry_count": 1,
    "failed_item_count": 1,
    "status": "pending",
    "total_amount": "102.12",
    "warnings": [
      "string"
    ]
  }
}