Budgeting category

A budgeting category.

Create a budgeting category

Create a new budgeting category.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing budgeting category information.

name
required
string <= 1000 characters

The name of the new budgeting category.

budgeting_hash
required
string

The budgeting of the new budgeting category.

Responses
201

Successful operation

422

Unprocessable Content

post/budgetingcategory
Request samples
application/json
{
  • "name": "KPI",
  • "budgeting_hash": "956bc5a691b6a2cf67c4f963029dd3dcb9776be3"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "93a019f628caa51353491a1f18d4f6e62443b5b8",
  • "data": {
    },
  • "timestamp": 1657637020041
}

Get all budgeting categories

Get all budgeting categories of the authenticated hub.

SecurityJWT
Request
query Parameters
measure
string or integer

Filter the budgeting category list for a measure.

measure_package
string or integer

Filter the budgeting category list for a measure package.

project
string or integer

Filter the budgeting category list for a project.

program
string or integer

Filter the budgeting category list for a program.

budgeting
string or integer

Filter the budgeting category list for a budgeting.

Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

get/budgetingcategory
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "27634e1465db39811d1bea2e619f3d61f20f52ff",
  • "data": [
    ],
  • "timestamp": 1657637691346
}

Get a budgeting category

Get a budgeting category.

SecurityJWT
Request
path Parameters
budgetingcategory
required
string or integer

The id/hash of the budgeting category.

Responses
200

Successful operation

404

Not Found

get/budgetingcategory/{budgetingcategory}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "1d1602c8d9f690b1827ac625b4e37a11d1fc2863",
  • "data": {
    },
  • "timestamp": 1657638236029
}

Update a budgeting category

Update a budgeting category

SecurityJWT
Request
path Parameters
budgetingcategory
required
string or integer

The id/hash of the budgeting category.

Request Body schema: application/json

A JSON object containing budgeting category information

name
string <= 1000 characters

The name of the budgeting category.

Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

put/budgetingcategory/{budgetingcategory}
Request samples
application/json
{
  • "name": "KPI"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "a07797549b7b39e83935b1737c075a6a883ca07a",
  • "data": {
    },
  • "timestamp": 1657638502031
}

Delete a budgeting category

Delete a budgeting category

SecurityJWT
Request
path Parameters
budgetingcategory
required
string or integer

The id/hash of the budgeting category.

Responses
200

Successful operation

404

Not Found

delete/budgetingcategory/{budgetingcategory}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": [ ],
  • "timestamp": 1657638799503
}

Position a budgeting category

Position a budgeting category in relation to another budgeting category.

SecurityJWT
Request
path Parameters
budgetingcategory
required
string or integer

The id/hash of the budgeting category.

Request Body schema: application/json

A JSON object containing budgeting category information.

position
required
string

The new position in relation to the budgeting category.

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

The budgeting category to position the given budgeting category to.

Responses
200

Successful operation

404

Not Found

put/budgetingcategory/{budgetingcategory}/position
Request samples
application/json
{
  • "position": "before",
  • "budgeting_category_id": 5
}
Response samples
application/json
{
  • "success": true,
  • "hash": "192dab761e17a782da25ec5a2de4dfdc48c650f3",
  • "data": {
    },
  • "timestamp": 1655976061248
}

Restore a budgeting category

Restore a budgeting category.

SecurityJWT
Request
path Parameters
budgetingcategory
required
string or integer

The id/hash of the budgeting category.

Responses
200

Successful operation

404

Not Found

put/budgetingcategory/{budgetingcategory}/restore
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": [ ],
  • "timestamp": 1657639899235
}