avalara_sdk 25.8.3 → 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 (110) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +4 -14
  4. data/docs/A1099/V2/CompaniesW9Api.md +9 -9
  5. data/docs/A1099/V2/CompanyBase.md +50 -0
  6. data/docs/A1099/V2/CompanyRequest.md +50 -0
  7. data/docs/A1099/V2/Form1042S.md +16 -16
  8. data/docs/A1099/V2/Form1095B.md +15 -15
  9. data/docs/A1099/V2/Form1095C.md +14 -14
  10. data/docs/A1099/V2/Form1099Base.md +14 -14
  11. data/docs/A1099/V2/Form1099Div.md +15 -15
  12. data/docs/A1099/V2/Form1099Int.md +16 -16
  13. data/docs/A1099/V2/Form1099K.md +20 -20
  14. data/docs/A1099/V2/Form1099ListRequest.md +1 -1
  15. data/docs/A1099/V2/Form1099Misc.md +15 -15
  16. data/docs/A1099/V2/Form1099Nec.md +17 -17
  17. data/docs/A1099/V2/Form1099R.md +17 -17
  18. data/docs/A1099/V2/Forms1099Api.md +12 -12
  19. data/docs/A1099/V2/FormsW9Api.md +17 -17
  20. data/docs/A1099/V2/IntermediaryOrFlowThrough.md +2 -2
  21. data/docs/A1099/V2/IssuerBase.md +46 -0
  22. data/docs/A1099/V2/IssuerRequest.md +46 -0
  23. data/docs/A1099/V2/Issuers1099Api.md +9 -9
  24. data/docs/A1099/V2/JobResponse.md +1 -1
  25. data/docs/A1099/V2/JobsApi.md +1 -1
  26. data/docs/A1099/V2/TinMatchStatusResponse.md +1 -1
  27. data/docs/A1099/V2/W4FormMinimalRequest.md +2 -2
  28. data/docs/A1099/V2/W4FormRequest.md +11 -11
  29. data/docs/A1099/V2/W4FormResponse.md +48 -20
  30. data/docs/A1099/V2/W8BenEFormMinimalRequest.md +2 -2
  31. data/docs/A1099/V2/W8BenEFormRequest.md +10 -10
  32. data/docs/A1099/V2/W8BenEFormResponse.md +96 -68
  33. data/docs/A1099/V2/W8BenFormMinimalRequest.md +2 -2
  34. data/docs/A1099/V2/W8BenFormRequest.md +6 -6
  35. data/docs/A1099/V2/W8BenFormResponse.md +55 -27
  36. data/docs/A1099/V2/W8ImyFormMinimalRequest.md +2 -2
  37. data/docs/A1099/V2/W8ImyFormRequest.md +10 -10
  38. data/docs/A1099/V2/W8ImyFormResponse.md +118 -90
  39. data/docs/A1099/V2/W9FormBaseMinimalRequest.md +2 -2
  40. data/docs/A1099/V2/W9FormBaseRequest.md +2 -2
  41. data/docs/A1099/V2/W9FormBaseResponse.md +3 -3
  42. data/docs/A1099/V2/W9FormMinimalRequest.md +2 -2
  43. data/docs/A1099/V2/W9FormRequest.md +10 -10
  44. data/docs/A1099/V2/W9FormResponse.md +44 -16
  45. data/lib/avalara_sdk/api/A1099/V2/companies_w9_api.rb +21 -21
  46. data/lib/avalara_sdk/api/A1099/V2/forms1099_api.rb +7 -7
  47. data/lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb +16 -16
  48. data/lib/avalara_sdk/api/A1099/V2/issuers1099_api.rb +21 -21
  49. data/lib/avalara_sdk/api/A1099/V2/jobs_api.rb +1 -1
  50. data/lib/avalara_sdk/api/EInvoicing/V1/data_input_fields_api.rb +1 -1
  51. data/lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb +1 -1
  52. data/lib/avalara_sdk/api/EInvoicing/V1/interop_api.rb +1 -1
  53. data/lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb +1 -1
  54. data/lib/avalara_sdk/api/EInvoicing/V1/subscriptions_api.rb +1 -1
  55. data/lib/avalara_sdk/api/EInvoicing/V1/tax_identifiers_api.rb +1 -1
  56. data/lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb +1 -1
  57. data/lib/avalara_sdk/api_client.rb +10 -2
  58. data/lib/avalara_sdk/models/A1099/V2/company_base.rb +404 -0
  59. data/lib/avalara_sdk/models/A1099/V2/company_request.rb +411 -0
  60. data/lib/avalara_sdk/models/A1099/V2/company_response.rb +1 -1
  61. data/lib/avalara_sdk/models/A1099/V2/error_response.rb +0 -6
  62. data/lib/avalara_sdk/models/A1099/V2/form1042_s.rb +20 -30
  63. data/lib/avalara_sdk/models/A1099/V2/form1095_b.rb +19 -40
  64. data/lib/avalara_sdk/models/A1099/V2/form1095_c.rb +18 -49
  65. data/lib/avalara_sdk/models/A1099/V2/form1099_base.rb +18 -29
  66. data/lib/avalara_sdk/models/A1099/V2/form1099_div.rb +20 -31
  67. data/lib/avalara_sdk/models/A1099/V2/form1099_int.rb +22 -32
  68. data/lib/avalara_sdk/models/A1099/V2/form1099_k.rb +35 -38
  69. data/lib/avalara_sdk/models/A1099/V2/form1099_list_request.rb +2 -12
  70. data/lib/avalara_sdk/models/A1099/V2/form1099_misc.rb +20 -31
  71. data/lib/avalara_sdk/models/A1099/V2/form1099_nec.rb +23 -33
  72. data/lib/avalara_sdk/models/A1099/V2/form1099_r.rb +48 -33
  73. data/lib/avalara_sdk/models/A1099/V2/intermediary_or_flow_through.rb +48 -2
  74. data/lib/avalara_sdk/models/A1099/V2/issuer_base.rb +384 -0
  75. data/lib/avalara_sdk/models/A1099/V2/issuer_request.rb +391 -0
  76. data/lib/avalara_sdk/models/A1099/V2/issuer_response.rb +1 -1
  77. data/lib/avalara_sdk/models/A1099/V2/job_response.rb +0 -6
  78. data/lib/avalara_sdk/models/A1099/V2/validation_error.rb +0 -6
  79. data/lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb +1 -27
  80. data/lib/avalara_sdk/models/A1099/V2/w4_form_request.rb +31 -29
  81. data/lib/avalara_sdk/models/A1099/V2/w4_form_response.rb +191 -15
  82. data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_minimal_request.rb +1 -27
  83. data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_request.rb +37 -28
  84. data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb +190 -14
  85. data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_minimal_request.rb +1 -27
  86. data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_request.rb +20 -23
  87. data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb +191 -15
  88. data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_minimal_request.rb +1 -27
  89. data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_request.rb +30 -28
  90. data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_response.rb +191 -15
  91. data/lib/avalara_sdk/models/A1099/V2/w9_form_base_minimal_request.rb +1 -27
  92. data/lib/avalara_sdk/models/A1099/V2/w9_form_base_request.rb +1 -27
  93. data/lib/avalara_sdk/models/A1099/V2/w9_form_base_response.rb +47 -18
  94. data/lib/avalara_sdk/models/A1099/V2/w9_form_minimal_request.rb +1 -27
  95. data/lib/avalara_sdk/models/A1099/V2/w9_form_request.rb +40 -25
  96. data/lib/avalara_sdk/models/A1099/V2/w9_form_response.rb +190 -14
  97. data/lib/avalara_sdk/version.rb +1 -1
  98. data/lib/avalara_sdk.rb +8 -4
  99. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/byebug-11.1.3/gem_make.out +5 -5
  100. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/date-3.4.1/gem_make.out +5 -5
  101. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debase-0.2.9/gem_make.out +5 -5
  102. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debug-1.10.0/gem_make.out +5 -5
  103. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/erb-5.0.1/gem_make.out +5 -5
  104. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/io-console-0.8.0/gem_make.out +5 -5
  105. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/json-2.12.2/gem_make.out +5 -5
  106. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/prism-1.4.0/gem_make.out +5 -5
  107. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/psych-5.2.6/gem_make.out +5 -5
  108. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/racc-1.8.1/gem_make.out +5 -5
  109. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/stringio-3.1.7/gem_make.out +5 -5
  110. metadata +10 -2
@@ -42,9 +42,9 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
42
42
 
43
43
  avalara_version = '2.0.0' # String | API version
44
44
  opts = {
45
- x_correlation_id: '876394c1-80f7-4f02-a857-3899965a96bf', # String | Unique correlation Id in a GUID format
45
+ x_correlation_id: '96f3173e-05e5-496d-b7a2-8f3c8711164f', # 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
- 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', company_id: 'company_id_example'}) # CreateAndSendW9FormEmailRequest | Form to be created
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
48
  }
49
49
 
50
50
  begin
@@ -125,9 +125,9 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
125
125
 
126
126
  avalara_version = '2.0.0' # String | API version
127
127
  opts = {
128
- x_correlation_id: '4f7d2a74-9904-4300-b8c4-d5eadabea39b', # 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
129
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/) .
130
- create_w9_form_request: AvalaraSdk::A1099::V2::W4FormRequest.new({company_id: 'company_id_example'}) # 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
131
131
  }
132
132
 
133
133
  begin
@@ -209,7 +209,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
209
209
  id = 'id_example' # String | ID of the form to delete
210
210
  avalara_version = '2.0.0' # String | API version
211
211
  opts = {
212
- x_correlation_id: '897b8ec0-bd1d-404b-b128-05268ad1823d', # 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
213
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/) .
214
214
  }
215
215
 
@@ -291,7 +291,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
291
291
  id = 'id_example' # String | ID of the form
292
292
  avalara_version = '2.0.0' # String | API version
293
293
  opts = {
294
- x_correlation_id: '5aacb16c-2a0a-4896-a0d2-a121f2b5d1d8', # 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
295
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/) .
296
296
  }
297
297
 
@@ -379,7 +379,7 @@ opts = {
379
379
  order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.
380
380
  count: true, # Boolean | If true, return the global count of elements in the collection.
381
381
  count_only: true, # Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true.
382
- x_correlation_id: '779b71e3-fc48-49be-b680-e44e47b3d963', # 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
383
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/) .
384
384
  }
385
385
 
@@ -444,7 +444,7 @@ end
444
444
 
445
445
  Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form
446
446
 
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.
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.
448
448
 
449
449
  ### Examples
450
450
 
@@ -467,7 +467,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
467
467
  id = 'id_example' # String | The ID of the W9/W4/W8 form.
468
468
  avalara_version = '2.0.0' # String | API version
469
469
  opts = {
470
- x_correlation_id: '8f5afdc6-9616-494f-940c-c66b87b43d27', # 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
471
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/) .
472
472
  }
473
473
 
@@ -523,7 +523,7 @@ end
523
523
 
524
524
  ## update_w9_form
525
525
 
526
- > <IW9FormDataModelsOneOf> update_w9_form(id, avalara_version, opts)
526
+ > <CreateW9Form201Response> update_w9_form(id, avalara_version, opts)
527
527
 
528
528
  Update a W9/W4/W8 form
529
529
 
@@ -550,9 +550,9 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
550
550
  id = 'id_example' # String | ID of the form to update
551
551
  avalara_version = '2.0.0' # String | API version
552
552
  opts = {
553
- x_correlation_id: 'e0842c54-95c7-488a-882a-ce34cb46e87d', # 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
554
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/) .
555
- 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
556
556
  }
557
557
 
558
558
  begin
@@ -568,7 +568,7 @@ end
568
568
 
569
569
  This returns an Array which contains the response data, status code and headers.
570
570
 
571
- > <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)
572
572
 
573
573
  ```ruby
574
574
  begin
@@ -576,7 +576,7 @@ begin
576
576
  data, status_code, headers = api_instance.update_w9_form_with_http_info(id, avalara_version, opts)
577
577
  p status_code # => 2xx
578
578
  p headers # => { ... }
579
- p data # => <IW9FormDataModelsOneOf>
579
+ p data # => <CreateW9Form201Response>
580
580
  rescue AvalaraSdk::A1099::V2::ApiError => e
581
581
  puts "Error when calling FormsW9Api->update_w9_form_with_http_info: #{e}"
582
582
  end
@@ -590,11 +590,11 @@ end
590
590
  | **avalara_version** | **String** | API version | |
591
591
  | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
592
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] |
593
- | **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] |
594
594
 
595
595
  ### Return type
596
596
 
597
- [**IW9FormDataModelsOneOf**](IW9FormDataModelsOneOf.md)
597
+ [**CreateW9Form201Response**](CreateW9Form201Response.md)
598
598
 
599
599
  ### Authorization
600
600
 
@@ -635,7 +635,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
635
635
  id = 'id_example' # String | Id of the form
636
636
  avalara_version = '2.0.0' # String | API version
637
637
  opts = {
638
- x_correlation_id: 'ba11f0c0-e9ed-4667-8137-0026b63b63cf', # 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
639
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/) .
640
640
  file: File.new('/path/to/some/file') # File |
641
641
  }
@@ -5,8 +5,8 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **ein** | **String** | EIN (Employer Identification Number) of the intermediary or flow-through entity | [optional] |
8
- | **chap3_status_code** | **String** | Chapter 3 status code for the intermediary or flow-through entity | [optional] |
9
- | **chap4_status_code** | **String** | Chapter 4 status code for the intermediary or flow-through entity | [optional] |
8
+ | **chap3_status_code** | **String** | Chapter 3 status code for the intermediary or flow-through entity. Available values: - 01: U.S. Withholding Agent - FI (Deprecated - valid only for tax years prior to 2020) - 02: U.S. Withholding Agent - Other (Deprecated - valid only for tax years prior to 2020) - 03: Territory FI - treated as U.S. Person - 04: Territory FI - not treated as U.S. Person - 05: U.S. branch - treated as U.S. Person - 06: U.S. branch - not treated as U.S. Person - 07: U.S. branch - ECI presumption applied - 08: Partnership other than Withholding Foreign Partnership - 09: Withholding Foreign Partnership - 10: Trust other than Withholding Foreign Trust - 11: Withholding Foreign Trust - 12: Qualified Intermediary - 13: Qualified Securities Lender - Qualified Intermediary - 14: Qualified Securities Lender - Other - 15: Corporation - 16: Individual - 17: Estate - 18: Private Foundation - 19: Government or International Organization - 20: Tax Exempt Organization (Section 501(c) entities) - 21: Unknown Recipient - 22: Artist or Athlete - 23: Pension - 24: Foreign Central Bank of Issue - 25: Nonqualified Intermediary - 26: Hybrid entity making Treaty Claim - 27: Withholding Rate Pool - General - 28: Withholding Rate Pool - Exempt Organization - 29: PAI Withholding Rate Pool - General - 30: PAI Withholding Rate Pool - Exempt Organization - 31: Agency Withholding Rate Pool - General - 32: Agency Withholding Rate Pool - Exempt Organization - 34: U.S. Withholding Agent-Foreign branch of FI (Deprecated - valid only for tax years prior to 2020) - 35: Qualified Derivatives Dealer - 36: Foreign Government - Integral Part - 37: Foreign Government - Controlled Entity - 38: Publicly Traded Partnership - 39: Disclosing Qualified Intermediary | [optional] |
9
+ | **chap4_status_code** | **String** | Chapter 4 status code for the intermediary or flow-through entity. Available values: - 01: U.S. Withholding Agent - FI - 02: U.S. Withholding Agent - Other - 03: Territory FI - not treated as U.S. Person - 04: Territory FI - treated as U.S. Person - 05: Participating FFI - Other - 06: Participating FFI - Reporting Model 2 FFI - 07: Registered Deemed - Compliant FFI-Reporting Model 1 FFI - 08: Registered Deemed - Compliant FFI-Sponsored Entity - 09: Registered Deemed - Compliant FFI-Other - 10: Certified Deemed - Compliant FFI-Other - 11: Certified Deemed - Compliant FFI-FFI with Low Value Accounts - 12: Certified Deemed - Compliant FFI-Non-Registering Local Bank - 13: Certified Deemed - Compliant FFI-Sponsored Entity - 14: Certified Deemed - Compliant FFI-Investment Advisor or Investment Manager - 15: Nonparticipating FFI - 16: Owner-Documented FFI - 17: U.S. Branch - treated as U.S. person - 18: U.S. Branch - not treated as U.S. person (reporting under section 1471) - 19: Passive NFFE identifying Substantial U.S. Owners - 20: Passive NFFE with no Substantial U.S. Owners - 21: Publicly Traded NFFE or Affiliate of Publicly Traded NFFE - 22: Active NFFE - 23: Individual - 24: Section 501(c) Entities - 25: Excepted Territory NFFE - 26: Excepted NFFE - Other - 27: Exempt Beneficial Owner - 28: Entity Wholly Owned by Exempt Beneficial Owners - 29: Unknown Recipient - 30: Recalcitrant Account Holder - 31: Nonreporting IGA FFI - 32: Direct reporting NFFE - 33: U.S. reportable account - 34: Non-consenting U.S. account - 35: Sponsored direct reporting NFFE - 36: Excepted Inter-affiliate FFI - 37: Undocumented Preexisting Obligation - 38: U.S. Branch - ECI presumption applied - 39: Account Holder of Excluded Financial Account - 40: Passive NFFE reported by FFI - 41: NFFE subject to 1472 withholding - 42: Recalcitrant Pool - No U.S. Indicia - 43: Recalcitrant Pool - U.S. Indicia - 44: Recalcitrant Pool - Dormant Account - 45: Recalcitrant Pool - U.S. Persons - 46: Recalcitrant Pool - Passive NFFEs - 47: Nonparticipating FFI Pool - 48: U.S. Payees Pool - 49: QI - Recalcitrant Pool-General - 50: U.S. Withholding Agent-Foreign branch of FI | [optional] |
10
10
  | **name** | **String** | Name of the intermediary or flow-through entity | [optional] |
11
11
  | **giin** | **String** | GIIN (Global Intermediary Identification Number) of the intermediary or flow-through entity | [optional] |
12
12
  | **country_code** | **String** | Country code for the intermediary or flow-through entity | [optional] |
@@ -0,0 +1,46 @@
1
+ # AvalaraSdk::A1099::V2::IssuerBase
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Legal name. Not the DBA name. | |
8
+ | **dba_name** | **String** | Doing Business As (DBA) name or continuation of a long legal name. Use either this or &#39;transferAgentName&#39;. | [optional] |
9
+ | **tin** | **String** | Federal Tax Identification Number (TIN). | [optional] |
10
+ | **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. If present, it will prefix download filenames. Allowed characters: letters, numbers, dashes, underscores, and spaces. | [optional] |
11
+ | **telephone** | **String** | Contact phone number (must contain at least 10 digits, max 15 characters). For recipient inquiries. | |
12
+ | **tax_year** | **Integer** | Tax year for which the forms are being filed (e.g., 2024). Must be within current tax year and current tax year - 4. | |
13
+ | **country_code** | **String** | Two-letter IRS country code (e.g., &#39;US&#39;, &#39;CA&#39;), as defined at https://www.irs.gov/e-file-providers/country-codes. If there is a transfer agent, use the transfer agent&#39;s shipping address. | [optional] |
14
+ | **email** | **String** | Contact email address. For recipient inquiries. | |
15
+ | **address** | **String** | Address. | |
16
+ | **city** | **String** | City. | |
17
+ | **state** | **String** | Two-letter US state or Canadian province code (required for US/CA addresses). | |
18
+ | **zip** | **String** | ZIP/postal code. | |
19
+ | **foreign_province** | **String** | Province or region for non-US/CA addresses. | [optional] |
20
+ | **transfer_agent_name** | **String** | Name of the transfer agent, if applicable — optional; use either this or &#39;dbaName&#39;. | [optional] |
21
+ | **last_filing** | **Boolean** | Indicates if this is the issuer&#39;s final year filing. | |
22
+
23
+ ## Example
24
+
25
+ ```ruby
26
+ require 'avalara_sdk'
27
+
28
+ instance = AvalaraSdk::A1099::V2::IssuerBase.new(
29
+ name: null,
30
+ dba_name: null,
31
+ tin: null,
32
+ reference_id: null,
33
+ telephone: null,
34
+ tax_year: null,
35
+ country_code: null,
36
+ email: null,
37
+ address: null,
38
+ city: null,
39
+ state: null,
40
+ zip: null,
41
+ foreign_province: null,
42
+ transfer_agent_name: null,
43
+ last_filing: null
44
+ )
45
+ ```
46
+
@@ -0,0 +1,46 @@
1
+ # AvalaraSdk::A1099::V2::IssuerRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Legal name. Not the DBA name. | |
8
+ | **dba_name** | **String** | Doing Business As (DBA) name or continuation of a long legal name. Use either this or &#39;transferAgentName&#39;. | [optional] |
9
+ | **tin** | **String** | Federal Tax Identification Number (TIN). | [optional] |
10
+ | **reference_id** | **String** | Internal reference ID. Never shown to any agency or recipient. If present, it will prefix download filenames. Allowed characters: letters, numbers, dashes, underscores, and spaces. | [optional] |
11
+ | **telephone** | **String** | Contact phone number (must contain at least 10 digits, max 15 characters). For recipient inquiries. | |
12
+ | **tax_year** | **Integer** | Tax year for which the forms are being filed (e.g., 2024). Must be within current tax year and current tax year - 4. | |
13
+ | **country_code** | **String** | Two-letter IRS country code (e.g., &#39;US&#39;, &#39;CA&#39;), as defined at https://www.irs.gov/e-file-providers/country-codes. If there is a transfer agent, use the transfer agent&#39;s shipping address. | [optional] |
14
+ | **email** | **String** | Contact email address. For recipient inquiries. | |
15
+ | **address** | **String** | Address. | |
16
+ | **city** | **String** | City. | |
17
+ | **state** | **String** | Two-letter US state or Canadian province code (required for US/CA addresses). | |
18
+ | **zip** | **String** | ZIP/postal code. | |
19
+ | **foreign_province** | **String** | Province or region for non-US/CA addresses. | [optional] |
20
+ | **transfer_agent_name** | **String** | Name of the transfer agent, if applicable — optional; use either this or &#39;dbaName&#39;. | [optional] |
21
+ | **last_filing** | **Boolean** | Indicates if this is the issuer&#39;s final year filing. | |
22
+
23
+ ## Example
24
+
25
+ ```ruby
26
+ require 'avalara_sdk'
27
+
28
+ instance = AvalaraSdk::A1099::V2::IssuerRequest.new(
29
+ name: null,
30
+ dba_name: null,
31
+ tin: null,
32
+ reference_id: null,
33
+ telephone: null,
34
+ tax_year: null,
35
+ country_code: null,
36
+ email: null,
37
+ address: null,
38
+ city: null,
39
+ state: null,
40
+ zip: null,
41
+ foreign_province: null,
42
+ transfer_agent_name: null,
43
+ last_filing: null
44
+ )
45
+ ```
46
+
@@ -39,9 +39,9 @@ api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
39
39
 
40
40
  avalara_version = '2.0.0' # String | API version
41
41
  opts = {
42
- x_correlation_id: '26a8ae54-5655-49b3-b01a-f4203094a5ef', # String | Unique correlation Id in a GUID format
42
+ x_correlation_id: '5c70e4f3-3885-4757-84f3-86323c1af033', # String | Unique correlation Id in a GUID format
43
43
  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/) .
44
- create_issuer_request: AvalaraSdk::A1099::V2::IssuerCommand.new({name: 'name_example', telephone: 'telephone_example', tax_year: 37, email: 'email_example', address: 'address_example', city: 'city_example', state: 'state_example', zip: 'zip_example', last_filing: false}) # CreateIssuerRequest | The issuer to create
44
+ issuer_request: AvalaraSdk::A1099::V2::IssuerRequest.new({name: 'name_example', telephone: 'telephone_example', tax_year: 37, email: 'email_example', address: 'address_example', city: 'city_example', state: 'state_example', zip: 'zip_example', last_filing: false}) # IssuerRequest | The issuer to create
45
45
  }
46
46
 
47
47
  begin
@@ -78,7 +78,7 @@ end
78
78
  | **avalara_version** | **String** | API version | |
79
79
  | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
80
80
  | **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] |
81
- | **create_issuer_request** | [**CreateIssuerRequest**](CreateIssuerRequest.md) | The issuer to create | [optional] |
81
+ | **issuer_request** | [**IssuerRequest**](IssuerRequest.md) | The issuer to create | [optional] |
82
82
 
83
83
  ### Return type
84
84
 
@@ -123,7 +123,7 @@ api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
123
123
  id = 'id_example' # String | Id of the issuer to delete
124
124
  avalara_version = '2.0.0' # String | API version
125
125
  opts = {
126
- x_correlation_id: 'b8d102b3-3e63-4e6e-9735-25f17b0c69a7', # String | Unique correlation Id in a GUID format
126
+ x_correlation_id: 'ebe59aa0-745c-44da-b86b-67ad7994619c', # String | Unique correlation Id in a GUID format
127
127
  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/) .
128
128
  }
129
129
 
@@ -205,7 +205,7 @@ api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
205
205
  id = 'id_example' # String | Id of the issuer to retrieve
206
206
  avalara_version = '2.0.0' # String | API version
207
207
  opts = {
208
- x_correlation_id: 'fc90ea70-0e20-46ed-a73c-80e99e89f3d5', # String | Unique correlation Id in a GUID format
208
+ x_correlation_id: 'cfc604e9-15ae-4c65-a59f-123475fad2ef', # String | Unique correlation Id in a GUID format
209
209
  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/) .
210
210
  }
211
211
 
@@ -293,7 +293,7 @@ opts = {
293
293
  order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.
294
294
  count: true, # Boolean | If true, return the global count of elements in the collection.
295
295
  count_only: true, # Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true.
296
- x_correlation_id: '8c33cfd6-f102-4192-9001-24fed7baee29', # String | Unique correlation Id in a GUID format
296
+ x_correlation_id: '3302a30f-61fc-4b94-af04-c683c6064eed', # String | Unique correlation Id in a GUID format
297
297
  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/) .
298
298
  }
299
299
 
@@ -381,9 +381,9 @@ api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
381
381
  id = 'id_example' # String | Id of the issuer to update
382
382
  avalara_version = '2.0.0' # String | API version
383
383
  opts = {
384
- x_correlation_id: 'c353a7ba-0386-49f8-97a8-378cd39452ea', # String | Unique correlation Id in a GUID format
384
+ x_correlation_id: '4f30c58e-f8fd-4635-99d4-ea710f1d0182', # String | Unique correlation Id in a GUID format
385
385
  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/) .
386
- create_issuer_request: AvalaraSdk::A1099::V2::IssuerCommand.new({name: 'name_example', telephone: 'telephone_example', tax_year: 37, email: 'email_example', address: 'address_example', city: 'city_example', state: 'state_example', zip: 'zip_example', last_filing: false}) # CreateIssuerRequest | The issuer to update
386
+ issuer_request: AvalaraSdk::A1099::V2::IssuerRequest.new({name: 'name_example', telephone: 'telephone_example', tax_year: 37, email: 'email_example', address: 'address_example', city: 'city_example', state: 'state_example', zip: 'zip_example', last_filing: false}) # IssuerRequest | The issuer to update
387
387
  }
388
388
 
389
389
  begin
@@ -420,7 +420,7 @@ end
420
420
  | **avalara_version** | **String** | API version | |
421
421
  | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
422
422
  | **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] |
423
- | **create_issuer_request** | [**CreateIssuerRequest**](CreateIssuerRequest.md) | The issuer to update | [optional] |
423
+ | **issuer_request** | [**IssuerRequest**](IssuerRequest.md) | The issuer to update | [optional] |
424
424
 
425
425
  ### Return type
426
426
 
@@ -33,7 +33,7 @@ require 'avalara_sdk'
33
33
  instance = AvalaraSdk::A1099::V2::JobResponse.new(
34
34
  id: null,
35
35
  type: null,
36
- status: InProgress,
36
+ status: null,
37
37
  error_message: null,
38
38
  total_processed: null,
39
39
  total_rows: null,
@@ -36,7 +36,7 @@ api_instance = AvalaraSdk::A1099::V2::JobsApi.new api_client
36
36
  id = 'id_example' # String | Job id obtained from other API responses, like `/1099/bulk-upsert`.
37
37
  avalara_version = '2.0.0' # String | API version
38
38
  opts = {
39
- x_correlation_id: 'b5e99bb8-41d6-4f87-8677-070497e8fba3', # String | Unique correlation Id in a GUID format
39
+ x_correlation_id: 'af6414fe-0bd6-4ddb-91bb-43108aa78fa5', # String | Unique correlation Id in a GUID format
40
40
  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/) .
41
41
  }
42
42
 
@@ -15,7 +15,7 @@ require 'avalara_sdk'
15
15
 
16
16
  instance = AvalaraSdk::A1099::V2::TinMatchStatusResponse.new(
17
17
  time: null,
18
- status: None,
18
+ status: null,
19
19
  irs_response: null
20
20
  )
21
21
  ```
@@ -9,7 +9,7 @@
9
9
  | **employee_first_name** | **String** | The first name of the employee. | |
10
10
  | **employee_last_name** | **String** | The last name of the employee. | |
11
11
  | **office_code** | **String** | The office code associated with the form. | [optional] |
12
- | **company_id** | **String** | The ID of the associated company. | |
12
+ | **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] |
13
13
  | **reference_id** | **String** | A reference identifier for the form. | [optional] |
14
14
 
15
15
  ## Example
@@ -18,7 +18,7 @@
18
18
  require 'avalara_sdk'
19
19
 
20
20
  instance = AvalaraSdk::A1099::V2::W4FormMinimalRequest.new(
21
- type: W4,
21
+ type: null,
22
22
  email: null,
23
23
  employee_first_name: null,
24
24
  employee_last_name: null,
@@ -5,17 +5,17 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | The form type (always \&quot;w4\&quot; 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&#39;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] |
@@ -26,7 +26,7 @@
26
26
  | **office_code** | **String** | The office code associated with the form. | [optional] |
27
27
  | **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] |
28
28
  | **signature** | **String** | The signature of the form. | [optional] |
29
- | **company_id** | **String** | The ID of the associated company. | |
29
+ | **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] |
30
30
  | **reference_id** | **String** | A reference identifier for the form. | [optional] |
31
31
  | **email** | **String** | The email address of the individual associated with the form. | [optional] |
32
32
 
@@ -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,
@@ -4,11 +4,12 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | The form type (always \&quot;W4\&quot; 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
 
@@ -8,7 +8,7 @@
8
8
  | **email** | **String** | The email address of the individual associated with the form. | |
9
9
  | **name** | **String** | The name of the individual or entity associated with the form. | |
10
10
  | **reference_number** | **String** | A reference number for the form. | [optional] |
11
- | **company_id** | **String** | The ID of the associated company. | |
11
+ | **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] |
12
12
  | **reference_id** | **String** | A reference identifier for the form. | [optional] |
13
13
 
14
14
  ## Example
@@ -17,7 +17,7 @@
17
17
  require 'avalara_sdk'
18
18
 
19
19
  instance = AvalaraSdk::A1099::V2::W8BenEFormMinimalRequest.new(
20
- type: W4,
20
+ type: null,
21
21
  email: null,
22
22
  name: null,
23
23
  reference_number: null,
@@ -5,17 +5,17 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | The form type (always \&quot;w8bene\&quot; 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&#39;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] |
@@ -102,7 +102,7 @@
102
102
  | **capacity_to_sign_certification** | **Boolean** | Certifies signer has the capacity to sign for the beneficial owner. | [optional] |
103
103
  | **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] |
104
104
  | **signature** | **String** | The signature of the form. | [optional] |
105
- | **company_id** | **String** | The ID of the associated company. | |
105
+ | **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] |
106
106
  | **reference_id** | **String** | A reference identifier for the form. | [optional] |
107
107
  | **email** | **String** | The email address of the individual associated with the form. | [optional] |
108
108
 
@@ -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,