Class: FdxV660Api::Form1097Btc

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

Overview

Bond Tax Credit, from FORM 1097-BTC ISSUER (1st-2nd boxes) to RECIPIENT (3rd-6th boxes)

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, filing_for_credit: SKIP, as_nominee: SKIP, total: SKIP, bond_code: SKIP, unique_id: SKIP, bond_type: SKIP, amounts: SKIP, comments: SKIP, additional_properties: nil) ⇒ Form1097Btc

Returns a new instance of Form1097Btc.



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
193
194
195
196
197
198
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 166

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, filing_for_credit: SKIP, as_nominee: SKIP,
               total: SKIP, bond_code: SKIP, unique_id: SKIP,
               bond_type: SKIP, amounts: SKIP, comments: 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
  @filing_for_credit = filing_for_credit unless filing_for_credit == SKIP
  @as_nominee = as_nominee unless as_nominee == SKIP
  @total = total unless total == SKIP
  @bond_code = bond_code unless bond_code == SKIP
  @unique_id = unique_id unless unique_id == SKIP
  @bond_type = bond_type unless bond_type == SKIP
  @amounts = amounts unless amounts == SKIP
  @comments = comments unless comments == 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) 


24
25
26
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 24

def 
  @account_id
end

#additional_information ⇒ String

Additional explanation text or content about this tax form

Returns:

  • (String) 


38
39
40
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 38

def additional_information
  @additional_information
end

#amounts ⇒ Array[MonthAndAmount]

Box 5, Amounts by month

Returns:



103
104
105
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 103

def amounts
  @amounts
end

#as_nominee ⇒ TrueClass | FalseClass

Form 1097-BTC issuer is: An entity or a person that received or should have received a current year Form 1097-BTC and is distributing part or all of that credit to others

Returns:

  • (TrueClass | FalseClass) 


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

def as_nominee
  @as_nominee
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:



64
65
66
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 64

def attributes
  @attributes
end

#bond_code ⇒ String

Box 2a, Code

Returns:

  • (String) 


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

def bond_code
  @bond_code
end

#bond_type ⇒ String

Box 3, Bond type

Returns:

  • (String) 


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

def bond_type
  @bond_type
end

#comments ⇒ String

Box 6, Comments

Returns:

  • (String) 


107
108
109
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 107

def comments
  @comments
end

#corrected ⇒ TrueClass | FalseClass

True to indicate this is a corrected tax form

Returns:

  • (TrueClass | FalseClass) 


19
20
21
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 19

def corrected
  @corrected
end

#error ⇒ Error2

Present if an error was encountered while retrieving this form

Returns:



68
69
70
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 68

def error
  @error
end

#filing_for_credit ⇒ TrueClass | FalseClass

Form 1097-BTC issuer is: Issuer of bond or its agent filing current year Form 1097-BTC for credit being reported

Returns:

  • (TrueClass | FalseClass) 


77
78
79
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 77

def filing_for_credit
  @filing_for_credit
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:



48
49
50
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 48

def issuer
  @issuer
end

#links ⇒ Array[HateoasLink]

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

Returns:



72
73
74
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 72

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:



54
55
56
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 54

def recipient
  @recipient
end

#tax_form_date ⇒ Date

Date of production or delivery of the tax form

Returns:

  • (Date) 


34
35
36
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 34

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) 


30
31
32
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 30

def tax_form_id
  @tax_form_id
end

#tax_form_type ⇒ TypeFormType1

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

Returns:



42
43
44
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 42

def tax_form_type
  @tax_form_type
end

#tax_year ⇒ Integer

Year for which taxes are being paid

Returns:

  • (Integer) 


15
16
17
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 15

def tax_year
  @tax_year
end

#total ⇒ Float

Box 1, Total

Returns:

  • (Float) 


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

def total
  @total
end

#unique_id ⇒ String

Box 2b, Unique Identifier

Returns:

  • (String) 


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

def unique_id
  @unique_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 201

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')
  filing_for_credit =
    hash.key?('filingForCredit') ? hash['filingForCredit'] : SKIP
  as_nominee = hash.key?('asNominee') ? hash['asNominee'] : SKIP
  total = hash.key?('total') ? hash['total'] : SKIP
  bond_code = hash.key?('bondCode') ? hash['bondCode'] : SKIP
  unique_id = hash.key?('uniqueId') ? hash['uniqueId'] : SKIP
  bond_type = hash.key?('bondType') ? hash['bondType'] : SKIP
  # Parameter is an array, so we need to iterate through it
  amounts = nil
  unless hash['amounts'].nil?
    amounts = []
    hash['amounts'].each do |structure|
      amounts << (MonthAndAmount.from_hash(structure) if structure)
    end
  end

  amounts = SKIP unless hash.key?('amounts')
  comments = hash.key?('comments') ? hash['comments'] : 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.
  Form1097Btc.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,
                  filing_for_credit: filing_for_credit,
                  as_nominee: as_nominee,
                  total: total,
                  bond_code: bond_code,
                  unique_id: unique_id,
                  bond_type: bond_type,
                  amounts: amounts,
                  comments: comments,
                  additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 110

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['filing_for_credit'] = 'filingForCredit'
  @_hash['as_nominee'] = 'asNominee'
  @_hash['total'] = 'total'
  @_hash['bond_code'] = 'bondCode'
  @_hash['unique_id'] = 'uniqueId'
  @_hash['bond_type'] = 'bondType'
  @_hash['amounts'] = 'amounts'
  @_hash['comments'] = 'comments'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



162
163
164
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 162

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 136

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
    filing_for_credit
    as_nominee
    total
    bond_code
    unique_id
    bond_type
    amounts
    comments
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 300

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}, filing_for_credit: #{@filing_for_credit.inspect}, as_nominee:"\
  " #{@as_nominee.inspect}, total: #{@total.inspect}, bond_code: #{@bond_code.inspect},"\
  " unique_id: #{@unique_id.inspect}, bond_type: #{@bond_type.inspect}, amounts:"\
  " #{@amounts.inspect}, comments: #{@comments.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/fdx_v660_api/models/form1097_btc.rb', line 287

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}, filing_for_credit: #{@filing_for_credit}, as_nominee:"\
  " #{@as_nominee}, total: #{@total}, bond_code: #{@bond_code}, unique_id: #{@unique_id},"\
  " bond_type: #{@bond_type}, amounts: #{@amounts}, comments: #{@comments},"\
  " additional_properties: #{@additional_properties}>"
end