fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/form_w2.rb

@@ -0,0 +1,459 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Wage and Tax Statement, from Employer (boxes b-c as issuer) to Employee
+  # (boxes a, e-f as recipient)
+  class FormW2 < 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
+
+    # Control number
+    # @return [String]
+    attr_accessor :control_number
+
+    # Box 1, Wages, tips, other compensation
+    # @return [Float]
+    attr_accessor :wages
+
+    # Box 2, Federal income tax withheld
+    # @return [Float]
+    attr_accessor :federal_tax_withheld
+
+    # Box 3, Social security wages
+    # @return [Float]
+    attr_accessor :social_security_wages
+
+    # Box 4, Social security tax withheld
+    # @return [Float]
+    attr_accessor :social_security_tax_withheld
+
+    # Box 5, Medicare wages and tips
+    # @return [Float]
+    attr_accessor :medicare_wages
+
+    # Box 6, Medicare tax withheld
+    # @return [Float]
+    attr_accessor :medicare_tax_withheld
+
+    # Box 7, Social security tips
+    # @return [Float]
+    attr_accessor :social_security_tips
+
+    # Box 8, Allocated tips
+    # @return [Float]
+    attr_accessor :allocated_tips
+
+    # Box 10, Dependent care benefits
+    # @return [Float]
+    attr_accessor :dependent_care_benefit
+
+    # Box 11, Nonqualified plans
+    # @return [Float]
+    attr_accessor :non_qualified_plan
+
+    # Box 12, Codes and amounts
+    # @return [Array[CodeAndAmount]]
+    attr_accessor :codes
+
+    # Box 13, Statutory employee
+    # @return [TrueClass | FalseClass]
+    attr_accessor :statutory
+
+    # Box 13, Retirement plan
+    # @return [TrueClass | FalseClass]
+    attr_accessor :retirement_plan
+
+    # Box 13, Third-party sick pay
+    # @return [TrueClass | FalseClass]
+    attr_accessor :third_party_sick_pay
+
+    # Employee Stock Purchase Plan Qualified Disposition amount
+    # @return [Float]
+    attr_accessor :espp_qualified
+
+    # Employee Stock Purchase Plan Nonqualified Disposition amount
+    # @return [Float]
+    attr_accessor :espp_non_qualified
+
+    # Box 14, Other descriptions and amounts
+    # @return [Array[DescriptionAndAmount]]
+    attr_accessor :other
+
+    # Boxes 15-20, 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['control_number'] = 'controlNumber'
+      @_hash['wages'] = 'wages'
+      @_hash['federal_tax_withheld'] = 'federalTaxWithheld'
+      @_hash['social_security_wages'] = 'socialSecurityWages'
+      @_hash['social_security_tax_withheld'] = 'socialSecurityTaxWithheld'
+      @_hash['medicare_wages'] = 'medicareWages'
+      @_hash['medicare_tax_withheld'] = 'medicareTaxWithheld'
+      @_hash['social_security_tips'] = 'socialSecurityTips'
+      @_hash['allocated_tips'] = 'allocatedTips'
+      @_hash['dependent_care_benefit'] = 'dependentCareBenefit'
+      @_hash['non_qualified_plan'] = 'nonQualifiedPlan'
+      @_hash['codes'] = 'codes'
+      @_hash['statutory'] = 'statutory'
+      @_hash['retirement_plan'] = 'retirementPlan'
+      @_hash['third_party_sick_pay'] = 'thirdPartySickPay'
+      @_hash['espp_qualified'] = 'esppQualified'
+      @_hash['espp_non_qualified'] = 'esppNonQualified'
+      @_hash['other'] = 'other'
+      @_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
+        control_number
+        wages
+        federal_tax_withheld
+        social_security_wages
+        social_security_tax_withheld
+        medicare_wages
+        medicare_tax_withheld
+        social_security_tips
+        allocated_tips
+        dependent_care_benefit
+        non_qualified_plan
+        codes
+        statutory
+        retirement_plan
+        third_party_sick_pay
+        espp_qualified
+        espp_non_qualified
+        other
+        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, control_number: SKIP, wages: SKIP,
+                   federal_tax_withheld: SKIP, social_security_wages: SKIP,
+                   social_security_tax_withheld: SKIP, medicare_wages: SKIP,
+                   medicare_tax_withheld: SKIP, social_security_tips: SKIP,
+                   allocated_tips: SKIP, dependent_care_benefit: SKIP,
+                   non_qualified_plan: SKIP, codes: SKIP, statutory: SKIP,
+                   retirement_plan: SKIP, third_party_sick_pay: SKIP,
+                   espp_qualified: SKIP, espp_non_qualified: SKIP, other: 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
+      @control_number = control_number unless control_number == SKIP
+      @wages = wages unless wages == SKIP
+      @federal_tax_withheld = federal_tax_withheld unless federal_tax_withheld == SKIP
+      @social_security_wages = social_security_wages unless social_security_wages == SKIP
+      unless social_security_tax_withheld == SKIP
+        @social_security_tax_withheld =
+          social_security_tax_withheld
+      end
+      @medicare_wages = medicare_wages unless medicare_wages == SKIP
+      @medicare_tax_withheld = medicare_tax_withheld unless medicare_tax_withheld == SKIP
+      @social_security_tips = social_security_tips unless social_security_tips == SKIP
+      @allocated_tips = allocated_tips unless allocated_tips == SKIP
+      @dependent_care_benefit = dependent_care_benefit unless dependent_care_benefit == SKIP
+      @non_qualified_plan = non_qualified_plan unless non_qualified_plan == SKIP
+      @codes = codes unless codes == SKIP
+      @statutory = statutory unless statutory == SKIP
+      @retirement_plan = retirement_plan unless retirement_plan == SKIP
+      @third_party_sick_pay = third_party_sick_pay unless third_party_sick_pay == SKIP
+      @espp_qualified = espp_qualified unless espp_qualified == SKIP
+      @espp_non_qualified = espp_non_qualified unless espp_non_qualified == SKIP
+      @other = other unless other == 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')
+      control_number = hash.key?('controlNumber') ? hash['controlNumber'] : SKIP
+      wages = hash.key?('wages') ? hash['wages'] : SKIP
+      federal_tax_withheld =
+        hash.key?('federalTaxWithheld') ? hash['federalTaxWithheld'] : SKIP
+      social_security_wages =
+        hash.key?('socialSecurityWages') ? hash['socialSecurityWages'] : SKIP
+      social_security_tax_withheld =
+        hash.key?('socialSecurityTaxWithheld') ? hash['socialSecurityTaxWithheld'] : SKIP
+      medicare_wages = hash.key?('medicareWages') ? hash['medicareWages'] : SKIP
+      medicare_tax_withheld =
+        hash.key?('medicareTaxWithheld') ? hash['medicareTaxWithheld'] : SKIP
+      social_security_tips =
+        hash.key?('socialSecurityTips') ? hash['socialSecurityTips'] : SKIP
+      allocated_tips = hash.key?('allocatedTips') ? hash['allocatedTips'] : SKIP
+      dependent_care_benefit =
+        hash.key?('dependentCareBenefit') ? hash['dependentCareBenefit'] : SKIP
+      non_qualified_plan =
+        hash.key?('nonQualifiedPlan') ? hash['nonQualifiedPlan'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      codes = nil
+      unless hash['codes'].nil?
+        codes = []
+        hash['codes'].each do |structure|
+          codes << (CodeAndAmount.from_hash(structure) if structure)
+        end
+      end
+
+      codes = SKIP unless hash.key?('codes')
+      statutory = hash.key?('statutory') ? hash['statutory'] : SKIP
+      retirement_plan =
+        hash.key?('retirementPlan') ? hash['retirementPlan'] : SKIP
+      third_party_sick_pay =
+        hash.key?('thirdPartySickPay') ? hash['thirdPartySickPay'] : SKIP
+      espp_qualified = hash.key?('esppQualified') ? hash['esppQualified'] : SKIP
+      espp_non_qualified =
+        hash.key?('esppNonQualified') ? hash['esppNonQualified'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      other = nil
+      unless hash['other'].nil?
+        other = []
+        hash['other'].each do |structure|
+          other << (DescriptionAndAmount.from_hash(structure) if structure)
+        end
+      end
+
+      other = SKIP unless hash.key?('other')
+      # 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.
+      FormW2.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,
+                 control_number: control_number,
+                 wages: wages,
+                 federal_tax_withheld: federal_tax_withheld,
+                 social_security_wages: social_security_wages,
+                 social_security_tax_withheld: social_security_tax_withheld,
+                 medicare_wages: medicare_wages,
+                 medicare_tax_withheld: medicare_tax_withheld,
+                 social_security_tips: social_security_tips,
+                 allocated_tips: allocated_tips,
+                 dependent_care_benefit: dependent_care_benefit,
+                 non_qualified_plan: non_qualified_plan,
+                 codes: codes,
+                 statutory: statutory,
+                 retirement_plan: retirement_plan,
+                 third_party_sick_pay: third_party_sick_pay,
+                 espp_qualified: espp_qualified,
+                 espp_non_qualified: espp_non_qualified,
+                 other: other,
+                 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}, control_number: #{@control_number}, wages: #{@wages},"\
+      " federal_tax_withheld: #{@federal_tax_withheld}, social_security_wages:"\
+      " #{@social_security_wages}, social_security_tax_withheld: #{@social_security_tax_withheld},"\
+      " medicare_wages: #{@medicare_wages}, medicare_tax_withheld: #{@medicare_tax_withheld},"\
+      " social_security_tips: #{@social_security_tips}, allocated_tips: #{@allocated_tips},"\
+      " dependent_care_benefit: #{@dependent_care_benefit}, non_qualified_plan:"\
+      " #{@non_qualified_plan}, codes: #{@codes}, statutory: #{@statutory}, retirement_plan:"\
+      " #{@retirement_plan}, third_party_sick_pay: #{@third_party_sick_pay}, espp_qualified:"\
+      " #{@espp_qualified}, espp_non_qualified: #{@espp_non_qualified}, other: #{@other},"\
+      " 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}, control_number: #{@control_number.inspect}, wages:"\
+      " #{@wages.inspect}, federal_tax_withheld: #{@federal_tax_withheld.inspect},"\
+      " social_security_wages: #{@social_security_wages.inspect}, social_security_tax_withheld:"\
+      " #{@social_security_tax_withheld.inspect}, medicare_wages: #{@medicare_wages.inspect},"\
+      " medicare_tax_withheld: #{@medicare_tax_withheld.inspect}, social_security_tips:"\
+      " #{@social_security_tips.inspect}, allocated_tips: #{@allocated_tips.inspect},"\
+      " dependent_care_benefit: #{@dependent_care_benefit.inspect}, non_qualified_plan:"\
+      " #{@non_qualified_plan.inspect}, codes: #{@codes.inspect}, statutory:"\
+      " #{@statutory.inspect}, retirement_plan: #{@retirement_plan.inspect}, third_party_sick_pay:"\
+      " #{@third_party_sick_pay.inspect}, espp_qualified: #{@espp_qualified.inspect},"\
+      " espp_non_qualified: #{@espp_non_qualified.inspect}, other: #{@other.inspect},"\
+      " state_and_local: #{@state_and_local.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end