Sign in
budgets

Store new budget limit.

Store a new budget limit under this budget.

post/v1/budgets/{id}/limits

Request

  • Base URL: https://demo.firefly-iii.org/api
  • URL: https://demo.firefly-iii.org/api/v1/budgets/{id}/limits
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://demo.firefly-iii.org/oauth/authorize, token URL https://demo.firefly-iii.org/oauth/token)
    • HTTP bearer

Path parameters

idstring required
Example:123

The ID of the budget.

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Request body

currency_idstring string

Use either currency_id or currency_code. Defaults to the user's primary currency.

currency_codestring string

Use either currency_id or currency_code. Defaults to the user's primary currency.

budget_idstring string required

The budget ID of the associated budget.

startstring date required

Start date of the budget limit.

periodstring string nullable

Period of the budget limit. Only used when auto-generated by auto-budget.

endstring date required

End date of the budget limit.

amountstring amount required
notesstring string nullable

Some notes for this specific budget limit.

fire_webhooksboolean

Whether or not to fire the webhooks that are related to this event.

Example request

{
  "currency_id": "5",
  "currency_code": "EUR",
  "budget_id": "23",
  "start": "2025-10-01",
  "period": "monthly",
  "end": "2025-10-31",
  "amount": "123.45",
  "notes": "Some example notes",
  "fire_webhooks": true
}

Response

New budget limit stored, result in response.

Changes

No recorded changes to this endpoint across all 1 revision of this API.