Skip to main content
POST
/
v0
/
budgets
Create Budget
curl --request POST \
  --url https://api.sumvin.com/v0/budgets/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "original_request": "<string>",
  "category_name": "<string>",
  "budget_type": "weekly",
  "limit_amount": "<string>",
  "currency": "<string>",
  "period_start": 123,
  "period_end": 123
}
'
{
  "_links": {},
  "budget": {
    "id": "<string>",
    "name": "<string>",
    "original_request": "<string>",
    "category_name": "<string>",
    "budget_type": "weekly",
    "limit_amount": "<string>",
    "currency": "<string>",
    "spent": "<string>",
    "remaining": "<string>",
    "daily_avg": "<string>",
    "period_start": 123,
    "period_end": 123,
    "created_at": 123,
    "updated_at": 123,
    "transactions": [
      {
        "transaction_id": "<string>",
        "amount": "<string>",
        "amount_in_budget_currency": "<string>",
        "timestamp": 123,
        "running_total": "<string>"
      }
    ]
  }
}

Headers

x-juno-orgid
string | null

Tenant org ID for multi-tenant auth

x-sumvin-token
string | null
x-juno-jwt
string | null

Body

application/json
name
string
required
Required string length: 1 - 100
original_request
string
required
category_name
string
required
budget_type
enum<string>
required
Available options:
weekly,
monthly,
yearly,
custom
limit_amount
string
required
currency
string
required
period_start
integer | null

Period start timestamp in milliseconds. Required for CUSTOM budgets, ignored for recurring types.

period_end
integer | null

Period end timestamp in milliseconds. Required for CUSTOM budgets, ignored for recurring types.

Response

Budget created successfully

HAL-style hypermedia links for navigation and available actions.

budget
BudgetData · object
required