Recompute and return a budget's progress for the current period

GET

/budgets/{id}/progress

const url = 'http://localhost:8000/api/v1/budgets/1/progress';
const options = {method: 'GET', 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 GET \
  --url http://localhost:8000/api/v1/budgets/1/progress \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

required

integer

Responses

200

Progress snapshot

application/json

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

Example

{
  "status": "on_track"
}

404

Budget not found