Versions Compared

Key

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

Overview

This structure includes basic information about a system currency. The information represented in this structure is not comprehensive and only includes certain key attributes of a currency. 

Format

Panel
titlePwsOpsCurrencySummary
  • PwsOpsCurrencySummary
    • OpsCurrencyCode: String
    • OpsCurrencyId: Int32
    • CurrencyIdentity: PwsCurrencyRef
    • CurrencyName: String
    • DecimalDigits: Byte
    • InactiveFlag: Boolean
    • InstallationCurrencyInactiveFlag: Boolean

Elements

Element

Data Type

Description

Sample Data

OpsCurrencyCode

String

 The code of the system currency.

 USD

OpsCurrencyId

Int32

 The system currency Id is a unique identifier. For internal use only.


CurrencyIdentity

PwsCurrencyRef

 This structure represents the unique key fields associated with identifying

...

Format

...

an account currency. Click here for more information. Note that this structure will be NULL if the currency represented is not set up as an account currency.


CurrencyName

String

 The name of the system currency.

 United States Dollars

DecimalDigits

Byte

 The number of decimal point allowed for this currency. If this currency is set up as an account currency, this value will reflect the decimal digit override at the account currency level, if there is one.

 2

InactiveFlag

Boolean

 If set to 'true', this system currency is inactive.

 false

InstallationCurrencyInactiveFlag

Boolean

 If set to 'true', the associated account currency is inactive. If this currency is not configured as an account currency, this will be NULL.

 false

Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
                 <a:Currency xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:OpsCurrencyCode>USD</b:OpsCurrencyCode>
                     <b:OpsCurrencyId i:nil="true"/>
                     <b:CurrencyIdentity>
                        <b:CurrencyCode>USD</b:CurrencyCode>
                        <b:CurrencyId i:nil="true"/>
                        <b:CurrencyUid>1152921504606849879</b:CurrencyUid>
                     </b:CurrencyIdentity>
                     <b:CurrencyName>United States Dollars</b:CurrencyName>
                     <b:DecimalDigits>2</b:DecimalDigits>
                     <b:InactiveFlag>false</b:InactiveFlag>
                     <b:InstallationCurrencyInactiveFlag>false</b:InstallationCurrencyInactiveFlag>
                  </a:Currency>