Invoicingv2invoicesOrderInformationAmountDetails (cybersource-rest-client-java 0.0.53 API)

java.lang.Object
- Model.Invoicingv2invoicesOrderInformationAmountDetails

public class Invoicingv2invoicesOrderInformationAmountDetails
extends Object

Contains all of the amount-related fields in the invoice.

Constructor Summary

Constructors
Constructor and Description

Invoicingv2invoicesOrderInformationAmountDetails()

Constructors
Constructor and Description
`Invoicingv2invoicesOrderInformationAmountDetails()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Invoicingv2invoicesOrderInformationAmountDetails`	`currency(String currency)`
`Invoicingv2invoicesOrderInformationAmountDetails`	`discountAmount(String discountAmount)`
`Invoicingv2invoicesOrderInformationAmountDetails`	`discountPercent(BigDecimal discountPercent)`
`boolean`	`equals(Object o)`
`Invoicingv2invoicesOrderInformationAmountDetails`	`freight(Invoicingv2invoicesOrderInformationAmountDetailsFreight freight)`
`String`	`getCurrency()` Currency used for the order.
`String`	`getDiscountAmount()` Total discount amount applied to the order.
`BigDecimal`	`getDiscountPercent()` The total discount percentage applied to the invoice.
`Invoicingv2invoicesOrderInformationAmountDetailsFreight`	`getFreight()` Get freight
`BigDecimal`	`getMinimumPartialAmount()` The minimum partial amount required to pay the invoice.
`BigDecimal`	`getSubAmount()` Sub-amount of the invoice.
`Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails`	`getTaxDetails()` Get taxDetails
`String`	`getTotalAmount()` Grand total for the order.
`int`	`hashCode()`
`Invoicingv2invoicesOrderInformationAmountDetails`	`minimumPartialAmount(BigDecimal minimumPartialAmount)`
`void`	`setCurrency(String currency)`
`void`	`setDiscountAmount(String discountAmount)`
`void`	`setDiscountPercent(BigDecimal discountPercent)`
`void`	`setFreight(Invoicingv2invoicesOrderInformationAmountDetailsFreight freight)`
`void`	`setMinimumPartialAmount(BigDecimal minimumPartialAmount)`
`void`	`setSubAmount(BigDecimal subAmount)`
`void`	`setTaxDetails(Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails taxDetails)`
`void`	`setTotalAmount(String totalAmount)`
`Invoicingv2invoicesOrderInformationAmountDetails`	`subAmount(BigDecimal subAmount)`
`Invoicingv2invoicesOrderInformationAmountDetails`	`taxDetails(Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails taxDetails)`
`String`	`toString()`
`Invoicingv2invoicesOrderInformationAmountDetails`	`totalAmount(String totalAmount)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Invoicingv2invoicesOrderInformationAmountDetails
```
public Invoicingv2invoicesOrderInformationAmountDetails()
```
- Method Detail
  - totalAmount
```
public Invoicingv2invoicesOrderInformationAmountDetails totalAmount(String totalAmount)
```
  - getTotalAmount
```
public String getTotalAmount()
```
    Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used.
    
    Returns:
    
    totalAmount
  - setTotalAmount
```
public void setTotalAmount(String totalAmount)
```
  - currency
```
public Invoicingv2invoicesOrderInformationAmountDetails currency(String currency)
```
  - getCurrency
```
public String getCurrency()
```
    Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency.
    
    Returns:
    
    currency
  - setCurrency
```
public void setCurrency(String currency)
```
  - discountAmount
```
public Invoicingv2invoicesOrderInformationAmountDetails discountAmount(String discountAmount)
```
  - getDiscountAmount
```
public String getDiscountAmount()
```
    Total discount amount applied to the order.
    
    Returns:
    
    discountAmount
  - setDiscountAmount
```
public void setDiscountAmount(String discountAmount)
```
  - discountPercent
```
public Invoicingv2invoicesOrderInformationAmountDetails discountPercent(BigDecimal discountPercent)
```
  - getDiscountPercent
```
public BigDecimal getDiscountPercent()
```
    The total discount percentage applied to the invoice.
    
    Returns:
    
    discountPercent
  - setDiscountPercent
```
public void setDiscountPercent(BigDecimal discountPercent)
```
  - subAmount
```
public Invoicingv2invoicesOrderInformationAmountDetails subAmount(BigDecimal subAmount)
```
  - getSubAmount
```
public BigDecimal getSubAmount()
```
    Sub-amount of the invoice.
    
    Returns:
    
    subAmount
  - setSubAmount
```
public void setSubAmount(BigDecimal subAmount)
```
  - minimumPartialAmount
```
public Invoicingv2invoicesOrderInformationAmountDetails minimumPartialAmount(BigDecimal minimumPartialAmount)
```
  - getMinimumPartialAmount
```
public BigDecimal getMinimumPartialAmount()
```
    The minimum partial amount required to pay the invoice.
    
    Returns:
    
    minimumPartialAmount
  - setMinimumPartialAmount
```
public void setMinimumPartialAmount(BigDecimal minimumPartialAmount)
```
  - taxDetails
```
public Invoicingv2invoicesOrderInformationAmountDetails taxDetails(Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails taxDetails)
```
  - getTaxDetails
```
public Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails getTaxDetails()
```
    Get taxDetails
    
    Returns:
    
    taxDetails
  - setTaxDetails
```
public void setTaxDetails(Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails taxDetails)
```
  - freight
```
public Invoicingv2invoicesOrderInformationAmountDetails freight(Invoicingv2invoicesOrderInformationAmountDetailsFreight freight)
```
  - getFreight
```
public Invoicingv2invoicesOrderInformationAmountDetailsFreight getFreight()
```
    Get freight
    
    Returns:
    
    freight
  - setFreight
```
public void setFreight(Invoicingv2invoicesOrderInformationAmountDetailsFreight freight)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Invoicingv2invoicesOrderInformationAmountDetails

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Invoicingv2invoicesOrderInformationAmountDetails

Method Detail

totalAmount

getTotalAmount

setTotalAmount

currency

getCurrency

setCurrency

discountAmount

getDiscountAmount

setDiscountAmount

discountPercent

getDiscountPercent

setDiscountPercent

subAmount

getSubAmount

setSubAmount

minimumPartialAmount

getMinimumPartialAmount

setMinimumPartialAmount

taxDetails

getTaxDetails

setTaxDetails

freight

getFreight

setFreight

equals

hashCode

toString