Measure budgeting effect

A measure budgeting effect.

Create a measure budgeting effect

Create a new measure budgeting effect for a measure and a budgeting period.

If the measure budgeting effect is already set, the value(s) will be overwritten without any further warning.

SecurityJWT

Request

Request Body schema: application/json

A JSON object containing measure budgeting effect information

value_plan

number or null <float>

The plan value of the measure budgeting effect.

value_actual

number or null <float>

The actual value of the measure budgeting effect.

measure

required

string or integer

The measure of the measure budgeting effect.

Without a measure the request will always return a 403 Forbidden response.

budgeting_item

required

string or integer

The budgeting item of the measure budgeting effect.

budgeting_period

string

The name of the budgeting period of the measure budgeting effect.

The name must be provided in the following formats:

Period type	Format	Example
Weekly	JJJJ-CW-##	2021-CW-20
Monthly	JJJJ-MMM	2021-Mar
Quarterly	JJJJ-QQ	2021-Q1
Yearly	JJJJ	2021
Financial year	JJJJ-JJJJ	2021-2022

Responses

200

Successful operation

201

Successful operation

404

Not Found

422

Unprocessable Content

post/measurebudgetingeffect

Request samples

Payload
curl

application/json

{"value_plan": 59.07105,
"value_actual": 37.11787,
"measure": "264a21089e5720c8dddc67986d5bab827a75b58e",
"budgeting_item": 14,
"budgeting_period": "2024-May"
}

Response samples

application/json

{"success": true,
"hash": "f900def2f6ad5b91ea95df1375724373d0d4fd3b",
"data": {"id": 1965,
"hash": "6ef0dc7571ab349948dce80c6bf5bba381fa7065",
"value_plan": 51.72673,
"value_actual": 55.15539,
"value_delta": 3.42866,
"value_achievement": 106.62841,
"value_traffic_light": 1,
"locked": false,
"created_time": "2022-05-25T09:54:50.000000Z",
"modified_time": "2022-05-25T10:14:53.000000Z",
"modified_user_time": "2022-05-25T10:14:53.000000Z",
"model": "MeasureBudgetingEffect",
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-25T09:02:43.000000Z",
"modified_user_time": "2022-05-25T09:02:43.000000Z",
"model": "User"
}
},
"timestamp": 1653472490807
}

Get all measure budgeting effects

Get all measure budgeting effects of the authenticated hub.

SecurityJWT

Request

query Parameters

measure

string or integer

The measure for which the measure budgeting effects should be displayed.

measure_package

string or integer

The measure package for which the measure budgeting effects should be displayed.

project

string or integer

The project for which the measure budgeting effects should be displayed.

program

string or integer

The program for which the measure budgeting effects should be displayed.

budgeting

string or integer

The budgeting for which the measure budgeting effects should be displayed.

budgeting_item

string or integer

Filter the measure budgeting effects for a budgeting item.

budgeting_category

string or integer

Filter the measure budgeting effects for a budgeting category.

budgeting_period

string

Filter the measure budgeting effects for a budgeting period name.

The name must be provided in the following formats:

Period type	Format	Example
Weekly	JJJJ-CW-##	2021-CW-20
Monthly	JJJJ-MMM	2021-Mar
Quarterly	JJJJ-QQ	2021-Q1
Yearly	JJJJ	2021
Financial year	JJJJ-JJJJ	2021-2022

start_time

string <date-time>

Filter the measure budgeting effects for a budgeting period start time.

The date must be before or equal to the end time.

end_time

string <date-time>

Filter the measure budgeting effects for a budgeting period end time.

The date must be after or equal to the start time.

calculated

boolean

Filter the measure budgeting effects for calculated effects.

filled

boolean

Filter the measure budgeting effects for filled effects.

locked

boolean

Filter the measure budgeting effects for locked effects.

created_user

string or integer

Filter the measure budgeting effects for a created user.

modified_user

string or integer

Filter the measure budgeting effects for a modified user.

page

integer

Default: 1

The page number of the response.

Responses

200

Successful operation

404

Not Found

422

Unprocessable Content

get/measurebudgetingeffect

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "73a69ca66009332f20eca2a2dbe448376ded8791",
"data": [{"id": 25,
"hash": "18d1030364e31007744055b395d074c7cfcfab9a",
"value_plan": 37978.76,
"value_actual": 54009.28,
"value_delta": 16030.52,
"value_achievement": 57.79083,
"value_traffic_light": 3,
"locked": false,
"created_time": "2022-05-04T16:51:39.000000Z",
"modified_time": "2022-05-04T16:51:39.000000Z",
"modified_user_time": "2022-05-04T16:51:39.000000Z",
"model": "MeasureBudgetingEffect",
"measure": {"id": 2,
"hash": "952d544cd1d50a3937b903ee9f0322808baba201",
"name": "Turnover",
"paused": false,
"locked": false,
"model": "Measure",
"measure_package": {"id": 1,
"hash": "7ce83d4d4d933305a5410a7311a6a6f133f37dd5",
"name": "Working Capital",
"model": "MeasurePackage",
"project": {"id": 1,
"hash": "583bf59445f18e7bf566020aa8134ddfa7c79113",
"name": "Phoenix",
"model": "Project",
"program": {"id": 1,
"hash": "1650600bd010a50897b50572382460965fed588a",
"name": "Airborne",
"model": "Program"
}
}
}
},
"budgeting_item": {"id": 5,
"hash": "692e090390928df7fbb99a7918df72d7bb3dbccc",
"position": 5,
"operand": 5,
"name": "Cash",
"unit": 1,
"factor": 1,
"decimals": 1,
"suffix": "",
"period_type": 1,
"aggregation_type_horizontal": 1,
"aggregation_type_vertical": 1,
"target_type": 1,
"threshold_yellow": 90,
"threshold_red": 70,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"format": "€",
"model": "BudgetingItem",
"budgeting_term": null,
"budgeting_category": {"id": 5,
"hash": "5e4deda376707cc38986975c795be8d1e3170a4a",
"position": 2,
"name": "Balance/Cash",
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"model": "BudgetingCategory"
}
},
"budgeting_period": {"id": 2,
"hash": "2178ab015de8d67318944cf2481c672b2bcea2e4",
"name": "2022-May",
"start_time": "2022-05-01",
"end_time": "2022-05-31",
"scaling": 2,
"offset": 0,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"model": "BudgetingPeriod"
},
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
},
{"id": 26,
"hash": "a33e4a036f6f7d90aae71194115e1e9af5a9df7d",
"value_plan": 39928.9,
"value_actual": 25659.55,
"value_delta": -14269.35,
"value_achievement": 135.7369,
"value_traffic_light": 1,
"locked": false,
"created_time": "2022-05-04T16:51:39.000000Z",
"modified_time": "2022-05-04T16:51:39.000000Z",
"modified_user_time": "2022-05-04T16:51:39.000000Z",
"model": "MeasureBudgetingEffect",
"measure": {"id": 2,
"hash": "952d544cd1d50a3937b903ee9f0322808baba201",
"name": "Turnover",
"paused": false,
"locked": false,
"model": "Measure",
"measure_package": {"id": 1,
"hash": "7ce83d4d4d933305a5410a7311a6a6f133f37dd5",
"name": "Working Capital",
"model": "MeasurePackage",
"project": {"id": 1,
"hash": "583bf59445f18e7bf566020aa8134ddfa7c79113",
"name": "Phoenix",
"model": "Project",
"program": {"id": 1,
"hash": "1650600bd010a50897b50572382460965fed588a",
"name": "Airborne",
"model": "Program"
}
}
}
},
"budgeting_item": {"id": 5,
"hash": "692e090390928df7fbb99a7918df72d7bb3dbccc",
"position": 5,
"operand": 5,
"name": "Cash",
"unit": 1,
"factor": 1,
"decimals": 1,
"suffix": "",
"period_type": 1,
"aggregation_type_horizontal": 1,
"aggregation_type_vertical": 1,
"target_type": 1,
"threshold_yellow": 90,
"threshold_red": 70,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"format": "€",
"model": "BudgetingItem",
"budgeting_term": null,
"budgeting_category": {"id": 5,
"hash": "5e4deda376707cc38986975c795be8d1e3170a4a",
"position": 2,
"name": "Balance/Cash",
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"model": "BudgetingCategory"
}
},
"budgeting_period": {"id": 3,
"hash": "4c71b08e08809567e37f1fdb98d5019045667f21",
"name": "2022-Jun",
"start_time": "2022-06-01",
"end_time": "2022-06-30",
"scaling": 2,
"offset": 0,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"model": "BudgetingPeriod"
},
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
},
{"id": 27,
"hash": "f431ca210d53e01d5805830b181b7adf2eef173c",
"value_plan": 31587.34,
"value_actual": 30622.99,
"value_delta": -964.35,
"value_achievement": 103.05296,
"value_traffic_light": 1,
"locked": false,
"created_time": "2022-05-04T16:51:39.000000Z",
"modified_time": "2022-05-04T16:51:39.000000Z",
"modified_user_time": "2022-05-04T16:51:39.000000Z",
"model": "MeasureBudgetingEffect",
"measure": {"id": 2,
"hash": "952d544cd1d50a3937b903ee9f0322808baba201",
"name": "Turnover",
"paused": false,
"locked": false,
"model": "Measure",
"measure_package": {"id": 1,
"hash": "7ce83d4d4d933305a5410a7311a6a6f133f37dd5",
"name": "Working Capital",
"model": "MeasurePackage",
"project": {"id": 1,
"hash": "583bf59445f18e7bf566020aa8134ddfa7c79113",
"name": "Phoenix",
"model": "Project",
"program": {"id": 1,
"hash": "1650600bd010a50897b50572382460965fed588a",
"name": "Airborne",
"model": "Program"
}
}
}
},
"budgeting_item": {"id": 5,
"hash": "692e090390928df7fbb99a7918df72d7bb3dbccc",
"position": 5,
"operand": 5,
"name": "Cash",
"unit": 1,
"factor": 1,
"decimals": 1,
"suffix": "",
"period_type": 1,
"aggregation_type_horizontal": 1,
"aggregation_type_vertical": 1,
"target_type": 1,
"threshold_yellow": 90,
"threshold_red": 70,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"format": "€",
"model": "BudgetingItem",
"budgeting_term": null,
"budgeting_category": {"id": 5,
"hash": "5e4deda376707cc38986975c795be8d1e3170a4a",
"position": 2,
"name": "Balance/Cash",
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"model": "BudgetingCategory"
}
},
"budgeting_period": {"id": 4,
"hash": "ecc4b4984414ef1e9656c58814635d7e5286dc04",
"name": "2022-Jul",
"start_time": "2022-07-01",
"end_time": "2022-07-31",
"scaling": 2,
"offset": 0,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"model": "BudgetingPeriod"
},
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
}
],
"meta": {"page": 1,
"first": 1,
"last": 3,
"total": 3,
"limit": 1000,
"pages": 1
},
"timestamp": 1653641832276
}

Get a measure budgeting effect

Get a measure budgeting effect.

SecurityJWT

Request

path Parameters

measurebudgetingeffect

required

string or integer

The id/hash of the measure budgeting effect.

Responses

200

Successful operation

404

Not Found

get/measurebudgetingeffect/{measurebudgetingeffect}

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "5d06275042af56b41273e5f4dd85444a93bdedc9",
"data": {"id": 30,
"hash": "1644461055b4388a1fe0f7b7fe05d612b0f8c83b",
"value_plan": 47175.96,
"value_actual": 49632.21,
"value_delta": 2456.25,
"value_achievement": 94.79343,
"value_traffic_light": 1,
"locked": false,
"created_time": "2022-05-04T16:51:39.000000Z",
"modified_time": "2022-05-04T16:51:39.000000Z",
"modified_user_time": "2022-05-04T16:51:39.000000Z",
"model": "MeasureBudgetingEffect",
"measure": {"id": 2,
"hash": "952d544cd1d50a3937b903ee9f0322808baba201",
"name": "Turnover",
"paused": false,
"locked": false,
"model": "Measure",
"measure_package": {"id": 1,
"hash": "7ce83d4d4d933305a5410a7311a6a6f133f37dd5",
"name": "Working Capital",
"model": "MeasurePackage",
"project": {"id": 1,
"hash": "583bf59445f18e7bf566020aa8134ddfa7c79113",
"name": "Phoenix",
"model": "Project",
"program": {"id": 1,
"hash": "1650600bd010a50897b50572382460965fed588a",
"name": "Airborne",
"model": "Program"
}
}
}
},
"budgeting_item": {"id": 5,
"hash": "692e090390928df7fbb99a7918df72d7bb3dbccc",
"position": 5,
"operand": 5,
"name": "Cash",
"unit": 1,
"factor": 1,
"decimals": 1,
"suffix": "",
"period_type": 1,
"aggregation_type_horizontal": 1,
"aggregation_type_vertical": 1,
"target_type": 1,
"threshold_yellow": 90,
"threshold_red": 70,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"format": "€",
"model": "BudgetingItem",
"budgeting_term": null,
"budgeting_category": {"id": 5,
"hash": "5e4deda376707cc38986975c795be8d1e3170a4a",
"position": 2,
"name": "Balance/Cash",
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"model": "BudgetingCategory"
}
},
"budgeting_period": {"id": 4,
"hash": "ecc4b4984414ef1e9656c58814635d7e5286dc04",
"name": "2022-Jul",
"start_time": "2022-07-01",
"end_time": "2022-07-31",
"scaling": 2,
"offset": 0,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"model": "BudgetingPeriod"
},
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
},
"timestamp": 1653642164115
}

Update a measure budgeting effect

Update a measure budgeting effect.

SecurityJWT

Request

path Parameters

measurebudgetingeffect

required

string or integer

The id/hash of the measure budgeting effect.

Request Body schema: application/json

A JSON object containing measure budgeting effect information

value_plan	number or null <float> The plan value of the measure budgeting effect.
value_actual	number or null <float> The actual value of the measure budgeting effect.

Responses

200

Successful operation

404

Not Found

422

Unprocessable Content

put/measurebudgetingeffect/{measurebudgetingeffect}

Request samples

Payload
curl

application/json

{"value_plan": 51.72673,
"value_actual": 55.15539
}

Response samples

application/json

{"success": true,
"hash": "f900def2f6ad5b91ea95df1375724373d0d4fd3b",
"data": {"id": 1965,
"hash": "6ef0dc7571ab349948dce80c6bf5bba381fa7065",
"value_plan": 51.72673,
"value_actual": 55.15539,
"value_delta": 3.42866,
"value_achievement": 106.62841,
"value_traffic_light": 1,
"locked": false,
"created_time": "2022-05-25T09:54:50.000000Z",
"modified_time": "2022-05-25T10:14:53.000000Z",
"modified_user_time": "2022-05-25T10:14:53.000000Z",
"model": "MeasureBudgetingEffect",
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-25T09:02:43.000000Z",
"modified_user_time": "2022-05-25T09:02:43.000000Z",
"model": "User"
}
},
"timestamp": 1653472490807
}

➔ Next to Measure budgeting total