BudgetDto

Example Json Object

  1{
  2  "id": 0,
  3  "createdOn": "2019-08-24T14:15:22Z",
  4  "createdById": "string",
  5  "modifiedOn": "2019-08-24T14:15:22Z",
  6  "modifiedById": "string",
  7  "createdByName": "string",
  8  "lastModifiedByName": "string",
  9  "requestedAmount": 0,
 10  "spent": 0,
 11  "companyCurrency": "string",
 12  "endYear": 0,
 13  "internalAssetClassIds": "string",
 14  "availableCombos": "string",
 15  "belongToBudgetId": 0,
 16  "postedAssetExists": true,
 17  "childrenIds": [
 18    0
 19  ],
 20  "investmentAreaIds": [
 21    0
 22  ],
 23  "investmentRequestToInvestmentArea": {
 24    "id": 0,
 25    "createdOn": "2019-08-24T14:15:22Z",
 26    "createdById": "string",
 27    "modifiedOn": "2019-08-24T14:15:22Z",
 28    "modifiedById": "string",
 29    "createdByName": "string",
 30    "lastModifiedByName": "string",
 31    "amount": 0,
 32    "originalCurrencyId": 0,
 33    "originalCurrencyDisplayId": "string",
 34    "originalAmount": 0,
 35    "rate": 0,
 36    "rateDate": "2019-08-24",
 37    "investmentAreaId": 0,
 38    "investmentArea": {
 39      "id": 0,
 40      "createdOn": "2019-08-24T14:15:22Z",
 41      "createdById": "string",
 42      "modifiedOn": "2019-08-24T14:15:22Z",
 43      "modifiedById": "string",
 44      "createdByName": "string",
 45      "lastModifiedByName": "string",
 46      "displayId": "string",
 47      "name": "string",
 48      "assetClasses": [
 49        0
 50      ]
 51    },
 52    "investmentRequestYearDistributions": [
 53      {
 54        "id": 0,
 55        "createdOn": "2019-08-24T14:15:22Z",
 56        "createdById": "string",
 57        "modifiedOn": "2019-08-24T14:15:22Z",
 58        "modifiedById": "string",
 59        "createdByName": "string",
 60        "lastModifiedByName": "string",
 61        "year": 0,
 62        "amount": 0,
 63        "originalCurrencyId": 0,
 64        "originalCurrencyDisplayId": "string",
 65        "originalAmount": 0,
 66        "rate": 0,
 67        "rateDate": "2019-08-24",
 68        "spent": 0,
 69        "investmentRequestToInvestmentAreaId": 0
 70      }
 71    ],
 72    "totalSpent": 0,
 73    "totalReserved": 0,
 74    "balance": 0,
 75    "linkedBudgets": [
 76      {
 77        "id": 0,
 78        "createdOn": "2019-08-24T14:15:22Z",
 79        "createdById": "string",
 80        "modifiedOn": "2019-08-24T14:15:22Z",
 81        "modifiedById": "string",
 82        "createdByName": "string",
 83        "lastModifiedByName": "string",
 84        "requestCategoryId": 0,
 85        "year": 0,
 86        "displayId": "string",
 87        "project": "string",
 88        "requestCategory": {
 89          "id": 0,
 90          "createdOn": "2019-08-24T14:15:22Z",
 91          "createdById": "string",
 92          "modifiedOn": "2019-08-24T14:15:22Z",
 93          "modifiedById": "string",
 94          "createdByName": "string",
 95          "lastModifiedByName": "string",
 96          "displayId": "string",
 97          "title": "string",
 98          "subTitle": "string",
 99          "icon": "string",
100          "budgetTitle": "string",
101          "budgetSubTitle": "string",
102          "investmentTitle": "string",
103          "investmentSubTitle": "string"
104        }
105      }
106    ]
107  },
108  "investmentRequestYearDistribution": {
109    "id": 0,
110    "createdOn": "2019-08-24T14:15:22Z",
111    "createdById": "string",
112    "modifiedOn": "2019-08-24T14:15:22Z",
113    "modifiedById": "string",
114    "createdByName": "string",
115    "lastModifiedByName": "string",
116    "year": 0,
117    "amount": 0,
118    "originalCurrencyId": 0,
119    "originalCurrencyDisplayId": "string",
120    "originalAmount": 0,
121    "rate": 0,
122    "rateDate": "2019-08-24",
123    "spent": 0,
124    "investmentRequestToInvestmentAreaId": 0
125  },
126  "investmentRequestId": 0,
127  "investmentRequestDisplayId": "string",
128  "investmentRequestTitle": "string",
129  "requestCategoryId": 0,
130  "year": 0,
131  "displayId": "string",
132  "leaseAreaId": 0,
133  "leaseAreaDisplayId": "string",
134  "leaseAreaName": "string",
135  "businessUnitId": 0,
136  "businessUnitDisplayId": "string",
137  "companyId": 0,
138  "companyDisplayId": "string",
139  "departmentId": 0,
140  "departmentDisplayId": "string",
141  "project": "string",
142  "companyCurrencyId": 0,
143  "companyCurrencyDisplayId": "string",
144  "reportingCurrencyId": 0,
145  "reportingCurrencyDisplayId": "string",
146  "masterBudgetId": 0,
147  "archived": true,
148  "inceptionExchangeRate": 0,
149  "exchangeRateValidFrom": "2019-08-24",
150  "weightedAverageExchangeRate": 0,
151  "status": "DRAFT",
152  "workflowStepName": "string",
153  "forcastYearStart": 0,
154  "forcastYearEnd": 0,
155  "actualYearStart": 0,
156  "actualYearEnd": 0,
157  "projectDescription": "string",
158  "projectJustification": "string",
159  "sponsor": "string",
160  "group1": {
161    "id": 0,
162    "createdOn": "2019-08-24T14:15:22Z",
163    "createdById": "string",
164    "modifiedOn": "2019-08-24T14:15:22Z",
165    "modifiedById": "string",
166    "createdByName": "string",
167    "lastModifiedByName": "string",
168    "displayId": "string",
169    "name": "string",
170    "type": "Group1"
171  },
172  "group2": {
173    "id": 0,
174    "createdOn": "2019-08-24T14:15:22Z",
175    "createdById": "string",
176    "modifiedOn": "2019-08-24T14:15:22Z",
177    "modifiedById": "string",
178    "createdByName": "string",
179    "lastModifiedByName": "string",
180    "displayId": "string",
181    "name": "string",
182    "type": "Group1"
183  },
184  "belongToBudget": {
185    "id": 0,
186    "createdOn": "2019-08-24T14:15:22Z",
187    "createdById": "string",
188    "modifiedOn": "2019-08-24T14:15:22Z",
189    "modifiedById": "string",
190    "createdByName": "string",
191    "lastModifiedByName": "string",
192    "requestedAmount": 0,
193    "spent": 0,
194    "companyCurrency": "string",
195    "endYear": 0,
196    "internalAssetClassIds": "string",
197    "availableCombos": "string",
198    "belongToBudgetId": 0,
199    "postedAssetExists": true,
200    "childrenIds": [
201      0
202    ],
203    "investmentAreaIds": [
204      0
205    ],
206    "investmentRequestToInvestmentArea": {
207      "id": 0,
208      "createdOn": "2019-08-24T14:15:22Z",
209      "createdById": "string",
210      "modifiedOn": "2019-08-24T14:15:22Z",
211      "modifiedById": "string",
212      "createdByName": "string",
213      "lastModifiedByName": "string",
214      "amount": 0,
215      "originalCurrencyId": 0,
216      "originalCurrencyDisplayId": "string",
217      "originalAmount": 0,
218      "rate": 0,
219      "rateDate": "2019-08-24",
220      "investmentAreaId": 0,
221      "investmentArea": {
222        "id": 0,
223        "createdOn": "2019-08-24T14:15:22Z",
224        "createdById": "string",
225        "modifiedOn": "2019-08-24T14:15:22Z",
226        "modifiedById": "string",
227        "createdByName": "string",
228        "lastModifiedByName": "string",
229        "displayId": "string",
230        "name": "string",
231        "assetClasses": [
232          0
233        ]
234      },
235      "investmentRequestYearDistributions": [
236        {
237          "id": 0,
238          "createdOn": "2019-08-24T14:15:22Z",
239          "createdById": "string",
240          "modifiedOn": "2019-08-24T14:15:22Z",
241          "modifiedById": "string",
242          "createdByName": "string",
243          "lastModifiedByName": "string",
244          "year": 0,
245          "amount": 0,
246          "originalCurrencyId": 0,
247          "originalCurrencyDisplayId": "string",
248          "originalAmount": 0,
249          "rate": 0,
250          "rateDate": "2019-08-24",
251          "spent": 0,
252          "investmentRequestToInvestmentAreaId": 0
253        }
254      ],
255      "totalSpent": 0,
256      "totalReserved": 0,
257      "balance": 0,
258      "linkedBudgets": [
259        {
260          "id": 0,
261          "createdOn": "2019-08-24T14:15:22Z",
262          "createdById": "string",
263          "modifiedOn": "2019-08-24T14:15:22Z",
264          "modifiedById": "string",
265          "createdByName": "string",
266          "lastModifiedByName": "string",
267          "requestCategoryId": 0,
268          "year": 0,
269          "displayId": "string",
270          "project": "string",
271          "requestCategory": {
272            "id": 0,
273            "createdOn": "2019-08-24T14:15:22Z",
274            "createdById": "string",
275            "modifiedOn": "2019-08-24T14:15:22Z",
276            "modifiedById": "string",
277            "createdByName": "string",
278            "lastModifiedByName": "string",
279            "displayId": "string",
280            "title": "string",
281            "subTitle": "string",
282            "icon": "string",
283            "budgetTitle": "string",
284            "budgetSubTitle": "string",
285            "investmentTitle": "string",
286            "investmentSubTitle": "string"
287          }
288        }
289      ]
290    },
291    "investmentRequestYearDistribution": {
292      "id": 0,
293      "createdOn": "2019-08-24T14:15:22Z",
294      "createdById": "string",
295      "modifiedOn": "2019-08-24T14:15:22Z",
296      "modifiedById": "string",
297      "createdByName": "string",
298      "lastModifiedByName": "string",
299      "year": 0,
300      "amount": 0,
301      "originalCurrencyId": 0,
302      "originalCurrencyDisplayId": "string",
303      "originalAmount": 0,
304      "rate": 0,
305      "rateDate": "2019-08-24",
306      "spent": 0,
307      "investmentRequestToInvestmentAreaId": 0
308    },
309    "investmentRequestId": 0,
310    "investmentRequestDisplayId": "string",
311    "investmentRequestTitle": "string",
312    "requestCategoryId": 0,
313    "year": 0,
314    "displayId": "string",
315    "leaseAreaId": 0,
316    "leaseAreaDisplayId": "string",
317    "leaseAreaName": "string",
318    "businessUnitId": 0,
319    "businessUnitDisplayId": "string",
320    "companyId": 0,
321    "companyDisplayId": "string",
322    "departmentId": 0,
323    "departmentDisplayId": "string",
324    "project": "string",
325    "companyCurrencyId": 0,
326    "companyCurrencyDisplayId": "string",
327    "reportingCurrencyId": 0,
328    "reportingCurrencyDisplayId": "string",
329    "masterBudgetId": 0,
330    "archived": true,
331    "inceptionExchangeRate": 0,
332    "exchangeRateValidFrom": "2019-08-24",
333    "weightedAverageExchangeRate": 0,
334    "status": "DRAFT",
335    "workflowStepName": "string",
336    "forcastYearStart": 0,
337    "forcastYearEnd": 0,
338    "actualYearStart": 0,
339    "actualYearEnd": 0,
340    "projectDescription": "string",
341    "projectJustification": "string",
342    "sponsor": "string",
343    "group1": {
344      "id": 0,
345      "createdOn": "2019-08-24T14:15:22Z",
346      "createdById": "string",
347      "modifiedOn": "2019-08-24T14:15:22Z",
348      "modifiedById": "string",
349      "createdByName": "string",
350      "lastModifiedByName": "string",
351      "displayId": "string",
352      "name": "string",
353      "type": "Group1"
354    },
355    "group2": {
356      "id": 0,
357      "createdOn": "2019-08-24T14:15:22Z",
358      "createdById": "string",
359      "modifiedOn": "2019-08-24T14:15:22Z",
360      "modifiedById": "string",
361      "createdByName": "string",
362      "lastModifiedByName": "string",
363      "displayId": "string",
364      "name": "string",
365      "type": "Group1"
366    },
367    "belongToBudget": {},
368    "totalRequestedAmount": 0,
369    "totalExpense": 0,
370    "totalSpent": 0,
371    "originalRequestedAmount": 0,
372    "modifiedAmount": 0,
373    "currentAvailable": 0,
374    "splitYears": "string",
375    "modificationId": 0,
376    "requestCategory": {
377      "id": 0,
378      "createdOn": "2019-08-24T14:15:22Z",
379      "createdById": "string",
380      "modifiedOn": "2019-08-24T14:15:22Z",
381      "modifiedById": "string",
382      "createdByName": "string",
383      "lastModifiedByName": "string",
384      "displayId": "string",
385      "title": "string",
386      "subTitle": "string",
387      "icon": "string",
388      "budgetTitle": "string",
389      "budgetSubTitle": "string",
390      "investmentTitle": "string",
391      "investmentSubTitle": "string"
392    },
393    "leaseArea": {
394      "id": 0,
395      "status": "CREATED",
396      "displayId": "string",
397      "name": "string",
398      "businessUnitId": 0
399    },
400    "businessUnit": {
401      "id": 0,
402      "status": "CREATED",
403      "displayId": "string",
404      "name": "string",
405      "leaseAreaId": 0,
406      "companyId": 0
407    },
408    "company": {
409      "id": 0,
410      "status": "CREATED",
411      "displayId": "string",
412      "erpSystemId": 0,
413      "erpSystemDisplayId": "string",
414      "countryId": 0,
415      "countryDisplayId": "string",
416      "postingPeriodVariantId": 0,
417      "name": "string",
418      "postingPeriodVariantDisplayId": "string",
419      "controllingAreaId": 0,
420      "controllingAreaDisplayId": "string",
421      "chartOfAccountId": 0,
422      "chartOfAccountDisplayId": "string",
423      "fiscalVariantId": 0,
424      "fiscalVariantDisplayId": "string",
425      "chartOfDepreciationId": 0,
426      "chartOfDepreciationDisplayId": "string",
427      "purchasingOrganizationId": 0,
428      "assetId": 0,
429      "exchangeRateTypeId": 0,
430      "plantId": 0,
431      "incrementalBorrowingRateId": 0,
432      "businessUnitId": 0,
433      "projectId": 0,
434      "transferVariantId": 0,
435      "partnerId": 0,
436      "departmentId": 0,
437      "accountingStandardId": 0,
438      "generalLedgerAccountId": 0,
439      "consumerPriceIndexCategoryId": 0,
440      "costCenterId": 0,
441      "costCenterRelationValidFrom": "2019-08-24",
442      "costCenterRelationValidTo": "2019-08-24"
443    },
444    "department": {
445      "id": 0,
446      "status": "CREATED",
447      "displayId": "string",
448      "name": "string",
449      "companyId": 0,
450      "leaseGroupId": 0
451    }
452  },
453  "totalRequestedAmount": 0,
454  "totalExpense": 0,
455  "totalSpent": 0,
456  "originalRequestedAmount": 0,
457  "modifiedAmount": 0,
458  "currentAvailable": 0,
459  "splitYears": "string",
460  "modificationId": 0,
461  "requestCategory": {
462    "id": 0,
463    "createdOn": "2019-08-24T14:15:22Z",
464    "createdById": "string",
465    "modifiedOn": "2019-08-24T14:15:22Z",
466    "modifiedById": "string",
467    "createdByName": "string",
468    "lastModifiedByName": "string",
469    "displayId": "string",
470    "title": "string",
471    "subTitle": "string",
472    "icon": "string",
473    "budgetTitle": "string",
474    "budgetSubTitle": "string",
475    "investmentTitle": "string",
476    "investmentSubTitle": "string"
477  },
478  "leaseArea": {
479    "id": 0,
480    "status": "CREATED",
481    "displayId": "string",
482    "name": "string",
483    "businessUnitId": 0
484  },
485  "businessUnit": {
486    "id": 0,
487    "status": "CREATED",
488    "displayId": "string",
489    "name": "string",
490    "leaseAreaId": 0,
491    "companyId": 0
492  },
493  "company": {
494    "id": 0,
495    "status": "CREATED",
496    "displayId": "string",
497    "erpSystemId": 0,
498    "erpSystemDisplayId": "string",
499    "countryId": 0,
500    "countryDisplayId": "string",
501    "postingPeriodVariantId": 0,
502    "name": "string",
503    "postingPeriodVariantDisplayId": "string",
504    "controllingAreaId": 0,
505    "controllingAreaDisplayId": "string",
506    "chartOfAccountId": 0,
507    "chartOfAccountDisplayId": "string",
508    "fiscalVariantId": 0,
509    "fiscalVariantDisplayId": "string",
510    "chartOfDepreciationId": 0,
511    "chartOfDepreciationDisplayId": "string",
512    "purchasingOrganizationId": 0,
513    "assetId": 0,
514    "exchangeRateTypeId": 0,
515    "plantId": 0,
516    "incrementalBorrowingRateId": 0,
517    "businessUnitId": 0,
518    "projectId": 0,
519    "transferVariantId": 0,
520    "partnerId": 0,
521    "departmentId": 0,
522    "accountingStandardId": 0,
523    "generalLedgerAccountId": 0,
524    "consumerPriceIndexCategoryId": 0,
525    "costCenterId": 0,
526    "costCenterRelationValidFrom": "2019-08-24",
527    "costCenterRelationValidTo": "2019-08-24"
528  },
529  "department": {
530    "id": 0,
531    "status": "CREATED",
532    "displayId": "string",
533    "name": "string",
534    "companyId": 0,
535    "leaseGroupId": 0
536  }
537}

📄 Description: Data transfer object representing a budget allocation, including details such as amount, category, and associated timelines, to facilitate effective financial planning and management within the organization.

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

Unique identifier for the resource

createdOn

string(date-time)

false

none

Timestamp indicating when the budget was created, providing essential context for budget lifecycle management and historical tracking.

createdById

string

false

none

Unique identifier for the created by

modifiedOn

string(date-time)

false

none

Timestamp indicating the last date and time when the budget record was modified, ensuring accurate tracking of changes for financial oversight.

modifiedById

string

false

none

Unique identifier for the modified by

createdByName

string

false

none

Name of the created by

lastModifiedByName

string

false

none

Name of the last modified by

requestedAmount

number

false

none

Amount of requested

spent

number

false

none

Represents the total amount of budget allocated that has been utilized, providing insight into financial performance against planned expenditures.

companyCurrency

string

false

none

Specifies the currency in which the company’s budget is denominated, facilitating accurate financial reporting and analysis.

endYear

integer(int32)

false

none

Represents the final year of the budget cycle, indicating the period for which the allocated funds are planned.

internalAssetClassIds

string

false

none

Comma-separated list of unique identifiers representing the internal asset classes associated with the budget, facilitating effective budget categorization and management.

availableCombos

string

false

none

Represents the available budget combinations that can be utilized for financial planning and resource allocation.

belongToBudgetId

integer(int64)

false

none

Unique identifier for the belong to budget

postedAssetExists

boolean

false

none

Indicates whether an asset has been posted to the budget, facilitating accurate financial tracking and reporting.

childrenIds

[integer]

false

none

Array of unique identifiers for the child budget items associated with the parent budget, facilitating efficient budget management and tracking.

investmentAreaIds

[integer]

false

none

Array of unique identifiers representing the specific investment areas associated with the budget allocation.

investmentRequestToInvestmentArea

InvestmentRequestToInvestmentAreaDto

false

none

Specifies the allocation of investment requests to designated investment areas within the budget framework.

investmentRequestYearDistribution

InvestmentRequestYearDistributionDto

false

none

Distribution of investment requests across different years, providing insights for budget allocation and financial planning.

investmentRequestId

integer(int64)

false

none

Unique identifier for the investment request

investmentRequestDisplayId

string

false

none

Unique identifier for the investment request display

investmentRequestTitle

string

false

none

Title of the investment request

requestCategoryId

integer(int64)

false

none

Unique identifier for the request category

year

integer(int32)

false

none

Represents the fiscal year associated with the budget, enabling accurate financial planning and reporting.

displayId

string

false

none

Unique identifier for the display

leaseAreaId

integer(int64)

false

none

Unique identifier for the lease area

leaseAreaDisplayId

string

false

none

Unique identifier for the lease area display

leaseAreaName

string

false

none

Name of the lease area

businessUnitId

integer(int64)

false

none

Unique identifier for the business unit

businessUnitDisplayId

string

false

none

Unique identifier for the business unit display

companyId

integer(int64)

false

none

Unique identifier for the company

companyDisplayId

string

false

none

Unique identifier for the company display

departmentId

integer(int64)

false

none

Unique identifier for the department

departmentDisplayId

string

false

none

Unique identifier for the department display

project

string

false

none

Represents the name or identifier of the project associated with the budget, facilitating effective financial tracking and management.

companyCurrencyId

integer(int64)

false

none

Unique identifier for the company currency

companyCurrencyDisplayId

string

false

none

Unique identifier for the company currency display

reportingCurrencyId

integer(int64)

false

none

Unique identifier for the reporting currency

reportingCurrencyDisplayId

string

false

none

Unique identifier for the reporting currency display

masterBudgetId

integer(int64)

false

none

Unique identifier for the master budget

archived

boolean

false

none

Indicates whether the budget has been archived, reflecting its status in the financial management process.

inceptionExchangeRate

number

false

none

Rate of inception exchange

exchangeRateValidFrom

string(date)

false

none

Indicates the date and time from which the exchange rate is considered valid for budget calculations.

weightedAverageExchangeRate

number

false

none

Rate of weighted average exchange

status

string

false

none

Status of the resource

workflowStepName

string

false

none

Name of the workflow step

forcastYearStart

integer(int32)

false

none

Indicates the starting year for the budget forecast, essential for aligning financial planning with organizational objectives.

forcastYearEnd

integer(int32)

false

none

Represents the fiscal year-end date for budget forecasting, enabling accurate financial planning and resource allocation.

actualYearStart

integer(int32)

false

none

Represents the starting year of the budget cycle, providing essential context for financial planning and analysis.

actualYearEnd

integer(int32)

false

none

Represents the actual year-end value for the budget, providing a critical measure for financial performance evaluation.

projectDescription

string

false

none

Description of the project

projectJustification

string

false

none

Description of the rationale behind the budget allocation for the project, providing essential context for financial decision-making.

sponsor

string

false

none

Name of the sponsor associated with the budget, providing accountability and ownership for financial allocations.

group1

ProjectGroupDto

false

none

Represents the first grouping category within the budget structure, facilitating organized budget management and reporting.

group2

ProjectGroupDto

false

none

Represents a secondary grouping identifier within the budget schema, facilitating the organization and categorization of budgetary allocations.

belongToBudget

BudgetDto

false

none

Indicates the budget to which the current entity is associated, facilitating effective budget management and allocation.

totalRequestedAmount

number

false

none

Amount of total requested

totalExpense

number

false

none

Represents the total expenses incurred within the budget, providing essential insights for financial analysis and decision-making.

totalSpent

number

false

none

Total amount of funds allocated and utilized within the budget, providing insight into financial performance and resource management.

originalRequestedAmount

number

false

none

Amount of original requested

modifiedAmount

number

false

none

Amount of modified

currentAvailable

number

false

none

Represents the current available budget amount, providing essential insight for financial planning and resource allocation.

splitYears

string

false

none

Specifies the budget allocation period in years, allowing for detailed financial planning and analysis.

modificationId

integer(int64)

false

none

Unique identifier for the modification

requestCategory

RequestCategoryDto

false

none

Category of the request

leaseArea

LeaseAreaDto

false

none

Represents the designated area associated with a lease within the budget framework, facilitating accurate financial planning and resource allocation.

businessUnit

BusinessUnitDto

false

none

Represents the specific business unit associated with the budget, facilitating targeted financial management and resource allocation within the organization.

company

CompanyDto

false

none

Represents the name of the company associated with the budget, facilitating financial tracking and reporting within the organization.

department

DepartmentDto

false

none

Represents the department associated with the budget, facilitating effective financial management and resource allocation within the organization.

Enumerated Values

Attribute

Value

status

APPROVED, DRAFT, MODIFICATION, REJECTED, REWORK, SUBMITTED