Budgeting item

A budgeting item.

Create a budgeting item

Create a new budgeting item for a budgeting category.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing budgeting item information.

name
required
string <= 1000 characters

The name of the budgeting item.

calculation
string or integer <= 1000 characters

The calculation for the budgeting term of the budgeting item.

Formulas and constants can be entered here, which will be executed for each period of budgeting. As a reference to other budgeting items, the operand (with a leading hashtag) can be used here.

unit
required
integer

The unit of the budgeting item.

  • 1 - Currency
  • 2 - Quantity
  • 3 - Achievement
Enum: 1 2 3
factor
integer

The factor of the budgeting item.

  • 0 - None
  • 1 - Thousand
  • 2 - Million
Enum: 0 1 2
decimals
integer or null [ 0 .. 5 ]

The number of displayed decimals of the budgeting item.

suffix
string <= 1000 characters

The suffix of the budgeting item.

period_type
required
integer

The period type of the budgeting item.

  • 1 - Overall
  • 2 - Pre previous year
  • 3 - Previous year
  • 4 - Year to date
  • 5 - Actual year
  • 6 - Date to year
  • 7 - Upcoming year
  • 8 - Last year
  • 9 - Start to date
  • 10 - Rolling year to date
  • 11 - Pre previous period
  • 12 - Previous period
  • 13 - Actual period
  • 14 - Upcoming period
  • 15 - Date to rolling year
  • 16 - Date to end
  • 17 - Last period
Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
aggregation_type_horizontal
required
integer

The horizontal aggregation type of the budgeting item.

  • 1 - Sum
  • 2 - Average
  • 3 - Calculation
  • 4 - Last period
Enum: 1 2 3 4
aggregation_type_vertical
required
integer

The vertical aggregation type of the budgeting item.

  • 1 - Sum
  • 2 - Average
  • 3 - Calculation
Enum: 1 2 3
target_type
required
integer

The target type of the budgeting item.

  • 1 - More
  • 2 - Less
  • 3 - Spot
Enum: 1 2 3
threshold_yellow
required
integer [ -100 .. 100 ]

The yellow threshold of the budgeting item.

The value must be greater or equal to the red threshold.

threshold_red
required
integer [ -100 .. 100 ]

The red threshold of the budgeting item.

The value must be smaller or equal to the yellow threshold.

budgeting_category
required
string or integer

The budgeting category of the budgeting item.

Without a budgeting category the request will always return a 403 Forbidden response.

Responses
201

Successful operation

422

Unprocessable Content

post/budgetingitem
Request samples
application/json
{
  • "name": "Inventory",
  • "unit": 1,
  • "factor": 1,
  • "period_type": 2,
  • "aggregation_type_horizontal": 2,
  • "aggregation_type_vertical": 2,
  • "target_type": 3,
  • "threshold_yellow": 90,
  • "threshold_red": 70,
  • "budgeting_category": 5
}
Response samples
application/json
{
  • "success": true,
  • "hash": "6d8197b5d60e946dcf1ea632bb3b6fb3718f440f",
  • "data": {
    },
  • "timestamp": 1657709165396
}

Get all budgeting items

Get all budgeting items of the authenticated hub.

SecurityJWT
Request
query Parameters
measure
string or integer

Filter the budgeting item list for a measure.

measure_package
string or integer

Filter the budgeting item list for a measure package.

project
string or integer

Filter the budgeting item list for a project.

program
string or integer

Filter the budgeting item list for a program.

budgeting
string or integer

Filter the budgeting item list for a budgeting.

page
integer
Default: 1

The page number of the response.

Responses
200

Successful operation

422

Unprocessable Content

get/budgetingitem
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "971302cbc7ccc8424c2fe64041c71dbfeb1509a1",
  • "data": [
    ],
  • "meta": {
    },
  • "timestamp": 1657709807411
}
Get a budgeting item
Get a budgeting item.


SecurityJWT 
Request 
path Parameters
budgetingitem
required
string or integer
The id/hash of the budgeting item.


 
Responses 
200
Successful operation


404
Not Found


get/budgetingitem/{budgetingitem}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "0df7d6bdc596a5e4d0dc7ed69b593a0774bbe8f8",
  • "data": {
    },
  • "timestamp": 1657710969284
}
Update a budgeting item
Update a budgeting item.


SecurityJWT 
Request 
path Parameters
budgetingitem
required
string or integer
The id/hash of the budgeting item.


 
Request Body schema: application/json
A JSON object containing budgeting item information


name
string  <= 1000 characters 
The name of the budgeting item.


 
calculation
string or integer  <= 1000 characters 
The calculation for the budgeting term of the budgeting item.
Formulas and constants can be entered here, which will be executed for each period of budgeting. As a reference to other budgeting items, the operand (with a leading hashtag) can be used here.
 
unit
integer
The unit of the budgeting item.


    

  • 1 - Currency
    • 

  • 2 - Quantity
    • 

  • 3 - Achievement
    • 



 Enum: 1 2 3  
factor
integer
The factor of the budgeting item.


    

  • 0 - None
    • 

  • 1 - Thousand
    • 

  • 2 - Million
    • 



 Enum: 0 1 2  
decimals
integer or null  [ 0 .. 5 ] 
The number of displayed decimals of the budgeting item.


 
suffix
string  <= 1000 characters 
The suffix of the budgeting item.


 
period_type
integer
The period type of the budgeting item.


    

  • 1 - Overall
    • 

  • 2 - Pre previous year
    • 

  • 3 - Previous year
    • 

  • 4 - Year to date
    • 

  • 5 - Actual year
    • 

  • 6 - Date to year
    • 

  • 7 - Upcoming year
    • 

  • 8 - Last year
    • 

  • 9 - Start to date
    • 

  • 10 - Rolling year to date
    • 

  • 11 - Pre previous period
    • 

  • 12 - Previous period
    • 

  • 13 - Actual period
    • 

  • 14 - Upcoming period
    • 

  • 15 - Date to rolling year
    • 

  • 16 - Date to end
    • 

  • 17 - Last period
    • 



 Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17  
aggregation_type_horizontal
integer
The horizontal aggregation type of the budgeting item.


    

  • 1 - Sum
    • 

  • 2 - Average
    • 

  • 3 - Calculation
    • 

  • 4 - Last period
    • 



 Enum: 1 2 3 4  
aggregation_type_vertical
integer
The vertical aggregation type of the budgeting item.


    

  • 1 - Sum
    • 

  • 2 - Average
    • 

  • 3 - Calculation
    • 



 Enum: 1 2 3  
target_type
integer
The target type of the budgeting item.


    

  • 1 - More
    • 

  • 2 - Less
    • 

  • 3 - Spot
    • 



 Enum: 1 2 3  
threshold_yellow
integer  [ -100 .. 100 ] 
The yellow threshold of the budgeting item.
The value must be greater or equal to the red threshold.
 
threshold_red
integer  [ -100 .. 100 ] 
The red threshold of the budgeting item.
The value must be smaller or equal to the yellow threshold.
 
budgeting_category
string or integer
The budgeting category of the budgeting item.


 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/budgetingitem/{budgetingitem}
Request samples 
application/json
{
  • "calculation": "(#1/#4)*100",
  • "unit": 2,
  • "decimals": 2,
  • "suffix": "%",
  • "target_type": 1,
  • "budgeting_category": 6
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8c6eb45ff7b555231e8b4b600662e502969e74bd",
  • "data": {
    },
  • "timestamp": 1657716457546
}
Delete a budgeting item
Delete a budgeting item.


SecurityJWT 
Request 
path Parameters
budgetingitem
required
string or integer
The id/hash of the budgeting item.


 
Responses 
200
Successful operation


404
Not Found


delete/budgetingitem/{budgetingitem}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1657717012079
}
Position a budgeting item
Position a budgeting item in relation to another budgeting item.


SecurityJWT 
Request 
path Parameters
budgetingitem
required
string or integer
The id/hash of the budgeting item.


 
Request Body schema: application/json
A JSON object containing budgeting item information.


position
required
string
The position in relation to the budgeting item.


 Enum: "before" "after"  
budgeting_item
required
string or integer
The budgeting item to position the given budgeting item to.
Both budgeting items must belong to the same budgeting.
 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/budgetingitem/{budgetingitem}/position
Request samples 
application/json
{
  • "position": "after",
  • "budgeting_item": 6
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "2f6b655c8c5a594a981c7e68aeca084a4b89b55a",
  • "data": {
    },
  • "timestamp": 1657717449636
}
Restore a budgeting item
Restore a budgeting item.


SecurityJWT 
Request 
path Parameters
budgetingitem
required
string or integer
The id/hash of the budgeting item.


 
Responses 
200
Successful operation


404
Not Found


put/budgetingitem/{budgetingitem}/restore
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1657717207030
}
➔ Next to Budgeting period