fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/form1099_patr.rb

@@ -0,0 +1,421 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Taxable Distributions Received From Cooperatives, from PAYER (1st-2nd boxes
+  # as issuer) to RECIPIENT (3rd-4th boxes)
+  class Form1099Patr < 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, Patronage dividends
+    # @return [Float]
+    attr_accessor :patronage_dividends
+
+    # Box 2, Nonpatronage distributions
+    # @return [Float]
+    attr_accessor :nonpatronage_distributions
+
+    # Box 3, Per-unit retain allocations
+    # @return [Float]
+    attr_accessor :per_unit_retain_allocations
+
+    # Box 4, Federal income tax withheld
+    # @return [Float]
+    attr_accessor :federal_tax_withheld
+
+    # Box 5, Redemption of nonqualified notices and retain allocations
+    # @return [Float]
+    attr_accessor :redemption
+
+    # Box 6, Section 199A(g) deduction
+    # @return [Float]
+    attr_accessor :section199_deduction
+
+    # Box 7, Qualified payments
+    # @return [Float]
+    attr_accessor :qualified_payments
+
+    # Box 8, Section 199A(a) qualified items
+    # @return [Float]
+    attr_accessor :section199_qualified_items
+
+    # Box 9, Section 199A(a) SSTB (Specified Service Trade or Business) items
+    # @return [Float]
+    attr_accessor :section199_sstb_items
+
+    # Box 10, Investment credit
+    # @return [Float]
+    attr_accessor :investment_credit
+
+    # Box 11, Work opportunity credit
+    # @return [Float]
+    attr_accessor :work_opportunity_credit
+
+    # Box 12, Other credits and deductions
+    # @return [Float]
+    attr_accessor :other_credits_and_deductions
+
+    # Box 13, Specified Cooperative
+    # @return [TrueClass | FalseClass]
+    attr_accessor :specified_coop
+
+    # State and Local tax withholding, from IRS's IRIS schema
+    # @return [StateAndLocalTaxWithholding2]
+    attr_accessor :state_and_local
+
+    # 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['account_number'] = 'accountNumber'
+      @_hash['patronage_dividends'] = 'patronageDividends'
+      @_hash['nonpatronage_distributions'] = 'nonpatronageDistributions'
+      @_hash['per_unit_retain_allocations'] = 'perUnitRetainAllocations'
+      @_hash['federal_tax_withheld'] = 'federalTaxWithheld'
+      @_hash['redemption'] = 'redemption'
+      @_hash['section199_deduction'] = 'section199Deduction'
+      @_hash['qualified_payments'] = 'qualifiedPayments'
+      @_hash['section199_qualified_items'] = 'section199QualifiedItems'
+      @_hash['section199_sstb_items'] = 'section199SstbItems'
+      @_hash['investment_credit'] = 'investmentCredit'
+      @_hash['work_opportunity_credit'] = 'workOpportunityCredit'
+      @_hash['other_credits_and_deductions'] = 'otherCreditsAndDeductions'
+      @_hash['specified_coop'] = 'specifiedCoop'
+      @_hash['state_and_local'] = 'stateAndLocal'
+      @_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
+        account_number
+        patronage_dividends
+        nonpatronage_distributions
+        per_unit_retain_allocations
+        federal_tax_withheld
+        redemption
+        section199_deduction
+        qualified_payments
+        section199_qualified_items
+        section199_sstb_items
+        investment_credit
+        work_opportunity_credit
+        other_credits_and_deductions
+        specified_coop
+        state_and_local
+        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, account_number: SKIP, patronage_dividends: SKIP,
+                   nonpatronage_distributions: SKIP,
+                   per_unit_retain_allocations: SKIP,
+                   federal_tax_withheld: SKIP, redemption: SKIP,
+                   section199_deduction: SKIP, qualified_payments: SKIP,
+                   section199_qualified_items: SKIP,
+                   section199_sstb_items: SKIP, investment_credit: SKIP,
+                   work_opportunity_credit: SKIP,
+                   other_credits_and_deductions: SKIP, specified_coop: 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 = 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
+      @patronage_dividends = patronage_dividends unless patronage_dividends == SKIP
+      unless nonpatronage_distributions == SKIP
+        @nonpatronage_distributions =
+          nonpatronage_distributions
+      end
+      unless per_unit_retain_allocations == SKIP
+        @per_unit_retain_allocations =
+          per_unit_retain_allocations
+      end
+      @federal_tax_withheld = federal_tax_withheld unless federal_tax_withheld == SKIP
+      @redemption = redemption unless redemption == SKIP
+      @section199_deduction = section199_deduction unless section199_deduction == SKIP
+      @qualified_payments = qualified_payments unless qualified_payments == SKIP
+      unless section199_qualified_items == SKIP
+        @section199_qualified_items =
+          section199_qualified_items
+      end
+      @section199_sstb_items = section199_sstb_items unless section199_sstb_items == SKIP
+      @investment_credit = investment_credit unless investment_credit == SKIP
+      @work_opportunity_credit = work_opportunity_credit unless work_opportunity_credit == SKIP
+      unless other_credits_and_deductions == SKIP
+        @other_credits_and_deductions =
+          other_credits_and_deductions
+      end
+      @specified_coop = specified_coop unless specified_coop == 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
+
+    # 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
+      patronage_dividends =
+        hash.key?('patronageDividends') ? hash['patronageDividends'] : SKIP
+      nonpatronage_distributions =
+        hash.key?('nonpatronageDistributions') ? hash['nonpatronageDistributions'] : SKIP
+      per_unit_retain_allocations =
+        hash.key?('perUnitRetainAllocations') ? hash['perUnitRetainAllocations'] : SKIP
+      federal_tax_withheld =
+        hash.key?('federalTaxWithheld') ? hash['federalTaxWithheld'] : SKIP
+      redemption = hash.key?('redemption') ? hash['redemption'] : SKIP
+      section199_deduction =
+        hash.key?('section199Deduction') ? hash['section199Deduction'] : SKIP
+      qualified_payments =
+        hash.key?('qualifiedPayments') ? hash['qualifiedPayments'] : SKIP
+      section199_qualified_items =
+        hash.key?('section199QualifiedItems') ? hash['section199QualifiedItems'] : SKIP
+      section199_sstb_items =
+        hash.key?('section199SstbItems') ? hash['section199SstbItems'] : SKIP
+      investment_credit =
+        hash.key?('investmentCredit') ? hash['investmentCredit'] : SKIP
+      work_opportunity_credit =
+        hash.key?('workOpportunityCredit') ? hash['workOpportunityCredit'] : SKIP
+      other_credits_and_deductions =
+        hash.key?('otherCreditsAndDeductions') ? hash['otherCreditsAndDeductions'] : SKIP
+      specified_coop = hash.key?('specifiedCoop') ? hash['specifiedCoop'] : SKIP
+      state_and_local = StateAndLocalTaxWithholding2.from_hash(hash['stateAndLocal']) if
+        hash['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.
+      Form1099Patr.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,
+                       patronage_dividends: patronage_dividends,
+                       nonpatronage_distributions: nonpatronage_distributions,
+                       per_unit_retain_allocations: per_unit_retain_allocations,
+                       federal_tax_withheld: federal_tax_withheld,
+                       redemption: redemption,
+                       section199_deduction: section199_deduction,
+                       qualified_payments: qualified_payments,
+                       section199_qualified_items: section199_qualified_items,
+                       section199_sstb_items: section199_sstb_items,
+                       investment_credit: investment_credit,
+                       work_opportunity_credit: work_opportunity_credit,
+                       other_credits_and_deductions: other_credits_and_deductions,
+                       specified_coop: specified_coop,
+                       state_and_local: state_and_local,
+                       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}, account_number: #{@account_number}, patronage_dividends:"\
+      " #{@patronage_dividends}, nonpatronage_distributions: #{@nonpatronage_distributions},"\
+      " per_unit_retain_allocations: #{@per_unit_retain_allocations}, federal_tax_withheld:"\
+      " #{@federal_tax_withheld}, redemption: #{@redemption}, section199_deduction:"\
+      " #{@section199_deduction}, qualified_payments: #{@qualified_payments},"\
+      " section199_qualified_items: #{@section199_qualified_items}, section199_sstb_items:"\
+      " #{@section199_sstb_items}, investment_credit: #{@investment_credit},"\
+      " work_opportunity_credit: #{@work_opportunity_credit}, other_credits_and_deductions:"\
+      " #{@other_credits_and_deductions}, specified_coop: #{@specified_coop}, state_and_local:"\
+      " #{@state_and_local}, 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}, account_number: #{@account_number.inspect}, patronage_dividends:"\
+      " #{@patronage_dividends.inspect}, nonpatronage_distributions:"\
+      " #{@nonpatronage_distributions.inspect}, per_unit_retain_allocations:"\
+      " #{@per_unit_retain_allocations.inspect}, federal_tax_withheld:"\
+      " #{@federal_tax_withheld.inspect}, redemption: #{@redemption.inspect},"\
+      " section199_deduction: #{@section199_deduction.inspect}, qualified_payments:"\
+      " #{@qualified_payments.inspect}, section199_qualified_items:"\
+      " #{@section199_qualified_items.inspect}, section199_sstb_items:"\
+      " #{@section199_sstb_items.inspect}, investment_credit: #{@investment_credit.inspect},"\
+      " work_opportunity_credit: #{@work_opportunity_credit.inspect},"\
+      " other_credits_and_deductions: #{@other_credits_and_deductions.inspect}, specified_coop:"\
+      " #{@specified_coop.inspect}, state_and_local: #{@state_and_local.inspect},"\
+      " second_tin_notice: #{@second_tin_notice.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end