Measure package budgeting effect

A measure package budgeting effect.

Get all measure package budgeting effects

Get all measure package budgeting effects of the authenticated hub.

SecurityJWT

Request

query Parameters

measure_package

string or integer

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

project

string or integer

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

program

string or integer

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

budgeting

string or integer

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

budgeting_item

string or integer

Filter the measure package budgeting effects for a budgeting item.

budgeting_category

string or integer

Filter the measure package budgeting effects for a budgeting category.

budgeting_period

string

Filter the measure package 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 package 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 package budgeting effects for a budgeting period end time.

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

calculated

boolean

Filter the measure package budgeting effects for calculated effects.

created_user

string or integer

Filter the measure package budgeting effects for a created user.

modified_user

string or integer

Filter the measure package 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/measurepackagebudgetingeffect

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "73a69ca66009332f20eca2a2dbe448376ded8791",
"data": [{"id": 13,
"hash": "b22d9f64f273e74a030781c32929493344bdd31a",
"value_plan": 41055.62,
"value_plan_sum": 41055.62,
"value_plan_min": 41055.62,
"value_plan_max": 41055.62,
"value_plan_avg": 41055.62,
"value_plan_effects_count": 1,
"value_actual": 28656.73,
"value_actual_sum": 28656.73,
"value_actual_min": 28656.73,
"value_actual_max": 28656.73,
"value_actual_avg": 28656.73,
"value_actual_effects_count": 1,
"value_delta": -12398.89,
"value_delta_sum": -12398.89,
"value_delta_min": -12398.89,
"value_delta_max": -12398.89,
"value_delta_avg": -12398.89,
"value_delta_effects_count": 1,
"value_achievement": 130.20023,
"value_traffic_light": 1,
"created_time": "2022-05-04T16:51:40.000000Z",
"modified_time": "2022-05-04T16:51:40.000000Z",
"modified_user_time": "2022-05-04T16:51:40.000000Z",
"model": "MeasurePackageBudgetingEffect",
"measure_package": {"id": 1,
"hash": "7ce83d4d4d933305a5410a7311a6a6f133f37dd5",
"name": "Working Capital",
"paused": false,
"locked": false,
"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,
"name": "2022-May",
"hash": "2178ab015de8d67318944cf2481c672b2bcea2e4",
"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": 14,
"hash": "2a45595060482111ec85496b16a48ffac7cd8164",
"value_plan": 29660.46,
"value_plan_sum": 29660.46,
"value_plan_min": 29660.46,
"value_plan_max": 29660.46,
"value_plan_avg": 29660.46,
"value_plan_effects_count": 1,
"value_actual": 59366.93,
"value_actual_sum": 59366.93,
"value_actual_min": 59366.93,
"value_actual_max": 59366.93,
"value_actual_avg": 59366.93,
"value_actual_effects_count": 1,
"value_delta": 29706.47,
"value_delta_sum": 29706.47,
"value_delta_min": 29706.47,
"value_delta_max": 29706.47,
"value_delta_avg": 29706.47,
"value_delta_effects_count": 1,
"value_achievement": -0.15512,
"value_traffic_light": 3,
"created_time": "2022-05-04T16:51:40.000000Z",
"modified_time": "2022-05-04T16:51:40.000000Z",
"modified_user_time": "2022-05-04T16:51:40.000000Z",
"model": "MeasurePackageBudgetingEffect",
"measure_package": {"id": 1,
"hash": "7ce83d4d4d933305a5410a7311a6a6f133f37dd5",
"name": "Working Capital",
"paused": false,
"locked": false,
"model": "MeasurePackage",
"project": {"id": 1,
"hash": "583bf59445f18e7bf566020aa8134ddfa7c79113",
"name": "Phoenix",
"model": "Project",
"program": {"id": 1,
"hash": "1650600bd010a50897b50572382460965fed588a",
"name": "Airborne",
"model": "Program"
}
}
},
"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"
},
"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"
}
},
"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": 15,
"hash": "faec5bd16ea1d78458f93e14458af437fbf13fd6",
"value_plan": 16080,
"value_plan_sum": 16080,
"value_plan_min": 16080,
"value_plan_max": 16080,
"value_plan_avg": 16080,
"value_plan_effects_count": 1,
"value_actual": 12567.22,
"value_actual_sum": 12567.22,
"value_actual_min": 12567.22,
"value_actual_max": 12567.22,
"value_actual_avg": 12567.22,
"value_actual_effects_count": 1,
"value_delta": -3512.78,
"value_delta_sum": -3512.78,
"value_delta_min": -3512.78,
"value_delta_max": -3512.78,
"value_delta_avg": -3512.78,
"value_delta_effects_count": 1,
"value_achievement": 121.84565,
"value_traffic_light": 1,
"created_time": "2022-05-04T16:51:40.000000Z",
"modified_time": "2022-05-04T16:51:40.000000Z",
"modified_user_time": "2022-05-04T16:51:40.000000Z",
"model": "MeasurePackageBudgetingEffect",
"measure_package": {"id": 1,
"hash": "7ce83d4d4d933305a5410a7311a6a6f133f37dd5",
"name": "Working Capital",
"paused": false,
"locked": false,
"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 package budgeting effect

Get a measure package budgeting effect.

SecurityJWT

Request

path Parameters

measurepackagebudgetingeffect

required

string or integer

The id/hash of the measure package budgeting effect.

Responses

200

Successful operation

404

Not Found

get/measurepackagebudgetingeffect/{measurepackagebudgetingeffect}

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "73a69ca66009332f20eca2a2dbe448376ded8791",
"data": {"id": 14,
"hash": "2a45595060482111ec85496b16a48ffac7cd8164",
"value_plan": 29660.46,
"value_plan_sum": 29660.46,
"value_plan_min": 29660.46,
"value_plan_max": 29660.46,
"value_plan_avg": 29660.46,
"value_plan_effects_count": 1,
"value_actual": 59366.93,
"value_actual_sum": 59366.93,
"value_actual_min": 59366.93,
"value_actual_max": 59366.93,
"value_actual_avg": 59366.93,
"value_actual_effects_count": 1,
"value_delta": 29706.47,
"value_delta_sum": 29706.47,
"value_delta_min": 29706.47,
"value_delta_max": 29706.47,
"value_delta_avg": 29706.47,
"value_delta_effects_count": 1,
"value_achievement": -0.15512,
"value_traffic_light": 3,
"created_time": "2022-05-04T16:51:40.000000Z",
"modified_time": "2022-05-04T16:51:40.000000Z",
"modified_user_time": "2022-05-04T16:51:40.000000Z",
"model": "MeasurePackageBudgetingEffect",
"measure_package": {"id": 1,
"hash": "7ce83d4d4d933305a5410a7311a6a6f133f37dd5",
"name": "Working Capital",
"paused": false,
"locked": false,
"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"
}
},
"timestamp": 1653641832276
}

➔ Next to Measure package budgeting total