fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/form54981.rb

@@ -0,0 +1,485 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # IRA Contribution Information
+  class Form54981 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Year for which taxes are being paid
+    # @return [Integer]
+    attr_accessor :tax_year
+
+    # True to indicate this is a corrected tax form
+    # @return [TrueClass | FalseClass]
+    attr_accessor :corrected
+
+    # Long-term persistent identity of the source account. Not the account
+    # number
+    # @return [String]
+    attr_accessor :account_id
+
+    # 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.
+    # @return [String]
+    attr_accessor :tax_form_id
+
+    # Date of production or delivery of the tax form
+    # @return [Date]
+    attr_accessor :tax_form_date
+
+    # Additional explanation text or content about this tax form
+    # @return [String]
+    attr_accessor :additional_information
+
+    # Enumerated name of the tax form entity e.g. "TaxW2"
+    # @return [TypeFormType1]
+    attr_accessor :tax_form_type
+
+    # 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.
+    # @return [TaxParty8]
+    attr_accessor :issuer
+
+    # 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.
+    # @return [TaxParty1]
+    attr_accessor :recipient
+
+    # 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.
+    # @return [Array[TaxFormAttribute]]
+    attr_accessor :attributes
+
+    # Present if an error was encountered while retrieving this form
+    # @return [Error1]
+    attr_accessor :error
+
+    # Links to retrieve this form as data or image, or to invoke other APIs
+    # @return [Array[HateoasLink]]
+    attr_accessor :links
+
+    # Account number
+    # @return [String]
+    attr_accessor :account_number
+
+    # Box 1, IRA contributions
+    # @return [Float]
+    attr_accessor :ira_contributions
+
+    # Box 2, Rollover contributions
+    # @return [Float]
+    attr_accessor :rollover_contributions
+
+    # Box 3, Roth IRA conversion amount
+    # @return [Float]
+    attr_accessor :roth_ira_conversion
+
+    # Box 4, Recharacterized contributions
+    # @return [Float]
+    attr_accessor :recharacterized_contributions
+
+    # Box 5, Fair market value of account
+    # @return [Float]
+    attr_accessor :fair_market_value
+
+    # Box 6, Life insurance cost included in box 1
+    # @return [Float]
+    attr_accessor :life_insurance_cost
+
+    # Box 7a, IRA
+    # @return [TrueClass | FalseClass]
+    attr_accessor :ira
+
+    # Box 7b, SEP
+    # @return [TrueClass | FalseClass]
+    attr_accessor :sep
+
+    # Box 7c, SIMPLE
+    # @return [TrueClass | FalseClass]
+    attr_accessor :simple
+
+    # Box 7d, Roth IRA
+    # @return [TrueClass | FalseClass]
+    attr_accessor :roth_ira
+
+    # Box 8, SEP contributions
+    # @return [Float]
+    attr_accessor :sep_contributions
+
+    # Box 9, SIMPLE contributions
+    # @return [Float]
+    attr_accessor :simple_contributions
+
+    # Box 10, Roth IRA contributions
+    # @return [Float]
+    attr_accessor :roth_ira_contributions
+
+    # Box 11, If checked, required minimum distribution for next year
+    # @return [TrueClass | FalseClass]
+    attr_accessor :rmd_next_year
+
+    # Box 12a, RMD date
+    # @return [Date]
+    attr_accessor :rmd_date
+
+    # Box 12b, RMD amount
+    # @return [Float]
+    attr_accessor :rmd_amount
+
+    # Box 13a, Postponed contribution
+    # @return [Float]
+    attr_accessor :postponed_contribution
+
+    # Box 13b, Year
+    # @return [Integer]
+    attr_accessor :postponed_year
+
+    # Box 13c, Code
+    # @return [String]
+    attr_accessor :postponed_code
+
+    # Box 14a, Repayments
+    # @return [Float]
+    attr_accessor :repayments
+
+    # Box 14b, Code
+    # @return [String]
+    attr_accessor :repay_code
+
+    # Box 15a, FMV of certain specified assets
+    # @return [Float]
+    attr_accessor :fmv_specified_assets
+
+    # Box 15b, Code(s)
+    # @return [String]
+    attr_accessor :specified_codes
+
+    # A mapping from model property names to API property names.
+    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['ira_contributions'] = 'iraContributions'
+      @_hash['rollover_contributions'] = 'rolloverContributions'
+      @_hash['roth_ira_conversion'] = 'rothIraConversion'
+      @_hash['recharacterized_contributions'] = 'recharacterizedContributions'
+      @_hash['fair_market_value'] = 'fairMarketValue'
+      @_hash['life_insurance_cost'] = 'lifeInsuranceCost'
+      @_hash['ira'] = 'ira'
+      @_hash['sep'] = 'sep'
+      @_hash['simple'] = 'simple'
+      @_hash['roth_ira'] = 'rothIra'
+      @_hash['sep_contributions'] = 'sepContributions'
+      @_hash['simple_contributions'] = 'simpleContributions'
+      @_hash['roth_ira_contributions'] = 'rothIraContributions'
+      @_hash['rmd_next_year'] = 'rmdNextYear'
+      @_hash['rmd_date'] = 'rmdDate'
+      @_hash['rmd_amount'] = 'rmdAmount'
+      @_hash['postponed_contribution'] = 'postponedContribution'
+      @_hash['postponed_year'] = 'postponedYear'
+      @_hash['postponed_code'] = 'postponedCode'
+      @_hash['repayments'] = 'repayments'
+      @_hash['repay_code'] = 'repayCode'
+      @_hash['fmv_specified_assets'] = 'fmvSpecifiedAssets'
+      @_hash['specified_codes'] = 'specifiedCodes'
+      @_hash
+    end
+
+    # An array for optional fields
+    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
+        ira_contributions
+        rollover_contributions
+        roth_ira_conversion
+        recharacterized_contributions
+        fair_market_value
+        life_insurance_cost
+        ira
+        sep
+        simple
+        roth_ira
+        sep_contributions
+        simple_contributions
+        roth_ira_contributions
+        rmd_next_year
+        rmd_date
+        rmd_amount
+        postponed_contribution
+        postponed_year
+        postponed_code
+        repayments
+        repay_code
+        fmv_specified_assets
+        specified_codes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    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, ira_contributions: SKIP,
+                   rollover_contributions: SKIP, roth_ira_conversion: SKIP,
+                   recharacterized_contributions: SKIP, fair_market_value: SKIP,
+                   life_insurance_cost: SKIP, ira: SKIP, sep: SKIP,
+                   simple: SKIP, roth_ira: SKIP, sep_contributions: SKIP,
+                   simple_contributions: SKIP, roth_ira_contributions: SKIP,
+                   rmd_next_year: SKIP, rmd_date: SKIP, rmd_amount: SKIP,
+                   postponed_contribution: SKIP, postponed_year: SKIP,
+                   postponed_code: SKIP, repayments: SKIP, repay_code: SKIP,
+                   fmv_specified_assets: SKIP, specified_codes: 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 = account_id unless account_id == 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 = account_number unless account_number == SKIP
+      @ira_contributions = ira_contributions unless ira_contributions == SKIP
+      @rollover_contributions = rollover_contributions unless rollover_contributions == SKIP
+      @roth_ira_conversion = roth_ira_conversion unless roth_ira_conversion == SKIP
+      unless recharacterized_contributions == SKIP
+        @recharacterized_contributions =
+          recharacterized_contributions
+      end
+      @fair_market_value = fair_market_value unless fair_market_value == SKIP
+      @life_insurance_cost = life_insurance_cost unless life_insurance_cost == SKIP
+      @ira = ira unless ira == SKIP
+      @sep = sep unless sep == SKIP
+      @simple = simple unless simple == SKIP
+      @roth_ira = roth_ira unless roth_ira == SKIP
+      @sep_contributions = sep_contributions unless sep_contributions == SKIP
+      @simple_contributions = simple_contributions unless simple_contributions == SKIP
+      @roth_ira_contributions = roth_ira_contributions unless roth_ira_contributions == SKIP
+      @rmd_next_year = rmd_next_year unless rmd_next_year == SKIP
+      @rmd_date = rmd_date unless rmd_date == SKIP
+      @rmd_amount = rmd_amount unless rmd_amount == SKIP
+      @postponed_contribution = postponed_contribution unless postponed_contribution == SKIP
+      @postponed_year = postponed_year unless postponed_year == SKIP
+      @postponed_code = postponed_code unless postponed_code == SKIP
+      @repayments = repayments unless repayments == SKIP
+      @repay_code = repay_code unless repay_code == SKIP
+      @fmv_specified_assets = fmv_specified_assets unless fmv_specified_assets == SKIP
+      @specified_codes = specified_codes unless specified_codes == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    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
+      account_id = 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 = Error1.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')
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : SKIP
+      ira_contributions =
+        hash.key?('iraContributions') ? hash['iraContributions'] : SKIP
+      rollover_contributions =
+        hash.key?('rolloverContributions') ? hash['rolloverContributions'] : SKIP
+      roth_ira_conversion =
+        hash.key?('rothIraConversion') ? hash['rothIraConversion'] : SKIP
+      recharacterized_contributions =
+        hash.key?('recharacterizedContributions') ? hash['recharacterizedContributions'] : SKIP
+      fair_market_value =
+        hash.key?('fairMarketValue') ? hash['fairMarketValue'] : SKIP
+      life_insurance_cost =
+        hash.key?('lifeInsuranceCost') ? hash['lifeInsuranceCost'] : SKIP
+      ira = hash.key?('ira') ? hash['ira'] : SKIP
+      sep = hash.key?('sep') ? hash['sep'] : SKIP
+      simple = hash.key?('simple') ? hash['simple'] : SKIP
+      roth_ira = hash.key?('rothIra') ? hash['rothIra'] : SKIP
+      sep_contributions =
+        hash.key?('sepContributions') ? hash['sepContributions'] : SKIP
+      simple_contributions =
+        hash.key?('simpleContributions') ? hash['simpleContributions'] : SKIP
+      roth_ira_contributions =
+        hash.key?('rothIraContributions') ? hash['rothIraContributions'] : SKIP
+      rmd_next_year = hash.key?('rmdNextYear') ? hash['rmdNextYear'] : SKIP
+      rmd_date = hash.key?('rmdDate') ? hash['rmdDate'] : SKIP
+      rmd_amount = hash.key?('rmdAmount') ? hash['rmdAmount'] : SKIP
+      postponed_contribution =
+        hash.key?('postponedContribution') ? hash['postponedContribution'] : SKIP
+      postponed_year = hash.key?('postponedYear') ? hash['postponedYear'] : SKIP
+      postponed_code = hash.key?('postponedCode') ? hash['postponedCode'] : SKIP
+      repayments = hash.key?('repayments') ? hash['repayments'] : SKIP
+      repay_code = hash.key?('repayCode') ? hash['repayCode'] : SKIP
+      fmv_specified_assets =
+        hash.key?('fmvSpecifiedAssets') ? hash['fmvSpecifiedAssets'] : SKIP
+      specified_codes =
+        hash.key?('specifiedCodes') ? hash['specifiedCodes'] : 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.
+      Form54981.new(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,
+                    ira_contributions: ira_contributions,
+                    rollover_contributions: rollover_contributions,
+                    roth_ira_conversion: roth_ira_conversion,
+                    recharacterized_contributions: recharacterized_contributions,
+                    fair_market_value: fair_market_value,
+                    life_insurance_cost: life_insurance_cost,
+                    ira: ira,
+                    sep: sep,
+                    simple: simple,
+                    roth_ira: roth_ira,
+                    sep_contributions: sep_contributions,
+                    simple_contributions: simple_contributions,
+                    roth_ira_contributions: roth_ira_contributions,
+                    rmd_next_year: rmd_next_year,
+                    rmd_date: rmd_date,
+                    rmd_amount: rmd_amount,
+                    postponed_contribution: postponed_contribution,
+                    postponed_year: postponed_year,
+                    postponed_code: postponed_code,
+                    repayments: repayments,
+                    repay_code: repay_code,
+                    fmv_specified_assets: fmv_specified_assets,
+                    specified_codes: specified_codes,
+                    additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    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}, ira_contributions:"\
+      " #{@ira_contributions}, rollover_contributions: #{@rollover_contributions},"\
+      " roth_ira_conversion: #{@roth_ira_conversion}, recharacterized_contributions:"\
+      " #{@recharacterized_contributions}, fair_market_value: #{@fair_market_value},"\
+      " life_insurance_cost: #{@life_insurance_cost}, ira: #{@ira}, sep: #{@sep}, simple:"\
+      " #{@simple}, roth_ira: #{@roth_ira}, sep_contributions: #{@sep_contributions},"\
+      " simple_contributions: #{@simple_contributions}, roth_ira_contributions:"\
+      " #{@roth_ira_contributions}, rmd_next_year: #{@rmd_next_year}, rmd_date: #{@rmd_date},"\
+      " rmd_amount: #{@rmd_amount}, postponed_contribution: #{@postponed_contribution},"\
+      " postponed_year: #{@postponed_year}, postponed_code: #{@postponed_code}, repayments:"\
+      " #{@repayments}, repay_code: #{@repay_code}, fmv_specified_assets:"\
+      " #{@fmv_specified_assets}, specified_codes: #{@specified_codes}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    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}, ira_contributions:"\
+      " #{@ira_contributions.inspect}, rollover_contributions: #{@rollover_contributions.inspect},"\
+      " roth_ira_conversion: #{@roth_ira_conversion.inspect}, recharacterized_contributions:"\
+      " #{@recharacterized_contributions.inspect}, fair_market_value:"\
+      " #{@fair_market_value.inspect}, life_insurance_cost: #{@life_insurance_cost.inspect}, ira:"\
+      " #{@ira.inspect}, sep: #{@sep.inspect}, simple: #{@simple.inspect}, roth_ira:"\
+      " #{@roth_ira.inspect}, sep_contributions: #{@sep_contributions.inspect},"\
+      " simple_contributions: #{@simple_contributions.inspect}, roth_ira_contributions:"\
+      " #{@roth_ira_contributions.inspect}, rmd_next_year: #{@rmd_next_year.inspect}, rmd_date:"\
+      " #{@rmd_date.inspect}, rmd_amount: #{@rmd_amount.inspect}, postponed_contribution:"\
+      " #{@postponed_contribution.inspect}, postponed_year: #{@postponed_year.inspect},"\
+      " postponed_code: #{@postponed_code.inspect}, repayments: #{@repayments.inspect},"\
+      " repay_code: #{@repay_code.inspect}, fmv_specified_assets:"\
+      " #{@fmv_specified_assets.inspect}, specified_codes: #{@specified_codes.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end