Program budgeting effect

A program budgeting effect.

Get all program budgeting effects

Get all program budgeting effects of the authenticated hub.

SecurityJWT

Request

query Parameters

program

string or integer

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

budgeting

string or integer

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

budgeting_item

string or integer

Filter the program budgeting effects for a budgeting item.

budgeting_category

string or integer

Filter the program budgeting effects for a budgeting category.

budgeting_period

string

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

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

calculated

boolean

Filter the program budgeting effects for calculated effects.

created_user

string or integer

Filter the program budgeting effects for a created user.

modified_user

string or integer

Filter the program 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/programbudgetingeffect

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "933e22de5542bd8df9921051c3bd035388d67af1",
"data": [{"id": 1,
"hash": "23aef1d70531d6d18fe89e351a84ff926be5df9c",
"value_plan": 79034.38,
"value_plan_sum": 79034.38,
"value_plan_min": 79034.38,
"value_plan_max": 79034.38,
"value_plan_avg": 79034.38,
"value_plan_effects_count": 1,
"value_actual": 82666.01,
"value_actual_sum": 82666.01,
"value_actual_min": 82666.01,
"value_actual_max": 82666.01,
"value_actual_avg": 82666.01,
"value_actual_effects_count": 1,
"value_delta": 3631.63,
"value_delta_sum": 3631.63,
"value_delta_min": 3631.63,
"value_delta_max": 3631.63,
"value_delta_avg": 3631.63,
"value_delta_effects_count": 1,
"value_achievement": 95.405,
"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": "ProgramBudgetingEffect",
"program": {"id": 1,
"hash": "1650600bd010a50897b50572382460965fed588a",
"name": "Airborne",
"paused": false,
"locked": false,
"model": "Program"
},
"budgeting_item": {"id": 2,
"hash": "ec9d9b8f7e42230489f57058cbdc07244444d1fa",
"position": 2,
"operand": 2,
"name": "Material expenditures",
"unit": 1,
"factor": 1,
"decimals": 1,
"suffix": "",
"period_type": 1,
"aggregation_type_horizontal": 1,
"aggregation_type_vertical": 1,
"target_type": 2,
"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": 4,
"hash": "2a3633b85818388897dcb8b5717927484ada465d",
"position": 1,
"name": "P&L",
"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": 2,
"hash": "7bac0b8e14d3d01a111231290810762bf8b78b81",
"value_plan": 69589.36,
"value_plan_sum": 69589.36,
"value_plan_min": 69589.36,
"value_plan_max": 69589.36,
"value_plan_avg": 69589.36,
"value_plan_effects_count": 1,
"value_actual": 85026.48,
"value_actual_sum": 85026.48,
"value_actual_min": 85026.48,
"value_actual_max": 85026.48,
"value_actual_avg": 85026.48,
"value_actual_effects_count": 1,
"value_delta": 15437.12,
"value_delta_sum": 15437.12,
"value_delta_min": 15437.12,
"value_delta_max": 15437.12,
"value_delta_avg": 15437.12,
"value_delta_effects_count": 1,
"value_achievement": 77.81684,
"value_traffic_light": 2,
"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": "ProgramBudgetingEffect",
"program": {"id": 1,
"hash": "1650600bd010a50897b50572382460965fed588a",
"name": "Airborne",
"paused": false,
"locked": false,
"model": "Program"
},
"budgeting_item": {"id": 2,
"hash": "ec9d9b8f7e42230489f57058cbdc07244444d1fa",
"position": 2,
"operand": 2,
"name": "Material expenditures",
"unit": 1,
"factor": 1,
"decimals": 1,
"suffix": "",
"period_type": 1,
"aggregation_type_horizontal": 1,
"aggregation_type_vertical": 1,
"target_type": 2,
"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": 4,
"hash": "2a3633b85818388897dcb8b5717927484ada465d",
"position": 1,
"name": "P&L",
"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": 3,
"hash": "5da5adb568ae5de96c2ae8c541181d61f35483e2",
"value_plan": 47667.34,
"value_plan_sum": 47667.34,
"value_plan_min": 47667.34,
"value_plan_max": 47667.34,
"value_plan_avg": 47667.34,
"value_plan_effects_count": 1,
"value_actual": 43190.21,
"value_actual_sum": 43190.21,
"value_actual_min": 43190.21,
"value_actual_max": 43190.21,
"value_actual_avg": 43190.21,
"value_actual_effects_count": 1,
"value_delta": -4477.13,
"value_delta_sum": -4477.13,
"value_delta_min": -4477.13,
"value_delta_max": -4477.13,
"value_delta_avg": -4477.13,
"value_delta_effects_count": 1,
"value_achievement": 109.39245,
"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": "ProgramBudgetingEffect",
"program": {"id": 1,
"hash": "1650600bd010a50897b50572382460965fed588a",
"name": "Airborne",
"paused": false,
"locked": false,
"model": "Program"
},
"budgeting_item": {"id": 2,
"hash": "ec9d9b8f7e42230489f57058cbdc07244444d1fa",
"position": 2,
"operand": 2,
"name": "Material expenditures",
"unit": 1,
"factor": 1,
"decimals": 1,
"suffix": "",
"period_type": 1,
"aggregation_type_horizontal": 1,
"aggregation_type_vertical": 1,
"target_type": 2,
"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": 4,
"hash": "2a3633b85818388897dcb8b5717927484ada465d",
"position": 1,
"name": "P&L",
"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": 1653645943294
}

Get a program budgeting effect

Get a program budgeting effect.

SecurityJWT

Request

path Parameters

programbudgetingeffect

required

string or integer

The id/hash of the program budgeting effect.

Responses

200

Successful operation

404

Not Found

get/programbudgetingeffect/{programbudgetingeffect}

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "094691a1dd8f55ab18460f7b4921461eac602a92",
"data": {"id": 3,
"hash": "5da5adb568ae5de96c2ae8c541181d61f35483e2",
"value_plan": 47667.34,
"value_plan_sum": 47667.34,
"value_plan_min": 47667.34,
"value_plan_max": 47667.34,
"value_plan_avg": 47667.34,
"value_plan_effects_count": 1,
"value_actual": 43190.21,
"value_actual_sum": 43190.21,
"value_actual_min": 43190.21,
"value_actual_max": 43190.21,
"value_actual_avg": 43190.21,
"value_actual_effects_count": 1,
"value_delta": -4477.13,
"value_delta_sum": -4477.13,
"value_delta_min": -4477.13,
"value_delta_max": -4477.13,
"value_delta_avg": -4477.13,
"value_delta_effects_count": 1,
"value_achievement": 109.39245,
"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": "ProgramBudgetingEffect",
"program": {"id": 1,
"hash": "1650600bd010a50897b50572382460965fed588a",
"name": "Airborne",
"paused": false,
"locked": false,
"model": "Program"
},
"budgeting_item": {"id": 2,
"hash": "ec9d9b8f7e42230489f57058cbdc07244444d1fa",
"position": 2,
"operand": 2,
"name": "Material expenditures",
"unit": 1,
"factor": 1,
"decimals": 1,
"suffix": "",
"period_type": 1,
"aggregation_type_horizontal": 1,
"aggregation_type_vertical": 1,
"target_type": 2,
"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": 4,
"hash": "2a3633b85818388897dcb8b5717927484ada465d",
"position": 1,
"name": "P&L",
"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": 1653646285115
}

➔ Next to Program budgeting total