class CyberSource::Vasv2taxOrderInformationLineItems

Attributes

buyer_vat_registration_number[RW]

Buyer’s VAT registration number. NOTE If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for international and value added taxes only. Not applicable to U.S. and Canadian taxes.

order_acceptance[RW]
order_origin[RW]
product_code[RW]

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](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.

product_name[RW]

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.

product_sku[RW]

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.

quantity[RW]

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.

seller_vat_registration_number[RW]

VAT seller registration number. For details, see "International Taxes and Value-Added Tax (VAT)" in [Tax Calculation Service Using the SCMP API](apps.cybersource.com/library/documentation/dev_guides/Tax_SCMP_API/html/). NOTE If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for international and value added taxes only. Not applicable to U.S. and Canadian taxes.

ship_from_administrative_area[RW]

State from which the order is shipped. This field is used only when `orderInformation.shippingDetails.shipFromLocality` and `orderInformation.shippingDetails.shipFromCountry` are present. Use the [State, Province, and Territory Codes for the United States and Canada](apps.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). NOTE If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes.

ship_from_country[RW]

Country from which the order is shipped. This field is used only when `orderInformation.shippingDetails.shipFromLocality` and `orderInformation.shippingDetails.shipFromAdministrativeArea` are present. Use the [ISO Standard Country Codes](apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). NOTE If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/ or rates applied to the transaction based on sourcing. Optional for U.S., Canadian, international tax, and value added taxes.

ship_from_locality[RW]

City where the product is shipped from. This field is used only when the `orderInformation.shipTo.administrativeArea` and `orderInformation.shipTo.country` fields are present. NOTE If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes.

ship_from_postal_code[RW]

Postal code where the product is shipped from. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes.

tax_amount[RW]

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

unit_price[RW]

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.] (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)

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 58
def self.attribute_map
  {
    :'product_sku' => :'productSKU',
    :'product_code' => :'productCode',
    :'quantity' => :'quantity',
    :'product_name' => :'productName',
    :'unit_price' => :'unitPrice',
    :'tax_amount' => :'taxAmount',
    :'order_acceptance' => :'orderAcceptance',
    :'order_origin' => :'orderOrigin',
    :'ship_from_country' => :'shipFromCountry',
    :'ship_from_administrative_area' => :'shipFromAdministrativeArea',
    :'ship_from_locality' => :'shipFromLocality',
    :'ship_from_postal_code' => :'shipFromPostalCode',
    :'buyer_vat_registration_number' => :'buyerVatRegistrationNumber',
    :'seller_vat_registration_number' => :'sellerVatRegistrationNumber'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 99
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'productSKU')
    self.product_sku = attributes[:'productSKU']
  end

  if attributes.has_key?(:'productCode')
    self.product_code = attributes[:'productCode']
  end

  if attributes.has_key?(:'quantity')
    self.quantity = attributes[:'quantity']
  end

  if attributes.has_key?(:'productName')
    self.product_name = attributes[:'productName']
  end

  if attributes.has_key?(:'unitPrice')
    self.unit_price = attributes[:'unitPrice']
  end

  if attributes.has_key?(:'taxAmount')
    self.tax_amount = attributes[:'taxAmount']
  end

  if attributes.has_key?(:'orderAcceptance')
    self.order_acceptance = attributes[:'orderAcceptance']
  end

  if attributes.has_key?(:'orderOrigin')
    self.order_origin = attributes[:'orderOrigin']
  end

  if attributes.has_key?(:'shipFromCountry')
    self.ship_from_country = attributes[:'shipFromCountry']
  end

  if attributes.has_key?(:'shipFromAdministrativeArea')
    self.ship_from_administrative_area = attributes[:'shipFromAdministrativeArea']
  end

  if attributes.has_key?(:'shipFromLocality')
    self.ship_from_locality = attributes[:'shipFromLocality']
  end

  if attributes.has_key?(:'shipFromPostalCode')
    self.ship_from_postal_code = attributes[:'shipFromPostalCode']
  end

  if attributes.has_key?(:'buyerVatRegistrationNumber')
    self.buyer_vat_registration_number = attributes[:'buyerVatRegistrationNumber']
  end

  if attributes.has_key?(:'sellerVatRegistrationNumber')
    self.seller_vat_registration_number = attributes[:'sellerVatRegistrationNumber']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 78
def self.swagger_types
  {
    :'product_sku' => :'String',
    :'product_code' => :'String',
    :'quantity' => :'Integer',
    :'product_name' => :'String',
    :'unit_price' => :'String',
    :'tax_amount' => :'String',
    :'order_acceptance' => :'Vasv2taxOrderInformationOrderAcceptance',
    :'order_origin' => :'Vasv2taxOrderInformationOrderOrigin',
    :'ship_from_country' => :'String',
    :'ship_from_administrative_area' => :'String',
    :'ship_from_locality' => :'String',
    :'ship_from_postal_code' => :'String',
    :'buyer_vat_registration_number' => :'String',
    :'seller_vat_registration_number' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 267
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      product_sku == o.product_sku &&
      product_code == o.product_code &&
      quantity == o.quantity &&
      product_name == o.product_name &&
      unit_price == o.unit_price &&
      tax_amount == o.tax_amount &&
      order_acceptance == o.order_acceptance &&
      order_origin == o.order_origin &&
      ship_from_country == o.ship_from_country &&
      ship_from_administrative_area == o.ship_from_administrative_area &&
      ship_from_locality == o.ship_from_locality &&
      ship_from_postal_code == o.ship_from_postal_code &&
      buyer_vat_registration_number == o.buyer_vat_registration_number &&
      seller_vat_registration_number == o.seller_vat_registration_number
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 322
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = CyberSource.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 388
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 301
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
buyer_vat_registration_number=(buyer_vat_registration_number) click to toggle source

Custom attribute writer method with validation @param [Object] buyer_vat_registration_number Value to be assigned

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 255
def buyer_vat_registration_number=(buyer_vat_registration_number)
  @buyer_vat_registration_number = buyer_vat_registration_number
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 288
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 294
def hash
  [product_sku, product_code, quantity, product_name, unit_price, tax_amount, order_acceptance, order_origin, ship_from_country, ship_from_administrative_area, ship_from_locality, ship_from_postal_code, buyer_vat_registration_number, seller_vat_registration_number].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 164
def list_invalid_properties
  invalid_properties = Array.new
  if !@quantity.nil? && @quantity > 999999999
    invalid_properties.push('invalid value for "quantity", must be smaller than or equal to 999999999.')
  end

  if !@quantity.nil? && @quantity < 1
    invalid_properties.push('invalid value for "quantity", must be greater than or equal to 1.')
  end

  invalid_properties
end
product_code=(product_code) click to toggle source

Custom attribute writer method with validation @param [Object] product_code Value to be assigned

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 193
def product_code=(product_code)
  @product_code = product_code
end
product_name=(product_name) click to toggle source

Custom attribute writer method with validation @param [Object] product_name Value to be assigned

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 213
def product_name=(product_name)
  @product_name = product_name
end
product_sku=(product_sku) click to toggle source

Custom attribute writer method with validation @param [Object] product_sku Value to be assigned

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 187
def product_sku=(product_sku)
  @product_sku = product_sku
end
quantity=(quantity) click to toggle source

Custom attribute writer method with validation @param [Object] quantity Value to be assigned

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 199
def quantity=(quantity)
  if !quantity.nil? && quantity > 999999999
    fail ArgumentError, 'invalid value for "quantity", must be smaller than or equal to 999999999.'
  end

  if !quantity.nil? && quantity < 1
    fail ArgumentError, 'invalid value for "quantity", must be greater than or equal to 1.'
  end

  @quantity = quantity
end
seller_vat_registration_number=(seller_vat_registration_number) click to toggle source

Custom attribute writer method with validation @param [Object] seller_vat_registration_number Value to be assigned

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 261
def seller_vat_registration_number=(seller_vat_registration_number)
  @seller_vat_registration_number = seller_vat_registration_number
end
ship_from_administrative_area=(ship_from_administrative_area) click to toggle source

Custom attribute writer method with validation @param [Object] ship_from_administrative_area Value to be assigned

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 237
def ship_from_administrative_area=(ship_from_administrative_area)
  @ship_from_administrative_area = ship_from_administrative_area
end
ship_from_country=(ship_from_country) click to toggle source

Custom attribute writer method with validation @param [Object] ship_from_country Value to be assigned

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 231
def ship_from_country=(ship_from_country)
  @ship_from_country = ship_from_country
end
ship_from_locality=(ship_from_locality) click to toggle source

Custom attribute writer method with validation @param [Object] ship_from_locality Value to be assigned

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 243
def ship_from_locality=(ship_from_locality)
  @ship_from_locality = ship_from_locality
end
ship_from_postal_code=(ship_from_postal_code) click to toggle source

Custom attribute writer method with validation @param [Object] ship_from_postal_code Value to be assigned

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 249
def ship_from_postal_code=(ship_from_postal_code)
  @ship_from_postal_code = ship_from_postal_code
end
tax_amount=(tax_amount) click to toggle source

Custom attribute writer method with validation @param [Object] tax_amount Value to be assigned

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 225
def tax_amount=(tax_amount)
  @tax_amount = tax_amount
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 368
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 374
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 362
def to_s
  to_hash.to_s
end
unit_price=(unit_price) click to toggle source

Custom attribute writer method with validation @param [Object] unit_price Value to be assigned

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 219
def unit_price=(unit_price)
  @unit_price = unit_price
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb, line 179
def valid?
  return false if !@quantity.nil? && @quantity > 999999999
  return false if !@quantity.nil? && @quantity < 1
  true
end