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
@@ -1,6 +1,6 @@
1
1
  # AvalaraSdk::A1099::V2::Forms1099Api
2
2
 
3
- All URIs are relative to *https://api-ava1099.eta.sbx.us-east-1.aws.avalara.io/avalara1099*
3
+ All URIs are relative to *https://api.sbx.avalara.com/avalara1099*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
@@ -15,11 +15,11 @@ All URIs are relative to *https://api-ava1099.eta.sbx.us-east-1.aws.avalara.io/a
15
15
 
16
16
  ## bulk_upsert1099_forms
17
17
 
18
- > <Form1099ProccessResult> bulk_upsert1099_forms(avalara_version, opts)
18
+ > <JobResponse> bulk_upsert1099_forms(avalara_version, opts)
19
19
 
20
20
  Create or update multiple 1099/1095/W2/1042S forms
21
21
 
22
- This endpoint allows you to create or update multiple 1099/1095/W2/1042S forms. You can use one of the following payload structures: **Form 1099-MISC:** ```json { \"formType\": \"1099-MISC\", \"forms\": [ { \"IssuerId\": \"123456\", \"IssuerReferenceId\": \"REF123\", \"IssuerTin\": \"12-3456789\", \"TaxYear\": 2023, \"ReferenceId\": \"FORM123456\", \"RecipientName\": \"John Doe\", \"RecipientTin\": \"587-65-4321\", \"TinType\": \"SSN\", \"RecipientSecondName\": \"Jane Doe\", \"Address\": \"123 Main Street\", \"Address2\": \"Apt 4B\", \"City\": \"New York\", \"State\": \"NY\", \"Zip\": \"10001\", \"Email\": \"john.doe@email.com\", \"AccountNumber\": \"ACC123456\", \"OfficeCode\": \"NYC01\", \"SecondTinNotice\": false, \"NonUsProvince\": \"\", \"CountryCode\": \"US\", \"Rents\": 12000.00, \"Royalties\": 5000.00, \"OtherIncome\": 3000.00, \"FishingBoatProceeds\": 0.00, \"MedicalAndHealthCarePayments\": 15000.00, \"SubstitutePayments\": 1000.00, \"CropInsuranceProceeds\": 0.00, \"GrossProceedsPaidToAttorney\": 7500.00, \"FishPurchasedForResale\": 0.00, \"FedIncomeTaxWithheld\": 5000.00, \"Section409ADeferrals\": 0.00, \"ExcessGoldenParachutePayments\": 0.00, \"NonqualifiedDeferredCompensation\": 0.00, \"DirectSalesIndicator\": false, \"FatcaFilingRequirement\": false, \"StateAndLocalWithholding\": { \"StateTaxWithheld\": 2500.00, \"LocalTaxWithheld\": 1000.00, \"State\": \"NY\", \"StateIdNumber\": \"NY123456\", \"Locality\": \"New York City\", \"StateIncome\": 35000.00, \"LocalIncome\": 35000.00 } } ] } ``` **Form 1099-NEC:** ```json { \"formType\": \"1099-NEC\", \"forms\": [ { \"issuerID\": \"180337282\", \"issuerReferenceId\": \"ISS123\", \"issuerTin\": \"12-3000000\", \"taxYear\": 2024, \"referenceID\": \"REF-002\", \"recipientName\": \"Jane Smith\", \"recipientSecondName\": \"\", \"recipientTin\": \"587-65-4321\", \"tinType\": \"SSN\", \"address\": \"123 Center St\", \"address2\": \"\", \"city\": \"Santa Monica\", \"state\": \"CA\", \"zip\": \"90401\", \"countryCode\": \"US\", \"nonUsProvince\": \"\", \"email\": \"\", \"accountNumber\": \"\", \"officeCode\": \"\", \"secondTinNotice\": false, \"nonemployeeCompensation\": 123.45, \"directSalesIndicator\": false, \"federalIncomeTaxWithheld\": 12.34, \"stateAndLocalWithholding\": { \"state\": \"CA\", \"stateIdNumber\": \"123123123\", \"stateIncome\": 123.45, \"stateTaxWithheld\": 12.34, \"locality\": \"Santa Monica\", \"localityIdNumber\": \"456456\", \"localTaxWithheld\": 12.34, \"localIncome\": 50000.00 }, \"federalEFile\": true, \"postalMail\": true, \"stateEFile\": true, \"tinMatch\": true, \"addressVerification\": true } ] } ``` For the full version of the payload and its schema details, refer to the Swagger schemas section.
22
+ This endpoint allows you to create or update multiple 1099/1095/W2/1042S forms. Maximum of 5000 forms can be processed in a single bulk request. **Date Scheduling Rules:** If federalEfileDate, stateEfileDate, or recipientEdeliveryDate are between current date and beginning of blackout period, scheduled to that date. If dates are in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. StateEfileDate must be on or after federalEfileDate. Set dates to null to leave unscheduled.
23
23
 
24
24
  ### Examples
25
25
 
@@ -41,10 +41,10 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client
41
41
 
42
42
  avalara_version = '2.0.0' # String | API version
43
43
  opts = {
44
- dry_run: true, # Boolean |
45
- x_correlation_id: 'fc005c04-52f7-44d6-bf16-6551603a8324', # String | Unique correlation Id in a GUID format
44
+ dry_run: true, # Boolean | defaults to false. If true, it will NOT change the DB. It will just return a report of what would've have been changed in the DB
45
+ x_correlation_id: '5ef65de0-c394-4aa2-b249-d8bfcbe9b23a', # String | Unique correlation Id in a GUID format
46
46
  x_avalara_client: 'Swagger UI; 22.1.0', # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
47
- bulk_upsert1099_forms_request: AvalaraSdk::A1099::V2::Form1042SList.new # BulkUpsert1099FormsRequest |
47
+ form1099_list_request: AvalaraSdk::A1099::V2::Form1099ListRequest.new # Form1099ListRequest |
48
48
  }
49
49
 
50
50
  begin
@@ -60,7 +60,7 @@ end
60
60
 
61
61
  This returns an Array which contains the response data, status code and headers.
62
62
 
63
- > <Array(<Form1099ProccessResult>, Integer, Hash)> bulk_upsert1099_forms_with_http_info(avalara_version, opts)
63
+ > <Array(<JobResponse>, Integer, Hash)> bulk_upsert1099_forms_with_http_info(avalara_version, opts)
64
64
 
65
65
  ```ruby
66
66
  begin
@@ -68,7 +68,7 @@ begin
68
68
  data, status_code, headers = api_instance.bulk_upsert1099_forms_with_http_info(avalara_version, opts)
69
69
  p status_code # => 2xx
70
70
  p headers # => { ... }
71
- p data # => <Form1099ProccessResult>
71
+ p data # => <JobResponse>
72
72
  rescue AvalaraSdk::A1099::V2::ApiError => e
73
73
  puts "Error when calling Forms1099Api->bulk_upsert1099_forms_with_http_info: #{e}"
74
74
  end
@@ -79,14 +79,14 @@ end
79
79
  | Name | Type | Description | Notes |
80
80
  | ---- | ---- | ----------- | ----- |
81
81
  | **avalara_version** | **String** | API version | |
82
- | **dry_run** | **Boolean** | | [optional][default to false] |
82
+ | **dry_run** | **Boolean** | defaults to false. If true, it will NOT change the DB. It will just return a report of what would&#39;ve have been changed in the DB | [optional][default to false] |
83
83
  | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
84
84
  | **x_avalara_client** | **String** | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] |
85
- | **bulk_upsert1099_forms_request** | [**BulkUpsert1099FormsRequest**](BulkUpsert1099FormsRequest.md) | | [optional] |
85
+ | **form1099_list_request** | [**Form1099ListRequest**](Form1099ListRequest.md) | | [optional] |
86
86
 
87
87
  ### Return type
88
88
 
89
- [**Form1099ProccessResult**](Form1099ProccessResult.md)
89
+ [**JobResponse**](JobResponse.md)
90
90
 
91
91
  ### Authorization
92
92
 
@@ -100,11 +100,11 @@ end
100
100
 
101
101
  ## create1099_form
102
102
 
103
- > <Create1099Form201Response> create1099_form(avalara_version, opts)
103
+ > <Get1099Form200Response> create1099_form(avalara_version, opts)
104
104
 
105
105
  Create a 1099/1095/W2/1042S form
106
106
 
107
- Create a 1099/1095/W2/1042S form.
107
+ Create a 1099/1095/W2/1042S form. **Date Scheduling Rules:** If federalEfileDate, stateEfileDate, or recipientEdeliveryDate are between current date and beginning of blackout period, scheduled to that date. If dates are in the past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. StateEfileDate must be on or after federalEfileDate. Set dates to null to leave unscheduled.
108
108
 
109
109
  ### Examples
110
110
 
@@ -126,9 +126,9 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client
126
126
 
127
127
  avalara_version = '2.0.0' # String | API version
128
128
  opts = {
129
- x_correlation_id: '13eb4eb0-0e7d-41e3-adf3-61b131c1a92c', # String | Unique correlation Id in a GUID format
129
+ x_correlation_id: '5b55b569-4e1e-44d3-920c-65153461c426', # String | Unique correlation Id in a GUID format
130
130
  x_avalara_client: 'Swagger UI; 22.1.0', # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
131
- i_create_form1099_request: AvalaraSdk::A1099::V2::Form1099DivRequest.new # ICreateForm1099Request |
131
+ get1099_form200_response: AvalaraSdk::A1099::V2::Form1042S.new({unique_form_id: 'unique_form_id_example', income_code: '01', gross_income: 3.56, withholding_indicator: '3', tax_country_code: 'tax_country_code_example', type: 'Form1099Nec', recipient_name: 'recipient_name_example', address: 'address_example', city: 'city_example', country_code: 'country_code_example'}) # Get1099Form200Response |
132
132
  }
133
133
 
134
134
  begin
@@ -144,7 +144,7 @@ end
144
144
 
145
145
  This returns an Array which contains the response data, status code and headers.
146
146
 
147
- > <Array(<Create1099Form201Response>, Integer, Hash)> create1099_form_with_http_info(avalara_version, opts)
147
+ > <Array(<Get1099Form200Response>, Integer, Hash)> create1099_form_with_http_info(avalara_version, opts)
148
148
 
149
149
  ```ruby
150
150
  begin
@@ -152,7 +152,7 @@ begin
152
152
  data, status_code, headers = api_instance.create1099_form_with_http_info(avalara_version, opts)
153
153
  p status_code # => 2xx
154
154
  p headers # => { ... }
155
- p data # => <Create1099Form201Response>
155
+ p data # => <Get1099Form200Response>
156
156
  rescue AvalaraSdk::A1099::V2::ApiError => e
157
157
  puts "Error when calling Forms1099Api->create1099_form_with_http_info: #{e}"
158
158
  end
@@ -165,11 +165,11 @@ end
165
165
  | **avalara_version** | **String** | API version | |
166
166
  | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
167
167
  | **x_avalara_client** | **String** | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] |
168
- | **i_create_form1099_request** | [**ICreateForm1099Request**](ICreateForm1099Request.md) | | [optional] |
168
+ | **get1099_form200_response** | [**Get1099Form200Response**](Get1099Form200Response.md) | | [optional] |
169
169
 
170
170
  ### Return type
171
171
 
172
- [**Create1099Form201Response**](Create1099Form201Response.md)
172
+ [**Get1099Form200Response**](Get1099Form200Response.md)
173
173
 
174
174
  ### Authorization
175
175
 
@@ -210,7 +210,7 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client
210
210
  id = 'id_example' # String | The unique identifier of the desired form to delete.
211
211
  avalara_version = '2.0.0' # String | API version
212
212
  opts = {
213
- x_correlation_id: '2bcc9cf0-9638-46d5-a792-be61566e0651', # String | Unique correlation Id in a GUID format
213
+ x_correlation_id: 'e82ee14f-7146-41a5-b856-28f403d65e29', # String | Unique correlation Id in a GUID format
214
214
  x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
215
215
  }
216
216
 
@@ -292,7 +292,7 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client
292
292
  id = 'id_example' # String |
293
293
  avalara_version = '2.0.0' # String | API version
294
294
  opts = {
295
- x_correlation_id: '6e842a03-8b64-4b02-8c5e-7073bf4e8a8c', # String | Unique correlation Id in a GUID format
295
+ x_correlation_id: 'f5198e72-fc87-4a4d-a09a-b2aa6cf70c38', # String | Unique correlation Id in a GUID format
296
296
  x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
297
297
  }
298
298
 
@@ -376,7 +376,7 @@ id = 'id_example' # String | The ID of the form
376
376
  avalara_version = '2.0.0' # String | API version
377
377
  opts = {
378
378
  mark_edelivered: true, # Boolean | Optional boolean that if set indicates that the form should be marked as having been successfully edelivered
379
- x_correlation_id: '7b4aa70b-3a10-4fa0-bf19-7592170409b7', # String | Unique correlation Id in a GUID format
379
+ x_correlation_id: '7fdfd0b2-cebf-4f25-8a65-6dd03811e77d', # String | Unique correlation Id in a GUID format
380
380
  x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
381
381
  }
382
382
 
@@ -433,11 +433,11 @@ end
433
433
 
434
434
  ## list1099_forms
435
435
 
436
- > <Form1099ListResponse> list1099_forms(avalara_version, opts)
436
+ > <PaginatedQueryResultModelForm1099Base> list1099_forms(avalara_version, opts)
437
437
 
438
438
  List 1099/1095/W2/1042S forms
439
439
 
440
- List 1099/1095/W2/1042S forms. Filterable fields are name, referenceId and taxYear.
440
+ List 1099/1095/W2/1042S forms. Collections support filtering only on certain fields. An attempt to filter on an unsupported field will receive a 400 Bad Request response. Supported filtering fields are as follows: - issuerId - issuerReferenceId - taxYear - addressVerificationStatus - possible values are: unknown, pending, failed, incomplete, unchanged, verified - createdAt - edeliveryStatus - possible values are: sent, unscheduled, bad_verify, bad_verify_limit, scheduled, bounced, accepted - email - federalEfileStatus - possible values are: unscheduled, scheduled, sent, corrected_scheduled, accepted, corrected, corrected_accepted, held - recipientName - mailStatus - possible values are: sent, unscheduled, pending, delivered - referenceId - tinMatchStatus - possible values are: none, pending, matched, failed - type - possible values are: 940, 941, 943, 944, 945, 1042, 1042-S, 1095-B, 1095-C, 1097-BTC, 1098, 1098-C, 1098-E, 1098-Q, 1098-T, 3921, 3922, 5498, 5498-ESA, 5498-SA, 1099-MISC, 1099-A, 1099-B, 1099-C, 1099-CAP, 1099-DIV, 1099-G, 1099-INT, 1099-K, 1099-LS, 1099-LTC, 1099-NEC, 1099-OID, 1099-PATR, 1099-Q, 1099-R, 1099-S, 1099-SA, T4A, W-2, W-2G, 1099-HC - updatedAt - validity - possible values are: true, false For more information on filtering, see <see href=\"https://developer.avalara.com/avatax/filtering-in-rest/\">Filtering in REST</see>.
441
441
 
442
442
  ### Examples
443
443
 
@@ -459,11 +459,13 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client
459
459
 
460
460
  avalara_version = '2.0.0' # String | API version
461
461
  opts = {
462
- filter: 'issuerId eq 884781823', # String | A filter statement to identify specific records to retrieve. For more information on filtering, see <a href=\"https://developer.avalara.com/avatax/filtering-in-rest/\">Filtering in REST</a>. Collections support filtering only on certain fields. An attempt to filter on an unsupported field will receive a 400 Bad Request response. Supported filtering fields are as follows: issuerId issuerReferenceId taxYear addressVerificationStatus - possible values are: unknown, pending, failed, incomplete, unchanged, verified createdAt edeliveryStatus - possible values are: sent, unscheduled, bad_verify, bad_verify_limit, scheduled, bounced, accepted email federalEfileStatus - possible values are: unscheduled, scheduled, sent, corrected_scheduled, accepted, corrected, corrected_accepted, held recipientName mailStatus - possible values are: sent, unscheduled, pending, delivered referenceId tinMatchStatus - possible values are: none, pending, matched, failed type - possible values are: 940, 941, 943, 944, 945, 1042, 1042-S, 1095-B, 1095-C, 1097-BTC, 1098, 1098-C, 1098-E, 1098-Q, 1098-T, 3921, 3922, 5498, 5498-ESA, 5498-SA, 1099-MISC, 1099-A, 1099-B, 1099-C, 1099-CAP, 1099-DIV, 1099-G, 1099-INT, 1099-K, 1099-LS, 1099-LTC, 1099-NEC, 1099-OID, 1099-PATR, 1099-Q, 1099-R, 1099-S, 1099-SA, T4A, W-2, W-2G, 1099-HC updatedAt validity - possible values are: true, false
463
- top: 56, # Integer | If nonzero, return no more than this number of results. Used with skip to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
462
+ filter: 'issuerId eq 884781823', # String | A filter statement to identify specific records to retrieve. For more information on filtering, see <a href=\"https://developer.avalara.com/avatax/filtering-in-rest/\">Filtering in REST</a>.
463
+ top: 56, # Integer | If zero or greater than 1000, return at most 1000 results. Otherwise, return this number of results. Used with skip to provide pagination for large datasets.
464
464
  skip: 56, # Integer | If nonzero, skip this number of results before returning data. Used with top to provide pagination for large datasets.
465
- order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example issuerReferenceId ASC. Supported sorting fields are: issuerReferenceId taxYear createdAt recipientName updatedAt
466
- x_correlation_id: '7766bce5-4834-4907-81e9-dd0fd6c13079', # String | Unique correlation Id in a GUID format
465
+ order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.
466
+ count: true, # Boolean | If true, return the global count of elements in the collection.
467
+ count_only: true, # Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true.
468
+ x_correlation_id: '97f7596c-99c0-4879-b47c-57df572a32c9', # String | Unique correlation Id in a GUID format
467
469
  x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
468
470
  }
469
471
 
@@ -480,7 +482,7 @@ end
480
482
 
481
483
  This returns an Array which contains the response data, status code and headers.
482
484
 
483
- > <Array(<Form1099ListResponse>, Integer, Hash)> list1099_forms_with_http_info(avalara_version, opts)
485
+ > <Array(<PaginatedQueryResultModelForm1099Base>, Integer, Hash)> list1099_forms_with_http_info(avalara_version, opts)
484
486
 
485
487
  ```ruby
486
488
  begin
@@ -488,7 +490,7 @@ begin
488
490
  data, status_code, headers = api_instance.list1099_forms_with_http_info(avalara_version, opts)
489
491
  p status_code # => 2xx
490
492
  p headers # => { ... }
491
- p data # => <Form1099ListResponse>
493
+ p data # => <PaginatedQueryResultModelForm1099Base>
492
494
  rescue AvalaraSdk::A1099::V2::ApiError => e
493
495
  puts "Error when calling Forms1099Api->list1099_forms_with_http_info: #{e}"
494
496
  end
@@ -499,16 +501,18 @@ end
499
501
  | Name | Type | Description | Notes |
500
502
  | ---- | ---- | ----------- | ----- |
501
503
  | **avalara_version** | **String** | API version | |
502
- | **filter** | **String** | A filter statement to identify specific records to retrieve. For more information on filtering, see &lt;a href&#x3D;\&quot;https://developer.avalara.com/avatax/filtering-in-rest/\&quot;&gt;Filtering in REST&lt;/a&gt;. Collections support filtering only on certain fields. An attempt to filter on an unsupported field will receive a 400 Bad Request response. Supported filtering fields are as follows: issuerId issuerReferenceId taxYear addressVerificationStatus - possible values are: unknown, pending, failed, incomplete, unchanged, verified createdAt edeliveryStatus - possible values are: sent, unscheduled, bad_verify, bad_verify_limit, scheduled, bounced, accepted email federalEfileStatus - possible values are: unscheduled, scheduled, sent, corrected_scheduled, accepted, corrected, corrected_accepted, held recipientName mailStatus - possible values are: sent, unscheduled, pending, delivered referenceId tinMatchStatus - possible values are: none, pending, matched, failed type - possible values are: 940, 941, 943, 944, 945, 1042, 1042-S, 1095-B, 1095-C, 1097-BTC, 1098, 1098-C, 1098-E, 1098-Q, 1098-T, 3921, 3922, 5498, 5498-ESA, 5498-SA, 1099-MISC, 1099-A, 1099-B, 1099-C, 1099-CAP, 1099-DIV, 1099-G, 1099-INT, 1099-K, 1099-LS, 1099-LTC, 1099-NEC, 1099-OID, 1099-PATR, 1099-Q, 1099-R, 1099-S, 1099-SA, T4A, W-2, W-2G, 1099-HC updatedAt validity - possible values are: true, false | [optional] |
503
- | **top** | **Integer** | If nonzero, return no more than this number of results. Used with skip to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. | [optional][default to 10] |
504
- | **skip** | **Integer** | If nonzero, skip this number of results before returning data. Used with top to provide pagination for large datasets. | [optional][default to 0] |
505
- | **order_by** | **String** | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example issuerReferenceId ASC. Supported sorting fields are: issuerReferenceId taxYear createdAt recipientName updatedAt | [optional] |
504
+ | **filter** | **String** | A filter statement to identify specific records to retrieve. For more information on filtering, see &lt;a href&#x3D;\&quot;https://developer.avalara.com/avatax/filtering-in-rest/\&quot;&gt;Filtering in REST&lt;/a&gt;. | [optional] |
505
+ | **top** | **Integer** | If zero or greater than 1000, return at most 1000 results. Otherwise, return this number of results. Used with skip to provide pagination for large datasets. | [optional] |
506
+ | **skip** | **Integer** | If nonzero, skip this number of results before returning data. Used with top to provide pagination for large datasets. | [optional] |
507
+ | **order_by** | **String** | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC. | [optional] |
508
+ | **count** | **Boolean** | If true, return the global count of elements in the collection. | [optional] |
509
+ | **count_only** | **Boolean** | If true, return ONLY the global count of elements in the collection. It only applies when count&#x3D;true. | [optional] |
506
510
  | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
507
511
  | **x_avalara_client** | **String** | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] |
508
512
 
509
513
  ### Return type
510
514
 
511
- [**Form1099ListResponse**](Form1099ListResponse.md)
515
+ [**PaginatedQueryResultModelForm1099Base**](PaginatedQueryResultModelForm1099Base.md)
512
516
 
513
517
  ### Authorization
514
518
 
@@ -522,11 +526,11 @@ end
522
526
 
523
527
  ## update1099_form
524
528
 
525
- > <Update1099Form200Response> update1099_form(id, avalara_version, opts)
529
+ > <Get1099Form200Response> update1099_form(id, avalara_version, opts)
526
530
 
527
531
  Update a 1099/1095/W2/1042S form
528
532
 
529
- Update a 1099/1095/W2/1042S form.
533
+ Update a 1099/1095/W2/1042S form. **Date Update Rules:** Possible to update scheduled dates (same validation rules apply). Cannot change from scheduled to unscheduled status - must delete form and create new one. If dates are between current date and blackout period, scheduled to that date. If dates are in past or blackout period, scheduled to next available date. For blackout period information, see https://www.track1099.com/info/IRS_info. StateEfileDate must be on or after federalEfileDate.
530
534
 
531
535
  ### Examples
532
536
 
@@ -549,9 +553,9 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client
549
553
  id = 'id_example' # String |
550
554
  avalara_version = '2.0.0' # String | API version
551
555
  opts = {
552
- x_correlation_id: '9f622e4f-7992-4e4f-8e24-e628c5339402', # String | Unique correlation Id in a GUID format
556
+ x_correlation_id: '560aa857-d5ba-484b-9375-a14e9e57d7a8', # String | Unique correlation Id in a GUID format
553
557
  x_avalara_client: 'Swagger UI; 22.1.0', # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
554
- i_update_form1099_request: AvalaraSdk::A1099::V2::Form1099DivRequest.new # IUpdateForm1099Request |
558
+ get1099_form200_response: AvalaraSdk::A1099::V2::Form1042S.new({unique_form_id: 'unique_form_id_example', income_code: '01', gross_income: 3.56, withholding_indicator: '3', tax_country_code: 'tax_country_code_example', type: 'Form1099Nec', recipient_name: 'recipient_name_example', address: 'address_example', city: 'city_example', country_code: 'country_code_example'}) # Get1099Form200Response |
555
559
  }
556
560
 
557
561
  begin
@@ -567,7 +571,7 @@ end
567
571
 
568
572
  This returns an Array which contains the response data, status code and headers.
569
573
 
570
- > <Array(<Update1099Form200Response>, Integer, Hash)> update1099_form_with_http_info(id, avalara_version, opts)
574
+ > <Array(<Get1099Form200Response>, Integer, Hash)> update1099_form_with_http_info(id, avalara_version, opts)
571
575
 
572
576
  ```ruby
573
577
  begin
@@ -575,7 +579,7 @@ begin
575
579
  data, status_code, headers = api_instance.update1099_form_with_http_info(id, avalara_version, opts)
576
580
  p status_code # => 2xx
577
581
  p headers # => { ... }
578
- p data # => <Update1099Form200Response>
582
+ p data # => <Get1099Form200Response>
579
583
  rescue AvalaraSdk::A1099::V2::ApiError => e
580
584
  puts "Error when calling Forms1099Api->update1099_form_with_http_info: #{e}"
581
585
  end
@@ -589,11 +593,11 @@ end
589
593
  | **avalara_version** | **String** | API version | |
590
594
  | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
591
595
  | **x_avalara_client** | **String** | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] |
592
- | **i_update_form1099_request** | [**IUpdateForm1099Request**](IUpdateForm1099Request.md) | | [optional] |
596
+ | **get1099_form200_response** | [**Get1099Form200Response**](Get1099Form200Response.md) | | [optional] |
593
597
 
594
598
  ### Return type
595
599
 
596
- [**Update1099Form200Response**](Update1099Form200Response.md)
600
+ [**Get1099Form200Response**](Get1099Form200Response.md)
597
601
 
598
602
  ### Authorization
599
603
 
@@ -1,9 +1,10 @@
1
1
  # AvalaraSdk::A1099::V2::FormsW9Api
2
2
 
3
- All URIs are relative to *https://api-ava1099.eta.sbx.us-east-1.aws.avalara.io/avalara1099*
3
+ All URIs are relative to *https://api.sbx.avalara.com/avalara1099*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
+ | [**create_and_send_w9_form_email**](FormsW9Api.md#create_and_send_w9_form_email) | **POST** /w9/forms/$create-and-send-email | Create a minimal W9/W4/W8 form and sends the e-mail request |
7
8
  | [**create_w9_form**](FormsW9Api.md#create_w9_form) | **POST** /w9/forms | Create a W9/W4/W8 form |
8
9
  | [**delete_w9_form**](FormsW9Api.md#delete_w9_form) | **DELETE** /w9/forms/{id} | Delete a W9/W4/W8 form |
9
10
  | [**get_w9_form**](FormsW9Api.md#get_w9_form) | **GET** /w9/forms/{id} | Retrieve a W9/W4/W8 form |
@@ -13,6 +14,89 @@ All URIs are relative to *https://api-ava1099.eta.sbx.us-east-1.aws.avalara.io/a
13
14
  | [**upload_w9_files**](FormsW9Api.md#upload_w9_files) | **POST** /w9/forms/{id}/attachment | Replace the PDF file for a W9/W4/W8 form |
14
15
 
15
16
 
17
+ ## create_and_send_w9_form_email
18
+
19
+ > <CreateW9Form201Response> create_and_send_w9_form_email(avalara_version, opts)
20
+
21
+ Create a minimal W9/W4/W8 form and sends the e-mail request
22
+
23
+ Create a minimal W9/W4/W8 form and sends the e-mail request.
24
+
25
+ ### Examples
26
+
27
+ ```ruby
28
+ require 'time'
29
+ require 'avalara_sdk'
30
+ # setup authorization
31
+ AvalaraSdk::A1099::V2.configure do |config|
32
+ # See Documentation for Authorization section in main README.md for more auth examples.
33
+ config.bearer_token='<Your Avalara Identity Access Token>'
34
+ config.environment='sandbox'
35
+ config.app_name='testApp'
36
+ config.app_version='1.2.3'
37
+ config.machine_name='testMachine'
38
+ end
39
+
40
+ api_client = AvalaraSdk::ApiClient.new config
41
+ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
42
+
43
+ avalara_version = '2.0.0' # String | API version
44
+ opts = {
45
+ x_correlation_id: '96f3173e-05e5-496d-b7a2-8f3c8711164f', # String | Unique correlation Id in a GUID format
46
+ x_avalara_client: 'Swagger UI; 22.1.0', # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
47
+ create_and_send_w9_form_email_request: AvalaraSdk::A1099::V2::W4FormMinimalRequest.new({email: 'email_example', employee_first_name: 'employee_first_name_example', employee_last_name: 'employee_last_name_example'}) # CreateAndSendW9FormEmailRequest | Form to be created
48
+ }
49
+
50
+ begin
51
+ # Create a minimal W9/W4/W8 form and sends the e-mail request
52
+ result = api_instance.create_and_send_w9_form_email(avalara_version, opts)
53
+ p result
54
+ rescue AvalaraSdk::ApiError => e
55
+ puts "Error when calling FormsW9Api->create_and_send_w9_form_email: #{e}"
56
+ end
57
+ ```
58
+
59
+ #### Using the create_and_send_w9_form_email_with_http_info variant
60
+
61
+ This returns an Array which contains the response data, status code and headers.
62
+
63
+ > <Array(<CreateW9Form201Response>, Integer, Hash)> create_and_send_w9_form_email_with_http_info(avalara_version, opts)
64
+
65
+ ```ruby
66
+ begin
67
+ # Create a minimal W9/W4/W8 form and sends the e-mail request
68
+ data, status_code, headers = api_instance.create_and_send_w9_form_email_with_http_info(avalara_version, opts)
69
+ p status_code # => 2xx
70
+ p headers # => { ... }
71
+ p data # => <CreateW9Form201Response>
72
+ rescue AvalaraSdk::A1099::V2::ApiError => e
73
+ puts "Error when calling FormsW9Api->create_and_send_w9_form_email_with_http_info: #{e}"
74
+ end
75
+ ```
76
+
77
+ ### Parameters
78
+
79
+ | Name | Type | Description | Notes |
80
+ | ---- | ---- | ----------- | ----- |
81
+ | **avalara_version** | **String** | API version | |
82
+ | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
83
+ | **x_avalara_client** | **String** | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] |
84
+ | **create_and_send_w9_form_email_request** | [**CreateAndSendW9FormEmailRequest**](CreateAndSendW9FormEmailRequest.md) | Form to be created | [optional] |
85
+
86
+ ### Return type
87
+
88
+ [**CreateW9Form201Response**](CreateW9Form201Response.md)
89
+
90
+ ### Authorization
91
+
92
+ [bearer](../../../README.md#documentation-for-authorization)
93
+
94
+ ### HTTP request headers
95
+
96
+ - **Content-Type**: application/json, text/json, application/*+json
97
+ - **Accept**: application/json
98
+
99
+
16
100
  ## create_w9_form
17
101
 
18
102
  > <CreateW9Form201Response> create_w9_form(avalara_version, opts)
@@ -41,9 +125,9 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
41
125
 
42
126
  avalara_version = '2.0.0' # String | API version
43
127
  opts = {
44
- x_correlation_id: 'd8cc3501-afdd-4b9e-af90-85db9793cbbc', # String | Unique correlation Id in a GUID format
128
+ x_correlation_id: '4fef31cf-2985-471b-83bb-59b4bf4cee0e', # String | Unique correlation Id in a GUID format
45
129
  x_avalara_client: 'Swagger UI; 22.1.0', # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
46
- create_w9_form_request: AvalaraSdk::A1099::V2::W4FormRequest.new # CreateW9FormRequest | Form to be created
130
+ create_w9_form_request: AvalaraSdk::A1099::V2::W4FormRequest.new({employee_first_name: 'employee_first_name_example', employee_last_name: 'employee_last_name_example', tin_type: 'tin_type_example', tin: 'tin_example'}) # CreateW9FormRequest | Form to be created
47
131
  }
48
132
 
49
133
  begin
@@ -125,7 +209,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
125
209
  id = 'id_example' # String | ID of the form to delete
126
210
  avalara_version = '2.0.0' # String | API version
127
211
  opts = {
128
- x_correlation_id: '0013f0dd-e304-45c6-9f17-bd023626ba48', # String | Unique correlation Id in a GUID format
212
+ x_correlation_id: 'b1cd71dd-2fd3-483d-b611-0dd8306b5201', # String | Unique correlation Id in a GUID format
129
213
  x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
130
214
  }
131
215
 
@@ -207,7 +291,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
207
291
  id = 'id_example' # String | ID of the form
208
292
  avalara_version = '2.0.0' # String | API version
209
293
  opts = {
210
- x_correlation_id: 'e76a4eb2-f5f0-4586-888a-c25443f75fc4', # String | Unique correlation Id in a GUID format
294
+ x_correlation_id: '6d803604-fec0-4f42-9114-e77ddd25d823', # String | Unique correlation Id in a GUID format
211
295
  x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
212
296
  }
213
297
 
@@ -295,7 +379,7 @@ opts = {
295
379
  order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.
296
380
  count: true, # Boolean | If true, return the global count of elements in the collection.
297
381
  count_only: true, # Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true.
298
- x_correlation_id: '8092ac9c-17d0-4ee8-a00e-804088e5ab81', # String | Unique correlation Id in a GUID format
382
+ x_correlation_id: '5473c6dd-8986-4b62-b027-9a94c94f9401', # String | Unique correlation Id in a GUID format
299
383
  x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
300
384
  }
301
385
 
@@ -356,11 +440,11 @@ end
356
440
 
357
441
  ## send_w9_form_email
358
442
 
359
- > <IW9FormDataModelsOneOf> send_w9_form_email(id, avalara_version, opts)
443
+ > <CreateW9Form201Response> send_w9_form_email(id, avalara_version, opts)
360
444
 
361
445
  Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form
362
446
 
363
- Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form.
447
+ Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form. If the form is not in 'Requested' status, it will either use an existing descendant form in 'Requested' status or create a new minimal form and send the email request.
364
448
 
365
449
  ### Examples
366
450
 
@@ -383,7 +467,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
383
467
  id = 'id_example' # String | The ID of the W9/W4/W8 form.
384
468
  avalara_version = '2.0.0' # String | API version
385
469
  opts = {
386
- x_correlation_id: '05ca3285-5ab1-43c0-88d7-f23c30428d54', # String | Unique correlation Id in a GUID format
470
+ x_correlation_id: '1204a47d-7c4d-4b63-8776-560f89e236e6', # String | Unique correlation Id in a GUID format
387
471
  x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
388
472
  }
389
473
 
@@ -400,7 +484,7 @@ end
400
484
 
401
485
  This returns an Array which contains the response data, status code and headers.
402
486
 
403
- > <Array(<IW9FormDataModelsOneOf>, Integer, Hash)> send_w9_form_email_with_http_info(id, avalara_version, opts)
487
+ > <Array(<CreateW9Form201Response>, Integer, Hash)> send_w9_form_email_with_http_info(id, avalara_version, opts)
404
488
 
405
489
  ```ruby
406
490
  begin
@@ -408,7 +492,7 @@ begin
408
492
  data, status_code, headers = api_instance.send_w9_form_email_with_http_info(id, avalara_version, opts)
409
493
  p status_code # => 2xx
410
494
  p headers # => { ... }
411
- p data # => <IW9FormDataModelsOneOf>
495
+ p data # => <CreateW9Form201Response>
412
496
  rescue AvalaraSdk::A1099::V2::ApiError => e
413
497
  puts "Error when calling FormsW9Api->send_w9_form_email_with_http_info: #{e}"
414
498
  end
@@ -425,7 +509,7 @@ end
425
509
 
426
510
  ### Return type
427
511
 
428
- [**IW9FormDataModelsOneOf**](IW9FormDataModelsOneOf.md)
512
+ [**CreateW9Form201Response**](CreateW9Form201Response.md)
429
513
 
430
514
  ### Authorization
431
515
 
@@ -439,7 +523,7 @@ end
439
523
 
440
524
  ## update_w9_form
441
525
 
442
- > <IW9FormDataModelsOneOf> update_w9_form(id, avalara_version, opts)
526
+ > <CreateW9Form201Response> update_w9_form(id, avalara_version, opts)
443
527
 
444
528
  Update a W9/W4/W8 form
445
529
 
@@ -466,9 +550,9 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
466
550
  id = 'id_example' # String | ID of the form to update
467
551
  avalara_version = '2.0.0' # String | API version
468
552
  opts = {
469
- x_correlation_id: '87498441-c774-4e3a-864e-dd604bff0d41', # String | Unique correlation Id in a GUID format
553
+ x_correlation_id: '2f240777-dd4f-4aaf-b4b6-fcb22df6de90', # String | Unique correlation Id in a GUID format
470
554
  x_avalara_client: 'Swagger UI; 22.1.0', # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
471
- iw9_form_data_models_one_of: AvalaraSdk::A1099::V2::W4FormDataModel.new # IW9FormDataModelsOneOf | Form to be updated
555
+ create_w9_form_request: AvalaraSdk::A1099::V2::W4FormRequest.new({employee_first_name: 'employee_first_name_example', employee_last_name: 'employee_last_name_example', tin_type: 'tin_type_example', tin: 'tin_example'}) # CreateW9FormRequest | Form to be updated
472
556
  }
473
557
 
474
558
  begin
@@ -484,7 +568,7 @@ end
484
568
 
485
569
  This returns an Array which contains the response data, status code and headers.
486
570
 
487
- > <Array(<IW9FormDataModelsOneOf>, Integer, Hash)> update_w9_form_with_http_info(id, avalara_version, opts)
571
+ > <Array(<CreateW9Form201Response>, Integer, Hash)> update_w9_form_with_http_info(id, avalara_version, opts)
488
572
 
489
573
  ```ruby
490
574
  begin
@@ -492,7 +576,7 @@ begin
492
576
  data, status_code, headers = api_instance.update_w9_form_with_http_info(id, avalara_version, opts)
493
577
  p status_code # => 2xx
494
578
  p headers # => { ... }
495
- p data # => <IW9FormDataModelsOneOf>
579
+ p data # => <CreateW9Form201Response>
496
580
  rescue AvalaraSdk::A1099::V2::ApiError => e
497
581
  puts "Error when calling FormsW9Api->update_w9_form_with_http_info: #{e}"
498
582
  end
@@ -506,11 +590,11 @@ end
506
590
  | **avalara_version** | **String** | API version | |
507
591
  | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
508
592
  | **x_avalara_client** | **String** | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] |
509
- | **iw9_form_data_models_one_of** | [**IW9FormDataModelsOneOf**](IW9FormDataModelsOneOf.md) | Form to be updated | [optional] |
593
+ | **create_w9_form_request** | [**CreateW9FormRequest**](CreateW9FormRequest.md) | Form to be updated | [optional] |
510
594
 
511
595
  ### Return type
512
596
 
513
- [**IW9FormDataModelsOneOf**](IW9FormDataModelsOneOf.md)
597
+ [**CreateW9Form201Response**](CreateW9Form201Response.md)
514
598
 
515
599
  ### Authorization
516
600
 
@@ -551,7 +635,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
551
635
  id = 'id_example' # String | Id of the form
552
636
  avalara_version = '2.0.0' # String | API version
553
637
  opts = {
554
- x_correlation_id: '453b7d64-1fd0-4ed3-ba3c-a1d9ca1d69e6', # String | Unique correlation Id in a GUID format
638
+ x_correlation_id: 'ba65d92c-2a2a-4b4e-9731-c7b385d7fb59', # String | Unique correlation Id in a GUID format
555
639
  x_avalara_client: 'Swagger UI; 22.1.0', # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
556
640
  file: File.new('/path/to/some/file') # File |
557
641
  }
@@ -14,15 +14,15 @@ require 'avalara_sdk'
14
14
  AvalaraSdk::A1099::V2::Get1099Form200Response.openapi_one_of
15
15
  # =>
16
16
  # [
17
- # :'Form1042SListItemResponse',
18
- # :'Form1095BListItemResponse',
19
- # :'Form1099BaseResponse',
20
- # :'Form1099DivListItemResponse',
21
- # :'Form1099IntListItemResponse',
22
- # :'Form1099KListItemResponse',
23
- # :'Form1099MiscListItemResponse',
24
- # :'Form1099NecListItemResponse',
25
- # :'Form1099RListItemResponse'
17
+ # :'Form1042S',
18
+ # :'Form1095B',
19
+ # :'Form1095C',
20
+ # :'Form1099Div',
21
+ # :'Form1099Int',
22
+ # :'Form1099K',
23
+ # :'Form1099Misc',
24
+ # :'Form1099Nec',
25
+ # :'Form1099R'
26
26
  # ]
27
27
  ```
28
28
 
@@ -36,7 +36,7 @@ Find the appropriate object from the `openapi_one_of` list and casts the data in
36
36
  require 'avalara_sdk'
37
37
 
38
38
  AvalaraSdk::A1099::V2::Get1099Form200Response.build(data)
39
- # => #<Form1042SListItemResponse:0x00007fdd4aab02a0>
39
+ # => #<Form1042S:0x00007fdd4aab02a0>
40
40
 
41
41
  AvalaraSdk::A1099::V2::Get1099Form200Response.build(data_that_doesnt_match)
42
42
  # => nil
@@ -50,14 +50,14 @@ AvalaraSdk::A1099::V2::Get1099Form200Response.build(data_that_doesnt_match)
50
50
 
51
51
  #### Return type
52
52
 
53
- - `Form1042SListItemResponse`
54
- - `Form1095BListItemResponse`
55
- - `Form1099BaseResponse`
56
- - `Form1099DivListItemResponse`
57
- - `Form1099IntListItemResponse`
58
- - `Form1099KListItemResponse`
59
- - `Form1099MiscListItemResponse`
60
- - `Form1099NecListItemResponse`
61
- - `Form1099RListItemResponse`
53
+ - `Form1042S`
54
+ - `Form1095B`
55
+ - `Form1095C`
56
+ - `Form1099Div`
57
+ - `Form1099Int`
58
+ - `Form1099K`
59
+ - `Form1099Misc`
60
+ - `Form1099Nec`
61
+ - `Form1099R`
62
62
  - `nil` (if no type matches)
63
63