Class: AvalaraSdk::A1099::V2::W8BenEFormResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ W8BenEFormResponse

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 642

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AvalaraSdk::A1099::V2::W8BenEFormResponse` 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::W8BenEFormResponse`. 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?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'citizenship_country')
    self.citizenship_country = attributes[:'citizenship_country']
  end

  if attributes.key?(:'disregarded_entity')
    self.disregarded_entity = attributes[:'disregarded_entity']
  end

  if attributes.key?(:'entity_type')
    self.entity_type = attributes[:'entity_type']
  end

  if attributes.key?(:'making_treaty_claim')
    self.making_treaty_claim = attributes[:'making_treaty_claim']
  end

  if attributes.key?(:'fatca_status')
    self.fatca_status = attributes[:'fatca_status']
  end

  if attributes.key?(:'residence_address')
    self.residence_address = attributes[:'residence_address']
  end

  if attributes.key?(:'residence_city')
    self.residence_city = attributes[:'residence_city']
  end

  if attributes.key?(:'residence_state')
    self.residence_state = attributes[:'residence_state']
  end

  if attributes.key?(:'residence_zip')
    self.residence_zip = attributes[:'residence_zip']
  end

  if attributes.key?(:'residence_country')
    self.residence_country = attributes[:'residence_country']
  end

  if attributes.key?(:'residence_is_mailing')
    self.residence_is_mailing = attributes[:'residence_is_mailing']
  end

  if attributes.key?(:'mailing_address')
    self.mailing_address = attributes[:'mailing_address']
  end

  if attributes.key?(:'mailing_city')
    self.mailing_city = attributes[:'mailing_city']
  end

  if attributes.key?(:'mailing_state')
    self.mailing_state = attributes[:'mailing_state']
  end

  if attributes.key?(:'mailing_zip')
    self.mailing_zip = attributes[:'mailing_zip']
  end

  if attributes.key?(:'mailing_country')
    self.mailing_country = attributes[:'mailing_country']
  end

  if attributes.key?(:'tin_type')
    self.tin_type = attributes[:'tin_type']
  end

  if attributes.key?(:'tin')
    self.tin = attributes[:'tin']
  end

  if attributes.key?(:'giin')
    self.giin = attributes[:'giin']
  end

  if attributes.key?(:'foreign_tin_not_required')
    self.foreign_tin_not_required = attributes[:'foreign_tin_not_required']
  end

  if attributes.key?(:'foreign_tin')
    self.foreign_tin = attributes[:'foreign_tin']
  end

  if attributes.key?(:'reference_number')
    self.reference_number = attributes[:'reference_number']
  end

  if attributes.key?(:'disregarded_entity_fatca_status')
    self.disregarded_entity_fatca_status = attributes[:'disregarded_entity_fatca_status']
  end

  if attributes.key?(:'disregarded_address')
    self.disregarded_address = attributes[:'disregarded_address']
  end

  if attributes.key?(:'disregarded_city')
    self.disregarded_city = attributes[:'disregarded_city']
  end

  if attributes.key?(:'disregarded_state')
    self.disregarded_state = attributes[:'disregarded_state']
  end

  if attributes.key?(:'disregarded_zip')
    self.disregarded_zip = attributes[:'disregarded_zip']
  end

  if attributes.key?(:'disregarded_country')
    self.disregarded_country = attributes[:'disregarded_country']
  end

  if attributes.key?(:'disregarded_entity_giin')
    self.disregarded_entity_giin = attributes[:'disregarded_entity_giin']
  end

  if attributes.key?(:'treaty_country_certification')
    self.treaty_country_certification = attributes[:'treaty_country_certification']
  end

  if attributes.key?(:'treaty_country')
    self.treaty_country = attributes[:'treaty_country']
  end

  if attributes.key?(:'benefit_limitation_certification')
    self.benefit_limitation_certification = attributes[:'benefit_limitation_certification']
  end

  if attributes.key?(:'benefit_limitation')
    self.benefit_limitation = attributes[:'benefit_limitation']
  end

  if attributes.key?(:'qualified_resident_status_certification')
    self.qualified_resident_status_certification = attributes[:'qualified_resident_status_certification']
  end

  if attributes.key?(:'treaty_article')
    self.treaty_article = attributes[:'treaty_article']
  end

  if attributes.key?(:'withholding_rate')
    self.withholding_rate = attributes[:'withholding_rate']
  end

  if attributes.key?(:'income_type')
    self.income_type = attributes[:'income_type']
  end

  if attributes.key?(:'treaty_reasons')
    self.treaty_reasons = attributes[:'treaty_reasons']
  end

  if attributes.key?(:'ffi_sponsoring_entity')
    self.ffi_sponsoring_entity = attributes[:'ffi_sponsoring_entity']
  end

  if attributes.key?(:'investment_entity_certification')
    self.investment_entity_certification = attributes[:'investment_entity_certification']
  end

  if attributes.key?(:'controlled_foreign_corporation_certification')
    self.controlled_foreign_corporation_certification = attributes[:'controlled_foreign_corporation_certification']
  end

  if attributes.key?(:'compliant_nonregistering_local_bank_certification')
    self.compliant_nonregistering_local_bank_certification = attributes[:'compliant_nonregistering_local_bank_certification']
  end

  if attributes.key?(:'compliant_ffi_low_value_accounts_certification')
    self.compliant_ffi_low_value_accounts_certification = attributes[:'compliant_ffi_low_value_accounts_certification']
  end

  if attributes.key?(:'sponsored_closely_held_entity_sponsoring_entity')
    self.sponsored_closely_held_entity_sponsoring_entity = attributes[:'sponsored_closely_held_entity_sponsoring_entity']
  end

  if attributes.key?(:'sponsored_closely_held_investment_vehicle_certification')
    self.sponsored_closely_held_investment_vehicle_certification = attributes[:'sponsored_closely_held_investment_vehicle_certification']
  end

  if attributes.key?(:'compliant_limited_life_debt_entity_certification')
    self.compliant_limited_life_debt_entity_certification = attributes[:'compliant_limited_life_debt_entity_certification']
  end

  if attributes.key?(:'investment_entity_no_financial_accounts_certification')
    self.investment_entity_no_financial_accounts_certification = attributes[:'investment_entity_no_financial_accounts_certification']
  end

  if attributes.key?(:'owner_documented_ffi_certification')
    self.owner_documented_ffi_certification = attributes[:'owner_documented_ffi_certification']
  end

  if attributes.key?(:'owner_documented_ffi_reporting_statement_certification')
    self.owner_documented_ffi_reporting_statement_certification = attributes[:'owner_documented_ffi_reporting_statement_certification']
  end

  if attributes.key?(:'owner_documented_ffi_auditor_letter_certification')
    self.owner_documented_ffi_auditor_letter_certification = attributes[:'owner_documented_ffi_auditor_letter_certification']
  end

  if attributes.key?(:'owner_documented_ffi_trust_beneficiaries_certification')
    self.owner_documented_ffi_trust_beneficiaries_certification = attributes[:'owner_documented_ffi_trust_beneficiaries_certification']
  end

  if attributes.key?(:'restricted_distributor_certification')
    self.restricted_distributor_certification = attributes[:'restricted_distributor_certification']
  end

  if attributes.key?(:'restricted_distributor_agreement_certification')
    self.restricted_distributor_agreement_certification = attributes[:'restricted_distributor_agreement_certification']
  end

  if attributes.key?(:'restricted_distributor_preexisting_sales_compliance_certification')
    self.restricted_distributor_preexisting_sales_compliance_certification = attributes[:'restricted_distributor_preexisting_sales_compliance_certification']
  end

  if attributes.key?(:'nonreporting_iga_ffi_certification')
    self.nonreporting_iga_ffi_certification = attributes[:'nonreporting_iga_ffi_certification']
  end

  if attributes.key?(:'iga_country')
    self.iga_country = attributes[:'iga_country']
  end

  if attributes.key?(:'iga_model')
    self.iga_model = attributes[:'iga_model']
  end

  if attributes.key?(:'iga_legal_status_treatment')
    self.iga_legal_status_treatment = attributes[:'iga_legal_status_treatment']
  end

  if attributes.key?(:'iga_ffi_trustee_or_sponsor')
    self.iga_ffi_trustee_or_sponsor = attributes[:'iga_ffi_trustee_or_sponsor']
  end

  if attributes.key?(:'iga_ffi_trustee_is_foreign')
    self.iga_ffi_trustee_is_foreign = attributes[:'iga_ffi_trustee_is_foreign']
  end

  if attributes.key?(:'non_commercial_financial_activity_certification')
    self.non_commercial_financial_activity_certification = attributes[:'non_commercial_financial_activity_certification']
  end

  if attributes.key?(:'internation_organization_certification')
    self.internation_organization_certification = attributes[:'internation_organization_certification']
  end

  if attributes.key?(:'intergovernmental_organization_certification')
    self.intergovernmental_organization_certification = attributes[:'intergovernmental_organization_certification']
  end

  if attributes.key?(:'treaty_qualified_pension_fund_certification')
    self.treaty_qualified_pension_fund_certification = attributes[:'treaty_qualified_pension_fund_certification']
  end

  if attributes.key?(:'qualified_retirement_fund_certification')
    self.qualified_retirement_fund_certification = attributes[:'qualified_retirement_fund_certification']
  end

  if attributes.key?(:'narrow_participation_retirement_fund_certification')
    self.narrow_participation_retirement_fund_certification = attributes[:'narrow_participation_retirement_fund_certification']
  end

  if attributes.key?(:'section401_a_equivalent_pension_plan_certification')
    self.section401_a_equivalent_pension_plan_certification = attributes[:'section401_a_equivalent_pension_plan_certification']
  end

  if attributes.key?(:'investment_entity_for_retirement_funds_certification')
    self.investment_entity_for_retirement_funds_certification = attributes[:'investment_entity_for_retirement_funds_certification']
  end

  if attributes.key?(:'exempt_beneficial_owner_sponsored_retirement_fund_certification')
    self.exempt_beneficial_owner_sponsored_retirement_fund_certification = attributes[:'exempt_beneficial_owner_sponsored_retirement_fund_certification']
  end

  if attributes.key?(:'exempt_beneficial_owner_owned_investment_entity_certification')
    self.exempt_beneficial_owner_owned_investment_entity_certification = attributes[:'exempt_beneficial_owner_owned_investment_entity_certification']
  end

  if attributes.key?(:'territory_financial_institution_certification')
    self.territory_financial_institution_certification = attributes[:'territory_financial_institution_certification']
  end

  if attributes.key?(:'excepted_nonfinancial_group_entity_certification')
    self.excepted_nonfinancial_group_entity_certification = attributes[:'excepted_nonfinancial_group_entity_certification']
  end

  if attributes.key?(:'excepted_nonfinancial_start_up_certification')
    self.excepted_nonfinancial_start_up_certification = attributes[:'excepted_nonfinancial_start_up_certification']
  end

  if attributes.key?(:'startup_formation_or_resolution_date')
    self.startup_formation_or_resolution_date = attributes[:'startup_formation_or_resolution_date']
  end

  if attributes.key?(:'excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification')
    self.excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification = attributes[:'excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification']
  end

  if attributes.key?(:'nonfinancial_entity_filing_date')
    self.nonfinancial_entity_filing_date = attributes[:'nonfinancial_entity_filing_date']
  end

  if attributes.key?(:'section501_c_organization_certification')
    self.section501_c_organization_certification = attributes[:'section501_c_organization_certification']
  end

  if attributes.key?(:'determination_letter_date')
    self.determination_letter_date = attributes[:'determination_letter_date']
  end

  if attributes.key?(:'nonprofit_organization_certification')
    self.nonprofit_organization_certification = attributes[:'nonprofit_organization_certification']
  end

  if attributes.key?(:'publicly_traded_nffe_certification')
    self.publicly_traded_nffe_certification = attributes[:'publicly_traded_nffe_certification']
  end

  if attributes.key?(:'publicly_traded_nffe_securities_market')
    self.publicly_traded_nffe_securities_market = attributes[:'publicly_traded_nffe_securities_market']
  end

  if attributes.key?(:'nffe_affiliate_of_publicly_traded_entity_certification')
    self.nffe_affiliate_of_publicly_traded_entity_certification = attributes[:'nffe_affiliate_of_publicly_traded_entity_certification']
  end

  if attributes.key?(:'publicly_traded_entity')
    self.publicly_traded_entity = attributes[:'publicly_traded_entity']
  end

  if attributes.key?(:'nffe_affiliate_of_publicly_traded_entity_securities_market')
    self.nffe_affiliate_of_publicly_traded_entity_securities_market = attributes[:'nffe_affiliate_of_publicly_traded_entity_securities_market']
  end

  if attributes.key?(:'excepted_territory_nffe_certification')
    self.excepted_territory_nffe_certification = attributes[:'excepted_territory_nffe_certification']
  end

  if attributes.key?(:'active_nffe_certification')
    self.active_nffe_certification = attributes[:'active_nffe_certification']
  end

  if attributes.key?(:'passive_nffe_certification')
    self.passive_nffe_certification = attributes[:'passive_nffe_certification']
  end

  if attributes.key?(:'passive_nffe_no_substantial_us_owners_certification')
    self.passive_nffe_no_substantial_us_owners_certification = attributes[:'passive_nffe_no_substantial_us_owners_certification']
  end

  if attributes.key?(:'passive_nffe_substantial_us_owners_provided_certification')
    self.passive_nffe_substantial_us_owners_provided_certification = attributes[:'passive_nffe_substantial_us_owners_provided_certification']
  end

  if attributes.key?(:'excepted_inter_affiliate_ffi_certification')
    self.excepted_inter_affiliate_ffi_certification = attributes[:'excepted_inter_affiliate_ffi_certification']
  end

  if attributes.key?(:'sponsored_direct_reporting_nffe_certification')
    self.sponsored_direct_reporting_nffe_certification = attributes[:'sponsored_direct_reporting_nffe_certification']
  end

  if attributes.key?(:'direct_reporting_nffe_sponsoring_entity')
    self.direct_reporting_nffe_sponsoring_entity = attributes[:'direct_reporting_nffe_sponsoring_entity']
  end

  if attributes.key?(:'substantial_us_owners')
    if (value = attributes[:'substantial_us_owners']).is_a?(Array)
      self.substantial_us_owners = value
    end
  end

  if attributes.key?(:'signer_name')
    self.signer_name = attributes[:'signer_name']
  end

  if attributes.key?(:'capacity_to_sign_certification')
    self.capacity_to_sign_certification = attributes[:'capacity_to_sign_certification']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'entry_status')
    self.entry_status = attributes[:'entry_status']
  end

  if attributes.key?(:'entry_status_date')
    self.entry_status_date = attributes[:'entry_status_date']
  end

  if attributes.key?(:'reference_id')
    self.reference_id = attributes[:'reference_id']
  end

  if attributes.key?(:'company_id')
    self.company_id = attributes[:'company_id']
  end

  if attributes.key?(:'display_name')
    self.display_name = attributes[:'display_name']
  end

  if attributes.key?(:'email')
    self.email = attributes[:'email']
  end

  if attributes.key?(:'archived')
    self.archived = attributes[:'archived']
  end

  if attributes.key?(:'signature')
    self.signature = attributes[:'signature']
  end

  if attributes.key?(:'signed_date')
    self.signed_date = attributes[:'signed_date']
  end

  if attributes.key?(:'e_delivery_consented_at')
    self.e_delivery_consented_at = attributes[:'e_delivery_consented_at']
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end
end

Instance Attribute Details

#active_nffe_certificationObject

Certifies that the entity is a foreign non-financial institution with less than 50% passive income and less than 50% of its assets producing or held to produce passive income.



273
274
275
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 273

def active_nffe_certification
  @active_nffe_certification
end

#archivedObject

Indicates whether the form is archived.



327
328
329
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 327

def archived
  @archived
end

#benefit_limitationObject

The benefit limitation for tax treaty claims.



114
115
116
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 114

def benefit_limitation
  @benefit_limitation
end

#benefit_limitation_certificationObject

Certifies that the beneficial owner is eligible for treaty benefits and meets any limitation on benefits requirements.



111
112
113
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 111

def benefit_limitation_certification
  @benefit_limitation_certification
end

#capacity_to_sign_certificationObject

Certifies signer has the capacity to sign for the beneficial owner.



300
301
302
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 300

def capacity_to_sign_certification
  @capacity_to_sign_certification
end

#citizenship_countryObject

The country of citizenship.



18
19
20
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 18

def citizenship_country
  @citizenship_country
end

#company_idObject

The ID of the associated company.



318
319
320
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 318

def company_id
  @company_id
end

#compliant_ffi_low_value_accounts_certificationObject

Certifies that the FFI is not primarily engaged in investment activities, maintains only low-value accounts, and has limited total assets within its group.



144
145
146
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 144

def compliant_ffi_low_value_accounts_certification
  @compliant_ffi_low_value_accounts_certification
end

#compliant_limited_life_debt_entity_certificationObject

Certifies that the entity qualifies as a limited life debt investment entity based on its formation date, issuance terms, and compliance with regulatory requirements.



153
154
155
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 153

def compliant_limited_life_debt_entity_certification
  @compliant_limited_life_debt_entity_certification
end

#compliant_nonregistering_local_bank_certificationObject

Certifies that the FFI operates solely as a limited bank or credit union within its country, meets asset thresholds, and has no foreign operations or affiliations outside its country of organization.



141
142
143
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 141

def compliant_nonregistering_local_bank_certification
  @compliant_nonregistering_local_bank_certification
end

#controlled_foreign_corporation_certificationObject

Certifies that the entity is a controlled foreign corporation sponsored by a U.S. financial institution, not a QI, WP, or WT, and shares a common electronic account system for full transparency.



138
139
140
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 138

def controlled_foreign_corporation_certification
  @controlled_foreign_corporation_certification
end

#created_atObject

The creation date of the form.



339
340
341
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 339

def created_at
  @created_at
end

#determination_letter_dateObject

The date of the IRS determination letter confirming the entity’s section 501© status.



249
250
251
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 249

def determination_letter_date
  @determination_letter_date
end

#direct_reporting_nffe_sponsoring_entityObject

The name of the entity that sponsors the direct reporting NFFE.



291
292
293
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 291

def direct_reporting_nffe_sponsoring_entity
  @direct_reporting_nffe_sponsoring_entity
end

#display_nameObject

The display name associated with the form.



321
322
323
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 321

def display_name
  @display_name
end

#disregarded_addressObject

The address for disregarded entities.



87
88
89
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 87

def disregarded_address
  @disregarded_address
end

#disregarded_cityObject

The city for disregarded entities.



90
91
92
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 90

def disregarded_city
  @disregarded_city
end

#disregarded_countryObject

The country for disregarded entities.



99
100
101
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 99

def disregarded_country
  @disregarded_country
end

#disregarded_entityObject

The name of the disregarded entity receiving the payment (if applicable).



21
22
23
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 21

def disregarded_entity
  @disregarded_entity
end

#disregarded_entity_fatca_statusObject

The FATCA status of disregarded entity or branch receiving payment.



84
85
86
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 84

def disregarded_entity_fatca_status
  @disregarded_entity_fatca_status
end

#disregarded_entity_giinObject

The GIIN for disregarded entities.



102
103
104
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 102

def disregarded_entity_giin
  @disregarded_entity_giin
end

#disregarded_stateObject

The state for disregarded entities.



93
94
95
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 93

def disregarded_state
  @disregarded_state
end

#disregarded_zipObject

The ZIP code for disregarded entities.



96
97
98
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 96

def disregarded_zip
  @disregarded_zip
end

#e_delivery_consented_atObject

The date when e-delivery was consented.



336
337
338
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 336

def e_delivery_consented_at
  @e_delivery_consented_at
end

#emailObject

The email address of the individual associated with the form.



324
325
326
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 324

def email
  @email
end

#entity_typeObject

The entity type.



24
25
26
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 24

def entity_type
  @entity_type
end

#entry_statusObject

The form status.



309
310
311
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 309

def entry_status
  @entry_status
end

#entry_status_dateObject

The timestamp for the latest status update.



312
313
314
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 312

def entry_status_date
  @entry_status_date
end

#excepted_inter_affiliate_ffi_certificationObject

Certifies that the entity is an inter-affiliate FFI meeting all conditions for exemption, including limited account activity and payment interactions within its expanded affiliated group.



285
286
287
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 285

def excepted_inter_affiliate_ffi_certification
  @excepted_inter_affiliate_ffi_certification
end

#excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certificationObject

Certifies that the entity is in liquidation, reorganization, or bankruptcy and intends to operate as a nonfinancial entity, with supporting documentation available if the process exceeds three years.



240
241
242
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 240

def excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification
  @excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification
end

#excepted_nonfinancial_group_entity_certificationObject

Certifies that the entity is a holding company, treasury center, or captive finance company operating within a nonfinancial group and not functioning as an investment or financial institution.



231
232
233
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 231

def excepted_nonfinancial_group_entity_certification
  @excepted_nonfinancial_group_entity_certification
end

#excepted_nonfinancial_start_up_certificationObject

Certifies that the entity is a recently formed startup NFFE investing in a non-financial business and is not operating as or presenting itself as an investment fund.



234
235
236
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 234

def excepted_nonfinancial_start_up_certification
  @excepted_nonfinancial_start_up_certification
end

#excepted_territory_nffe_certificationObject

Certifies that the entity is organized in a U.S. possession, is not engaged in financial activities, and is entirely owned by bona fide residents of that possession.



270
271
272
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 270

def excepted_territory_nffe_certification
  @excepted_territory_nffe_certification
end

#exempt_beneficial_owner_owned_investment_entity_certificationObject

Certifies that the entity is an investment entity wholly owned by exempt beneficial owners and has provided complete ownership and documentation details as required under FATCA regulations.



225
226
227
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 225

def exempt_beneficial_owner_owned_investment_entity_certification
  @exempt_beneficial_owner_owned_investment_entity_certification
end

#exempt_beneficial_owner_sponsored_retirement_fund_certificationObject

Certifies that the entity is established and sponsored by a qualifying exempt beneficial owner to provide retirement, disability, or death benefits to individuals based on services performed for the sponsor.



222
223
224
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 222

def exempt_beneficial_owner_sponsored_retirement_fund_certification
  @exempt_beneficial_owner_sponsored_retirement_fund_certification
end

#fatca_statusObject

The FATCA status.



30
31
32
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 30

def fatca_status
  @fatca_status
end

#ffi_sponsoring_entityObject

The name of the entity that sponsors the foreign financial institution (FFI).



132
133
134
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 132

def ffi_sponsoring_entity
  @ffi_sponsoring_entity
end

#foreign_tinObject

The foreign taxpayer identification number (TIN).



78
79
80
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 78

def foreign_tin
  @foreign_tin
end

#foreign_tin_not_requiredObject

Indicates whether a foreign TIN is not required.



75
76
77
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 75

def foreign_tin_not_required
  @foreign_tin_not_required
end

#giinObject

The global intermediary identification number (GIIN).



72
73
74
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 72

def giin
  @giin
end

#idObject

The unique identifier for the form.



303
304
305
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 303

def id
  @id
end

#iga_countryObject

The country for the applicable IGA with the United States.



183
184
185
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 183

def iga_country
  @iga_country
end

#iga_ffi_trustee_is_foreignObject

Indicates whether the trustee for the nonreporting IGA FFI is foreign.



195
196
197
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 195

def iga_ffi_trustee_is_foreign
  @iga_ffi_trustee_is_foreign
end

#iga_ffi_trustee_or_sponsorObject

The trustee or sponsor name for the nonreporting IGA FFI.



192
193
194
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 192

def iga_ffi_trustee_or_sponsor
  @iga_ffi_trustee_or_sponsor
end

Specifies how the applicable IGA is treated under the IGA provisions or Treasury regulations.



189
190
191
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 189

def iga_legal_status_treatment
  @iga_legal_status_treatment
end

#iga_modelObject

The applicable IGA model.



186
187
188
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 186

def iga_model
  @iga_model
end

#income_typeObject

Specifies the type of income for which the reduced treaty withholding rate is being claimed.



126
127
128
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 126

def income_type
  @income_type
end

#intergovernmental_organization_certificationObject

Certifies that the entity is an intergovernmental or supranational organization primarily comprised of foreign governments, is the beneficial owner, and is not engaged in commercial financial activities.



204
205
206
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 204

def intergovernmental_organization_certification
  @intergovernmental_organization_certification
end

#internation_organization_certificationObject

Certifies that the entity is an international organization described in section 7701(a)(18).



201
202
203
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 201

def internation_organization_certification
  @internation_organization_certification
end

#investment_entity_certificationObject

Certifies that the entity is an investment entity, not a QI, WP, or WT, and has an agreement with a sponsoring entity.



135
136
137
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 135

def investment_entity_certification
  @investment_entity_certification
end

#investment_entity_for_retirement_funds_certificationObject

Certifies that the entity is established solely to earn income for the benefit of qualifying retirement funds or accounts under applicable FATCA regulations or IGAs.



219
220
221
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 219

def investment_entity_for_retirement_funds_certification
  @investment_entity_for_retirement_funds_certification
end

#investment_entity_no_financial_accounts_certificationObject

Certifies that the entity is a financial institution solely because it is an investment entity under regulations and the entity does not maintain financial accounts.



156
157
158
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 156

def investment_entity_no_financial_accounts_certification
  @investment_entity_no_financial_accounts_certification
end

#mailing_addressObject

The mailing address.



51
52
53
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 51

def mailing_address
  @mailing_address
end

#mailing_cityObject

The city of the mailing address.



54
55
56
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 54

def mailing_city
  @mailing_city
end

#mailing_countryObject

The country of the mailing address.



63
64
65
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 63

def mailing_country
  @mailing_country
end

#mailing_stateObject

The state of the mailing address.



57
58
59
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 57

def mailing_state
  @mailing_state
end

#mailing_zipObject

The ZIP code of the mailing address.



60
61
62
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 60

def mailing_zip
  @mailing_zip
end

#making_treaty_claimObject

Indicates whether the entity is making a treaty claim.



27
28
29
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 27

def making_treaty_claim
  @making_treaty_claim
end

#nameObject

The name of the individual or entity associated with the form.



15
16
17
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 15

def name
  @name
end

#narrow_participation_retirement_fund_certificationObject

Certifies that the entity is a government-regulated retirement fund with fewer than 50 participants, limited foreign ownership, and employer sponsorship that is not from investment entities or passive NFFEs.



213
214
215
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 213

def narrow_participation_retirement_fund_certification
  @narrow_participation_retirement_fund_certification
end

#nffe_affiliate_of_publicly_traded_entity_certificationObject

Certifies that the entity is a foreign corporation that is not a financial institution and is affiliated with a publicly traded entity within the same expanded affiliated group.



261
262
263
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 261

def nffe_affiliate_of_publicly_traded_entity_certification
  @nffe_affiliate_of_publicly_traded_entity_certification
end

#nffe_affiliate_of_publicly_traded_entity_securities_marketObject

The name of the established securities market where the affiliated entity’s stock is traded.



267
268
269
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 267

def nffe_affiliate_of_publicly_traded_entity_securities_market
  @nffe_affiliate_of_publicly_traded_entity_securities_market
end

#non_commercial_financial_activity_certificationObject

Certifies that the entity is the beneficial owner and is not engaged in commercial financial activities related to the specified payments, accounts or obligations for which this form is submitted.



198
199
200
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 198

def non_commercial_financial_activity_certification
  @non_commercial_financial_activity_certification
end

#nonfinancial_entity_filing_dateObject

The filed date for a plan of reorganization, liquidation or bankruptcy.



243
244
245
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 243

def nonfinancial_entity_filing_date
  @nonfinancial_entity_filing_date
end

#nonprofit_organization_certificationObject

Certifies that the entity is a nonprofit organization established for charitable or similar purposes, exempt from income tax, and restricted in the use and distribution of its assets under applicable law.



252
253
254
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 252

def nonprofit_organization_certification
  @nonprofit_organization_certification
end

#nonreporting_iga_ffi_certificationObject

Certifies that the entity meets the requirements to be considered a nonreporting financial institution to an applicable IGA.



180
181
182
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 180

def nonreporting_iga_ffi_certification
  @nonreporting_iga_ffi_certification
end

#owner_documented_ffi_auditor_letter_certificationObject

Certifies that the FFI will provide an auditor’s letter and required owner reporting documentation to confirm its status as an owner-documented FFI.



165
166
167
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 165

def owner_documented_ffi_auditor_letter_certification
  @owner_documented_ffi_auditor_letter_certification
end

#owner_documented_ffi_certificationObject

Certifies that the FFI meets all requirements to qualify as an owner-documented FFI, including restrictions on activities, ownership, and account relationships.



159
160
161
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 159

def owner_documented_ffi_certification
  @owner_documented_ffi_certification
end

#owner_documented_ffi_reporting_statement_certificationObject

Certifies that the FFI will provide a complete owner reporting statement and required documentation for each relevant owner or debt holder.



162
163
164
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 162

def owner_documented_ffi_reporting_statement_certification
  @owner_documented_ffi_reporting_statement_certification
end

#owner_documented_ffi_trust_beneficiaries_certificationObject

Certifies that the trust has no contingent or unidentified beneficiaries or designated classes of beneficiaries.



168
169
170
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 168

def owner_documented_ffi_trust_beneficiaries_certification
  @owner_documented_ffi_trust_beneficiaries_certification
end

#passive_nffe_certificationObject

Certifies that the entity is a foreign non-financial entity that does not qualify for any other NFFE category and is not a financial institution.



276
277
278
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 276

def passive_nffe_certification
  @passive_nffe_certification
end

#passive_nffe_no_substantial_us_owners_certificationObject

Certifies that the passive NFFE has no substantial U.S. owners or controlling U.S. persons.



279
280
281
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 279

def passive_nffe_no_substantial_us_owners_certification
  @passive_nffe_no_substantial_us_owners_certification
end

#passive_nffe_substantial_us_owners_provided_certificationObject

Certifies that the passive NFFE has provided the name, address, and TIN of each substantial U.S. owner or controlling U.S. person.



282
283
284
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 282

def passive_nffe_substantial_us_owners_provided_certification
  @passive_nffe_substantial_us_owners_provided_certification
end

#publicly_traded_entityObject

The name of the affiliated entity whose stock is regularly traded on an established securities market.



264
265
266
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 264

def publicly_traded_entity
  @publicly_traded_entity
end

#publicly_traded_nffe_certificationObject

Certifies that the entity is a foreign corporation that is not a financial institution and whose stock is regularly traded on an established securities market.



255
256
257
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 255

def publicly_traded_nffe_certification
  @publicly_traded_nffe_certification
end

#publicly_traded_nffe_securities_marketObject

The name of the securities market where the corporation’s stock is regularly traded.



258
259
260
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 258

def publicly_traded_nffe_securities_market
  @publicly_traded_nffe_securities_market
end

#qualified_resident_status_certificationObject

Certifies that the beneficial owner claims treaty benefits and meets the qualified resident status for specific U.S. source income.



117
118
119
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 117

def qualified_resident_status_certification
  @qualified_resident_status_certification
end

#qualified_retirement_fund_certificationObject

Certifies that the entity is a government-regulated retirement fund meeting specific requirements for contributions, tax exemption, beneficiary limits, and distribution restrictions.



210
211
212
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 210

def qualified_retirement_fund_certification
  @qualified_retirement_fund_certification
end

#reference_idObject

A reference identifier for the form.



315
316
317
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 315

def reference_id
  @reference_id
end

#reference_numberObject

A reference number for the form.



81
82
83
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 81

def reference_number
  @reference_number
end

#residence_addressObject

The residential address of the individual or entity.



33
34
35
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 33

def residence_address
  @residence_address
end

#residence_cityObject

The city of residence.



36
37
38
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 36

def residence_city
  @residence_city
end

#residence_countryObject

The country of residence.



45
46
47
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 45

def residence_country
  @residence_country
end

#residence_is_mailingObject

Indicates whether the residence address is also the mailing address.



48
49
50
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 48

def residence_is_mailing
  @residence_is_mailing
end

#residence_stateObject

The state of residence.



39
40
41
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 39

def residence_state
  @residence_state
end

#residence_zipObject

The ZIP code of the residence.



42
43
44
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 42

def residence_zip
  @residence_zip
end

#restricted_distributor_agreement_certificationObject

Certifies that the entity is, and has been, bound by distribution agreements prohibiting sales of fund interests to specified U.S. persons and certain non-U.S. entities.



174
175
176
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 174

def restricted_distributor_agreement_certification
  @restricted_distributor_agreement_certification
end

#restricted_distributor_certificationObject

Certifies that the entity qualifies as a restricted distributor based on its operations, customer base, regulatory compliance, and financial and geographic limitations.



171
172
173
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 171

def restricted_distributor_certification
  @restricted_distributor_certification
end

#restricted_distributor_preexisting_sales_compliance_certificationObject

Certifies that the entity complies with distribution restrictions for U.S.-linked investors and has addressed any preexisting sales in accordance with FATCA regulations.



177
178
179
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 177

def restricted_distributor_preexisting_sales_compliance_certification
  @restricted_distributor_preexisting_sales_compliance_certification
end

#section401_a_equivalent_pension_plan_certificationObject

Certifies that the entity is formed under a pension plan meeting section 401(a) requirements, except for being U.S.-trust funded.



216
217
218
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 216

def section401_a_equivalent_pension_plan_certification
  @section401_a_equivalent_pension_plan_certification
end

#section501_c_organization_certificationObject

Certifies that the entity is a section 501© organization based on a valid IRS determination letter or a legal opinion from U.S. counsel.



246
247
248
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 246

def section501_c_organization_certification
  @section501_c_organization_certification
end

#signatureObject

The signature of the form.



330
331
332
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 330

def signature
  @signature
end

#signed_dateObject

The date the form was signed.



333
334
335
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 333

def signed_date
  @signed_date
end

#signer_nameObject

The name of the signer.



297
298
299
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 297

def signer_name
  @signer_name
end

The name of sponsoring entity for a certified deemed-compliant, closely held investment vehicle.



147
148
149
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 147

def sponsored_closely_held_entity_sponsoring_entity
  @sponsored_closely_held_entity_sponsoring_entity
end

Certifies that the entity is a sponsored investment entity with 20 or fewer individual owners, and that all compliance obligations are fulfilled by the sponsoring entity.



150
151
152
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 150

def sponsored_closely_held_investment_vehicle_certification
  @sponsored_closely_held_investment_vehicle_certification
end

Certifies that the entity is a sponsored direct reporting NFFE.



288
289
290
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 288

def sponsored_direct_reporting_nffe_certification
  @sponsored_direct_reporting_nffe_certification
end

#startup_formation_or_resolution_dateObject

The date the start-up company was formed on (or, in case of new line of business, the date of board resolution approving the new line of business).



237
238
239
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 237

def startup_formation_or_resolution_date
  @startup_formation_or_resolution_date
end

#substantial_us_ownersObject

The list of substantial U.S. owners of passive NFFE.



294
295
296
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 294

def substantial_us_owners
  @substantial_us_owners
end

#territory_financial_institution_certificationObject

Certifies that the entity is a financial institution (other than an investment entity) that is incorporated or organized under the laws of a possession of the United States.



228
229
230
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 228

def territory_financial_institution_certification
  @territory_financial_institution_certification
end

#tinObject

The taxpayer identification number (TIN).



69
70
71
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 69

def tin
  @tin
end

#tin_typeObject

The type of TIN provided.



66
67
68
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 66

def tin_type
  @tin_type
end

#treaty_articleObject

Indicates the specific article and paragraph of the tax treaty under which the beneficial owner is claiming benefits.



120
121
122
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 120

def treaty_article
  @treaty_article
end

#treaty_countryObject

The treaty country of the beneficial owner.



108
109
110
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 108

def treaty_country
  @treaty_country
end

#treaty_country_certificationObject

Certifies the beneficial owner’s country under the U.S. tax treaty.



105
106
107
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 105

def treaty_country_certification
  @treaty_country_certification
end

#treaty_qualified_pension_fund_certificationObject

Certifies that the entity is a pension or retirement fund established in a treaty country and is entitled to treaty benefits on U.S. source income.



207
208
209
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 207

def treaty_qualified_pension_fund_certification
  @treaty_qualified_pension_fund_certification
end

#treaty_reasonsObject

The additional conditions in the article the beneficial owner meets to be eligible for the rate of withholding.



129
130
131
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 129

def treaty_reasons
  @treaty_reasons
end

#typeObject

The form type.



306
307
308
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 306

def type
  @type
end

#updated_atObject

The last updated date of the form.



342
343
344
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 342

def updated_at
  @updated_at
end

#withholding_rateObject

Specifies the reduced withholding rate claimed under the applicable tax treaty.



123
124
125
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 123

def withholding_rate
  @withholding_rate
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 1269

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

.acceptable_attributesObject

Returns all the JSON keys this model knows about



461
462
463
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 461

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 345

def self.attribute_map
  {
    :'name' => :'name',
    :'citizenship_country' => :'citizenshipCountry',
    :'disregarded_entity' => :'disregardedEntity',
    :'entity_type' => :'entityType',
    :'making_treaty_claim' => :'makingTreatyClaim',
    :'fatca_status' => :'fatcaStatus',
    :'residence_address' => :'residenceAddress',
    :'residence_city' => :'residenceCity',
    :'residence_state' => :'residenceState',
    :'residence_zip' => :'residenceZip',
    :'residence_country' => :'residenceCountry',
    :'residence_is_mailing' => :'residenceIsMailing',
    :'mailing_address' => :'mailingAddress',
    :'mailing_city' => :'mailingCity',
    :'mailing_state' => :'mailingState',
    :'mailing_zip' => :'mailingZip',
    :'mailing_country' => :'mailingCountry',
    :'tin_type' => :'tinType',
    :'tin' => :'tin',
    :'giin' => :'giin',
    :'foreign_tin_not_required' => :'foreignTinNotRequired',
    :'foreign_tin' => :'foreignTin',
    :'reference_number' => :'referenceNumber',
    :'disregarded_entity_fatca_status' => :'disregardedEntityFatcaStatus',
    :'disregarded_address' => :'disregardedAddress',
    :'disregarded_city' => :'disregardedCity',
    :'disregarded_state' => :'disregardedState',
    :'disregarded_zip' => :'disregardedZip',
    :'disregarded_country' => :'disregardedCountry',
    :'disregarded_entity_giin' => :'disregardedEntityGiin',
    :'treaty_country_certification' => :'treatyCountryCertification',
    :'treaty_country' => :'treatyCountry',
    :'benefit_limitation_certification' => :'benefitLimitationCertification',
    :'benefit_limitation' => :'benefitLimitation',
    :'qualified_resident_status_certification' => :'qualifiedResidentStatusCertification',
    :'treaty_article' => :'treatyArticle',
    :'withholding_rate' => :'withholdingRate',
    :'income_type' => :'incomeType',
    :'treaty_reasons' => :'treatyReasons',
    :'ffi_sponsoring_entity' => :'ffiSponsoringEntity',
    :'investment_entity_certification' => :'investmentEntityCertification',
    :'controlled_foreign_corporation_certification' => :'controlledForeignCorporationCertification',
    :'compliant_nonregistering_local_bank_certification' => :'compliantNonregisteringLocalBankCertification',
    :'compliant_ffi_low_value_accounts_certification' => :'compliantFfiLowValueAccountsCertification',
    :'sponsored_closely_held_entity_sponsoring_entity' => :'sponsoredCloselyHeldEntitySponsoringEntity',
    :'sponsored_closely_held_investment_vehicle_certification' => :'sponsoredCloselyHeldInvestmentVehicleCertification',
    :'compliant_limited_life_debt_entity_certification' => :'compliantLimitedLifeDebtEntityCertification',
    :'investment_entity_no_financial_accounts_certification' => :'investmentEntityNoFinancialAccountsCertification',
    :'owner_documented_ffi_certification' => :'ownerDocumentedFfiCertification',
    :'owner_documented_ffi_reporting_statement_certification' => :'ownerDocumentedFfiReportingStatementCertification',
    :'owner_documented_ffi_auditor_letter_certification' => :'ownerDocumentedFfiAuditorLetterCertification',
    :'owner_documented_ffi_trust_beneficiaries_certification' => :'ownerDocumentedFfiTrustBeneficiariesCertification',
    :'restricted_distributor_certification' => :'restrictedDistributorCertification',
    :'restricted_distributor_agreement_certification' => :'restrictedDistributorAgreementCertification',
    :'restricted_distributor_preexisting_sales_compliance_certification' => :'restrictedDistributorPreexistingSalesComplianceCertification',
    :'nonreporting_iga_ffi_certification' => :'nonreportingIgaFfiCertification',
    :'iga_country' => :'igaCountry',
    :'iga_model' => :'igaModel',
    :'iga_legal_status_treatment' => :'igaLegalStatusTreatment',
    :'iga_ffi_trustee_or_sponsor' => :'igaFfiTrusteeOrSponsor',
    :'iga_ffi_trustee_is_foreign' => :'igaFfiTrusteeIsForeign',
    :'non_commercial_financial_activity_certification' => :'nonCommercialFinancialActivityCertification',
    :'internation_organization_certification' => :'internationOrganizationCertification',
    :'intergovernmental_organization_certification' => :'intergovernmentalOrganizationCertification',
    :'treaty_qualified_pension_fund_certification' => :'treatyQualifiedPensionFundCertification',
    :'qualified_retirement_fund_certification' => :'qualifiedRetirementFundCertification',
    :'narrow_participation_retirement_fund_certification' => :'narrowParticipationRetirementFundCertification',
    :'section401_a_equivalent_pension_plan_certification' => :'section401AEquivalentPensionPlanCertification',
    :'investment_entity_for_retirement_funds_certification' => :'investmentEntityForRetirementFundsCertification',
    :'exempt_beneficial_owner_sponsored_retirement_fund_certification' => :'exemptBeneficialOwnerSponsoredRetirementFundCertification',
    :'exempt_beneficial_owner_owned_investment_entity_certification' => :'exemptBeneficialOwnerOwnedInvestmentEntityCertification',
    :'territory_financial_institution_certification' => :'territoryFinancialInstitutionCertification',
    :'excepted_nonfinancial_group_entity_certification' => :'exceptedNonfinancialGroupEntityCertification',
    :'excepted_nonfinancial_start_up_certification' => :'exceptedNonfinancialStartUpCertification',
    :'startup_formation_or_resolution_date' => :'startupFormationOrResolutionDate',
    :'excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification' => :'exceptedNonfinancialEntityInLiquidationOrBankruptcyCertification',
    :'nonfinancial_entity_filing_date' => :'nonfinancialEntityFilingDate',
    :'section501_c_organization_certification' => :'section501COrganizationCertification',
    :'determination_letter_date' => :'determinationLetterDate',
    :'nonprofit_organization_certification' => :'nonprofitOrganizationCertification',
    :'publicly_traded_nffe_certification' => :'publiclyTradedNffeCertification',
    :'publicly_traded_nffe_securities_market' => :'publiclyTradedNffeSecuritiesMarket',
    :'nffe_affiliate_of_publicly_traded_entity_certification' => :'nffeAffiliateOfPubliclyTradedEntityCertification',
    :'publicly_traded_entity' => :'publiclyTradedEntity',
    :'nffe_affiliate_of_publicly_traded_entity_securities_market' => :'nffeAffiliateOfPubliclyTradedEntitySecuritiesMarket',
    :'excepted_territory_nffe_certification' => :'exceptedTerritoryNffeCertification',
    :'active_nffe_certification' => :'activeNffeCertification',
    :'passive_nffe_certification' => :'passiveNffeCertification',
    :'passive_nffe_no_substantial_us_owners_certification' => :'passiveNffeNoSubstantialUsOwnersCertification',
    :'passive_nffe_substantial_us_owners_provided_certification' => :'passiveNffeSubstantialUsOwnersProvidedCertification',
    :'excepted_inter_affiliate_ffi_certification' => :'exceptedInterAffiliateFfiCertification',
    :'sponsored_direct_reporting_nffe_certification' => :'sponsoredDirectReportingNffeCertification',
    :'direct_reporting_nffe_sponsoring_entity' => :'directReportingNffeSponsoringEntity',
    :'substantial_us_owners' => :'substantialUsOwners',
    :'signer_name' => :'signerName',
    :'capacity_to_sign_certification' => :'capacityToSignCertification',
    :'id' => :'id',
    :'type' => :'type',
    :'entry_status' => :'entryStatus',
    :'entry_status_date' => :'entryStatusDate',
    :'reference_id' => :'referenceId',
    :'company_id' => :'companyId',
    :'display_name' => :'displayName',
    :'email' => :'email',
    :'archived' => :'archived',
    :'signature' => :'signature',
    :'signed_date' => :'signedDate',
    :'e_delivery_consented_at' => :'eDeliveryConsentedAt',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 1245

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

.openapi_all_ofObject

List of class defined in allOf (OpenAPI v3)



634
635
636
637
638
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 634

def self.openapi_all_of
  [
  :'W9FormBaseResponse'
  ]
end

.openapi_nullableObject

List of attributes with nullable: true



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 582

def self.openapi_nullable
  Set.new([
    :'disregarded_entity',
    :'residence_state',
    :'mailing_address',
    :'mailing_city',
    :'mailing_state',
    :'mailing_zip',
    :'mailing_country',
    :'tin_type',
    :'tin',
    :'giin',
    :'foreign_tin',
    :'reference_number',
    :'disregarded_entity_fatca_status',
    :'disregarded_address',
    :'disregarded_city',
    :'disregarded_state',
    :'disregarded_zip',
    :'disregarded_country',
    :'disregarded_entity_giin',
    :'treaty_country',
    :'benefit_limitation',
    :'treaty_article',
    :'withholding_rate',
    :'income_type',
    :'treaty_reasons',
    :'ffi_sponsoring_entity',
    :'sponsored_closely_held_entity_sponsoring_entity',
    :'iga_country',
    :'iga_model',
    :'iga_legal_status_treatment',
    :'iga_ffi_trustee_or_sponsor',
    :'iga_ffi_trustee_is_foreign',
    :'startup_formation_or_resolution_date',
    :'nonfinancial_entity_filing_date',
    :'determination_letter_date',
    :'publicly_traded_nffe_securities_market',
    :'publicly_traded_entity',
    :'nffe_affiliate_of_publicly_traded_entity_securities_market',
    :'direct_reporting_nffe_sponsoring_entity',
    :'signer_name',
    :'entry_status_date',
    :'reference_id',
    :'email',
    :'signature',
    :'signed_date',
    :'e_delivery_consented_at',
  ])
end

.openapi_typesObject

Attribute type mapping.



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 466

def self.openapi_types
  {
    :'name' => :'String',
    :'citizenship_country' => :'String',
    :'disregarded_entity' => :'String',
    :'entity_type' => :'String',
    :'making_treaty_claim' => :'Boolean',
    :'fatca_status' => :'String',
    :'residence_address' => :'String',
    :'residence_city' => :'String',
    :'residence_state' => :'String',
    :'residence_zip' => :'String',
    :'residence_country' => :'String',
    :'residence_is_mailing' => :'Boolean',
    :'mailing_address' => :'String',
    :'mailing_city' => :'String',
    :'mailing_state' => :'String',
    :'mailing_zip' => :'String',
    :'mailing_country' => :'String',
    :'tin_type' => :'String',
    :'tin' => :'String',
    :'giin' => :'String',
    :'foreign_tin_not_required' => :'Boolean',
    :'foreign_tin' => :'String',
    :'reference_number' => :'String',
    :'disregarded_entity_fatca_status' => :'String',
    :'disregarded_address' => :'String',
    :'disregarded_city' => :'String',
    :'disregarded_state' => :'String',
    :'disregarded_zip' => :'String',
    :'disregarded_country' => :'String',
    :'disregarded_entity_giin' => :'String',
    :'treaty_country_certification' => :'Boolean',
    :'treaty_country' => :'String',
    :'benefit_limitation_certification' => :'Boolean',
    :'benefit_limitation' => :'String',
    :'qualified_resident_status_certification' => :'Boolean',
    :'treaty_article' => :'String',
    :'withholding_rate' => :'String',
    :'income_type' => :'String',
    :'treaty_reasons' => :'String',
    :'ffi_sponsoring_entity' => :'String',
    :'investment_entity_certification' => :'Boolean',
    :'controlled_foreign_corporation_certification' => :'Boolean',
    :'compliant_nonregistering_local_bank_certification' => :'Boolean',
    :'compliant_ffi_low_value_accounts_certification' => :'Boolean',
    :'sponsored_closely_held_entity_sponsoring_entity' => :'String',
    :'sponsored_closely_held_investment_vehicle_certification' => :'Boolean',
    :'compliant_limited_life_debt_entity_certification' => :'Boolean',
    :'investment_entity_no_financial_accounts_certification' => :'Boolean',
    :'owner_documented_ffi_certification' => :'Boolean',
    :'owner_documented_ffi_reporting_statement_certification' => :'Boolean',
    :'owner_documented_ffi_auditor_letter_certification' => :'Boolean',
    :'owner_documented_ffi_trust_beneficiaries_certification' => :'Boolean',
    :'restricted_distributor_certification' => :'Boolean',
    :'restricted_distributor_agreement_certification' => :'Boolean',
    :'restricted_distributor_preexisting_sales_compliance_certification' => :'Boolean',
    :'nonreporting_iga_ffi_certification' => :'Boolean',
    :'iga_country' => :'String',
    :'iga_model' => :'String',
    :'iga_legal_status_treatment' => :'String',
    :'iga_ffi_trustee_or_sponsor' => :'String',
    :'iga_ffi_trustee_is_foreign' => :'Boolean',
    :'non_commercial_financial_activity_certification' => :'Boolean',
    :'internation_organization_certification' => :'Boolean',
    :'intergovernmental_organization_certification' => :'Boolean',
    :'treaty_qualified_pension_fund_certification' => :'Boolean',
    :'qualified_retirement_fund_certification' => :'Boolean',
    :'narrow_participation_retirement_fund_certification' => :'Boolean',
    :'section401_a_equivalent_pension_plan_certification' => :'Boolean',
    :'investment_entity_for_retirement_funds_certification' => :'Boolean',
    :'exempt_beneficial_owner_sponsored_retirement_fund_certification' => :'Boolean',
    :'exempt_beneficial_owner_owned_investment_entity_certification' => :'Boolean',
    :'territory_financial_institution_certification' => :'Boolean',
    :'excepted_nonfinancial_group_entity_certification' => :'Boolean',
    :'excepted_nonfinancial_start_up_certification' => :'Boolean',
    :'startup_formation_or_resolution_date' => :'Time',
    :'excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification' => :'Boolean',
    :'nonfinancial_entity_filing_date' => :'Time',
    :'section501_c_organization_certification' => :'Boolean',
    :'determination_letter_date' => :'Time',
    :'nonprofit_organization_certification' => :'Boolean',
    :'publicly_traded_nffe_certification' => :'Boolean',
    :'publicly_traded_nffe_securities_market' => :'String',
    :'nffe_affiliate_of_publicly_traded_entity_certification' => :'Boolean',
    :'publicly_traded_entity' => :'String',
    :'nffe_affiliate_of_publicly_traded_entity_securities_market' => :'String',
    :'excepted_territory_nffe_certification' => :'Boolean',
    :'active_nffe_certification' => :'Boolean',
    :'passive_nffe_certification' => :'Boolean',
    :'passive_nffe_no_substantial_us_owners_certification' => :'Boolean',
    :'passive_nffe_substantial_us_owners_provided_certification' => :'Boolean',
    :'excepted_inter_affiliate_ffi_certification' => :'Boolean',
    :'sponsored_direct_reporting_nffe_certification' => :'Boolean',
    :'direct_reporting_nffe_sponsoring_entity' => :'String',
    :'substantial_us_owners' => :'Array<SubstantialUsOwnerResponse>',
    :'signer_name' => :'String',
    :'capacity_to_sign_certification' => :'Boolean',
    :'id' => :'String',
    :'type' => :'String',
    :'entry_status' => :'String',
    :'entry_status_date' => :'Time',
    :'reference_id' => :'String',
    :'company_id' => :'String',
    :'display_name' => :'String',
    :'email' => :'String',
    :'archived' => :'Boolean',
    :'signature' => :'String',
    :'signed_date' => :'Time',
    :'e_delivery_consented_at' => :'Time',
    :'created_at' => :'Time',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 1115

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      citizenship_country == o.citizenship_country &&
      disregarded_entity == o.disregarded_entity &&
      entity_type == o.entity_type &&
      making_treaty_claim == o.making_treaty_claim &&
      fatca_status == o.fatca_status &&
      residence_address == o.residence_address &&
      residence_city == o.residence_city &&
      residence_state == o.residence_state &&
      residence_zip == o.residence_zip &&
      residence_country == o.residence_country &&
      residence_is_mailing == o.residence_is_mailing &&
      mailing_address == o.mailing_address &&
      mailing_city == o.mailing_city &&
      mailing_state == o.mailing_state &&
      mailing_zip == o.mailing_zip &&
      mailing_country == o.mailing_country &&
      tin_type == o.tin_type &&
      tin == o.tin &&
      giin == o.giin &&
      foreign_tin_not_required == o.foreign_tin_not_required &&
      foreign_tin == o.foreign_tin &&
      reference_number == o.reference_number &&
      disregarded_entity_fatca_status == o.disregarded_entity_fatca_status &&
      disregarded_address == o.disregarded_address &&
      disregarded_city == o.disregarded_city &&
      disregarded_state == o.disregarded_state &&
      disregarded_zip == o.disregarded_zip &&
      disregarded_country == o.disregarded_country &&
      disregarded_entity_giin == o.disregarded_entity_giin &&
      treaty_country_certification == o.treaty_country_certification &&
      treaty_country == o.treaty_country &&
      benefit_limitation_certification == o.benefit_limitation_certification &&
      benefit_limitation == o.benefit_limitation &&
      qualified_resident_status_certification == o.qualified_resident_status_certification &&
      treaty_article == o.treaty_article &&
      withholding_rate == o.withholding_rate &&
      income_type == o.income_type &&
      treaty_reasons == o.treaty_reasons &&
      ffi_sponsoring_entity == o.ffi_sponsoring_entity &&
      investment_entity_certification == o.investment_entity_certification &&
      controlled_foreign_corporation_certification == o.controlled_foreign_corporation_certification &&
      compliant_nonregistering_local_bank_certification == o.compliant_nonregistering_local_bank_certification &&
      compliant_ffi_low_value_accounts_certification == o.compliant_ffi_low_value_accounts_certification &&
      sponsored_closely_held_entity_sponsoring_entity == o.sponsored_closely_held_entity_sponsoring_entity &&
      sponsored_closely_held_investment_vehicle_certification == o.sponsored_closely_held_investment_vehicle_certification &&
      compliant_limited_life_debt_entity_certification == o.compliant_limited_life_debt_entity_certification &&
      investment_entity_no_financial_accounts_certification == o.investment_entity_no_financial_accounts_certification &&
      owner_documented_ffi_certification == o.owner_documented_ffi_certification &&
      owner_documented_ffi_reporting_statement_certification == o.owner_documented_ffi_reporting_statement_certification &&
      owner_documented_ffi_auditor_letter_certification == o.owner_documented_ffi_auditor_letter_certification &&
      owner_documented_ffi_trust_beneficiaries_certification == o.owner_documented_ffi_trust_beneficiaries_certification &&
      restricted_distributor_certification == o.restricted_distributor_certification &&
      restricted_distributor_agreement_certification == o.restricted_distributor_agreement_certification &&
      restricted_distributor_preexisting_sales_compliance_certification == o.restricted_distributor_preexisting_sales_compliance_certification &&
      nonreporting_iga_ffi_certification == o.nonreporting_iga_ffi_certification &&
      iga_country == o.iga_country &&
      iga_model == o.iga_model &&
      iga_legal_status_treatment == o.iga_legal_status_treatment &&
      iga_ffi_trustee_or_sponsor == o.iga_ffi_trustee_or_sponsor &&
      iga_ffi_trustee_is_foreign == o.iga_ffi_trustee_is_foreign &&
      non_commercial_financial_activity_certification == o.non_commercial_financial_activity_certification &&
      internation_organization_certification == o.internation_organization_certification &&
      intergovernmental_organization_certification == o.intergovernmental_organization_certification &&
      treaty_qualified_pension_fund_certification == o.treaty_qualified_pension_fund_certification &&
      qualified_retirement_fund_certification == o.qualified_retirement_fund_certification &&
      narrow_participation_retirement_fund_certification == o.narrow_participation_retirement_fund_certification &&
      section401_a_equivalent_pension_plan_certification == o.section401_a_equivalent_pension_plan_certification &&
      investment_entity_for_retirement_funds_certification == o.investment_entity_for_retirement_funds_certification &&
      exempt_beneficial_owner_sponsored_retirement_fund_certification == o.exempt_beneficial_owner_sponsored_retirement_fund_certification &&
      exempt_beneficial_owner_owned_investment_entity_certification == o.exempt_beneficial_owner_owned_investment_entity_certification &&
      territory_financial_institution_certification == o.territory_financial_institution_certification &&
      excepted_nonfinancial_group_entity_certification == o.excepted_nonfinancial_group_entity_certification &&
      excepted_nonfinancial_start_up_certification == o.excepted_nonfinancial_start_up_certification &&
      startup_formation_or_resolution_date == o.startup_formation_or_resolution_date &&
      excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification == o.excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification &&
      nonfinancial_entity_filing_date == o.nonfinancial_entity_filing_date &&
      section501_c_organization_certification == o.section501_c_organization_certification &&
      determination_letter_date == o.determination_letter_date &&
      nonprofit_organization_certification == o.nonprofit_organization_certification &&
      publicly_traded_nffe_certification == o.publicly_traded_nffe_certification &&
      publicly_traded_nffe_securities_market == o.publicly_traded_nffe_securities_market &&
      nffe_affiliate_of_publicly_traded_entity_certification == o.nffe_affiliate_of_publicly_traded_entity_certification &&
      publicly_traded_entity == o.publicly_traded_entity &&
      nffe_affiliate_of_publicly_traded_entity_securities_market == o.nffe_affiliate_of_publicly_traded_entity_securities_market &&
      excepted_territory_nffe_certification == o.excepted_territory_nffe_certification &&
      active_nffe_certification == o.active_nffe_certification &&
      passive_nffe_certification == o.passive_nffe_certification &&
      passive_nffe_no_substantial_us_owners_certification == o.passive_nffe_no_substantial_us_owners_certification &&
      passive_nffe_substantial_us_owners_provided_certification == o.passive_nffe_substantial_us_owners_provided_certification &&
      excepted_inter_affiliate_ffi_certification == o.excepted_inter_affiliate_ffi_certification &&
      sponsored_direct_reporting_nffe_certification == o.sponsored_direct_reporting_nffe_certification &&
      direct_reporting_nffe_sponsoring_entity == o.direct_reporting_nffe_sponsoring_entity &&
      substantial_us_owners == o.substantial_us_owners &&
      signer_name == o.signer_name &&
      capacity_to_sign_certification == o.capacity_to_sign_certification &&
      id == o.id &&
      type == o.type &&
      entry_status == o.entry_status &&
      entry_status_date == o.entry_status_date &&
      reference_id == o.reference_id &&
      company_id == o.company_id &&
      display_name == o.display_name &&
      email == o.email &&
      archived == o.archived &&
      signature == o.signature &&
      signed_date == o.signed_date &&
      e_delivery_consented_at == o.e_delivery_consented_at &&
      created_at == o.created_at &&
      updated_at == o.updated_at
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 1340

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


1232
1233
1234
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 1232

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



1238
1239
1240
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 1238

def hash
  [name, citizenship_country, disregarded_entity, entity_type, making_treaty_claim, fatca_status, residence_address, residence_city, residence_state, residence_zip, residence_country, residence_is_mailing, mailing_address, mailing_city, mailing_state, mailing_zip, mailing_country, tin_type, tin, giin, foreign_tin_not_required, foreign_tin, reference_number, disregarded_entity_fatca_status, disregarded_address, disregarded_city, disregarded_state, disregarded_zip, disregarded_country, disregarded_entity_giin, treaty_country_certification, treaty_country, benefit_limitation_certification, benefit_limitation, qualified_resident_status_certification, treaty_article, withholding_rate, income_type, treaty_reasons, ffi_sponsoring_entity, investment_entity_certification, controlled_foreign_corporation_certification, compliant_nonregistering_local_bank_certification, compliant_ffi_low_value_accounts_certification, sponsored_closely_held_entity_sponsoring_entity, sponsored_closely_held_investment_vehicle_certification, compliant_limited_life_debt_entity_certification, investment_entity_no_financial_accounts_certification, owner_documented_ffi_certification, owner_documented_ffi_reporting_statement_certification, owner_documented_ffi_auditor_letter_certification, owner_documented_ffi_trust_beneficiaries_certification, restricted_distributor_certification, restricted_distributor_agreement_certification, restricted_distributor_preexisting_sales_compliance_certification, nonreporting_iga_ffi_certification, iga_country, iga_model, iga_legal_status_treatment, iga_ffi_trustee_or_sponsor, iga_ffi_trustee_is_foreign, non_commercial_financial_activity_certification, internation_organization_certification, intergovernmental_organization_certification, treaty_qualified_pension_fund_certification, qualified_retirement_fund_certification, narrow_participation_retirement_fund_certification, section401_a_equivalent_pension_plan_certification, investment_entity_for_retirement_funds_certification, exempt_beneficial_owner_sponsored_retirement_fund_certification, exempt_beneficial_owner_owned_investment_entity_certification, territory_financial_institution_certification, excepted_nonfinancial_group_entity_certification, excepted_nonfinancial_start_up_certification, startup_formation_or_resolution_date, excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification, nonfinancial_entity_filing_date, section501_c_organization_certification, determination_letter_date, nonprofit_organization_certification, publicly_traded_nffe_certification, publicly_traded_nffe_securities_market, nffe_affiliate_of_publicly_traded_entity_certification, publicly_traded_entity, nffe_affiliate_of_publicly_traded_entity_securities_market, excepted_territory_nffe_certification, active_nffe_certification, passive_nffe_certification, passive_nffe_no_substantial_us_owners_certification, passive_nffe_substantial_us_owners_provided_certification, excepted_inter_affiliate_ffi_certification, sponsored_direct_reporting_nffe_certification, direct_reporting_nffe_sponsoring_entity, substantial_us_owners, signer_name, capacity_to_sign_certification, id, type, entry_status, entry_status_date, reference_id, company_id, display_name, email, archived, signature, signed_date, e_delivery_consented_at, created_at, updated_at].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



1100
1101
1102
1103
1104
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 1100

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



1316
1317
1318
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 1316

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 1322

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

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



1310
1311
1312
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 1310

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



1108
1109
1110
1111
# File 'lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb', line 1108

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end