avalara_sdk 25.10.0 → 25.11.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.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +1 -0
- data/docs/A1099/V2/CompaniesW9Api.md +5 -5
- data/docs/A1099/V2/Form1099Misc.md +1 -1
- data/docs/A1099/V2/Form1099Nec.md +2 -0
- data/docs/A1099/V2/Forms1099Api.md +7 -7
- data/docs/A1099/V2/FormsW9Api.md +92 -8
- data/docs/A1099/V2/Issuers1099Api.md +6 -6
- data/docs/A1099/V2/JobsApi.md +1 -1
- data/docs/A1099/V2/StateEfileStatusDetail.md +3 -1
- data/docs/A1099/V2/W8BenEFormRequest.md +4 -4
- data/docs/A1099/V2/W8BenFormRequest.md +7 -7
- data/lib/avalara_sdk/api/A1099/V2/companies_w9_api.rb +1 -1
- data/lib/avalara_sdk/api/A1099/V2/forms1099_api.rb +1 -1
- data/lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb +138 -1
- data/lib/avalara_sdk/api/A1099/V2/issuers1099_api.rb +1 -1
- data/lib/avalara_sdk/api/A1099/V2/jobs_api.rb +1 -1
- data/lib/avalara_sdk/api/EInvoicing/V1/data_input_fields_api.rb +1 -1
- data/lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb +1 -1
- data/lib/avalara_sdk/api/EInvoicing/V1/interop_api.rb +1 -1
- data/lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb +1 -1
- data/lib/avalara_sdk/api/EInvoicing/V1/subscriptions_api.rb +1 -1
- data/lib/avalara_sdk/api/EInvoicing/V1/tax_identifiers_api.rb +1 -1
- data/lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/form1099_misc.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/form1099_nec.rb +12 -1
- data/lib/avalara_sdk/models/A1099/V2/state_efile_status_detail.rb +15 -5
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_request.rb +100 -4
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_request.rb +91 -7
- data/lib/avalara_sdk/version.rb +1 -1
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/byebug-11.1.3/byebug/byebug.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/byebug-11.1.3/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/date-3.4.1/date_core.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/date-3.4.1/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/date-3.4.1/mkmf.log +4 -4
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debase-0.2.9/attach.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debase-0.2.9/debase_internals.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debase-0.2.9/gem_make.out +7 -7
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debase-0.2.9/mkmf.log +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debug-1.10.0/debug/debug.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debug-1.10.0/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/erb-5.0.1/erb/escape.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/erb-5.0.1/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/io-console-0.8.0/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/io-console-0.8.0/io/console.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/io-console-0.8.0/mkmf.log +21 -21
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/json-2.12.2/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/json-2.12.2/json/ext/generator.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/json-2.12.2/json/ext/parser.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/json-2.12.2/mkmf.log +7 -7
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/prism-1.4.0/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/prism-1.4.0/mkmf.log +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/prism-1.4.0/prism/prism.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/psych-5.2.6/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/psych-5.2.6/mkmf.log +10 -10
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/psych-5.2.6/psych.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/racc-1.8.1/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/racc-1.8.1/racc/cparse.so +0 -0
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/ruby-debug-ide-0.7.3/gem_make.out +2 -2
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/stringio-3.1.7/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/stringio-3.1.7/mkmf.log +2 -2
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/stringio-3.1.7/stringio.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/byebug-11.1.3/ext/byebug/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/byebug-11.1.3/lib/byebug/byebug.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/date-3.4.1/ext/date/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/date-3.4.1/lib/date_core.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/debase-0.2.9/ext/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/debase-0.2.9/ext/attach/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/debase-0.2.9/lib/attach.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/debase-0.2.9/lib/debase_internals.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/debug-1.10.0/ext/debug/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/debug-1.10.0/lib/debug/debug.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/erb-5.0.1/ext/erb/escape/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/erb-5.0.1/lib/erb/escape.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/io-console-0.8.0/ext/io/console/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/io-console-0.8.0/lib/io/console.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/json-2.12.2/ext/json/ext/generator/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/json-2.12.2/ext/json/ext/parser/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/json-2.12.2/lib/json/ext/generator.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/json-2.12.2/lib/json/ext/parser.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/prism-1.4.0/ext/prism/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/prism-1.4.0/lib/prism/prism.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/psych-5.2.6/ext/psych/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/psych-5.2.6/lib/psych.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/racc-1.8.1/ext/racc/cparse/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/racc-1.8.1/lib/racc/cparse.so +0 -0
- data/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.7/ext/stringio/Makefile +3 -3
- data/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.7/lib/stringio.so +0 -0
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8f30656fb5c1d2ef267c92750fa5241b1c654f29131dfcfec6c099c4695320df
|
|
4
|
+
data.tar.gz: 66a3d8ab16e8ba1959ea31e20165c509b215c583f2faea5fe9afa49834c7e445
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c10102d5ee54a7f18b75ca8b9575bbe7515a3640865114818dbfcac55b7eddef498bade302fc2815a8e1943aabe8735b622e4f19547b0519fb849f99767bcf67
|
|
7
|
+
data.tar.gz: 9df91422ea19ff0f4f06d3ebdb6289ac06d5a0927fde6135ab5490f9b91e2453c9ca626f245ed3a73269ac36cb0848f9a2b64a9d2d6014779a5c3acea1125afc
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -94,6 +94,7 @@ Class | Method | HTTP request | Description
|
|
|
94
94
|
*FormsW9Api* | [**create_w9_form**](docs/A1099/V2/FormsW9Api.md#create_w9_form) | **POST** /w9/forms | Create a W9/W4/W8 form
|
|
95
95
|
*FormsW9Api* | [**delete_w9_form**](docs/A1099/V2/FormsW9Api.md#delete_w9_form) | **DELETE** /w9/forms/{id} | Delete a W9/W4/W8 form
|
|
96
96
|
*FormsW9Api* | [**get_w9_form**](docs/A1099/V2/FormsW9Api.md#get_w9_form) | **GET** /w9/forms/{id} | Retrieve a W9/W4/W8 form
|
|
97
|
+
*FormsW9Api* | [**get_w9_form_pdf**](docs/A1099/V2/FormsW9Api.md#get_w9_form_pdf) | **GET** /w9/forms/{id}/pdf | Download the PDF for a W9/W4/W8 form.
|
|
97
98
|
*FormsW9Api* | [**list_w9_forms**](docs/A1099/V2/FormsW9Api.md#list_w9_forms) | **GET** /w9/forms | List W9/W4/W8 forms
|
|
98
99
|
*FormsW9Api* | [**send_w9_form_email**](docs/A1099/V2/FormsW9Api.md#send_w9_form_email) | **POST** /w9/forms/{id}/$send-email | Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form
|
|
99
100
|
*FormsW9Api* | [**update_w9_form**](docs/A1099/V2/FormsW9Api.md#update_w9_form) | **PUT** /w9/forms/{id} | Update a W9/W4/W8 form
|
|
@@ -39,7 +39,7 @@ api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client
|
|
|
39
39
|
|
|
40
40
|
avalara_version = '2.0.0' # String | API version
|
|
41
41
|
opts = {
|
|
42
|
-
x_correlation_id: '
|
|
42
|
+
x_correlation_id: 'bedc4273-bb12-48c6-88a8-c0aee6e7b954', # 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
44
|
company_request: AvalaraSdk::A1099::V2::CompanyRequest.new({name: 'name_example', email: 'email_example', address: 'address_example', city: 'city_example', zip: 'zip_example', telephone: 'telephone_example', tin: 'tin_example', country_code: 'country_code_example'}) # CompanyRequest | The company to create
|
|
45
45
|
}
|
|
@@ -123,7 +123,7 @@ api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client
|
|
|
123
123
|
id = 'id_example' # String | The company to delete
|
|
124
124
|
avalara_version = '2.0.0' # String | API version
|
|
125
125
|
opts = {
|
|
126
|
-
x_correlation_id: '
|
|
126
|
+
x_correlation_id: '9ed3d9c2-5c65-47f5-accf-cc911576c7cb', # 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
|
|
|
@@ -210,7 +210,7 @@ opts = {
|
|
|
210
210
|
order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.
|
|
211
211
|
count: true, # Boolean | If true, return the global count of elements in the collection.
|
|
212
212
|
count_only: true, # Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true.
|
|
213
|
-
x_correlation_id: '
|
|
213
|
+
x_correlation_id: '50aba33f-6235-4915-aa65-80129e69c929', # 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
|
|
|
@@ -298,7 +298,7 @@ api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client
|
|
|
298
298
|
id = 'id_example' # String | Id of the company
|
|
299
299
|
avalara_version = '2.0.0' # String | API version
|
|
300
300
|
opts = {
|
|
301
|
-
x_correlation_id: '
|
|
301
|
+
x_correlation_id: '5cb4aaf8-d220-4a6d-bc06-4c664b4b5d51', # String | Unique correlation Id in a GUID format
|
|
302
302
|
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/) .
|
|
303
303
|
}
|
|
304
304
|
|
|
@@ -381,7 +381,7 @@ api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client
|
|
|
381
381
|
id = 'id_example' # String | The ID of the company to update
|
|
382
382
|
avalara_version = '2.0.0' # String | API version
|
|
383
383
|
opts = {
|
|
384
|
-
x_correlation_id: '
|
|
384
|
+
x_correlation_id: '53bb7b71-2c2d-4faf-a86b-5bcb3642ce67', # 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
386
|
company_request: AvalaraSdk::A1099::V2::CompanyRequest.new({name: 'name_example', email: 'email_example', address: 'address_example', city: 'city_example', zip: 'zip_example', telephone: 'telephone_example', tin: 'tin_example', country_code: 'country_code_example'}) # CompanyRequest | The updated company data
|
|
387
387
|
}
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
| **gross_proceeds_paid_to_attorney** | **Float** | Gross proceeds paid to an attorney | [optional] |
|
|
17
17
|
| **fish_purchased_for_resale** | **Float** | Fish purchased for resale | [optional] |
|
|
18
18
|
| **section409_a_deferrals** | **Float** | Section 409A deferrals | [optional] |
|
|
19
|
-
| **excess_golden_parachute_payments** | **Float** |
|
|
19
|
+
| **excess_golden_parachute_payments** | **Float** | Excess golden parachute payments - Available only for tax year 2024 and earlier | [optional] |
|
|
20
20
|
| **nonqualified_deferred_compensation** | **Float** | Nonqualified deferred compensation | [optional] |
|
|
21
21
|
| **fatca_filing_requirement** | **Boolean** | FATCA filing requirement. | [optional] |
|
|
22
22
|
| **type** | **String** | Form type. | |
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **nonemployee_compensation** | **Float** | Nonemployee compensation. Required if DirectSalesIndicator is false. | |
|
|
8
8
|
| **direct_sales_indicator** | **Boolean** | Payer made direct sales totaling $5,000 or more of consumer products to recipient for resale. Should be true if Nonemployee compensation is not provided. | [optional] |
|
|
9
|
+
| **excess_golden_parachute_payments** | **Float** | Excess golden parachute payments - Available only for tax year 2025 and later | [optional] |
|
|
9
10
|
| **federal_income_tax_withheld** | **Float** | Federal income tax withheld. | [optional] |
|
|
10
11
|
| **type** | **String** | Form type. | |
|
|
11
12
|
| **id** | **String** | Form ID. Unique identifier set when the record is created. | [optional][readonly] |
|
|
@@ -55,6 +56,7 @@ require 'avalara_sdk'
|
|
|
55
56
|
instance = AvalaraSdk::A1099::V2::Form1099Nec.new(
|
|
56
57
|
nonemployee_compensation: null,
|
|
57
58
|
direct_sales_indicator: null,
|
|
59
|
+
excess_golden_parachute_payments: null,
|
|
58
60
|
federal_income_tax_withheld: null,
|
|
59
61
|
type: null,
|
|
60
62
|
id: null,
|
|
@@ -42,7 +42,7 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client
|
|
|
42
42
|
avalara_version = '2.0.0' # String | API version
|
|
43
43
|
opts = {
|
|
44
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: '
|
|
45
|
+
x_correlation_id: '65ba673f-da74-46f5-a26a-2b7da2eae19c', # 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
47
|
form1099_list_request: AvalaraSdk::A1099::V2::Form1099ListRequest.new # Form1099ListRequest |
|
|
48
48
|
}
|
|
@@ -126,7 +126,7 @@ 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: '
|
|
129
|
+
x_correlation_id: '4e987f77-91dd-473a-9583-a7552f724f89', # 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
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
|
}
|
|
@@ -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: '
|
|
213
|
+
x_correlation_id: '2e4a61ed-57e4-4eed-9668-ba57bf364a8a', # 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: '
|
|
295
|
+
x_correlation_id: 'f1d240d0-9019-4e85-87c4-bfa1c90d59e1', # 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: '
|
|
379
|
+
x_correlation_id: 'bc095972-c93b-457e-bc4b-407a3a94891c', # 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
|
|
|
@@ -465,7 +465,7 @@ opts = {
|
|
|
465
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
466
|
count: true, # Boolean | If true, return the global count of elements in the collection.
|
|
467
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: '
|
|
468
|
+
x_correlation_id: '4e7e1488-0963-48c2-abd5-296f37dae5c5', # String | Unique correlation Id in a GUID format
|
|
469
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/) .
|
|
470
470
|
}
|
|
471
471
|
|
|
@@ -553,7 +553,7 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client
|
|
|
553
553
|
id = 'id_example' # String |
|
|
554
554
|
avalara_version = '2.0.0' # String | API version
|
|
555
555
|
opts = {
|
|
556
|
-
x_correlation_id: '
|
|
556
|
+
x_correlation_id: '7abc5695-4063-414a-aa57-7cb2b9fee1dc', # String | Unique correlation Id in a GUID format
|
|
557
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/) .
|
|
558
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 |
|
|
559
559
|
}
|
data/docs/A1099/V2/FormsW9Api.md
CHANGED
|
@@ -8,6 +8,7 @@ All URIs are relative to *https://api.sbx.avalara.com/avalara1099*
|
|
|
8
8
|
| [**create_w9_form**](FormsW9Api.md#create_w9_form) | **POST** /w9/forms | Create a W9/W4/W8 form |
|
|
9
9
|
| [**delete_w9_form**](FormsW9Api.md#delete_w9_form) | **DELETE** /w9/forms/{id} | Delete a W9/W4/W8 form |
|
|
10
10
|
| [**get_w9_form**](FormsW9Api.md#get_w9_form) | **GET** /w9/forms/{id} | Retrieve a W9/W4/W8 form |
|
|
11
|
+
| [**get_w9_form_pdf**](FormsW9Api.md#get_w9_form_pdf) | **GET** /w9/forms/{id}/pdf | Download the PDF for a W9/W4/W8 form. |
|
|
11
12
|
| [**list_w9_forms**](FormsW9Api.md#list_w9_forms) | **GET** /w9/forms | List W9/W4/W8 forms |
|
|
12
13
|
| [**send_w9_form_email**](FormsW9Api.md#send_w9_form_email) | **POST** /w9/forms/{id}/$send-email | Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form |
|
|
13
14
|
| [**update_w9_form**](FormsW9Api.md#update_w9_form) | **PUT** /w9/forms/{id} | Update a W9/W4/W8 form |
|
|
@@ -42,7 +43,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
|
|
|
42
43
|
|
|
43
44
|
avalara_version = '2.0.0' # String | API version
|
|
44
45
|
opts = {
|
|
45
|
-
x_correlation_id: '
|
|
46
|
+
x_correlation_id: 'a31bfcd3-48f4-4459-86e7-2ce87c8eab6b', # String | Unique correlation Id in a GUID format
|
|
46
47
|
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
48
|
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
|
}
|
|
@@ -125,7 +126,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
|
|
|
125
126
|
|
|
126
127
|
avalara_version = '2.0.0' # String | API version
|
|
127
128
|
opts = {
|
|
128
|
-
x_correlation_id: '
|
|
129
|
+
x_correlation_id: '4d4842c6-baeb-4f47-970e-dc9a9da6e8f4', # String | Unique correlation Id in a GUID format
|
|
129
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/) .
|
|
130
131
|
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
132
|
}
|
|
@@ -209,7 +210,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
|
|
|
209
210
|
id = 'id_example' # String | ID of the form to delete
|
|
210
211
|
avalara_version = '2.0.0' # String | API version
|
|
211
212
|
opts = {
|
|
212
|
-
x_correlation_id: '
|
|
213
|
+
x_correlation_id: 'fc19f8c0-4c87-4387-8ab1-aa9d962df4eb', # String | Unique correlation Id in a GUID format
|
|
213
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/) .
|
|
214
215
|
}
|
|
215
216
|
|
|
@@ -291,7 +292,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
|
|
|
291
292
|
id = 'id_example' # String | ID of the form
|
|
292
293
|
avalara_version = '2.0.0' # String | API version
|
|
293
294
|
opts = {
|
|
294
|
-
x_correlation_id: '
|
|
295
|
+
x_correlation_id: 'd24ad701-0869-495f-ad6e-234ea6b363b5', # String | Unique correlation Id in a GUID format
|
|
295
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/) .
|
|
296
297
|
}
|
|
297
298
|
|
|
@@ -345,6 +346,89 @@ end
|
|
|
345
346
|
- **Accept**: application/json
|
|
346
347
|
|
|
347
348
|
|
|
349
|
+
## get_w9_form_pdf
|
|
350
|
+
|
|
351
|
+
> File get_w9_form_pdf(id, avalara_version, opts)
|
|
352
|
+
|
|
353
|
+
Download the PDF for a W9/W4/W8 form.
|
|
354
|
+
|
|
355
|
+
Returns the PDF file for a W9/W4/W8 form.
|
|
356
|
+
|
|
357
|
+
### Examples
|
|
358
|
+
|
|
359
|
+
```ruby
|
|
360
|
+
require 'time'
|
|
361
|
+
require 'avalara_sdk'
|
|
362
|
+
# setup authorization
|
|
363
|
+
AvalaraSdk::A1099::V2.configure do |config|
|
|
364
|
+
# See Documentation for Authorization section in main README.md for more auth examples.
|
|
365
|
+
config.bearer_token='<Your Avalara Identity Access Token>'
|
|
366
|
+
config.environment='sandbox'
|
|
367
|
+
config.app_name='testApp'
|
|
368
|
+
config.app_version='1.2.3'
|
|
369
|
+
config.machine_name='testMachine'
|
|
370
|
+
end
|
|
371
|
+
|
|
372
|
+
api_client = AvalaraSdk::ApiClient.new config
|
|
373
|
+
api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
|
|
374
|
+
|
|
375
|
+
id = 'id_example' # String | Id of the form
|
|
376
|
+
avalara_version = '2.0.0' # String | API version
|
|
377
|
+
opts = {
|
|
378
|
+
x_correlation_id: '51c49fe8-a8d5-4e6c-93b2-271795eaa196', # String | Unique correlation Id in a GUID format
|
|
379
|
+
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/) .
|
|
380
|
+
}
|
|
381
|
+
|
|
382
|
+
begin
|
|
383
|
+
# Download the PDF for a W9/W4/W8 form.
|
|
384
|
+
result = api_instance.get_w9_form_pdf(id, avalara_version, opts)
|
|
385
|
+
p result
|
|
386
|
+
rescue AvalaraSdk::ApiError => e
|
|
387
|
+
puts "Error when calling FormsW9Api->get_w9_form_pdf: #{e}"
|
|
388
|
+
end
|
|
389
|
+
```
|
|
390
|
+
|
|
391
|
+
#### Using the get_w9_form_pdf_with_http_info variant
|
|
392
|
+
|
|
393
|
+
This returns an Array which contains the response data, status code and headers.
|
|
394
|
+
|
|
395
|
+
> <Array(File, Integer, Hash)> get_w9_form_pdf_with_http_info(id, avalara_version, opts)
|
|
396
|
+
|
|
397
|
+
```ruby
|
|
398
|
+
begin
|
|
399
|
+
# Download the PDF for a W9/W4/W8 form.
|
|
400
|
+
data, status_code, headers = api_instance.get_w9_form_pdf_with_http_info(id, avalara_version, opts)
|
|
401
|
+
p status_code # => 2xx
|
|
402
|
+
p headers # => { ... }
|
|
403
|
+
p data # => File
|
|
404
|
+
rescue AvalaraSdk::A1099::V2::ApiError => e
|
|
405
|
+
puts "Error when calling FormsW9Api->get_w9_form_pdf_with_http_info: #{e}"
|
|
406
|
+
end
|
|
407
|
+
```
|
|
408
|
+
|
|
409
|
+
### Parameters
|
|
410
|
+
|
|
411
|
+
| Name | Type | Description | Notes |
|
|
412
|
+
| ---- | ---- | ----------- | ----- |
|
|
413
|
+
| **id** | **String** | Id of the form | |
|
|
414
|
+
| **avalara_version** | **String** | API version | |
|
|
415
|
+
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
|
|
416
|
+
| **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] |
|
|
417
|
+
|
|
418
|
+
### Return type
|
|
419
|
+
|
|
420
|
+
**File**
|
|
421
|
+
|
|
422
|
+
### Authorization
|
|
423
|
+
|
|
424
|
+
[bearer](../../../README.md#documentation-for-authorization)
|
|
425
|
+
|
|
426
|
+
### HTTP request headers
|
|
427
|
+
|
|
428
|
+
- **Content-Type**: Not defined
|
|
429
|
+
- **Accept**: application/pdf, application/json
|
|
430
|
+
|
|
431
|
+
|
|
348
432
|
## list_w9_forms
|
|
349
433
|
|
|
350
434
|
> <PaginatedQueryResultModelW9FormBaseResponse> list_w9_forms(avalara_version, opts)
|
|
@@ -379,7 +463,7 @@ opts = {
|
|
|
379
463
|
order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.
|
|
380
464
|
count: true, # Boolean | If true, return the global count of elements in the collection.
|
|
381
465
|
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: '
|
|
466
|
+
x_correlation_id: '9bfb0cee-b6e0-4c22-a8a2-4be68535c83e', # String | Unique correlation Id in a GUID format
|
|
383
467
|
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
468
|
}
|
|
385
469
|
|
|
@@ -467,7 +551,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
|
|
|
467
551
|
id = 'id_example' # String | The ID of the W9/W4/W8 form.
|
|
468
552
|
avalara_version = '2.0.0' # String | API version
|
|
469
553
|
opts = {
|
|
470
|
-
x_correlation_id: '
|
|
554
|
+
x_correlation_id: 'a615b830-d8f7-4687-afe7-c9987a509eac', # String | Unique correlation Id in a GUID format
|
|
471
555
|
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
556
|
}
|
|
473
557
|
|
|
@@ -550,7 +634,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
|
|
|
550
634
|
id = 'id_example' # String | ID of the form to update
|
|
551
635
|
avalara_version = '2.0.0' # String | API version
|
|
552
636
|
opts = {
|
|
553
|
-
x_correlation_id: '
|
|
637
|
+
x_correlation_id: 'eb20e211-254b-4e5f-a1a5-7e6f596e378b', # String | Unique correlation Id in a GUID format
|
|
554
638
|
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
639
|
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
640
|
}
|
|
@@ -635,7 +719,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
|
|
|
635
719
|
id = 'id_example' # String | Id of the form
|
|
636
720
|
avalara_version = '2.0.0' # String | API version
|
|
637
721
|
opts = {
|
|
638
|
-
x_correlation_id: '
|
|
722
|
+
x_correlation_id: 'a757e3ef-d759-49bd-b130-28ef831f2126', # String | Unique correlation Id in a GUID format
|
|
639
723
|
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
724
|
file: File.new('/path/to/some/file') # File |
|
|
641
725
|
}
|
|
@@ -39,7 +39,7 @@ 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: '
|
|
42
|
+
x_correlation_id: '8783a532-9268-4e0b-a0ff-44de4f71b537', # 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
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
|
}
|
|
@@ -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: '
|
|
126
|
+
x_correlation_id: '5d63e7f2-9ded-4877-b46c-d4a9deaf226d', # 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: '
|
|
208
|
+
x_correlation_id: 'd4b90233-dbcb-43a4-bbf7-d4c5d4e8ea6f', # 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
|
|
|
@@ -287,13 +287,13 @@ api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
|
|
|
287
287
|
|
|
288
288
|
avalara_version = '2.0.0' # String | API version
|
|
289
289
|
opts = {
|
|
290
|
-
filter: 'taxYear eq
|
|
290
|
+
filter: 'taxYear eq 2025', # 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>.
|
|
291
291
|
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.
|
|
292
292
|
skip: 56, # Integer | If nonzero, skip this number of results before returning data. Used with top to provide pagination for large datasets.
|
|
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: '
|
|
296
|
+
x_correlation_id: '67f66334-e4f2-4d38-aca7-47de8ea93dc0', # 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,7 +381,7 @@ 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: '
|
|
384
|
+
x_correlation_id: '88269912-43b9-460b-b285-28c036924f06', # 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
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
|
}
|
data/docs/A1099/V2/JobsApi.md
CHANGED
|
@@ -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: '
|
|
39
|
+
x_correlation_id: '8a4b3b32-d90c-4ab4-915b-e3e2d4f3e213', # 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
|
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
| **status** | **String** | | [optional] |
|
|
8
8
|
| **time** | **String** | | [optional] |
|
|
9
9
|
| **jurisdiction** | **String** | | [optional] |
|
|
10
|
+
| **rejected_reason** | **String** | | [optional] |
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
@@ -16,7 +17,8 @@ require 'avalara_sdk'
|
|
|
16
17
|
instance = AvalaraSdk::A1099::V2::StateEfileStatusDetail.new(
|
|
17
18
|
status: null,
|
|
18
19
|
time: null,
|
|
19
|
-
jurisdiction: null
|
|
20
|
+
jurisdiction: null,
|
|
21
|
+
rejected_reason: null
|
|
20
22
|
)
|
|
21
23
|
```
|
|
22
24
|
|
|
@@ -8,9 +8,9 @@
|
|
|
8
8
|
| **name** | **String** | The name of the individual or entity associated with the form. | |
|
|
9
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** |
|
|
11
|
+
| **entity_type** | **String** | Represents the entity type for tax forms. Each value corresponds to a specific entity classification. - 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** |
|
|
13
|
+
| **fatca_status** | **String** | Represents the FATCA status types for tax forms. Used for W8-BEN-E forms and FATCA compliance validations. Values correspond to numeric identifiers used in forms. - 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] |
|
|
@@ -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. Available values: - 1:
|
|
30
|
+
| **disregarded_entity_fatca_status** | **String** | The FATCA status of disregarded entity or branch receiving payment. Available values: - 1: Branch treated as nonparticipating FFI - 2: U.S. Branch - 3: Participating FFI - 4: Reporting Model 1 FFI - 5: Reporting Model 2 FFI | [optional] |
|
|
31
31
|
| **disregarded_address** | **String** | The address for disregarded entities. | [optional] |
|
|
32
32
|
| **disregarded_city** | **String** | The city for disregarded entities. | [optional] |
|
|
33
33
|
| **disregarded_state** | **String** | The state for disregarded entities. | [optional] |
|
|
@@ -37,7 +37,7 @@
|
|
|
37
37
|
| **treaty_country_certification** | **Boolean** | Certifies the beneficial owner's country under the U.S. tax treaty. | [optional] |
|
|
38
38
|
| **treaty_country** | **String** | The treaty country of the beneficial owner. | [optional] |
|
|
39
39
|
| **benefit_limitation_certification** | **Boolean** | Certifies that the beneficial owner is eligible for treaty benefits and meets any limitation on benefits requirements. | [optional] |
|
|
40
|
-
| **benefit_limitation** | **String** | The benefit limitation for tax treaty claims. 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] |
|
|
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 - 11: No LOB article in treaty | [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] |
|
|
@@ -6,27 +6,27 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **type** | **String** | The form type (always \"w8ben\" for this model). | [optional][readonly] |
|
|
8
8
|
| **name** | **String** | The name of the individual or entity associated with the form. | |
|
|
9
|
-
| **citizenship_country** | **String** | The country of citizenship
|
|
9
|
+
| **citizenship_country** | **String** | The country of citizenship.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) | |
|
|
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
|
-
| **residence_state** | **String** | The state of residence. | [optional] |
|
|
12
|
+
| **residence_state** | **String** | The state of residence. Required for US and Canada.. Allowed values: AA, AE, AK, AL, AP, AR, AS, AZ, CA, CO (and 65 more) | [optional] |
|
|
13
13
|
| **residence_zip** | **String** | The ZIP code of the residence. | [optional] |
|
|
14
|
-
| **residence_country** | **String** | The country of residence
|
|
14
|
+
| **residence_country** | **String** | The country of residence.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) | |
|
|
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
|
-
| **mailing_state** | **String** | The state of the mailing address. | [optional] |
|
|
18
|
+
| **mailing_state** | **String** | The state of the mailing address. Required for US and Canada.. Allowed values: AA, AE, AK, AL, AP, AR, AS, AZ, CA, CO (and 65 more) | [optional] |
|
|
19
19
|
| **mailing_zip** | **String** | The ZIP code of the mailing address. | [optional] |
|
|
20
|
-
| **mailing_country** | **String** | The country of the mailing address
|
|
20
|
+
| **mailing_country** | **String** | The country of the mailing address.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) | |
|
|
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] |
|
|
24
24
|
| **reference_number** | **String** | A reference number for the form. | [optional] |
|
|
25
25
|
| **birthday** | **Date** | The birthday of the individual associated with the form. | [optional] |
|
|
26
|
-
| **treaty_country** | **String** | The country for which the treaty applies
|
|
26
|
+
| **treaty_country** | **String** | The country for which the treaty applies.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) | [optional] |
|
|
27
27
|
| **treaty_article** | **String** | The specific article of the treaty being claimed. | [optional] |
|
|
28
28
|
| **treaty_reasons** | **String** | The reasons for claiming treaty benefits. | [optional] |
|
|
29
|
-
| **withholding_rate** | **String** | The withholding rate applied as per the treaty. | [optional] |
|
|
29
|
+
| **withholding_rate** | **String** | The withholding rate applied as per the treaty. Must be a percentage with up to two decimals (e.g., 12.50, 0).. Allowed values: 0, 0.0, 0.00, 5, 5.5, 10, 12.50, 15, 20, 25 (and 1 more) | [optional] |
|
|
30
30
|
| **income_type** | **String** | The type of income covered by the treaty. | [optional] |
|
|
31
31
|
| **signer_name** | **String** | The name of the signer of the form. | [optional] |
|
|
32
32
|
| **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] |
|