Skip to content
Patrimoine
v9.1.0

Create Budget Endpoint

POST
/api/v1/budget/budgets
curl --request POST \
  --url https://example.com/api/v1/budget/budgets \
  --header 'Content-Type: application/json' \
  --data '{ "category_id": 1, "subcategory_id": 1, "monthly_limit": 1, "rollover_enabled": false }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
BudgetCreate
object
category_id
required
Category Id
integer
subcategory_id
Any of:
integer
monthly_limit
required
Any of:
number
> 0
rollover_enabled
Rollover Enabled
boolean

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
BudgetOut
object
id
required
Id
integer
user_id
required
User Id
integer
legacy_category
required
Any of:
string
category_id
required
Category Id
integer
subcategory_id
required
Any of:
integer
monthly_limit
required
Monthly Limit
string
rollover_enabled
required
Rollover Enabled
boolean
archived
required
Archived
boolean
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

Example generated

{
  "id": 1,
  "user_id": 1,
  "legacy_category": "example",
  "category_id": 1,
  "subcategory_id": 1,
  "monthly_limit": "example",
  "rollover_enabled": true,
  "archived": true,
  "created_at": "2026-04-15T12:00:00Z",
  "updated_at": "2026-04-15T12:00:00Z"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Example generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}