Usage

Read what the account has spent

GET /credits says what is left to spend; this says what has been spent, and on what: the ledger entries, plus the same amounts by month, by cost line, by project and by tracker. The amounts outside by_month are a cumulative total over period, never a monthly figure, so quote the period alongside the amount. this_month_forecast is the month in progress: report it as a forecast, never as spend.

get/usage

Request

  • Base URL: https://api.epovest.com/v1
  • URL: https://api.epovest.com/v1/usage
  • Auth: HTTP bearer

Query parameters

monthstring

YYYY-MM narrows everything to one month.

type'in' | 'out'

Narrows entries[] alone, since both breakdowns are spend by nature.

pageinteger

Clamped, not rejected: ask for page 99 of 3 and you get page 3 back, with pagination.page saying 3. Stop on pagination.page >= pagination.pages.

per_pageinteger

Response

The spend of the period.

currencystring required
monthstring nullable required

The month asked for, as YYYY-MM.

total_spent_minorinteger required

The check spend of the period, matching the sum of both breakdowns.

months_totalinteger required

How many months have spend, so you can tell whether twelve covered everything.

Changes

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