BUILTIN.CONSOLIDATE

This function converts the currency amount in a field to a target currency.

Parameters

Important:

To use the default value for any parameter (except original amount field name and view type), you can specify 'DEFAULT' as the parameter value.

Parameter	Required / Optional	Description	Acceptable Parameter Values
Original amount field name	Required	The field name to apply criteria context to.	–
View type	Required	Supported view types.	`'LEDGER'` `'INCOME'`
Consolidation rate type	Required	Supported consolidation rate types.	`'DEFAULT'` `'STANDARD'` `'BUDGET'`
Subsidiary rate type	Required	Supported rate types based on subsidiary.	`'DEFAULT'` `'CURRENT'` `'HISTORICAL'` `'AVERAGE'` `SQL EXPRESSION`
Target subsidiary	Required	The target subsidiary id.	Number `SQL EXPRESSION`
Period	Required	The accounting period.	Number `SQL EXPRESSION`
Book	Required	The accounting book.	`'DEFAULT'` `SQL EXPRESSION`

Parameter

Required / Optional

Description

Acceptable Parameter Values

Original amount field name

Required

The field name to apply criteria context to.

–

View type

Required

Supported view types.

Consolidation rate type

Required

Supported consolidation rate types.

Subsidiary rate type

Required

Supported rate types based on subsidiary.

Target subsidiary

Required

The target subsidiary id.

Period

Required

The accounting period.

Book

Required

The accounting book.

          BUILTIN.CONSOLIDATE(sales.amount, 'INCOME', 'DEFAULT', 'DEFAULT', 1, NUMBER, 'DEFAULT')