Overview
Accounting Periods define the time boundaries for financial transactions. All journal entries, bills, invoices, and payments must be posted to an open accounting period. Periods can be closed to prevent new transactions and reopened when adjustments are needed.Period Properties
| Property | Type | Description |
|---|---|---|
period_id | string | Unique identifier |
period_name | string | Display name (e.g., “January 2024”) |
fiscal_year_id | string | Associated fiscal year |
start_date | string | Period start date (YYYY-MM-DD) |
end_date | string | Period end date (YYYY-MM-DD) |
quarter | number | Fiscal quarter (1-4) |
is_adjustment_period | boolean | Whether this is period 13 for adjustments |
is_closed | boolean | Whether the period is closed |
Period States
| State | Description |
|---|---|
| Open | Transactions can be posted |
| Soft Closed | Closed but can be reopened |
| Hard Closed | Permanently closed |
Close Types
When closing a period, you can specify which sub-ledgers to close:| Type | Description |
|---|---|
all | Close all sub-ledgers |
ap | Close Accounts Payable only |
ar | Close Accounts Receivable only |
payroll | Close Payroll only |
Endpoints
Create Period
Create a new accounting period
Get Period
Retrieve period details
List Periods
List all accounting periods
Close Period
Close an accounting period
Reopen Period
Reopen a closed period
Check Unposted
Check for unposted entries before closing
Period Close Process
1
Check Unposted Entries
Use the unposted-entries endpoint to identify any documents that haven’t been posted.
2
Post or Void Pending Documents
Either post pending documents or void them if they shouldn’t be included.
3
Review Period Balances
Run the Trial Balance report to verify debits equal credits.
4
Close the Period
Use the close endpoint to prevent new transactions.