Budgeting period model

The budgeting period model represents a budgeting period in Falcon.

id
integer

The id of the budgeting period.

name
string

The name of the budgeting period.

start_time
string <date> Y-m-d

The start time of the budgeting period.

end_time
string <date> Y-m-d

The end time of the budgeting period.

scaling
integer

The scaling of the budgeting period.

  • 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 period.

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

The the current flag of the budgeting period.

forecast
boolean

The the forecast flag of the budgeting period.

created_time
string <date-time>

The created time of the budgeting period.

modified_time
string <date-time>

The modified time of the budgeting period.

modified_user_time
string <date-time>

The modified user time of the budgeting period.

model
string

The budgeting period model.

Value: "BudgetingPeriod"
{
  • "id": 3,
  • "name": "Jun 2022 (01/06/2022 - 30/06/2022)",
  • "start_time": "2022-06-01T00:00:00.000000Z",
  • "end_time": "2022-06-30T00:00:00.000000Z",
  • "scaling": 2,
  • "offset": 0,
  • "current": false,
  • "forecast": false,
  • "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"
}