Create a custom managerial bucket

POST /api/v1/businesses/{business_id}/cfo-portal/buckets

Create a new custom managerial bucket for categorizing GL accounts.

The bucket key must be unique and cannot conflict with default bucket keys. Use lowercase letters, numbers, and underscores only.

Operation ID: cfo_portal_create_bucket_api_v1_businesses__business_id__cfo_portal_buckets_post · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

business_id string required

Request body

Schema: CustomBucketCreateRequest

key string required

Unique slug for the bucket (lowercase, underscores allowed)

label string required

Display name for the bucket

color string

Color theme: green, orange, indigo, accent, gray

classification string

Bucket classification: operating_revenue, cogs, operating_expense, other_income, other_expense

sort_order integer

Responses

201 Successful Response

Schema: CustomBucketResponse

id string required
key string required
label string required
color string required
classification string required
sort_order integer required
is_active boolean required
is_default boolean

True for built-in default buckets

can_delete boolean

Whether the bucket can be deleted from Recipe Book. Some built-in buckets are locked.

400 Bad Request - Invalid input

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError
5 fields
loc array · string | integer required
msg string required
type string required
input object
ctx object