Manually close the current period of a rollover-enabled budget

POST

/budgets/{id}/close-period

const url = 'http://localhost:8000/api/v1/budgets/1/close-period';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:8000/api/v1/budgets/1/close-period \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

required

integer

Responses

200

Period closed

application/json

object

integer

owner_id

integer

owner_type

string

name

string

slug

string

description

string

nullable

amount

number format: float

currency

string

period_type

string

Allowed values: weekly monthly yearly custom

start_date

string format: date

end_date

string format: date

nullable

rollover_enabled

boolean

threshold_percent

integer

forecast_alerts_enabled

boolean

is_active

boolean

targets

Array<object>

object

type

string

Allowed values: category group wallet

integer

client_generated_id

string

nullable

name

string

progress

object

period_start

string format: date

period_end

string format: date

limit

number format: float

gross_spent

number format: float

refunds

number format: float

net_spent

number format: float

rollover_in

number format: float

effective_limit

number format: float

remaining

number format: float

percent_used

integer

projected_spend

number format: float

status

string

Allowed values: on_track near_limit over_budget forecast_breach

client_generated_id

string

nullable

last_synced_at

string format: date-time

nullable

created_at

string format: date-time

updated_at

string format: date-time

deleted_at

string format: date-time

nullable

Example

{
  "owner_type": "App\\Models\\User",
  "currency": "USD",
  "period_type": "weekly",
  "threshold_percent": 80,
  "targets": [
    {
      "type": "category"
    }
  ],
  "progress": {
    "status": "on_track"
  }
}

404

Budget not found

422

Rollover not enabled