class CyberSource::Ptsv2paymentsOrderInformationAmountDetailsTaxDetails

Attributes

amount[RW]

Indicates the amount of tax based on the `type` field as described in the table below: | type | type description | | ————- |:————-:| | `alternate` | Total amount of alternate tax for the order. | | `local` | Sales tax for the order. | | `national` | National tax for the order. | | `vat` | Total amount of value added tax (VAT) included in the order. | | `other` | Other tax. |

applied[RW]

Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is included in the request. Possible values: - `false`: alternate tax amount is not included in the request. - `true`: alternate tax amount is included in the request. For processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)

code[RW]

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

exemption_code[RW]

Status code for exemption from sales and use tax. 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. For possible values and important information for using this field, see _Appendix B, "Exemption Status Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)

rate[RW]

Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) For processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)

tax_id[RW]

Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value, including zero. You may send this field without sending alternate tax amount. For processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)

type[RW]

Indicates the type of tax data for the taxDetails object. Possible values: - `alternate` - `local` - `national` - `vat` - `other` For processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)

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/ptsv2payments_order_information_amount_details_tax_details.rb, line 39
def self.attribute_map
  {
    :'type' => :'type',
    :'amount' => :'amount',
    :'rate' => :'rate',
    :'code' => :'code',
    :'tax_id' => :'taxId',
    :'applied' => :'applied',
    :'exemption_code' => :'exemptionCode'
  }
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/ptsv2payments_order_information_amount_details_tax_details.rb, line 66
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?(:'type')
    self.type = attributes[:'type']
  end

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

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

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

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

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

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

Attribute type mapping.

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb, line 52
def self.swagger_types
  {
    :'type' => :'String',
    :'amount' => :'String',
    :'rate' => :'String',
    :'code' => :'String',
    :'tax_id' => :'String',
    :'applied' => :'BOOLEAN',
    :'exemption_code' => :'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/ptsv2payments_order_information_amount_details_tax_details.rb, line 146
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      amount == o.amount &&
      rate == o.rate &&
      code == o.code &&
      tax_id == o.tax_id &&
      applied == o.applied &&
      exemption_code == o.exemption_code
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/ptsv2payments_order_information_amount_details_tax_details.rb, line 194
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/ptsv2payments_order_information_amount_details_tax_details.rb, line 260
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
amount=(amount) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb, line 116
def amount=(amount)
  @amount = amount
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/ptsv2payments_order_information_amount_details_tax_details.rb, line 173
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
code=(code) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb, line 128
def code=(code)
  @code = code
end
eql?(o) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb, line 160
def eql?(o)
  self == o
end
exemption_code=(exemption_code) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb, line 140
def exemption_code=(exemption_code)
  @exemption_code = exemption_code
end
hash() click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb, line 166
def hash
  [type, amount, rate, code, tax_id, applied, exemption_code].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/ptsv2payments_order_information_amount_details_tax_details.rb, line 103
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
rate=(rate) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb, line 122
def rate=(rate)
  @rate = rate
end
tax_id=(tax_id) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb, line 134
def tax_id=(tax_id)
  @tax_id = tax_id
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/ptsv2payments_order_information_amount_details_tax_details.rb, line 240
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/ptsv2payments_order_information_amount_details_tax_details.rb, line 246
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/ptsv2payments_order_information_amount_details_tax_details.rb, line 234
def to_s
  to_hash.to_s
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/ptsv2payments_order_information_amount_details_tax_details.rb, line 110
def valid?
  true
end