Fiscal periods
A closing interval inside the fiscal year of one company.
- API name:
accountingfiscalyearperiods - Domain: Accounting
- Modules: Finances
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Fiscal year | accountingfiscalyearId | Reference | Yes | |
| Name | label | Text | Yes | |
| Fiscal period | period | Whole Number | Yes | Period number within the fiscal year, from 1 to 12. This is not the calendar month. |
| Period start | dateStart | Date | Yes | Calendar date without time of date. |
| Period end | dateEnd | Date | Yes | Calendar date without time of date. |
| Kind | kind | Constant | Yes | Fixed option from the allowed set for this field. |
| Reopen reason | uncloseReason | Constant | Business reason to reopen a period that was already closed. | |
| Unlock reason | unlockReason | Constant | Reason to lift a subledger lock during period close. | |
| Data | data | Data | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Closed by | closedBy | User | ||
| Closed at | closedAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Fiscal year accountingfiscalyearId | Fiscal years | owned by |
Actions
What you can do with a record. Every action also sends the webhook event accountingfiscalyearperiods.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Finish close | close | Hard-close the period after the close checklist passes. After the close, journal entries cannot post with a date in this period. | App · WebMCP · API · CLI |
| Reopen period | unclose | Reopens the latest closed period. After the reopen, you can post to this period again immediately. | App · WebMCP · API · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.