fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/form1099_b1.rb

@@ -0,0 +1,367 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Proceeds From Broker and Barter Exchange Transactions
+  class Form1099B1 < 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
+
+    # Boxes 14-16, State and Local tax withholding
+    # @return [Array[StateAndLocalTaxWithholding]]
+    attr_accessor :state_and_local
+
+    # Box 4, Federal income tax withheld
+    # @return [Float]
+    attr_accessor :federal_tax_withheld
+
+    # Box 8, Profit or (loss) realized in current year on closed contracts
+    # @return [Float]
+    attr_accessor :profit_on_closed_contracts
+
+    # Box 9, Unrealized profit or loss on open contracts at end of last year
+    # @return [Float]
+    attr_accessor :unrealized_profit_open_contracts_begin
+
+    # Box 10, Unrealized profit or loss on open contracts at end of current year
+    # @return [Float]
+    attr_accessor :unrealized_profit_open_contracts_end
+
+    # Box 11, Aggregate profit or (loss) on contracts
+    # @return [Float]
+    attr_accessor :aggregate_profit_on_contracts
+
+    # Box 13, Bartering
+    # @return [Float]
+    attr_accessor :bartering
+
+    # Boxes 1-3, 5-7, 12, Security details
+    # @return [Array[SecurityDetailIrsForm1099B]]
+    attr_accessor :security_details
+
+    # 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['state_and_local'] = 'stateAndLocal'
+      @_hash['federal_tax_withheld'] = 'federalTaxWithheld'
+      @_hash['profit_on_closed_contracts'] = 'profitOnClosedContracts'
+      @_hash['unrealized_profit_open_contracts_begin'] =
+        'unrealizedProfitOpenContractsBegin'
+      @_hash['unrealized_profit_open_contracts_end'] =
+        'unrealizedProfitOpenContractsEnd'
+      @_hash['aggregate_profit_on_contracts'] = 'aggregateProfitOnContracts'
+      @_hash['bartering'] = 'bartering'
+      @_hash['security_details'] = 'securityDetails'
+      @_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
+        state_and_local
+        federal_tax_withheld
+        profit_on_closed_contracts
+        unrealized_profit_open_contracts_begin
+        unrealized_profit_open_contracts_end
+        aggregate_profit_on_contracts
+        bartering
+        security_details
+        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, state_and_local: SKIP,
+                   federal_tax_withheld: SKIP, profit_on_closed_contracts: SKIP,
+                   unrealized_profit_open_contracts_begin: SKIP,
+                   unrealized_profit_open_contracts_end: SKIP,
+                   aggregate_profit_on_contracts: SKIP, bartering: SKIP,
+                   security_details: 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
+      @state_and_local = state_and_local unless state_and_local == SKIP
+      @federal_tax_withheld = federal_tax_withheld unless federal_tax_withheld == SKIP
+      unless profit_on_closed_contracts == SKIP
+        @profit_on_closed_contracts =
+          profit_on_closed_contracts
+      end
+      unless unrealized_profit_open_contracts_begin == SKIP
+        @unrealized_profit_open_contracts_begin =
+          unrealized_profit_open_contracts_begin
+      end
+      unless unrealized_profit_open_contracts_end == SKIP
+        @unrealized_profit_open_contracts_end =
+          unrealized_profit_open_contracts_end
+      end
+      unless aggregate_profit_on_contracts == SKIP
+        @aggregate_profit_on_contracts =
+          aggregate_profit_on_contracts
+      end
+      @bartering = bartering unless bartering == SKIP
+      @security_details = security_details unless security_details == 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
+      # 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')
+      federal_tax_withheld =
+        hash.key?('federalTaxWithheld') ? hash['federalTaxWithheld'] : SKIP
+      profit_on_closed_contracts =
+        hash.key?('profitOnClosedContracts') ? hash['profitOnClosedContracts'] : SKIP
+      unrealized_profit_open_contracts_begin =
+        hash.key?('unrealizedProfitOpenContractsBegin') ? hash['unrealizedProfitOpenContractsBegin'] : SKIP
+      unrealized_profit_open_contracts_end =
+        hash.key?('unrealizedProfitOpenContractsEnd') ? hash['unrealizedProfitOpenContractsEnd'] : SKIP
+      aggregate_profit_on_contracts =
+        hash.key?('aggregateProfitOnContracts') ? hash['aggregateProfitOnContracts'] : SKIP
+      bartering = hash.key?('bartering') ? hash['bartering'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      security_details = nil
+      unless hash['securityDetails'].nil?
+        security_details = []
+        hash['securityDetails'].each do |structure|
+          security_details << (SecurityDetailIrsForm1099B.from_hash(structure) if structure)
+        end
+      end
+
+      security_details = SKIP unless hash.key?('securityDetails')
+      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.
+      Form1099B1.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,
+                     state_and_local: state_and_local,
+                     federal_tax_withheld: federal_tax_withheld,
+                     profit_on_closed_contracts: profit_on_closed_contracts,
+                     unrealized_profit_open_contracts_begin: unrealized_profit_open_contracts_begin,
+                     unrealized_profit_open_contracts_end: unrealized_profit_open_contracts_end,
+                     aggregate_profit_on_contracts: aggregate_profit_on_contracts,
+                     bartering: bartering,
+                     security_details: security_details,
+                     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}, state_and_local:"\
+      " #{@state_and_local}, federal_tax_withheld: #{@federal_tax_withheld},"\
+      " profit_on_closed_contracts: #{@profit_on_closed_contracts},"\
+      " unrealized_profit_open_contracts_begin: #{@unrealized_profit_open_contracts_begin},"\
+      " unrealized_profit_open_contracts_end: #{@unrealized_profit_open_contracts_end},"\
+      " aggregate_profit_on_contracts: #{@aggregate_profit_on_contracts}, bartering:"\
+      " #{@bartering}, security_details: #{@security_details}, 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}, state_and_local:"\
+      " #{@state_and_local.inspect}, federal_tax_withheld: #{@federal_tax_withheld.inspect},"\
+      " profit_on_closed_contracts: #{@profit_on_closed_contracts.inspect},"\
+      ' unrealized_profit_open_contracts_begin:'\
+      " #{@unrealized_profit_open_contracts_begin.inspect}, unrealized_profit_open_contracts_end:"\
+      " #{@unrealized_profit_open_contracts_end.inspect}, aggregate_profit_on_contracts:"\
+      " #{@aggregate_profit_on_contracts.inspect}, bartering: #{@bartering.inspect},"\
+      " security_details: #{@security_details.inspect}, second_tin_notice:"\
+      " #{@second_tin_notice.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/form1099_c.rb

@@ -0,0 +1,310 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Cancellation of Debt, from CREDITOR (1st-2nd boxes as issuer) to DEBTOR
+  # (3rd-4th boxes as recipient)
+  class Form1099C < 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, Date of identifiable event
+    # @return [Date]
+    attr_accessor :date_of_event
+
+    # Box 2, Amount of debt discharged
+    # @return [Float]
+    attr_accessor :amount_discharged
+
+    # Box 3, Interest if included in box 2
+    # @return [Float]
+    attr_accessor :interest_included
+
+    # Box 4, Debt description
+    # @return [String]
+    attr_accessor :debt_description
+
+    # Box 5, If checked, the debtor was personally liable for repayment of the
+    # debt
+    # @return [TrueClass | FalseClass]
+    attr_accessor :personally_liable
+
+    # Box 6, Identifiable debt code
+    # @return [String]
+    attr_accessor :debt_code
+
+    # Box 7, Fair market value of property
+    # @return [Float]
+    attr_accessor :fair_market_value
+
+    # 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['date_of_event'] = 'dateOfEvent'
+      @_hash['amount_discharged'] = 'amountDischarged'
+      @_hash['interest_included'] = 'interestIncluded'
+      @_hash['debt_description'] = 'debtDescription'
+      @_hash['personally_liable'] = 'personallyLiable'
+      @_hash['debt_code'] = 'debtCode'
+      @_hash['fair_market_value'] = 'fairMarketValue'
+      @_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
+        date_of_event
+        amount_discharged
+        interest_included
+        debt_description
+        personally_liable
+        debt_code
+        fair_market_value
+      ]
+    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, date_of_event: SKIP,
+                   amount_discharged: SKIP, interest_included: SKIP,
+                   debt_description: SKIP, personally_liable: SKIP,
+                   debt_code: SKIP, fair_market_value: 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
+      @date_of_event = date_of_event unless date_of_event == SKIP
+      @amount_discharged = amount_discharged unless amount_discharged == SKIP
+      @interest_included = interest_included unless interest_included == SKIP
+      @debt_description = debt_description unless debt_description == SKIP
+      @personally_liable = personally_liable unless personally_liable == SKIP
+      @debt_code = debt_code unless debt_code == SKIP
+      @fair_market_value = fair_market_value unless fair_market_value == 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
+      date_of_event = hash.key?('dateOfEvent') ? hash['dateOfEvent'] : SKIP
+      amount_discharged =
+        hash.key?('amountDischarged') ? hash['amountDischarged'] : SKIP
+      interest_included =
+        hash.key?('interestIncluded') ? hash['interestIncluded'] : SKIP
+      debt_description =
+        hash.key?('debtDescription') ? hash['debtDescription'] : SKIP
+      personally_liable =
+        hash.key?('personallyLiable') ? hash['personallyLiable'] : SKIP
+      debt_code = hash.key?('debtCode') ? hash['debtCode'] : SKIP
+      fair_market_value =
+        hash.key?('fairMarketValue') ? hash['fairMarketValue'] : 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.
+      Form1099C.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,
+                    date_of_event: date_of_event,
+                    amount_discharged: amount_discharged,
+                    interest_included: interest_included,
+                    debt_description: debt_description,
+                    personally_liable: personally_liable,
+                    debt_code: debt_code,
+                    fair_market_value: fair_market_value,
+                    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}, date_of_event:"\
+      " #{@date_of_event}, amount_discharged: #{@amount_discharged}, interest_included:"\
+      " #{@interest_included}, debt_description: #{@debt_description}, personally_liable:"\
+      " #{@personally_liable}, debt_code: #{@debt_code}, fair_market_value: #{@fair_market_value},"\
+      " 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}, date_of_event:"\
+      " #{@date_of_event.inspect}, amount_discharged: #{@amount_discharged.inspect},"\
+      " interest_included: #{@interest_included.inspect}, debt_description:"\
+      " #{@debt_description.inspect}, personally_liable: #{@personally_liable.inspect}, debt_code:"\
+      " #{@debt_code.inspect}, fair_market_value: #{@fair_market_value.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end