getConsolidatedExchangeRate

On the Consolidated Exchange Rates table, you can maintain exchange rates between the root-parent and child subsidiaries. Use the getConsolidatedExchangeRate operation to get and filter all data related to this table.

Important:

The exposure of the consolidated exchange rate record prompted the removal of the getConsolidatedExchangeRate operation from the 2017.1 endpoint. You can still use the getConsolidatedExchangeRate operation on earlier endpoints. For more information about working with consolidated exchange rates on endpoints starting from 2017.1, see Consolidated Exchange Rate.

Important:

This operation can be used only in NetSuite OneWorld acccounts.

In the UI, you can see the Consolidated Exchange Rates table by going to List > Accounting > Consolidated Exchange Rates. Note that in SOAP web services, this table is read-only.

For general information on currencies and working with the Consolidated Exchange Rate table, see the following topics:

Note:

If you choose, you can set exchange rates in the Consolidated Exchange Rates table directly. See the steps under “To set exchange rates in the Consolidated Exchange Rates table” for details.

getConsolidatedExchangeRate for the Multi-Book Accounting Feature

Results for the getConsolidatedExchageRate operation can include values for the book field. Results can also be filtered by this field.

Note:

In endpoints prior to 2016.2, the getConsolidatedExchangeRate operation can only be used to return results for the primary accounting book, even if the Multi-Book Accounting feature is enabled.

Request

The GetConsolidatedExchangeRateRequest type is used for the request.

Element Name

XSD Type

Notes

consolidatedExchangeRateFilter

ConsolidatedExchangeRateFilter

You can filter the returned consolidated exchange rates using this filter.

ConsolidatedExchangeRateFilter

ConsolidatedExchangeRateFilter is defined in the core XSD.

Element Name

XSD Type

Notes

period

RecordRef

References an existing period. This argument is required.

fromSubsidiary

RecordRef

References the receiving subsidiary. This argument is optional.

toSubsidiary

RecordRef

References the originating subsidiary. This argument is optional.

book

RecordRef

References the specific accounting book for accounts with the Multi-Book Accounting feature enabled.

Response

The GetConsolidatedExchangeRateResult type is used for the response.

Element Name

XSD Type

Notes

status

Status

The status for this operation. All applicable errors or warnings are listed within this type.

consolidatedExchangeRateList

ConsolidatedExchangeRateList

Returns a list of available consolidated exchange rates.

ConsolidatedExchangeRateList

Element Name

XSD Type

Notes

consolidatedExchangeRate

ConsolidatedExchangeRate

References an existing period.

ConsolidatedExchangeRate

Element Name

XSD Type

Notes

period

RecordRef

References an existing period.

fromSubsidiary

RecordRef

References the receiving subsidiary.

toSubsidiary

RecordRef

References the originating subsidiary.

currentRate

double

References the current rate.

averageRate

double

References the average rate.

historicalRate

double

References the historical rate.

Faults

This operation can throw one of the following faults. See SOAP Fault Status Codes for more information on faults.

Sample Code

The getConsolidatedExchangeRate and getBudgetExchangeRate operations are used in the same way. Therefore, please refer to the Sample Code for getBudgetExchangeRate.

Related Topics

General Notices