YearBudget([BudgetCode: String,] PeriodID: Number[, BranchRange: String, DepartmentRange: String, Segment1Range: String, Segment2Range: String, Selection: String, ConsolidateBy: String] [, Level: Number, ExcludeNull: Boolean])
Year to date budget as at period specified. If a budget code is not passed then the default budget is used. Optionally can be passed additional parameters to calculate summed year to date budget over a range of accounts. If additional parameters are not supplied, they will default from the iterator for the band.
Note: Branch and Department are only available in Accredo Saturn.
Note: If any of the BranchRange, DepartmentRange, Segment1Range, Segment2Range, Selection and ConsolidateBy parameters are passed in, all these parameters must be passed in.
YearBudget function syntax has these named arguments:
Parameter |
Description |
|---|---|
Budget Code |
Optional. Budget code to use. If not specified, defaults to the Default Budget Code set in GL Settings. |
Period ID |
Required. The Period ID to use. |
Branch Range |
Optional. Range of branches to be included. If this is entered, the Department Range, Segment 1 Range and Segment 2 Range must be entered. If this is not entered, defaults from the Iterator.
|
Department Range |
Optional. Range of departments to be included. If this is entered, the Branch Range, Segment 1 Range and Segment 2 Range must be entered. If this is not entered, defaults from the Iterator.
|
Segment 1 Range |
Optional. Range of Segment 1 values to be included. If this is entered, the Branch Range, Department Range and Segment 2 Range must be entered. If this is not entered, defaults from the Iterator. |
Segment 2 Range |
Optional. Range of Segment 2 values to be included. If this is entered, the Branch Range, Department Range and Segment 1 Range must be entered. If this is not entered, defaults from the Iterator. |
Selection |
Optional. Selection to be included. |
Consolidate By |
Optional. String to consolidate by. |
Level |
Optional. The level to total to. |
Exclude Null |
Optional. When True, nulls will be excluded. |