Program budgeting

A program budgeting.

Freeze program budgeting effects

Freeze measure budgeting effects for a program.

SecurityJWT
Request
path Parameters
program
required
string or integer

The id/hash of the program.

Request Body schema: application/json

A JSON object containing program budgeting information.

start_time
required
string <date>

The start time of the budgeting periods for the measure budgeting effects in the program that will be locked.

The date must be before or equal to the end time. All budgeting periods that start on or after this date will be locked. It must match one of the following formats:

  • Y-m-d
  • Y/m/d
  • d.m.Y
  • m/d/Y

end_time
string or null <date>

The end time of the budgeting periods for the measure budgeting effects in the program that will be locked.

If the date is set it must be after or equal to the start time. All budgeting periods that end on or before this date will be locked. If no date is set the request will freeze all effects starting from the start time. It must match one of the following formats:

  • Y-m-d
  • Y/m/d
  • d.m.Y
  • m/d/Y

locked
boolean
Default: true

The locked flag for the measure budgeting effects in the program.

budgeting_item
string or integer or null

The budgeting item for which the effects should be locked.

If no budgeting item is set, the effects are locked for all budgeting items.

Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

put/programbudgeting/{program}/freeze
Request samples
application/json
{
  • "start_time": "2022-06-01",
  • "budgeting_item": 4
}
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1660578505341
}

Set actual program budgeting effects

Set the actual values with the plan values of the measure budgeting effects for a program.

SecurityJWT
Request
path Parameters
program
required
string or integer

The id/hash of the program.

Request Body schema: application/json

A JSON object containing program budgeting information.

overwrite
boolean
Default: false

The overwrite flag for the budgeting effects of the measures in the program.

With this flag set, the actual effect values which are not null will be overwritten as well.

past
boolean
Default: false

The past flag for the budgeting effects of the measures in the program.

With this flag set, the actual effect values from the past will be set as well.

Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

put/programbudgeting/{program}/actual
Request samples
application/json
{
  • "overwrite": true,
  • "past": false
}
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1660578738788
}

Set plan program budgeting effects

Set the plan values with the actual values of the measure budgeting effects for a program.

SecurityJWT
Request
path Parameters
program
required
string or integer

The id/hash of the program.

Request Body schema: application/json

A JSON object containing program budgeting information.

overwrite
boolean
Default: false

The overwrite flag for the budgeting effects of the measures in the program.

With this flag set, the plan effect values which are not null will be overwritten as well.

past
boolean
Default: false

The past flag for the budgeting effects of the measures in the program.

With this flag set, the plan effect values from the past will be set as well.

Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

put/programbudgeting/{program}/plan
Request samples
application/json
{
  • "overwrite": true,
  • "past": false
}
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1660578945369
}

Reset program budgeting effects

Reset budgeting effects for a program.

SecurityJWT
Request
path Parameters
program
required
string or integer

The id/hash of the program.

Responses
200

Successful operation

404

Not Found

put/programbudgeting/{program}/reset
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1660739738431
}
➔ Next to Program budgeting effect