Package com.broadleafcommerce.paypal.micro.gateway.domain.orders

Class AmountWithBreakdown

java.lang.Object

com.broadleafcommerce.paypal.micro.gateway.domain.orders.AmountWithBreakdown

All Implemented Interfaces:

Serializable

public class AmountWithBreakdown
extends Object
implements Serializable

The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any. If you specify "amount.breakdown", the amount equals "item_total" plus "tax_total" plus "shipping" plus "handling" plus "insurance" minus "shipping_discount" minus discount. The amount must be a positive number. For listed of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes.

Author:

Dima Myroniuk (dmyroniuk)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AmountWithBreakdown()

Method Summary

Modifier and Type	Method	Description
AmountBreakdown	getAmountBreakdown()	The breakdown of the amount.
String	getCurrencyCode()	The three-character ISO-4217 currency code that identifies the currency.
String	getValue()	The value, which might be: An integer for currencies like "JPY" that are not typically fractional. A decimal fraction for currencies like "TND" that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes.
void	setAmountBreakdown(AmountBreakdown amountBreakdown)	The breakdown of the amount.
void	setCurrencyCode(String currencyCode)	The three-character ISO-4217 currency code that identifies the currency.
void	setValue(String value)	The value, which might be: An integer for currencies like "JPY" that are not typically fractional. A decimal fraction for currencies like "TND" that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AmountWithBreakdown

public AmountWithBreakdown()

Method Detail

setCurrencyCode

public void setCurrencyCode(String currencyCode)

The three-character ISO-4217 currency code that identifies the currency.

setValue

public void setValue(String value)

The value, which might be:

• An integer for currencies like "JPY" that are not typically fractional.
• A decimal fraction for currencies like "TND" that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

setAmountBreakdown

public void setAmountBreakdown(AmountBreakdown amountBreakdown)

The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.

getCurrencyCode

public String getCurrencyCode()

The three-character ISO-4217 currency code that identifies the currency.

getValue

public String getValue()

The value, which might be:

• An integer for currencies like "JPY" that are not typically fractional.
• A decimal fraction for currencies like "TND" that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

getAmountBreakdown

public AmountBreakdown getAmountBreakdown()

The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.