Get company budgets

get/v1/public/budgets

Query parameters

fromDatestring

Example:2021-01-31T20:00:00.000-05:00

a date in ISO-8601 format (2021-01-31T20:00:00.000-05:00). If set, only budgets starting at or after this date will be returned

toDatestring

Example:2021-05-10T20:00:00.000-04:00

a date in ISO-8601 format (2021-01-31T20:00:00.000-05:00). If set, only budgets starting before this date will be returned

forNameContainingstring

Example:office

If specify, only budgets having a name in any languages containing the search text will be returned.The search is case insensitive. For budgets named "Main office Calgary" and "Office New York" and searching for "Office" both budgets are returned.

Response

uidstring required

unique budget id

namesobject required

Multilingual name as a map indexed by locale ("en" or "fr")

valuenumber required

The value (amount) of the budget

teamIdsstring[]

the budget team UIDs

teamCodesstring[]

the budget team codes

skillIdsstring[]

the budget skill (position) UIDs

skillICodesstring[]

the budget skill (position) codes

locationIdsstring[]

the budget location UIDs

locationCodesstring[]

the budget location codes

effectiveFromnumber

If specified, the effective start date of the budget

effectiveTonumber

If specified, the effective end date of the budget

Example response

[
  {
    "names": {
      "en": "Main Office Budget",
      "fr": "Budget Maison Mère"
    }
  }
]

Changes

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