BoringBooks API reference

create_account

POST /api/v1/commands/create_account

Base URL: https://boringbooks.io.

Request body

FieldTypeRequiredDescription
codestringyesAccount code, unique per ledger Min length: 1. Max length: 255.
ledger_idstring (uuid)yesExternal id of the ledger this account belongs to
namestringyesMin length: 1. Max length: 255.
typestringyesOne of the five account types One of: asset, liability, equity, revenue, expense.
contrabooleannoBalance runs against the type's normal side Default: false.
postablebooleannoA leaf that journals may post to Default: true.

Example:

{
  "code": "1000",
  "ledger_id": "11111111-1111-4111-8111-111111111111",
  "name": "Cash",
  "type": "asset"
}

Response (200)

FieldTypeRequiredDescription
codestringyes
idstring (uuid)yesExternal id of the new account
namestringyes
typestringyes

Errors

Every error response is a single error object with a closed type and a refining code. The codes, and the conventions every operation shares, are in llms-full.txt.