Class: AvalaraSdk::A1099::V2::Form1099NecRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Form1099NecRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 218

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AvalaraSdk::A1099::V2::Form1099NecRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `AvalaraSdk::A1099::V2::Form1099NecRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'nonemployee_compensation')
    self.nonemployee_compensation = attributes[:'nonemployee_compensation']
  else
    self.nonemployee_compensation = nil
  end

  if attributes.key?(:'direct_sales_indicator')
    self.direct_sales_indicator = attributes[:'direct_sales_indicator']
  end

  if attributes.key?(:'federal_income_tax_withheld')
    self.federal_income_tax_withheld = attributes[:'federal_income_tax_withheld']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'issuer_id')
    self.issuer_id = attributes[:'issuer_id']
  end

  if attributes.key?(:'reference_id')
    self.reference_id = attributes[:'reference_id']
  end

  if attributes.key?(:'recipient_tin')
    self.recipient_tin = attributes[:'recipient_tin']
  end

  if attributes.key?(:'recipient_name')
    self.recipient_name = attributes[:'recipient_name']
  end

  if attributes.key?(:'tin_type')
    self.tin_type = attributes[:'tin_type']
  end

  if attributes.key?(:'recipient_second_name')
    self.recipient_second_name = attributes[:'recipient_second_name']
  end

  if attributes.key?(:'address')
    self.address = attributes[:'address']
  else
    self.address = nil
  end

  if attributes.key?(:'address2')
    self.address2 = attributes[:'address2']
  end

  if attributes.key?(:'city')
    self.city = attributes[:'city']
  else
    self.city = nil
  end

  if attributes.key?(:'state')
    self.state = attributes[:'state']
  end

  if attributes.key?(:'zip')
    self.zip = attributes[:'zip']
  end

  if attributes.key?(:'email')
    self.email = attributes[:'email']
  end

  if attributes.key?(:'account_number')
    self. = attributes[:'account_number']
  end

  if attributes.key?(:'office_code')
    self.office_code = attributes[:'office_code']
  end

  if attributes.key?(:'non_us_province')
    self.non_us_province = attributes[:'non_us_province']
  end

  if attributes.key?(:'country_code')
    self.country_code = attributes[:'country_code']
  else
    self.country_code = nil
  end

  if attributes.key?(:'federal_e_file')
    self.federal_e_file = attributes[:'federal_e_file']
  end

  if attributes.key?(:'postal_mail')
    self.postal_mail = attributes[:'postal_mail']
  end

  if attributes.key?(:'state_e_file')
    self.state_e_file = attributes[:'state_e_file']
  end

  if attributes.key?(:'tin_match')
    self.tin_match = attributes[:'tin_match']
  end

  if attributes.key?(:'no_tin')
    self.no_tin = attributes[:'no_tin']
  end

  if attributes.key?(:'second_tin_notice')
    self.second_tin_notice = attributes[:'second_tin_notice']
  end

  if attributes.key?(:'address_verification')
    self.address_verification = attributes[:'address_verification']
  end

  if attributes.key?(:'state_and_local_withholding')
    self.state_and_local_withholding = attributes[:'state_and_local_withholding']
  end
end

Instance Attribute Details

#account_numberObject

Account number



62
63
64
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 62

def 
  @account_number
end

#addressObject

Address



44
45
46
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 44

def address
  @address
end

#address2Object

Address line 2



47
48
49
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 47

def address2
  @address2
end

#address_verificationObject

Boolean indicating that address verification should be scheduled for this form



92
93
94
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 92

def address_verification
  @address_verification
end

#cityObject

City



50
51
52
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 50

def city
  @city
end

#country_codeObject

Country code, as defined at www.irs.gov/e-file-providers/country-codes



71
72
73
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 71

def country_code
  @country_code
end

#direct_sales_indicatorObject

Payer made direct sales totaling $5,000 or more of consumer products to recipient for resale



18
19
20
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 18

def direct_sales_indicator
  @direct_sales_indicator
end

#emailObject

Recipient email address



59
60
61
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 59

def email
  @email
end

#federal_e_fileObject

Boolean indicating that federal e-filing should be scheduled for this form



74
75
76
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 74

def federal_e_file
  @federal_e_file
end

#federal_income_tax_withheldObject

Federal income tax withheld



21
22
23
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 21

def federal_income_tax_withheld
  @federal_income_tax_withheld
end

#issuer_idObject

Issuer ID



26
27
28
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 26

def issuer_id
  @issuer_id
end

#no_tinObject

Indicates whether the recipient has no TIN



86
87
88
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 86

def no_tin
  @no_tin
end

#non_us_provinceObject

Foreign province



68
69
70
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 68

def non_us_province
  @non_us_province
end

#nonemployee_compensationObject

Nonemployee compensation



15
16
17
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 15

def nonemployee_compensation
  @nonemployee_compensation
end

#office_codeObject

Office code



65
66
67
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 65

def office_code
  @office_code
end

#postal_mailObject

Boolean indicating that postal mailing to the recipient should be scheduled for this form



77
78
79
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 77

def postal_mail
  @postal_mail
end

#recipient_nameObject

Recipient name



35
36
37
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 35

def recipient_name
  @recipient_name
end

#recipient_second_nameObject

Recipient second name



41
42
43
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 41

def recipient_second_name
  @recipient_second_name
end

#recipient_tinObject

Recipient Tax ID Number



32
33
34
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 32

def recipient_tin
  @recipient_tin
end

#reference_idObject

Reference ID



29
30
31
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 29

def reference_id
  @reference_id
end

#second_tin_noticeObject

Second TIN notice in three years



89
90
91
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 89

def second_tin_notice
  @second_tin_notice
end

#stateObject

US state. Required if CountryCode is "US".



53
54
55
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 53

def state
  @state
end

#state_and_local_withholdingObject

State and local withholding information



95
96
97
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 95

def state_and_local_withholding
  @state_and_local_withholding
end

#state_e_fileObject

Boolean indicating that state e-filing should be scheduled for this form



80
81
82
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 80

def state_e_file
  @state_e_file
end

#tin_matchObject

Boolean indicating that TIN Matching should be scheduled for this form



83
84
85
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 83

def tin_match
  @tin_match
end

#tin_typeObject

Type of TIN (Tax ID Number). Will be one of: * SSN * EIN * ITIN * ATIN



38
39
40
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 38

def tin_type
  @tin_type
end

#typeObject

Returns the value of attribute type.



23
24
25
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 23

def type
  @type
end

#zipObject

Zip/postal code



56
57
58
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 56

def zip
  @zip
end

Class Method Details

._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



542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 542

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = AvalaraSdk::A1099::V2.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



154
155
156
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 154

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 120

def self.attribute_map
  {
    :'nonemployee_compensation' => :'nonemployeeCompensation',
    :'direct_sales_indicator' => :'directSalesIndicator',
    :'federal_income_tax_withheld' => :'federalIncomeTaxWithheld',
    :'type' => :'type',
    :'issuer_id' => :'issuerId',
    :'reference_id' => :'referenceId',
    :'recipient_tin' => :'recipientTin',
    :'recipient_name' => :'recipientName',
    :'tin_type' => :'tinType',
    :'recipient_second_name' => :'recipientSecondName',
    :'address' => :'address',
    :'address2' => :'address2',
    :'city' => :'city',
    :'state' => :'state',
    :'zip' => :'zip',
    :'email' => :'email',
    :'account_number' => :'accountNumber',
    :'office_code' => :'officeCode',
    :'non_us_province' => :'nonUsProvince',
    :'country_code' => :'countryCode',
    :'federal_e_file' => :'federalEFile',
    :'postal_mail' => :'postalMail',
    :'state_e_file' => :'stateEFile',
    :'tin_match' => :'tinMatch',
    :'no_tin' => :'noTin',
    :'second_tin_notice' => :'secondTinNotice',
    :'address_verification' => :'addressVerification',
    :'state_and_local_withholding' => :'stateAndLocalWithholding'
  }
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



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 518

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_all_ofObject

List of class defined in allOf (OpenAPI v3)



210
211
212
213
214
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 210

def self.openapi_all_of
  [
  :'FormSingleRequestBase'
  ]
end

.openapi_nullableObject

List of attributes with nullable: true



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 193

def self.openapi_nullable
  Set.new([
    :'issuer_id',
    :'reference_id',
    :'recipient_name',
    :'recipient_second_name',
    :'address2',
    :'email',
    :'account_number',
    :'office_code',
    :'non_us_province',
    :'second_tin_notice',
    :'state_and_local_withholding'
  ])
end

.openapi_typesObject

Attribute type mapping.



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 159

def self.openapi_types
  {
    :'nonemployee_compensation' => :'Float',
    :'direct_sales_indicator' => :'Boolean',
    :'federal_income_tax_withheld' => :'Float',
    :'type' => :'String',
    :'issuer_id' => :'String',
    :'reference_id' => :'String',
    :'recipient_tin' => :'String',
    :'recipient_name' => :'String',
    :'tin_type' => :'String',
    :'recipient_second_name' => :'String',
    :'address' => :'String',
    :'address2' => :'String',
    :'city' => :'String',
    :'state' => :'String',
    :'zip' => :'String',
    :'email' => :'String',
    :'account_number' => :'String',
    :'office_code' => :'String',
    :'non_us_province' => :'String',
    :'country_code' => :'String',
    :'federal_e_file' => :'Boolean',
    :'postal_mail' => :'Boolean',
    :'state_e_file' => :'Boolean',
    :'tin_match' => :'Boolean',
    :'no_tin' => :'Boolean',
    :'second_tin_notice' => :'Boolean',
    :'address_verification' => :'Boolean',
    :'state_and_local_withholding' => :'StateAndLocalWithholdingRequest'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 470

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      nonemployee_compensation == o.nonemployee_compensation &&
      direct_sales_indicator == o.direct_sales_indicator &&
      federal_income_tax_withheld == o.federal_income_tax_withheld &&
      type == o.type &&
      issuer_id == o.issuer_id &&
      reference_id == o.reference_id &&
      recipient_tin == o.recipient_tin &&
      recipient_name == o.recipient_name &&
      tin_type == o.tin_type &&
      recipient_second_name == o.recipient_second_name &&
      address == o.address &&
      address2 == o.address2 &&
      city == o.city &&
      state == o.state &&
      zip == o.zip &&
      email == o.email &&
       == o. &&
      office_code == o.office_code &&
      non_us_province == o.non_us_province &&
      country_code == o.country_code &&
      federal_e_file == o.federal_e_file &&
      postal_mail == o.postal_mail &&
      state_e_file == o.state_e_file &&
      tin_match == o.tin_match &&
      no_tin == o.no_tin &&
      second_tin_notice == o.second_tin_notice &&
      address_verification == o.address_verification &&
      state_and_local_withholding == o.state_and_local_withholding
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



613
614
615
616
617
618
619
620
621
622
623
624
625
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 613

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


505
506
507
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 505

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



511
512
513
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 511

def hash
  [nonemployee_compensation, direct_sales_indicator, federal_income_tax_withheld, type, issuer_id, reference_id, recipient_tin, recipient_name, tin_type, recipient_second_name, address, address2, city, state, zip, email, , office_code, non_us_province, country_code, federal_e_file, postal_mail, state_e_file, tin_match, no_tin, second_tin_notice, address_verification, state_and_local_withholding].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 354

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @nonemployee_compensation.nil?
    invalid_properties.push('invalid value for "nonemployee_compensation", nonemployee_compensation cannot be nil.')
  end

  if @address.nil?
    invalid_properties.push('invalid value for "address", address cannot be nil.')
  end

  if @address.to_s.length < 1
    invalid_properties.push('invalid value for "address", the character length must be great than or equal to 1.')
  end

  if @city.nil?
    invalid_properties.push('invalid value for "city", city cannot be nil.')
  end

  if @city.to_s.length < 1
    invalid_properties.push('invalid value for "city", the character length must be great than or equal to 1.')
  end

  if @country_code.nil?
    invalid_properties.push('invalid value for "country_code", country_code cannot be nil.')
  end

  if @country_code.to_s.length < 1
    invalid_properties.push('invalid value for "country_code", the character length must be great than or equal to 1.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



589
590
591
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 589

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



595
596
597
598
599
600
601
602
603
604
605
606
607
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 595

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



583
584
585
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 583

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



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
# File 'lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb', line 390

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @nonemployee_compensation.nil?
  type_validator = EnumAttributeValidator.new('String', ["1099-NEC", "1099-MISC", "1099-DIV", "1099-R", "1099-K", "1095-B", "1042-S", "1095-C"])
  return false unless type_validator.valid?(@type)
  tin_type_validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"])
  return false unless tin_type_validator.valid?(@tin_type)
  return false if @address.nil?
  return false if @address.to_s.length < 1
  return false if @city.nil?
  return false if @city.to_s.length < 1
  return false if @country_code.nil?
  return false if @country_code.to_s.length < 1
  true
end