fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/form1099_misc.rb

@@ -0,0 +1,438 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Miscellaneous Income, from PAYER (1st-2nd boxes as issuer) to RECIPIENT
+  # (3rd-4th boxes)
+  class Form1099Misc < 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, Rents
+    # @return [Float]
+    attr_accessor :rents
+
+    # Box 2, Royalties
+    # @return [Float]
+    attr_accessor :royalties
+
+    # Box 3, Other income
+    # @return [Float]
+    attr_accessor :other_income
+
+    # Box 4, Federal income tax withheld
+    # @return [Float]
+    attr_accessor :federal_tax_withheld
+
+    # Box 5, Fishing boat proceeds
+    # @return [Float]
+    attr_accessor :fishing_boat_proceeds
+
+    # Box 6, Medical and health care payments
+    # @return [Float]
+    attr_accessor :medical_health_payment
+
+    # Box 7, Payer made direct sales of $5,000 or more of consumer products to a
+    # buyer (recipient) for resale
+    # @return [TrueClass | FalseClass]
+    attr_accessor :payer_direct_sales
+
+    # Box 8, Substitute payments in lieu of dividends or interest
+    # @return [Float]
+    attr_accessor :substitute_payments
+
+    # Box 9, Crop insurance proceeds
+    # @return [Float]
+    attr_accessor :crop_insurance
+
+    # Second TIN Notice
+    # @return [TrueClass | FalseClass]
+    attr_accessor :second_tin_notice
+
+    # Box 10, Gross proceeds paid to an attorney
+    # @return [Float]
+    attr_accessor :gross_attorney
+
+    # Box 11, Fish purchased for resale
+    # @return [Float]
+    attr_accessor :fish_purchased
+
+    # Box 12, Section 409A deferrals
+    # @return [Float]
+    attr_accessor :section409_a_deferrals
+
+    # Box 13, FATCA filing requirement
+    # @return [TrueClass | FalseClass]
+    attr_accessor :foreign_account_tax_compliance
+
+    # Box 14, Excess golden parachute payments
+    # @return [Float]
+    attr_accessor :excess_golden
+
+    # Box 15, Nonqualified Deferred Compensation
+    # @return [Float]
+    attr_accessor :non_qualified_deferred_compensation
+
+    # Boxes 16-18, 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['account_number'] = 'accountNumber'
+      @_hash['rents'] = 'rents'
+      @_hash['royalties'] = 'royalties'
+      @_hash['other_income'] = 'otherIncome'
+      @_hash['federal_tax_withheld'] = 'federalTaxWithheld'
+      @_hash['fishing_boat_proceeds'] = 'fishingBoatProceeds'
+      @_hash['medical_health_payment'] = 'medicalHealthPayment'
+      @_hash['payer_direct_sales'] = 'payerDirectSales'
+      @_hash['substitute_payments'] = 'substitutePayments'
+      @_hash['crop_insurance'] = 'cropInsurance'
+      @_hash['second_tin_notice'] = 'secondTinNotice'
+      @_hash['gross_attorney'] = 'grossAttorney'
+      @_hash['fish_purchased'] = 'fishPurchased'
+      @_hash['section409_a_deferrals'] = 'section409ADeferrals'
+      @_hash['foreign_account_tax_compliance'] = 'foreignAccountTaxCompliance'
+      @_hash['excess_golden'] = 'excessGolden'
+      @_hash['non_qualified_deferred_compensation'] =
+        'nonQualifiedDeferredCompensation'
+      @_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
+        account_number
+        rents
+        royalties
+        other_income
+        federal_tax_withheld
+        fishing_boat_proceeds
+        medical_health_payment
+        payer_direct_sales
+        substitute_payments
+        crop_insurance
+        second_tin_notice
+        gross_attorney
+        fish_purchased
+        section409_a_deferrals
+        foreign_account_tax_compliance
+        excess_golden
+        non_qualified_deferred_compensation
+        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, account_number: SKIP, rents: SKIP,
+                   royalties: SKIP, other_income: SKIP,
+                   federal_tax_withheld: SKIP, fishing_boat_proceeds: SKIP,
+                   medical_health_payment: SKIP, payer_direct_sales: SKIP,
+                   substitute_payments: SKIP, crop_insurance: SKIP,
+                   second_tin_notice: SKIP, gross_attorney: SKIP,
+                   fish_purchased: SKIP, section409_a_deferrals: SKIP,
+                   foreign_account_tax_compliance: SKIP, excess_golden: SKIP,
+                   non_qualified_deferred_compensation: 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
+      @account_number = account_number unless account_number == SKIP
+      @rents = rents unless rents == SKIP
+      @royalties = royalties unless royalties == SKIP
+      @other_income = other_income unless other_income == SKIP
+      @federal_tax_withheld = federal_tax_withheld unless federal_tax_withheld == SKIP
+      @fishing_boat_proceeds = fishing_boat_proceeds unless fishing_boat_proceeds == SKIP
+      @medical_health_payment = medical_health_payment unless medical_health_payment == SKIP
+      @payer_direct_sales = payer_direct_sales unless payer_direct_sales == SKIP
+      @substitute_payments = substitute_payments unless substitute_payments == SKIP
+      @crop_insurance = crop_insurance unless crop_insurance == SKIP
+      @second_tin_notice = second_tin_notice unless second_tin_notice == SKIP
+      @gross_attorney = gross_attorney unless gross_attorney == SKIP
+      @fish_purchased = fish_purchased unless fish_purchased == SKIP
+      @section409_a_deferrals = section409_a_deferrals unless section409_a_deferrals == SKIP
+      unless foreign_account_tax_compliance == SKIP
+        @foreign_account_tax_compliance =
+          foreign_account_tax_compliance
+      end
+      @excess_golden = excess_golden unless excess_golden == SKIP
+      unless non_qualified_deferred_compensation == SKIP
+        @non_qualified_deferred_compensation =
+          non_qualified_deferred_compensation
+      end
+      @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')
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : SKIP
+      rents = hash.key?('rents') ? hash['rents'] : SKIP
+      royalties = hash.key?('royalties') ? hash['royalties'] : SKIP
+      other_income = hash.key?('otherIncome') ? hash['otherIncome'] : SKIP
+      federal_tax_withheld =
+        hash.key?('federalTaxWithheld') ? hash['federalTaxWithheld'] : SKIP
+      fishing_boat_proceeds =
+        hash.key?('fishingBoatProceeds') ? hash['fishingBoatProceeds'] : SKIP
+      medical_health_payment =
+        hash.key?('medicalHealthPayment') ? hash['medicalHealthPayment'] : SKIP
+      payer_direct_sales =
+        hash.key?('payerDirectSales') ? hash['payerDirectSales'] : SKIP
+      substitute_payments =
+        hash.key?('substitutePayments') ? hash['substitutePayments'] : SKIP
+      crop_insurance = hash.key?('cropInsurance') ? hash['cropInsurance'] : SKIP
+      second_tin_notice =
+        hash.key?('secondTinNotice') ? hash['secondTinNotice'] : SKIP
+      gross_attorney = hash.key?('grossAttorney') ? hash['grossAttorney'] : SKIP
+      fish_purchased = hash.key?('fishPurchased') ? hash['fishPurchased'] : SKIP
+      section409_a_deferrals =
+        hash.key?('section409ADeferrals') ? hash['section409ADeferrals'] : SKIP
+      foreign_account_tax_compliance =
+        hash.key?('foreignAccountTaxCompliance') ? hash['foreignAccountTaxCompliance'] : SKIP
+      excess_golden = hash.key?('excessGolden') ? hash['excessGolden'] : SKIP
+      non_qualified_deferred_compensation =
+        hash.key?('nonQualifiedDeferredCompensation') ? hash['nonQualifiedDeferredCompensation'] : 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.
+      Form1099Misc.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,
+                       rents: rents,
+                       royalties: royalties,
+                       other_income: other_income,
+                       federal_tax_withheld: federal_tax_withheld,
+                       fishing_boat_proceeds: fishing_boat_proceeds,
+                       medical_health_payment: medical_health_payment,
+                       payer_direct_sales: payer_direct_sales,
+                       substitute_payments: substitute_payments,
+                       crop_insurance: crop_insurance,
+                       second_tin_notice: second_tin_notice,
+                       gross_attorney: gross_attorney,
+                       fish_purchased: fish_purchased,
+                       section409_a_deferrals: section409_a_deferrals,
+                       foreign_account_tax_compliance: foreign_account_tax_compliance,
+                       excess_golden: excess_golden,
+                       non_qualified_deferred_compensation: non_qualified_deferred_compensation,
+                       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}, account_number: #{@account_number}, rents: #{@rents},"\
+      " royalties: #{@royalties}, other_income: #{@other_income}, federal_tax_withheld:"\
+      " #{@federal_tax_withheld}, fishing_boat_proceeds: #{@fishing_boat_proceeds},"\
+      " medical_health_payment: #{@medical_health_payment}, payer_direct_sales:"\
+      " #{@payer_direct_sales}, substitute_payments: #{@substitute_payments}, crop_insurance:"\
+      " #{@crop_insurance}, second_tin_notice: #{@second_tin_notice}, gross_attorney:"\
+      " #{@gross_attorney}, fish_purchased: #{@fish_purchased}, section409_a_deferrals:"\
+      " #{@section409_a_deferrals}, foreign_account_tax_compliance:"\
+      " #{@foreign_account_tax_compliance}, excess_golden: #{@excess_golden},"\
+      " non_qualified_deferred_compensation: #{@non_qualified_deferred_compensation},"\
+      " 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}, account_number: #{@account_number.inspect}, rents:"\
+      " #{@rents.inspect}, royalties: #{@royalties.inspect}, other_income:"\
+      " #{@other_income.inspect}, federal_tax_withheld: #{@federal_tax_withheld.inspect},"\
+      " fishing_boat_proceeds: #{@fishing_boat_proceeds.inspect}, medical_health_payment:"\
+      " #{@medical_health_payment.inspect}, payer_direct_sales: #{@payer_direct_sales.inspect},"\
+      " substitute_payments: #{@substitute_payments.inspect}, crop_insurance:"\
+      " #{@crop_insurance.inspect}, second_tin_notice: #{@second_tin_notice.inspect},"\
+      " gross_attorney: #{@gross_attorney.inspect}, fish_purchased: #{@fish_purchased.inspect},"\
+      " section409_a_deferrals: #{@section409_a_deferrals.inspect},"\
+      " foreign_account_tax_compliance: #{@foreign_account_tax_compliance.inspect}, excess_golden:"\
+      " #{@excess_golden.inspect}, non_qualified_deferred_compensation:"\
+      " #{@non_qualified_deferred_compensation.inspect}, state_and_local:"\
+      " #{@state_and_local.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end