Budgets - Get budgets
API Url
Use it to return all budgets
GET
http://localhost:16010/ProMarkREST/web/System/budgets
Permissions: user
Success 200
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| budgets | Object[] | |
| budgetType | Number | The budget type. |
| description | String | The budget description. |
| firstPeriods | Object[] | |
| contextId | String | The parent id of the budget. |
| contextType | Number | The parent type of the budget. |
| from | Date | Start date of the first period. |
| id | Number | The id of the budget. |
| isApproved | Boolean | TRUE if the budget is approved. |
| isPublished | Boolean | TRUE if the budget is published. |
| name | String | The name of the budget. |
messageoptional | Object | Object containing response messages. |
| code | Number | Message code. |
| text | String | Message text. |
| type | String | Type of message. "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"}]}]}}}