Class: FdxV660Api::Form1099K

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

Overview

Merchant Card and Third-Party Network Payments, from FILER (1st-8th, 11th boxes as issuer) to PAYEE (12th-19th 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, payment_settlement_entity: SKIP, electronic_payment_facilitator: SKIP, payment_card: SKIP, third_party_network: SKIP, pse_name: SKIP, pse_phone: SKIP, account_number: SKIP, gross_amount: SKIP, card_not_present: SKIP, tips: SKIP, occupation_codes: SKIP, merchant_category_code: SKIP, number_of_transactions: SKIP, federal_tax_withheld: SKIP, month_amounts: SKIP, state_and_local: SKIP, second_tin_notice: SKIP, additional_properties: nil) ⇒ Form1099K

Returns a new instance of Form1099K.



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

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, payment_settlement_entity: SKIP,
               electronic_payment_facilitator: SKIP, payment_card: SKIP,
               third_party_network: SKIP, pse_name: SKIP, pse_phone: SKIP,
               account_number: SKIP, gross_amount: SKIP,
               card_not_present: SKIP, tips: SKIP, occupation_codes: SKIP,
               merchant_category_code: SKIP, number_of_transactions: SKIP,
               federal_tax_withheld: SKIP, month_amounts: SKIP,
               state_and_local: SKIP, second_tin_notice: 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
  unless payment_settlement_entity == SKIP
    @payment_settlement_entity =
      payment_settlement_entity
  end
  unless electronic_payment_facilitator == SKIP
    @electronic_payment_facilitator =
      electronic_payment_facilitator
  end
  @payment_card = payment_card unless payment_card == SKIP
  @third_party_network = third_party_network unless third_party_network == SKIP
  @pse_name = pse_name unless pse_name == SKIP
  @pse_phone = pse_phone unless pse_phone == SKIP
  @account_number =  unless  == SKIP
  @gross_amount = gross_amount unless gross_amount == SKIP
  @card_not_present = card_not_present unless card_not_present == SKIP
  @tips = tips unless tips == SKIP
  @occupation_codes = occupation_codes unless occupation_codes == SKIP
  @merchant_category_code = merchant_category_code unless merchant_category_code == SKIP
  @number_of_transactions = number_of_transactions unless number_of_transactions == SKIP
  @federal_tax_withheld = federal_tax_withheld unless federal_tax_withheld == SKIP
  @month_amounts = month_amounts unless month_amounts == SKIP
  @state_and_local = state_and_local unless state_and_local == SKIP
  @second_tin_notice = second_tin_notice unless second_tin_notice == 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_k.rb', line 24

def 
  @account_id
end

#account_number ⇒ String

Account number

Returns:

  • (String) 


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

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_k.rb', line 38

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:



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

def attributes
  @attributes
end

#card_not_present ⇒ Float

Box 1b, Card Not Present Transactions

Returns:

  • (Float) 


109
110
111
 
# File 'lib/fdx_v660_api/models/form1099_k.rb', line 109

def card_not_present
  @card_not_present
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_k.rb', line 19

def corrected
  @corrected
end

#electronic_payment_facilitator ⇒ TrueClass | FalseClass

Check to indicate if FILER is an Electronic Payment Facilitator (EPF) / Other third party

Returns:

  • (TrueClass | FalseClass) 


81
82
83
 
# File 'lib/fdx_v660_api/models/form1099_k.rb', line 81

def electronic_payment_facilitator
  @electronic_payment_facilitator
end

#error ⇒ Error2

Present if an error was encountered while retrieving this form

Returns:



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

def error
  @error
end

#federal_tax_withheld ⇒ Float

Box 4, Federal income tax withheld

Returns:

  • (Float) 


129
130
131
 
# File 'lib/fdx_v660_api/models/form1099_k.rb', line 129

def federal_tax_withheld
  @federal_tax_withheld
end

#gross_amount ⇒ Float

Box 1a, Gross amount of payment card/third party network transactions

Returns:

  • (Float) 


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

def gross_amount
  @gross_amount
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_k.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_k.rb', line 72

def links
  @links
end

#merchant_category_code ⇒ String

Box 2, Merchant category code

Returns:

  • (String) 


121
122
123
 
# File 'lib/fdx_v660_api/models/form1099_k.rb', line 121

def merchant_category_code
  @merchant_category_code
end

#month_amounts ⇒ Array[MonthAndAmount]

Box 5, Monthly amounts

Returns:



133
134
135
 
# File 'lib/fdx_v660_api/models/form1099_k.rb', line 133

def month_amounts
  @month_amounts
end

#number_of_transactions ⇒ Float

Box 3, Number of payment transactions

Returns:

  • (Float) 


125
126
127
 
# File 'lib/fdx_v660_api/models/form1099_k.rb', line 125

def number_of_transactions
  @number_of_transactions
end

#occupation_codes ⇒ Array[String]

Box 1d, Treasury Tipped Occupation Codes (TTOC)

Returns:

  • (Array[String]) 


117
118
119
 
# File 'lib/fdx_v660_api/models/form1099_k.rb', line 117

def occupation_codes
  @occupation_codes
end

#payment_card ⇒ TrueClass | FalseClass

Check to indicate transactions reported are: Payment card

Returns:

  • (TrueClass | FalseClass) 


85
86
87
 
# File 'lib/fdx_v660_api/models/form1099_k.rb', line 85

def payment_card
  @payment_card
end

#payment_settlement_entity ⇒ TrueClass | FalseClass

Check to indicate if FILER is a Payment Settlement Entity (PSE)

Returns:

  • (TrueClass | FalseClass) 


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

def payment_settlement_entity
  @payment_settlement_entity
end

#pse_name ⇒ String

PSE's name

Returns:

  • (String) 


93
94
95
 
# File 'lib/fdx_v660_api/models/form1099_k.rb', line 93

def pse_name
  @pse_name
end

#pse_phone ⇒ TelephoneNumberPlusExtension3

PSE's phone number

Returns:



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

def pse_phone
  @pse_phone
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_k.rb', line 54

def recipient
  @recipient
end

#second_tin_notice ⇒ TrueClass | FalseClass

Second TIN Notice

Returns:

  • (TrueClass | FalseClass) 


141
142
143
 
# File 'lib/fdx_v660_api/models/form1099_k.rb', line 141

def second_tin_notice
  @second_tin_notice
end

#state_and_local ⇒ Array[StateAndLocalTaxWithholding]

Boxes 6-8, State and Local tax withholding

Returns:



137
138
139
 
# File 'lib/fdx_v660_api/models/form1099_k.rb', line 137

def state_and_local
  @state_and_local
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_k.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_k.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_k.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_k.rb', line 15

def tax_year
  @tax_year
end

#third_party_network ⇒ TrueClass | FalseClass

Check to indicate transactions reported are: Third party network

Returns:

  • (TrueClass | FalseClass) 


89
90
91
 
# File 'lib/fdx_v660_api/models/form1099_k.rb', line 89

def third_party_network
  @third_party_network
end

#tips ⇒ Float

Box 1c, Cash tips

Returns:

  • (Float) 


113
114
115
 
# File 'lib/fdx_v660_api/models/form1099_k.rb', line 113

def tips
  @tips
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

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')
  payment_settlement_entity =
    hash.key?('paymentSettlementEntity') ? hash['paymentSettlementEntity'] : SKIP
  electronic_payment_facilitator =
    hash.key?('electronicPaymentFacilitator') ? hash['electronicPaymentFacilitator'] : SKIP
  payment_card = hash.key?('paymentCard') ? hash['paymentCard'] : SKIP
  third_party_network =
    hash.key?('thirdPartyNetwork') ? hash['thirdPartyNetwork'] : SKIP
  pse_name = hash.key?('pseName') ? hash['pseName'] : SKIP
  pse_phone = TelephoneNumberPlusExtension3.from_hash(hash['psePhone']) if hash['psePhone']
   = hash.key?('accountNumber') ? hash['accountNumber'] : SKIP
  gross_amount = hash.key?('grossAmount') ? hash['grossAmount'] : SKIP
  card_not_present =
    hash.key?('cardNotPresent') ? hash['cardNotPresent'] : SKIP
  tips = hash.key?('tips') ? hash['tips'] : SKIP
  occupation_codes =
    hash.key?('occupationCodes') ? hash['occupationCodes'] : SKIP
  merchant_category_code =
    hash.key?('merchantCategoryCode') ? hash['merchantCategoryCode'] : SKIP
  number_of_transactions =
    hash.key?('numberOfTransactions') ? hash['numberOfTransactions'] : SKIP
  federal_tax_withheld =
    hash.key?('federalTaxWithheld') ? hash['federalTaxWithheld'] : SKIP
  # Parameter is an array, so we need to iterate through it
  month_amounts = nil
  unless hash['monthAmounts'].nil?
    month_amounts = []
    hash['monthAmounts'].each do |structure|
      month_amounts << (MonthAndAmount.from_hash(structure) if structure)
    end
  end

  month_amounts = SKIP unless hash.key?('monthAmounts')
  # Parameter is an array, so we need to iterate through it
  state_and_local = nil
  unless hash['stateAndLocal'].nil?
    state_and_local = []
    hash['stateAndLocal'].each do |structure|
      state_and_local << (StateAndLocalTaxWithholding.from_hash(structure) if structure)
    end
  end

  state_and_local = SKIP unless hash.key?('stateAndLocal')
  second_tin_notice =
    hash.key?('secondTinNotice') ? hash['secondTinNotice'] : 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.
  Form1099K.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,
                payment_settlement_entity: payment_settlement_entity,
                electronic_payment_facilitator: electronic_payment_facilitator,
                payment_card: payment_card,
                third_party_network: third_party_network,
                pse_name: pse_name,
                pse_phone: pse_phone,
                account_number: ,
                gross_amount: gross_amount,
                card_not_present: card_not_present,
                tips: tips,
                occupation_codes: occupation_codes,
                merchant_category_code: merchant_category_code,
                number_of_transactions: number_of_transactions,
                federal_tax_withheld: federal_tax_withheld,
                month_amounts: month_amounts,
                state_and_local: state_and_local,
                second_tin_notice: second_tin_notice,
                additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/fdx_v660_api/models/form1099_k.rb', line 144

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['payment_settlement_entity'] = 'paymentSettlementEntity'
  @_hash['electronic_payment_facilitator'] =
    'electronicPaymentFacilitator'
  @_hash['payment_card'] = 'paymentCard'
  @_hash['third_party_network'] = 'thirdPartyNetwork'
  @_hash['pse_name'] = 'pseName'
  @_hash['pse_phone'] = 'psePhone'
  @_hash['account_number'] = 'accountNumber'
  @_hash['gross_amount'] = 'grossAmount'
  @_hash['card_not_present'] = 'cardNotPresent'
  @_hash['tips'] = 'tips'
  @_hash['occupation_codes'] = 'occupationCodes'
  @_hash['merchant_category_code'] = 'merchantCategoryCode'
  @_hash['number_of_transactions'] = 'numberOfTransactions'
  @_hash['federal_tax_withheld'] = 'federalTaxWithheld'
  @_hash['month_amounts'] = 'monthAmounts'
  @_hash['state_and_local'] = 'stateAndLocal'
  @_hash['second_tin_notice'] = 'secondTinNotice'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



215
216
217
 
# File 'lib/fdx_v660_api/models/form1099_k.rb', line 215

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

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
    payment_settlement_entity
    electronic_payment_facilitator
    payment_card
    third_party_network
    pse_name
    pse_phone
    account_number
    gross_amount
    card_not_present
    tips
    occupation_codes
    merchant_category_code
    number_of_transactions
    federal_tax_withheld
    month_amounts
    state_and_local
    second_tin_notice
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/fdx_v660_api/models/form1099_k.rb', line 414

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}, payment_settlement_entity:"\
  " #{@payment_settlement_entity.inspect}, electronic_payment_facilitator:"\
  " #{@electronic_payment_facilitator.inspect}, payment_card: #{@payment_card.inspect},"\
  " third_party_network: #{@third_party_network.inspect}, pse_name: #{@pse_name.inspect},"\
  " pse_phone: #{@pse_phone.inspect}, account_number: #{@account_number.inspect},"\
  " gross_amount: #{@gross_amount.inspect}, card_not_present: #{@card_not_present.inspect},"\
  " tips: #{@tips.inspect}, occupation_codes: #{@occupation_codes.inspect},"\
  " merchant_category_code: #{@merchant_category_code.inspect}, number_of_transactions:"\
  " #{@number_of_transactions.inspect}, federal_tax_withheld:"\
  " #{@federal_tax_withheld.inspect}, month_amounts: #{@month_amounts.inspect},"\
  " state_and_local: #{@state_and_local.inspect}, second_tin_notice:"\
  " #{@second_tin_notice.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/fdx_v660_api/models/form1099_k.rb', line 395

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}, payment_settlement_entity: #{@payment_settlement_entity},"\
  " electronic_payment_facilitator: #{@electronic_payment_facilitator}, payment_card:"\
  " #{@payment_card}, third_party_network: #{@third_party_network}, pse_name: #{@pse_name},"\
  " pse_phone: #{@pse_phone}, account_number: #{@account_number}, gross_amount:"\
  " #{@gross_amount}, card_not_present: #{@card_not_present}, tips: #{@tips},"\
  " occupation_codes: #{@occupation_codes}, merchant_category_code:"\
  " #{@merchant_category_code}, number_of_transactions: #{@number_of_transactions},"\
  " federal_tax_withheld: #{@federal_tax_withheld}, month_amounts: #{@month_amounts},"\
  " state_and_local: #{@state_and_local}, second_tin_notice: #{@second_tin_notice},"\
  " additional_properties: #{@additional_properties}>"
end