Budgets - Get Budget overview

API Url

Used to get the budget overview values grouped by date , node and totals

GET

http://localhost:16010/ProMarkREST/web/Budgets/budget-overview

Permissions: user

Query parameters

Field	Type	Description
contextId`optional`	String	The id of the node.
contextType`optional`	Number	The type of the node.
from`optional`	Date
granularity`optional`	Number	1 = day , 2 = week , 3 = month.
Ids`optional`	String	Comma seperated list of budget ids to get the overview for.
to`optional`	Date

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
budgetOverviewValues	Object[]
perDateValues	Object[]
date	Date
description	String	The description of the node.
leafId	String	The Id of the node.
leafType	Number	Type of the leaf , 1 = department , 2 = group , 3 = approval group.
values	Object[]
budgetId	Number	The Id of the budget , -1 for cost.
name	String	The name of the budget.
type	Number	The type of the budget , 0 = currency , 1 = hours.
value	Number	The values for the day for the budget.
values	Number	The values for the day for the budget.
perLeafValues	Object[]
totals	Object[]
budgetId	String	The Id of the budget , -1 for cost.
type	Number	The type of the budget , 0 = currency , 1 = hours.
value	String	The values for the day for the budget.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example with a single shift:

HTTP/1.1 200 OK
{
    "response": {
        "data": {
            "budgetOverviewValues": {
                "perDateValues": [
                    {
                        "date": "2020-10-26",
                        "values": [
                            {
                                "budgetId": -1,
                                "type": 0,
                                "value": 271.25,
                                "name": "Cost"
                            },
                            {
                                "budgetId": 2164908929,
                                "type": 0,
                                "value": 1000.0,
                                "name": "Overview1"
                            },
                            {
                                "budgetId": 2164909027,
                                "type": 0,
                                "value": 500.0,
                                "name": "Overview 2"
                            }
                        ]
                    },
                    {
                        "date": "2020-10-27",
                        "values": [
                            {
                                "budgetId": -1,
                                "type": 0,
                                "value": 271.25,
                                "name": "Cost"
                            },
                            {
                                "budgetId": 2164908929,
                                "type": 0,
                                "value": 1000.0,
                                "name": "Overview1"
                            },
                            {
                                "budgetId": 2164909027,
                                "type": 0,
                                "value": 500.0,
                                "name": "Overview 2"
                            }
                        ]
                    },
                    {
                        "date": "2020-10-28",
                        "values": [
                            {
                                "budgetId": -1,
                                "type": 0,
                                "value": 311.25,
                                "name": "Cost"
                            },
                            {
                                "budgetId": 2164908929,
                                "type": 0,
                                "value": 1000.0,
                                "name": "Overview1"
                            },
                            {
                                "budgetId": 2164909027,
                                "type": 0,
                                "value": 500.0,
                                "name": "Overview 2"
                            }
                        ]
                    },
                    {
                        "date": "2020-10-29",
                        "values": [
                            {
                                "budgetId": -1,
                                "type": 0,
                                "value": 271.25,
                                "name": "Cost"
                            },
                            {
                                "budgetId": 2164908929,
                                "type": 0,
                                "value": 1000.0,
                                "name": "Overview1"
                            },
                            {
                                "budgetId": 2164909027,
                                "type": 0,
                                "value": 500.0,
                                "name": "Overview 2"
                            }
                        ]
                    },
                    {
                        "date": "2020-10-30",
                        "values": [
                            {
                                "budgetId": -1,
                                "type": 0,
                                "value": 196.25,
                                "name": "Cost"
                            },
                            {
                                "budgetId": 2164908929,
                                "type": 0,
                                "value": 1000.0,
                                "name": "Overview1"
                            },
                            {
                                "budgetId": 2164909027,
                                "type": 0,
                                "value": 500.0,
                                "name": "Overview 2"
                            }
                        ]
                    },
                    {
                        "date": "2020-10-31",
                        "values": [
                            {
                                "budgetId": -1,
                                "type": 0,
                                "value": 0.0,
                                "name": "Cost"
                            },
                            {
                                "budgetId": 2164908929,
                                "type": 0,
                                "value": 1000.0,
                                "name": "Overview1"
                            },
                            {
                                "budgetId": 2164909027,
                                "type": 0,
                                "value": 500.0,
                                "name": "Overview 2"
                            }
                        ]
                    },
                    {
                        "date": "2020-11-01",
                        "values": [
                            {
                                "budgetId": 2164908929,
                                "type": 0,
                                "value": 1000.0,
                                "name": "Overview1"
                            },
                            {
                                "budgetId": 2164909027,
                                "type": 0,
                                "value": 500.0,
                                "name": "Overview 2"
                            }
                        ]
                    },
                    {
                        "date": "2020-11-02",
                        "values": [
                            {
                                "budgetId": -1,
                                "type": 0,
                                "value": 271.25,
                                "name": "Cost"
                            },
                            {
                                "budgetId": 2164908929,
                                "type": 0,
                                "value": 1000.0,
                                "name": "Overview1"
                            },
                            {
                                "budgetId": 2164909027,
                                "type": 0,
                                "value": 500.0,
                                "name": "Overview 2"
                            }
                        ]
                    },
                    {
                        "date": "2020-11-03",
                        "values": [
                            {
                                "budgetId": -1,
                                "type": 0,
                                "value": 271.25,
                                "name": "Cost"
                            },
                            {
                                "budgetId": 2164908929,
                                "type": 0,
                                "value": 1000.0,
                                "name": "Overview1"
                            },
                            {
                                "budgetId": 2164909027,
                                "type": 0,
                                "value": 500.0,
                                "name": "Overview 2"
                            }
                        ]
                    },
                    {
                        "date": "2020-11-04",
                        "values": [
                            {
                                "budgetId": -1,
                                "type": 0,
                                "value": 311.25,
                                "name": "Cost"
                            },
                            {
                                "budgetId": 2164908929,
                                "type": 0,
                                "value": 1000.0,
                                "name": "Overview1"
                            },
                            {
                                "budgetId": 2164909027,
                                "type": 0,
                                "value": 500.0,
                                "name": "Overview 2"
                            }
                        ]
                    },
                    {
                        "date": "2020-11-05",
                        "values": [
                            {
                                "budgetId": -1,
                                "type": 0,
                                "value": 271.25,
                                "name": "Cost"
                            },
                            {
                                "budgetId": 2164908929,
                                "type": 0,
                                "value": 1000.0,
                                "name": "Overview1"
                            },
                            {
                                "budgetId": 2164909027,
                                "type": 0,
                                "value": 500.0,
                                "name": "Overview 2"
                            }
                        ]
                    }
                ],
                "perLeafValues": [
                    {
                        "leafId": "WAREHOUSE",
                        "leafType": 1,
                        "description": "FGN warehouse department",
                        "values": [
                            {
                                "budgetId": -1,
                                "type": 0,
                                "value": 2446.25,
                                "name": "Cost"
                            },
                            {
                                "budgetId": 2164908929,
                                "type": 0,
                                "value": 11000.0,
                                "name": "Overview1"
                            },
                            {
                                "budgetId": 2164909027,
                                "type": 0,
                                "value": 5500.0,
                                "name": "Overview 2"
                            }
                        ]
                    }
                ],
                "totals": [
                    {
                        "budgetId": -1,
                        "type": 0,
                        "value": 2446.25
                    },
                    {
                        "budgetId": 2164908929,
                        "type": 0,
                        "value": 11000.0
                    },
                    {
                        "budgetId": 2164909027,
                        "type": 0,
                        "value": 5500.0
                    }
                ]
            }
        }
    }
}