Overview
Accounting period tools manage fiscal periods, including closing, reopening, and sub-ledger locking.
finance_period_create
Create a new accounting period.
Parameters:
| Parameter | Type | Required | Description |
|---|
period_id | string | Yes | Unique period ID |
period_name | string | Yes | Period name (e.g., “January 2024”) |
start_date | string | Yes | Period start date |
end_date | string | Yes | Period end date |
fiscal_year | string | Yes | Fiscal year |
is_adjustment_period | boolean | No | Is this an adjustment period |
finance_period_get
Retrieve an accounting period by ID.
Parameters:
| Parameter | Type | Required | Description |
|---|
period_id | string | Yes | Period ID |
finance_period_list
List accounting periods.
Parameters:
| Parameter | Type | Required | Description |
|---|
fiscal_year | string | No | Filter by fiscal year |
status | string | No | Filter by status (Open, Closed) |
is_adjustment_period | boolean | No | Filter adjustment periods |
finance_period_update
Update an accounting period.
Parameters:
| Parameter | Type | Required | Description |
|---|
period_id | string | Yes | Period ID |
period_name | string | No | Updated name |
finance_period_close
Close an accounting period.
Parameters:
| Parameter | Type | Required | Description |
|---|
period_id | string | Yes | Period ID |
force | boolean | No | Close even with unposted entries |
Closing a period prevents new transactions from being posted to it.
finance_period_reopen
Reopen a closed accounting period.
Parameters:
| Parameter | Type | Required | Description |
|---|
period_id | string | Yes | Period ID |
reason | string | Yes | Reason for reopening |
finance_period_get_unposted
Get unposted entries in a period.
Parameters:
| Parameter | Type | Required | Description |
|---|
period_id | string | Yes | Period ID |
document_type | string | No | Filter by document type |
finance_period_lock_subledger
Lock a sub-ledger for a period.
Parameters:
| Parameter | Type | Required | Description |
|---|
period_id | string | Yes | Period ID |
subledger | string | Yes | Sub-ledger: AP, AR, GL |
finance_period_unlock_subledger
Unlock a sub-ledger for a period.
Parameters:
| Parameter | Type | Required | Description |
|---|
period_id | string | Yes | Period ID |
subledger | string | Yes | Sub-ledger: AP, AR, GL |
reason | string | Yes | Reason for unlocking |
finance_period_get_subledger_status
Get sub-ledger lock status for a period.
Parameters:
| Parameter | Type | Required | Description |
|---|
period_id | string | Yes | Period ID |
{
"period_id": "period-2024-01",
"subledger_status": {
"AP": { "locked": true, "locked_at": "2024-02-01T00:00:00Z" },
"AR": { "locked": true, "locked_at": "2024-02-01T00:00:00Z" },
"GL": { "locked": false }
}
}
