avalara_sdk 25.7.0 → 25.8.0

data/lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb

@@ -0,0 +1,891 @@
+=begin
+#Avalara 1099 & W-9 API Definition
+
+### 🔐 Authentication  Generate a **license key** from: *[Avalara Portal](https://www.avalara.com/us/en/signin.html) → Settings → License and API Keys*.  [More on authentication methods](https://developer.avalara.com/avatax-dm-combined-erp/common-setup/authentication/authentication-methods/)  [Test your credentials](https://developer.avalara.com/avatax/test-credentials/)  ## 📘 API & SDK Documentation  [Avalara SDK (.NET) on GitHub](https://github.com/avadev/Avalara-SDK-DotNet#avalarasdk--the-unified-c-library-for-next-gen-avalara-services)  [Code Examples – 1099 API](https://github.com/avadev/Avalara-SDK-DotNet/blob/main/docs/A1099/V2/Class1099IssuersApi.md#call1099issuersget)
+
+
+=end
+
+require 'date'
+require 'time'
+
+module AvalaraSdk::A1099::V2
+      class Form1042SListItem
+    # Unique form identifier
+    attr_accessor :unique_form_id
+
+    # No TIN indicator
+    attr_accessor :no_tin
+
+    # Recipient's date of birth
+    attr_accessor :recipient_date_of_birth
+
+    # Recipient's GIIN (Global Intermediary Identification Number)
+    attr_accessor :recipient_giin
+
+    # Recipient's foreign TIN
+    attr_accessor :recipient_foreign_tin
+
+    # Limitation on benefits code
+    attr_accessor :lob_code
+
+    # Income code
+    attr_accessor :income_code
+
+    # Gross income
+    attr_accessor :gross_income
+
+    # Withholding indicator
+    attr_accessor :withholding_indicator
+
+    # Country code
+    attr_accessor :tax_country_code
+
+    # Exemption code (Chapter 3)
+    attr_accessor :exemption_code_chap3
+
+    # Exemption code (Chapter 4)
+    attr_accessor :exemption_code_chap4
+
+    # Tax rate (Chapter 3)
+    attr_accessor :tax_rate_chap3
+
+    # Withholding allowance
+    attr_accessor :withholding_allowance
+
+    # Federal tax withheld
+    attr_accessor :federal_tax_withheld
+
+    # Tax not deposited indicator
+    attr_accessor :tax_not_deposited_indicator
+
+    # Academic indicator
+    attr_accessor :academic_indicator
+
+    # Tax withheld by other agents
+    attr_accessor :tax_withheld_other_agents
+
+    # Amount repaid to recipient
+    attr_accessor :amount_repaid
+
+    # Tax paid by withholding agent
+    attr_accessor :tax_paid_agent
+
+    # Chapter 3 status code
+    attr_accessor :chap3_status_code
+
+    # Chapter 4 status code
+    attr_accessor :chap4_status_code
+
+    # Primary withholding agent information
+    attr_accessor :primary_withholding_agent
+
+    # Intermediary or flow-through entity information
+    attr_accessor :intermediary_or_flow_through
+
+    # Issuer ID
+    attr_accessor :issuer_id
+
+    # Reference ID
+    attr_accessor :reference_id
+
+    # Recipient Tax ID Number
+    attr_accessor :recipient_tin
+
+    # Recipient name
+    attr_accessor :recipient_name
+
+    # Type of TIN (Tax ID Number). Will be one of:  * SSN  * EIN  * ITIN  * ATIN
+    attr_accessor :tin_type
+
+    # Recipient second name
+    attr_accessor :recipient_second_name
+
+    # Address
+    attr_accessor :address
+
+    # Address line 2
+    attr_accessor :address2
+
+    # City
+    attr_accessor :city
+
+    # US state. Required if CountryCode is \"US\".
+    attr_accessor :state
+
+    # Zip/postal code
+    attr_accessor :zip
+
+    # Recipient email address
+    attr_accessor :recipient_email
+
+    # Account number
+    attr_accessor :account_number
+
+    # Office code
+    attr_accessor :office_code
+
+    # Foreign province
+    attr_accessor :recipient_non_us_province
+
+    # Country code, as defined at https://www.irs.gov/e-file-providers/country-codes
+    attr_accessor :country_code
+
+    # Boolean indicating that federal e-filing should be scheduled for this form
+    attr_accessor :federal_e_file
+
+    # Boolean indicating that postal mailing to the recipient should be scheduled for this form
+    attr_accessor :postal_mail
+
+    # Boolean indicating that state e-filing should be scheduled for this form
+    attr_accessor :state_e_file
+
+    # Boolean indicating that TIN Matching should be scheduled for this form
+    attr_accessor :tin_match
+
+    # Boolean indicating that address verification should be scheduled for this form
+    attr_accessor :address_verification
+
+    # State and local withholding information
+    attr_accessor :state_and_local_withholding
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'unique_form_id' => :'uniqueFormId',
+        :'no_tin' => :'noTin',
+        :'recipient_date_of_birth' => :'recipientDateOfBirth',
+        :'recipient_giin' => :'recipientGiin',
+        :'recipient_foreign_tin' => :'recipientForeignTin',
+        :'lob_code' => :'lobCode',
+        :'income_code' => :'incomeCode',
+        :'gross_income' => :'grossIncome',
+        :'withholding_indicator' => :'withholdingIndicator',
+        :'tax_country_code' => :'taxCountryCode',
+        :'exemption_code_chap3' => :'exemptionCodeChap3',
+        :'exemption_code_chap4' => :'exemptionCodeChap4',
+        :'tax_rate_chap3' => :'taxRateChap3',
+        :'withholding_allowance' => :'withholdingAllowance',
+        :'federal_tax_withheld' => :'federalTaxWithheld',
+        :'tax_not_deposited_indicator' => :'taxNotDepositedIndicator',
+        :'academic_indicator' => :'academicIndicator',
+        :'tax_withheld_other_agents' => :'taxWithheldOtherAgents',
+        :'amount_repaid' => :'amountRepaid',
+        :'tax_paid_agent' => :'taxPaidAgent',
+        :'chap3_status_code' => :'chap3StatusCode',
+        :'chap4_status_code' => :'chap4StatusCode',
+        :'primary_withholding_agent' => :'primaryWithholdingAgent',
+        :'intermediary_or_flow_through' => :'intermediaryOrFlowThrough',
+        :'issuer_id' => :'issuerId',
+        :'reference_id' => :'referenceId',
+        :'recipient_tin' => :'recipientTin',
+        :'recipient_name' => :'recipientName',
+        :'tin_type' => :'tinType',
+        :'recipient_second_name' => :'recipientSecondName',
+        :'address' => :'address',
+        :'address2' => :'address2',
+        :'city' => :'city',
+        :'state' => :'state',
+        :'zip' => :'zip',
+        :'recipient_email' => :'recipientEmail',
+        :'account_number' => :'accountNumber',
+        :'office_code' => :'officeCode',
+        :'recipient_non_us_province' => :'recipientNonUsProvince',
+        :'country_code' => :'countryCode',
+        :'federal_e_file' => :'federalEFile',
+        :'postal_mail' => :'postalMail',
+        :'state_e_file' => :'stateEFile',
+        :'tin_match' => :'tinMatch',
+        :'address_verification' => :'addressVerification',
+        :'state_and_local_withholding' => :'stateAndLocalWithholding'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'unique_form_id' => :'String',
+        :'no_tin' => :'Boolean',
+        :'recipient_date_of_birth' => :'Time',
+        :'recipient_giin' => :'String',
+        :'recipient_foreign_tin' => :'String',
+        :'lob_code' => :'String',
+        :'income_code' => :'String',
+        :'gross_income' => :'Float',
+        :'withholding_indicator' => :'String',
+        :'tax_country_code' => :'String',
+        :'exemption_code_chap3' => :'String',
+        :'exemption_code_chap4' => :'String',
+        :'tax_rate_chap3' => :'String',
+        :'withholding_allowance' => :'Float',
+        :'federal_tax_withheld' => :'Float',
+        :'tax_not_deposited_indicator' => :'Boolean',
+        :'academic_indicator' => :'Boolean',
+        :'tax_withheld_other_agents' => :'Float',
+        :'amount_repaid' => :'Float',
+        :'tax_paid_agent' => :'Float',
+        :'chap3_status_code' => :'String',
+        :'chap4_status_code' => :'String',
+        :'primary_withholding_agent' => :'PrimaryWithholdingAgent',
+        :'intermediary_or_flow_through' => :'IntermediaryOrFlowThrough',
+        :'issuer_id' => :'String',
+        :'reference_id' => :'String',
+        :'recipient_tin' => :'String',
+        :'recipient_name' => :'String',
+        :'tin_type' => :'String',
+        :'recipient_second_name' => :'String',
+        :'address' => :'String',
+        :'address2' => :'String',
+        :'city' => :'String',
+        :'state' => :'String',
+        :'zip' => :'String',
+        :'recipient_email' => :'String',
+        :'account_number' => :'String',
+        :'office_code' => :'String',
+        :'recipient_non_us_province' => :'String',
+        :'country_code' => :'String',
+        :'federal_e_file' => :'Boolean',
+        :'postal_mail' => :'Boolean',
+        :'state_e_file' => :'Boolean',
+        :'tin_match' => :'Boolean',
+        :'address_verification' => :'Boolean',
+        :'state_and_local_withholding' => :'StateAndLocalWithholdingRequest'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'no_tin',
+        :'recipient_date_of_birth',
+        :'recipient_giin',
+        :'recipient_foreign_tin',
+        :'lob_code',
+        :'exemption_code_chap3',
+        :'exemption_code_chap4',
+        :'tax_rate_chap3',
+        :'withholding_allowance',
+        :'federal_tax_withheld',
+        :'tax_not_deposited_indicator',
+        :'academic_indicator',
+        :'tax_withheld_other_agents',
+        :'amount_repaid',
+        :'tax_paid_agent',
+        :'chap3_status_code',
+        :'chap4_status_code',
+        :'issuer_id',
+        :'reference_id',
+        :'recipient_second_name',
+        :'address2',
+        :'recipient_email',
+        :'account_number',
+        :'office_code',
+        :'recipient_non_us_province',
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'FormRequestBase'
+      ]
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AvalaraSdk::A1099::V2::Form1042SListItem` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `AvalaraSdk::A1099::V2::Form1042SListItem`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'unique_form_id')
+        self.unique_form_id = attributes[:'unique_form_id']
+      end
+
+      if attributes.key?(:'no_tin')
+        self.no_tin = attributes[:'no_tin']
+      end
+
+      if attributes.key?(:'recipient_date_of_birth')
+        self.recipient_date_of_birth = attributes[:'recipient_date_of_birth']
+      end
+
+      if attributes.key?(:'recipient_giin')
+        self.recipient_giin = attributes[:'recipient_giin']
+      end
+
+      if attributes.key?(:'recipient_foreign_tin')
+        self.recipient_foreign_tin = attributes[:'recipient_foreign_tin']
+      end
+
+      if attributes.key?(:'lob_code')
+        self.lob_code = attributes[:'lob_code']
+      end
+
+      if attributes.key?(:'income_code')
+        self.income_code = attributes[:'income_code']
+      end
+
+      if attributes.key?(:'gross_income')
+        self.gross_income = attributes[:'gross_income']
+      end
+
+      if attributes.key?(:'withholding_indicator')
+        self.withholding_indicator = attributes[:'withholding_indicator']
+      end
+
+      if attributes.key?(:'tax_country_code')
+        self.tax_country_code = attributes[:'tax_country_code']
+      end
+
+      if attributes.key?(:'exemption_code_chap3')
+        self.exemption_code_chap3 = attributes[:'exemption_code_chap3']
+      end
+
+      if attributes.key?(:'exemption_code_chap4')
+        self.exemption_code_chap4 = attributes[:'exemption_code_chap4']
+      end
+
+      if attributes.key?(:'tax_rate_chap3')
+        self.tax_rate_chap3 = attributes[:'tax_rate_chap3']
+      end
+
+      if attributes.key?(:'withholding_allowance')
+        self.withholding_allowance = attributes[:'withholding_allowance']
+      end
+
+      if attributes.key?(:'federal_tax_withheld')
+        self.federal_tax_withheld = attributes[:'federal_tax_withheld']
+      end
+
+      if attributes.key?(:'tax_not_deposited_indicator')
+        self.tax_not_deposited_indicator = attributes[:'tax_not_deposited_indicator']
+      end
+
+      if attributes.key?(:'academic_indicator')
+        self.academic_indicator = attributes[:'academic_indicator']
+      end
+
+      if attributes.key?(:'tax_withheld_other_agents')
+        self.tax_withheld_other_agents = attributes[:'tax_withheld_other_agents']
+      end
+
+      if attributes.key?(:'amount_repaid')
+        self.amount_repaid = attributes[:'amount_repaid']
+      end
+
+      if attributes.key?(:'tax_paid_agent')
+        self.tax_paid_agent = attributes[:'tax_paid_agent']
+      end
+
+      if attributes.key?(:'chap3_status_code')
+        self.chap3_status_code = attributes[:'chap3_status_code']
+      end
+
+      if attributes.key?(:'chap4_status_code')
+        self.chap4_status_code = attributes[:'chap4_status_code']
+      end
+
+      if attributes.key?(:'primary_withholding_agent')
+        self.primary_withholding_agent = attributes[:'primary_withholding_agent']
+      end
+
+      if attributes.key?(:'intermediary_or_flow_through')
+        self.intermediary_or_flow_through = attributes[:'intermediary_or_flow_through']
+      end
+
+      if attributes.key?(:'issuer_id')
+        self.issuer_id = attributes[:'issuer_id']
+      end
+
+      if attributes.key?(:'reference_id')
+        self.reference_id = attributes[:'reference_id']
+      end
+
+      if attributes.key?(:'recipient_tin')
+        self.recipient_tin = attributes[:'recipient_tin']
+      end
+
+      if attributes.key?(:'recipient_name')
+        self.recipient_name = attributes[:'recipient_name']
+      else
+        self.recipient_name = nil
+      end
+
+      if attributes.key?(:'tin_type')
+        self.tin_type = attributes[:'tin_type']
+      end
+
+      if attributes.key?(:'recipient_second_name')
+        self.recipient_second_name = attributes[:'recipient_second_name']
+      end
+
+      if attributes.key?(:'address')
+        self.address = attributes[:'address']
+      else
+        self.address = nil
+      end
+
+      if attributes.key?(:'address2')
+        self.address2 = attributes[:'address2']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      else
+        self.city = nil
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'zip')
+        self.zip = attributes[:'zip']
+      end
+
+      if attributes.key?(:'recipient_email')
+        self.recipient_email = attributes[:'recipient_email']
+      end
+
+      if attributes.key?(:'account_number')
+        self.account_number = attributes[:'account_number']
+      end
+
+      if attributes.key?(:'office_code')
+        self.office_code = attributes[:'office_code']
+      end
+
+      if attributes.key?(:'recipient_non_us_province')
+        self.recipient_non_us_province = attributes[:'recipient_non_us_province']
+      end
+
+      if attributes.key?(:'country_code')
+        self.country_code = attributes[:'country_code']
+      else
+        self.country_code = nil
+      end
+
+      if attributes.key?(:'federal_e_file')
+        self.federal_e_file = attributes[:'federal_e_file']
+      end
+
+      if attributes.key?(:'postal_mail')
+        self.postal_mail = attributes[:'postal_mail']
+      end
+
+      if attributes.key?(:'state_e_file')
+        self.state_e_file = attributes[:'state_e_file']
+      end
+
+      if attributes.key?(:'tin_match')
+        self.tin_match = attributes[:'tin_match']
+      end
+
+      if attributes.key?(:'address_verification')
+        self.address_verification = attributes[:'address_verification']
+      end
+
+      if attributes.key?(:'state_and_local_withholding')
+        self.state_and_local_withholding = attributes[:'state_and_local_withholding']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @recipient_name.nil?
+        invalid_properties.push('invalid value for "recipient_name", recipient_name cannot be nil.')
+      end
+
+      if @recipient_name.to_s.length < 1
+        invalid_properties.push('invalid value for "recipient_name", the character length must be great than or equal to 1.')
+      end
+
+      if @address.nil?
+        invalid_properties.push('invalid value for "address", address cannot be nil.')
+      end
+
+      if @address.to_s.length < 1
+        invalid_properties.push('invalid value for "address", the character length must be great than or equal to 1.')
+      end
+
+      if @city.nil?
+        invalid_properties.push('invalid value for "city", city cannot be nil.')
+      end
+
+      if @city.to_s.length < 1
+        invalid_properties.push('invalid value for "city", the character length must be great than or equal to 1.')
+      end
+
+      if @country_code.nil?
+        invalid_properties.push('invalid value for "country_code", country_code cannot be nil.')
+      end
+
+      if @country_code.to_s.length < 1
+        invalid_properties.push('invalid value for "country_code", the character length must be great than or equal to 1.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      lob_code_validator = EnumAttributeValidator.new('String', ["Individual", "GovernmentContractingState", "TaxExemptPensionTrust", "TaxExemptCharitableOrganization", "PubliclyTradedCorporation", "SubsidiaryOfPubliclyTradedCorporation", "CompanyOwnershipBaseErosionTest", "CompanyDerivativeBenefitsTest", "CompanyActiveTradeOrBusinessTest", "DiscretionaryDetermination", "Other", "NoLobArticleInTreaty"])
+      return false unless lob_code_validator.valid?(@lob_code)
+      exemption_code_chap3_validator = EnumAttributeValidator.new('String', ["TaxRateDueToBackupWithholding", "EffectivelyConnectedIncome", "ExemptUnderIrc", "IncomeNotFromUsSources", "ExemptUnderTaxTreaty", "PortfolioInterestExemptUnderIrc", "QiThatAssumesPrimaryWithholdingResponsibility", "WfPorWft", "UsBranchTreatedAsUsPerson", "TerritoryFiTreatedAsUsPerson", "QiRepresentsIncomeExempt", "QslThatAssumesPrimaryWithholdingResponsibility", "PayeeSubjectedToChapter4Withholding", "QddThatAssumesPrimaryWithholdingResponsibility", "ExemptUnderSection897L", "ExemptUnderSection892"])
+      return false unless exemption_code_chap3_validator.valid?(@exemption_code_chap3)
+      exemption_code_chap4_validator = EnumAttributeValidator.new('String', ["NotExempt", "GrandfatheredPayment", "EffectivelyConnectedIncome", "PayeeNotSubjectToChapter4Withholding", "ExcludedNonfinancialPayment", "ForeignEntityThatAssumesPrimaryWithholdingResponsibility", "UsPayeesOfParticipatingFfi", "ExemptFromWithholdingUnderIga", "DormantAccount", "OtherPaymentNotSubjectToChapter4Withholding"])
+      return false unless exemption_code_chap4_validator.valid?(@exemption_code_chap4)
+      chap3_status_code_validator = EnumAttributeValidator.new('String', ["USWithholdingAgentFI", "USWithholdingAgentOther", "TerritoryFITreatedAsUSPerson", "TerritoryFINotTreatedAsUSPerson", "USBranchTreatedAsUSPerson", "USBranchNotTreatedAsUSPerson", "USBranchECIPresumptionApplied", "PartnershipOtherThanWithholdingForeignPartnership", "WithholdingForeignPartnership", "TrustOtherThanWithholdingForeignTrust", "WithholdingForeignTrust", "QualifiedIntermediary", "QualifiedSecuritiesLenderQualifiedIntermediary", "QualifiedSecuritiesLenderOther", "Corporation", "Individual", "Estate", "PrivateFoundation", "GovernmentOrInternationalOrganization", "TaxExemptOrganizationSection501cEntities", "UnknownRecipient", "ArtistOrAthlete", "Pension", "ForeignCentralBankOfIssue", "NonqualifiedIntermediary", "HybridEntityMakingTreatyClaim", "WithholdingRatePoolGeneral", "WithholdingRatePoolExemptOrganization", "PAIWithholdingRatePoolGeneral", "PAIWithholdingRatePoolExemptOrganization", "AgencyWithholdingRatePoolGeneral", "AgencyWithholdingRatePoolExemptOrganization", "USWithholdingAgentForeignBranchOfFI", "QualifiedDerivativesDealer", "ForeignGovernmentIntegralPart", "ForeignGovernmentControlledEntity", "PubliclyTradedPartnership", "DisclosingQualifiedIntermediary"])
+      return false unless chap3_status_code_validator.valid?(@chap3_status_code)
+      chap4_status_code_validator = EnumAttributeValidator.new('String', ["UsWithholdingAgentFi", "UsWithholdingAgentOther", "TerritoryFiNotTreatedAsUsPerson", "TerritoryFiTreatedAsUsPerson", "ParticipatingFfiOther", "ParticipatingFfiReportingModel2Ffi", "RegisteredDeemedCompliantFfiReportingModel1Ffi", "RegisteredDeemedCompliantFfiSponsoredEntity", "RegisteredDeemedCompliantFfiOther", "CertifiedDeemedCompliantFfiOther", "CertifiedDeemedCompliantFfiffiWithLowValueAccounts", "CertifiedDeemedCompliantFfiNonRegisteringLocalBank", "CertifiedDeemedCompliantFfiSponsoredEntity", "CertifiedDeemedCompliantFfiInvestmentAdvisorOrManager", "NonparticipatingFfi", "OwnerDocumentedFfi", "UsBranchTreatedAsUsPerson", "UsBranchNotTreatedAsUsPerson", "PassiveNffeIdentifyingSubstantialUsOwners", "PassiveNffeWithNoSubstantialUsOwners", "PubliclyTradedNffeOrAffiliate", "ActiveNffe", "Individual", "Section501CEntities", "ExceptedTerritoryNffe", "ExceptedNffeOther", "ExemptBeneficialOwner", "EntityWhollyOwnedByExemptBeneficialOwners", "UnknownRecipient", "RecalcitrantAccountHolder", "NonreportingIgafii", "DirectReportingNffe", "UsReportableAccount", "NonConsentingUsAccount", "SponsoredDirectReportingNffe", "ExceptedInterAffiliateFfi", "UndocumentedPreexistingObligation", "UsBranchEciPresumptionApplied", "AccountHolderOfExcludedFinancialAccount", "PassiveNffeReportedByFfi", "NffeSubjectTo1472Withholding", "RecalcitrantPoolNoUsIndicia", "RecalcitrantPoolUsIndicia", "RecalcitrantPoolDormantAccount", "RecalcitrantPoolUsPersons", "RecalcitrantPoolPassiveNffEs", "NonparticipatingFfiPool", "UsPayeesPool", "QiRecalcitrantPoolGeneral", "UsWithholdingAgentForeignBranchOfFi"])
+      return false unless chap4_status_code_validator.valid?(@chap4_status_code)
+      return false if @recipient_name.nil?
+      return false if @recipient_name.to_s.length < 1
+      tin_type_validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"])
+      return false unless tin_type_validator.valid?(@tin_type)
+      return false if @address.nil?
+      return false if @address.to_s.length < 1
+      return false if @city.nil?
+      return false if @city.to_s.length < 1
+      return false if @country_code.nil?
+      return false if @country_code.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] lob_code Object to be assigned
+    def lob_code=(lob_code)
+      validator = EnumAttributeValidator.new('String', ["Individual", "GovernmentContractingState", "TaxExemptPensionTrust", "TaxExemptCharitableOrganization", "PubliclyTradedCorporation", "SubsidiaryOfPubliclyTradedCorporation", "CompanyOwnershipBaseErosionTest", "CompanyDerivativeBenefitsTest", "CompanyActiveTradeOrBusinessTest", "DiscretionaryDetermination", "Other", "NoLobArticleInTreaty"])
+      unless validator.valid?(lob_code)
+        fail ArgumentError, "invalid value for \"lob_code\", must be one of #{validator.allowable_values}."
+      end
+      @lob_code = lob_code
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] exemption_code_chap3 Object to be assigned
+    def exemption_code_chap3=(exemption_code_chap3)
+      validator = EnumAttributeValidator.new('String', ["TaxRateDueToBackupWithholding", "EffectivelyConnectedIncome", "ExemptUnderIrc", "IncomeNotFromUsSources", "ExemptUnderTaxTreaty", "PortfolioInterestExemptUnderIrc", "QiThatAssumesPrimaryWithholdingResponsibility", "WfPorWft", "UsBranchTreatedAsUsPerson", "TerritoryFiTreatedAsUsPerson", "QiRepresentsIncomeExempt", "QslThatAssumesPrimaryWithholdingResponsibility", "PayeeSubjectedToChapter4Withholding", "QddThatAssumesPrimaryWithholdingResponsibility", "ExemptUnderSection897L", "ExemptUnderSection892"])
+      unless validator.valid?(exemption_code_chap3)
+        fail ArgumentError, "invalid value for \"exemption_code_chap3\", must be one of #{validator.allowable_values}."
+      end
+      @exemption_code_chap3 = exemption_code_chap3
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] exemption_code_chap4 Object to be assigned
+    def exemption_code_chap4=(exemption_code_chap4)
+      validator = EnumAttributeValidator.new('String', ["NotExempt", "GrandfatheredPayment", "EffectivelyConnectedIncome", "PayeeNotSubjectToChapter4Withholding", "ExcludedNonfinancialPayment", "ForeignEntityThatAssumesPrimaryWithholdingResponsibility", "UsPayeesOfParticipatingFfi", "ExemptFromWithholdingUnderIga", "DormantAccount", "OtherPaymentNotSubjectToChapter4Withholding"])
+      unless validator.valid?(exemption_code_chap4)
+        fail ArgumentError, "invalid value for \"exemption_code_chap4\", must be one of #{validator.allowable_values}."
+      end
+      @exemption_code_chap4 = exemption_code_chap4
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] chap3_status_code Object to be assigned
+    def chap3_status_code=(chap3_status_code)
+      validator = EnumAttributeValidator.new('String', ["USWithholdingAgentFI", "USWithholdingAgentOther", "TerritoryFITreatedAsUSPerson", "TerritoryFINotTreatedAsUSPerson", "USBranchTreatedAsUSPerson", "USBranchNotTreatedAsUSPerson", "USBranchECIPresumptionApplied", "PartnershipOtherThanWithholdingForeignPartnership", "WithholdingForeignPartnership", "TrustOtherThanWithholdingForeignTrust", "WithholdingForeignTrust", "QualifiedIntermediary", "QualifiedSecuritiesLenderQualifiedIntermediary", "QualifiedSecuritiesLenderOther", "Corporation", "Individual", "Estate", "PrivateFoundation", "GovernmentOrInternationalOrganization", "TaxExemptOrganizationSection501cEntities", "UnknownRecipient", "ArtistOrAthlete", "Pension", "ForeignCentralBankOfIssue", "NonqualifiedIntermediary", "HybridEntityMakingTreatyClaim", "WithholdingRatePoolGeneral", "WithholdingRatePoolExemptOrganization", "PAIWithholdingRatePoolGeneral", "PAIWithholdingRatePoolExemptOrganization", "AgencyWithholdingRatePoolGeneral", "AgencyWithholdingRatePoolExemptOrganization", "USWithholdingAgentForeignBranchOfFI", "QualifiedDerivativesDealer", "ForeignGovernmentIntegralPart", "ForeignGovernmentControlledEntity", "PubliclyTradedPartnership", "DisclosingQualifiedIntermediary"])
+      unless validator.valid?(chap3_status_code)
+        fail ArgumentError, "invalid value for \"chap3_status_code\", must be one of #{validator.allowable_values}."
+      end
+      @chap3_status_code = chap3_status_code
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] chap4_status_code Object to be assigned
+    def chap4_status_code=(chap4_status_code)
+      validator = EnumAttributeValidator.new('String', ["UsWithholdingAgentFi", "UsWithholdingAgentOther", "TerritoryFiNotTreatedAsUsPerson", "TerritoryFiTreatedAsUsPerson", "ParticipatingFfiOther", "ParticipatingFfiReportingModel2Ffi", "RegisteredDeemedCompliantFfiReportingModel1Ffi", "RegisteredDeemedCompliantFfiSponsoredEntity", "RegisteredDeemedCompliantFfiOther", "CertifiedDeemedCompliantFfiOther", "CertifiedDeemedCompliantFfiffiWithLowValueAccounts", "CertifiedDeemedCompliantFfiNonRegisteringLocalBank", "CertifiedDeemedCompliantFfiSponsoredEntity", "CertifiedDeemedCompliantFfiInvestmentAdvisorOrManager", "NonparticipatingFfi", "OwnerDocumentedFfi", "UsBranchTreatedAsUsPerson", "UsBranchNotTreatedAsUsPerson", "PassiveNffeIdentifyingSubstantialUsOwners", "PassiveNffeWithNoSubstantialUsOwners", "PubliclyTradedNffeOrAffiliate", "ActiveNffe", "Individual", "Section501CEntities", "ExceptedTerritoryNffe", "ExceptedNffeOther", "ExemptBeneficialOwner", "EntityWhollyOwnedByExemptBeneficialOwners", "UnknownRecipient", "RecalcitrantAccountHolder", "NonreportingIgafii", "DirectReportingNffe", "UsReportableAccount", "NonConsentingUsAccount", "SponsoredDirectReportingNffe", "ExceptedInterAffiliateFfi", "UndocumentedPreexistingObligation", "UsBranchEciPresumptionApplied", "AccountHolderOfExcludedFinancialAccount", "PassiveNffeReportedByFfi", "NffeSubjectTo1472Withholding", "RecalcitrantPoolNoUsIndicia", "RecalcitrantPoolUsIndicia", "RecalcitrantPoolDormantAccount", "RecalcitrantPoolUsPersons", "RecalcitrantPoolPassiveNffEs", "NonparticipatingFfiPool", "UsPayeesPool", "QiRecalcitrantPoolGeneral", "UsWithholdingAgentForeignBranchOfFi"])
+      unless validator.valid?(chap4_status_code)
+        fail ArgumentError, "invalid value for \"chap4_status_code\", must be one of #{validator.allowable_values}."
+      end
+      @chap4_status_code = chap4_status_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] recipient_name Value to be assigned
+    def recipient_name=(recipient_name)
+      if recipient_name.nil?
+        fail ArgumentError, 'recipient_name cannot be nil'
+      end
+
+      if recipient_name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "recipient_name", the character length must be great than or equal to 1.'
+      end
+
+      @recipient_name = recipient_name
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] tin_type Object to be assigned
+    def tin_type=(tin_type)
+      validator = EnumAttributeValidator.new('String', ["EIN", "SSN", "ITIN", "ATIN"])
+      unless validator.valid?(tin_type)
+        fail ArgumentError, "invalid value for \"tin_type\", must be one of #{validator.allowable_values}."
+      end
+      @tin_type = tin_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] address Value to be assigned
+    def address=(address)
+      if address.nil?
+        fail ArgumentError, 'address cannot be nil'
+      end
+
+      if address.to_s.length < 1
+        fail ArgumentError, 'invalid value for "address", the character length must be great than or equal to 1.'
+      end
+
+      @address = address
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] city Value to be assigned
+    def city=(city)
+      if city.nil?
+        fail ArgumentError, 'city cannot be nil'
+      end
+
+      if city.to_s.length < 1
+        fail ArgumentError, 'invalid value for "city", the character length must be great than or equal to 1.'
+      end
+
+      @city = city
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country_code Value to be assigned
+    def country_code=(country_code)
+      if country_code.nil?
+        fail ArgumentError, 'country_code cannot be nil'
+      end
+
+      if country_code.to_s.length < 1
+        fail ArgumentError, 'invalid value for "country_code", the character length must be great than or equal to 1.'
+      end
+
+      @country_code = country_code
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          unique_form_id == o.unique_form_id &&
+          no_tin == o.no_tin &&
+          recipient_date_of_birth == o.recipient_date_of_birth &&
+          recipient_giin == o.recipient_giin &&
+          recipient_foreign_tin == o.recipient_foreign_tin &&
+          lob_code == o.lob_code &&
+          income_code == o.income_code &&
+          gross_income == o.gross_income &&
+          withholding_indicator == o.withholding_indicator &&
+          tax_country_code == o.tax_country_code &&
+          exemption_code_chap3 == o.exemption_code_chap3 &&
+          exemption_code_chap4 == o.exemption_code_chap4 &&
+          tax_rate_chap3 == o.tax_rate_chap3 &&
+          withholding_allowance == o.withholding_allowance &&
+          federal_tax_withheld == o.federal_tax_withheld &&
+          tax_not_deposited_indicator == o.tax_not_deposited_indicator &&
+          academic_indicator == o.academic_indicator &&
+          tax_withheld_other_agents == o.tax_withheld_other_agents &&
+          amount_repaid == o.amount_repaid &&
+          tax_paid_agent == o.tax_paid_agent &&
+          chap3_status_code == o.chap3_status_code &&
+          chap4_status_code == o.chap4_status_code &&
+          primary_withholding_agent == o.primary_withholding_agent &&
+          intermediary_or_flow_through == o.intermediary_or_flow_through &&
+          issuer_id == o.issuer_id &&
+          reference_id == o.reference_id &&
+          recipient_tin == o.recipient_tin &&
+          recipient_name == o.recipient_name &&
+          tin_type == o.tin_type &&
+          recipient_second_name == o.recipient_second_name &&
+          address == o.address &&
+          address2 == o.address2 &&
+          city == o.city &&
+          state == o.state &&
+          zip == o.zip &&
+          recipient_email == o.recipient_email &&
+          account_number == o.account_number &&
+          office_code == o.office_code &&
+          recipient_non_us_province == o.recipient_non_us_province &&
+          country_code == o.country_code &&
+          federal_e_file == o.federal_e_file &&
+          postal_mail == o.postal_mail &&
+          state_e_file == o.state_e_file &&
+          tin_match == o.tin_match &&
+          address_verification == o.address_verification &&
+          state_and_local_withholding == o.state_and_local_withholding
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [unique_form_id, no_tin, recipient_date_of_birth, recipient_giin, recipient_foreign_tin, lob_code, income_code, gross_income, withholding_indicator, tax_country_code, exemption_code_chap3, exemption_code_chap4, tax_rate_chap3, withholding_allowance, federal_tax_withheld, tax_not_deposited_indicator, academic_indicator, tax_withheld_other_agents, amount_repaid, tax_paid_agent, chap3_status_code, chap4_status_code, primary_withholding_agent, intermediary_or_flow_through, issuer_id, reference_id, recipient_tin, recipient_name, tin_type, recipient_second_name, address, address2, city, state, zip, recipient_email, account_number, office_code, recipient_non_us_province, country_code, federal_e_file, postal_mail, state_e_file, tin_match, address_verification, state_and_local_withholding].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = AvalaraSdk::A1099::V2.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end