Budgeting item

A budgeting item.

Create a budgeting item

Create a new budgeting item.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing budgeting item information.

name
required
string <= 1000 characters

The name of the new budgeting item.

calculation
string

The budgeting term of the new budgeting item.

unit
required
integer

The unit of the new budgeting item.

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

The factor of the new budgeting item.

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

The number of decimals of the new budgeting item.

suffix
string <= 1000 characters

The suffix of the new budgeting item.

period_type
required
integer

The period type of the new budgeting item.

  • 1 - Overall
  • 2 - Actual year
  • 3 - Previous year
  • 4 - Pre previous year
  • 5 - Upcoming year
  • 6 - Year to date
  • 7 - Date to year
  • 8 - Start to date
  • 9 - Date to start
  • 10 - Actual period
  • 11 - Previous period
  • 12 - Pre previous period
  • 13 - Upcoming period
Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13
aggregation_type_horizontal
required
integer

The horizontal aggregation type of the new budgeting item.

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

The vertical aggregation type of the new budgeting item.

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

The target type of the new budgeting item.

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

The yellow threshold of the new budgeting item.

threshold_red
required
integer [ -100 .. 100 ]

The red threshold of the new budgeting item.

budgeting_category_id
required
integer >= 1

The budgeting category id of the new budgeting item.

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_id": 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.

Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

get/budgetingitem
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "971302cbc7ccc8424c2fe64041c71dbfeb1509a1",
  • "data": [
    ],
  • "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

The budgeting term of the budgeting item.

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.

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

The the number of 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 - Actual year
  • 3 - Previous year
  • 4 - Pre previous year
  • 5 - Upcoming year
  • 6 - Year to date
  • 7 - Date to year
  • 8 - Start to date
  • 9 - Date to start
  • 10 - Actual period
  • 11 - Previous period
  • 12 - Pre previous period
  • 13 - Upcoming period
Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13
aggregation_type_horizontal
integer

The horizontal aggregation type of the budgeting item.

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

The vertical aggregation type of the budgeting item.

  • 1 - Sum
  • 2 - Average
Enum: 1 2
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.

threshold_red
integer [ -100 .. 100 ]

The red threshold of the budgeting item.

budgeting_category_id
integer >= 1

The budgeting category id 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_id": 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 new position in relation to the budgeting item.

Enum: "before" "after"
budgeting_item_id
required
integer >= 0

The budgeting item to position the given budgeting item to.

Responses
200

Successful operation

404

Not Found

put/budgetingitem/{budgetingitem}/position
Request samples
application/json
{
  • "position": "after",
  • "budgeting_item_id": 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
}