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? | Description | Sample Data |
|---|---|---|---|---|
CurrencyCode | String (4) | One of CurrencyCode or CurrencyUid is required | The currency code is a unique identifier for a currency | USD |
CurrencyId | Int32 | No | A unique identifier for a currency. For internal use only. | |
CurrencyUid | Int64 | See CurrencyCode | A unique and immutable identifier for a currency | 1152921504606851838 |
Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<b:CurrencyIdentity>
<b:CurrencyCode>USD</b:CurrencyCode>
<b:CurrencyId i:nil="true"/>
<b:CurrencyUid>1152921504606851838</b:CurrencyUid>
</b:CurrencyIdentity>
|