Ptsv2paymentsidrefundsOrderInformationLineItems (cybersource-rest-client-java 0.0.41 API)

java.lang.Object
- Model.Ptsv2paymentsidrefundsOrderInformationLineItems

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2022-01-19T16:20:04.317+05:30")
public class Ptsv2paymentsidrefundsOrderInformationLineItems
extends Object

Ptsv2paymentsidrefundsOrderInformationLineItems

Constructor Summary

Constructors
Constructor and Description

Ptsv2paymentsidrefundsOrderInformationLineItems()

Constructors
Constructor and Description
`Ptsv2paymentsidrefundsOrderInformationLineItems()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`addTaxDetailsItem(Ptsv2paymentsOrderInformationAmountDetailsTaxDetails taxDetailsItem)`
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`amountIncludesTax(Boolean amountIncludesTax)`
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`commodityCode(String commodityCode)`
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`discountAmount(String discountAmount)`
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`discountApplied(Boolean discountApplied)`
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`discountRate(String discountRate)`
`boolean`	`equals(Object o)`
`Boolean`	`getAmountIncludesTax()` Flag that indicates whether the tax amount is included in the Line Item Total.
`String`	`getCommodityCode()` Commodity code or International description code used to classify the item.
`String`	`getDiscountAmount()` Discount applied to the item.
`Boolean`	`getDiscountApplied()` Flag that indicates whether the amount is discounted.
`String`	`getDiscountRate()` Rate the item is discounted.
`String`	`getInvoiceNumber()` Field to support an invoice number for a transaction.
`String`	`getProductCode()` Type of product.
`String`	`getProductName()` For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling.
`String`	`getProductSku()` Product identifier code.
`Integer`	`getQuantity()` Number of units for this order.
`String`	`getTaxAmount()` Total tax to apply to the product.
`String`	`getTaxAppliedAfterDiscount()` Flag to indicate how you handle discount at the line item level.
`List<Ptsv2paymentsOrderInformationAmountDetailsTaxDetails>`	`getTaxDetails()` Get taxDetails
`String`	`getTaxRate()` Tax rate applied to the item.
`String`	`getTaxStatusIndicator()` Flag to indicate whether tax is exempted or not included.
`String`	`getTaxTypeCode()` Type of tax being applied to the item.
`String`	`getTotalAmount()` Total amount for the item.
`String`	`getTypeOfSupply()` Flag to indicate whether the purchase is categorized as goods or services.
`String`	`getUnitOfMeasure()` Unit of measure, or unit of measure code, for the item.
`String`	`getUnitPrice()` Per-item price of the product.
`int`	`hashCode()`
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`invoiceNumber(String invoiceNumber)`
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`productCode(String productCode)`
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`productName(String productName)`
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`productSku(String productSku)`
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`quantity(Integer quantity)`
`void`	`setAmountIncludesTax(Boolean amountIncludesTax)`
`void`	`setCommodityCode(String commodityCode)`
`void`	`setDiscountAmount(String discountAmount)`
`void`	`setDiscountApplied(Boolean discountApplied)`
`void`	`setDiscountRate(String discountRate)`
`void`	`setInvoiceNumber(String invoiceNumber)`
`void`	`setProductCode(String productCode)`
`void`	`setProductName(String productName)`
`void`	`setProductSku(String productSku)`
`void`	`setQuantity(Integer quantity)`
`void`	`setTaxAmount(String taxAmount)`
`void`	`setTaxAppliedAfterDiscount(String taxAppliedAfterDiscount)`
`void`	`setTaxDetails(List<Ptsv2paymentsOrderInformationAmountDetailsTaxDetails> taxDetails)`
`void`	`setTaxRate(String taxRate)`
`void`	`setTaxStatusIndicator(String taxStatusIndicator)`
`void`	`setTaxTypeCode(String taxTypeCode)`
`void`	`setTotalAmount(String totalAmount)`
`void`	`setTypeOfSupply(String typeOfSupply)`
`void`	`setUnitOfMeasure(String unitOfMeasure)`
`void`	`setUnitPrice(String unitPrice)`
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`taxAmount(String taxAmount)`
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`taxAppliedAfterDiscount(String taxAppliedAfterDiscount)`
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`taxDetails(List<Ptsv2paymentsOrderInformationAmountDetailsTaxDetails> taxDetails)`
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`taxRate(String taxRate)`
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`taxStatusIndicator(String taxStatusIndicator)`
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`taxTypeCode(String taxTypeCode)`
`String`	`toString()`
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`totalAmount(String totalAmount)`
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`typeOfSupply(String typeOfSupply)`
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`unitOfMeasure(String unitOfMeasure)`
`Ptsv2paymentsidrefundsOrderInformationLineItems`	`unitPrice(String unitPrice)`

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

- Constructor Detail
  - Ptsv2paymentsidrefundsOrderInformationLineItems
```
public Ptsv2paymentsidrefundsOrderInformationLineItems()
```
- Method Detail
  - productCode
```
public Ptsv2paymentsidrefundsOrderInformationLineItems productCode(String productCode)
```
  - getProductCode
```
public String getProductCode()
```
    Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. To use the tax calculation service, use values listed in the Tax Product Code Guide. For information about this document, contact customer support. See \"Product Codes,\" page 14, for more information.
    
    Returns:
    
    productCode
  - setProductCode
```
public void setProductCode(String productCode)
```
  - productName
```
public Ptsv2paymentsidrefundsOrderInformationLineItems productName(String productName)
```
  - getProductName
```
public String getProductName()
```
    For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes.
    
    Returns:
    
    productName
  - setProductName
```
public void setProductName(String productName)
```
  - productSku
```
public Ptsv2paymentsidrefundsOrderInformationLineItems productSku(String productSku)
```
  - getProductSku
```
public String getProductSku()
```
    Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling.
    
    Returns:
    
    productSku
  - setProductSku
```
public void setProductSku(String productSku)
```
  - quantity
```
public Ptsv2paymentsidrefundsOrderInformationLineItems quantity(Integer quantity)
```
  - getQuantity
```
public Integer getQuantity()
```
    Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. minimum: 1 maximum: 999999999
    
    Returns:
    
    quantity
  - setQuantity
```
public void setQuantity(Integer quantity)
```
  - unitPrice
```
public Ptsv2paymentsidrefundsOrderInformationLineItems unitPrice(String unitPrice)
```
  - getUnitPrice
```
public String getUnitPrice()
```
    Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15)
    
    Returns:
    
    unitPrice
  - setUnitPrice
```
public void setUnitPrice(String unitPrice)
```
  - unitOfMeasure
```
public Ptsv2paymentsidrefundsOrderInformationLineItems unitOfMeasure(String unitOfMeasure)
```
  - getUnitOfMeasure
```
public String getUnitOfMeasure()
```
    Unit of measure, or unit of measure code, for the item.
    
    Returns:
    
    unitOfMeasure
  - setUnitOfMeasure
```
public void setUnitOfMeasure(String unitOfMeasure)
```
  - totalAmount
```
public Ptsv2paymentsidrefundsOrderInformationLineItems totalAmount(String totalAmount)
```
  - getTotalAmount
```
public String getTotalAmount()
```
    Total amount for the item. Normally calculated as the unit price times quantity. When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD = 123
    
    Returns:
    
    totalAmount
  - setTotalAmount
```
public void setTotalAmount(String totalAmount)
```
  - taxAmount
```
public Ptsv2paymentsidrefundsOrderInformationLineItems taxAmount(String taxAmount)
```
  - getTaxAmount
```
public String getTaxAmount()
```
    Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. Optional field. #### Airlines processing Tax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s). Format: English characters only. Optional request field for a line item. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Note if you send this field in your tax request, the value in the field will override the tax engine
    
    Returns:
    
    taxAmount
  - setTaxAmount
```
public void setTaxAmount(String taxAmount)
```
  - taxRate
```
public Ptsv2paymentsidrefundsOrderInformationLineItems taxRate(String taxRate)
```
  - getTaxRate
```
public String getTaxRate()
```
    Tax rate applied to the item. For details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) **Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated). **Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).
    
    Returns:
    
    taxRate
  - setTaxRate
```
public void setTaxRate(String taxRate)
```
  - taxAppliedAfterDiscount
```
public Ptsv2paymentsidrefundsOrderInformationLineItems taxAppliedAfterDiscount(String taxAppliedAfterDiscount)
```
  - getTaxAppliedAfterDiscount
```
public String getTaxAppliedAfterDiscount()
```
    Flag to indicate how you handle discount at the line item level. - 0: no line level discount provided - 1: tax was calculated on the post-discount line item total - 2: tax was calculated on the pre-discount line item total `Note` Visa will inset 0 (zero) if an invalid value is included in this field. This field relates to the value in the _lineItems[].discountAmount_ field.
    
    Returns:
    
    taxAppliedAfterDiscount
  - setTaxAppliedAfterDiscount
```
public void setTaxAppliedAfterDiscount(String taxAppliedAfterDiscount)
```
  - taxStatusIndicator
```
public Ptsv2paymentsidrefundsOrderInformationLineItems taxStatusIndicator(String taxStatusIndicator)
```
  - getTaxStatusIndicator
```
public String getTaxStatusIndicator()
```
    Flag to indicate whether tax is exempted or not included. - 0: tax not included - 1: tax included - 2: transaction is not subject to tax
    
    Returns:
    
    taxStatusIndicator
  - setTaxStatusIndicator
```
public void setTaxStatusIndicator(String taxStatusIndicator)
```
  - taxTypeCode
```
public Ptsv2paymentsidrefundsOrderInformationLineItems taxTypeCode(String taxTypeCode)
```
  - getTaxTypeCode
```
public String getTaxTypeCode()
```
    Type of tax being applied to the item. For possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/): #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator`
    
    Returns:
    
    taxTypeCode
  - setTaxTypeCode
```
public void setTaxTypeCode(String taxTypeCode)
```
  - amountIncludesTax
```
public Ptsv2paymentsidrefundsOrderInformationLineItems amountIncludesTax(Boolean amountIncludesTax)
```
  - getAmountIncludesTax
```
public Boolean getAmountIncludesTax()
```
    Flag that indicates whether the tax amount is included in the Line Item Total. Possible values: - **true** - **false**
    
    Returns:
    
    amountIncludesTax
  - setAmountIncludesTax
```
public void setAmountIncludesTax(Boolean amountIncludesTax)
```
  - typeOfSupply
```
public Ptsv2paymentsidrefundsOrderInformationLineItems typeOfSupply(String typeOfSupply)
```
  - getTypeOfSupply
```
public String getTypeOfSupply()
```
    Flag to indicate whether the purchase is categorized as goods or services. Possible values: - 00: goods - 01: services
    
    Returns:
    
    typeOfSupply
  - setTypeOfSupply
```
public void setTypeOfSupply(String typeOfSupply)
```
  - commodityCode
```
public Ptsv2paymentsidrefundsOrderInformationLineItems commodityCode(String commodityCode)
```
  - getCommodityCode
```
public String getCommodityCode()
```
    Commodity code or International description code used to classify the item. Contact your acquirer for a list of codes.
    
    Returns:
    
    commodityCode
  - setCommodityCode
```
public void setCommodityCode(String commodityCode)
```
  - discountAmount
```
public Ptsv2paymentsidrefundsOrderInformationLineItems discountAmount(String discountAmount)
```
  - getDiscountAmount
```
public String getDiscountAmount()
```
    Discount applied to the item.
    
    Returns:
    
    discountAmount
  - setDiscountAmount
```
public void setDiscountAmount(String discountAmount)
```
  - discountApplied
```
public Ptsv2paymentsidrefundsOrderInformationLineItems discountApplied(Boolean discountApplied)
```
  - getDiscountApplied
```
public Boolean getDiscountApplied()
```
    Flag that indicates whether the amount is discounted. If you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets this field to **true**. Possible values: - **true** - **false**
    
    Returns:
    
    discountApplied
  - setDiscountApplied
```
public void setDiscountApplied(Boolean discountApplied)
```
  - discountRate
```
public Ptsv2paymentsidrefundsOrderInformationLineItems discountRate(String discountRate)
```
  - getDiscountRate
```
public String getDiscountRate()
```
    Rate the item is discounted. Maximum of 2 decimal places. Example 5.25 (=5.25%)
    
    Returns:
    
    discountRate
  - setDiscountRate
```
public void setDiscountRate(String discountRate)
```
  - invoiceNumber
```
public Ptsv2paymentsidrefundsOrderInformationLineItems invoiceNumber(String invoiceNumber)
```
  - getInvoiceNumber
```
public String getInvoiceNumber()
```
    Field to support an invoice number for a transaction. You must specify the number of line items that will include an invoice number. By default, the first line item will include an invoice number field. The invoice number field can be included for up to 10 line items.
    
    Returns:
    
    invoiceNumber
  - setInvoiceNumber
```
public void setInvoiceNumber(String invoiceNumber)
```
  - taxDetails
```
public Ptsv2paymentsidrefundsOrderInformationLineItems taxDetails(List<Ptsv2paymentsOrderInformationAmountDetailsTaxDetails> taxDetails)
```
  - addTaxDetailsItem
```
public Ptsv2paymentsidrefundsOrderInformationLineItems addTaxDetailsItem(Ptsv2paymentsOrderInformationAmountDetailsTaxDetails taxDetailsItem)
```
  - getTaxDetails
```
public List<Ptsv2paymentsOrderInformationAmountDetailsTaxDetails> getTaxDetails()
```
    Get taxDetails
    
    Returns:
    
    taxDetails
  - setTaxDetails
```
public void setTaxDetails(List<Ptsv2paymentsOrderInformationAmountDetailsTaxDetails> taxDetails)
```
  - 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 Ptsv2paymentsidrefundsOrderInformationLineItems

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Ptsv2paymentsidrefundsOrderInformationLineItems

Method Detail

productCode

getProductCode

setProductCode

productName

getProductName

setProductName

productSku

getProductSku

setProductSku

quantity

getQuantity

setQuantity

unitPrice

getUnitPrice

setUnitPrice

unitOfMeasure

getUnitOfMeasure

setUnitOfMeasure

totalAmount

getTotalAmount

setTotalAmount

taxAmount

getTaxAmount

setTaxAmount

taxRate

getTaxRate

setTaxRate

taxAppliedAfterDiscount

getTaxAppliedAfterDiscount

setTaxAppliedAfterDiscount

taxStatusIndicator

getTaxStatusIndicator

setTaxStatusIndicator

taxTypeCode

getTaxTypeCode

setTaxTypeCode

amountIncludesTax

getAmountIncludesTax

setAmountIncludesTax

typeOfSupply

getTypeOfSupply

setTypeOfSupply

commodityCode

getCommodityCode

setCommodityCode

discountAmount

getDiscountAmount

setDiscountAmount

discountApplied

getDiscountApplied

setDiscountApplied

discountRate

getDiscountRate

setDiscountRate

invoiceNumber

getInvoiceNumber

setInvoiceNumber

taxDetails

addTaxDetailsItem

getTaxDetails

setTaxDetails

equals

hashCode

toString