BoringBooks API reference

create_dimension_definition

POST /api/v1/commands/create_dimension_definition

Base URL: https://boringbooks.io.

Request body

FieldTypeRequiredDescription
keystringyesThe dimension's name, unique within the ledger, with no leading or trailing spaces Min length: 1. Max length: 255.
ledger_idstring (uuid)yes
value_policyobject, nullablenoThe values a line may carry for this dimension, as {"values": ["sales", "ops"]}. Omit it, or send null, to accept any value.
value_policy.valuesarray of stringyesDistinct values with no leading or trailing spaces Min items: 1.

Example:

{
  "key": "department",
  "ledger_id": "11111111-1111-4111-8111-111111111111"
}

Response (200)

FieldTypeRequiredDescription
idstring (uuid)yes
keystringyes

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.