fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/form1099_k.rb

@@ -0,0 +1,413 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Merchant Card and Third-Party Network Payments, from FILER (1st, 7th boxes
+  # as issuer) to PAYEE (4th, 8th boxes as recipient)
+  class Form1099K < 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
+
+    # Check to indicate if FILER is a Payment Settlement Entity (PSE)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :payment_settlement_entity
+
+    # Check to indicate if FILER is an Electronic Payment Facilitator (EPF) /
+    # Other third party
+    # @return [TrueClass | FalseClass]
+    attr_accessor :electronic_payment_facilitator
+
+    # Check to indicate transactions reported are: Payment card
+    # @return [TrueClass | FalseClass]
+    attr_accessor :payment_card
+
+    # Check to indicate transactions reported are: Third party network
+    # @return [TrueClass | FalseClass]
+    attr_accessor :third_party_network
+
+    # PSE's name
+    # @return [String]
+    attr_accessor :pse_name
+
+    # PSE's phone number
+    # @return [TelephoneNumberPlusExtension1]
+    attr_accessor :pse_phone
+
+    # Account number
+    # @return [String]
+    attr_accessor :account_number
+
+    # Box 1a, Gross amount of payment card/third party network transactions
+    # @return [Float]
+    attr_accessor :gross_amount
+
+    # Box 1b, Card Not Present Transactions
+    # @return [Float]
+    attr_accessor :card_not_present
+
+    # Box 2, Merchant category code
+    # @return [String]
+    attr_accessor :merchant_category_code
+
+    # Box 3, Number of purchase transactions
+    # @return [Float]
+    attr_accessor :number_of_transactions
+
+    # Box 4, Federal income tax withheld
+    # @return [Float]
+    attr_accessor :federal_tax_withheld
+
+    # Box 5, Monthly amounts
+    # @return [Array[MonthAndAmount]]
+    attr_accessor :month_amounts
+
+    # Boxes 6-8, State and Local tax withholding
+    # @return [Array[StateAndLocalTaxWithholding]]
+    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['payment_settlement_entity'] = 'paymentSettlementEntity'
+      @_hash['electronic_payment_facilitator'] =
+        'electronicPaymentFacilitator'
+      @_hash['payment_card'] = 'paymentCard'
+      @_hash['third_party_network'] = 'thirdPartyNetwork'
+      @_hash['pse_name'] = 'pseName'
+      @_hash['pse_phone'] = 'psePhone'
+      @_hash['account_number'] = 'accountNumber'
+      @_hash['gross_amount'] = 'grossAmount'
+      @_hash['card_not_present'] = 'cardNotPresent'
+      @_hash['merchant_category_code'] = 'merchantCategoryCode'
+      @_hash['number_of_transactions'] = 'numberOfTransactions'
+      @_hash['federal_tax_withheld'] = 'federalTaxWithheld'
+      @_hash['month_amounts'] = 'monthAmounts'
+      @_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
+        payment_settlement_entity
+        electronic_payment_facilitator
+        payment_card
+        third_party_network
+        pse_name
+        pse_phone
+        account_number
+        gross_amount
+        card_not_present
+        merchant_category_code
+        number_of_transactions
+        federal_tax_withheld
+        month_amounts
+        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, payment_settlement_entity: SKIP,
+                   electronic_payment_facilitator: SKIP, payment_card: SKIP,
+                   third_party_network: SKIP, pse_name: SKIP, pse_phone: SKIP,
+                   account_number: SKIP, gross_amount: SKIP,
+                   card_not_present: SKIP, merchant_category_code: SKIP,
+                   number_of_transactions: SKIP, federal_tax_withheld: SKIP,
+                   month_amounts: 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
+      unless payment_settlement_entity == SKIP
+        @payment_settlement_entity =
+          payment_settlement_entity
+      end
+      unless electronic_payment_facilitator == SKIP
+        @electronic_payment_facilitator =
+          electronic_payment_facilitator
+      end
+      @payment_card = payment_card unless payment_card == SKIP
+      @third_party_network = third_party_network unless third_party_network == SKIP
+      @pse_name = pse_name unless pse_name == SKIP
+      @pse_phone = pse_phone unless pse_phone == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @gross_amount = gross_amount unless gross_amount == SKIP
+      @card_not_present = card_not_present unless card_not_present == SKIP
+      @merchant_category_code = merchant_category_code unless merchant_category_code == SKIP
+      @number_of_transactions = number_of_transactions unless number_of_transactions == SKIP
+      @federal_tax_withheld = federal_tax_withheld unless federal_tax_withheld == SKIP
+      @month_amounts = month_amounts unless month_amounts == 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')
+      payment_settlement_entity =
+        hash.key?('paymentSettlementEntity') ? hash['paymentSettlementEntity'] : SKIP
+      electronic_payment_facilitator =
+        hash.key?('electronicPaymentFacilitator') ? hash['electronicPaymentFacilitator'] : SKIP
+      payment_card = hash.key?('paymentCard') ? hash['paymentCard'] : SKIP
+      third_party_network =
+        hash.key?('thirdPartyNetwork') ? hash['thirdPartyNetwork'] : SKIP
+      pse_name = hash.key?('pseName') ? hash['pseName'] : SKIP
+      pse_phone = TelephoneNumberPlusExtension1.from_hash(hash['psePhone']) if hash['psePhone']
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : SKIP
+      gross_amount = hash.key?('grossAmount') ? hash['grossAmount'] : SKIP
+      card_not_present =
+        hash.key?('cardNotPresent') ? hash['cardNotPresent'] : SKIP
+      merchant_category_code =
+        hash.key?('merchantCategoryCode') ? hash['merchantCategoryCode'] : SKIP
+      number_of_transactions =
+        hash.key?('numberOfTransactions') ? hash['numberOfTransactions'] : SKIP
+      federal_tax_withheld =
+        hash.key?('federalTaxWithheld') ? hash['federalTaxWithheld'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      month_amounts = nil
+      unless hash['monthAmounts'].nil?
+        month_amounts = []
+        hash['monthAmounts'].each do |structure|
+          month_amounts << (MonthAndAmount.from_hash(structure) if structure)
+        end
+      end
+
+      month_amounts = SKIP unless hash.key?('monthAmounts')
+      # 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')
+      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.
+      Form1099K.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,
+                    payment_settlement_entity: payment_settlement_entity,
+                    electronic_payment_facilitator: electronic_payment_facilitator,
+                    payment_card: payment_card,
+                    third_party_network: third_party_network,
+                    pse_name: pse_name,
+                    pse_phone: pse_phone,
+                    account_number: account_number,
+                    gross_amount: gross_amount,
+                    card_not_present: card_not_present,
+                    merchant_category_code: merchant_category_code,
+                    number_of_transactions: number_of_transactions,
+                    federal_tax_withheld: federal_tax_withheld,
+                    month_amounts: month_amounts,
+                    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}, payment_settlement_entity: #{@payment_settlement_entity},"\
+      " electronic_payment_facilitator: #{@electronic_payment_facilitator}, payment_card:"\
+      " #{@payment_card}, third_party_network: #{@third_party_network}, pse_name: #{@pse_name},"\
+      " pse_phone: #{@pse_phone}, account_number: #{@account_number}, gross_amount:"\
+      " #{@gross_amount}, card_not_present: #{@card_not_present}, merchant_category_code:"\
+      " #{@merchant_category_code}, number_of_transactions: #{@number_of_transactions},"\
+      " federal_tax_withheld: #{@federal_tax_withheld}, month_amounts: #{@month_amounts},"\
+      " 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}, payment_settlement_entity:"\
+      " #{@payment_settlement_entity.inspect}, electronic_payment_facilitator:"\
+      " #{@electronic_payment_facilitator.inspect}, payment_card: #{@payment_card.inspect},"\
+      " third_party_network: #{@third_party_network.inspect}, pse_name: #{@pse_name.inspect},"\
+      " pse_phone: #{@pse_phone.inspect}, account_number: #{@account_number.inspect},"\
+      " gross_amount: #{@gross_amount.inspect}, card_not_present: #{@card_not_present.inspect},"\
+      " merchant_category_code: #{@merchant_category_code.inspect}, number_of_transactions:"\
+      " #{@number_of_transactions.inspect}, federal_tax_withheld:"\
+      " #{@federal_tax_withheld.inspect}, month_amounts: #{@month_amounts.inspect},"\
+      " state_and_local: #{@state_and_local.inspect}, second_tin_notice:"\
+      " #{@second_tin_notice.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end