- 1 Minute to read
- Print
- DarkLight
- PDF
Entity Status
- 1 Minute to read
- Print
- DarkLight
- PDF
With this release, we have introduced an API that allows you to get the status of a specified entity from the Budget Entity Hierarchy, including the roll-ups for a selected scenario. This helps you to know the progress of cost center budgeting. This functionality will significantly reduce the manual work and time involved in tracking the status of cost centers during the budgeting. In the output file, Budget Entity Code and Budget Entity Name are separate entries.
You will be able to filter the data based on either Budget Entity Code or Budget Entity Label.
Method
POST
Endpoint Url Syntax
Content Type
application/json
Headers
Key | Value |
---|---|
APIKey | Key |
Sample Request
{
"FilterOption" : "Label",
"ScenarioCode" : "Budget 2014",
"BudgetEntities":["Budget Hierarchy","new2","1000 - Host BGT NTY'"]
}
or
{
"FilterOption" : "Code",
"ScenarioCode" : "Budget 2014",
"BudgetEntities":[1000'"]
}
or
{
"ScenarioCode" : "Budget 2014"
}
Sample Reponse
{
"BudgetEntities": [
{
"Name": "Budget Hierarchy",
"Id": 1,
"Status": "InProgress",
"Children": [
{
"Name": "Level2",
"Id": 29,
"Status": "Forwarded",
"Children": [
{
"Name": "Level3",
"Id": 30,
"Status": "Forwarded",
"Children": [
{
"Name": "Level4",
"Id": 31,
"Status": "Forwarded",
"Children": []
}
]
}
]
},
{
"Name": "new2",
"Id": 28,
"Status": "InProgress",
"Children": []
},
{
"Name": "BGT HIER",
"Id": 4,
"Status": "Approved",
"Children": [
{
"Name": "2020 - Host Spain",
"Id": 3,
"Status": "Approved",
"Children": []
},
{
"Name": "1000 - Host BGT NTY",
"Id": 2,
"Status": "Approved",
"Children": []
}
]
},
{
"Name": "New R",
"Id": 24,
"Status": "InProgress",
"Children": []
},
{
"Name": "ATB ENTITY",
"Id": 6,
"Status": "InProgress",
"Children": []
},
{
"Name": "12,6 entity exception",
"Id": 11,
"Status": "InProgress",
"Children": []
},
{
"Name": "formual error exception",
"Id": 12,
"Status": "InProgress",
"Children": []
},
{
"Name": "Div/zero exception",
"Id": 13,
"Status": "InProgress",
"Children": []
},
{
"Name": "MTD\\YTD\\Debit\\Credit exception",
"Id": 14,
"Status": "InProgress",
"Children": []
},
{
"Name": "Host Mexico - Host Mexico",
"Id": 15,
"Status": "InProgress",
"Children": []
},
{
"Name": "Host USD - Host USD",
"Id": 16,
"Status": "InProgress",
"Children": []
},
{
"Name": "New - New",
"Id": 20,
"Status": "InProgress",
"Children": []
}
]
}
]
}