Budgeting

A budgeting.

Create a budgeting

Create a new budgeting.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing budgeting information.

name
required
string <= 1000 characters

The name of the new budgeting.

start_time
required
string <date> Y-m-d, Y/m/d, d.m.Y, m/d/Y

The start time of the new budgeting.

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

end_time
required
string <date> Y-m-d, Y/m/d, d.m.Y, m/d/Y

The end time of the new budgeting.

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

scaling
required
integer

The budgeting scaling type of the new budgeting.

  • 1 - Weekly
  • 2 - Monthly
  • 3 - Quarterly
  • 4 - Yearly
Enum: 1 2 3 4
offset
required
integer [ 0 .. 11 ]

The offset for the financial year of the new budgeting.

  • 0 - January
  • 1 - February
  • 2 - March
  • 3 - April
  • 4 - May
  • 5 - June
  • 6 - July
  • 7 - August
  • 8 - September
  • 9 - October
  • 10 - November
  • 11 - December
Responses
201

Successful operation

422

Unprocessable Content

post/budgeting
Request samples
application/json
{
  • "name": "Airborne",
  • "start_time": "2022-07-01",
  • "end_time": "2022-07-31",
  • "scaling": 1,
  • "offset": 6
}
Response samples
application/json
{
  • "success": true,
  • "hash": "4857bbcbf0d4686ef292266a1ce109d491db0108",
  • "data": {
    },
  • "timestamp": 1657550176812
}

Get all budgetings

Get all budgetings of the authenticated hub.

SecurityJWT
Responses
200

Successful operation

401

Unauthorized

get/budgeting
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "0da942a96ab5944a087aaf09266e2d6d91c0740b",
  • "data": [
    ],
  • "timestamp": 1654265060983
}

Get a budgeting

Get a budgeting.

SecurityJWT
Request
path Parameters
budgeting
required
string or integer

The id/hash of the budgeting.

Responses
200

Successful operation

404

Not Found

get/budgeting/{budgeting}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "3a8b62071fd61473c36bcdc6277b61afc280503f",
  • "data": {
    },
  • "timestamp": 1657619522090
}

Update a budgeting

Update a budgeting

SecurityJWT
Request
path Parameters
budgeting
required
string or integer

The id/hash of the budgeting.

Request Body schema: application/json

A JSON object containing budgeting information

name
string <= 1000 characters

The name of the budgeting.

start_time
string <date> Y-m-d, Y/m/d, d.m.Y, m/d/Y

The start time of the budgeting.

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

end_time
string <date> Y-m-d, Y/m/d, d.m.Y, m/d/Y

The end time of the budgeting.

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

scaling
integer

The budgeting scaling type of the budgeting.

  • 1 - Weekly
  • 2 - Monthly
  • 3 - Quarterly
  • 4 - Yearly
Enum: 1 2 3 4
offset
integer [ 0 .. 11 ]

The offset for the financial year of the budgeting.

  • 0 - January
  • 1 - February
  • 2 - March
  • 3 - April
  • 4 - May
  • 5 - June
  • 6 - July
  • 7 - August
  • 8 - September
  • 9 - October
  • 10 - November
  • 11 - December
Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

put/budgeting/{budgeting}
Request samples
application/json
{
  • "name": "Budgeting for Airborne",
  • "start_time": "2022-05-01",
  • "end_time": "2022-06-30",
  • "scaling": 2,
  • "offset": 4
}
Response samples
application/json
{
  • "success": true,
  • "hash": "adbf7ac33270713f4ca40bc173b7bbdc55eccf46",
  • "data": {
    },
  • "timestamp": 1657620548291
}

Delete a budgeting

Delete a budgeting

SecurityJWT
Request
path Parameters
budgeting
required
string or integer

The id/hash of the budgeting.

Responses
200

Successful operation

404

Not Found

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

Copy a budgeting

Copy a budgeting.

SecurityJWT
Request
path Parameters
budgeting
required
string or integer

The id/hash of the budgeting.

Responses
200

Successful operation

404

Not Found

post/budgeting/{budgeting}/copy
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": [ ],
  • "timestamp": 1657621624390
}

Restore a budgeting

Restore a budgeting.

SecurityJWT
Request
path Parameters
budgeting
required
string or integer

The id/hash of the budgeting.

Responses
200

Successful operation

404

Not Found

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