Class: FdxV660Api::Form24391

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/fdx_v660_api/models/form24391.rb

Overview

Notice to Shareholder of Undistributed Long-Term Capital Gains

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(tax_year: SKIP, corrected: SKIP, account_id: SKIP, tax_form_id: SKIP, tax_form_date: SKIP, additional_information: SKIP, tax_form_type: SKIP, issuer: SKIP, recipient: SKIP, attributes: SKIP, error: SKIP, links: SKIP, fiscal_year_begin: SKIP, fiscal_year_end: SKIP, undistributed_long_term_capital_gains: SKIP, unrecaptured1250_gain: SKIP, section1202_gain: SKIP, collectibles_gain: SKIP, tax_paid: SKIP, additional_properties: nil) ⇒ Form24391

Returns a new instance of Form24391.



157
158
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
191
192
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 157

def initialize(tax_year: SKIP, corrected: SKIP, account_id: SKIP,
               tax_form_id: SKIP, tax_form_date: SKIP,
               additional_information: SKIP, tax_form_type: SKIP,
               issuer: SKIP, recipient: SKIP, attributes: SKIP, error: SKIP,
               links: SKIP, fiscal_year_begin: SKIP, fiscal_year_end: SKIP,
               undistributed_long_term_capital_gains: SKIP,
               unrecaptured1250_gain: SKIP, section1202_gain: SKIP,
               collectibles_gain: SKIP, tax_paid: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @tax_year = tax_year unless tax_year == SKIP
  @corrected = corrected unless corrected == SKIP
  @account_id =  unless  == SKIP
  @tax_form_id = tax_form_id unless tax_form_id == SKIP
  @tax_form_date = tax_form_date unless tax_form_date == SKIP
  @additional_information = additional_information unless additional_information == SKIP
  @tax_form_type = tax_form_type unless tax_form_type == SKIP
  @issuer = issuer unless issuer == SKIP
  @recipient = recipient unless recipient == SKIP
  @attributes = attributes unless attributes == SKIP
  @error = error unless error == SKIP
  @links = links unless links == SKIP
  @fiscal_year_begin = fiscal_year_begin unless fiscal_year_begin == SKIP
  @fiscal_year_end = fiscal_year_end unless fiscal_year_end == SKIP
  unless undistributed_long_term_capital_gains == SKIP
    @undistributed_long_term_capital_gains =
      undistributed_long_term_capital_gains
  end
  @unrecaptured1250_gain = unrecaptured1250_gain unless unrecaptured1250_gain == SKIP
  @section1202_gain = section1202_gain unless section1202_gain == SKIP
  @collectibles_gain = collectibles_gain unless collectibles_gain == SKIP
  @tax_paid = tax_paid unless tax_paid == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#account_id ⇒ String

Long-term persistent identity of the source account. Not the account number

Returns:

  • (String) 


23
24
25
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 23

def 
  @account_id
end

#additional_information ⇒ String

Additional explanation text or content about this tax form

Returns:

  • (String) 


37
38
39
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 37

def additional_information
  @additional_information
end

#attributes ⇒ Array[TaxFormAttribute]

Additional attributes for this tax form when defined fields are not available. Some specific additional attributes already defined by providers: Fields required by [IRS FIRE](https://www.irs.gov/e-file-providers/filing-information-returns-elec tronically-fire): Name Control, Type of Identification Number (EIN, SSN, ITIN, ATIN). (ATIN is tax ID number for pending adoptions.) Tax form provider field for taxpayer notification: Recipient Email Address.

Returns:



63
64
65
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 63

def attributes
  @attributes
end

#collectibles_gain ⇒ Float

Box 1d, Collectibles (28%) gain

Returns:

  • (Float) 


95
96
97
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 95

def collectibles_gain
  @collectibles_gain
end

#corrected ⇒ TrueClass | FalseClass

True to indicate this is a corrected tax form

Returns:

  • (TrueClass | FalseClass) 


18
19
20
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 18

def corrected
  @corrected
end

#error ⇒ Error2

Present if an error was encountered while retrieving this form

Returns:



67
68
69
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 67

def error
  @error
end

#fiscal_year_begin ⇒ Date

Fiscal year begin date

Returns:

  • (Date) 


75
76
77
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 75

def fiscal_year_begin
  @fiscal_year_begin
end

#fiscal_year_end ⇒ Date

Fiscal year end date

Returns:

  • (Date) 


79
80
81
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 79

def fiscal_year_end
  @fiscal_year_end
end

#issuer ⇒ TaxParty8

Issuer's name, address, phone, and TIN. Issuer data need only be transmitted on enclosing TaxStatement, if it is the same on all its included tax forms.

Returns:



47
48
49
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 47

def issuer
  @issuer
end

#links ⇒ Array[HateoasLink]

Links to retrieve this form as data or image, or to invoke other APIs

Returns:



71
72
73
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 71

def links
  @links
end

#recipient ⇒ TaxParty1

Recipient's name, address, phone, and TIN. Recipient data need only be transmitted on enclosing TaxStatement, if it is the same on all its included tax forms.

Returns:



53
54
55
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 53

def recipient
  @recipient
end

#section1202_gain ⇒ Float

Box 1c, Section 1202 gain

Returns:

  • (Float) 


91
92
93
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 91

def section1202_gain
  @section1202_gain
end

#tax_form_date ⇒ Date

Date of production or delivery of the tax form

Returns:

  • (Date) 


33
34
35
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 33

def tax_form_date
  @tax_form_date
end

#tax_form_id ⇒ String

Long-term persistent id for this tax form. Depending upon the data provider, this may be the same id as the enclosing tax statement id, or this may be a different id, or this id may be omitted.

Returns:

  • (String) 


29
30
31
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 29

def tax_form_id
  @tax_form_id
end

#tax_form_type ⇒ TypeFormType1

Enumerated name of the tax form entity e.g. "TaxW2"

Returns:



41
42
43
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 41

def tax_form_type
  @tax_form_type
end

#tax_paid ⇒ Float

Box 2, Tax paid by the RIC or REIT on the box 1a gains

Returns:

  • (Float) 


99
100
101
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 99

def tax_paid
  @tax_paid
end

#tax_year ⇒ Integer

Year for which taxes are being paid

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 14

def tax_year
  @tax_year
end

#undistributed_long_term_capital_gains ⇒ Float

Box 1a, Total undistributed long-term capital gains

Returns:

  • (Float) 


83
84
85
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 83

def undistributed_long_term_capital_gains
  @undistributed_long_term_capital_gains
end

#unrecaptured1250_gain ⇒ Float

Box 1b, Unrecaptured section 1250 gain

Returns:

  • (Float) 


87
88
89
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 87

def unrecaptured1250_gain
  @unrecaptured1250_gain
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
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
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 195

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  tax_year = hash.key?('taxYear') ? hash['taxYear'] : SKIP
  corrected = hash.key?('corrected') ? hash['corrected'] : SKIP
   = hash.key?('accountId') ? hash['accountId'] : SKIP
  tax_form_id = hash.key?('taxFormId') ? hash['taxFormId'] : SKIP
  tax_form_date = hash.key?('taxFormDate') ? hash['taxFormDate'] : SKIP
  additional_information =
    hash.key?('additionalInformation') ? hash['additionalInformation'] : SKIP
  tax_form_type = hash.key?('taxFormType') ? hash['taxFormType'] : SKIP
  issuer = TaxParty8.from_hash(hash['issuer']) if hash['issuer']
  recipient = TaxParty1.from_hash(hash['recipient']) if hash['recipient']
  # Parameter is an array, so we need to iterate through it
  attributes = nil
  unless hash['attributes'].nil?
    attributes = []
    hash['attributes'].each do |structure|
      attributes << (TaxFormAttribute.from_hash(structure) if structure)
    end
  end

  attributes = SKIP unless hash.key?('attributes')
  error = Error2.from_hash(hash['error']) if hash['error']
  # Parameter is an array, so we need to iterate through it
  links = nil
  unless hash['links'].nil?
    links = []
    hash['links'].each do |structure|
      links << (HateoasLink.from_hash(structure) if structure)
    end
  end

  links = SKIP unless hash.key?('links')
  fiscal_year_begin =
    hash.key?('fiscalYearBegin') ? hash['fiscalYearBegin'] : SKIP
  fiscal_year_end =
    hash.key?('fiscalYearEnd') ? hash['fiscalYearEnd'] : SKIP
  undistributed_long_term_capital_gains =
    hash.key?('undistributedLongTermCapitalGains') ? hash['undistributedLongTermCapitalGains'] : SKIP
  unrecaptured1250_gain =
    hash.key?('unrecaptured1250Gain') ? hash['unrecaptured1250Gain'] : SKIP
  section1202_gain =
    hash.key?('section1202Gain') ? hash['section1202Gain'] : SKIP
  collectibles_gain =
    hash.key?('collectiblesGain') ? hash['collectiblesGain'] : SKIP
  tax_paid = hash.key?('taxPaid') ? hash['taxPaid'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  Form24391.new(tax_year: tax_year,
                corrected: corrected,
                account_id: ,
                tax_form_id: tax_form_id,
                tax_form_date: tax_form_date,
                additional_information: additional_information,
                tax_form_type: tax_form_type,
                issuer: issuer,
                recipient: recipient,
                attributes: attributes,
                error: error,
                links: links,
                fiscal_year_begin: fiscal_year_begin,
                fiscal_year_end: fiscal_year_end,
                undistributed_long_term_capital_gains: undistributed_long_term_capital_gains,
                unrecaptured1250_gain: unrecaptured1250_gain,
                section1202_gain: section1202_gain,
                collectibles_gain: collectibles_gain,
                tax_paid: tax_paid,
                additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 102

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['tax_year'] = 'taxYear'
  @_hash['corrected'] = 'corrected'
  @_hash['account_id'] = 'accountId'
  @_hash['tax_form_id'] = 'taxFormId'
  @_hash['tax_form_date'] = 'taxFormDate'
  @_hash['additional_information'] = 'additionalInformation'
  @_hash['tax_form_type'] = 'taxFormType'
  @_hash['issuer'] = 'issuer'
  @_hash['recipient'] = 'recipient'
  @_hash['attributes'] = 'attributes'
  @_hash['error'] = 'error'
  @_hash['links'] = 'links'
  @_hash['fiscal_year_begin'] = 'fiscalYearBegin'
  @_hash['fiscal_year_end'] = 'fiscalYearEnd'
  @_hash['undistributed_long_term_capital_gains'] =
    'undistributedLongTermCapitalGains'
  @_hash['unrecaptured1250_gain'] = 'unrecaptured1250Gain'
  @_hash['section1202_gain'] = 'section1202Gain'
  @_hash['collectibles_gain'] = 'collectiblesGain'
  @_hash['tax_paid'] = 'taxPaid'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



153
154
155
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 153

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 128

def self.optionals
  %w[
    tax_year
    corrected
    account_id
    tax_form_id
    tax_form_date
    additional_information
    tax_form_type
    issuer
    recipient
    attributes
    error
    links
    fiscal_year_begin
    fiscal_year_end
    undistributed_long_term_capital_gains
    unrecaptured1250_gain
    section1202_gain
    collectibles_gain
    tax_paid
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 290

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} tax_year: #{@tax_year.inspect}, corrected: #{@corrected.inspect},"\
  " account_id: #{@account_id.inspect}, tax_form_id: #{@tax_form_id.inspect}, tax_form_date:"\
  " #{@tax_form_date.inspect}, additional_information: #{@additional_information.inspect},"\
  " tax_form_type: #{@tax_form_type.inspect}, issuer: #{@issuer.inspect}, recipient:"\
  " #{@recipient.inspect}, attributes: #{@attributes.inspect}, error: #{@error.inspect},"\
  " links: #{@links.inspect}, fiscal_year_begin: #{@fiscal_year_begin.inspect},"\
  " fiscal_year_end: #{@fiscal_year_end.inspect}, undistributed_long_term_capital_gains:"\
  " #{@undistributed_long_term_capital_gains.inspect}, unrecaptured1250_gain:"\
  " #{@unrecaptured1250_gain.inspect}, section1202_gain: #{@section1202_gain.inspect},"\
  " collectibles_gain: #{@collectibles_gain.inspect}, tax_paid: #{@tax_paid.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/fdx_v660_api/models/form24391.rb', line 275

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} tax_year: #{@tax_year}, corrected: #{@corrected}, account_id:"\
  " #{@account_id}, tax_form_id: #{@tax_form_id}, tax_form_date: #{@tax_form_date},"\
  " additional_information: #{@additional_information}, tax_form_type: #{@tax_form_type},"\
  " issuer: #{@issuer}, recipient: #{@recipient}, attributes: #{@attributes}, error:"\
  " #{@error}, links: #{@links}, fiscal_year_begin: #{@fiscal_year_begin}, fiscal_year_end:"\
  " #{@fiscal_year_end}, undistributed_long_term_capital_gains:"\
  " #{@undistributed_long_term_capital_gains}, unrecaptured1250_gain:"\
  " #{@unrecaptured1250_gain}, section1202_gain: #{@section1202_gain}, collectibles_gain:"\
  " #{@collectibles_gain}, tax_paid: #{@tax_paid}, additional_properties:"\
  " #{@additional_properties}>"
end