avalara_sdk 25.8.2 → 25.8.3
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 +18 -79
- data/docs/A1099/V2/CompaniesW9Api.md +18 -18
- data/docs/A1099/V2/CompanyCreateUpdateRequestModel.md +18 -18
- data/docs/A1099/V2/CompanyResponse.md +37 -37
- data/docs/A1099/V2/CoveredIndividual.md +56 -0
- data/docs/A1099/V2/CreateAndSendW9FormEmailRequest.md +55 -0
- data/docs/A1099/V2/CreateCompanyRequest.md +49 -0
- data/docs/A1099/V2/CreateIssuerRequest.md +49 -0
- data/docs/A1099/V2/EntryStatusResponse.md +20 -0
- data/docs/A1099/V2/Form1042S.md +83 -83
- data/docs/A1099/V2/Form1095B.md +72 -62
- data/docs/A1099/V2/Form1095C.md +112 -0
- data/docs/A1099/V2/Form1099Base.md +60 -60
- data/docs/A1099/V2/Form1099Div.md +79 -77
- data/docs/A1099/V2/Form1099Int.md +76 -74
- data/docs/A1099/V2/Form1099K.md +83 -83
- data/docs/A1099/V2/Form1099ListRequest.md +20 -0
- data/docs/A1099/V2/Form1099Misc.md +79 -77
- data/docs/A1099/V2/Form1099Nec.md +64 -64
- data/docs/A1099/V2/Form1099R.md +95 -93
- data/docs/A1099/V2/Forms1099Api.md +45 -41
- data/docs/A1099/V2/FormsW9Api.md +98 -14
- data/docs/A1099/V2/Get1099Form200Response.md +19 -19
- data/docs/A1099/V2/IntermediaryOrFlowThrough.md +11 -11
- data/docs/A1099/V2/IssuerCommand.md +16 -16
- data/docs/A1099/V2/IssuerResponse.md +35 -35
- data/docs/A1099/V2/Issuers1099Api.md +10 -10
- data/docs/A1099/V2/JobResponse.md +56 -0
- data/docs/A1099/V2/JobsApi.md +91 -0
- data/docs/A1099/V2/OfferAndCoverage.md +28 -0
- data/docs/A1099/V2/PaginatedQueryResultModelForm1099Base.md +22 -0
- data/docs/A1099/V2/PrimaryWithholdingAgent.md +4 -4
- data/docs/A1099/V2/StateAndLocalWithholding.md +8 -8
- data/docs/A1099/V2/ValidationError.md +2 -2
- data/docs/A1099/V2/W4FormMinimalRequest.md +30 -0
- data/docs/A1099/V2/W4FormRequest.md +6 -6
- data/docs/A1099/V2/W8BenEFormMinimalRequest.md +28 -0
- data/docs/A1099/V2/W8BenEFormRequest.md +6 -6
- data/docs/A1099/V2/W8BenFormMinimalRequest.md +28 -0
- data/docs/A1099/V2/W8BenFormRequest.md +6 -6
- data/docs/A1099/V2/W8ImyFormMinimalRequest.md +28 -0
- data/docs/A1099/V2/W8ImyFormRequest.md +6 -6
- data/docs/A1099/V2/W9FormBaseMinimalRequest.md +24 -0
- data/docs/A1099/V2/W9FormBaseRequest.md +6 -6
- data/docs/A1099/V2/W9FormBaseResponse.md +3 -3
- data/docs/A1099/V2/W9FormMinimalRequest.md +28 -0
- data/docs/A1099/V2/W9FormRequest.md +6 -6
- data/lib/avalara_sdk/api/A1099/V2/companies_w9_api.rb +27 -27
- data/lib/avalara_sdk/api/A1099/V2/forms1099_api.rb +89 -57
- data/lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb +144 -6
- data/lib/avalara_sdk/api/A1099/V2/issuers1099_api.rb +21 -21
- data/lib/avalara_sdk/api/A1099/V2/{jobs1099_api.rb → jobs_api.rb} +9 -9
- 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/company_create_update_request_model.rb +58 -17
- data/lib/avalara_sdk/models/A1099/V2/company_response.rb +110 -69
- data/lib/avalara_sdk/models/A1099/V2/{covered_individual_request.rb → covered_individual.rb} +36 -7
- data/lib/avalara_sdk/models/A1099/V2/{i_create_form1099_request.rb → create_and_send_w9_form_email_request.rb} +6 -5
- data/lib/avalara_sdk/models/A1099/V2/{error_response_errors_inner.rb → create_company_request.rb} +3 -3
- data/lib/avalara_sdk/models/A1099/V2/{i_update_form1099_request.rb → create_issuer_request.rb} +3 -5
- data/lib/avalara_sdk/models/A1099/V2/{status_detail.rb → entry_status_response.rb} +20 -18
- data/lib/avalara_sdk/models/A1099/V2/form1042_s.rb +424 -179
- data/lib/avalara_sdk/models/A1099/V2/form1095_b.rb +365 -179
- data/lib/avalara_sdk/models/A1099/V2/{form1095_b_response.rb → form1095_c.rb} +259 -111
- data/lib/avalara_sdk/models/A1099/V2/form1099_base.rb +286 -177
- data/lib/avalara_sdk/models/A1099/V2/form1099_div.rb +310 -171
- data/lib/avalara_sdk/models/A1099/V2/form1099_int.rb +308 -174
- data/lib/avalara_sdk/models/A1099/V2/form1099_k.rb +298 -186
- data/lib/avalara_sdk/models/A1099/V2/{form1099_div_list.rb → form1099_list_request.rb} +49 -22
- data/lib/avalara_sdk/models/A1099/V2/form1099_misc.rb +337 -201
- data/lib/avalara_sdk/models/A1099/V2/form1099_nec.rb +298 -183
- data/lib/avalara_sdk/models/A1099/V2/form1099_r.rb +414 -274
- data/lib/avalara_sdk/models/A1099/V2/get1099_form200_response.rb +9 -9
- data/lib/avalara_sdk/models/A1099/V2/intermediary_or_flow_through.rb +13 -1
- data/lib/avalara_sdk/models/A1099/V2/issuer_command.rb +42 -23
- data/lib/avalara_sdk/models/A1099/V2/issuer_response.rb +77 -46
- data/lib/avalara_sdk/models/A1099/V2/{job_result.rb → job_response.rb} +108 -42
- data/lib/avalara_sdk/models/A1099/V2/{offer_and_coverage_request.rb → offer_and_coverage.rb} +79 -9
- data/lib/avalara_sdk/models/A1099/V2/{paginated_query_result_model.rb → paginated_query_result_model_form1099_base.rb} +4 -4
- data/lib/avalara_sdk/models/A1099/V2/primary_withholding_agent.rb +23 -16
- data/lib/avalara_sdk/models/A1099/V2/state_and_local_withholding.rb +8 -0
- data/lib/avalara_sdk/models/A1099/V2/validation_error.rb +2 -0
- data/lib/avalara_sdk/models/A1099/V2/w4_form_minimal_request.rb +418 -0
- data/lib/avalara_sdk/models/A1099/V2/w4_form_request.rb +53 -27
- data/lib/avalara_sdk/models/A1099/V2/{company_model.rb → w8_ben_e_form_minimal_request.rb} +139 -170
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_request.rb +53 -27
- data/lib/avalara_sdk/models/A1099/V2/{base_company_model.rb → w8_ben_form_minimal_request.rb} +148 -122
- data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_request.rb +53 -27
- data/lib/avalara_sdk/models/A1099/V2/{attribute.rb → w8_imy_form_minimal_request.rb} +135 -132
- data/lib/avalara_sdk/models/A1099/V2/w8_imy_form_request.rb +53 -27
- data/lib/avalara_sdk/models/A1099/V2/{http_validation_problem_details.rb → w9_form_base_minimal_request.rb} +87 -53
- data/lib/avalara_sdk/models/A1099/V2/w9_form_base_request.rb +60 -27
- data/lib/avalara_sdk/models/A1099/V2/w9_form_base_response.rb +14 -14
- data/lib/avalara_sdk/models/A1099/V2/{company_response_model.rb → w9_form_minimal_request.rb} +140 -148
- data/lib/avalara_sdk/models/A1099/V2/w9_form_request.rb +53 -27
- data/lib/avalara_sdk/version.rb +1 -1
- data/lib/avalara_sdk.rb +22 -105
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/byebug-11.1.3/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/date-3.4.1/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debase-0.2.9/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debug-1.10.0/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/erb-5.0.1/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/io-console-0.8.0/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/json-2.12.2/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/prism-1.4.0/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/psych-5.2.6/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/racc-1.8.1/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/stringio-3.1.7/gem_make.out +5 -5
- metadata +37 -103
- data/lib/avalara_sdk/models/A1099/V2/base_form_list_request.rb +0 -210
- data/lib/avalara_sdk/models/A1099/V2/bulk_upsert1099_forms_request.rb +0 -108
- data/lib/avalara_sdk/models/A1099/V2/covered_individual_reference.rb +0 -403
- data/lib/avalara_sdk/models/A1099/V2/covered_individual_reference_response.rb +0 -407
- data/lib/avalara_sdk/models/A1099/V2/create1099_form201_response.rb +0 -108
- data/lib/avalara_sdk/models/A1099/V2/data.rb +0 -237
- data/lib/avalara_sdk/models/A1099/V2/form1042_s_list.rb +0 -238
- data/lib/avalara_sdk/models/A1099/V2/form1042_s_list_item.rb +0 -816
- data/lib/avalara_sdk/models/A1099/V2/form1042_s_list_item_response.rb +0 -980
- data/lib/avalara_sdk/models/A1099/V2/form1042_s_request.rb +0 -778
- data/lib/avalara_sdk/models/A1099/V2/form1042_s_response.rb +0 -619
- data/lib/avalara_sdk/models/A1099/V2/form1095_b_list.rb +0 -238
- data/lib/avalara_sdk/models/A1099/V2/form1095_b_list_item.rb +0 -606
- data/lib/avalara_sdk/models/A1099/V2/form1095_b_list_item_response.rb +0 -765
- data/lib/avalara_sdk/models/A1099/V2/form1095_b_request.rb +0 -627
- data/lib/avalara_sdk/models/A1099/V2/form1095_c_list.rb +0 -238
- data/lib/avalara_sdk/models/A1099/V2/form1095_c_list_item.rb +0 -662
- data/lib/avalara_sdk/models/A1099/V2/form1099_base_response.rb +0 -726
- data/lib/avalara_sdk/models/A1099/V2/form1099_div_list_item.rb +0 -747
- data/lib/avalara_sdk/models/A1099/V2/form1099_div_list_item_response.rb +0 -931
- data/lib/avalara_sdk/models/A1099/V2/form1099_div_request.rb +0 -729
- data/lib/avalara_sdk/models/A1099/V2/form1099_div_response.rb +0 -790
- data/lib/avalara_sdk/models/A1099/V2/form1099_int_list.rb +0 -238
- data/lib/avalara_sdk/models/A1099/V2/form1099_int_list_item.rb +0 -702
- data/lib/avalara_sdk/models/A1099/V2/form1099_int_list_item_response.rb +0 -887
- data/lib/avalara_sdk/models/A1099/V2/form1099_int_request.rb +0 -684
- data/lib/avalara_sdk/models/A1099/V2/form1099_int_response.rb +0 -773
- data/lib/avalara_sdk/models/A1099/V2/form1099_k_list.rb +0 -238
- data/lib/avalara_sdk/models/A1099/V2/form1099_k_list_item.rb +0 -788
- data/lib/avalara_sdk/models/A1099/V2/form1099_k_list_item_response.rb +0 -995
- data/lib/avalara_sdk/models/A1099/V2/form1099_k_request.rb +0 -770
- data/lib/avalara_sdk/models/A1099/V2/form1099_k_response.rb +0 -839
- data/lib/avalara_sdk/models/A1099/V2/form1099_list.rb +0 -219
- data/lib/avalara_sdk/models/A1099/V2/form1099_list_data_inner.rb +0 -55
- data/lib/avalara_sdk/models/A1099/V2/form1099_list_response.rb +0 -220
- data/lib/avalara_sdk/models/A1099/V2/form1099_list_response_value_inner.rb +0 -108
- data/lib/avalara_sdk/models/A1099/V2/form1099_misc_list.rb +0 -238
- data/lib/avalara_sdk/models/A1099/V2/form1099_misc_list_item.rb +0 -688
- data/lib/avalara_sdk/models/A1099/V2/form1099_misc_list_item_response.rb +0 -886
- data/lib/avalara_sdk/models/A1099/V2/form1099_misc_request.rb +0 -670
- data/lib/avalara_sdk/models/A1099/V2/form1099_misc_response.rb +0 -754
- data/lib/avalara_sdk/models/A1099/V2/form1099_nec_list.rb +0 -238
- data/lib/avalara_sdk/models/A1099/V2/form1099_nec_list_item.rb +0 -586
- data/lib/avalara_sdk/models/A1099/V2/form1099_nec_list_item_response.rb +0 -765
- data/lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb +0 -567
- data/lib/avalara_sdk/models/A1099/V2/form1099_nec_response.rb +0 -646
- data/lib/avalara_sdk/models/A1099/V2/form1099_proccess_result.rb +0 -228
- data/lib/avalara_sdk/models/A1099/V2/form1099_proccess_result_processed_forms_inner.rb +0 -107
- data/lib/avalara_sdk/models/A1099/V2/form1099_r_list.rb +0 -238
- data/lib/avalara_sdk/models/A1099/V2/form1099_r_list_item.rb +0 -763
- data/lib/avalara_sdk/models/A1099/V2/form1099_r_list_item_response.rb +0 -942
- data/lib/avalara_sdk/models/A1099/V2/form1099_r_request.rb +0 -720
- data/lib/avalara_sdk/models/A1099/V2/form1099_r_response.rb +0 -839
- data/lib/avalara_sdk/models/A1099/V2/form1099_status_detail_response.rb +0 -223
- data/lib/avalara_sdk/models/A1099/V2/form_request_base.rb +0 -502
- data/lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb +0 -475
- data/lib/avalara_sdk/models/A1099/V2/form_request_list_item_base.rb +0 -548
- data/lib/avalara_sdk/models/A1099/V2/form_request_model.rb +0 -345
- data/lib/avalara_sdk/models/A1099/V2/form_response_base.rb +0 -612
- data/lib/avalara_sdk/models/A1099/V2/form_single_request_base.rb +0 -530
- data/lib/avalara_sdk/models/A1099/V2/included_base.rb +0 -219
- data/lib/avalara_sdk/models/A1099/V2/intermediary_or_flow_through_request.rb +0 -311
- data/lib/avalara_sdk/models/A1099/V2/intermediary_or_flow_through_response.rb +0 -311
- data/lib/avalara_sdk/models/A1099/V2/link.rb +0 -210
- data/lib/avalara_sdk/models/A1099/V2/paginated_w9_forms_model.rb +0 -231
- data/lib/avalara_sdk/models/A1099/V2/primary_withholding_agent_request.rb +0 -221
- data/lib/avalara_sdk/models/A1099/V2/primary_withholding_agent_response.rb +0 -221
- data/lib/avalara_sdk/models/A1099/V2/problem_details.rb +0 -251
- data/lib/avalara_sdk/models/A1099/V2/state_and_local_withholding_request.rb +0 -278
- data/lib/avalara_sdk/models/A1099/V2/state_and_local_withholding_response.rb +0 -282
- data/lib/avalara_sdk/models/A1099/V2/state_efile_status_detail_app.rb +0 -231
- data/lib/avalara_sdk/models/A1099/V2/state_efile_status_detail_response.rb +0 -231
- data/lib/avalara_sdk/models/A1099/V2/update1099_form200_response.rb +0 -108
- data/lib/avalara_sdk/models/A1099/V2/validation_error_app.rb +0 -229
- data/lib/avalara_sdk/models/A1099/V2/validation_error_response.rb +0 -231
- data/lib/avalara_sdk/models/EInvoicing/V1/directory_search_response.rb +0 -233
- data/lib/avalara_sdk/models/EInvoicing/V1/directory_search_response_value_inner.rb +0 -274
- data/lib/avalara_sdk/models/EInvoicing/V1/directory_search_response_value_inner_addresses_inner.rb +0 -251
- data/lib/avalara_sdk/models/EInvoicing/V1/directory_search_response_value_inner_identifiers_inner.rb +0 -221
- data/lib/avalara_sdk/models/EInvoicing/V1/directory_search_response_value_inner_supported_document_types_inner.rb +0 -241
- data/lib/avalara_sdk/models/EInvoicing/V1/document_fetch_request.rb +0 -224
- data/lib/avalara_sdk/models/EInvoicing/V1/document_fetch_request_data_inner.rb +0 -237
- data/lib/avalara_sdk/models/EInvoicing/V1/document_fetch_request_metadata.rb +0 -288
- data/lib/avalara_sdk/models/EInvoicing/V1/submit_document_data.rb +0 -216
data/docs/A1099/V2/FormsW9Api.md
CHANGED
@@ -1,9 +1,10 @@
|
|
1
1
|
# AvalaraSdk::A1099::V2::FormsW9Api
|
2
2
|
|
3
|
-
All URIs are relative to *https://api
|
3
|
+
All URIs are relative to *https://api.sbx.avalara.com/avalara1099*
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_and_send_w9_form_email**](FormsW9Api.md#create_and_send_w9_form_email) | **POST** /w9/forms/$create-and-send-email | Create a minimal W9/W4/W8 form and sends the e-mail request |
|
7
8
|
| [**create_w9_form**](FormsW9Api.md#create_w9_form) | **POST** /w9/forms | Create a W9/W4/W8 form |
|
8
9
|
| [**delete_w9_form**](FormsW9Api.md#delete_w9_form) | **DELETE** /w9/forms/{id} | Delete a W9/W4/W8 form |
|
9
10
|
| [**get_w9_form**](FormsW9Api.md#get_w9_form) | **GET** /w9/forms/{id} | Retrieve a W9/W4/W8 form |
|
@@ -13,6 +14,89 @@ All URIs are relative to *https://api-ava1099.eta.sbx.us-east-1.aws.avalara.io/a
|
|
13
14
|
| [**upload_w9_files**](FormsW9Api.md#upload_w9_files) | **POST** /w9/forms/{id}/attachment | Replace the PDF file for a W9/W4/W8 form |
|
14
15
|
|
15
16
|
|
17
|
+
## create_and_send_w9_form_email
|
18
|
+
|
19
|
+
> <CreateW9Form201Response> create_and_send_w9_form_email(avalara_version, opts)
|
20
|
+
|
21
|
+
Create a minimal W9/W4/W8 form and sends the e-mail request
|
22
|
+
|
23
|
+
Create a minimal W9/W4/W8 form and sends the e-mail request.
|
24
|
+
|
25
|
+
### Examples
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'time'
|
29
|
+
require 'avalara_sdk'
|
30
|
+
# setup authorization
|
31
|
+
AvalaraSdk::A1099::V2.configure do |config|
|
32
|
+
# See Documentation for Authorization section in main README.md for more auth examples.
|
33
|
+
config.bearer_token='<Your Avalara Identity Access Token>'
|
34
|
+
config.environment='sandbox'
|
35
|
+
config.app_name='testApp'
|
36
|
+
config.app_version='1.2.3'
|
37
|
+
config.machine_name='testMachine'
|
38
|
+
end
|
39
|
+
|
40
|
+
api_client = AvalaraSdk::ApiClient.new config
|
41
|
+
api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
|
42
|
+
|
43
|
+
avalara_version = '2.0.0' # String | API version
|
44
|
+
opts = {
|
45
|
+
x_correlation_id: '876394c1-80f7-4f02-a857-3899965a96bf', # String | Unique correlation Id in a GUID format
|
46
|
+
x_avalara_client: 'Swagger UI; 22.1.0', # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
|
47
|
+
create_and_send_w9_form_email_request: AvalaraSdk::A1099::V2::W4FormMinimalRequest.new({email: 'email_example', employee_first_name: 'employee_first_name_example', employee_last_name: 'employee_last_name_example', company_id: 'company_id_example'}) # CreateAndSendW9FormEmailRequest | Form to be created
|
48
|
+
}
|
49
|
+
|
50
|
+
begin
|
51
|
+
# Create a minimal W9/W4/W8 form and sends the e-mail request
|
52
|
+
result = api_instance.create_and_send_w9_form_email(avalara_version, opts)
|
53
|
+
p result
|
54
|
+
rescue AvalaraSdk::ApiError => e
|
55
|
+
puts "Error when calling FormsW9Api->create_and_send_w9_form_email: #{e}"
|
56
|
+
end
|
57
|
+
```
|
58
|
+
|
59
|
+
#### Using the create_and_send_w9_form_email_with_http_info variant
|
60
|
+
|
61
|
+
This returns an Array which contains the response data, status code and headers.
|
62
|
+
|
63
|
+
> <Array(<CreateW9Form201Response>, Integer, Hash)> create_and_send_w9_form_email_with_http_info(avalara_version, opts)
|
64
|
+
|
65
|
+
```ruby
|
66
|
+
begin
|
67
|
+
# Create a minimal W9/W4/W8 form and sends the e-mail request
|
68
|
+
data, status_code, headers = api_instance.create_and_send_w9_form_email_with_http_info(avalara_version, opts)
|
69
|
+
p status_code # => 2xx
|
70
|
+
p headers # => { ... }
|
71
|
+
p data # => <CreateW9Form201Response>
|
72
|
+
rescue AvalaraSdk::A1099::V2::ApiError => e
|
73
|
+
puts "Error when calling FormsW9Api->create_and_send_w9_form_email_with_http_info: #{e}"
|
74
|
+
end
|
75
|
+
```
|
76
|
+
|
77
|
+
### Parameters
|
78
|
+
|
79
|
+
| Name | Type | Description | Notes |
|
80
|
+
| ---- | ---- | ----------- | ----- |
|
81
|
+
| **avalara_version** | **String** | API version | |
|
82
|
+
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
|
83
|
+
| **x_avalara_client** | **String** | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] |
|
84
|
+
| **create_and_send_w9_form_email_request** | [**CreateAndSendW9FormEmailRequest**](CreateAndSendW9FormEmailRequest.md) | Form to be created | [optional] |
|
85
|
+
|
86
|
+
### Return type
|
87
|
+
|
88
|
+
[**CreateW9Form201Response**](CreateW9Form201Response.md)
|
89
|
+
|
90
|
+
### Authorization
|
91
|
+
|
92
|
+
[bearer](../../../README.md#documentation-for-authorization)
|
93
|
+
|
94
|
+
### HTTP request headers
|
95
|
+
|
96
|
+
- **Content-Type**: application/json, text/json, application/*+json
|
97
|
+
- **Accept**: application/json
|
98
|
+
|
99
|
+
|
16
100
|
## create_w9_form
|
17
101
|
|
18
102
|
> <CreateW9Form201Response> create_w9_form(avalara_version, opts)
|
@@ -41,9 +125,9 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
|
|
41
125
|
|
42
126
|
avalara_version = '2.0.0' # String | API version
|
43
127
|
opts = {
|
44
|
-
x_correlation_id: '
|
128
|
+
x_correlation_id: '4f7d2a74-9904-4300-b8c4-d5eadabea39b', # String | Unique correlation Id in a GUID format
|
45
129
|
x_avalara_client: 'Swagger UI; 22.1.0', # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
|
46
|
-
create_w9_form_request: AvalaraSdk::A1099::V2::W4FormRequest.new # CreateW9FormRequest | Form to be created
|
130
|
+
create_w9_form_request: AvalaraSdk::A1099::V2::W4FormRequest.new({company_id: 'company_id_example'}) # CreateW9FormRequest | Form to be created
|
47
131
|
}
|
48
132
|
|
49
133
|
begin
|
@@ -125,7 +209,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
|
|
125
209
|
id = 'id_example' # String | ID of the form to delete
|
126
210
|
avalara_version = '2.0.0' # String | API version
|
127
211
|
opts = {
|
128
|
-
x_correlation_id: '
|
212
|
+
x_correlation_id: '897b8ec0-bd1d-404b-b128-05268ad1823d', # String | Unique correlation Id in a GUID format
|
129
213
|
x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
|
130
214
|
}
|
131
215
|
|
@@ -207,7 +291,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
|
|
207
291
|
id = 'id_example' # String | ID of the form
|
208
292
|
avalara_version = '2.0.0' # String | API version
|
209
293
|
opts = {
|
210
|
-
x_correlation_id: '
|
294
|
+
x_correlation_id: '5aacb16c-2a0a-4896-a0d2-a121f2b5d1d8', # String | Unique correlation Id in a GUID format
|
211
295
|
x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
|
212
296
|
}
|
213
297
|
|
@@ -295,7 +379,7 @@ opts = {
|
|
295
379
|
order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.
|
296
380
|
count: true, # Boolean | If true, return the global count of elements in the collection.
|
297
381
|
count_only: true, # Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true.
|
298
|
-
x_correlation_id: '
|
382
|
+
x_correlation_id: '779b71e3-fc48-49be-b680-e44e47b3d963', # String | Unique correlation Id in a GUID format
|
299
383
|
x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
|
300
384
|
}
|
301
385
|
|
@@ -356,11 +440,11 @@ end
|
|
356
440
|
|
357
441
|
## send_w9_form_email
|
358
442
|
|
359
|
-
> <
|
443
|
+
> <CreateW9Form201Response> send_w9_form_email(id, avalara_version, opts)
|
360
444
|
|
361
445
|
Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form
|
362
446
|
|
363
|
-
Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form.
|
447
|
+
Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form. If the form is not in 'Requested' status, it will either use an existing descendant form in 'Requested' status or create a new minimal form and send the email request.
|
364
448
|
|
365
449
|
### Examples
|
366
450
|
|
@@ -383,7 +467,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
|
|
383
467
|
id = 'id_example' # String | The ID of the W9/W4/W8 form.
|
384
468
|
avalara_version = '2.0.0' # String | API version
|
385
469
|
opts = {
|
386
|
-
x_correlation_id: '
|
470
|
+
x_correlation_id: '8f5afdc6-9616-494f-940c-c66b87b43d27', # String | Unique correlation Id in a GUID format
|
387
471
|
x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
|
388
472
|
}
|
389
473
|
|
@@ -400,7 +484,7 @@ end
|
|
400
484
|
|
401
485
|
This returns an Array which contains the response data, status code and headers.
|
402
486
|
|
403
|
-
> <Array(<
|
487
|
+
> <Array(<CreateW9Form201Response>, Integer, Hash)> send_w9_form_email_with_http_info(id, avalara_version, opts)
|
404
488
|
|
405
489
|
```ruby
|
406
490
|
begin
|
@@ -408,7 +492,7 @@ begin
|
|
408
492
|
data, status_code, headers = api_instance.send_w9_form_email_with_http_info(id, avalara_version, opts)
|
409
493
|
p status_code # => 2xx
|
410
494
|
p headers # => { ... }
|
411
|
-
p data # => <
|
495
|
+
p data # => <CreateW9Form201Response>
|
412
496
|
rescue AvalaraSdk::A1099::V2::ApiError => e
|
413
497
|
puts "Error when calling FormsW9Api->send_w9_form_email_with_http_info: #{e}"
|
414
498
|
end
|
@@ -425,7 +509,7 @@ end
|
|
425
509
|
|
426
510
|
### Return type
|
427
511
|
|
428
|
-
[**
|
512
|
+
[**CreateW9Form201Response**](CreateW9Form201Response.md)
|
429
513
|
|
430
514
|
### Authorization
|
431
515
|
|
@@ -466,7 +550,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
|
|
466
550
|
id = 'id_example' # String | ID of the form to update
|
467
551
|
avalara_version = '2.0.0' # String | API version
|
468
552
|
opts = {
|
469
|
-
x_correlation_id: '
|
553
|
+
x_correlation_id: 'e0842c54-95c7-488a-882a-ce34cb46e87d', # String | Unique correlation Id in a GUID format
|
470
554
|
x_avalara_client: 'Swagger UI; 22.1.0', # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
|
471
555
|
iw9_form_data_models_one_of: AvalaraSdk::A1099::V2::W4FormDataModel.new # IW9FormDataModelsOneOf | Form to be updated
|
472
556
|
}
|
@@ -551,7 +635,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
|
|
551
635
|
id = 'id_example' # String | Id of the form
|
552
636
|
avalara_version = '2.0.0' # String | API version
|
553
637
|
opts = {
|
554
|
-
x_correlation_id: '
|
638
|
+
x_correlation_id: 'ba11f0c0-e9ed-4667-8137-0026b63b63cf', # String | Unique correlation Id in a GUID format
|
555
639
|
x_avalara_client: 'Swagger UI; 22.1.0', # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
|
556
640
|
file: File.new('/path/to/some/file') # File |
|
557
641
|
}
|
@@ -14,15 +14,15 @@ require 'avalara_sdk'
|
|
14
14
|
AvalaraSdk::A1099::V2::Get1099Form200Response.openapi_one_of
|
15
15
|
# =>
|
16
16
|
# [
|
17
|
-
# :'
|
18
|
-
# :'
|
19
|
-
# :'
|
20
|
-
# :'
|
21
|
-
# :'
|
22
|
-
# :'
|
23
|
-
# :'
|
24
|
-
# :'
|
25
|
-
# :'
|
17
|
+
# :'Form1042S',
|
18
|
+
# :'Form1095B',
|
19
|
+
# :'Form1095C',
|
20
|
+
# :'Form1099Div',
|
21
|
+
# :'Form1099Int',
|
22
|
+
# :'Form1099K',
|
23
|
+
# :'Form1099Misc',
|
24
|
+
# :'Form1099Nec',
|
25
|
+
# :'Form1099R'
|
26
26
|
# ]
|
27
27
|
```
|
28
28
|
|
@@ -36,7 +36,7 @@ Find the appropriate object from the `openapi_one_of` list and casts the data in
|
|
36
36
|
require 'avalara_sdk'
|
37
37
|
|
38
38
|
AvalaraSdk::A1099::V2::Get1099Form200Response.build(data)
|
39
|
-
# => #<
|
39
|
+
# => #<Form1042S:0x00007fdd4aab02a0>
|
40
40
|
|
41
41
|
AvalaraSdk::A1099::V2::Get1099Form200Response.build(data_that_doesnt_match)
|
42
42
|
# => nil
|
@@ -50,14 +50,14 @@ AvalaraSdk::A1099::V2::Get1099Form200Response.build(data_that_doesnt_match)
|
|
50
50
|
|
51
51
|
#### Return type
|
52
52
|
|
53
|
-
- `
|
54
|
-
- `
|
55
|
-
- `
|
56
|
-
- `
|
57
|
-
- `
|
58
|
-
- `
|
59
|
-
- `
|
60
|
-
- `
|
61
|
-
- `
|
53
|
+
- `Form1042S`
|
54
|
+
- `Form1095B`
|
55
|
+
- `Form1095C`
|
56
|
+
- `Form1099Div`
|
57
|
+
- `Form1099Int`
|
58
|
+
- `Form1099K`
|
59
|
+
- `Form1099Misc`
|
60
|
+
- `Form1099Nec`
|
61
|
+
- `Form1099R`
|
62
62
|
- `nil` (if no type matches)
|
63
63
|
|
@@ -4,17 +4,17 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **ein** | **String** |
|
8
|
-
| **chap3_status_code** | **String** |
|
9
|
-
| **chap4_status_code** | **String** |
|
10
|
-
| **name** | **String** |
|
11
|
-
| **giin** | **String** |
|
12
|
-
| **country_code** | **String** |
|
13
|
-
| **foreign_tin** | **String** |
|
14
|
-
| **address** | **String** |
|
15
|
-
| **city** | **String** |
|
16
|
-
| **state** | **String** |
|
17
|
-
| **zip** | **String** |
|
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] |
|
10
|
+
| **name** | **String** | Name of the intermediary or flow-through entity | [optional] |
|
11
|
+
| **giin** | **String** | GIIN (Global Intermediary Identification Number) of the intermediary or flow-through entity | [optional] |
|
12
|
+
| **country_code** | **String** | Country code for the intermediary or flow-through entity | [optional] |
|
13
|
+
| **foreign_tin** | **String** | Foreign TIN of the intermediary or flow-through entity | [optional] |
|
14
|
+
| **address** | **String** | Address of the intermediary or flow-through entity | [optional] |
|
15
|
+
| **city** | **String** | City of the intermediary or flow-through entity | [optional] |
|
16
|
+
| **state** | **String** | State of the intermediary or flow-through entity | [optional] |
|
17
|
+
| **zip** | **String** | Zip code of the intermediary or flow-through entity | [optional] |
|
18
18
|
|
19
19
|
## Example
|
20
20
|
|
@@ -4,21 +4,21 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **name** | **String** | Legal name
|
8
|
-
| **
|
9
|
-
| **tin** | **String** | Tax
|
10
|
-
| **reference_id** | **String** |
|
11
|
-
| **telephone** | **String** |
|
12
|
-
| **tax_year** | **Integer** | Tax year
|
13
|
-
| **country_code** | **String** | If there is a transfer agent, use the shipping address
|
14
|
-
| **email** | **String** |
|
15
|
-
| **address** | **String** | Address |
|
16
|
-
| **city** | **String** | City |
|
17
|
-
| **state** | **String** |
|
18
|
-
| **zip** | **String** |
|
19
|
-
| **foreign_province** | **String** |
|
20
|
-
| **transfer_agent_name** | **String** |
|
21
|
-
| **last_filing** | **Boolean** |
|
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 'transferAgentName'. | [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., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. If there is a transfer agent, use the transfer agent'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 'dbaName'. | [optional] |
|
21
|
+
| **last_filing** | **Boolean** | Indicates if this is the issuer's final year filing. | |
|
22
22
|
|
23
23
|
## Example
|
24
24
|
|
@@ -27,7 +27,7 @@ require 'avalara_sdk'
|
|
27
27
|
|
28
28
|
instance = AvalaraSdk::A1099::V2::IssuerCommand.new(
|
29
29
|
name: null,
|
30
|
-
|
30
|
+
dba_name: null,
|
31
31
|
tin: null,
|
32
32
|
reference_id: null,
|
33
33
|
telephone: null,
|
@@ -4,24 +4,24 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** | Unique identifier set when the record is created | [optional]
|
8
|
-
| **
|
9
|
-
| **
|
10
|
-
| **
|
11
|
-
| **
|
12
|
-
| **
|
13
|
-
| **
|
14
|
-
| **
|
15
|
-
| **
|
16
|
-
| **
|
17
|
-
| **
|
18
|
-
| **
|
19
|
-
| **
|
20
|
-
| **
|
21
|
-
| **
|
22
|
-
| **
|
23
|
-
| **
|
24
|
-
| **
|
7
|
+
| **id** | **String** | Unique identifier set when the record is created. | [optional] |
|
8
|
+
| **created_at** | **Time** | Date time when the record was created. | [optional] |
|
9
|
+
| **updated_at** | **Time** | Date time when the record was last updated. | [optional] |
|
10
|
+
| **name** | **String** | Legal name. Not the DBA name. | |
|
11
|
+
| **dba_name** | **String** | Doing Business As (DBA) name or continuation of a long legal name. Use either this or 'transferAgentName'. | [optional] |
|
12
|
+
| **tin** | **String** | Federal Tax Identification Number (TIN). | [optional] |
|
13
|
+
| **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] |
|
14
|
+
| **telephone** | **String** | Contact phone number (must contain at least 10 digits, max 15 characters). For recipient inquiries. | |
|
15
|
+
| **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. | |
|
16
|
+
| **country_code** | **String** | Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. If there is a transfer agent, use the transfer agent's shipping address. | [optional] |
|
17
|
+
| **email** | **String** | Contact email address. For recipient inquiries. | |
|
18
|
+
| **address** | **String** | Address. | |
|
19
|
+
| **city** | **String** | City. | |
|
20
|
+
| **state** | **String** | Two-letter US state or Canadian province code (required for US/CA addresses). | |
|
21
|
+
| **zip** | **String** | ZIP/postal code. | |
|
22
|
+
| **foreign_province** | **String** | Province or region for non-US/CA addresses. | [optional] |
|
23
|
+
| **transfer_agent_name** | **String** | Name of the transfer agent, if applicable — optional; use either this or 'dbaName'. | [optional] |
|
24
|
+
| **last_filing** | **Boolean** | Indicates if this is the issuer's final year filing. | |
|
25
25
|
|
26
26
|
## Example
|
27
27
|
|
@@ -29,24 +29,24 @@
|
|
29
29
|
require 'avalara_sdk'
|
30
30
|
|
31
31
|
instance = AvalaraSdk::A1099::V2::IssuerResponse.new(
|
32
|
-
id:
|
33
|
-
name: Acme Corp,
|
34
|
-
name_dba: Second Name Corp,
|
35
|
-
tin: 23-8234555,
|
36
|
-
reference_id: 1891810-9819891,
|
37
|
-
telephone: 520-555-1234,
|
38
|
-
tax_year: 2024,
|
39
|
-
country_code: US,
|
40
|
-
email: roadrunner@acmecorp.com,
|
41
|
-
address: 1234 Meep Meep Blvd,
|
42
|
-
city: Tucson,
|
43
|
-
state: AZ,
|
44
|
-
zip: 35004,
|
45
|
-
foreign_province: 1981981,
|
46
|
-
transfer_agent_name: test,
|
47
|
-
last_filing: false,
|
32
|
+
id: null,
|
48
33
|
created_at: null,
|
49
|
-
updated_at: null
|
34
|
+
updated_at: null,
|
35
|
+
name: null,
|
36
|
+
dba_name: null,
|
37
|
+
tin: null,
|
38
|
+
reference_id: null,
|
39
|
+
telephone: null,
|
40
|
+
tax_year: null,
|
41
|
+
country_code: null,
|
42
|
+
email: null,
|
43
|
+
address: null,
|
44
|
+
city: null,
|
45
|
+
state: null,
|
46
|
+
zip: null,
|
47
|
+
foreign_province: null,
|
48
|
+
transfer_agent_name: null,
|
49
|
+
last_filing: null
|
50
50
|
)
|
51
51
|
```
|
52
52
|
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# AvalaraSdk::A1099::V2::Issuers1099Api
|
2
2
|
|
3
|
-
All URIs are relative to *https://api
|
3
|
+
All URIs are relative to *https://api.sbx.avalara.com/avalara1099*
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
@@ -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: '
|
42
|
+
x_correlation_id: '26a8ae54-5655-49b3-b01a-f4203094a5ef', # 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
|
+
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
|
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
|
-
| **
|
81
|
+
| **create_issuer_request** | [**CreateIssuerRequest**](CreateIssuerRequest.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: '
|
126
|
+
x_correlation_id: 'b8d102b3-3e63-4e6e-9735-25f17b0c69a7', # 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: 'fc90ea70-0e20-46ed-a73c-80e99e89f3d5', # 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: '
|
296
|
+
x_correlation_id: '8c33cfd6-f102-4192-9001-24fed7baee29', # 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: '
|
384
|
+
x_correlation_id: 'c353a7ba-0386-49f8-97a8-378cd39452ea', # 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
|
+
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
|
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
|
-
| **
|
423
|
+
| **create_issuer_request** | [**CreateIssuerRequest**](CreateIssuerRequest.md) | The issuer to update | [optional] |
|
424
424
|
|
425
425
|
### Return type
|
426
426
|
|
@@ -0,0 +1,56 @@
|
|
1
|
+
# AvalaraSdk::A1099::V2::JobResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Unique identifier for the job | [optional] |
|
8
|
+
| **type** | **String** | Job type identifier. Will always be \"update_job\" for bulk upsert operations | [optional] |
|
9
|
+
| **status** | **String** | Current status of the job (e.g., Success, Failed, InProgress) | [optional] |
|
10
|
+
| **error_message** | **String** | Error message if the job failed, null otherwise | [optional] |
|
11
|
+
| **total_processed** | **Integer** | Total number of forms processed. Value can be 0 or another value based on what the job has available | [optional] |
|
12
|
+
| **total_rows** | **Integer** | Total number of forms in the request. Value can be 0 or another value based on what the job has available | [optional] |
|
13
|
+
| **updated_valid** | **Integer** | Number of forms updated and valid for e-filing and e-delivery. Value can be 0 or another value based on what the job has available | [optional] |
|
14
|
+
| **updated_no_email** | **Integer** | Number of forms updated and valid for e-filing but missing email or email is undeliverable. Value can be 0 or another value based on what the job has available | [optional] |
|
15
|
+
| **updated_invalid** | **Integer** | Number of forms updated but invalid for e-filing. Value can be 0 or another value based on what the job has available | [optional] |
|
16
|
+
| **skipped_duplicate** | **Integer** | Number of forms skipped because they would have updated a record already updated once in the request. Value can be 0 or another value based on what the job has available | [optional] |
|
17
|
+
| **skipped_invalid** | **Integer** | Number of forms skipped because they would have made a form invalid and the form is already e-filed or scheduled for e-filing. Value can be 0 or another value based on what the job has available | [optional] |
|
18
|
+
| **skipped_multiple_matches** | **Integer** | Number of forms skipped because they matched multiple forms. Value can be 0 or another value based on what the job has available | [optional] |
|
19
|
+
| **not_found** | **Integer** | Number of forms skipped because no matching form or issuer could be found. Value can be 0 or another value based on what the job has available | [optional] |
|
20
|
+
| **created_invalid** | **Integer** | Number of new forms created because no matching form could be found (and `upsert` was true) - with errors. Value can be 0 or another value based on what the job has available | [optional] |
|
21
|
+
| **created_no_email** | **Integer** | Number of new forms created because no matching form could be found (and `upsert` was true) - valid for e-filing but missing email or email is undeliverable. Value can be 0 or another value based on what the job has available | [optional] |
|
22
|
+
| **created_valid** | **Integer** | Number of new forms created because no matching form could be found (and `upsert` was true) - valid for e-filing and e-delivery. Value can be 0 or another value based on what the job has available | [optional] |
|
23
|
+
| **dry_run** | **Boolean** | Dry run. If `true`, this job only simulates the changes but doesn't actually persist them. | [optional] |
|
24
|
+
| **upsert** | **Boolean** | Upsert. If `true`, this job will first attempt to update existing records if matches can be found. Matches are done in the following order: Form ID, Form Reference ID and tax year, Form TIN and tax year. | [optional] |
|
25
|
+
| **link** | **String** | Link to access the job details | [optional] |
|
26
|
+
| **processed_forms** | [**Array<Get1099Form200Response>**](Get1099Form200Response.md) | List of processed forms returned when bulk-upsert processes ≤1000 records. Same format as GET /1099/forms response. Only available in bulk-upsert endpoint responses. | [optional] |
|
27
|
+
|
28
|
+
## Example
|
29
|
+
|
30
|
+
```ruby
|
31
|
+
require 'avalara_sdk'
|
32
|
+
|
33
|
+
instance = AvalaraSdk::A1099::V2::JobResponse.new(
|
34
|
+
id: null,
|
35
|
+
type: null,
|
36
|
+
status: InProgress,
|
37
|
+
error_message: null,
|
38
|
+
total_processed: null,
|
39
|
+
total_rows: null,
|
40
|
+
updated_valid: null,
|
41
|
+
updated_no_email: null,
|
42
|
+
updated_invalid: null,
|
43
|
+
skipped_duplicate: null,
|
44
|
+
skipped_invalid: null,
|
45
|
+
skipped_multiple_matches: null,
|
46
|
+
not_found: null,
|
47
|
+
created_invalid: null,
|
48
|
+
created_no_email: null,
|
49
|
+
created_valid: null,
|
50
|
+
dry_run: null,
|
51
|
+
upsert: null,
|
52
|
+
link: null,
|
53
|
+
processed_forms: null
|
54
|
+
)
|
55
|
+
```
|
56
|
+
|