avalara_sdk 25.8.3 → 25.10.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 (113) 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/ErrorResponse.md +2 -2
  8. data/docs/A1099/V2/ErrorResponseItem.md +2 -2
  9. data/docs/A1099/V2/Form1042S.md +16 -16
  10. data/docs/A1099/V2/Form1095B.md +15 -15
  11. data/docs/A1099/V2/Form1095C.md +14 -14
  12. data/docs/A1099/V2/Form1099Base.md +14 -14
  13. data/docs/A1099/V2/Form1099Div.md +15 -15
  14. data/docs/A1099/V2/Form1099Int.md +16 -16
  15. data/docs/A1099/V2/Form1099K.md +20 -20
  16. data/docs/A1099/V2/Form1099ListRequest.md +1 -1
  17. data/docs/A1099/V2/Form1099Misc.md +15 -15
  18. data/docs/A1099/V2/Form1099Nec.md +17 -17
  19. data/docs/A1099/V2/Form1099R.md +17 -17
  20. data/docs/A1099/V2/Forms1099Api.md +12 -12
  21. data/docs/A1099/V2/FormsW9Api.md +17 -17
  22. data/docs/A1099/V2/IntermediaryOrFlowThrough.md +2 -2
  23. data/docs/A1099/V2/IssuerBase.md +46 -0
  24. data/docs/A1099/V2/IssuerRequest.md +46 -0
  25. data/docs/A1099/V2/Issuers1099Api.md +9 -9
  26. data/docs/A1099/V2/JobResponse.md +1 -1
  27. data/docs/A1099/V2/JobsApi.md +1 -1
  28. data/docs/A1099/V2/TinMatchStatusResponse.md +1 -1
  29. data/docs/A1099/V2/W4FormMinimalRequest.md +2 -2
  30. data/docs/A1099/V2/W4FormRequest.md +11 -11
  31. data/docs/A1099/V2/W4FormResponse.md +48 -20
  32. data/docs/A1099/V2/W8BenEFormMinimalRequest.md +2 -2
  33. data/docs/A1099/V2/W8BenEFormRequest.md +10 -10
  34. data/docs/A1099/V2/W8BenEFormResponse.md +96 -68
  35. data/docs/A1099/V2/W8BenFormMinimalRequest.md +2 -2
  36. data/docs/A1099/V2/W8BenFormRequest.md +6 -6
  37. data/docs/A1099/V2/W8BenFormResponse.md +55 -27
  38. data/docs/A1099/V2/W8ImyFormMinimalRequest.md +2 -2
  39. data/docs/A1099/V2/W8ImyFormRequest.md +10 -10
  40. data/docs/A1099/V2/W8ImyFormResponse.md +118 -90
  41. data/docs/A1099/V2/W9FormBaseMinimalRequest.md +2 -2
  42. data/docs/A1099/V2/W9FormBaseRequest.md +2 -2
  43. data/docs/A1099/V2/W9FormBaseResponse.md +3 -3
  44. data/docs/A1099/V2/W9FormMinimalRequest.md +2 -2
  45. data/docs/A1099/V2/W9FormRequest.md +12 -12
  46. data/docs/A1099/V2/W9FormResponse.md +44 -16
  47. data/lib/avalara_sdk/api/A1099/V2/companies_w9_api.rb +21 -21
  48. data/lib/avalara_sdk/api/A1099/V2/forms1099_api.rb +7 -7
  49. data/lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb +16 -16
  50. data/lib/avalara_sdk/api/A1099/V2/issuers1099_api.rb +21 -21
  51. data/lib/avalara_sdk/api/A1099/V2/jobs_api.rb +1 -1
  52. data/lib/avalara_sdk/api/EInvoicing/V1/data_input_fields_api.rb +1 -1
  53. data/lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb +1 -1
  54. data/lib/avalara_sdk/api/EInvoicing/V1/interop_api.rb +1 -1
  55. data/lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb +1 -1
  56. data/lib/avalara_sdk/api/EInvoicing/V1/subscriptions_api.rb +1 -1
  57. data/lib/avalara_sdk/api/EInvoicing/V1/tax_identifiers_api.rb +1 -1
  58. data/lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb +1 -1
  59. data/lib/avalara_sdk/api_client.rb +10 -2
  60. data/lib/avalara_sdk/models/A1099/V2/company_base.rb +404 -0
  61. data/lib/avalara_sdk/models/A1099/V2/company_request.rb +411 -0
  62. data/lib/avalara_sdk/models/A1099/V2/company_response.rb +1 -1
  63. data/lib/avalara_sdk/models/A1099/V2/error_response.rb +2 -6
  64. data/lib/avalara_sdk/models/A1099/V2/error_response_item.rb +2 -0
  65. data/lib/avalara_sdk/models/A1099/V2/form1042_s.rb +20 -30
  66. data/lib/avalara_sdk/models/A1099/V2/form1095_b.rb +19 -40
  67. data/lib/avalara_sdk/models/A1099/V2/form1095_c.rb +18 -49
  68. data/lib/avalara_sdk/models/A1099/V2/form1099_base.rb +18 -29
  69. data/lib/avalara_sdk/models/A1099/V2/form1099_div.rb +20 -31
  70. data/lib/avalara_sdk/models/A1099/V2/form1099_int.rb +22 -32
  71. data/lib/avalara_sdk/models/A1099/V2/form1099_k.rb +35 -38
  72. data/lib/avalara_sdk/models/A1099/V2/form1099_list_request.rb +2 -12
  73. data/lib/avalara_sdk/models/A1099/V2/form1099_misc.rb +20 -31
  74. data/lib/avalara_sdk/models/A1099/V2/form1099_nec.rb +23 -33
  75. data/lib/avalara_sdk/models/A1099/V2/form1099_r.rb +48 -33
  76. data/lib/avalara_sdk/models/A1099/V2/intermediary_or_flow_through.rb +48 -2
  77. data/lib/avalara_sdk/models/A1099/V2/issuer_base.rb +384 -0
  78. data/lib/avalara_sdk/models/A1099/V2/issuer_request.rb +391 -0
  79. data/lib/avalara_sdk/models/A1099/V2/issuer_response.rb +1 -1
  80. data/lib/avalara_sdk/models/A1099/V2/job_response.rb +0 -6
  81. data/lib/avalara_sdk/models/A1099/V2/validation_error.rb +0 -6
  82. data/lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb +1 -27
  83. data/lib/avalara_sdk/models/A1099/V2/w4_form_request.rb +50 -24
  84. data/lib/avalara_sdk/models/A1099/V2/w4_form_response.rb +191 -15
  85. data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_minimal_request.rb +1 -27
  86. data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_request.rb +37 -28
  87. data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_response.rb +190 -14
  88. data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_minimal_request.rb +1 -27
  89. data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_request.rb +20 -23
  90. data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_response.rb +191 -15
  91. data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_minimal_request.rb +1 -27
  92. data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_request.rb +72 -22
  93. data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_response.rb +191 -15
  94. data/lib/avalara_sdk/models/A1099/V2/w9_form_base_minimal_request.rb +1 -27
  95. data/lib/avalara_sdk/models/A1099/V2/w9_form_base_request.rb +1 -27
  96. data/lib/avalara_sdk/models/A1099/V2/w9_form_base_response.rb +47 -18
  97. data/lib/avalara_sdk/models/A1099/V2/w9_form_minimal_request.rb +1 -27
  98. data/lib/avalara_sdk/models/A1099/V2/w9_form_request.rb +61 -22
  99. data/lib/avalara_sdk/models/A1099/V2/w9_form_response.rb +190 -14
  100. data/lib/avalara_sdk/version.rb +1 -1
  101. data/lib/avalara_sdk.rb +8 -4
  102. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/byebug-11.1.3/gem_make.out +5 -5
  103. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/date-3.4.1/gem_make.out +5 -5
  104. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debase-0.2.9/gem_make.out +5 -5
  105. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debug-1.10.0/gem_make.out +5 -5
  106. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/erb-5.0.1/gem_make.out +5 -5
  107. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/io-console-0.8.0/gem_make.out +5 -5
  108. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/json-2.12.2/gem_make.out +5 -5
  109. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/prism-1.4.0/gem_make.out +5 -5
  110. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/psych-5.2.6/gem_make.out +5 -5
  111. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/racc-1.8.1/gem_make.out +5 -5
  112. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/stringio-3.1.7/gem_make.out +5 -5
  113. metadata +10 -2
data/docs/A1099/V2/W8BenEFormResponse.md CHANGED
@@ -4,6 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | The form type (always \"W8BenE\" for this model). | [optional][readonly] |
7
8
  | **name** | **String** | The name of the individual or entity associated with the form. | [optional] |
8
9
  | **citizenship_country** | **String** | The country of citizenship. | [optional] |
9
10
  | **disregarded_entity** | **String** | The name of the disregarded entity receiving the payment (if applicable). | [optional] |
@@ -21,7 +22,7 @@
21
22
  | **mailing_state** | **String** | The state of the mailing address. | [optional] |
22
23
  | **mailing_zip** | **String** | The ZIP code of the mailing address. | [optional] |
23
24
  | **mailing_country** | **String** | The country of the mailing address. | [optional] |
24
- | **tin_type** | **String** | The type of TIN provided. | [optional] |
25
+ | **tin_type** | **String** | Tax Identification Number (TIN) type. | [optional] |
25
26
  | **tin** | **String** | The taxpayer identification number (TIN). | [optional] |
26
27
  | **giin** | **String** | The global intermediary identification number (GIIN). | [optional] |
27
28
  | **foreign_tin_not_required** | **Boolean** | Indicates whether a foreign TIN is not required. | [optional] |
@@ -100,6 +101,19 @@
100
101
  | **substantial_us_owners** | [**Array<SubstantialUsOwnerResponse>**](SubstantialUsOwnerResponse.md) | The list of substantial U.S. owners of passive NFFE. | [optional] |
101
102
  | **signer_name** | **String** | The name of the signer. | [optional] |
102
103
  | **capacity_to_sign_certification** | **Boolean** | Certifies signer has the capacity to sign for the beneficial owner. | [optional] |
104
+ | **id** | **String** | The unique identifier for the form. | [optional] |
105
+ | **entry_status** | [**EntryStatusResponse**](EntryStatusResponse.md) | The entry status information for the form. | [optional] |
106
+ | **reference_id** | **String** | A reference identifier for the form. | [optional] |
107
+ | **company_id** | **String** | The ID of the associated company. | [optional] |
108
+ | **display_name** | **String** | The display name associated with the form. | [optional] |
109
+ | **email** | **String** | The email address of the individual associated with the form. | [optional] |
110
+ | **archived** | **Boolean** | Indicates whether the form is archived. | [optional] |
111
+ | **ancestor_id** | **String** | Form ID of previous version. | [optional] |
112
+ | **signature** | **String** | The signature of the form. | [optional] |
113
+ | **signed_date** | **Time** | The date the form was signed. | [optional] |
114
+ | **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] |
115
+ | **created_at** | **Time** | The creation date of the form. | [optional] |
116
+ | **updated_at** | **Time** | The last updated date of the form. | [optional] |
103
117
 
104
118
  ## Example
105
119
 
@@ -107,29 +121,30 @@
107
121
  require 'avalara_sdk'
108
122
 
109
123
  instance = AvalaraSdk::A1099::V2::W8BenEFormResponse.new(
110
- name: Global Enterprises LLC,
111
- citizenship_country: USA,
112
- disregarded_entity: Subsidiary LLC,
113
- entity_type: Corporation,
114
- making_treaty_claim: false,
115
- fatca_status: Active,
116
- residence_address: 123 International Blvd,
117
- residence_city: Metropolis,
118
- residence_state: NY,
119
- residence_zip: 10118,
120
- residence_country: USA,
121
- residence_is_mailing: false,
122
- mailing_address: P.O. Box 123,
123
- mailing_city: Metropolis,
124
- mailing_state: NY,
125
- mailing_zip: 10119,
126
- mailing_country: USA,
127
- tin_type: ,
128
- tin: 123-45-6789,
129
- giin: GIIN12345678,
130
- foreign_tin_not_required: true,
124
+ type: null,
125
+ name: null,
126
+ citizenship_country: null,
127
+ disregarded_entity: null,
128
+ entity_type: null,
129
+ making_treaty_claim: null,
130
+ fatca_status: null,
131
+ residence_address: null,
132
+ residence_city: null,
133
+ residence_state: null,
134
+ residence_zip: null,
135
+ residence_country: null,
136
+ residence_is_mailing: null,
137
+ mailing_address: null,
138
+ mailing_city: null,
139
+ mailing_state: null,
140
+ mailing_zip: null,
141
+ mailing_country: null,
142
+ tin_type: null,
143
+ tin: null,
144
+ giin: null,
145
+ foreign_tin_not_required: null,
131
146
  foreign_tin: null,
132
- reference_number: W8BENE12345,
147
+ reference_number: null,
133
148
  disregarded_entity_fatca_status: null,
134
149
  disregarded_address: null,
135
150
  disregarded_city: null,
@@ -137,72 +152,85 @@ instance = AvalaraSdk::A1099::V2::W8BenEFormResponse.new(
137
152
  disregarded_zip: null,
138
153
  disregarded_country: null,
139
154
  disregarded_entity_giin: null,
140
- treaty_country_certification: false,
155
+ treaty_country_certification: null,
141
156
  treaty_country: null,
142
- benefit_limitation_certification: false,
157
+ benefit_limitation_certification: null,
143
158
  benefit_limitation: null,
144
- qualified_resident_status_certification: false,
159
+ qualified_resident_status_certification: null,
145
160
  treaty_article: null,
146
161
  withholding_rate: null,
147
162
  income_type: null,
148
163
  treaty_reasons: null,
149
164
  ffi_sponsoring_entity: null,
150
- investment_entity_certification: false,
151
- controlled_foreign_corporation_certification: false,
152
- compliant_nonregistering_local_bank_certification: false,
153
- compliant_ffi_low_value_accounts_certification: false,
165
+ investment_entity_certification: null,
166
+ controlled_foreign_corporation_certification: null,
167
+ compliant_nonregistering_local_bank_certification: null,
168
+ compliant_ffi_low_value_accounts_certification: null,
154
169
  sponsored_closely_held_entity_sponsoring_entity: null,
155
- sponsored_closely_held_investment_vehicle_certification: false,
156
- compliant_limited_life_debt_entity_certification: false,
157
- investment_entity_no_financial_accounts_certification: false,
158
- owner_documented_ffi_certification: false,
159
- owner_documented_ffi_reporting_statement_certification: false,
160
- owner_documented_ffi_auditor_letter_certification: false,
161
- owner_documented_ffi_trust_beneficiaries_certification: false,
162
- restricted_distributor_certification: false,
163
- restricted_distributor_agreement_certification: false,
164
- restricted_distributor_preexisting_sales_compliance_certification: false,
165
- nonreporting_iga_ffi_certification: false,
170
+ sponsored_closely_held_investment_vehicle_certification: null,
171
+ compliant_limited_life_debt_entity_certification: null,
172
+ investment_entity_no_financial_accounts_certification: null,
173
+ owner_documented_ffi_certification: null,
174
+ owner_documented_ffi_reporting_statement_certification: null,
175
+ owner_documented_ffi_auditor_letter_certification: null,
176
+ owner_documented_ffi_trust_beneficiaries_certification: null,
177
+ restricted_distributor_certification: null,
178
+ restricted_distributor_agreement_certification: null,
179
+ restricted_distributor_preexisting_sales_compliance_certification: null,
180
+ nonreporting_iga_ffi_certification: null,
166
181
  iga_country: null,
167
182
  iga_model: null,
168
183
  iga_legal_status_treatment: null,
169
184
  iga_ffi_trustee_or_sponsor: null,
170
185
  iga_ffi_trustee_is_foreign: null,
171
- non_commercial_financial_activity_certification: false,
172
- internation_organization_certification: false,
173
- intergovernmental_organization_certification: false,
174
- treaty_qualified_pension_fund_certification: false,
175
- qualified_retirement_fund_certification: false,
176
- narrow_participation_retirement_fund_certification: false,
177
- section401_a_equivalent_pension_plan_certification: false,
178
- investment_entity_for_retirement_funds_certification: false,
179
- exempt_beneficial_owner_sponsored_retirement_fund_certification: false,
180
- exempt_beneficial_owner_owned_investment_entity_certification: false,
181
- territory_financial_institution_certification: false,
182
- excepted_nonfinancial_group_entity_certification: false,
183
- excepted_nonfinancial_start_up_certification: false,
186
+ non_commercial_financial_activity_certification: null,
187
+ internation_organization_certification: null,
188
+ intergovernmental_organization_certification: null,
189
+ treaty_qualified_pension_fund_certification: null,
190
+ qualified_retirement_fund_certification: null,
191
+ narrow_participation_retirement_fund_certification: null,
192
+ section401_a_equivalent_pension_plan_certification: null,
193
+ investment_entity_for_retirement_funds_certification: null,
194
+ exempt_beneficial_owner_sponsored_retirement_fund_certification: null,
195
+ exempt_beneficial_owner_owned_investment_entity_certification: null,
196
+ territory_financial_institution_certification: null,
197
+ excepted_nonfinancial_group_entity_certification: null,
198
+ excepted_nonfinancial_start_up_certification: null,
184
199
  startup_formation_or_resolution_date: null,
185
- excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification: false,
200
+ excepted_nonfinancial_entity_in_liquidation_or_bankruptcy_certification: null,
186
201
  nonfinancial_entity_filing_date: null,
187
- section501_c_organization_certification: false,
202
+ section501_c_organization_certification: null,
188
203
  determination_letter_date: null,
189
- nonprofit_organization_certification: false,
190
- publicly_traded_nffe_certification: false,
204
+ nonprofit_organization_certification: null,
205
+ publicly_traded_nffe_certification: null,
191
206
  publicly_traded_nffe_securities_market: null,
192
- nffe_affiliate_of_publicly_traded_entity_certification: false,
207
+ nffe_affiliate_of_publicly_traded_entity_certification: null,
193
208
  publicly_traded_entity: null,
194
209
  nffe_affiliate_of_publicly_traded_entity_securities_market: null,
195
- excepted_territory_nffe_certification: false,
196
- active_nffe_certification: false,
197
- passive_nffe_certification: false,
198
- passive_nffe_no_substantial_us_owners_certification: false,
199
- passive_nffe_substantial_us_owners_provided_certification: false,
200
- excepted_inter_affiliate_ffi_certification: false,
201
- sponsored_direct_reporting_nffe_certification: false,
210
+ excepted_territory_nffe_certification: null,
211
+ active_nffe_certification: null,
212
+ passive_nffe_certification: null,
213
+ passive_nffe_no_substantial_us_owners_certification: null,
214
+ passive_nffe_substantial_us_owners_provided_certification: null,
215
+ excepted_inter_affiliate_ffi_certification: null,
216
+ sponsored_direct_reporting_nffe_certification: null,
202
217
  direct_reporting_nffe_sponsoring_entity: null,
203
- substantial_us_owners: [],
218
+ substantial_us_owners: null,
204
219
  signer_name: null,
205
- capacity_to_sign_certification: false
220
+ capacity_to_sign_certification: null,
221
+ id: null,
222
+ entry_status: null,
223
+ reference_id: null,
224
+ company_id: null,
225
+ display_name: null,
226
+ email: null,
227
+ archived: null,
228
+ ancestor_id: null,
229
+ signature: null,
230
+ signed_date: null,
231
+ e_delivery_consented_at: null,
232
+ created_at: null,
233
+ updated_at: null
206
234
  )
207
235
  ```
208
236
 
data/docs/A1099/V2/W8BenFormMinimalRequest.md CHANGED
@@ -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::W8BenFormMinimalRequest.new(
20
- type: W4,
20
+ type: null,
21
21
  email: null,
22
22
  name: null,
23
23
  reference_number: null,
data/docs/A1099/V2/W8BenFormRequest.md CHANGED
@@ -5,19 +5,19 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | The form type (always \"w8ben\" for this model). | [optional][readonly] |
8
- | **name** | **String** | The name of the individual or entity associated with the form. | [optional] |
9
- | **citizenship_country** | **String** | The country of citizenship. | [optional] |
8
+ | **name** | **String** | The name of the individual or entity associated with the form. | |
9
+ | **citizenship_country** | **String** | The country of citizenship. | |
10
10
  | **residence_address** | **String** | The residential address of the individual or entity. | [optional] |
11
11
  | **residence_city** | **String** | The city of residence. | [optional] |
12
12
  | **residence_state** | **String** | The state of residence. | [optional] |
13
13
  | **residence_zip** | **String** | The ZIP code of the residence. | [optional] |
14
- | **residence_country** | **String** | The country of residence. | [optional] |
14
+ | **residence_country** | **String** | The country of residence. | |
15
15
  | **residence_is_mailing** | **Boolean** | Indicates whether the residence address is the mailing address. | [optional] |
16
16
  | **mailing_address** | **String** | The mailing address. | [optional] |
17
17
  | **mailing_city** | **String** | The city of the mailing address. | [optional] |
18
18
  | **mailing_state** | **String** | The state of the mailing address. | [optional] |
19
19
  | **mailing_zip** | **String** | The ZIP code of the mailing address. | [optional] |
20
- | **mailing_country** | **String** | The country of the mailing address. | [optional] |
20
+ | **mailing_country** | **String** | The country of the mailing address. | |
21
21
  | **tin** | **String** | The taxpayer identification number (TIN). | [optional] |
22
22
  | **foreign_tin_not_required** | **Boolean** | Indicates whether a foreign TIN is not legally required. | [optional] |
23
23
  | **foreign_tin** | **String** | The foreign taxpayer identification number (TIN). | [optional] |
@@ -31,7 +31,7 @@
31
31
  | **signer_name** | **String** | The name of the signer of the form. | [optional] |
32
32
  | **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] |
33
33
  | **signature** | **String** | The signature of the form. | [optional] |
34
- | **company_id** | **String** | The ID of the associated company. | |
34
+ | **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] |
35
35
  | **reference_id** | **String** | A reference identifier for the form. | [optional] |
36
36
  | **email** | **String** | The email address of the individual associated with the form. | [optional] |
37
37
 
@@ -41,7 +41,7 @@
41
41
  require 'avalara_sdk'
42
42
 
43
43
  instance = AvalaraSdk::A1099::V2::W8BenFormRequest.new(
44
- type: W4,
44
+ type: null,
45
45
  name: null,
46
46
  citizenship_country: null,
47
47
  residence_address: null,
data/docs/A1099/V2/W8BenFormResponse.md CHANGED
@@ -4,6 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | The form type (always \"W8Ben\" for this model). | [optional][readonly] |
7
8
  | **name** | **String** | The name of the individual or entity associated with the form. | [optional] |
8
9
  | **citizenship_country** | **String** | The country of citizenship. | [optional] |
9
10
  | **residence_address** | **String** | The residential address of the individual or entity. | [optional] |
@@ -17,7 +18,7 @@
17
18
  | **mailing_state** | **String** | The state of the mailing address. | [optional] |
18
19
  | **mailing_zip** | **String** | The ZIP code of the mailing address. | [optional] |
19
20
  | **mailing_country** | **String** | The country of the mailing address. | [optional] |
20
- | **tin_type** | **String** | The type of TIN provided. | [optional] |
21
+ | **tin_type** | **String** | Tax Identification Number (TIN) type. | [optional] |
21
22
  | **tin** | **String** | The taxpayer identification number (TIN). | [optional] |
22
23
  | **foreign_tin_not_required** | **Boolean** | Indicates whether a foreign TIN is not required. | [optional] |
23
24
  | **foreign_tin** | **String** | The foreign taxpayer identification number (TIN). | [optional] |
@@ -30,6 +31,19 @@
30
31
  | **income_type** | **String** | The type of income covered by the treaty. | [optional] |
31
32
  | **signer_name** | **String** | The name of the signer of the form. | [optional] |
32
33
  | **signer_capacity** | **String** | The capacity in which the signer is signing the form. | [optional] |
34
+ | **id** | **String** | The unique identifier for the form. | [optional] |
35
+ | **entry_status** | [**EntryStatusResponse**](EntryStatusResponse.md) | The entry status information for the form. | [optional] |
36
+ | **reference_id** | **String** | A reference identifier for the form. | [optional] |
37
+ | **company_id** | **String** | The ID of the associated company. | [optional] |
38
+ | **display_name** | **String** | The display name associated with the form. | [optional] |
39
+ | **email** | **String** | The email address of the individual associated with the form. | [optional] |
40
+ | **archived** | **Boolean** | Indicates whether the form is archived. | [optional] |
41
+ | **ancestor_id** | **String** | Form ID of previous version. | [optional] |
42
+ | **signature** | **String** | The signature of the form. | [optional] |
43
+ | **signed_date** | **Time** | The date the form was signed. | [optional] |
44
+ | **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] |
45
+ | **created_at** | **Time** | The creation date of the form. | [optional] |
46
+ | **updated_at** | **Time** | The last updated date of the form. | [optional] |
33
47
 
34
48
  ## Example
35
49
 
@@ -37,32 +51,46 @@
37
51
  require 'avalara_sdk'
38
52
 
39
53
  instance = AvalaraSdk::A1099::V2::W8BenFormResponse.new(
40
- name: International Trading Co.,
41
- citizenship_country: US,
42
- residence_address: 789 Global St,
43
- residence_city: Capital City,
44
- residence_state: DC,
45
- residence_zip: 20001,
46
- residence_country: US,
47
- residence_is_mailing: false,
48
- mailing_address: P.O. Box 456,
49
- mailing_city: Capital City,
50
- mailing_state: DC,
51
- mailing_zip: 20002,
52
- mailing_country: USA,
53
- tin_type: SSN,
54
- tin: 123-45-6789,
55
- foreign_tin_not_required: false,
56
- foreign_tin: FTIN56789,
57
- reference_number: W8BEN12345,
58
- birthday: Mon Oct 01 17:00:00 PDT 1990,
59
- treaty_country: CA,
60
- treaty_article: Article 12,
61
- treaty_reasons: Reduced withholding,
62
- withholding_rate: 15%,
63
- income_type: Dividend,
64
- signer_name: Alice Johnson,
65
- signer_capacity: Authorized Representative
54
+ type: null,
55
+ name: null,
56
+ citizenship_country: null,
57
+ residence_address: null,
58
+ residence_city: null,
59
+ residence_state: null,
60
+ residence_zip: null,
61
+ residence_country: null,
62
+ residence_is_mailing: null,
63
+ mailing_address: null,
64
+ mailing_city: null,
65
+ mailing_state: null,
66
+ mailing_zip: null,
67
+ mailing_country: null,
68
+ tin_type: null,
69
+ tin: null,
70
+ foreign_tin_not_required: null,
71
+ foreign_tin: null,
72
+ reference_number: null,
73
+ birthday: null,
74
+ treaty_country: null,
75
+ treaty_article: null,
76
+ treaty_reasons: null,
77
+ withholding_rate: null,
78
+ income_type: null,
79
+ signer_name: null,
80
+ signer_capacity: null,
81
+ id: null,
82
+ entry_status: null,
83
+ reference_id: null,
84
+ company_id: null,
85
+ display_name: null,
86
+ email: null,
87
+ archived: null,
88
+ ancestor_id: null,
89
+ signature: null,
90
+ signed_date: null,
91
+ e_delivery_consented_at: null,
92
+ created_at: null,
93
+ updated_at: null
66
94
  )
67
95
  ```
68
96
 
data/docs/A1099/V2/W8ImyFormMinimalRequest.md CHANGED
@@ -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::W8ImyFormMinimalRequest.new(
20
- type: W4,
20
+ type: null,
21
21
  email: null,
22
22
  name: null,
23
23
  reference_number: null,
data/docs/A1099/V2/W8ImyFormRequest.md CHANGED
@@ -5,28 +5,28 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | The form type (always \"w8imy\" 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] |
12
- | **fatca_status** | **String** | The FATCA status. | [optional] |
11
+ | **entity_type** | **String** | Represents the entity type for W-8IMY tax forms. W-8IMY forms only accept entity types 1-9, which is a subset of the full EntityType enum. | |
12
+ | **fatca_status** | **String** | Represents the FATCA status types specifically for W8-IMY forms. This is a subset of the full FatcaStatus enum, restricted to values 1-26 for W8-IMY forms. | [optional] |
13
13
  | **residence_address** | **String** | The residential address of the individual or entity. | [optional] |
14
14
  | **residence_city** | **String** | The city of residence. | [optional] |
15
15
  | **residence_state** | **String** | The state of residence. | [optional] |
16
16
  | **residence_zip** | **String** | The ZIP code of the residence. | [optional] |
17
- | **residence_country** | **String** | The country of residence. | [optional] |
17
+ | **residence_country** | **String** | The country of residence. | |
18
18
  | **residence_is_mailing** | **Boolean** | Indicates whether the residence address is also the mailing address. | [optional] |
19
19
  | **mailing_address** | **String** | The mailing address. | [optional] |
20
20
  | **mailing_city** | **String** | The city of the mailing address. | [optional] |
21
21
  | **mailing_state** | **String** | The state of the mailing address. | [optional] |
22
22
  | **mailing_zip** | **String** | The ZIP code of the mailing address. | [optional] |
23
23
  | **mailing_country** | **String** | The country of the mailing address. | [optional] |
24
- | **tin_type** | **String** | The type of TIN provided. | [optional] |
24
+ | **tin_type** | **String** | Tax Identification Number (TIN) type. Available values: - QI-EIN: Qualified Intermediary EIN - WP-EIN: Withholding Partnership EIN - WT-EIN: Withholding Trust EIN - EIN: Employer Identification Number | [optional] |
25
25
  | **tin** | **String** | The taxpayer identification number (TIN). | [optional] |
26
26
  | **giin** | **String** | The global intermediary identification number (GIIN). | [optional] |
27
27
  | **foreign_tin** | **String** | The foreign taxpayer identification number (TIN). | [optional] |
28
28
  | **reference_number** | **String** | A reference number for the form. | [optional] |
29
- | **disregarded_entity_fatca_status** | **String** | The FATCA status of disregarded entity or branch receiving payment. | [optional] |
29
+ | **disregarded_entity_fatca_status** | **String** | The FATCA status of disregarded entity or branch receiving payment. Available values: - 1: Branch treated as nonparticipating FFI. - 2: Participating FFI. - 3: Reporting Model 1 FFI. - 4: Reporting Model 2 FFI. - 5: U.S. Branch | [optional] |
30
30
  | **disregarded_address** | **String** | The address for disregarded entities. | [optional] |
31
31
  | **disregarded_city** | **String** | The city for disregarded entities. | [optional] |
32
32
  | **disregarded_state** | **String** | The state for disregarded entities. | [optional] |
@@ -90,7 +90,7 @@
90
90
  | **foreign_central_bank_of_issue_certification** | **Boolean** | Certifies that the entity is treated as the beneficial owner of the payment solely for purposes of chapter 4 under Regulations section 1.1471-6(d)(4). | [optional] |
91
91
  | **nonreporting_iga_ffi_certification** | **Boolean** | Certifies that the entity meets the requirements to be considered a nonreporting financial institution to an applicable IGA. | [optional] |
92
92
  | **iga_country** | **String** | The country for the applicable IGA with the United States. | [optional] |
93
- | **iga_model** | **String** | The applicable IGA model. | [optional] |
93
+ | **iga_model** | **String** | The applicable IGA model. Available values: - 1: Model 1 IGA - 2: Model 2 IGA | [optional] |
94
94
  | **iga_legal_status_treatment** | **String** | Specifies how the applicable IGA is treated under the IGA provisions or Treasury regulations. | [optional] |
95
95
  | **iga_ffi_trustee_or_sponsor** | **String** | The trustee or sponsor name for the nonreporting IGA FFI. | [optional] |
96
96
  | **iga_ffi_trustee_is_foreign** | **Boolean** | Indicates whether the trustee for the nonreporting IGA FFI is foreign. | [optional] |
@@ -118,7 +118,7 @@
118
118
  | **signer_name** | **String** | The name of the signer. | [optional] |
119
119
  | **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] |
120
120
  | **signature** | **String** | The signature of the form. | [optional] |
121
- | **company_id** | **String** | The ID of the associated company. | |
121
+ | **company_id** | **String** | The ID of the associated company. Required when creating a form. | [optional] |
122
122
  | **reference_id** | **String** | A reference identifier for the form. | [optional] |
123
123
  | **email** | **String** | The email address of the individual associated with the form. | [optional] |
124
124
 
@@ -128,7 +128,7 @@
128
128
  require 'avalara_sdk'
129
129
 
130
130
  instance = AvalaraSdk::A1099::V2::W8ImyFormRequest.new(
131
- type: W4,
131
+ type: null,
132
132
  name: null,
133
133
  citizenship_country: null,
134
134
  disregarded_entity: null,