Class: FdxV660Api::Form1099C

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

Overview

Cancellation of Debt, from CREDITOR (1st-2nd boxes as issuer) to DEBTOR (3rd-4th boxes as recipient)

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, account_number: SKIP, date_of_event: SKIP, amount_discharged: SKIP, interest_included: SKIP, debt_description: SKIP, personally_liable: SKIP, debt_code: SKIP, fair_market_value: SKIP, additional_properties: nil) ⇒ Form1099C

Returns a new instance of Form1099C.



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

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, account_number: SKIP, date_of_event: SKIP,
               amount_discharged: SKIP, interest_included: SKIP,
               debt_description: SKIP, personally_liable: SKIP,
               debt_code: SKIP, fair_market_value: 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
  @account_number =  unless  == SKIP
  @date_of_event = date_of_event unless date_of_event == SKIP
  @amount_discharged = amount_discharged unless amount_discharged == SKIP
  @interest_included = interest_included unless interest_included == SKIP
  @debt_description = debt_description unless debt_description == SKIP
  @personally_liable = personally_liable unless personally_liable == SKIP
  @debt_code = debt_code unless debt_code == SKIP
  @fair_market_value = fair_market_value unless fair_market_value == 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/form1099_c.rb', line 24

def 
  @account_id
end

#account_number ⇒ String

Account number

Returns:

  • (String) 


76
77
78
 
# File 'lib/fdx_v660_api/models/form1099_c.rb', line 76

def 
  @account_number
end

#additional_information ⇒ String

Additional explanation text or content about this tax form

Returns:

  • (String) 


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

def additional_information
  @additional_information
end

#amount_discharged ⇒ Float

Box 2, Amount of debt discharged

Returns:

  • (Float) 


84
85
86
 
# File 'lib/fdx_v660_api/models/form1099_c.rb', line 84

def amount_discharged
  @amount_discharged
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/form1099_c.rb', line 64

def attributes
  @attributes
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/form1099_c.rb', line 19

def corrected
  @corrected
end

#date_of_event ⇒ Date

Box 1, Date of identifiable event

Returns:

  • (Date) 


80
81
82
 
# File 'lib/fdx_v660_api/models/form1099_c.rb', line 80

def date_of_event
  @date_of_event
end

#debt_code ⇒ String

Box 6, Identifiable debt code

Returns:

  • (String) 


101
102
103
 
# File 'lib/fdx_v660_api/models/form1099_c.rb', line 101

def debt_code
  @debt_code
end

#debt_description ⇒ String

Box 4, Debt description

Returns:

  • (String) 


92
93
94
 
# File 'lib/fdx_v660_api/models/form1099_c.rb', line 92

def debt_description
  @debt_description
end

#error ⇒ Error2

Present if an error was encountered while retrieving this form

Returns:



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

def error
  @error
end

#fair_market_value ⇒ Float

Box 7, Fair market value of property

Returns:

  • (Float) 


105
106
107
 
# File 'lib/fdx_v660_api/models/form1099_c.rb', line 105

def fair_market_value
  @fair_market_value
end

#interest_included ⇒ Float

Box 3, Interest if included in box 2

Returns:

  • (Float) 


88
89
90
 
# File 'lib/fdx_v660_api/models/form1099_c.rb', line 88

def interest_included
  @interest_included
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/form1099_c.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/form1099_c.rb', line 72

def links
  @links
end

#personally_liable ⇒ TrueClass | FalseClass

Box 5, If checked, the debtor was personally liable for repayment of the debt

Returns:

  • (TrueClass | FalseClass) 


97
98
99
 
# File 'lib/fdx_v660_api/models/form1099_c.rb', line 97

def personally_liable
  @personally_liable
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/form1099_c.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/form1099_c.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/form1099_c.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/form1099_c.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/form1099_c.rb', line 15

def tax_year
  @tax_year
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
273
274
275
276
277
278
 
# File 'lib/fdx_v660_api/models/form1099_c.rb', line 200

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')
   = hash.key?('accountNumber') ? hash['accountNumber'] : SKIP
  date_of_event = hash.key?('dateOfEvent') ? hash['dateOfEvent'] : SKIP
  amount_discharged =
    hash.key?('amountDischarged') ? hash['amountDischarged'] : SKIP
  interest_included =
    hash.key?('interestIncluded') ? hash['interestIncluded'] : SKIP
  debt_description =
    hash.key?('debtDescription') ? hash['debtDescription'] : SKIP
  personally_liable =
    hash.key?('personallyLiable') ? hash['personallyLiable'] : SKIP
  debt_code = hash.key?('debtCode') ? hash['debtCode'] : SKIP
  fair_market_value =
    hash.key?('fairMarketValue') ? hash['fairMarketValue'] : 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.
  Form1099C.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,
                account_number: ,
                date_of_event: date_of_event,
                amount_discharged: amount_discharged,
                interest_included: interest_included,
                debt_description: debt_description,
                personally_liable: personally_liable,
                debt_code: debt_code,
                fair_market_value: fair_market_value,
                additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

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['account_number'] = 'accountNumber'
  @_hash['date_of_event'] = 'dateOfEvent'
  @_hash['amount_discharged'] = 'amountDischarged'
  @_hash['interest_included'] = 'interestIncluded'
  @_hash['debt_description'] = 'debtDescription'
  @_hash['personally_liable'] = 'personallyLiable'
  @_hash['debt_code'] = 'debtCode'
  @_hash['fair_market_value'] = 'fairMarketValue'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



160
161
162
 
# File 'lib/fdx_v660_api/models/form1099_c.rb', line 160

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

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
    account_number
    date_of_event
    amount_discharged
    interest_included
    debt_description
    personally_liable
    debt_code
    fair_market_value
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/fdx_v660_api/models/form1099_c.rb', line 295

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}, account_number: #{@account_number.inspect}, date_of_event:"\
  " #{@date_of_event.inspect}, amount_discharged: #{@amount_discharged.inspect},"\
  " interest_included: #{@interest_included.inspect}, debt_description:"\
  " #{@debt_description.inspect}, personally_liable: #{@personally_liable.inspect}, debt_code:"\
  " #{@debt_code.inspect}, fair_market_value: #{@fair_market_value.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/fdx_v660_api/models/form1099_c.rb', line 281

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}, account_number: #{@account_number}, date_of_event:"\
  " #{@date_of_event}, amount_discharged: #{@amount_discharged}, interest_included:"\
  " #{@interest_included}, debt_description: #{@debt_description}, personally_liable:"\
  " #{@personally_liable}, debt_code: #{@debt_code}, fair_market_value: #{@fair_market_value},"\
  " additional_properties: #{@additional_properties}>"
end