Class Money | Infocenter

Salesforce B2C Commerce 24.7 > B2C Commerce API > B2C Commerce Script > dw.value

dw.value

Class Money

Object

dw.value.Money

Represents money in Commerce Cloud Digital.

NOT_AVAILABLE : Money

Represents that there is no money available.

available : boolean (Read Only)

Identifies if the instance contains settings for value and currency.

currencyCode : String (Read Only)

The ISO 4217 currency mnemonic (such as 'USD', 'EUR') of the currency the money value relates to. Note a money instance may also describe a price that is 'not available'. In this case the value of this attribute is N/A.

decimalValue : Decimal (Read Only)

The money as Decimal, null is returned when the money is not available.

value : Number (Read Only)

The value of the money instance.

valueOrNull : Number (Read Only)

Return the value of the money instance or null if the Money instance is NOT_AVAILABLE.

Money(value : Number, currencyCode : String)

Constructs a new money instance with the specified amount for the specified currency.

add(value : Money) : Money

Returns a Money instance by adding the specified Money object to the current object.

addPercent(percent : Number) : Money

Adds a certain percentage to the money object.

addRate(value : Number) : Money

Adds a rate (e.g.

compareTo(other : Money) : Number

Compares two Money values.

divide(divisor : Number) : Money

Divide Money object by specified divisor.

equals(other : Object) : boolean

Compares two money values whether they are equivalent.

getCurrencyCode() : String

Returns the ISO 4217 currency mnemonic (such as 'USD', 'EUR') of the currency the money value relates to.

getDecimalValue() : Decimal

Returns the money as Decimal, null is returned when the money is not available.

getValue() : Number

Returns the value of the money instance.

getValueOrNull() : Number

Return the value of the money instance or null if the Money instance is NOT_AVAILABLE.

hashCode() : Number

Calculates the hash code for a money;

isAvailable() : boolean

Identifies if the instance contains settings for value and currency.

isOfSameCurrency(value : Money) : boolean

Identifies if two Money value have the same currency.

multiply(factor : Number) : Money

Multiply Money object by specified factor.

multiply(quantity : Quantity) : Money

Multiplies the Money object with the given quantity.

newMoney(value : Decimal) : Money

Method returns a new instance of Money with the same currency but different value.

percentLessThan(value : Money) : Number

Convenience method.

percentOf(value : Money) : Number

Convenience method.

static prorate(dist : Money, values : Money...) : Money[]

Prorates the specified values using the specified discount.

subtract(value : Money) : Money

Returns a new Money instance by substracting the specified Money object from the current object.

subtractPercent(percent : Number) : Money

Subtracts a certain percentage from the money object.

subtractRate(value : Number) : Money

Subtracts a rate (e.g.

toFormattedString() : String

Returns a string representation of Money according to the regional settings configured for current request locale, for example '$59.00' or 'USD 59.00'.

toNumberString() : String

Returns a string representation for the numeric value of this money.

toString() : String

Returns a string representation of this Money object.

valueOf() : Object

According to the ECMA spec returns the "natural" primitve value.

Salesforce B2C Commerce Developer - Certification Tests

Why risk failing the SFCC exam? Get 180 real questions, killer content, and everything you need to crush the Salesforce B2C Commerce Developer certification.

Becoming a Salesforce B2C Commerce Developer is your ticket to higher salaries, better job opportunities, and the credibility to stand out from the competition. But let's be honest—passing the certification exam isn't easy. That's where we come in.

Salesforce Javascript Developer I - Certification Tests

Not just another prep course—this is your shortcut to passing. Master JavaScript for Salesforce and go from 'hoping to pass' to knowing you will. Ready to start?

This isn't just another prep course—it's your shortcut to mastering the skills and confidence you need to pass. With multiple practice tests covering every section and a final exam simulation designed to mirror the real thing, you'll feel like you've already aced it before test day.

Salesforce B2C Commerce Architect - Certification Tests

Think the Developer exam was hard? Welcome to the next level.

The Salesforce B2C Commerce Architect certification is a whole different game—complex solutions, elevated difficulty, and skills that set you apart in the eCommerce industry. That's why we're including 11 downloadable PDF guides, packed with best practices and strategies to help you prepare for the exam and build confidence in every topic.

Methods inherited from class Object

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Money

public Money(value : Number, currencyCode : String)

Constructs a new money instance with the specified amount for the specified currency. Note that each currency has a precision (number of digits after the decimal point) and that values beyond the precision are "rounded up" to their "nearest neighbor" following the rules of java.math.RoundingMode.HALF_UP.

Parameters:

value - The value of the money instance. Must not be null.

currencyCode - The ISO 4217 mnemonic of currency the amount is specified in. Must not be null.

add

add(value : Money) : Money

Returns a Money instance by adding the specified Money object to the current object. Only objects representing the same currency can be added. If one of the Money values is N/A, the result is N/A.

Parameters:

value - the Money object to add to this Money instance.

Returns:

the Money object representing the sum of the operands.

addPercent

addPercent(percent : Number) : Money

Adds a certain percentage to the money object. The percent value is given as true percent value, so for example 10 represent 10%. If this Money is N/A the result is also N/A.

Parameters:

percent - the percent value

Returns:

new Money object with the result of the calculation

addRate

addRate(value : Number) : Money

Adds a rate (e.g. 0.05) to the money object. This is typically for example to add a tax rate.

Parameters:

value - the rate to add.

Returns:

a new Money object with rate added.

compareTo

compareTo(other : Money) : Number

Compares two Money values. An exception is thrown if the two Money values are of different currency. If one of the Money values represents the N/A value it is treated as 0.0.

Parameters:

other - the money instance to comare against this money instance.

Returns:

the comparison of 0 if the money instances are equal or non-0 if they are different.

divide

divide(divisor : Number) : Money

Divide Money object by specified divisor. If this Money is N/A the result is also N/A.

Parameters:

divisor - the divisor.

Returns:

Money object representing division result

equals

equals(other : Object) : boolean

Compares two money values whether they are equivalent.

Parameters:

other - the object to compare against this money instance.

Returns:

true if equal, false otherwise.

getCurrencyCode

getCurrencyCode() : String

Returns the ISO 4217 currency mnemonic (such as 'USD', 'EUR') of the currency the money value relates to. Note a money instance may also describe a price that is 'not available'. In this case the value of this attribute is N/A.

Returns:

the value of the currency code.

getDecimalValue

getDecimalValue() : Decimal

Returns the money as Decimal, null is returned when the money is not available.

Returns:

the money as Decimal

getValue

getValue() : Number

Returns the value of the money instance.

Returns:

the value of the money instance.