Budgeting item model

The budgeting item model represents a budgeting item in Falcon.

id
integer

The id of the budgeting item.

hash
string

The unique hash of the budgeting item.

position
integer

The position of the budgeting item within the budgeting.

operand
integer

The operand of the budgeting item.

The operand can be used (together with a leading hashtag) as a reference to this budgeting item in calculations. The operand is automatically assigned when creating the budgeting position, cannot be changed and is unique within the budgeting.

name
string

The name of the budgeting item.

unit
integer

The unit of the budgeting item.

  • 1 - Currency
  • 2 - Quantity
  • 3 - Achievement
Enum: 1 2 3
factor
integer

The factor of the budgeting item.

  • 0 - None
  • 1 - Thousand
  • 2 - Million
Enum: 0 1 2
decimals
integer

The number of displayed decimals of the budgeting item.

suffix
string

The suffix of the budgeting item.

format
string

The format of the budgeting item.

The format is a combination of the unit and the suffix of the budgeting item.

period_type
integer

The period type of the budgeting item.

  • 1 - Overall
  • 2 - Pre previous year
  • 3 - Previous year
  • 4 - Year to date
  • 5 - Actual year
  • 6 - Date to year
  • 7 - Upcoming year
  • 8 - Last year
  • 9 - Start to date
  • 10 - Rolling year to date
  • 11 - Pre previous period
  • 12 - Previous period
  • 13 - Actual period
  • 14 - Upcoming period
  • 15 - Date to rolling year
  • 16 - Date to end
  • 17 - Last period
Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
aggregation_type_horizontal
integer

The horizontal aggregation type of the budgeting item.

  • 1 - Sum
  • 2 - Average
  • 3 - Calculation
  • 4 - Last period
Enum: 1 2 3 4
aggregation_type_vertical
integer

The vertical aggregation type of the budgeting item.

  • 1 - Sum
  • 2 - Average
  • 3 - Calculation
Enum: 1 2 3
target_type
integer

The target type of the budgeting item.

  • 1 - More is better
  • 2 - Less is better
  • 3 - Spot landing
Enum: 1 2 3
threshold_yellow
integer [ -100 .. 100 ]

The threshold for the yellow traffic light of the budgeting item.

threshold_red
integer [ -100 .. 100 ]

The threshold for the red traffic light of the budgeting item.

created_time
string <date-time>

The created time of the budgeting item.

modified_time
string <date-time>

The modified time of the budgeting item.

modified_user_time
string <date-time>

The modified user time of the budgeting item.

model
string

The budgeting item model.

Value: "BudgetingItem"
object or null (BudgetingTerm)

The budgeting term of the budgeting item.

object (BudgetingCategory)

The budgeting category of the budgeting item.

object (User)

The created user of the budgeting item.

object (User)

The modified user of the budgeting item.

{
  • "id": 7,
  • "hash": "33e79bb30fa9db3abcf9b76b9f27b92377aec411",
  • "position": 7,
  • "operand": 7,
  • "name": "Scrap rate",
  • "unit": 2,
  • "factor": 0,
  • "decimals": 2,
  • "suffix": "%",
  • "period_type": 6,
  • "aggregation_type_horizontal": 2,
  • "aggregation_type_vertical": 2,
  • "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": {
    },
  • "budgeting_category": {
    },
  • "created_user": {
    },
  • "modified_user": {
    }
}
➔ Next to Budgeting period model