Class: CyberSource::Ptsv2paymentsOrderInformationAmountDetailsTaxDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsOrderInformationAmountDetailsTaxDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 78

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

Instance Attribute Details

#amount ⇒ Object

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. | | `green` | Green tax amount for Korean Processing. |



20
21
22
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 20

def amount
  @amount
end

#applied ⇒ Object

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/)



32
33
34
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 32

def applied
  @applied
end

#code ⇒ Object

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`



26
27
28
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 26

def code
  @code
end

#exemption_code ⇒ Object

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/)



35
36
37
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 35

def exemption_code
  @exemption_code
end

#rate ⇒ Object

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/)



23
24
25
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 23

def rate
  @rate
end

#tax_id ⇒ Object

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/)



29
30
31
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 29

def tax_id
  @tax_id
end

#type ⇒ Object

Indicates the type of tax data for the taxDetails object. Possible values: - ‘alternate` - `local` - `national` - `vat` - `other` - `green` 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/)



17
18
19
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 17

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 38

def self.attribute_map
  {
    :'type' => :'type',
    :'amount' => :'amount',
    :'rate' => :'rate',
    :'code' => :'code',
    :'tax_id' => :'taxId',
    :'applied' => :'applied',
    :'exemption_code' => :'exemptionCode'
  }
end

.json_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 51

def self.json_map
  {
    :'type' => :'type',
    :'amount' => :'amount',
    :'rate' => :'rate',
    :'code' => :'code',
    :'tax_id' => :'tax_id',
    :'applied' => :'applied',
    :'exemption_code' => :'exemption_code'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 64

def self.swagger_types
  {
    :'type' => :'String',
    :'amount' => :'String',
    :'rate' => :'String',
    :'code' => :'String',
    :'tax_id' => :'String',
    :'applied' => :'BOOLEAN',
    :'exemption_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 158

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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 206

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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 272

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 185

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("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


172
173
174
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 172

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



178
179
180
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 178

def hash
  [type, amount, rate, code, tax_id, applied, exemption_code].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



115
116
117
118
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 115

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



252
253
254
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 252

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



258
259
260
261
262
263
264
265
266
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 258

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



246
247
248
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 246

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



122
123
124
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb', line 122

def valid?
  true
end