Skip to content
calternal docs

Create a Category

POST
/api/v1/money/budgets/{budget_id}/categories
curl --request POST \
  --url https://example.com/api/v1/money/budgets/example/categories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "group": "example", "name": "example" }'

Add an expense Category to a group in the budget. The response returns its ID, name, and group. Route: /api/v1/money/budgets/{budget_id}/categories. Inputs: budget_id. Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
budget_id
required
string

Budget ID

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Create an expense category in a group (the group is created if needed).

object
group
required

Group name.

string
name
required

Category name.

string
Examplegenerated
{
  "group": "example",
  "name": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

The new category

Media typeapplication/json

A created category.

object
group
required

Group name.

string
id
required

Category ID.

string
name
required

Display name.

string
Examplegenerated
{
  "group": "example",
  "id": "example",
  "name": "example"
}

400

Section titled “400”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

404

Section titled “404”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

409

Section titled “409”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}