Create Opening Balance Equity Account
POST/api/ledger/opening-balance/equity-account
Create the provider-conventional "Opening Balance Equity" account when the chart of accounts has none, so the opening-balance form's balancing-equity selector has something to point at. The created account is type Equity and is a never-synced internal plug. Its code is the first free preferred code (970, then 3000, then 9999, then numerically incremented past the last candidate), checked against ALL codes including archived ones since code is the unique key.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token + accounting.manage_settings.
Idempotent: if an account whose name contains "opening balance" already exists, that existing account is returned and no new account is created.
No request body. Returns the created (or existing) nominal code as data.nominal_code.
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.