fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/form1099_int.rb

@@ -0,0 +1,488 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Interest Income, from PAYER (1st-2nd boxes as issuer) to RECIPIENT (3rd-4th
+  # boxes)
+  class Form1099Int < 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
+
+    # FATCA filing requirement
+    # @return [TrueClass | FalseClass]
+    attr_accessor :foreign_account_tax_compliance
+
+    # Account number
+    # @return [String]
+    attr_accessor :account_number
+
+    # Payer's RTN
+    # @return [String]
+    attr_accessor :payer_rtn
+
+    # Box 1, Interest income
+    # @return [Float]
+    attr_accessor :interest_income
+
+    # Box 2, Early withdrawal penalty
+    # @return [Float]
+    attr_accessor :early_withdrawal_penalty
+
+    # Box 3, Interest on U.S. Savings Bonds and Treasury obligations
+    # @return [Float]
+    attr_accessor :us_bond_interest
+
+    # Box 4, Federal income tax withheld
+    # @return [Float]
+    attr_accessor :federal_tax_withheld
+
+    # Box 5, Investment expenses
+    # @return [Float]
+    attr_accessor :investment_expenses
+
+    # Box 6, Foreign tax paid
+    # @return [Float]
+    attr_accessor :foreign_tax_paid
+
+    # Box 7, Foreign country or U.S. possession
+    # @return [String]
+    attr_accessor :foreign_country
+
+    # Box 8, Tax-exempt interest
+    # @return [Float]
+    attr_accessor :tax_exempt_interest
+
+    # Box 9, Specified private activity bond interest
+    # @return [Float]
+    attr_accessor :specified_pab_interest
+
+    # Box 10, Market discount
+    # @return [Float]
+    attr_accessor :market_discount
+
+    # Box 11, Bond premium
+    # @return [Float]
+    attr_accessor :bond_premium
+
+    # Box 12, Bond premium on Treasury obligations
+    # @return [Float]
+    attr_accessor :us_bond_premium
+
+    # Box 13, Bond premium on tax-exempt bond
+    # @return [Float]
+    attr_accessor :tax_exempt_bond_premium
+
+    # Box 14, Tax-exempt bond CUSIP no.
+    # @return [String]
+    attr_accessor :cusip_number
+
+    # Boxes 15-17, State and Local tax withholding
+    # @return [Array[StateAndLocalTaxWithholding]]
+    attr_accessor :state_and_local
+
+    # Supplemental foreign income amount information (description is country)
+    # @return [Array[DescriptionAndAmount]]
+    attr_accessor :foreign_incomes
+
+    # Supplemental tax-exempt income by state (description is state)
+    # @return [Array[DescriptionAndAmount]]
+    attr_accessor :state_tax_exempt_income
+
+    # Second TIN Notice
+    # @return [TrueClass | FalseClass]
+    attr_accessor :second_tin_notice
+
+    # 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['foreign_account_tax_compliance'] = 'foreignAccountTaxCompliance'
+      @_hash['account_number'] = 'accountNumber'
+      @_hash['payer_rtn'] = 'payerRtn'
+      @_hash['interest_income'] = 'interestIncome'
+      @_hash['early_withdrawal_penalty'] = 'earlyWithdrawalPenalty'
+      @_hash['us_bond_interest'] = 'usBondInterest'
+      @_hash['federal_tax_withheld'] = 'federalTaxWithheld'
+      @_hash['investment_expenses'] = 'investmentExpenses'
+      @_hash['foreign_tax_paid'] = 'foreignTaxPaid'
+      @_hash['foreign_country'] = 'foreignCountry'
+      @_hash['tax_exempt_interest'] = 'taxExemptInterest'
+      @_hash['specified_pab_interest'] = 'specifiedPabInterest'
+      @_hash['market_discount'] = 'marketDiscount'
+      @_hash['bond_premium'] = 'bondPremium'
+      @_hash['us_bond_premium'] = 'usBondPremium'
+      @_hash['tax_exempt_bond_premium'] = 'taxExemptBondPremium'
+      @_hash['cusip_number'] = 'cusipNumber'
+      @_hash['state_and_local'] = 'stateAndLocal'
+      @_hash['foreign_incomes'] = 'foreignIncomes'
+      @_hash['state_tax_exempt_income'] = 'stateTaxExemptIncome'
+      @_hash['second_tin_notice'] = 'secondTinNotice'
+      @_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
+        foreign_account_tax_compliance
+        account_number
+        payer_rtn
+        interest_income
+        early_withdrawal_penalty
+        us_bond_interest
+        federal_tax_withheld
+        investment_expenses
+        foreign_tax_paid
+        foreign_country
+        tax_exempt_interest
+        specified_pab_interest
+        market_discount
+        bond_premium
+        us_bond_premium
+        tax_exempt_bond_premium
+        cusip_number
+        state_and_local
+        foreign_incomes
+        state_tax_exempt_income
+        second_tin_notice
+      ]
+    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, foreign_account_tax_compliance: SKIP,
+                   account_number: SKIP, payer_rtn: SKIP, interest_income: SKIP,
+                   early_withdrawal_penalty: SKIP, us_bond_interest: SKIP,
+                   federal_tax_withheld: SKIP, investment_expenses: SKIP,
+                   foreign_tax_paid: SKIP, foreign_country: SKIP,
+                   tax_exempt_interest: SKIP, specified_pab_interest: SKIP,
+                   market_discount: SKIP, bond_premium: SKIP,
+                   us_bond_premium: SKIP, tax_exempt_bond_premium: SKIP,
+                   cusip_number: SKIP, state_and_local: SKIP,
+                   foreign_incomes: SKIP, state_tax_exempt_income: 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 = 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
+      unless foreign_account_tax_compliance == SKIP
+        @foreign_account_tax_compliance =
+          foreign_account_tax_compliance
+      end
+      @account_number = account_number unless account_number == SKIP
+      @payer_rtn = payer_rtn unless payer_rtn == SKIP
+      @interest_income = interest_income unless interest_income == SKIP
+      @early_withdrawal_penalty = early_withdrawal_penalty unless early_withdrawal_penalty == SKIP
+      @us_bond_interest = us_bond_interest unless us_bond_interest == SKIP
+      @federal_tax_withheld = federal_tax_withheld unless federal_tax_withheld == SKIP
+      @investment_expenses = investment_expenses unless investment_expenses == SKIP
+      @foreign_tax_paid = foreign_tax_paid unless foreign_tax_paid == SKIP
+      @foreign_country = foreign_country unless foreign_country == SKIP
+      @tax_exempt_interest = tax_exempt_interest unless tax_exempt_interest == SKIP
+      @specified_pab_interest = specified_pab_interest unless specified_pab_interest == SKIP
+      @market_discount = market_discount unless market_discount == SKIP
+      @bond_premium = bond_premium unless bond_premium == SKIP
+      @us_bond_premium = us_bond_premium unless us_bond_premium == SKIP
+      @tax_exempt_bond_premium = tax_exempt_bond_premium unless tax_exempt_bond_premium == SKIP
+      @cusip_number = cusip_number unless cusip_number == SKIP
+      @state_and_local = state_and_local unless state_and_local == SKIP
+      @foreign_incomes = foreign_incomes unless foreign_incomes == SKIP
+      @state_tax_exempt_income = state_tax_exempt_income unless state_tax_exempt_income == SKIP
+      @second_tin_notice = second_tin_notice unless second_tin_notice == 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')
+      foreign_account_tax_compliance =
+        hash.key?('foreignAccountTaxCompliance') ? hash['foreignAccountTaxCompliance'] : SKIP
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : SKIP
+      payer_rtn = hash.key?('payerRtn') ? hash['payerRtn'] : SKIP
+      interest_income =
+        hash.key?('interestIncome') ? hash['interestIncome'] : SKIP
+      early_withdrawal_penalty =
+        hash.key?('earlyWithdrawalPenalty') ? hash['earlyWithdrawalPenalty'] : SKIP
+      us_bond_interest =
+        hash.key?('usBondInterest') ? hash['usBondInterest'] : SKIP
+      federal_tax_withheld =
+        hash.key?('federalTaxWithheld') ? hash['federalTaxWithheld'] : SKIP
+      investment_expenses =
+        hash.key?('investmentExpenses') ? hash['investmentExpenses'] : SKIP
+      foreign_tax_paid =
+        hash.key?('foreignTaxPaid') ? hash['foreignTaxPaid'] : SKIP
+      foreign_country =
+        hash.key?('foreignCountry') ? hash['foreignCountry'] : SKIP
+      tax_exempt_interest =
+        hash.key?('taxExemptInterest') ? hash['taxExemptInterest'] : SKIP
+      specified_pab_interest =
+        hash.key?('specifiedPabInterest') ? hash['specifiedPabInterest'] : SKIP
+      market_discount =
+        hash.key?('marketDiscount') ? hash['marketDiscount'] : SKIP
+      bond_premium = hash.key?('bondPremium') ? hash['bondPremium'] : SKIP
+      us_bond_premium =
+        hash.key?('usBondPremium') ? hash['usBondPremium'] : SKIP
+      tax_exempt_bond_premium =
+        hash.key?('taxExemptBondPremium') ? hash['taxExemptBondPremium'] : SKIP
+      cusip_number = hash.key?('cusipNumber') ? hash['cusipNumber'] : 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')
+      # Parameter is an array, so we need to iterate through it
+      foreign_incomes = nil
+      unless hash['foreignIncomes'].nil?
+        foreign_incomes = []
+        hash['foreignIncomes'].each do |structure|
+          foreign_incomes << (DescriptionAndAmount.from_hash(structure) if structure)
+        end
+      end
+
+      foreign_incomes = SKIP unless hash.key?('foreignIncomes')
+      # Parameter is an array, so we need to iterate through it
+      state_tax_exempt_income = nil
+      unless hash['stateTaxExemptIncome'].nil?
+        state_tax_exempt_income = []
+        hash['stateTaxExemptIncome'].each do |structure|
+          state_tax_exempt_income << (DescriptionAndAmount.from_hash(structure) if structure)
+        end
+      end
+
+      state_tax_exempt_income = SKIP unless hash.key?('stateTaxExemptIncome')
+      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.
+      Form1099Int.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,
+                      foreign_account_tax_compliance: foreign_account_tax_compliance,
+                      account_number: account_number,
+                      payer_rtn: payer_rtn,
+                      interest_income: interest_income,
+                      early_withdrawal_penalty: early_withdrawal_penalty,
+                      us_bond_interest: us_bond_interest,
+                      federal_tax_withheld: federal_tax_withheld,
+                      investment_expenses: investment_expenses,
+                      foreign_tax_paid: foreign_tax_paid,
+                      foreign_country: foreign_country,
+                      tax_exempt_interest: tax_exempt_interest,
+                      specified_pab_interest: specified_pab_interest,
+                      market_discount: market_discount,
+                      bond_premium: bond_premium,
+                      us_bond_premium: us_bond_premium,
+                      tax_exempt_bond_premium: tax_exempt_bond_premium,
+                      cusip_number: cusip_number,
+                      state_and_local: state_and_local,
+                      foreign_incomes: foreign_incomes,
+                      state_tax_exempt_income: state_tax_exempt_income,
+                      second_tin_notice: second_tin_notice,
+                      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}, foreign_account_tax_compliance:"\
+      " #{@foreign_account_tax_compliance}, account_number: #{@account_number}, payer_rtn:"\
+      " #{@payer_rtn}, interest_income: #{@interest_income}, early_withdrawal_penalty:"\
+      " #{@early_withdrawal_penalty}, us_bond_interest: #{@us_bond_interest},"\
+      " federal_tax_withheld: #{@federal_tax_withheld}, investment_expenses:"\
+      " #{@investment_expenses}, foreign_tax_paid: #{@foreign_tax_paid}, foreign_country:"\
+      " #{@foreign_country}, tax_exempt_interest: #{@tax_exempt_interest}, specified_pab_interest:"\
+      " #{@specified_pab_interest}, market_discount: #{@market_discount}, bond_premium:"\
+      " #{@bond_premium}, us_bond_premium: #{@us_bond_premium}, tax_exempt_bond_premium:"\
+      " #{@tax_exempt_bond_premium}, cusip_number: #{@cusip_number}, state_and_local:"\
+      " #{@state_and_local}, foreign_incomes: #{@foreign_incomes}, state_tax_exempt_income:"\
+      " #{@state_tax_exempt_income}, second_tin_notice: #{@second_tin_notice},"\
+      " 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}, foreign_account_tax_compliance:"\
+      " #{@foreign_account_tax_compliance.inspect}, account_number: #{@account_number.inspect},"\
+      " payer_rtn: #{@payer_rtn.inspect}, interest_income: #{@interest_income.inspect},"\
+      " early_withdrawal_penalty: #{@early_withdrawal_penalty.inspect}, us_bond_interest:"\
+      " #{@us_bond_interest.inspect}, federal_tax_withheld: #{@federal_tax_withheld.inspect},"\
+      " investment_expenses: #{@investment_expenses.inspect}, foreign_tax_paid:"\
+      " #{@foreign_tax_paid.inspect}, foreign_country: #{@foreign_country.inspect},"\
+      " tax_exempt_interest: #{@tax_exempt_interest.inspect}, specified_pab_interest:"\
+      " #{@specified_pab_interest.inspect}, market_discount: #{@market_discount.inspect},"\
+      " bond_premium: #{@bond_premium.inspect}, us_bond_premium: #{@us_bond_premium.inspect},"\
+      " tax_exempt_bond_premium: #{@tax_exempt_bond_premium.inspect}, cusip_number:"\
+      " #{@cusip_number.inspect}, state_and_local: #{@state_and_local.inspect}, foreign_incomes:"\
+      " #{@foreign_incomes.inspect}, state_tax_exempt_income: #{@state_tax_exempt_income.inspect},"\
+      " second_tin_notice: #{@second_tin_notice.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end