GetTotalFinancialSummaryForFixedPeriod
GetTotalFinancialSummaryForFixedPeriod (work item as ObjectIdentifier, field as String, period as String[,start year as Numeric, start month as Numeric, periods count as Numeric])
| Category: | Financial Planning |
| Description: | Returns a Currency value indicating the aggregated financial value of a specific financial resource time-phase field, for the specified Resource in the fixed time range for a specified project. Example business questions: Calculate Budget Cost for current fiscal month Calculate Forecast Cost for next fiscal quarter Calculate Budget Revenue for next fiscal year |
| Supported Context: | Business Rules |
| Parameters: | |
| workitem as ObjectIdentifier(workitem) | Represents a reference to a work item. Normally this will be a project. |
| field as string | Note: because the currency fields you will be referencing may not be directly referenceable using the Formula Options helper, you will need to manually input the field’s API name in the formula. The field API name can be seen in the Configure screen. Examples: “PlannedBudget”, “ForecastRevenue”. Full example below. |
| period | Calendar Periods: ‘d’ for Current Day ‘w’ for Current Week ‘m’ for Current Month 'q' for Current Quarter 'y' for Current Year Fiscal Periods ‘fm’ for Fiscal Month 'fq' for Fiscal Quarter 'fy' for Fiscal Year |
| Optional Parameters | Note: Start year and month will be according to whether you defined calendar or fiscal period in the previous parameter |
| Start year as numeric | The calendar or fiscal year you want to start aggregating from. If not set, will use Current Year. |
| Start Month as Numeric | The calendar or fiscal month you want to start aggregating from. 1 to 12 If not set, will use Month 1 Only used if you have set a Start Year. |
| Periods count as Numeric | The amount of quantities to aggregated data from. The period used is the period (day, week, month, quarter, year) defined in the 3rd parameter. |
| Example #1 |
Calendar Period: Calculate Budget Revenue for current calendar month GetTotalFinancialSummaryForFixedPeriod(CurrentObject(),'PlannedRevenue','m') Calculate Budget Cost for a calendar year, starting in June 2019 (ending in June 2020) GetTotalFinancialSummaryForFixedPeriod(CurrentObject(),'PlannedBudget','y',Year(today()+1) Calculate Budget Cost for a calendar year, starting in June 2019 (ending in June 2020) GetTotalFinancialSummaryForFixedPeriod(CurrentObject(),'PlannedBudget','y',2019,06) Calculate Forecast Revenue for 10 Years period, starting from Jan 2020 GetTotalFinancialSummaryForFixedPeriod(CurrentObject(),'ForecastRevenue,'y',2020,01,10) Fiscal Period: Calculate Budget Cost for Fiscal Year 2019 GetTotalFinancialSummaryForFixedPeriod(CurrentObject(),'PlannedBudget','fy',2019) Calculate Next 3 Fiscal Years Budget Cost for Starting in Fiscal Year 2019 GetTotalFinancialSummaryForFixedPeriod(CurrentObject(),'PlannedBudget','fy',2019,1,3) |
| Tips | The API name of the field you want to summarize should be in Quotes and without "$". |