GetFinancialDataForGivenPeriod Function
GetFinancialDataForGivenPeriod(work item as ObjectIdentifier, nlr as ObjectIdentifier, field as String, from as DateTime, to as DateTime)
| Category: | Financial Planning |
| Description: | Returns a Currency value indicating the aggregated financial value of a specific financial resource time-phase field, for the specified Non-Labor Resource in the given time range for a specified project. This should be the same number that is displayed in the Financial Planning screen. |
| Supported Context: | Business Rules |
| Parameters: | |
| workitem as ObjectIdentifier(workitem) | Represents a reference to a work item object or a field that returns a work item object. |
| nlr as ObjectIdentifier(nlr) | Represents a non-labor resource object for which you would like to calculate financial timephase data |
| dateTime1 | Represents a reference to a from date as DateTime(year,month,day,hour,minute,second) e.g. DateTime(Year(Today()),1,1,08,00,00) or field that returns a date value e.g. Start Date |
| field as string | The API name of the field in 'quotes' that you want to summarize for the time period. 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. |
| dateTime2 | Represents a reference to a to date as DateTime(year,month,day,hour,minute,second) e.g. DateTime(Year(Today()),12,31,08,00,00) or field that returns a date value e.g. Due Date |
| Example #1 | GetFinancialDataForGivenPeriod(CurrentObject(),’NLR-101’,'PlannedBudget',DateTime(2018,01,01,08,00,00),DateTime(2018,12,31,20,00,00)) |