Model.Ptsv2paymentsOrderInformationLineItems Maven / Gradle / Ivy
/*
* CyberSource Merged Spec
* All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
*
* OpenAPI spec version: 0.0.1
*
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
package Model;
import java.util.Objects;
import java.util.Arrays;
import Model.Ptsv2paymentsOrderInformationAmountDetailsTaxDetails;
import Model.Ptsv2paymentsOrderInformationPassenger;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
/**
* Ptsv2paymentsOrderInformationLineItems
*/
public class Ptsv2paymentsOrderInformationLineItems {
@SerializedName("productCode")
private String productCode = null;
@SerializedName("productName")
private String productName = null;
@SerializedName("productSku")
private String productSku = null;
@SerializedName("quantity")
private Integer quantity = null;
@SerializedName("unitPrice")
private String unitPrice = null;
@SerializedName("unitOfMeasure")
private String unitOfMeasure = null;
@SerializedName("totalAmount")
private String totalAmount = null;
@SerializedName("taxAmount")
private String taxAmount = null;
@SerializedName("taxRate")
private String taxRate = null;
@SerializedName("taxAppliedAfterDiscount")
private String taxAppliedAfterDiscount = null;
@SerializedName("taxStatusIndicator")
private String taxStatusIndicator = null;
@SerializedName("taxTypeCode")
private String taxTypeCode = null;
@SerializedName("amountIncludesTax")
private Boolean amountIncludesTax = null;
@SerializedName("typeOfSupply")
private String typeOfSupply = null;
@SerializedName("commodityCode")
private String commodityCode = null;
@SerializedName("discountAmount")
private String discountAmount = null;
@SerializedName("discountApplied")
private Boolean discountApplied = null;
@SerializedName("discountRate")
private String discountRate = null;
@SerializedName("invoiceNumber")
private String invoiceNumber = null;
@SerializedName("taxDetails")
private List taxDetails = null;
@SerializedName("fulfillmentType")
private String fulfillmentType = null;
@SerializedName("weight")
private String weight = null;
@SerializedName("weightIdentifier")
private String weightIdentifier = null;
@SerializedName("weightUnit")
private String weightUnit = null;
@SerializedName("referenceDataCode")
private String referenceDataCode = null;
@SerializedName("referenceDataNumber")
private String referenceDataNumber = null;
@SerializedName("unitTaxAmount")
private String unitTaxAmount = null;
@SerializedName("productDescription")
private String productDescription = null;
@SerializedName("giftCardCurrency")
private Integer giftCardCurrency = null;
@SerializedName("shippingDestinationTypes")
private String shippingDestinationTypes = null;
@SerializedName("gift")
private Boolean gift = null;
@SerializedName("passenger")
private Ptsv2paymentsOrderInformationPassenger passenger = null;
@SerializedName("allowedExportCountries")
private List allowedExportCountries = null;
@SerializedName("restrictedExportCountries")
private List restrictedExportCountries = null;
public Ptsv2paymentsOrderInformationLineItems productCode(String productCode) {
this.productCode = productCode;
return this;
}
/**
* 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. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].
* @return productCode
**/
@ApiModelProperty(value = "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. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. ")
public String getProductCode() {
return productCode;
}
public void setProductCode(String productCode) {
this.productCode = productCode;
}
public Ptsv2paymentsOrderInformationLineItems productName(String productName) {
this.productName = productName;
return this;
}
/**
* 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.
* @return productName
**/
@ApiModelProperty(value = "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. ")
public String getProductName() {
return productName;
}
public void setProductName(String productName) {
this.productName = productName;
}
public Ptsv2paymentsOrderInformationLineItems productSku(String productSku) {
this.productSku = productSku;
return this;
}
/**
* 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.
* @return productSku
**/
@ApiModelProperty(value = "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. ")
public String getProductSku() {
return productSku;
}
public void setProductSku(String productSku) {
this.productSku = productSku;
}
public Ptsv2paymentsOrderInformationLineItems quantity(Integer quantity) {
this.quantity = quantity;
return this;
}
/**
* 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
* @return quantity
**/
@ApiModelProperty(value = "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. ")
public Integer getQuantity() {
return quantity;
}
public void setQuantity(Integer quantity) {
this.quantity = quantity;
}
public Ptsv2paymentsOrderInformationLineItems unitPrice(String unitPrice) {
this.unitPrice = unitPrice;
return this;
}
/**
* 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. #### 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)
* @return unitPrice
**/
@ApiModelProperty(value = "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. #### 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) ")
public String getUnitPrice() {
return unitPrice;
}
public void setUnitPrice(String unitPrice) {
this.unitPrice = unitPrice;
}
public Ptsv2paymentsOrderInformationLineItems unitOfMeasure(String unitOfMeasure) {
this.unitOfMeasure = unitOfMeasure;
return this;
}
/**
* Unit of measure, or unit of measure code, for the item.
* @return unitOfMeasure
**/
@ApiModelProperty(value = "Unit of measure, or unit of measure code, for the item. ")
public String getUnitOfMeasure() {
return unitOfMeasure;
}
public void setUnitOfMeasure(String unitOfMeasure) {
this.unitOfMeasure = unitOfMeasure;
}
public Ptsv2paymentsOrderInformationLineItems totalAmount(String totalAmount) {
this.totalAmount = totalAmount;
return this;
}
/**
* 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
* @return totalAmount
**/
@ApiModelProperty(value = "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 ")
public String getTotalAmount() {
return totalAmount;
}
public void setTotalAmount(String totalAmount) {
this.totalAmount = totalAmount;
}
public Ptsv2paymentsOrderInformationLineItems taxAmount(String taxAmount) {
this.taxAmount = taxAmount;
return this;
}
/**
* 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
* @return taxAmount
**/
@ApiModelProperty(value = "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 ")
public String getTaxAmount() {
return taxAmount;
}
public void setTaxAmount(String taxAmount) {
this.taxAmount = taxAmount;
}
public Ptsv2paymentsOrderInformationLineItems taxRate(String taxRate) {
this.taxRate = taxRate;
return this;
}
/**
* Tax rate applied to the item. **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%).
* @return taxRate
**/
@ApiModelProperty(value = "Tax rate applied to the item. **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%). ")
public String getTaxRate() {
return taxRate;
}
public void setTaxRate(String taxRate) {
this.taxRate = taxRate;
}
public Ptsv2paymentsOrderInformationLineItems taxAppliedAfterDiscount(String taxAppliedAfterDiscount) {
this.taxAppliedAfterDiscount = taxAppliedAfterDiscount;
return this;
}
/**
* 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.
* @return taxAppliedAfterDiscount
**/
@ApiModelProperty(value = "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. ")
public String getTaxAppliedAfterDiscount() {
return taxAppliedAfterDiscount;
}
public void setTaxAppliedAfterDiscount(String taxAppliedAfterDiscount) {
this.taxAppliedAfterDiscount = taxAppliedAfterDiscount;
}
public Ptsv2paymentsOrderInformationLineItems taxStatusIndicator(String taxStatusIndicator) {
this.taxStatusIndicator = taxStatusIndicator;
return this;
}
/**
* Flag to indicate whether tax is exempted or not included. - 0: tax not included - 1: tax included - 2: transaction is not subject to tax
* @return taxStatusIndicator
**/
@ApiModelProperty(value = "Flag to indicate whether tax is exempted or not included. - 0: tax not included - 1: tax included - 2: transaction is not subject to tax ")
public String getTaxStatusIndicator() {
return taxStatusIndicator;
}
public void setTaxStatusIndicator(String taxStatusIndicator) {
this.taxStatusIndicator = taxStatusIndicator;
}
public Ptsv2paymentsOrderInformationLineItems taxTypeCode(String taxTypeCode) {
this.taxTypeCode = taxTypeCode;
return this;
}
/**
* Type of tax being applied to the item. #### 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`
* @return taxTypeCode
**/
@ApiModelProperty(value = "Type of tax being applied to the item. #### 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` ")
public String getTaxTypeCode() {
return taxTypeCode;
}
public void setTaxTypeCode(String taxTypeCode) {
this.taxTypeCode = taxTypeCode;
}
public Ptsv2paymentsOrderInformationLineItems amountIncludesTax(Boolean amountIncludesTax) {
this.amountIncludesTax = amountIncludesTax;
return this;
}
/**
* Flag that indicates whether the tax amount is included in the Line Item Total. Possible values: - **true** - **false**
* @return amountIncludesTax
**/
@ApiModelProperty(value = "Flag that indicates whether the tax amount is included in the Line Item Total. Possible values: - **true** - **false** ")
public Boolean isAmountIncludesTax() {
return amountIncludesTax;
}
public void setAmountIncludesTax(Boolean amountIncludesTax) {
this.amountIncludesTax = amountIncludesTax;
}
public Ptsv2paymentsOrderInformationLineItems typeOfSupply(String typeOfSupply) {
this.typeOfSupply = typeOfSupply;
return this;
}
/**
* Flag to indicate whether the purchase is categorized as goods or services. Possible values: - 00: goods - 01: services
* @return typeOfSupply
**/
@ApiModelProperty(value = "Flag to indicate whether the purchase is categorized as goods or services. Possible values: - 00: goods - 01: services ")
public String getTypeOfSupply() {
return typeOfSupply;
}
public void setTypeOfSupply(String typeOfSupply) {
this.typeOfSupply = typeOfSupply;
}
public Ptsv2paymentsOrderInformationLineItems commodityCode(String commodityCode) {
this.commodityCode = commodityCode;
return this;
}
/**
* Commodity code or International description code used to classify the item. Contact your acquirer for a list of codes.
* @return commodityCode
**/
@ApiModelProperty(value = "Commodity code or International description code used to classify the item. Contact your acquirer for a list of codes. ")
public String getCommodityCode() {
return commodityCode;
}
public void setCommodityCode(String commodityCode) {
this.commodityCode = commodityCode;
}
public Ptsv2paymentsOrderInformationLineItems discountAmount(String discountAmount) {
this.discountAmount = discountAmount;
return this;
}
/**
* Discount applied to the item.
* @return discountAmount
**/
@ApiModelProperty(value = "Discount applied to the item.")
public String getDiscountAmount() {
return discountAmount;
}
public void setDiscountAmount(String discountAmount) {
this.discountAmount = discountAmount;
}
public Ptsv2paymentsOrderInformationLineItems discountApplied(Boolean discountApplied) {
this.discountApplied = discountApplied;
return this;
}
/**
* 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**
* @return discountApplied
**/
@ApiModelProperty(value = "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** ")
public Boolean isDiscountApplied() {
return discountApplied;
}
public void setDiscountApplied(Boolean discountApplied) {
this.discountApplied = discountApplied;
}
public Ptsv2paymentsOrderInformationLineItems discountRate(String discountRate) {
this.discountRate = discountRate;
return this;
}
/**
* Rate the item is discounted. Maximum of 2 decimal places. Example 5.25 (=5.25%)
* @return discountRate
**/
@ApiModelProperty(value = "Rate the item is discounted. Maximum of 2 decimal places. Example 5.25 (=5.25%) ")
public String getDiscountRate() {
return discountRate;
}
public void setDiscountRate(String discountRate) {
this.discountRate = discountRate;
}
public Ptsv2paymentsOrderInformationLineItems invoiceNumber(String invoiceNumber) {
this.invoiceNumber = invoiceNumber;
return this;
}
/**
* 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.
* @return invoiceNumber
**/
@ApiModelProperty(value = "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. ")
public String getInvoiceNumber() {
return invoiceNumber;
}
public void setInvoiceNumber(String invoiceNumber) {
this.invoiceNumber = invoiceNumber;
}
public Ptsv2paymentsOrderInformationLineItems taxDetails(List taxDetails) {
this.taxDetails = taxDetails;
return this;
}
public Ptsv2paymentsOrderInformationLineItems addTaxDetailsItem(Ptsv2paymentsOrderInformationAmountDetailsTaxDetails taxDetailsItem) {
if (this.taxDetails == null) {
this.taxDetails = new ArrayList();
}
this.taxDetails.add(taxDetailsItem);
return this;
}
/**
* Get taxDetails
* @return taxDetails
**/
@ApiModelProperty(value = "")
public List getTaxDetails() {
return taxDetails;
}
public void setTaxDetails(List taxDetails) {
this.taxDetails = taxDetails;
}
public Ptsv2paymentsOrderInformationLineItems fulfillmentType(String fulfillmentType) {
this.fulfillmentType = fulfillmentType;
return this;
}
/**
* Information about the product code used for the line item. Possible values: - `E`: The product code is `electronic_software`. - `P`: The product code is not `electronic_software`. For details, see the `fulfillmentType` field description in [Business Center Reporting User Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/reporting_and_reconciliation/Reporting_User/html/)
* @return fulfillmentType
**/
@ApiModelProperty(value = "Information about the product code used for the line item. Possible values: - `E`: The product code is `electronic_software`. - `P`: The product code is not `electronic_software`. For details, see the `fulfillmentType` field description in [Business Center Reporting User Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/reporting_and_reconciliation/Reporting_User/html/) ")
public String getFulfillmentType() {
return fulfillmentType;
}
public void setFulfillmentType(String fulfillmentType) {
this.fulfillmentType = fulfillmentType;
}
public Ptsv2paymentsOrderInformationLineItems weight(String weight) {
this.weight = weight;
return this;
}
/**
* Weight of the item.
* @return weight
**/
@ApiModelProperty(value = "Weight of the item. ")
public String getWeight() {
return weight;
}
public void setWeight(String weight) {
this.weight = weight;
}
public Ptsv2paymentsOrderInformationLineItems weightIdentifier(String weightIdentifier) {
this.weightIdentifier = weightIdentifier;
return this;
}
/**
* Type of weight. Possible values: - B: Billed weight - N: Actual net weight
* @return weightIdentifier
**/
@ApiModelProperty(value = "Type of weight. Possible values: - B: Billed weight - N: Actual net weight ")
public String getWeightIdentifier() {
return weightIdentifier;
}
public void setWeightIdentifier(String weightIdentifier) {
this.weightIdentifier = weightIdentifier;
}
public Ptsv2paymentsOrderInformationLineItems weightUnit(String weightUnit) {
this.weightUnit = weightUnit;
return this;
}
/**
* Code that specifies the unit of measurement for the weight amount. For example, `OZ` specifies ounce and `LB` specifies pound. The possible values are defined by the ANSI Accredited Standards Committee (ASC).
* @return weightUnit
**/
@ApiModelProperty(value = "Code that specifies the unit of measurement for the weight amount. For example, `OZ` specifies ounce and `LB` specifies pound. The possible values are defined by the ANSI Accredited Standards Committee (ASC). ")
public String getWeightUnit() {
return weightUnit;
}
public void setWeightUnit(String weightUnit) {
this.weightUnit = weightUnit;
}
public Ptsv2paymentsOrderInformationLineItems referenceDataCode(String referenceDataCode) {
this.referenceDataCode = referenceDataCode;
return this;
}
/**
* Code that identifies the value of the corresponding `orderInformation.lineItems[].referenceDataNumber` field. Possible values: - AN: Client-defined asset code - MG: Manufacturer's part number - PO: Purchase order number - SK: Supplier stock keeping unit number - UP: Universal product code - VC: Supplier catalog number - VP: Vendor part number This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor.
* @return referenceDataCode
**/
@ApiModelProperty(value = "Code that identifies the value of the corresponding `orderInformation.lineItems[].referenceDataNumber` field. Possible values: - AN: Client-defined asset code - MG: Manufacturer's part number - PO: Purchase order number - SK: Supplier stock keeping unit number - UP: Universal product code - VC: Supplier catalog number - VP: Vendor part number This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. ")
public String getReferenceDataCode() {
return referenceDataCode;
}
public void setReferenceDataCode(String referenceDataCode) {
this.referenceDataCode = referenceDataCode;
}
public Ptsv2paymentsOrderInformationLineItems referenceDataNumber(String referenceDataNumber) {
this.referenceDataNumber = referenceDataNumber;
return this;
}
/**
* Reference number. The meaning of this value is identified by the value of the corresponding `referenceDataCode` field. See Numbered Elements. The maximum length for this field depends on the value of the corresponding `referenceDataCode` field: - When the code is `PO`, the maximum length for the reference number is 22. - When the code is `VC`, the maximum length for the reference number is 20. - For all other codes, the maximum length for the reference number is 30. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor.
* @return referenceDataNumber
**/
@ApiModelProperty(value = "Reference number. The meaning of this value is identified by the value of the corresponding `referenceDataCode` field. See Numbered Elements. The maximum length for this field depends on the value of the corresponding `referenceDataCode` field: - When the code is `PO`, the maximum length for the reference number is 22. - When the code is `VC`, the maximum length for the reference number is 20. - For all other codes, the maximum length for the reference number is 30. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. ")
public String getReferenceDataNumber() {
return referenceDataNumber;
}
public void setReferenceDataNumber(String referenceDataNumber) {
this.referenceDataNumber = referenceDataNumber;
}
public Ptsv2paymentsOrderInformationLineItems unitTaxAmount(String unitTaxAmount) {
this.unitTaxAmount = unitTaxAmount;
return this;
}
/**
* Per-item tax amount of the product. Note The amount value must be a non-negative number containing 2 decimal places and limited to 7 digits before the decimal point.
* @return unitTaxAmount
**/
@ApiModelProperty(value = "Per-item tax amount of the product. Note The amount value must be a non-negative number containing 2 decimal places and limited to 7 digits before the decimal point. ")
public String getUnitTaxAmount() {
return unitTaxAmount;
}
public void setUnitTaxAmount(String unitTaxAmount) {
this.unitTaxAmount = unitTaxAmount;
}
public Ptsv2paymentsOrderInformationLineItems productDescription(String productDescription) {
this.productDescription = productDescription;
return this;
}
/**
* Brief description of item.
* @return productDescription
**/
@ApiModelProperty(value = "Brief description of item.")
public String getProductDescription() {
return productDescription;
}
public void setProductDescription(String productDescription) {
this.productDescription = productDescription;
}
public Ptsv2paymentsOrderInformationLineItems giftCardCurrency(Integer giftCardCurrency) {
this.giftCardCurrency = giftCardCurrency;
return this;
}
/**
* When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)
* @return giftCardCurrency
**/
@ApiModelProperty(value = "When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) ")
public Integer getGiftCardCurrency() {
return giftCardCurrency;
}
public void setGiftCardCurrency(Integer giftCardCurrency) {
this.giftCardCurrency = giftCardCurrency;
}
public Ptsv2paymentsOrderInformationLineItems shippingDestinationTypes(String shippingDestinationTypes) {
this.shippingDestinationTypes = shippingDestinationTypes;
return this;
}
/**
* Destination to where the item will be shipped. Example: Commercial, Residential, Store
* @return shippingDestinationTypes
**/
@ApiModelProperty(value = "Destination to where the item will be shipped. Example: Commercial, Residential, Store ")
public String getShippingDestinationTypes() {
return shippingDestinationTypes;
}
public void setShippingDestinationTypes(String shippingDestinationTypes) {
this.shippingDestinationTypes = shippingDestinationTypes;
}
public Ptsv2paymentsOrderInformationLineItems gift(Boolean gift) {
this.gift = gift;
return this;
}
/**
* This field is only used in DM service. Determines whether to assign risk to the order if the billing and shipping addresses specify different cities, states, or countries. This field can contain one of the following values: - true: Orders are assigned only slight additional risk if billing and shipping addresses are different. - false: Orders are assigned higher additional risk if billing and shipping addresses are different.
* @return gift
**/
@ApiModelProperty(value = "This field is only used in DM service. Determines whether to assign risk to the order if the billing and shipping addresses specify different cities, states, or countries. This field can contain one of the following values: - true: Orders are assigned only slight additional risk if billing and shipping addresses are different. - false: Orders are assigned higher additional risk if billing and shipping addresses are different. ")
public Boolean isGift() {
return gift;
}
public void setGift(Boolean gift) {
this.gift = gift;
}
public Ptsv2paymentsOrderInformationLineItems passenger(Ptsv2paymentsOrderInformationPassenger passenger) {
this.passenger = passenger;
return this;
}
/**
* Get passenger
* @return passenger
**/
@ApiModelProperty(value = "")
public Ptsv2paymentsOrderInformationPassenger getPassenger() {
return passenger;
}
public void setPassenger(Ptsv2paymentsOrderInformationPassenger passenger) {
this.passenger = passenger;
}
public Ptsv2paymentsOrderInformationLineItems allowedExportCountries(List allowedExportCountries) {
this.allowedExportCountries = allowedExportCountries;
return this;
}
public Ptsv2paymentsOrderInformationLineItems addAllowedExportCountriesItem(String allowedExportCountriesItem) {
if (this.allowedExportCountries == null) {
this.allowedExportCountries = new ArrayList();
}
this.allowedExportCountries.add(allowedExportCountriesItem);
return this;
}
/**
* Get allowedExportCountries
* @return allowedExportCountries
**/
@ApiModelProperty(value = "")
public List getAllowedExportCountries() {
return allowedExportCountries;
}
public void setAllowedExportCountries(List allowedExportCountries) {
this.allowedExportCountries = allowedExportCountries;
}
public Ptsv2paymentsOrderInformationLineItems restrictedExportCountries(List restrictedExportCountries) {
this.restrictedExportCountries = restrictedExportCountries;
return this;
}
public Ptsv2paymentsOrderInformationLineItems addRestrictedExportCountriesItem(String restrictedExportCountriesItem) {
if (this.restrictedExportCountries == null) {
this.restrictedExportCountries = new ArrayList();
}
this.restrictedExportCountries.add(restrictedExportCountriesItem);
return this;
}
/**
* Get restrictedExportCountries
* @return restrictedExportCountries
**/
@ApiModelProperty(value = "")
public List getRestrictedExportCountries() {
return restrictedExportCountries;
}
public void setRestrictedExportCountries(List restrictedExportCountries) {
this.restrictedExportCountries = restrictedExportCountries;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Ptsv2paymentsOrderInformationLineItems ptsv2paymentsOrderInformationLineItems = (Ptsv2paymentsOrderInformationLineItems) o;
return Objects.equals(this.productCode, ptsv2paymentsOrderInformationLineItems.productCode) &&
Objects.equals(this.productName, ptsv2paymentsOrderInformationLineItems.productName) &&
Objects.equals(this.productSku, ptsv2paymentsOrderInformationLineItems.productSku) &&
Objects.equals(this.quantity, ptsv2paymentsOrderInformationLineItems.quantity) &&
Objects.equals(this.unitPrice, ptsv2paymentsOrderInformationLineItems.unitPrice) &&
Objects.equals(this.unitOfMeasure, ptsv2paymentsOrderInformationLineItems.unitOfMeasure) &&
Objects.equals(this.totalAmount, ptsv2paymentsOrderInformationLineItems.totalAmount) &&
Objects.equals(this.taxAmount, ptsv2paymentsOrderInformationLineItems.taxAmount) &&
Objects.equals(this.taxRate, ptsv2paymentsOrderInformationLineItems.taxRate) &&
Objects.equals(this.taxAppliedAfterDiscount, ptsv2paymentsOrderInformationLineItems.taxAppliedAfterDiscount) &&
Objects.equals(this.taxStatusIndicator, ptsv2paymentsOrderInformationLineItems.taxStatusIndicator) &&
Objects.equals(this.taxTypeCode, ptsv2paymentsOrderInformationLineItems.taxTypeCode) &&
Objects.equals(this.amountIncludesTax, ptsv2paymentsOrderInformationLineItems.amountIncludesTax) &&
Objects.equals(this.typeOfSupply, ptsv2paymentsOrderInformationLineItems.typeOfSupply) &&
Objects.equals(this.commodityCode, ptsv2paymentsOrderInformationLineItems.commodityCode) &&
Objects.equals(this.discountAmount, ptsv2paymentsOrderInformationLineItems.discountAmount) &&
Objects.equals(this.discountApplied, ptsv2paymentsOrderInformationLineItems.discountApplied) &&
Objects.equals(this.discountRate, ptsv2paymentsOrderInformationLineItems.discountRate) &&
Objects.equals(this.invoiceNumber, ptsv2paymentsOrderInformationLineItems.invoiceNumber) &&
Objects.equals(this.taxDetails, ptsv2paymentsOrderInformationLineItems.taxDetails) &&
Objects.equals(this.fulfillmentType, ptsv2paymentsOrderInformationLineItems.fulfillmentType) &&
Objects.equals(this.weight, ptsv2paymentsOrderInformationLineItems.weight) &&
Objects.equals(this.weightIdentifier, ptsv2paymentsOrderInformationLineItems.weightIdentifier) &&
Objects.equals(this.weightUnit, ptsv2paymentsOrderInformationLineItems.weightUnit) &&
Objects.equals(this.referenceDataCode, ptsv2paymentsOrderInformationLineItems.referenceDataCode) &&
Objects.equals(this.referenceDataNumber, ptsv2paymentsOrderInformationLineItems.referenceDataNumber) &&
Objects.equals(this.unitTaxAmount, ptsv2paymentsOrderInformationLineItems.unitTaxAmount) &&
Objects.equals(this.productDescription, ptsv2paymentsOrderInformationLineItems.productDescription) &&
Objects.equals(this.giftCardCurrency, ptsv2paymentsOrderInformationLineItems.giftCardCurrency) &&
Objects.equals(this.shippingDestinationTypes, ptsv2paymentsOrderInformationLineItems.shippingDestinationTypes) &&
Objects.equals(this.gift, ptsv2paymentsOrderInformationLineItems.gift) &&
Objects.equals(this.passenger, ptsv2paymentsOrderInformationLineItems.passenger) &&
Objects.equals(this.allowedExportCountries, ptsv2paymentsOrderInformationLineItems.allowedExportCountries) &&
Objects.equals(this.restrictedExportCountries, ptsv2paymentsOrderInformationLineItems.restrictedExportCountries);
}
@Override
public int hashCode() {
return Objects.hash(productCode, productName, productSku, quantity, unitPrice, unitOfMeasure, totalAmount, taxAmount, taxRate, taxAppliedAfterDiscount, taxStatusIndicator, taxTypeCode, amountIncludesTax, typeOfSupply, commodityCode, discountAmount, discountApplied, discountRate, invoiceNumber, taxDetails, fulfillmentType, weight, weightIdentifier, weightUnit, referenceDataCode, referenceDataNumber, unitTaxAmount, productDescription, giftCardCurrency, shippingDestinationTypes, gift, passenger, allowedExportCountries, restrictedExportCountries);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Ptsv2paymentsOrderInformationLineItems {\n");
sb.append(" productCode: ").append(toIndentedString(productCode)).append("\n");
sb.append(" productName: ").append(toIndentedString(productName)).append("\n");
sb.append(" productSku: ").append(toIndentedString(productSku)).append("\n");
sb.append(" quantity: ").append(toIndentedString(quantity)).append("\n");
sb.append(" unitPrice: ").append(toIndentedString(unitPrice)).append("\n");
sb.append(" unitOfMeasure: ").append(toIndentedString(unitOfMeasure)).append("\n");
sb.append(" totalAmount: ").append(toIndentedString(totalAmount)).append("\n");
sb.append(" taxAmount: ").append(toIndentedString(taxAmount)).append("\n");
sb.append(" taxRate: ").append(toIndentedString(taxRate)).append("\n");
sb.append(" taxAppliedAfterDiscount: ").append(toIndentedString(taxAppliedAfterDiscount)).append("\n");
sb.append(" taxStatusIndicator: ").append(toIndentedString(taxStatusIndicator)).append("\n");
sb.append(" taxTypeCode: ").append(toIndentedString(taxTypeCode)).append("\n");
sb.append(" amountIncludesTax: ").append(toIndentedString(amountIncludesTax)).append("\n");
sb.append(" typeOfSupply: ").append(toIndentedString(typeOfSupply)).append("\n");
sb.append(" commodityCode: ").append(toIndentedString(commodityCode)).append("\n");
sb.append(" discountAmount: ").append(toIndentedString(discountAmount)).append("\n");
sb.append(" discountApplied: ").append(toIndentedString(discountApplied)).append("\n");
sb.append(" discountRate: ").append(toIndentedString(discountRate)).append("\n");
sb.append(" invoiceNumber: ").append(toIndentedString(invoiceNumber)).append("\n");
sb.append(" taxDetails: ").append(toIndentedString(taxDetails)).append("\n");
sb.append(" fulfillmentType: ").append(toIndentedString(fulfillmentType)).append("\n");
sb.append(" weight: ").append(toIndentedString(weight)).append("\n");
sb.append(" weightIdentifier: ").append(toIndentedString(weightIdentifier)).append("\n");
sb.append(" weightUnit: ").append(toIndentedString(weightUnit)).append("\n");
sb.append(" referenceDataCode: ").append(toIndentedString(referenceDataCode)).append("\n");
sb.append(" referenceDataNumber: ").append(toIndentedString(referenceDataNumber)).append("\n");
sb.append(" unitTaxAmount: ").append(toIndentedString(unitTaxAmount)).append("\n");
sb.append(" productDescription: ").append(toIndentedString(productDescription)).append("\n");
sb.append(" giftCardCurrency: ").append(toIndentedString(giftCardCurrency)).append("\n");
sb.append(" shippingDestinationTypes: ").append(toIndentedString(shippingDestinationTypes)).append("\n");
sb.append(" gift: ").append(toIndentedString(gift)).append("\n");
sb.append(" passenger: ").append(toIndentedString(passenger)).append("\n");
sb.append(" allowedExportCountries: ").append(toIndentedString(allowedExportCountries)).append("\n");
sb.append(" restrictedExportCountries: ").append(toIndentedString(restrictedExportCountries)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(java.lang.Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy