getBudgetExchangeRate
On the Budget Exchange Rates table, you can maintain exchange rates between the root-parent and child subsidiaries for use in the budgeting process. Use the getBudgetExchangeRate operation to get and filter all data related to this table.
This operation can be used only in NetSuite OneWorld accounts.
In the UI, you can see the Budget Exchange Rates table by going to List > Accounting > Budget Exchange Rates. Note that in SOAP web services, this table is read-only.
For general information on the Budget Exchange Rate table, see Budget Exchange Rates.
Request
The GetBudgetExchangeRateRequest type is used for the request.
Element Name |
XSD Type |
Notes |
---|---|---|
budgetExchangeRateFilter |
BudgetExchageRateFilter |
You can filter the returned exchange rates for a budget using this filter. |
BudgetExchangeRateFilter
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. |
Response
The GetBudgetExchangeRateResult 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. |
budgetExchangeRateList |
BudgetExchangeRateList |
Returns a list of available exchange rates in a budget. |
BudgetExchangeRateList
Element Name |
XSD Type |
Notes |
---|---|---|
budgetExchangeRate |
BudgetExchangeRate |
References the exchange rate for a budget. |
BudgetExchangeRate
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.
-
InvalidSessionFault
-
InvalidCredentialsFault
-
ExceededRequestLimitFault
-
ExceededUsageLimitFault
-
ExceededRecordCountFault
-
ExceededRequestSizeFault
-
UnexpectedErrorFault
Sample Code
SOAP Request
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getBudgetExchangeRate xmlns="urn:messages_2017_1.platform.webservices.netsuite.com">
<budgetExchangeRateFilter>
<ns1:period internalId="3" xmlns:ns1="urn:core_2017_1.platform.webservices.netsuite.com"/>
<ns2:fromSubsidiary internalId="4" xmlns:ns2="urn:core_2017_1.platform.webservices.
netsuite.com"/>
</budgetExchangeRateFilter>
</getBudgetExchangeRate>
</soapenv:Body>
</soapenv:Envelope>
SOAP Response
<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<getBudgetExchangeRateResponse xmlns="urn:messages_2017_1.platform.webservices.netsuite.com">
<platformCore:getBudgetExchangeRateResult
xmlns:platformCore="urn:core_2017_1.platform.webservices.netsuite.com">
<platformCore:status isSuccess="true"/>
<platformCore:budgetExchangeRateList>
<platformCore:budgetExchangeRate>
<platformCore:period internalId="3"/>
<platformCore:fromSubsidiary internalId="4"/>
<platformCore:toSubsidiary internalId="1"/>
<platformCore:currentRate>1.9586</platformCore:currentRate>
<platformCore:averageRate>1.9586</platformCore:averageRate>
<platformCore:historicalRate>1.9586</platformCore:historicalRate>
</platformCore:budgetExchangeRate>
</platformCore:budgetExchangeRateList>
</platformCore:getBudgetExchangeRateResult>
</getBudgetExchangeRateResponse>
</soapenv:Body>
</soapenv:Envelope>
Java
/* Make Record Ref out of an internalId */
public static RecordRef mrr(String internalId)
{
RecordRef toRet = new RecordRef();
toRet.setInternalId(internalId);
return toRet;
}
c.getPort().getBudgetExchangeRate(new BudgetExchangeRateFilter(mrr("3"),mrr("4"),null));