class CyberSource::Vasv2taxTaxInformation

Attributes

commit_indicator[RW]

Indicates whether this is a committed tax transaction. For a committed tax transaction, the status in the Tax Detail Report is “Committed.” For an uncommitted tax transaction, the status in the Tax Detail Report is “Uncommitted.” Possible values: - `true`: This is a committed tax transaction. - `false` (default): This is not a committed tax transaction. A committed tax request is a tax service request that sets the status field in the Tax Detail Report to committed. The committed status indicates that the amount calculated by the tax service is included in the amount of a capture or credit. Use a void service request to cancels a committed tax request or a committed refund tax request. The void transaction is included as a separate entry in the Tax Detail Report. The value of the status field is cancelled. The value of the link ID is the request ID of the committed tax request or refund tax request that was voided. You can use the value of the link ID to reconcile your orders. Optional for U.S., Canadian, international tax, and value added taxes.

date_override_reason[RW]

If a past or future date is specified in `orderInformation.invoiceDetails.invoiceDate`, then provide the reason for that for audit purposes. Typical reasons include: 'Return', 'Layaway', 'Imported'. Optional for U.S., Canadian, international tax, and value added taxes.

nexus[RW]

Comma-separated list of states or provinces in which merchandise is taxable. Note merchandise may be still be non-taxable or tax exempt depending on the product taxability. Indicate the type of product you are selling in the product code field for product-level taxability rules to be applied. Do not use both the `taxInformation.nexus` and `taxInformation.noNexus` fields in your request. If you do not include this field in a tax calculation service request, the tax system makes its calculations as if you have nexus in every US state or Canadian province. Use the [State, Province, and Territory Codes for the United States and Canada](developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). If you indicate you do not have nexus in the destination state, jurisdiction level fields are left blank in the Tax Detail Report. Optional field for U.S. and Canadian taxes only. Either this field or `taxInformation.noNexus` is required if you do not have nexus in every state or province. Not applicable for international and value added taxes.

no_nexus[RW]

Comma-separated list of states or provinces where you do not have nexus. Check with a tax advisor to determine where your business has nexus. Do not use both the `taxInformation.nexus` and `taxInformation.noNexus` fields in your request. If you do not include this field in a tax calculation service request, the tax system makes its calculations as if you have nexus in every US state or Canadian province. Use the [State, Province, and Territory Codes for the United States and Canada](developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). If you indicate you do not have nexus in the destination state, jurisdiction level fields are left blank in the Tax Detail Report. Optional field for U.S. and Canadian taxes only. Either this field or `taxInformation.nexus` is required if you do not have nexus in every state or province. Not applicable for international and value added taxes.

refund_indicator[RW]

Indicates whether this is a refund tax transaction. For a refund tax transaction, amounts in the Tax Detail Report will be negative. Possible values: - `true`: This is a refund tax transaction. - `false` (default): This is not a refund tax transaction. A refund tax request is a tax service request that sets the transaction type field in the Tax Detail Report to refunded and makes the reported amount negative. Tax amounts are returned as positive amounts in reply messages, but they are saved in reports as negative amounts which enables the reporting software to accurately calculate the aggregate amounts. Optional for U.S., Canadian, international tax, and value added taxes.

reporting_date[RW]

Reporting date of transaction. Format: YYYYMMDD. Defaults to current date if not specified. Also the default tax calculation date unless a different date is specified in `orderInformation.invoiceDetails.invoiceDate`. Optional for U.S., Canadian, international tax, and value added taxes.

show_tax_per_line_item[RW]

Whether or not to display tax amounts for each line item. This field can contain one of the following values: - `Yes` - Display tax amounts for each line item - `No` (default) - Do not display tax amounts for each line item Optional for U.S., Canadian, international tax, and value added taxes.

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_tax_information.rb, line 39
def self.attribute_map
  {
    :'reporting_date' => :'reportingDate',
    :'date_override_reason' => :'dateOverrideReason',
    :'nexus' => :'nexus',
    :'no_nexus' => :'noNexus',
    :'show_tax_per_line_item' => :'showTaxPerLineItem',
    :'commit_indicator' => :'commitIndicator',
    :'refund_indicator' => :'refundIndicator'
  }
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_tax_information.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?(:'reportingDate')
    self.reporting_date = attributes[:'reportingDate']
  end

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

  if attributes.has_key?(:'nexus')
    if (value = attributes[:'nexus']).is_a?(Array)
      self.nexus = value
    end
  end

  if attributes.has_key?(:'noNexus')
    if (value = attributes[:'noNexus']).is_a?(Array)
      self.no_nexus = value
    end
  end

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

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

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

Attribute type mapping.

# File lib/cybersource_rest_client/models/vasv2tax_tax_information.rb, line 52
def self.swagger_types
  {
    :'reporting_date' => :'String',
    :'date_override_reason' => :'String',
    :'nexus' => :'Array<String>',
    :'no_nexus' => :'Array<String>',
    :'show_tax_per_line_item' => :'String',
    :'commit_indicator' => :'BOOLEAN',
    :'refund_indicator' => :'BOOLEAN'
  }
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_tax_information.rb, line 132
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      reporting_date == o.reporting_date &&
      date_override_reason == o.date_override_reason &&
      nexus == o.nexus &&
      no_nexus == o.no_nexus &&
      show_tax_per_line_item == o.show_tax_per_line_item &&
      commit_indicator == o.commit_indicator &&
      refund_indicator == o.refund_indicator
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_tax_information.rb, line 180
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_tax_information.rb, line 246
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_tax_information.rb, line 159
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
date_override_reason=(date_override_reason) click to toggle source

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

# File lib/cybersource_rest_client/models/vasv2tax_tax_information.rb, line 126
def date_override_reason=(date_override_reason)
  @date_override_reason = date_override_reason
end
eql?(o) click to toggle source

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

# File lib/cybersource_rest_client/models/vasv2tax_tax_information.rb, line 146
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_tax_information.rb, line 152
def hash
  [reporting_date, date_override_reason, nexus, no_nexus, show_tax_per_line_item, commit_indicator, refund_indicator].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_tax_information.rb, line 107
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
reporting_date=(reporting_date) click to toggle source

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

# File lib/cybersource_rest_client/models/vasv2tax_tax_information.rb, line 120
def reporting_date=(reporting_date)
  @reporting_date = reporting_date
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_tax_information.rb, line 226
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_tax_information.rb, line 232
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_tax_information.rb, line 220
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/vasv2tax_tax_information.rb, line 114
def valid?
  true
end