Budgets - Get budgets

API Url

Use it to return all budgets

GET
http://localhost:16010/ProMarkREST/web/System/budgets

Permissions: user

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

    budgetsObject[]
      budgetTypeNumber

The budget type. 0: Cost 1: Hours 2: Manning 3: Other

      descriptionString

The budget description.

      firstPeriodsObject[]
        contextIdString

The parent id of the budget.

        contextTypeNumber

The parent type of the budget. 1: Department 2: Group 3: Approval group

        fromDate

Start date of the first period.

      idNumber

The id of the budget.

      isApprovedBoolean

TRUE if the budget is approved.

      isPublishedBoolean

TRUE if the budget is published.

      nameString

The name of the budget.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Success example:

HTTP/1.1 200 OK
{
"response": {
"data": {
"budgets": [
{
"id": 2164713849,
"budgetId": "Budget1",
"budgetType": 1,
"description": "description here",
"isPublished": false,
"isApproved": false,
"firstPeriods": [
{
"contextType": 1,
"contextId": "CONTEX1",
"from": "2020-06-16"
},
{
"contextType": 1,
"contextId": "CONTEXT2",
"from": "2020-05-21"
}
]
}
]
}
}
}