Overview
This structure represents the unique key fields associated with identifying a currency. Currencies can be identified by CurrencyCode or CurrencyUid. When specifying a PwsCurrencyRef as an input to a web service, you may specify one or both the CurrencyCode and/or CurrencyUid. However, if you do specify both, they must both refer to the same currency or the currency reference will not be considered valid. When a PwsCurrencyRef is returned in the response to a web service, both the CurrencyCode and CurrencyUid will be populated, and guaranteed to refer to a single currency.
Format
| Panel | ||
|---|---|---|
| ||
|
Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
CurrencyCode | String (4) | On Insert: Yes (if CurrencyUid is not supplied) On Update: Yes (if CurrencyUid is not supplied) | The currency code is a unique identifier for a currency | USD | |
CurrencyId | Int32 | On Insert: No On Update: No | The currency Id is a unique identifier for a currency. For internal use only. | ||
CurrencyUid | Int64 | On Insert: Yes (if CurrencyCode is not supplied) On Update: Yes (if CurrencyCode is not supplied) | The currency Uid is a unique and immutable identifier for a currency | 1152921504606851838 |
Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<CurrencyIdentity>
<CurrencyCode>USD</CurrencyCode>
<CurrencyId i:nil="true"/>
<CurrencyUid>1152921504606851838</CurrencyUid>
</CurrencyIdentity>
|