CurrencyPeriodRates

This component runs the Currency Period Rates (CNP) function.

Note: This Help contains hyperlinks that are enabled when the Help is accessed within the application. However, if you have accessed this Help via the SunSystems Web portal, hyperlinks are not enabled.

Methods

Amend: Driver Type: SASI; Use this method to amend one or more currency code period rates. If a currency code period rate does not exist, an error message is produced and the payload is rejected.; Note: You cannot use this method to amend the status of currency code period rates. Instead, use one of the Open, Hidden, SuspendedHeld or Closed methods.
BulkCreateOrAmend: Driver Type: DJI; Use this method for the bulk loading or bulk amendment of currency period rates, or where performance is critical.
Closed: Driver Type: SASI; Use this method to amend the status of one or more currency code period rates to Closed.
CreateAsDraft: Driver Type: SASI; Use this method to create one or more draft currency period rates.
CreateOrAmend: Driver Type: SASI; Use this method to create or amend one or more currency period rates. A currency period rate is created if it does not exist and amended if it does. Both the Create and Amend methods require you to know in advance if a currency code period rate exists, whereas this method can be used if you are unsure.; Note: You cannot use this method to amend the status of currency code period rates. Instead, use one of the Open, Hidden, SuspendedHeld or Closed methods.
CreateReplaceOrDelete: Driver Type: SASI; Use this method to synchronize currency period rates. A currency period rate is created if it does not exist already and replaced if it does. If a currency period rate does not exist in the originating business unit, it is deleted.
Delete: Driver Type: SASI; Use this method to delete one or more currency code period rates.
Hidden: Driver Type: SASI; Use this method to amend the status of one or more currency code period rates to Hidden.
Open: Driver Type: SASI; Use this method to amend the status of one or more currency code period rates to Open.
Query: Driver Type: Export; Use this method to obtain currency code period rates details or to extract currency code period rates data from SunSystems.
SuspendedHeld: Driver Type: SASI; Use this method to amend the status of one or more currency code period rate to Suspended/Held.

Mandatory fields

When creating or amending a currency code period rate or changing the currency code period rate status, the following must be supplied:
- Currency Code From - payload element <CurrencyCodeFrom>
- Currency Code To - payload element <CurrencyCodeTo>
When specifying a Currency Rate Type, you must enter an existing rate type code:
```
<RateType>
<ShortHeading>.</ShortHeading>
</RateType>
```

If no rate type is specified, the currency period rate is used as the DEFAULT rate type.

Note: At runtime the component validates the payload contents to ensure that the values supplied are correct. Various combinations of values may require other elements in the payload to be specified before the payload can be processed successfully.

Related data

None.