budget

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

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

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/budget/calculate-usage
  • Auth: none declared

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

  • b1eb05de45cdRevision changes
    • breaking

      removed the success response with the status

    • info

      added the new optional query request parameter costBasis

    • info

      added the new optional query request parameter endDate

    • info

      added the new optional query request parameter startDate

    • info

      added the success response with the status