Class: AvalaraSdk::A1099::V2::Form1042SListItem

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Form1042SListItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
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
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
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
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 331

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AvalaraSdk::A1099::V2::Form1042SListItem` 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::Form1042SListItem`. 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?(:'unique_form_id')
    self.unique_form_id = attributes[:'unique_form_id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'intermediary_or_flow_through')
    self.intermediary_or_flow_through = attributes[:'intermediary_or_flow_through']
  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?(:'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

#academic_indicator ⇒ Object

Academic indicator



63
64
65
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 63

def academic_indicator
  @academic_indicator
end

#account_number ⇒ Object

Account number



123
124
125
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 123

def 
  @account_number
end

#address ⇒ Object

Address



105
106
107
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 105

def address
  @address
end

#address2 ⇒ Object

Address line 2



108
109
110
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 108

def address2
  @address2
end

#address_verification ⇒ Object

Boolean indicating that address verification should be scheduled for this form



150
151
152
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 150

def address_verification
  @address_verification
end

#amount_repaid ⇒ Object

Amount repaid to recipient



69
70
71
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 69

def amount_repaid
  @amount_repaid
end

#chap3_status_code ⇒ Object

Chapter 3 status code



75
76
77
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 75

def chap3_status_code
  @chap3_status_code
end

#chap4_status_code ⇒ Object

Chapter 4 status code



78
79
80
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 78

def chap4_status_code
  @chap4_status_code
end

#city ⇒ Object

City



111
112
113
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 111

def city
  @city
end

#country_code ⇒ Object

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



132
133
134
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 132

def country_code
  @country_code
end

#email ⇒ Object

Recipient email address



120
121
122
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 120

def email
  @email
end

#exemption_code_chap3 ⇒ Object

Exemption code (Chapter 3)



45
46
47
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 45

def exemption_code_chap3
  @exemption_code_chap3
end

#exemption_code_chap4 ⇒ Object

Exemption code (Chapter 4)



48
49
50
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 48

def exemption_code_chap4
  @exemption_code_chap4
end

#federal_e_file ⇒ Object

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



135
136
137
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 135

def federal_e_file
  @federal_e_file
end

#federal_tax_withheld ⇒ Object

Federal tax withheld



57
58
59
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 57

def federal_tax_withheld
  @federal_tax_withheld
end

#gross_income ⇒ Object

Gross income



36
37
38
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 36

def gross_income
  @gross_income
end

#income_code ⇒ Object

Income code



33
34
35
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 33

def income_code
  @income_code
end

#intermediary_or_flow_through ⇒ Object

Intermediary or flow-through entity information



84
85
86
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 84

def intermediary_or_flow_through
  @intermediary_or_flow_through
end

#issuer_id ⇒ Object

Issuer ID



87
88
89
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 87

def issuer_id
  @issuer_id
end

#lob_code ⇒ Object

Limitation on benefits code



30
31
32
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 30

def lob_code
  @lob_code
end

#no_tin ⇒ Object

No TIN indicator



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

def no_tin
  @no_tin
end

#non_us_province ⇒ Object

Foreign province



129
130
131
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 129

def non_us_province
  @non_us_province
end

#office_code ⇒ Object

Office code



126
127
128
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 126

def office_code
  @office_code
end

#postal_mail ⇒ Object

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



138
139
140
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 138

def postal_mail
  @postal_mail
end

#primary_withholding_agent ⇒ Object

Primary withholding agent information



81
82
83
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 81

def primary_withholding_agent
  @primary_withholding_agent
end

#recipient_date_of_birth ⇒ Object

Recipient’s date of birth



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

def recipient_date_of_birth
  @recipient_date_of_birth
end

#recipient_foreign_tin ⇒ Object

Recipient’s foreign TIN



27
28
29
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 27

def recipient_foreign_tin
  @recipient_foreign_tin
end

#recipient_giin ⇒ Object

Recipient’s GIIN (Global Intermediary Identification Number)



24
25
26
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 24

def recipient_giin
  @recipient_giin
end

#recipient_name ⇒ Object

Recipient name



96
97
98
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 96

def recipient_name
  @recipient_name
end

#recipient_second_name ⇒ Object

Recipient second name



102
103
104
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 102

def recipient_second_name
  @recipient_second_name
end

#recipient_tin ⇒ Object

Recipient Tax ID Number



93
94
95
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 93

def recipient_tin
  @recipient_tin
end

#reference_id ⇒ Object

Reference ID



90
91
92
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 90

def reference_id
  @reference_id
end

#second_tin_notice ⇒ Object

Second TIN notice in three years



147
148
149
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 147

def second_tin_notice
  @second_tin_notice
end

#state ⇒ Object

US state. Required if CountryCode is "US".



114
115
116
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 114

def state
  @state
end

#state_and_local_withholding ⇒ Object

State and local withholding information



153
154
155
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 153

def state_and_local_withholding
  @state_and_local_withholding
end

#state_e_file ⇒ Object

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



141
142
143
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 141

def state_e_file
  @state_e_file
end

#tax_country_code ⇒ Object

Country code



42
43
44
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 42

def tax_country_code
  @tax_country_code
end

#tax_not_deposited_indicator ⇒ Object

Tax not deposited indicator



60
61
62
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 60

def tax_not_deposited_indicator
  @tax_not_deposited_indicator
end

#tax_paid_agent ⇒ Object

Tax paid by withholding agent



72
73
74
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 72

def tax_paid_agent
  @tax_paid_agent
end

#tax_rate_chap3 ⇒ Object

Tax rate (Chapter 3)



51
52
53
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 51

def tax_rate_chap3
  @tax_rate_chap3
end

#tax_withheld_other_agents ⇒ Object

Tax withheld by other agents



66
67
68
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 66

def tax_withheld_other_agents
  @tax_withheld_other_agents
end

#tin_match ⇒ Object

Boolean indicating that TIN Matching should be scheduled for this form



144
145
146
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 144

def tin_match
  @tin_match
end

#tin_type ⇒ Object

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



99
100
101
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 99

def tin_type
  @tin_type
end

#unique_form_id ⇒ Object

Unique form identifier



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

def unique_form_id
  @unique_form_id
end

#withholding_allowance ⇒ Object

Withholding allowance



54
55
56
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 54

def withholding_allowance
  @withholding_allowance
end

#withholding_indicator ⇒ Object

Withholding indicator



39
40
41
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 39

def withholding_indicator
  @withholding_indicator
end

#zip ⇒ Object

Zip/postal code



117
118
119
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 117

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



791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 791

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

Returns all the JSON keys this model knows about



231
232
233
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 231

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
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/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 178

def self.attribute_map
  {
    :'unique_form_id' => :'uniqueFormId',
    :'no_tin' => :'noTin',
    :'recipient_date_of_birth' => :'recipientDateOfBirth',
    :'recipient_giin' => :'recipientGiin',
    :'recipient_foreign_tin' => :'recipientForeignTin',
    :'lob_code' => :'lobCode',
    :'income_code' => :'incomeCode',
    :'gross_income' => :'grossIncome',
    :'withholding_indicator' => :'withholdingIndicator',
    :'tax_country_code' => :'taxCountryCode',
    :'exemption_code_chap3' => :'exemptionCodeChap3',
    :'exemption_code_chap4' => :'exemptionCodeChap4',
    :'tax_rate_chap3' => :'taxRateChap3',
    :'withholding_allowance' => :'withholdingAllowance',
    :'federal_tax_withheld' => :'federalTaxWithheld',
    :'tax_not_deposited_indicator' => :'taxNotDepositedIndicator',
    :'academic_indicator' => :'academicIndicator',
    :'tax_withheld_other_agents' => :'taxWithheldOtherAgents',
    :'amount_repaid' => :'amountRepaid',
    :'tax_paid_agent' => :'taxPaidAgent',
    :'chap3_status_code' => :'chap3StatusCode',
    :'chap4_status_code' => :'chap4StatusCode',
    :'primary_withholding_agent' => :'primaryWithholdingAgent',
    :'intermediary_or_flow_through' => :'intermediaryOrFlowThrough',
    :'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',
    :'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



767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 767

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

List of class defined in allOf (OpenAPI v3)



323
324
325
326
327
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 323

def self.openapi_all_of
  [
  :'FormRequestBase'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 289

def self.openapi_nullable
  Set.new([
    :'no_tin',
    :'recipient_date_of_birth',
    :'recipient_giin',
    :'recipient_foreign_tin',
    :'lob_code',
    :'exemption_code_chap3',
    :'exemption_code_chap4',
    :'tax_rate_chap3',
    :'withholding_allowance',
    :'federal_tax_withheld',
    :'tax_not_deposited_indicator',
    :'academic_indicator',
    :'tax_withheld_other_agents',
    :'amount_repaid',
    :'tax_paid_agent',
    :'chap3_status_code',
    :'chap4_status_code',
    :'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_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 236

def self.openapi_types
  {
    :'unique_form_id' => :'String',
    :'no_tin' => :'Boolean',
    :'recipient_date_of_birth' => :'Time',
    :'recipient_giin' => :'String',
    :'recipient_foreign_tin' => :'String',
    :'lob_code' => :'String',
    :'income_code' => :'String',
    :'gross_income' => :'Float',
    :'withholding_indicator' => :'String',
    :'tax_country_code' => :'String',
    :'exemption_code_chap3' => :'String',
    :'exemption_code_chap4' => :'String',
    :'tax_rate_chap3' => :'String',
    :'withholding_allowance' => :'Float',
    :'federal_tax_withheld' => :'Float',
    :'tax_not_deposited_indicator' => :'Boolean',
    :'academic_indicator' => :'Boolean',
    :'tax_withheld_other_agents' => :'Float',
    :'amount_repaid' => :'Float',
    :'tax_paid_agent' => :'Float',
    :'chap3_status_code' => :'String',
    :'chap4_status_code' => :'String',
    :'primary_withholding_agent' => :'PrimaryWithholdingAgent',
    :'intermediary_or_flow_through' => :'IntermediaryOrFlowThrough',
    :'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',
    :'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



700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 700

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      unique_form_id == o.unique_form_id &&
      no_tin == o.no_tin &&
      recipient_date_of_birth == o.recipient_date_of_birth &&
      recipient_giin == o.recipient_giin &&
      recipient_foreign_tin == o.recipient_foreign_tin &&
      lob_code == o.lob_code &&
      income_code == o.income_code &&
      gross_income == o.gross_income &&
      withholding_indicator == o.withholding_indicator &&
      tax_country_code == o.tax_country_code &&
      exemption_code_chap3 == o.exemption_code_chap3 &&
      exemption_code_chap4 == o.exemption_code_chap4 &&
      tax_rate_chap3 == o.tax_rate_chap3 &&
      withholding_allowance == o.withholding_allowance &&
      federal_tax_withheld == o.federal_tax_withheld &&
      tax_not_deposited_indicator == o.tax_not_deposited_indicator &&
      academic_indicator == o.academic_indicator &&
      tax_withheld_other_agents == o.tax_withheld_other_agents &&
      amount_repaid == o.amount_repaid &&
      tax_paid_agent == o.tax_paid_agent &&
      chap3_status_code == o.chap3_status_code &&
      chap4_status_code == o.chap4_status_code &&
      primary_withholding_agent == o.primary_withholding_agent &&
      intermediary_or_flow_through == o.intermediary_or_flow_through &&
      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 &&
      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



862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 862

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


754
755
756
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 754

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



760
761
762
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 760

def hash
  [unique_form_id, no_tin, recipient_date_of_birth, recipient_giin, recipient_foreign_tin, lob_code, income_code, gross_income, withholding_indicator, tax_country_code, exemption_code_chap3, exemption_code_chap4, tax_rate_chap3, withholding_allowance, federal_tax_withheld, tax_not_deposited_indicator, academic_indicator, tax_withheld_other_agents, amount_repaid, tax_paid_agent, chap3_status_code, chap4_status_code, primary_withholding_agent, intermediary_or_flow_through, 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, second_tin_notice, address_verification, state_and_local_withholding].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



541
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
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 541

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



838
839
840
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 838

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



844
845
846
847
848
849
850
851
852
853
854
855
856
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 844

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

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



832
833
834
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 832

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



573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb', line 573

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  lob_code_validator = EnumAttributeValidator.new('String', ["Individual", "GovernmentContractingState", "TaxExemptPensionTrust", "TaxExemptCharitableOrganization", "PubliclyTradedCorporation", "SubsidiaryOfPubliclyTradedCorporation", "CompanyOwnershipBaseErosionTest", "CompanyDerivativeBenefitsTest", "CompanyActiveTradeOrBusinessTest", "DiscretionaryDetermination", "Other", "NoLobArticleInTreaty"])
  return false unless lob_code_validator.valid?(@lob_code)
  exemption_code_chap3_validator = EnumAttributeValidator.new('String', ["TaxRateDueToBackupWithholding", "EffectivelyConnectedIncome", "ExemptUnderIrc", "IncomeNotFromUsSources", "ExemptUnderTaxTreaty", "PortfolioInterestExemptUnderIrc", "QiThatAssumesPrimaryWithholdingResponsibility", "WfPorWft", "UsBranchTreatedAsUsPerson", "TerritoryFiTreatedAsUsPerson", "QiRepresentsIncomeExempt", "QslThatAssumesPrimaryWithholdingResponsibility", "PayeeSubjectedToChapter4Withholding", "QddThatAssumesPrimaryWithholdingResponsibility", "ExemptUnderSection897L", "ExemptUnderSection892"])
  return false unless exemption_code_chap3_validator.valid?(@exemption_code_chap3)
  exemption_code_chap4_validator = EnumAttributeValidator.new('String', ["NotExempt", "GrandfatheredPayment", "EffectivelyConnectedIncome", "PayeeNotSubjectToChapter4Withholding", "ExcludedNonfinancialPayment", "ForeignEntityThatAssumesPrimaryWithholdingResponsibility", "UsPayeesOfParticipatingFfi", "ExemptFromWithholdingUnderIga", "DormantAccount", "OtherPaymentNotSubjectToChapter4Withholding"])
  return false unless exemption_code_chap4_validator.valid?(@exemption_code_chap4)
  chap3_status_code_validator = EnumAttributeValidator.new('String', ["USWithholdingAgentFI", "USWithholdingAgentOther", "TerritoryFITreatedAsUSPerson", "TerritoryFINotTreatedAsUSPerson", "USBranchTreatedAsUSPerson", "USBranchNotTreatedAsUSPerson", "USBranchECIPresumptionApplied", "PartnershipOtherThanWithholdingForeignPartnership", "WithholdingForeignPartnership", "TrustOtherThanWithholdingForeignTrust", "WithholdingForeignTrust", "QualifiedIntermediary", "QualifiedSecuritiesLenderQualifiedIntermediary", "QualifiedSecuritiesLenderOther", "Corporation", "Individual", "Estate", "PrivateFoundation", "GovernmentOrInternationalOrganization", "TaxExemptOrganizationSection501cEntities", "UnknownRecipient", "ArtistOrAthlete", "Pension", "ForeignCentralBankOfIssue", "NonqualifiedIntermediary", "HybridEntityMakingTreatyClaim", "WithholdingRatePoolGeneral", "WithholdingRatePoolExemptOrganization", "PAIWithholdingRatePoolGeneral", "PAIWithholdingRatePoolExemptOrganization", "AgencyWithholdingRatePoolGeneral", "AgencyWithholdingRatePoolExemptOrganization", "USWithholdingAgentForeignBranchOfFI", "QualifiedDerivativesDealer", "ForeignGovernmentIntegralPart", "ForeignGovernmentControlledEntity", "PubliclyTradedPartnership", "DisclosingQualifiedIntermediary"])
  return false unless chap3_status_code_validator.valid?(@chap3_status_code)
  chap4_status_code_validator = EnumAttributeValidator.new('String', ["UsWithholdingAgentFi", "UsWithholdingAgentOther", "TerritoryFiNotTreatedAsUsPerson", "TerritoryFiTreatedAsUsPerson", "ParticipatingFfiOther", "ParticipatingFfiReportingModel2Ffi", "RegisteredDeemedCompliantFfiReportingModel1Ffi", "RegisteredDeemedCompliantFfiSponsoredEntity", "RegisteredDeemedCompliantFfiOther", "CertifiedDeemedCompliantFfiOther", "CertifiedDeemedCompliantFfiffiWithLowValueAccounts", "CertifiedDeemedCompliantFfiNonRegisteringLocalBank", "CertifiedDeemedCompliantFfiSponsoredEntity", "CertifiedDeemedCompliantFfiInvestmentAdvisorOrManager", "NonparticipatingFfi", "OwnerDocumentedFfi", "UsBranchTreatedAsUsPerson", "UsBranchNotTreatedAsUsPerson", "PassiveNffeIdentifyingSubstantialUsOwners", "PassiveNffeWithNoSubstantialUsOwners", "PubliclyTradedNffeOrAffiliate", "ActiveNffe", "Individual", "Section501CEntities", "ExceptedTerritoryNffe", "ExceptedNffeOther", "ExemptBeneficialOwner", "EntityWhollyOwnedByExemptBeneficialOwners", "UnknownRecipient", "RecalcitrantAccountHolder", "NonreportingIgafii", "DirectReportingNffe", "UsReportableAccount", "NonConsentingUsAccount", "SponsoredDirectReportingNffe", "ExceptedInterAffiliateFfi", "UndocumentedPreexistingObligation", "UsBranchEciPresumptionApplied", "AccountHolderOfExcludedFinancialAccount", "PassiveNffeReportedByFfi", "NffeSubjectTo1472Withholding", "RecalcitrantPoolNoUsIndicia", "RecalcitrantPoolUsIndicia", "RecalcitrantPoolDormantAccount", "RecalcitrantPoolUsPersons", "RecalcitrantPoolPassiveNffEs", "NonparticipatingFfiPool", "UsPayeesPool", "QiRecalcitrantPoolGeneral", "UsWithholdingAgentForeignBranchOfFi"])
  return false unless chap4_status_code_validator.valid?(@chap4_status_code)
  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