Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This structure represents the unique key fields associated with identifying a currency. Currences 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.

...

Panel
titlePwsCurrencyRef
  • PwsCurrencyRef
    • CurrencyCode: String (4)
    • CurrencyId: Int32
    • CurrencyUid: Int64


Elements


Element

Data Type

Required?

Default 

Description

Sample Data

CultureId

Int32

On Insert: No

On Update: No

CurrencyCode

String (4)

One of CurrencyCode or CurrencyUid is required

The currency code is a unique identifier for a currency.

USD
CultureNameThe currency Id is a

CurrencyId

String

On Insert: Yes

On Update: Yes (if CultureUid is not supplied) 

 

Int32

No

A unique identifier for a currency. For internal use only.

 

CultureUid


CurrencyUid

Int64

On Insert: No

On Update: Yes (if CultureName is not supplied)

 

The currency Uid is a

See CurrencyCode

A unique and immutable identifier for a currency.

1152921504606851838


Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
                     <CurrencyIdentity><b:CurrencyIdentity>
                        <CurrencyCode>USD<<b:CurrencyCode>USD</b:CurrencyCode>
                        <CurrencyId<b:CurrencyId i:nil="true"/>
                        <CurrencyUid>1152921504606851838<<b:CurrencyUid>1152921504606851838</b:CurrencyUid>
                     </b:CurrencyIdentity>