Sign in
budget

Calculate potential budget usage, for use while creating/setting budgets

get/v1/org/{orgId}/budget/calculate-usage

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

groupIdsstring

Group ids

costExprstring

Cost expression to calculate

currencystring

Currency to calculate in

datestring date

Date to retrieve as of

costBasisstring

Cost basis: ANNUALIZED or PERIOD_TOTAL (defaults to the org default, else PERIOD_TOTAL)

startDatestring date

Period start date (required for PERIOD_TOTAL)

endDatestring date

Period end date (required for PERIOD_TOTAL)

Response

successful operation

basis'ANNUALIZED' | 'PERIOD_TOTAL' required
openJobsMissingCompAndBandinteger

Count of open (unfilled) jobs in scope that have neither their own comp nor a comp band

Changes

Changed in 1 of the 10 revisions of this API.14

  • b1eb05de45cd14See the full diff
    • ▲

      removed the success response with the status

      response-success-status-removed

    • ○

      added the new optional query request parameter costBasis

      new-optional-request-parameter

    • ○

      added the new optional query request parameter endDate

      new-optional-request-parameter

    • ○

      added the new optional query request parameter startDate

      new-optional-request-parameter

    • ○

      added the success response with the status

      response-success-status-added