Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
budget

Get a budget by id or slug

get/v1/org/{orgId}/budget/{budgetId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

budgetIdstring required

Budget id or slug

Query parameters

datestring date

Date to get budget data as-of (defaults to today)

Response

ok

idstring required

globally unique id

orgIdstring required

parent organization id

slugstring required

url-safe slug for the budget, auto-generated from label if not provided

labelstring

human-readable label for the budget

ownerPersonIdsstring[]

list of persons who own this budget

groupIdsstring[]

list of group IDs (e.g. department) for this budget

colorstring

color of budget

startDatestring date required

start date of the budget

endDatestring date required

end date of the budget

sensitive'GLOBAL' | 'ORG' | 'SENSITIVE' | 'PERSONAL' | 'MANAGER' | 'HIGH' | 'PRIVATE' required

sensitivity level of budget

costExprstring

calculation to compute cost

costBasis'ANNUALIZED' | 'PERIOD_TOTAL'

cost measurement basis for this budget; null inherits the org default

status'DRAFT' | 'ACTIVE' | 'ARCHIVED' required

status of the budget

effectiveCostBasis'ANNUALIZED' | 'PERIOD_TOTAL'

effective cost basis after applying the org-default fallback (computed on read)

baselinedAtstring

instant this budget first became ACTIVE, freezing its baseline (null while never activated); set once by the server on the first DRAFT->ACTIVE transition, never re-stamped (sc-123222)

createDatestring date required

when this budget starts existing in org history

deleteDatestring date

when this budget stops existing in org history (null if still active)

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "ownerPersonIds": [
    "588f7ee98f138b19220041a7"
  ],
  "groupIds": [
    "588f7ee98f138b19220041a7"
  ],
  "shareAccess": [
    {
      "userId": "5887a7718f138b6a2a0041a7",
      "groupId": "5887a7718f138b6a2a0041a7",
      "fields": "name,image,title"
    }
  ],
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z"
}