Class: CyberSource::Vasv2taxTaxInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Vasv2taxTaxInformation

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
112
113
114
115
 
# File 'lib/cybersource_rest_client/models/vasv2tax_tax_information.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?(:'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

Instance Attribute Details

#commit_indicator ⇒ Object

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 cancel 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. For more information on Tax Detail Report features refer the [Tax Service Guide](developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html).



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

def commit_indicator
  @commit_indicator
end

#date_override_reason ⇒ Object

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.



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

def date_override_reason
  @date_override_reason
end

#nexus ⇒ Object

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.



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

def nexus
  @nexus
end

#no_nexus ⇒ Object

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.



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

def no_nexus
  @no_nexus
end

#refund_indicator ⇒ Object

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. For more information on Tax Detail Report features refer the [Tax Service Guide](developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html).



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

def refund_indicator
  @refund_indicator
end

#reporting_date ⇒ Object

Reporting date of transaction. Format: YYYYMMDD. Defaults to current date if not specified. Optional for U.S., Canadian, international tax, and value added taxes.



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

def reporting_date
  @reporting_date
end

#show_tax_per_line_item ⇒ Object

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.



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

def show_tax_per_line_item
  @show_tax_per_line_item
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/vasv2tax_tax_information.rb', line 38

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

.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/vasv2tax_tax_information.rb', line 51

def self.json_map
  {
    :'reporting_date' => :'reporting_date',
    :'date_override_reason' => :'date_override_reason',
    :'nexus' => :'nexus',
    :'no_nexus' => :'no_nexus',
    :'show_tax_per_line_item' => :'show_tax_per_line_item',
    :'commit_indicator' => :'commit_indicator',
    :'refund_indicator' => :'refund_indicator'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/cybersource_rest_client/models/vasv2tax_tax_information.rb', line 144

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

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/cybersource_rest_client/models/vasv2tax_tax_information.rb', line 192

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



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/cybersource_rest_client/models/vasv2tax_tax_information.rb', line 258

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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/cybersource_rest_client/models/vasv2tax_tax_information.rb', line 171

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


158
159
160
 
# File 'lib/cybersource_rest_client/models/vasv2tax_tax_information.rb', line 158

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



164
165
166
 
# File 'lib/cybersource_rest_client/models/vasv2tax_tax_information.rb', line 164

def hash
  [reporting_date, date_override_reason, nexus, no_nexus, show_tax_per_line_item, commit_indicator, refund_indicator].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



119
120
121
122
 
# File 'lib/cybersource_rest_client/models/vasv2tax_tax_information.rb', line 119

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



238
239
240
 
# File 'lib/cybersource_rest_client/models/vasv2tax_tax_information.rb', line 238

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



244
245
246
247
248
249
250
251
252
 
# File 'lib/cybersource_rest_client/models/vasv2tax_tax_information.rb', line 244

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



232
233
234
 
# File 'lib/cybersource_rest_client/models/vasv2tax_tax_information.rb', line 232

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



126
127
128
 
# File 'lib/cybersource_rest_client/models/vasv2tax_tax_information.rb', line 126

def valid?
  true
end