fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/form1099_r.rb

@@ -0,0 +1,475 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Distributions from Pensions, Annuities, Retirement or Profit-Sharing Plans,
+  # IRAs, Insurance Contracts, etc., from PAYER (1st-2nd boxes as issuer) to
+  # RECIPIENT (3rd-4th boxes)
+  class Form1099R < 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
+
+    # Box 10, Amount allocable to IRR within 5 years
+    # @return [Float]
+    attr_accessor :allocable_to_irr
+
+    # Box 11, First year of designated Roth contributions. A four-digit year.
+    # (Like `TaxYear` definition, but lower minimum since first year of Roth
+    # IRAs was 1997)
+    # @return [Integer]
+    attr_accessor :first_year_of_roth
+
+    # Account number
+    # @return [String]
+    attr_accessor :recipient_account_number
+
+    # Box 1, Gross distribution
+    # @return [Float]
+    attr_accessor :gross_distribution
+
+    # Box 2a, Taxable amount
+    # @return [Float]
+    attr_accessor :taxable_amount
+
+    # Box 2b, Taxable amount not determined
+    # @return [TrueClass | FalseClass]
+    attr_accessor :taxable_amount_not_determined
+
+    # Box 2c, Total distribution
+    # @return [TrueClass | FalseClass]
+    attr_accessor :total_distribution
+
+    # Box 3, Capital gain
+    # @return [Float]
+    attr_accessor :capital_gain
+
+    # Box 4, Federal income tax withheld
+    # @return [Float]
+    attr_accessor :federal_tax_withheld
+
+    # Box 5, Employee contributions
+    # @return [Float]
+    attr_accessor :employee_contributions
+
+    # Box 6, Net unrealized appreciation
+    # @return [Float]
+    attr_accessor :net_unrealized_appreciation
+
+    # Box 7, Distribution codes
+    # @return [Array[String]]
+    attr_accessor :distribution_codes
+
+    # Box 7b, IRA/SEP/SIMPLE
+    # @return [TrueClass | FalseClass]
+    attr_accessor :ira_sep_simple
+
+    # Box 8, Other
+    # @return [Float]
+    attr_accessor :other_amount
+
+    # Box 8, Other percent
+    # @return [Float]
+    attr_accessor :other_percent
+
+    # Box 9a, Your percent of total distribution
+    # @return [Float]
+    attr_accessor :your_percent_of_total
+
+    # Box 9b, Total employee contributions
+    # @return [Float]
+    attr_accessor :total_employee_contributions
+
+    # Box 12, FATCA filing requirement
+    # @return [TrueClass | FalseClass]
+    attr_accessor :foreign_account_tax_compliance
+
+    # Box 13, Date of payment
+    # @return [Date]
+    attr_accessor :date_of_payment
+
+    # Boxes 14-19, State and Local tax withholding
+    # @return [Array[StateAndLocalTaxWithholding]]
+    attr_accessor :state_and_local
+
+    # 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['allocable_to_irr'] = 'allocableToIRR'
+      @_hash['first_year_of_roth'] = 'firstYearOfRoth'
+      @_hash['recipient_account_number'] = 'recipientAccountNumber'
+      @_hash['gross_distribution'] = 'grossDistribution'
+      @_hash['taxable_amount'] = 'taxableAmount'
+      @_hash['taxable_amount_not_determined'] = 'taxableAmountNotDetermined'
+      @_hash['total_distribution'] = 'totalDistribution'
+      @_hash['capital_gain'] = 'capitalGain'
+      @_hash['federal_tax_withheld'] = 'federalTaxWithheld'
+      @_hash['employee_contributions'] = 'employeeContributions'
+      @_hash['net_unrealized_appreciation'] = 'netUnrealizedAppreciation'
+      @_hash['distribution_codes'] = 'distributionCodes'
+      @_hash['ira_sep_simple'] = 'iraSepSimple'
+      @_hash['other_amount'] = 'otherAmount'
+      @_hash['other_percent'] = 'otherPercent'
+      @_hash['your_percent_of_total'] = 'yourPercentOfTotal'
+      @_hash['total_employee_contributions'] = 'totalEmployeeContributions'
+      @_hash['foreign_account_tax_compliance'] = 'foreignAccountTaxCompliance'
+      @_hash['date_of_payment'] = 'dateOfPayment'
+      @_hash['state_and_local'] = 'stateAndLocal'
+      @_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
+        allocable_to_irr
+        first_year_of_roth
+        recipient_account_number
+        gross_distribution
+        taxable_amount
+        taxable_amount_not_determined
+        total_distribution
+        capital_gain
+        federal_tax_withheld
+        employee_contributions
+        net_unrealized_appreciation
+        distribution_codes
+        ira_sep_simple
+        other_amount
+        other_percent
+        your_percent_of_total
+        total_employee_contributions
+        foreign_account_tax_compliance
+        date_of_payment
+        state_and_local
+      ]
+    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, allocable_to_irr: SKIP,
+                   first_year_of_roth: SKIP, recipient_account_number: SKIP,
+                   gross_distribution: SKIP, taxable_amount: SKIP,
+                   taxable_amount_not_determined: SKIP,
+                   total_distribution: SKIP, capital_gain: SKIP,
+                   federal_tax_withheld: SKIP, employee_contributions: SKIP,
+                   net_unrealized_appreciation: SKIP, distribution_codes: SKIP,
+                   ira_sep_simple: SKIP, other_amount: SKIP,
+                   other_percent: SKIP, your_percent_of_total: SKIP,
+                   total_employee_contributions: SKIP,
+                   foreign_account_tax_compliance: SKIP, date_of_payment: SKIP,
+                   state_and_local: 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
+      @allocable_to_irr = allocable_to_irr unless allocable_to_irr == SKIP
+      @first_year_of_roth = first_year_of_roth unless first_year_of_roth == SKIP
+      @recipient_account_number = recipient_account_number unless recipient_account_number == SKIP
+      @gross_distribution = gross_distribution unless gross_distribution == SKIP
+      @taxable_amount = taxable_amount unless taxable_amount == SKIP
+      unless taxable_amount_not_determined == SKIP
+        @taxable_amount_not_determined =
+          taxable_amount_not_determined
+      end
+      @total_distribution = total_distribution unless total_distribution == SKIP
+      @capital_gain = capital_gain unless capital_gain == SKIP
+      @federal_tax_withheld = federal_tax_withheld unless federal_tax_withheld == SKIP
+      @employee_contributions = employee_contributions unless employee_contributions == SKIP
+      unless net_unrealized_appreciation == SKIP
+        @net_unrealized_appreciation =
+          net_unrealized_appreciation
+      end
+      @distribution_codes = distribution_codes unless distribution_codes == SKIP
+      @ira_sep_simple = ira_sep_simple unless ira_sep_simple == SKIP
+      @other_amount = other_amount unless other_amount == SKIP
+      @other_percent = other_percent unless other_percent == SKIP
+      @your_percent_of_total = your_percent_of_total unless your_percent_of_total == SKIP
+      unless total_employee_contributions == SKIP
+        @total_employee_contributions =
+          total_employee_contributions
+      end
+      unless foreign_account_tax_compliance == SKIP
+        @foreign_account_tax_compliance =
+          foreign_account_tax_compliance
+      end
+      @date_of_payment = date_of_payment unless date_of_payment == SKIP
+      @state_and_local = state_and_local unless state_and_local == 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')
+      allocable_to_irr =
+        hash.key?('allocableToIRR') ? hash['allocableToIRR'] : SKIP
+      first_year_of_roth =
+        hash.key?('firstYearOfRoth') ? hash['firstYearOfRoth'] : SKIP
+      recipient_account_number =
+        hash.key?('recipientAccountNumber') ? hash['recipientAccountNumber'] : SKIP
+      gross_distribution =
+        hash.key?('grossDistribution') ? hash['grossDistribution'] : SKIP
+      taxable_amount = hash.key?('taxableAmount') ? hash['taxableAmount'] : SKIP
+      taxable_amount_not_determined =
+        hash.key?('taxableAmountNotDetermined') ? hash['taxableAmountNotDetermined'] : SKIP
+      total_distribution =
+        hash.key?('totalDistribution') ? hash['totalDistribution'] : SKIP
+      capital_gain = hash.key?('capitalGain') ? hash['capitalGain'] : SKIP
+      federal_tax_withheld =
+        hash.key?('federalTaxWithheld') ? hash['federalTaxWithheld'] : SKIP
+      employee_contributions =
+        hash.key?('employeeContributions') ? hash['employeeContributions'] : SKIP
+      net_unrealized_appreciation =
+        hash.key?('netUnrealizedAppreciation') ? hash['netUnrealizedAppreciation'] : SKIP
+      distribution_codes =
+        hash.key?('distributionCodes') ? hash['distributionCodes'] : SKIP
+      ira_sep_simple = hash.key?('iraSepSimple') ? hash['iraSepSimple'] : SKIP
+      other_amount = hash.key?('otherAmount') ? hash['otherAmount'] : SKIP
+      other_percent = hash.key?('otherPercent') ? hash['otherPercent'] : SKIP
+      your_percent_of_total =
+        hash.key?('yourPercentOfTotal') ? hash['yourPercentOfTotal'] : SKIP
+      total_employee_contributions =
+        hash.key?('totalEmployeeContributions') ? hash['totalEmployeeContributions'] : SKIP
+      foreign_account_tax_compliance =
+        hash.key?('foreignAccountTaxCompliance') ? hash['foreignAccountTaxCompliance'] : SKIP
+      date_of_payment =
+        hash.key?('dateOfPayment') ? hash['dateOfPayment'] : SKIP
+      # 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')
+
+      # 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.
+      Form1099R.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,
+                    allocable_to_irr: allocable_to_irr,
+                    first_year_of_roth: first_year_of_roth,
+                    recipient_account_number: recipient_account_number,
+                    gross_distribution: gross_distribution,
+                    taxable_amount: taxable_amount,
+                    taxable_amount_not_determined: taxable_amount_not_determined,
+                    total_distribution: total_distribution,
+                    capital_gain: capital_gain,
+                    federal_tax_withheld: federal_tax_withheld,
+                    employee_contributions: employee_contributions,
+                    net_unrealized_appreciation: net_unrealized_appreciation,
+                    distribution_codes: distribution_codes,
+                    ira_sep_simple: ira_sep_simple,
+                    other_amount: other_amount,
+                    other_percent: other_percent,
+                    your_percent_of_total: your_percent_of_total,
+                    total_employee_contributions: total_employee_contributions,
+                    foreign_account_tax_compliance: foreign_account_tax_compliance,
+                    date_of_payment: date_of_payment,
+                    state_and_local: state_and_local,
+                    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}, allocable_to_irr: #{@allocable_to_irr}, first_year_of_roth:"\
+      " #{@first_year_of_roth}, recipient_account_number: #{@recipient_account_number},"\
+      " gross_distribution: #{@gross_distribution}, taxable_amount: #{@taxable_amount},"\
+      " taxable_amount_not_determined: #{@taxable_amount_not_determined}, total_distribution:"\
+      " #{@total_distribution}, capital_gain: #{@capital_gain}, federal_tax_withheld:"\
+      " #{@federal_tax_withheld}, employee_contributions: #{@employee_contributions},"\
+      " net_unrealized_appreciation: #{@net_unrealized_appreciation}, distribution_codes:"\
+      " #{@distribution_codes}, ira_sep_simple: #{@ira_sep_simple}, other_amount:"\
+      " #{@other_amount}, other_percent: #{@other_percent}, your_percent_of_total:"\
+      " #{@your_percent_of_total}, total_employee_contributions: #{@total_employee_contributions},"\
+      " foreign_account_tax_compliance: #{@foreign_account_tax_compliance}, date_of_payment:"\
+      " #{@date_of_payment}, state_and_local: #{@state_and_local}, 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}, allocable_to_irr: #{@allocable_to_irr.inspect},"\
+      " first_year_of_roth: #{@first_year_of_roth.inspect}, recipient_account_number:"\
+      " #{@recipient_account_number.inspect}, gross_distribution: #{@gross_distribution.inspect},"\
+      " taxable_amount: #{@taxable_amount.inspect}, taxable_amount_not_determined:"\
+      " #{@taxable_amount_not_determined.inspect}, total_distribution:"\
+      " #{@total_distribution.inspect}, capital_gain: #{@capital_gain.inspect},"\
+      " federal_tax_withheld: #{@federal_tax_withheld.inspect}, employee_contributions:"\
+      " #{@employee_contributions.inspect}, net_unrealized_appreciation:"\
+      " #{@net_unrealized_appreciation.inspect}, distribution_codes:"\
+      " #{@distribution_codes.inspect}, ira_sep_simple: #{@ira_sep_simple.inspect}, other_amount:"\
+      " #{@other_amount.inspect}, other_percent: #{@other_percent.inspect}, your_percent_of_total:"\
+      " #{@your_percent_of_total.inspect}, total_employee_contributions:"\
+      " #{@total_employee_contributions.inspect}, foreign_account_tax_compliance:"\
+      " #{@foreign_account_tax_compliance.inspect}, date_of_payment: #{@date_of_payment.inspect},"\
+      " state_and_local: #{@state_and_local.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end