Fiscal period locks
A block on posting in one fiscal period, set for the closing session or for one subledger.
- API name:
accountingfiscalyearperiodlocks - 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 period | accountingfiscalyearperiodId | Reference | Yes | |
| Lock kind | kind | Constant | Yes | What the period lock covers: the close session or one subledger. A period has one lock per kind. |
| 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 period accountingfiscalyearperiodId | Fiscal periods | owned by |
Actions
What you can do with a record. Every action also sends the webhook event accountingfiscalyearperiodlocks.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new period lock. | App · WebMCP · API · CLI |
| Close | close | Stop new references to this period lock. It stays, and existing documents stay. Unclose to allow new references again. | App · API · MCP · CLI |
| Reopen | unclose | Allow new references to this period lock again. | App · API · MCP · CLI |
| Delete | delete | Delete this period lock and the data that belongs with it. This cannot be undone. | App · WebMCP · API · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.