avalara_sdk 25.8.2 → 25.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (220) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +20 -91
  4. data/docs/A1099/V2/CompaniesW9Api.md +18 -18
  5. data/docs/A1099/V2/CompanyBase.md +50 -0
  6. data/docs/A1099/V2/CompanyCreateUpdateRequestModel.md +18 -18
  7. data/docs/A1099/V2/CompanyRequest.md +50 -0
  8. data/docs/A1099/V2/CompanyResponse.md +37 -37
  9. data/docs/A1099/V2/CoveredIndividual.md +56 -0
  10. data/docs/A1099/V2/CreateAndSendW9FormEmailRequest.md +55 -0
  11. data/docs/A1099/V2/CreateCompanyRequest.md +49 -0
  12. data/docs/A1099/V2/CreateIssuerRequest.md +49 -0
  13. data/docs/A1099/V2/EntryStatusResponse.md +20 -0
  14. data/docs/A1099/V2/Form1042S.md +83 -83
  15. data/docs/A1099/V2/Form1095B.md +72 -62
  16. data/docs/A1099/V2/Form1095C.md +112 -0
  17. data/docs/A1099/V2/Form1099Base.md +60 -60
  18. data/docs/A1099/V2/Form1099Div.md +79 -77
  19. data/docs/A1099/V2/Form1099Int.md +76 -74
  20. data/docs/A1099/V2/Form1099K.md +83 -83
  21. data/docs/A1099/V2/Form1099ListRequest.md +20 -0
  22. data/docs/A1099/V2/Form1099Misc.md +79 -77
  23. data/docs/A1099/V2/Form1099Nec.md +64 -64
  24. data/docs/A1099/V2/Form1099R.md +95 -93
  25. data/docs/A1099/V2/Forms1099Api.md +47 -43
  26. data/docs/A1099/V2/FormsW9Api.md +104 -20
  27. data/docs/A1099/V2/Get1099Form200Response.md +19 -19
  28. data/docs/A1099/V2/IntermediaryOrFlowThrough.md +11 -11
  29. data/docs/A1099/V2/IssuerBase.md +46 -0
  30. data/docs/A1099/V2/IssuerCommand.md +16 -16
  31. data/docs/A1099/V2/IssuerRequest.md +46 -0
  32. data/docs/A1099/V2/IssuerResponse.md +35 -35
  33. data/docs/A1099/V2/Issuers1099Api.md +10 -10
  34. data/docs/A1099/V2/JobResponse.md +56 -0
  35. data/docs/A1099/V2/JobsApi.md +91 -0
  36. data/docs/A1099/V2/OfferAndCoverage.md +28 -0
  37. data/docs/A1099/V2/PaginatedQueryResultModelForm1099Base.md +22 -0
  38. data/docs/A1099/V2/PrimaryWithholdingAgent.md +4 -4
  39. data/docs/A1099/V2/StateAndLocalWithholding.md +8 -8
  40. data/docs/A1099/V2/TinMatchStatusResponse.md +1 -1
  41. data/docs/A1099/V2/ValidationError.md +2 -2
  42. data/docs/A1099/V2/W4FormMinimalRequest.md +30 -0
  43. data/docs/A1099/V2/W4FormRequest.md +16 -16
  44. data/docs/A1099/V2/W4FormResponse.md +48 -20
  45. data/docs/A1099/V2/W8BenEFormMinimalRequest.md +28 -0
  46. data/docs/A1099/V2/W8BenEFormRequest.md +15 -15
  47. data/docs/A1099/V2/W8BenEFormResponse.md +96 -68
  48. data/docs/A1099/V2/W8BenFormMinimalRequest.md +28 -0
  49. data/docs/A1099/V2/W8BenFormRequest.md +11 -11
  50. data/docs/A1099/V2/W8BenFormResponse.md +55 -27
  51. data/docs/A1099/V2/W8ImyFormMinimalRequest.md +28 -0
  52. data/docs/A1099/V2/W8ImyFormRequest.md +15 -15
  53. data/docs/A1099/V2/W8ImyFormResponse.md +118 -90
  54. data/docs/A1099/V2/W9FormBaseMinimalRequest.md +24 -0
  55. data/docs/A1099/V2/W9FormBaseRequest.md +7 -7
  56. data/docs/A1099/V2/W9FormBaseResponse.md +6 -6
  57. data/docs/A1099/V2/W9FormMinimalRequest.md +28 -0
  58. data/docs/A1099/V2/W9FormRequest.md +15 -15
  59. data/docs/A1099/V2/W9FormResponse.md +44 -16
  60. data/lib/avalara_sdk/api/A1099/V2/companies_w9_api.rb +27 -27
  61. data/lib/avalara_sdk/api/A1099/V2/forms1099_api.rb +93 -61
  62. data/lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb +157 -19
  63. data/lib/avalara_sdk/api/A1099/V2/issuers1099_api.rb +21 -21
  64. data/lib/avalara_sdk/api/A1099/V2/{jobs1099_api.rb → jobs_api.rb} +9 -9
  65. data/lib/avalara_sdk/api/EInvoicing/V1/data_input_fields_api.rb +1 -1
  66. data/lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb +1 -1
  67. data/lib/avalara_sdk/api/EInvoicing/V1/interop_api.rb +1 -1
  68. data/lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb +1 -1
  69. data/lib/avalara_sdk/api/EInvoicing/V1/subscriptions_api.rb +1 -1
  70. data/lib/avalara_sdk/api/EInvoicing/V1/tax_identifiers_api.rb +1 -1
  71. data/lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb +1 -1
  72. data/lib/avalara_sdk/api_client.rb +10 -2
  73. data/lib/avalara_sdk/models/A1099/V2/{base_company_model.rb → company_base.rb} +61 -13
  74. data/lib/avalara_sdk/models/A1099/V2/company_create_update_request_model.rb +58 -17
  75. data/lib/avalara_sdk/models/A1099/V2/{company_model.rb → company_request.rb} +62 -64
  76. data/lib/avalara_sdk/models/A1099/V2/company_response.rb +110 -69
  77. data/lib/avalara_sdk/models/A1099/V2/{covered_individual_request.rb → covered_individual.rb} +36 -7
  78. data/lib/avalara_sdk/models/A1099/V2/{i_create_form1099_request.rb → create_and_send_w9_form_email_request.rb} +6 -5
  79. data/lib/avalara_sdk/models/A1099/V2/{error_response_errors_inner.rb → create_company_request.rb} +3 -3
  80. data/lib/avalara_sdk/models/A1099/V2/{i_update_form1099_request.rb → create_issuer_request.rb} +3 -5
  81. data/lib/avalara_sdk/models/A1099/V2/{status_detail.rb → entry_status_response.rb} +20 -18
  82. data/lib/avalara_sdk/models/A1099/V2/error_response.rb +0 -6
  83. data/lib/avalara_sdk/models/A1099/V2/form1042_s.rb +422 -187
  84. data/lib/avalara_sdk/models/A1099/V2/form1095_b.rb +359 -194
  85. data/lib/avalara_sdk/models/A1099/V2/{form1095_b_response.rb → form1095_c.rb} +250 -133
  86. data/lib/avalara_sdk/models/A1099/V2/form1099_base.rb +283 -185
  87. data/lib/avalara_sdk/models/A1099/V2/form1099_div.rb +307 -179
  88. data/lib/avalara_sdk/models/A1099/V2/form1099_int.rb +307 -183
  89. data/lib/avalara_sdk/models/A1099/V2/form1099_k.rb +307 -198
  90. data/lib/avalara_sdk/models/A1099/V2/{http_validation_problem_details.rb → form1099_list_request.rb} +45 -59
  91. data/lib/avalara_sdk/models/A1099/V2/form1099_misc.rb +334 -209
  92. data/lib/avalara_sdk/models/A1099/V2/form1099_nec.rb +297 -192
  93. data/lib/avalara_sdk/models/A1099/V2/form1099_r.rb +437 -282
  94. data/lib/avalara_sdk/models/A1099/V2/get1099_form200_response.rb +9 -9
  95. data/lib/avalara_sdk/models/A1099/V2/intermediary_or_flow_through.rb +59 -1
  96. data/lib/avalara_sdk/models/A1099/V2/{intermediary_or_flow_through_request.rb → issuer_base.rb} +119 -46
  97. data/lib/avalara_sdk/models/A1099/V2/issuer_command.rb +42 -23
  98. data/lib/avalara_sdk/models/A1099/V2/{company_response_model.rb → issuer_request.rb} +113 -112
  99. data/lib/avalara_sdk/models/A1099/V2/issuer_response.rb +77 -46
  100. data/lib/avalara_sdk/models/A1099/V2/{job_result.rb → job_response.rb} +102 -42
  101. data/lib/avalara_sdk/models/A1099/V2/{offer_and_coverage_request.rb → offer_and_coverage.rb} +79 -9
  102. data/lib/avalara_sdk/models/A1099/V2/{paginated_query_result_model.rb → paginated_query_result_model_form1099_base.rb} +4 -4
  103. data/lib/avalara_sdk/models/A1099/V2/primary_withholding_agent.rb +23 -16
  104. data/lib/avalara_sdk/models/A1099/V2/state_and_local_withholding.rb +8 -0
  105. data/lib/avalara_sdk/models/A1099/V2/validation_error.rb +2 -6
  106. data/lib/avalara_sdk/models/A1099/V2/{attribute.rb → w4_form_minimal_request.rb} +142 -129
  107. data/lib/avalara_sdk/models/A1099/V2/w4_form_request.rb +62 -34
  108. data/lib/avalara_sdk/models/A1099/V2/w4_form_response.rb +191 -15
  109. data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_minimal_request.rb +356 -0
  110. data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_request.rb +68 -33
  111. data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb +190 -14
  112. data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_minimal_request.rb +356 -0
  113. data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_request.rb +51 -28
  114. data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb +191 -15
  115. data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_minimal_request.rb +356 -0
  116. data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_request.rb +61 -33
  117. data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_response.rb +191 -15
  118. data/lib/avalara_sdk/models/A1099/V2/{problem_details.rb → w9_form_base_minimal_request.rb} +61 -35
  119. data/lib/avalara_sdk/models/A1099/V2/w9_form_base_request.rb +35 -28
  120. data/lib/avalara_sdk/models/A1099/V2/w9_form_base_response.rb +60 -31
  121. data/lib/avalara_sdk/models/A1099/V2/w9_form_minimal_request.rb +356 -0
  122. data/lib/avalara_sdk/models/A1099/V2/w9_form_request.rb +71 -30
  123. data/lib/avalara_sdk/models/A1099/V2/w9_form_response.rb +190 -14
  124. data/lib/avalara_sdk/version.rb +1 -1
  125. data/lib/avalara_sdk.rb +22 -101
  126. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/byebug-11.1.3/gem_make.out +5 -5
  127. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/date-3.4.1/gem_make.out +5 -5
  128. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debase-0.2.9/gem_make.out +5 -5
  129. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debug-1.10.0/gem_make.out +5 -5
  130. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/erb-5.0.1/gem_make.out +5 -5
  131. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/io-console-0.8.0/gem_make.out +5 -5
  132. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/json-2.12.2/gem_make.out +5 -5
  133. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/prism-1.4.0/gem_make.out +5 -5
  134. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/psych-5.2.6/gem_make.out +5 -5
  135. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/racc-1.8.1/gem_make.out +5 -5
  136. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/stringio-3.1.7/gem_make.out +5 -5
  137. metadata +45 -103
  138. data/lib/avalara_sdk/models/A1099/V2/base_form_list_request.rb +0 -210
  139. data/lib/avalara_sdk/models/A1099/V2/bulk_upsert1099_forms_request.rb +0 -108
  140. data/lib/avalara_sdk/models/A1099/V2/covered_individual_reference.rb +0 -403
  141. data/lib/avalara_sdk/models/A1099/V2/covered_individual_reference_response.rb +0 -407
  142. data/lib/avalara_sdk/models/A1099/V2/create1099_form201_response.rb +0 -108
  143. data/lib/avalara_sdk/models/A1099/V2/data.rb +0 -237
  144. data/lib/avalara_sdk/models/A1099/V2/form1042_s_list.rb +0 -238
  145. data/lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb +0 -816
  146. data/lib/avalara_sdk/models/A1099/V2/form1042_s_list_item_response.rb +0 -980
  147. data/lib/avalara_sdk/models/A1099/V2/form1042_s_request.rb +0 -778
  148. data/lib/avalara_sdk/models/A1099/V2/form1042_s_response.rb +0 -619
  149. data/lib/avalara_sdk/models/A1099/V2/form1095_b_list.rb +0 -238
  150. data/lib/avalara_sdk/models/A1099/V2/form1095_b_list_item.rb +0 -606
  151. data/lib/avalara_sdk/models/A1099/V2/form1095_b_list_item_response.rb +0 -765
  152. data/lib/avalara_sdk/models/A1099/V2/form1095_b_request.rb +0 -627
  153. data/lib/avalara_sdk/models/A1099/V2/form1095_c_list.rb +0 -238
  154. data/lib/avalara_sdk/models/A1099/V2/form1095_c_list_item.rb +0 -662
  155. data/lib/avalara_sdk/models/A1099/V2/form1099_base_response.rb +0 -726
  156. data/lib/avalara_sdk/models/A1099/V2/form1099_div_list.rb +0 -238
  157. data/lib/avalara_sdk/models/A1099/V2/form1099_div_list_item.rb +0 -747
  158. data/lib/avalara_sdk/models/A1099/V2/form1099_div_list_item_response.rb +0 -931
  159. data/lib/avalara_sdk/models/A1099/V2/form1099_div_request.rb +0 -729
  160. data/lib/avalara_sdk/models/A1099/V2/form1099_div_response.rb +0 -790
  161. data/lib/avalara_sdk/models/A1099/V2/form1099_int_list.rb +0 -238
  162. data/lib/avalara_sdk/models/A1099/V2/form1099_int_list_item.rb +0 -702
  163. data/lib/avalara_sdk/models/A1099/V2/form1099_int_list_item_response.rb +0 -887
  164. data/lib/avalara_sdk/models/A1099/V2/form1099_int_request.rb +0 -684
  165. data/lib/avalara_sdk/models/A1099/V2/form1099_int_response.rb +0 -773
  166. data/lib/avalara_sdk/models/A1099/V2/form1099_k_list.rb +0 -238
  167. data/lib/avalara_sdk/models/A1099/V2/form1099_k_list_item.rb +0 -788
  168. data/lib/avalara_sdk/models/A1099/V2/form1099_k_list_item_response.rb +0 -995
  169. data/lib/avalara_sdk/models/A1099/V2/form1099_k_request.rb +0 -770
  170. data/lib/avalara_sdk/models/A1099/V2/form1099_k_response.rb +0 -839
  171. data/lib/avalara_sdk/models/A1099/V2/form1099_list.rb +0 -219
  172. data/lib/avalara_sdk/models/A1099/V2/form1099_list_data_inner.rb +0 -55
  173. data/lib/avalara_sdk/models/A1099/V2/form1099_list_response.rb +0 -220
  174. data/lib/avalara_sdk/models/A1099/V2/form1099_list_response_value_inner.rb +0 -108
  175. data/lib/avalara_sdk/models/A1099/V2/form1099_misc_list.rb +0 -238
  176. data/lib/avalara_sdk/models/A1099/V2/form1099_misc_list_item.rb +0 -688
  177. data/lib/avalara_sdk/models/A1099/V2/form1099_misc_list_item_response.rb +0 -886
  178. data/lib/avalara_sdk/models/A1099/V2/form1099_misc_request.rb +0 -670
  179. data/lib/avalara_sdk/models/A1099/V2/form1099_misc_response.rb +0 -754
  180. data/lib/avalara_sdk/models/A1099/V2/form1099_nec_list.rb +0 -238
  181. data/lib/avalara_sdk/models/A1099/V2/form1099_nec_list_item.rb +0 -586
  182. data/lib/avalara_sdk/models/A1099/V2/form1099_nec_list_item_response.rb +0 -765
  183. data/lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb +0 -567
  184. data/lib/avalara_sdk/models/A1099/V2/form1099_nec_response.rb +0 -646
  185. data/lib/avalara_sdk/models/A1099/V2/form1099_proccess_result.rb +0 -228
  186. data/lib/avalara_sdk/models/A1099/V2/form1099_proccess_result_processed_forms_inner.rb +0 -107
  187. data/lib/avalara_sdk/models/A1099/V2/form1099_r_list.rb +0 -238
  188. data/lib/avalara_sdk/models/A1099/V2/form1099_r_list_item.rb +0 -763
  189. data/lib/avalara_sdk/models/A1099/V2/form1099_r_list_item_response.rb +0 -942
  190. data/lib/avalara_sdk/models/A1099/V2/form1099_r_request.rb +0 -720
  191. data/lib/avalara_sdk/models/A1099/V2/form1099_r_response.rb +0 -839
  192. data/lib/avalara_sdk/models/A1099/V2/form1099_status_detail_response.rb +0 -223
  193. data/lib/avalara_sdk/models/A1099/V2/form_request_base.rb +0 -502
  194. data/lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb +0 -475
  195. data/lib/avalara_sdk/models/A1099/V2/form_request_list_item_base.rb +0 -548
  196. data/lib/avalara_sdk/models/A1099/V2/form_request_model.rb +0 -345
  197. data/lib/avalara_sdk/models/A1099/V2/form_response_base.rb +0 -612
  198. data/lib/avalara_sdk/models/A1099/V2/form_single_request_base.rb +0 -530
  199. data/lib/avalara_sdk/models/A1099/V2/included_base.rb +0 -219
  200. data/lib/avalara_sdk/models/A1099/V2/intermediary_or_flow_through_response.rb +0 -311
  201. data/lib/avalara_sdk/models/A1099/V2/link.rb +0 -210
  202. data/lib/avalara_sdk/models/A1099/V2/paginated_w9_forms_model.rb +0 -231
  203. data/lib/avalara_sdk/models/A1099/V2/primary_withholding_agent_request.rb +0 -221
  204. data/lib/avalara_sdk/models/A1099/V2/primary_withholding_agent_response.rb +0 -221
  205. data/lib/avalara_sdk/models/A1099/V2/state_and_local_withholding_request.rb +0 -278
  206. data/lib/avalara_sdk/models/A1099/V2/state_and_local_withholding_response.rb +0 -282
  207. data/lib/avalara_sdk/models/A1099/V2/state_efile_status_detail_app.rb +0 -231
  208. data/lib/avalara_sdk/models/A1099/V2/state_efile_status_detail_response.rb +0 -231
  209. data/lib/avalara_sdk/models/A1099/V2/update1099_form200_response.rb +0 -108
  210. data/lib/avalara_sdk/models/A1099/V2/validation_error_app.rb +0 -229
  211. data/lib/avalara_sdk/models/A1099/V2/validation_error_response.rb +0 -231
  212. data/lib/avalara_sdk/models/EInvoicing/V1/directory_search_response.rb +0 -233
  213. data/lib/avalara_sdk/models/EInvoicing/V1/directory_search_response_value_inner.rb +0 -274
  214. data/lib/avalara_sdk/models/EInvoicing/V1/directory_search_response_value_inner_addresses_inner.rb +0 -251
  215. data/lib/avalara_sdk/models/EInvoicing/V1/directory_search_response_value_inner_identifiers_inner.rb +0 -221
  216. data/lib/avalara_sdk/models/EInvoicing/V1/directory_search_response_value_inner_supported_document_types_inner.rb +0 -241
  217. data/lib/avalara_sdk/models/EInvoicing/V1/document_fetch_request.rb +0 -224
  218. data/lib/avalara_sdk/models/EInvoicing/V1/document_fetch_request_data_inner.rb +0 -237
  219. data/lib/avalara_sdk/models/EInvoicing/V1/document_fetch_request_metadata.rb +0 -288
  220. data/lib/avalara_sdk/models/EInvoicing/V1/submit_document_data.rb +0 -216
@@ -0,0 +1,30 @@
1
+ # AvalaraSdk::A1099::V2::W4FormMinimalRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | The form type (always \"w4\" for this model). | [optional][readonly] |
8
+ | **email** | **String** | The email address of the individual associated with the form. | |
9
+ | **employee_first_name** | **String** | The first name of the employee. | |
10
+ | **employee_last_name** | **String** | The last name of the employee. | |
11
+ | **office_code** | **String** | The office code associated with the form. | [optional] |
12
+ | **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] |
13
+ | **reference_id** | **String** | A reference identifier for the form. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'avalara_sdk'
19
+
20
+ instance = AvalaraSdk::A1099::V2::W4FormMinimalRequest.new(
21
+ type: null,
22
+ email: null,
23
+ employee_first_name: null,
24
+ employee_last_name: null,
25
+ office_code: null,
26
+ company_id: null,
27
+ reference_id: null
28
+ )
29
+ ```
30
+
@@ -5,17 +5,17 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | The form type (always \"w4\" for this model). | [optional][readonly] |
8
- | **employee_first_name** | **String** | The first name of the employee. | [optional] |
8
+ | **employee_first_name** | **String** | The first name of the employee. | |
9
9
  | **employee_middle_name** | **String** | The middle name of the employee. | [optional] |
10
- | **employee_last_name** | **String** | The last name of the employee. | [optional] |
10
+ | **employee_last_name** | **String** | The last name of the employee. | |
11
11
  | **employee_name_suffix** | **String** | The name suffix of the employee. | [optional] |
12
- | **tin_type** | **String** | The type of TIN provided. | [optional] |
13
- | **tin** | **String** | The taxpayer identification number (TIN). | [optional] |
14
- | **address** | **String** | The address of the employee. | [optional] |
15
- | **city** | **String** | The city of residence of the employee. | [optional] |
16
- | **state** | **String** | The state of residence of the employee. | [optional] |
17
- | **zip** | **String** | The ZIP code of residence of the employee. | [optional] |
18
- | **marital_status** | **String** | The marital status of the employee. | [optional] |
12
+ | **tin_type** | **String** | Tax Identification Number (TIN) type. | |
13
+ | **tin** | **String** | The taxpayer identification number (TIN). | |
14
+ | **address** | **String** | The address of the employee. Required unless exempt. | [optional] |
15
+ | **city** | **String** | The city of residence of the employee. Required unless exempt. | [optional] |
16
+ | **state** | **String** | The state of residence of the employee. Required unless exempt. | [optional] |
17
+ | **zip** | **String** | The ZIP code of residence of the employee. Required unless exempt. | [optional] |
18
+ | **marital_status** | **String** | The marital status of the employee. Required unless exempt. Available values: - Single: Single or Married filing separately - Married: Married filing jointly or qualifying surviving spouse - MarriedBut: Head of household. Check only if you're unmarried and pay more than half the costs of keeping up a home for yourself and a qualifying individual. | [optional] |
19
19
  | **last_name_differs** | **Boolean** | Indicates whether the last name differs from prior records. | [optional] |
20
20
  | **num_allowances** | **Integer** | The number of allowances claimed by the employee. | [optional] |
21
21
  | **other_dependents** | **Integer** | The number of dependents other than allowances. | [optional] |
@@ -24,11 +24,11 @@
24
24
  | **additional_withheld** | **Float** | The additional amount withheld. | [optional] |
25
25
  | **exempt_from_withholding** | **Boolean** | Indicates whether the employee is exempt from withholding. | [optional] |
26
26
  | **office_code** | **String** | The office code associated with the form. | [optional] |
27
- | **company_id** | **String** | The ID of the associated company. | [optional] |
28
- | **reference_id** | **String** | A reference identifier for the form. | [optional] |
29
- | **email** | **String** | The email address of the individual associated with the form. | [optional] |
30
27
  | **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] |
31
28
  | **signature** | **String** | The signature of the form. | [optional] |
29
+ | **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] |
30
+ | **reference_id** | **String** | A reference identifier for the form. | [optional] |
31
+ | **email** | **String** | The email address of the individual associated with the form. | [optional] |
32
32
 
33
33
  ## Example
34
34
 
@@ -36,7 +36,7 @@
36
36
  require 'avalara_sdk'
37
37
 
38
38
  instance = AvalaraSdk::A1099::V2::W4FormRequest.new(
39
- type: W4,
39
+ type: null,
40
40
  employee_first_name: null,
41
41
  employee_middle_name: null,
42
42
  employee_last_name: null,
@@ -56,11 +56,11 @@ instance = AvalaraSdk::A1099::V2::W4FormRequest.new(
56
56
  additional_withheld: null,
57
57
  exempt_from_withholding: null,
58
58
  office_code: null,
59
+ e_delivery_consented_at: null,
60
+ signature: null,
59
61
  company_id: null,
60
62
  reference_id: null,
61
- email: null,
62
- e_delivery_consented_at: null,
63
- signature: null
63
+ email: null
64
64
  )
65
65
  ```
66
66
 
@@ -4,11 +4,12 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | The form type (always \"W4\" for this model). | [optional][readonly] |
7
8
  | **employee_first_name** | **String** | The first name of the employee. | [optional] |
8
9
  | **employee_middle_name** | **String** | The middle name of the employee. | [optional] |
9
10
  | **employee_last_name** | **String** | The last name of the employee. | [optional] |
10
11
  | **employee_name_suffix** | **String** | The name suffix of the employee. | [optional] |
11
- | **tin_type** | **String** | The type of TIN provided. | [optional] |
12
+ | **tin_type** | **String** | Tax Identification Number (TIN) type. | [optional] |
12
13
  | **tin** | **String** | The taxpayer identification number (TIN). | [optional] |
13
14
  | **address** | **String** | The address of the employee. | [optional] |
14
15
  | **city** | **String** | The city of residence of the employee. | [optional] |
@@ -23,6 +24,19 @@
23
24
  | **additional_withheld** | **Float** | The additional amount withheld. | [optional] |
24
25
  | **exempt_from_withholding** | **Boolean** | Indicates whether the employee is exempt from withholding. | [optional] |
25
26
  | **office_code** | **String** | The office code associated with the form. | [optional] |
27
+ | **id** | **String** | The unique identifier for the form. | [optional] |
28
+ | **entry_status** | [**EntryStatusResponse**](EntryStatusResponse.md) | The entry status information for the form. | [optional] |
29
+ | **reference_id** | **String** | A reference identifier for the form. | [optional] |
30
+ | **company_id** | **String** | The ID of the associated company. | [optional] |
31
+ | **display_name** | **String** | The display name associated with the form. | [optional] |
32
+ | **email** | **String** | The email address of the individual associated with the form. | [optional] |
33
+ | **archived** | **Boolean** | Indicates whether the form is archived. | [optional] |
34
+ | **ancestor_id** | **String** | Form ID of previous version. | [optional] |
35
+ | **signature** | **String** | The signature of the form. | [optional] |
36
+ | **signed_date** | **Time** | The date the form was signed. | [optional] |
37
+ | **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] |
38
+ | **created_at** | **Time** | The creation date of the form. | [optional] |
39
+ | **updated_at** | **Time** | The last updated date of the form. | [optional] |
26
40
 
27
41
  ## Example
28
42
 
@@ -30,25 +44,39 @@
30
44
  require 'avalara_sdk'
31
45
 
32
46
  instance = AvalaraSdk::A1099::V2::W4FormResponse.new(
33
- employee_first_name: Jane,
34
- employee_middle_name: A.,
35
- employee_last_name: Smith,
36
- employee_name_suffix: Jr.,
37
- tin_type: SSN,
38
- tin: 123-45-6789,
39
- address: 456 Elm St,
40
- city: Springfield,
41
- state: IL,
42
- zip: 62704,
43
- marital_status: Married,
44
- last_name_differs: false,
45
- num_allowances: 3,
46
- other_dependents: 1,
47
- non_job_income: 5000,
48
- deductions: 2000,
49
- additional_withheld: 150,
50
- exempt_from_withholding: false,
51
- office_code: OC12345
47
+ type: null,
48
+ employee_first_name: null,
49
+ employee_middle_name: null,
50
+ employee_last_name: null,
51
+ employee_name_suffix: null,
52
+ tin_type: null,
53
+ tin: null,
54
+ address: null,
55
+ city: null,
56
+ state: null,
57
+ zip: null,
58
+ marital_status: null,
59
+ last_name_differs: null,
60
+ num_allowances: null,
61
+ other_dependents: null,
62
+ non_job_income: null,
63
+ deductions: null,
64
+ additional_withheld: null,
65
+ exempt_from_withholding: null,
66
+ office_code: null,
67
+ id: null,
68
+ entry_status: null,
69
+ reference_id: null,
70
+ company_id: null,
71
+ display_name: null,
72
+ email: null,
73
+ archived: null,
74
+ ancestor_id: null,
75
+ signature: null,
76
+ signed_date: null,
77
+ e_delivery_consented_at: null,
78
+ created_at: null,
79
+ updated_at: null
52
80
  )
53
81
  ```
54
82
 
@@ -0,0 +1,28 @@
1
+ # AvalaraSdk::A1099::V2::W8BenEFormMinimalRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | The form type (always \"w8bene\" for this model). | [optional][readonly] |
8
+ | **email** | **String** | The email address of the individual associated with the form. | |
9
+ | **name** | **String** | The name of the individual or entity associated with the form. | |
10
+ | **reference_number** | **String** | A reference number for the form. | [optional] |
11
+ | **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] |
12
+ | **reference_id** | **String** | A reference identifier for the form. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'avalara_sdk'
18
+
19
+ instance = AvalaraSdk::A1099::V2::W8BenEFormMinimalRequest.new(
20
+ type: null,
21
+ email: null,
22
+ name: null,
23
+ reference_number: null,
24
+ company_id: null,
25
+ reference_id: null
26
+ )
27
+ ```
28
+
@@ -5,17 +5,17 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | The form type (always \"w8bene\" for this model). | [optional][readonly] |
8
- | **name** | **String** | The name of the individual or entity associated with the form. | [optional] |
9
- | **citizenship_country** | **String** | The country of citizenship. | [optional] |
8
+ | **name** | **String** | The name of the individual or entity associated with the form. | |
9
+ | **citizenship_country** | **String** | The country of citizenship. | |
10
10
  | **disregarded_entity** | **String** | The name of the disregarded entity receiving the payment (if applicable). | [optional] |
11
- | **entity_type** | **String** | The entity type. | [optional] |
11
+ | **entity_type** | **String** | The entity type. Available values: - 1: Corporation - 2: Disregarded entity - 3: Partnership - 4: Simple trust - 5: Grantor trust - 6: Complex trust - 7: Estate - 8: Foreign Government - Controlled Entity - 9: Central Bank of Issue - 10: Tax-exempt organization - 11: Private foundation - 12: International organization - 13: Foreign Government - Controlled Integral Part | |
12
12
  | **making_treaty_claim** | **Boolean** | Indicates whether the entity is making a treaty claim. | [optional] |
13
- | **fatca_status** | **String** | The FATCA status. | [optional] |
13
+ | **fatca_status** | **String** | The FATCA status. Available values: - 1: Nonparticipating FFI (including a limited FFI or an FFI related to a Reporting IGA FFI other than a deemed-compliant FFI, participating FFI, or exempt beneficial owner) - 2: Participating FFI - 3: Reporting Model 1 FFI - 4: Reporting Model 2 FFI - 5: Registered deemed-compliant FFI (other than a reporting Model 1 FFI, sponsored FFI, or nonreporting IGA FFI covered in Part XII) - 6: Sponsored FFI that has not obtained a GIIN - 7: Certified deemed-compliant nonregistering local bank - 8: Certified deemed-compliant FFI with only low-value accounts - 9: Certified deemed-compliant sponsored, closely held investment vehicle - 10: Certified deemed-compliant limited life debt investment entity - 11: Certified deemed-compliant investment advisors and investment managers - 12: Owner-documented FFI - 13: Restricted distributor - 14: Nonreporting IGA FFI - 15: Foreign government, government of a U.S. possession, or foreign central bank of issue - 16: International organization - 17: Exempt retirement plans - 18: Entity wholly owned by exempt beneficial owners - 19: Territory financial institution - 20: Nonfinancial group entity - 21: Excepted nonfinancial start-up company - 22: Excepted nonfinancial entity in liquidation or bankruptcy - 23: 501(c) organization - 24: Nonprofit organization - 25: Publicly traded NFFE or NFFE affiliate of a publicly traded corporation - 26: Excepted territory NFFE - 27: Active NFFE - 28: Passive NFFE - 29: Excepted inter-affiliate FFI - 30: Direct reporting NFFE - 31: Sponsored direct reporting NFFE - 32: Account that is not a financial account | |
14
14
  | **residence_address** | **String** | The residential address of the individual or entity. | [optional] |
15
15
  | **residence_city** | **String** | The city of residence. | [optional] |
16
16
  | **residence_state** | **String** | The state of residence. | [optional] |
17
17
  | **residence_zip** | **String** | The ZIP code of the residence. | [optional] |
18
- | **residence_country** | **String** | The country of residence. | [optional] |
18
+ | **residence_country** | **String** | The country of residence. | |
19
19
  | **residence_is_mailing** | **Boolean** | Indicates whether the residence address is also the mailing address. | [optional] |
20
20
  | **mailing_address** | **String** | The mailing address. | [optional] |
21
21
  | **mailing_city** | **String** | The city of the mailing address. | [optional] |
@@ -27,7 +27,7 @@
27
27
  | **foreign_tin_not_required** | **Boolean** | Indicates whether a foreign TIN is not required. | [optional] |
28
28
  | **foreign_tin** | **String** | The foreign taxpayer identification number (TIN). | [optional] |
29
29
  | **reference_number** | **String** | A reference number for the form. | [optional] |
30
- | **disregarded_entity_fatca_status** | **String** | The FATCA status of disregarded entity or branch receiving payment. | [optional] |
30
+ | **disregarded_entity_fatca_status** | **String** | The FATCA status of disregarded entity or branch receiving payment. Available values: - 1: Limited Branch - 2: U.S. Branch - 3: Participating FFI - 4: Reporting Model 1 FFI - 5: Reporting Model 2 FFI | [optional] |
31
31
  | **disregarded_address** | **String** | The address for disregarded entities. | [optional] |
32
32
  | **disregarded_city** | **String** | The city for disregarded entities. | [optional] |
33
33
  | **disregarded_state** | **String** | The state for disregarded entities. | [optional] |
@@ -37,7 +37,7 @@
37
37
  | **treaty_country_certification** | **Boolean** | Certifies the beneficial owner's country under the U.S. tax treaty. | [optional] |
38
38
  | **treaty_country** | **String** | The treaty country of the beneficial owner. | [optional] |
39
39
  | **benefit_limitation_certification** | **Boolean** | Certifies that the beneficial owner is eligible for treaty benefits and meets any limitation on benefits requirements. | [optional] |
40
- | **benefit_limitation** | **String** | The benefit limitation for tax treaty claims. | [optional] |
40
+ | **benefit_limitation** | **String** | The benefit limitation for tax treaty claims. Available values: - 1: Government - 2: Tax exempt pension trust or pension fund - 3: Other tax exempt organization - 4: Publicly traded corporation - 5: Subsidiary of a publicly traded corporation - 6: Company that meets the ownership and base erosion test - 7: Company that meets the derivative benefits test - 8: Company with an item of income that meets active trade or business test - 9: Favorable discretionary determination by the U.S. competent authority received - 10: Other | [optional] |
41
41
  | **qualified_resident_status_certification** | **Boolean** | Certifies that the beneficial owner claims treaty benefits and meets the qualified resident status for specific U.S. source income. | [optional] |
42
42
  | **treaty_article** | **String** | Indicates the specific article and paragraph of the tax treaty under which the beneficial owner is claiming benefits. | [optional] |
43
43
  | **withholding_rate** | **String** | Specifies the reduced withholding rate claimed under the applicable tax treaty. | [optional] |
@@ -61,7 +61,7 @@
61
61
  | **restricted_distributor_preexisting_sales_compliance_certification** | **Boolean** | Certifies that the entity complies with distribution restrictions for U.S.-linked investors and has addressed any preexisting sales in accordance with FATCA regulations. | [optional] |
62
62
  | **nonreporting_iga_ffi_certification** | **Boolean** | Certifies that the entity meets the requirements to be considered a nonreporting financial institution to an applicable IGA. | [optional] |
63
63
  | **iga_country** | **String** | The country for the applicable IGA with the United States. | [optional] |
64
- | **iga_model** | **String** | The applicable IGA model. | [optional] |
64
+ | **iga_model** | **String** | The applicable IGA model. Available values: - 1: Model 1 IGA - 2: Model 2 IGA | [optional] |
65
65
  | **iga_legal_status_treatment** | **String** | Specifies how the applicable IGA is treated under the IGA provisions or Treasury regulations. | [optional] |
66
66
  | **iga_ffi_trustee_or_sponsor** | **String** | The trustee or sponsor name for the nonreporting IGA FFI. | [optional] |
67
67
  | **iga_ffi_trustee_is_foreign** | **Boolean** | Indicates whether the trustee for the nonreporting IGA FFI is foreign. | [optional] |
@@ -100,11 +100,11 @@
100
100
  | **substantial_us_owners** | [**Array<SubstantialUsOwnerRequest>**](SubstantialUsOwnerRequest.md) | The list of substantial U.S. owners of passive NFFE. | [optional] |
101
101
  | **signer_name** | **String** | The name of the signer. | [optional] |
102
102
  | **capacity_to_sign_certification** | **Boolean** | Certifies signer has the capacity to sign for the beneficial owner. | [optional] |
103
- | **company_id** | **String** | The ID of the associated company. | [optional] |
104
- | **reference_id** | **String** | A reference identifier for the form. | [optional] |
105
- | **email** | **String** | The email address of the individual associated with the form. | [optional] |
106
103
  | **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] |
107
104
  | **signature** | **String** | The signature of the form. | [optional] |
105
+ | **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] |
106
+ | **reference_id** | **String** | A reference identifier for the form. | [optional] |
107
+ | **email** | **String** | The email address of the individual associated with the form. | [optional] |
108
108
 
109
109
  ## Example
110
110
 
@@ -112,7 +112,7 @@
112
112
  require 'avalara_sdk'
113
113
 
114
114
  instance = AvalaraSdk::A1099::V2::W8BenEFormRequest.new(
115
- type: W4,
115
+ type: null,
116
116
  name: null,
117
117
  citizenship_country: null,
118
118
  disregarded_entity: null,
@@ -208,11 +208,11 @@ instance = AvalaraSdk::A1099::V2::W8BenEFormRequest.new(
208
208
  substantial_us_owners: null,
209
209
  signer_name: null,
210
210
  capacity_to_sign_certification: null,
211
+ e_delivery_consented_at: null,
212
+ signature: null,
211
213
  company_id: null,
212
214
  reference_id: null,
213
- email: null,
214
- e_delivery_consented_at: null,
215
- signature: null
215
+ email: null
216
216
  )
217
217
  ```
218
218
 
@@ -4,6 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | The form type (always \"W8BenE\" for this model). | [optional][readonly] |
7
8
  | **name** | **String** | The name of the individual or entity associated with the form. | [optional] |
8
9
  | **citizenship_country** | **String** | The country of citizenship. | [optional] |
9
10
  | **disregarded_entity** | **String** | The name of the disregarded entity receiving the payment (if applicable). | [optional] |
@@ -21,7 +22,7 @@
21
22
  | **mailing_state** | **String** | The state of the mailing address. | [optional] |
22
23
  | **mailing_zip** | **String** | The ZIP code of the mailing address. | [optional] |
23
24
  | **mailing_country** | **String** | The country of the mailing address. | [optional] |
24
- | **tin_type** | **String** | The type of TIN provided. | [optional] |
25
+ | **tin_type** | **String** | Tax Identification Number (TIN) type. | [optional] |
25
26
  | **tin** | **String** | The taxpayer identification number (TIN). | [optional] |
26
27
  | **giin** | **String** | The global intermediary identification number (GIIN). | [optional] |
27
28
  | **foreign_tin_not_required** | **Boolean** | Indicates whether a foreign TIN is not required. | [optional] |
@@ -100,6 +101,19 @@
100
101
  | **substantial_us_owners** | [**Array<SubstantialUsOwnerResponse>**](SubstantialUsOwnerResponse.md) | The list of substantial U.S. owners of passive NFFE. | [optional] |
101
102
  | **signer_name** | **String** | The name of the signer. | [optional] |
102
103
  | **capacity_to_sign_certification** | **Boolean** | Certifies signer has the capacity to sign for the beneficial owner. | [optional] |
104
+ | **id** | **String** | The unique identifier for the form. | [optional] |
105
+ | **entry_status** | [**EntryStatusResponse**](EntryStatusResponse.md) | The entry status information for the form. | [optional] |
106
+ | **reference_id** | **String** | A reference identifier for the form. | [optional] |
107
+ | **company_id** | **String** | The ID of the associated company. | [optional] |
108
+ | **display_name** | **String** | The display name associated with the form. | [optional] |
109
+ | **email** | **String** | The email address of the individual associated with the form. | [optional] |
110
+ | **archived** | **Boolean** | Indicates whether the form is archived. | [optional] |
111
+ | **ancestor_id** | **String** | Form ID of previous version. | [optional] |
112
+ | **signature** | **String** | The signature of the form. | [optional] |
113
+ | **signed_date** | **Time** | The date the form was signed. | [optional] |
114
+ | **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] |
115
+ | **created_at** | **Time** | The creation date of the form. | [optional] |
116
+ | **updated_at** | **Time** | The last updated date of the form. | [optional] |
103
117
 
104
118
  ## Example
105
119
 
@@ -107,29 +121,30 @@
107
121
  require 'avalara_sdk'
108
122
 
109
123
  instance = AvalaraSdk::A1099::V2::W8BenEFormResponse.new(
110
- name: Global Enterprises LLC,
111
- citizenship_country: USA,
112
- disregarded_entity: Subsidiary LLC,
113
- entity_type: Corporation,
114
- making_treaty_claim: false,
115
- fatca_status: Active,
116
- residence_address: 123 International Blvd,
117
- residence_city: Metropolis,
118
- residence_state: NY,
119
- residence_zip: 10118,
120
- residence_country: USA,
121
- residence_is_mailing: false,
122
- mailing_address: P.O. Box 123,
123
- mailing_city: Metropolis,
124
- mailing_state: NY,
125
- mailing_zip: 10119,
126
- mailing_country: USA,
127
- tin_type: ,
128
- tin: 123-45-6789,
129
- giin: GIIN12345678,
130
- foreign_tin_not_required: true,
124
+ type: null,
125
+ name: null,
126
+ citizenship_country: null,
127
+ disregarded_entity: null,
128
+ entity_type: null,
129
+ making_treaty_claim: null,
130
+ fatca_status: null,
131
+ residence_address: null,
132
+ residence_city: null,
133
+ residence_state: null,
134
+ residence_zip: null,
135
+ residence_country: null,
136
+ residence_is_mailing: null,
137
+ mailing_address: null,
138
+ mailing_city: null,
139
+ mailing_state: null,
140
+ mailing_zip: null,
141
+ mailing_country: null,
142
+ tin_type: null,
143
+ tin: null,
144
+ giin: null,
145
+ foreign_tin_not_required: null,
131
146
  foreign_tin: null,
132
- reference_number: W8BENE12345,
147
+ reference_number: null,
133
148
  disregarded_entity_fatca_status: null,
134
149
  disregarded_address: null,
135
150
  disregarded_city: null,
@@ -137,72 +152,85 @@ instance = AvalaraSdk::A1099::V2::W8BenEFormResponse.new(
137
152
  disregarded_zip: null,
138
153
  disregarded_country: null,
139
154
  disregarded_entity_giin: null,
140
- treaty_country_certification: false,
155
+ treaty_country_certification: null,
141
156
  treaty_country: null,
142
- benefit_limitation_certification: false,
157
+ benefit_limitation_certification: null,
143
158
  benefit_limitation: null,
144
- qualified_resident_status_certification: false,
159
+ qualified_resident_status_certification: null,
145
160
  treaty_article: null,
146
161
  withholding_rate: null,
147
162
  income_type: null,
148
163
  treaty_reasons: null,
149
164
  ffi_sponsoring_entity: null,
150
- investment_entity_certification: false,
151
- controlled_foreign_corporation_certification: false,
152
- compliant_nonregistering_local_bank_certification: false,
153
- compliant_ffi_low_value_accounts_certification: false,
165
+ investment_entity_certification: null,
166
+ controlled_foreign_corporation_certification: null,
167
+ compliant_nonregistering_local_bank_certification: null,
168
+ compliant_ffi_low_value_accounts_certification: null,
154
169
  sponsored_closely_held_entity_sponsoring_entity: null,
155
- sponsored_closely_held_investment_vehicle_certification: false,
156
- compliant_limited_life_debt_entity_certification: false,
157
- investment_entity_no_financial_accounts_certification: false,
158
- owner_documented_ffi_certification: false,
159
- owner_documented_ffi_reporting_statement_certification: false,
160
- owner_documented_ffi_auditor_letter_certification: false,
161
- owner_documented_ffi_trust_beneficiaries_certification: false,
162
- restricted_distributor_certification: false,
163
- restricted_distributor_agreement_certification: false,
164
- restricted_distributor_preexisting_sales_compliance_certification: false,
165
- nonreporting_iga_ffi_certification: false,
170
+ sponsored_closely_held_investment_vehicle_certification: null,
171
+ compliant_limited_life_debt_entity_certification: null,
172
+ investment_entity_no_financial_accounts_certification: null,
173
+ owner_documented_ffi_certification: null,
174
+ owner_documented_ffi_reporting_statement_certification: null,
175
+ owner_documented_ffi_auditor_letter_certification: null,
176
+ owner_documented_ffi_trust_beneficiaries_certification: null,
177
+ restricted_distributor_certification: null,
178
+ restricted_distributor_agreement_certification: null,
179
+ restricted_distributor_preexisting_sales_compliance_certification: null,
180
+ nonreporting_iga_ffi_certification: null,
166
181
  iga_country: null,
167
182
  iga_model: null,
168
183
  iga_legal_status_treatment: null,
169
184
  iga_ffi_trustee_or_sponsor: null,
170
185
  iga_ffi_trustee_is_foreign: null,
171
- non_commercial_financial_activity_certification: false,
172
- internation_organization_certification: false,
173
- intergovernmental_organization_certification: false,
174
- treaty_qualified_pension_fund_certification: false,
175
- qualified_retirement_fund_certification: false,
176
- narrow_participation_retirement_fund_certification: false,
177
- section401_a_equivalent_pension_plan_certification: false,
178
- investment_entity_for_retirement_funds_certification: false,
179
- exempt_beneficial_owner_sponsored_retirement_fund_certification: false,
180
- exempt_beneficial_owner_owned_investment_entity_certification: false,
181
- territory_financial_institution_certification: false,
182
- excepted_nonfinancial_group_entity_certification: false,
183
- excepted_nonfinancial_start_up_certification: false,
186
+ non_commercial_financial_activity_certification: null,
187
+ internation_organization_certification: null,
188
+ intergovernmental_organization_certification: null,
189
+ treaty_qualified_pension_fund_certification: null,
190
+ qualified_retirement_fund_certification: null,
191
+ narrow_participation_retirement_fund_certification: null,
192
+ section401_a_equivalent_pension_plan_certification: null,
193
+ investment_entity_for_retirement_funds_certification: null,
194
+ exempt_beneficial_owner_sponsored_retirement_fund_certification: null,
195
+ exempt_beneficial_owner_owned_investment_entity_certification: null,
196
+ territory_financial_institution_certification: null,
197
+ excepted_nonfinancial_group_entity_certification: null,
198
+ excepted_nonfinancial_start_up_certification: null,
184
199
  startup_formation_or_resolution_date: null,
185
- excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification: false,
200
+ excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification: null,
186
201
  nonfinancial_entity_filing_date: null,
187
- section501_c_organization_certification: false,
202
+ section501_c_organization_certification: null,
188
203
  determination_letter_date: null,
189
- nonprofit_organization_certification: false,
190
- publicly_traded_nffe_certification: false,
204
+ nonprofit_organization_certification: null,
205
+ publicly_traded_nffe_certification: null,
191
206
  publicly_traded_nffe_securities_market: null,
192
- nffe_affiliate_of_publicly_traded_entity_certification: false,
207
+ nffe_affiliate_of_publicly_traded_entity_certification: null,
193
208
  publicly_traded_entity: null,
194
209
  nffe_affiliate_of_publicly_traded_entity_securities_market: null,
195
- excepted_territory_nffe_certification: false,
196
- active_nffe_certification: false,
197
- passive_nffe_certification: false,
198
- passive_nffe_no_substantial_us_owners_certification: false,
199
- passive_nffe_substantial_us_owners_provided_certification: false,
200
- excepted_inter_affiliate_ffi_certification: false,
201
- sponsored_direct_reporting_nffe_certification: false,
210
+ excepted_territory_nffe_certification: null,
211
+ active_nffe_certification: null,
212
+ passive_nffe_certification: null,
213
+ passive_nffe_no_substantial_us_owners_certification: null,
214
+ passive_nffe_substantial_us_owners_provided_certification: null,
215
+ excepted_inter_affiliate_ffi_certification: null,
216
+ sponsored_direct_reporting_nffe_certification: null,
202
217
  direct_reporting_nffe_sponsoring_entity: null,
203
- substantial_us_owners: [],
218
+ substantial_us_owners: null,
204
219
  signer_name: null,
205
- capacity_to_sign_certification: false
220
+ capacity_to_sign_certification: null,
221
+ id: null,
222
+ entry_status: null,
223
+ reference_id: null,
224
+ company_id: null,
225
+ display_name: null,
226
+ email: null,
227
+ archived: null,
228
+ ancestor_id: null,
229
+ signature: null,
230
+ signed_date: null,
231
+ e_delivery_consented_at: null,
232
+ created_at: null,
233
+ updated_at: null
206
234
  )
207
235
  ```
208
236
 
@@ -0,0 +1,28 @@
1
+ # AvalaraSdk::A1099::V2::W8BenFormMinimalRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | The form type (always \"w8ben\" for this model). | [optional][readonly] |
8
+ | **email** | **String** | The email address of the individual associated with the form. | |
9
+ | **name** | **String** | The name of the individual or entity associated with the form. | |
10
+ | **reference_number** | **String** | A reference number for the form. | [optional] |
11
+ | **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] |
12
+ | **reference_id** | **String** | A reference identifier for the form. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'avalara_sdk'
18
+
19
+ instance = AvalaraSdk::A1099::V2::W8BenFormMinimalRequest.new(
20
+ type: null,
21
+ email: null,
22
+ name: null,
23
+ reference_number: null,
24
+ company_id: null,
25
+ reference_id: null
26
+ )
27
+ ```
28
+
@@ -5,19 +5,19 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | The form type (always \"w8ben\" for this model). | [optional][readonly] |
8
- | **name** | **String** | The name of the individual or entity associated with the form. | [optional] |
9
- | **citizenship_country** | **String** | The country of citizenship. | [optional] |
8
+ | **name** | **String** | The name of the individual or entity associated with the form. | |
9
+ | **citizenship_country** | **String** | The country of citizenship. | |
10
10
  | **residence_address** | **String** | The residential address of the individual or entity. | [optional] |
11
11
  | **residence_city** | **String** | The city of residence. | [optional] |
12
12
  | **residence_state** | **String** | The state of residence. | [optional] |
13
13
  | **residence_zip** | **String** | The ZIP code of the residence. | [optional] |
14
- | **residence_country** | **String** | The country of residence. | [optional] |
14
+ | **residence_country** | **String** | The country of residence. | |
15
15
  | **residence_is_mailing** | **Boolean** | Indicates whether the residence address is the mailing address. | [optional] |
16
16
  | **mailing_address** | **String** | The mailing address. | [optional] |
17
17
  | **mailing_city** | **String** | The city of the mailing address. | [optional] |
18
18
  | **mailing_state** | **String** | The state of the mailing address. | [optional] |
19
19
  | **mailing_zip** | **String** | The ZIP code of the mailing address. | [optional] |
20
- | **mailing_country** | **String** | The country of the mailing address. | [optional] |
20
+ | **mailing_country** | **String** | The country of the mailing address. | |
21
21
  | **tin** | **String** | The taxpayer identification number (TIN). | [optional] |
22
22
  | **foreign_tin_not_required** | **Boolean** | Indicates whether a foreign TIN is not legally required. | [optional] |
23
23
  | **foreign_tin** | **String** | The foreign taxpayer identification number (TIN). | [optional] |
@@ -29,11 +29,11 @@
29
29
  | **withholding_rate** | **String** | The withholding rate applied as per the treaty. | [optional] |
30
30
  | **income_type** | **String** | The type of income covered by the treaty. | [optional] |
31
31
  | **signer_name** | **String** | The name of the signer of the form. | [optional] |
32
- | **company_id** | **String** | The ID of the associated company. | [optional] |
33
- | **reference_id** | **String** | A reference identifier for the form. | [optional] |
34
- | **email** | **String** | The email address of the individual associated with the form. | [optional] |
35
32
  | **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] |
36
33
  | **signature** | **String** | The signature of the form. | [optional] |
34
+ | **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] |
35
+ | **reference_id** | **String** | A reference identifier for the form. | [optional] |
36
+ | **email** | **String** | The email address of the individual associated with the form. | [optional] |
37
37
 
38
38
  ## Example
39
39
 
@@ -41,7 +41,7 @@
41
41
  require 'avalara_sdk'
42
42
 
43
43
  instance = AvalaraSdk::A1099::V2::W8BenFormRequest.new(
44
- type: W4,
44
+ type: null,
45
45
  name: null,
46
46
  citizenship_country: null,
47
47
  residence_address: null,
@@ -66,11 +66,11 @@ instance = AvalaraSdk::A1099::V2::W8BenFormRequest.new(
66
66
  withholding_rate: null,
67
67
  income_type: null,
68
68
  signer_name: null,
69
+ e_delivery_consented_at: null,
70
+ signature: null,
69
71
  company_id: null,
70
72
  reference_id: null,
71
- email: null,
72
- e_delivery_consented_at: null,
73
- signature: null
73
+ email: null
74
74
  )
75
75
  ```
76
76