Skip to main content
BlueAI
Home/Accounting/Period Locks

Period Locks

Lock and unlock journal entry input on a monthly basis.

|

Endpoints

GET/api/v1/accounting/period-locksList period locks
POST/api/v1/accounting/period-locksCreate a period lock
DELETE/api/v1/accounting/period-locks/{id}Delete a period lock
GET/api/v1/accounting/period-locks

List period locks

Authentication requiredInclude session cookie or Bearer token

Query Parameters

NameTypeRequiredDescription
fiscal_year_id
stringOptionalFilter by fiscal year ID
limit
integerOptionalNumber of items to return (default: 20, max: 100)
offset
integerOptionalOffset for pagination (default: 0)

Code Examples

curl "https://api.blueai.jp/api/v1/accounting/period-locks" \
  -H "Cookie: better-auth.session_token=<token>"
POST/api/v1/accounting/period-locks

Create a period lock

Authentication requiredInclude session cookie or Bearer token

Request Body

NameTypeRequiredDescription
fiscal_year_id
stringRequiredFiscal year ID
year_month
stringRequiredTarget month to lock (YYYY-MM)

Code Examples

curl -X POST "https://api.blueai.jp/api/v1/accounting/period-locks" \
  -H "Cookie: better-auth.session_token=<token>"
DELETE/api/v1/accounting/period-locks/{id}

Delete a period lock

Authentication requiredInclude session cookie or Bearer token

Path Parameters

NameTypeRequiredDescription
id
stringOptionalPeriod lock ID

Code Examples

curl -X DELETE "https://api.blueai.jp/api/v1/accounting/period-locks/plock_123e4567e89b12d3a456426614174000" \
  -H "Cookie: better-auth.session_token=<token>"