fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/form1098_c.rb

@@ -0,0 +1,421 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Contributions of Motor Vehicles, Boats, and Airplanes, from DONEE (1st-2nd
+  # boxes as issuer) to DONOR (3rd-6th boxes as recipient)
+  class Form1098C < 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
+
+    # Box 1, Date of contribution
+    # @return [Date]
+    attr_accessor :date_of_contribution
+
+    # Box 2a, Odometer mileage
+    # @return [Integer]
+    attr_accessor :odometer_mileage
+
+    # Box 2b, Year
+    # @return [Integer]
+    attr_accessor :car_year
+
+    # Box 2c, Make
+    # @return [String]
+    attr_accessor :make
+
+    # Box 2d, Model
+    # @return [String]
+    attr_accessor :model
+
+    # Box 3, Vehicle or other identification number
+    # @return [String]
+    attr_accessor :vin
+
+    # Box 4a, Donee certifies that vehicle was sold in arm's length transaction
+    # to unrelated party
+    # @return [TrueClass | FalseClass]
+    attr_accessor :arms_length_transaction
+
+    # Box 4b, Date of sale
+    # @return [Date]
+    attr_accessor :date_of_sale
+
+    # Box 4c, Gross proceeds from sale (see instructions)
+    # @return [Float]
+    attr_accessor :gross_proceeds
+
+    # Box 5a, Donee certifies that vehicle will not be transferred for money,
+    # other property, or services before completion of material improvements or
+    # significant intervening use
+    # @return [TrueClass | FalseClass]
+    attr_accessor :not_transferred_before
+
+    # Box 5b, Donee certifies that vehicle is to be transferred to a needy
+    # individual for significantly below fair market value in furtherance of
+    # donee's charitable purpose
+    # @return [TrueClass | FalseClass]
+    attr_accessor :needy_individual
+
+    # Box 5c, Donee certifies the following detailed description of material
+    # improvements or significant intervening use and duration of use
+    # @return [String]
+    attr_accessor :description_of_improvements
+
+    # Box 6a, Did you provide goods or services in exchange for the vehicle? Yes
+    # @return [TrueClass | FalseClass]
+    attr_accessor :goods_in_exchange
+
+    # Box 6b, Value of goods and services provided in exchange for the vehicle
+    # @return [Float]
+    attr_accessor :value_of_exchange
+
+    # Box 6c, If this box is checked, donee certifies that the goods and
+    # services consisted solely of intangible religious benefits
+    # @return [TrueClass | FalseClass]
+    attr_accessor :intangible_religious
+
+    # Box 6c, Describe the goods and services, if any, that were provided
+    # @return [String]
+    attr_accessor :description_of_goods
+
+    # Box 7, Under the law, the donor may not claim a deduction of more than
+    # $500 for this vehicle if this box is checked
+    # @return [TrueClass | FalseClass]
+    attr_accessor :max_deduction_applies
+
+    # 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['date_of_contribution'] = 'dateOfContribution'
+      @_hash['odometer_mileage'] = 'odometerMileage'
+      @_hash['car_year'] = 'carYear'
+      @_hash['make'] = 'make'
+      @_hash['model'] = 'model'
+      @_hash['vin'] = 'vin'
+      @_hash['arms_length_transaction'] = 'armsLengthTransaction'
+      @_hash['date_of_sale'] = 'dateOfSale'
+      @_hash['gross_proceeds'] = 'grossProceeds'
+      @_hash['not_transferred_before'] = 'notTransferredBefore'
+      @_hash['needy_individual'] = 'needyIndividual'
+      @_hash['description_of_improvements'] = 'descriptionOfImprovements'
+      @_hash['goods_in_exchange'] = 'goodsInExchange'
+      @_hash['value_of_exchange'] = 'valueOfExchange'
+      @_hash['intangible_religious'] = 'intangibleReligious'
+      @_hash['description_of_goods'] = 'descriptionOfGoods'
+      @_hash['max_deduction_applies'] = 'maxDeductionApplies'
+      @_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
+        date_of_contribution
+        odometer_mileage
+        car_year
+        make
+        model
+        vin
+        arms_length_transaction
+        date_of_sale
+        gross_proceeds
+        not_transferred_before
+        needy_individual
+        description_of_improvements
+        goods_in_exchange
+        value_of_exchange
+        intangible_religious
+        description_of_goods
+        max_deduction_applies
+      ]
+    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, date_of_contribution: SKIP,
+                   odometer_mileage: SKIP, car_year: SKIP, make: SKIP,
+                   model: SKIP, vin: SKIP, arms_length_transaction: SKIP,
+                   date_of_sale: SKIP, gross_proceeds: SKIP,
+                   not_transferred_before: SKIP, needy_individual: SKIP,
+                   description_of_improvements: SKIP, goods_in_exchange: SKIP,
+                   value_of_exchange: SKIP, intangible_religious: SKIP,
+                   description_of_goods: SKIP, max_deduction_applies: 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
+      @date_of_contribution = date_of_contribution unless date_of_contribution == SKIP
+      @odometer_mileage = odometer_mileage unless odometer_mileage == SKIP
+      @car_year = car_year unless car_year == SKIP
+      @make = make unless make == SKIP
+      @model = model unless model == SKIP
+      @vin = vin unless vin == SKIP
+      @arms_length_transaction = arms_length_transaction unless arms_length_transaction == SKIP
+      @date_of_sale = date_of_sale unless date_of_sale == SKIP
+      @gross_proceeds = gross_proceeds unless gross_proceeds == SKIP
+      @not_transferred_before = not_transferred_before unless not_transferred_before == SKIP
+      @needy_individual = needy_individual unless needy_individual == SKIP
+      unless description_of_improvements == SKIP
+        @description_of_improvements =
+          description_of_improvements
+      end
+      @goods_in_exchange = goods_in_exchange unless goods_in_exchange == SKIP
+      @value_of_exchange = value_of_exchange unless value_of_exchange == SKIP
+      @intangible_religious = intangible_religious unless intangible_religious == SKIP
+      @description_of_goods = description_of_goods unless description_of_goods == SKIP
+      @max_deduction_applies = max_deduction_applies unless max_deduction_applies == 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')
+      date_of_contribution =
+        hash.key?('dateOfContribution') ? hash['dateOfContribution'] : SKIP
+      odometer_mileage =
+        hash.key?('odometerMileage') ? hash['odometerMileage'] : SKIP
+      car_year = hash.key?('carYear') ? hash['carYear'] : SKIP
+      make = hash.key?('make') ? hash['make'] : SKIP
+      model = hash.key?('model') ? hash['model'] : SKIP
+      vin = hash.key?('vin') ? hash['vin'] : SKIP
+      arms_length_transaction =
+        hash.key?('armsLengthTransaction') ? hash['armsLengthTransaction'] : SKIP
+      date_of_sale = hash.key?('dateOfSale') ? hash['dateOfSale'] : SKIP
+      gross_proceeds = hash.key?('grossProceeds') ? hash['grossProceeds'] : SKIP
+      not_transferred_before =
+        hash.key?('notTransferredBefore') ? hash['notTransferredBefore'] : SKIP
+      needy_individual =
+        hash.key?('needyIndividual') ? hash['needyIndividual'] : SKIP
+      description_of_improvements =
+        hash.key?('descriptionOfImprovements') ? hash['descriptionOfImprovements'] : SKIP
+      goods_in_exchange =
+        hash.key?('goodsInExchange') ? hash['goodsInExchange'] : SKIP
+      value_of_exchange =
+        hash.key?('valueOfExchange') ? hash['valueOfExchange'] : SKIP
+      intangible_religious =
+        hash.key?('intangibleReligious') ? hash['intangibleReligious'] : SKIP
+      description_of_goods =
+        hash.key?('descriptionOfGoods') ? hash['descriptionOfGoods'] : SKIP
+      max_deduction_applies =
+        hash.key?('maxDeductionApplies') ? hash['maxDeductionApplies'] : 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.
+      Form1098C.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,
+                    date_of_contribution: date_of_contribution,
+                    odometer_mileage: odometer_mileage,
+                    car_year: car_year,
+                    make: make,
+                    model: model,
+                    vin: vin,
+                    arms_length_transaction: arms_length_transaction,
+                    date_of_sale: date_of_sale,
+                    gross_proceeds: gross_proceeds,
+                    not_transferred_before: not_transferred_before,
+                    needy_individual: needy_individual,
+                    description_of_improvements: description_of_improvements,
+                    goods_in_exchange: goods_in_exchange,
+                    value_of_exchange: value_of_exchange,
+                    intangible_religious: intangible_religious,
+                    description_of_goods: description_of_goods,
+                    max_deduction_applies: max_deduction_applies,
+                    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}, date_of_contribution: #{@date_of_contribution},"\
+      " odometer_mileage: #{@odometer_mileage}, car_year: #{@car_year}, make: #{@make}, model:"\
+      " #{@model}, vin: #{@vin}, arms_length_transaction: #{@arms_length_transaction},"\
+      " date_of_sale: #{@date_of_sale}, gross_proceeds: #{@gross_proceeds},"\
+      " not_transferred_before: #{@not_transferred_before}, needy_individual:"\
+      " #{@needy_individual}, description_of_improvements: #{@description_of_improvements},"\
+      " goods_in_exchange: #{@goods_in_exchange}, value_of_exchange: #{@value_of_exchange},"\
+      " intangible_religious: #{@intangible_religious}, description_of_goods:"\
+      " #{@description_of_goods}, max_deduction_applies: #{@max_deduction_applies},"\
+      " 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}, date_of_contribution: #{@date_of_contribution.inspect},"\
+      " odometer_mileage: #{@odometer_mileage.inspect}, car_year: #{@car_year.inspect}, make:"\
+      " #{@make.inspect}, model: #{@model.inspect}, vin: #{@vin.inspect}, arms_length_transaction:"\
+      " #{@arms_length_transaction.inspect}, date_of_sale: #{@date_of_sale.inspect},"\
+      " gross_proceeds: #{@gross_proceeds.inspect}, not_transferred_before:"\
+      " #{@not_transferred_before.inspect}, needy_individual: #{@needy_individual.inspect},"\
+      " description_of_improvements: #{@description_of_improvements.inspect}, goods_in_exchange:"\
+      " #{@goods_in_exchange.inspect}, value_of_exchange: #{@value_of_exchange.inspect},"\
+      " intangible_religious: #{@intangible_religious.inspect}, description_of_goods:"\
+      " #{@description_of_goods.inspect}, max_deduction_applies:"\
+      " #{@max_deduction_applies.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end