avalara_sdk 25.6.0 → 25.7.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/README.md +17 -3
- data/docs/A1099/V2/BulkUpsert1099FormsRequest.md +3 -1
- data/docs/A1099/V2/CompaniesW9Api.md +45 -31
- data/docs/A1099/V2/CoveredIndividualReference.md +58 -0
- data/docs/A1099/V2/CoveredIndividualRequest.md +54 -0
- data/docs/A1099/V2/Form1095B.md +86 -0
- data/docs/A1099/V2/Form1095BList.md +20 -0
- data/docs/A1099/V2/Form1095BListItem.md +74 -0
- data/docs/A1099/V2/Form1095BRequest.md +76 -0
- data/docs/A1099/V2/Form1099Base.md +8 -8
- data/docs/A1099/V2/Form1099DivListItem.md +11 -11
- data/docs/A1099/V2/Form1099DivRequest.md +11 -17
- data/docs/A1099/V2/Form1099DivResponse.md +88 -0
- data/docs/A1099/V2/Form1099K.md +8 -8
- data/docs/A1099/V2/Form1099KListItem.md +11 -11
- data/docs/A1099/V2/Form1099KRequest.md +11 -17
- data/docs/A1099/V2/Form1099List.md +1 -1
- data/docs/A1099/V2/Form1099ListDataInner.md +32 -0
- data/docs/A1099/V2/Form1099Misc.md +8 -8
- data/docs/A1099/V2/Form1099MiscListItem.md +11 -11
- data/docs/A1099/V2/Form1099MiscRequest.md +11 -17
- data/docs/A1099/V2/Form1099MiscResponse.md +120 -0
- data/docs/A1099/V2/Form1099Nec.md +8 -8
- data/docs/A1099/V2/Form1099NecListItem.md +11 -11
- data/docs/A1099/V2/Form1099NecRequest.md +11 -17
- data/docs/A1099/V2/Form1099NecResponse.md +96 -0
- data/docs/A1099/V2/Form1099R.md +8 -8
- data/docs/A1099/V2/Form1099RListItem.md +11 -11
- data/docs/A1099/V2/Form1099RRequest.md +11 -17
- data/docs/A1099/V2/FormRequestBase.md +9 -13
- data/docs/A1099/V2/FormRequestCsvBase.md +66 -0
- data/docs/A1099/V2/FormResponseBase.md +43 -9
- data/docs/A1099/V2/FormSingleRequestBase.md +11 -15
- data/docs/A1099/V2/Forms1099Api.md +75 -57
- data/docs/A1099/V2/FormsW9Api.md +63 -123
- data/docs/A1099/V2/Get1099Form200Response.md +55 -0
- data/docs/A1099/V2/IncludedBase.md +20 -0
- data/docs/A1099/V2/Issuers1099Api.md +45 -31
- data/docs/A1099/V2/Jobs1099Api.md +10 -6
- data/docs/A1099/V2/StateAndLocalWithholdingResponse.md +32 -0
- data/docs/A1099/V2/StateEfileStatusDetail.md +1 -1
- data/docs/A1099/V2/StateEfileStatusDetailApp.md +22 -0
- data/docs/A1099/V2/StatusDetail.md +20 -0
- data/docs/A1099/V2/Update1099Form200Response.md +53 -0
- data/docs/A1099/V2/ValidationErrorApp.md +20 -0
- data/docs/EInvoicing/V1/DataInputFieldsApi.md +4 -4
- data/docs/EInvoicing/V1/DocumentsApi.md +2 -2
- data/docs/EInvoicing/V1/MandatesApi.md +4 -4
- data/docs/EInvoicing/V1/SubscriptionsApi.md +4 -4
- data/docs/EInvoicing/V1/TradingPartnersApi.md +4 -4
- data/lib/avalara_sdk/api/A1099/V2/companies_w9_api.rb +103 -43
- data/lib/avalara_sdk/api/A1099/V2/forms1099_api.rb +171 -87
- data/lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb +135 -176
- data/lib/avalara_sdk/api/A1099/V2/issuers1099_api.rb +103 -43
- data/lib/avalara_sdk/api/A1099/V2/jobs1099_api.rb +19 -7
- data/lib/avalara_sdk/api/EInvoicing/V1/data_input_fields_api.rb +6 -6
- data/lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb +4 -4
- data/lib/avalara_sdk/api/EInvoicing/V1/interop_api.rb +1 -1
- data/lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb +6 -6
- data/lib/avalara_sdk/api/EInvoicing/V1/subscriptions_api.rb +6 -6
- data/lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb +7 -7
- data/lib/avalara_sdk/models/A1099/V2/bulk_upsert1099_forms_request.rb +1 -0
- data/lib/avalara_sdk/models/A1099/V2/covered_individual_reference.rb +403 -0
- data/lib/avalara_sdk/models/A1099/V2/covered_individual_request.rb +378 -0
- data/lib/avalara_sdk/models/A1099/V2/form1095_b.rb +572 -0
- data/lib/avalara_sdk/models/A1099/V2/form1095_b_list.rb +238 -0
- data/lib/avalara_sdk/models/A1099/V2/form1095_b_list_item.rb +538 -0
- data/lib/avalara_sdk/models/A1099/V2/form1095_b_request.rb +559 -0
- data/lib/avalara_sdk/models/A1099/V2/form1099_base.rb +29 -29
- data/lib/avalara_sdk/models/A1099/V2/form1099_div_list_item.rb +78 -36
- data/lib/avalara_sdk/models/A1099/V2/form1099_div_request.rb +80 -53
- data/lib/avalara_sdk/models/A1099/V2/form1099_div_response.rb +600 -0
- data/lib/avalara_sdk/models/A1099/V2/form1099_k.rb +29 -29
- data/lib/avalara_sdk/models/A1099/V2/form1099_k_list_item.rb +56 -37
- data/lib/avalara_sdk/models/A1099/V2/form1099_k_request.rb +80 -54
- data/lib/avalara_sdk/models/A1099/V2/form1099_list.rb +1 -1
- data/lib/avalara_sdk/models/A1099/V2/form1099_list_data_inner.rb +20 -68
- data/lib/avalara_sdk/models/A1099/V2/form1099_misc.rb +29 -29
- data/lib/avalara_sdk/models/A1099/V2/form1099_misc_list_item.rb +78 -36
- data/lib/avalara_sdk/models/A1099/V2/form1099_misc_request.rb +80 -53
- data/lib/avalara_sdk/models/A1099/V2/form1099_misc_response.rb +744 -0
- data/lib/avalara_sdk/models/A1099/V2/form1099_nec.rb +29 -29
- data/lib/avalara_sdk/models/A1099/V2/form1099_nec_list_item.rb +78 -36
- data/lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb +80 -53
- data/lib/avalara_sdk/models/A1099/V2/form1099_nec_response.rb +636 -0
- data/lib/avalara_sdk/models/A1099/V2/form1099_r.rb +29 -29
- data/lib/avalara_sdk/models/A1099/V2/form1099_r_list_item.rb +56 -36
- data/lib/avalara_sdk/models/A1099/V2/form1099_r_request.rb +80 -53
- data/lib/avalara_sdk/models/A1099/V2/form_request_base.rb +68 -44
- data/lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb +475 -0
- data/lib/avalara_sdk/models/A1099/V2/form_response_base.rb +252 -31
- data/lib/avalara_sdk/models/A1099/V2/form_single_request_base.rb +80 -44
- data/lib/avalara_sdk/models/A1099/V2/get1099_form200_response.rb +104 -0
- data/lib/avalara_sdk/models/A1099/V2/included_base.rb +219 -0
- data/lib/avalara_sdk/models/A1099/V2/state_and_local_withholding_request.rb +1 -0
- data/lib/avalara_sdk/models/A1099/V2/state_and_local_withholding_response.rb +274 -0
- data/lib/avalara_sdk/models/A1099/V2/state_efile_status_detail_app.rb +231 -0
- data/lib/avalara_sdk/models/A1099/V2/status_detail.rb +221 -0
- data/lib/avalara_sdk/models/A1099/V2/update1099_form200_response.rb +103 -0
- data/lib/avalara_sdk/models/A1099/V2/validation_error_app.rb +229 -0
- data/lib/avalara_sdk/version.rb +1 -1
- data/lib/avalara_sdk.rb +17 -0
- data/spec/integration/a1099_spec.rb +12 -12
- 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 +36 -2
@@ -15,11 +15,11 @@ All URIs are relative to *https://api-ava1099.eta.sbx.us-east-1.aws.avalara.io/a
|
|
15
15
|
|
16
16
|
## bulk_upsert1099_forms
|
17
17
|
|
18
|
-
> <Form1099ProccessResult> bulk_upsert1099_forms(avalara_version,
|
18
|
+
> <Form1099ProccessResult> bulk_upsert1099_forms(avalara_version, opts)
|
19
19
|
|
20
20
|
Creates or updates multiple 1099 forms.
|
21
21
|
|
22
|
-
This endpoint allows you to create or update multiple 1099 forms. You can use one of the following payload structures: **Form 1099-MISC:** ```json { \"formType\": \"1099-MISC\", \"forms\": [ { \"IssuerId\": \"123456\", \"IssuerReferenceId\": \"REF123\", \"IssuerTin\": \"12-3456789\", \"TaxYear\": 2023, \"ReferenceId\": \"FORM123456\", \"RecipientName\": \"John Doe\", \"RecipientTin\": \"987-65-4321\", \"TinType\":
|
22
|
+
This endpoint allows you to create or update multiple 1099 forms. You can use one of the following payload structures: **Form 1099-MISC:** ```json { \"formType\": \"1099-MISC\", \"forms\": [ { \"IssuerId\": \"123456\", \"IssuerReferenceId\": \"REF123\", \"IssuerTin\": \"12-3456789\", \"TaxYear\": 2023, \"ReferenceId\": \"FORM123456\", \"RecipientName\": \"John Doe\", \"RecipientTin\": \"987-65-4321\", \"TinType\": \"IEN\", \"RecipientSecondName\": \"Jane Doe\", \"Address\": \"123 Main Street\", \"Address2\": \"Apt 4B\", \"City\": \"New York\", \"State\": \"NY\", \"Zip\": \"10001\", \"RecipientEmail\": \"john.doe@email.com\", \"AccountNumber\": \"ACC123456\", \"OfficeCode\": \"NYC01\", \"SecondTinNotice\": false, \"RecipientNonUsProvince\": \"\", \"CountryCode\": \"US\", \"Rents\": 12000.00, \"Royalties\": 5000.00, \"OtherIncome\": 3000.00, \"FishingBoatProceeds\": 0.00, \"MedicalHealthCarePayments\": 15000.00, \"SubstitutePayments\": 1000.00, \"CropInsuranceProceeds\": 0.00, \"GrossProceedsPaidToAttorney\": 7500.00, \"FishPurchasedForResale\": 0.00, \"FedIncomeTaxWithheld\": 5000.00, \"Section409ADeferrals\": 0.00, \"ExcessGoldenParachutePayments\": 0.00, \"NonqualifiedDeferredCompensation\": 0.00, \"PayerMadeDirectSales\": false, \"FatcaFilingRequirement\": false, \"StateAndLocalWithholding\": { \"StateTaxWithheld\": 2500.00, \"LocalTaxWithheld\": 1000.00, \"State\": \"NY\", \"StateIdNumber\": \"NY123456\", \"Locality\": \"New York City\", \"StateIncome\": 35000.00, \"LocalIncome\": 35000.00 } } ] } ``` **Form 1099-NEC:** ```json { \"formType\": \"1099-NEC\", \"forms\": [ { \"issuerID\": \"180337282\", \"issuerReferenceId\": \"ISS123\", \"issuerTin\": \"12-3000000\", \"taxYear\": 2024, \"referenceID\": \"REF-002\", \"recipientName\": \"Jane Smith\", \"recipientSecondName\": \"\", \"recipientTin\": \"987-65-4321\", \"tinType\": \"IEN\", \"address\": \"123 Center St\", \"address2\": \"\", \"city\": \"Santa Monica\", \"state\": \"CA\", \"zip\": \"90401\", \"countryCode\": \"US\", \"recipientNonUsProvince\": \"\", \"recipientEmail\": \"\", \"accountNumber\": \"\", \"officeCode\": \"\", \"secondTinNotice\": false, \"nonemployeeCompensation\": 123.45, \"payerMadeDirectSales\": false, \"federalIncomeTaxWithheld\": 12.34, \"stateAndLocalWithholding\": { \"state\": \"CA\", \"stateIdNumber\": \"123123123\" \"stateIncome\": 123.45, \"stateTaxWithheld\": 12.34, \"locality\": \"Santa Monica\", \"localityIdNumber\": \"456456\", \"localTaxWithheld\": 12.34 \"localIncome\": 50000.00 }, \"federalEFile\": true, \"postalMail\": true, \"stateEFile\": true, \"tinMatch\": true, \"addressVerification\": true } ] } ``` For the full version of the payload and its schema details, refer to the Swagger schemas section.
|
23
23
|
|
24
24
|
### Examples
|
25
25
|
|
@@ -40,15 +40,16 @@ api_client = AvalaraSdk::ApiClient.new config
|
|
40
40
|
api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client
|
41
41
|
|
42
42
|
avalara_version = '2.0' # String | API version
|
43
|
-
x_correlation_id = '1ded0db3-4f25-4b15-b159-6d1467e6faac' # String | Unique correlation Id in a GUID format
|
44
43
|
opts = {
|
45
44
|
dry_run: true, # Boolean |
|
46
|
-
|
45
|
+
x_correlation_id: '95fa50ea-1ba2-4a11-a3e7-47cd309c14d9', # 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
|
+
bulk_upsert1099_forms_request: AvalaraSdk::A1099::V2::Form1095BList.new # BulkUpsert1099FormsRequest |
|
47
48
|
}
|
48
49
|
|
49
50
|
begin
|
50
51
|
# Creates or updates multiple 1099 forms.
|
51
|
-
result = api_instance.bulk_upsert1099_forms(avalara_version,
|
52
|
+
result = api_instance.bulk_upsert1099_forms(avalara_version, opts)
|
52
53
|
p result
|
53
54
|
rescue AvalaraSdk::ApiError => e
|
54
55
|
puts "Error when calling Forms1099Api->bulk_upsert1099_forms: #{e}"
|
@@ -59,12 +60,12 @@ end
|
|
59
60
|
|
60
61
|
This returns an Array which contains the response data, status code and headers.
|
61
62
|
|
62
|
-
> <Array(<Form1099ProccessResult>, Integer, Hash)> bulk_upsert1099_forms_with_http_info(avalara_version,
|
63
|
+
> <Array(<Form1099ProccessResult>, Integer, Hash)> bulk_upsert1099_forms_with_http_info(avalara_version, opts)
|
63
64
|
|
64
65
|
```ruby
|
65
66
|
begin
|
66
67
|
# Creates or updates multiple 1099 forms.
|
67
|
-
data, status_code, headers = api_instance.bulk_upsert1099_forms_with_http_info(avalara_version,
|
68
|
+
data, status_code, headers = api_instance.bulk_upsert1099_forms_with_http_info(avalara_version, opts)
|
68
69
|
p status_code # => 2xx
|
69
70
|
p headers # => { ... }
|
70
71
|
p data # => <Form1099ProccessResult>
|
@@ -78,8 +79,9 @@ end
|
|
78
79
|
| Name | Type | Description | Notes |
|
79
80
|
| ---- | ---- | ----------- | ----- |
|
80
81
|
| **avalara_version** | **String** | API version | |
|
81
|
-
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format | |
|
82
82
|
| **dry_run** | **Boolean** | | [optional][default to false] |
|
83
|
+
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
|
84
|
+
| **x_avalara_client** | **String** | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] |
|
83
85
|
| **bulk_upsert1099_forms_request** | [**BulkUpsert1099FormsRequest**](BulkUpsert1099FormsRequest.md) | | [optional] |
|
84
86
|
|
85
87
|
### Return type
|
@@ -98,7 +100,7 @@ end
|
|
98
100
|
|
99
101
|
## create1099_form
|
100
102
|
|
101
|
-
> <
|
103
|
+
> <Get1099Form200Response> create1099_form(avalara_version, opts)
|
102
104
|
|
103
105
|
Creates a 1099 form.
|
104
106
|
|
@@ -121,14 +123,15 @@ api_client = AvalaraSdk::ApiClient.new config
|
|
121
123
|
api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client
|
122
124
|
|
123
125
|
avalara_version = '2.0' # String | API version
|
124
|
-
x_correlation_id = '35eadeb5-51d8-4eb3-9442-90086637d517' # String | Unique correlation Id in a GUID format
|
125
126
|
opts = {
|
127
|
+
x_correlation_id: 'c8ea4e75-f9cd-4eee-979f-d57eee50d8f9', # String | Unique correlation Id in a GUID format
|
128
|
+
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/) .
|
126
129
|
i_create_form1099_request: AvalaraSdk::A1099::V2::Form1099DivRequest.new # ICreateForm1099Request |
|
127
130
|
}
|
128
131
|
|
129
132
|
begin
|
130
133
|
# Creates a 1099 form.
|
131
|
-
result = api_instance.create1099_form(avalara_version,
|
134
|
+
result = api_instance.create1099_form(avalara_version, opts)
|
132
135
|
p result
|
133
136
|
rescue AvalaraSdk::ApiError => e
|
134
137
|
puts "Error when calling Forms1099Api->create1099_form: #{e}"
|
@@ -139,15 +142,15 @@ end
|
|
139
142
|
|
140
143
|
This returns an Array which contains the response data, status code and headers.
|
141
144
|
|
142
|
-
> <Array(<
|
145
|
+
> <Array(<Get1099Form200Response>, Integer, Hash)> create1099_form_with_http_info(avalara_version, opts)
|
143
146
|
|
144
147
|
```ruby
|
145
148
|
begin
|
146
149
|
# Creates a 1099 form.
|
147
|
-
data, status_code, headers = api_instance.create1099_form_with_http_info(avalara_version,
|
150
|
+
data, status_code, headers = api_instance.create1099_form_with_http_info(avalara_version, opts)
|
148
151
|
p status_code # => 2xx
|
149
152
|
p headers # => { ... }
|
150
|
-
p data # => <
|
153
|
+
p data # => <Get1099Form200Response>
|
151
154
|
rescue AvalaraSdk::A1099::V2::ApiError => e
|
152
155
|
puts "Error when calling Forms1099Api->create1099_form_with_http_info: #{e}"
|
153
156
|
end
|
@@ -158,12 +161,13 @@ end
|
|
158
161
|
| Name | Type | Description | Notes |
|
159
162
|
| ---- | ---- | ----------- | ----- |
|
160
163
|
| **avalara_version** | **String** | API version | |
|
161
|
-
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format |
|
164
|
+
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
|
165
|
+
| **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] |
|
162
166
|
| **i_create_form1099_request** | [**ICreateForm1099Request**](ICreateForm1099Request.md) | | [optional] |
|
163
167
|
|
164
168
|
### Return type
|
165
169
|
|
166
|
-
[**
|
170
|
+
[**Get1099Form200Response**](Get1099Form200Response.md)
|
167
171
|
|
168
172
|
### Authorization
|
169
173
|
|
@@ -177,7 +181,7 @@ end
|
|
177
181
|
|
178
182
|
## delete1099_form
|
179
183
|
|
180
|
-
> delete1099_form(id, avalara_version,
|
184
|
+
> delete1099_form(id, avalara_version, opts)
|
181
185
|
|
182
186
|
Deletes a 1099 form.
|
183
187
|
|
@@ -201,11 +205,14 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client
|
|
201
205
|
|
202
206
|
id = 'id_example' # String | The unique identifier of the desired form to delete.
|
203
207
|
avalara_version = '2.0' # String | API version
|
204
|
-
|
208
|
+
opts = {
|
209
|
+
x_correlation_id: '5b974ae0-afd8-465b-9e50-44eba5e11a4a', # String | Unique correlation Id in a GUID format
|
210
|
+
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/) .
|
211
|
+
}
|
205
212
|
|
206
213
|
begin
|
207
214
|
# Deletes a 1099 form.
|
208
|
-
api_instance.delete1099_form(id, avalara_version,
|
215
|
+
api_instance.delete1099_form(id, avalara_version, opts)
|
209
216
|
rescue AvalaraSdk::ApiError => e
|
210
217
|
puts "Error when calling Forms1099Api->delete1099_form: #{e}"
|
211
218
|
end
|
@@ -215,12 +222,12 @@ end
|
|
215
222
|
|
216
223
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
217
224
|
|
218
|
-
> <Array(nil, Integer, Hash)> delete1099_form_with_http_info(id, avalara_version,
|
225
|
+
> <Array(nil, Integer, Hash)> delete1099_form_with_http_info(id, avalara_version, opts)
|
219
226
|
|
220
227
|
```ruby
|
221
228
|
begin
|
222
229
|
# Deletes a 1099 form.
|
223
|
-
data, status_code, headers = api_instance.delete1099_form_with_http_info(id, avalara_version,
|
230
|
+
data, status_code, headers = api_instance.delete1099_form_with_http_info(id, avalara_version, opts)
|
224
231
|
p status_code # => 2xx
|
225
232
|
p headers # => { ... }
|
226
233
|
p data # => nil
|
@@ -235,7 +242,8 @@ end
|
|
235
242
|
| ---- | ---- | ----------- | ----- |
|
236
243
|
| **id** | **String** | The unique identifier of the desired form to delete. | |
|
237
244
|
| **avalara_version** | **String** | API version | |
|
238
|
-
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format |
|
245
|
+
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
|
246
|
+
| **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] |
|
239
247
|
|
240
248
|
### Return type
|
241
249
|
|
@@ -253,7 +261,7 @@ nil (empty response body)
|
|
253
261
|
|
254
262
|
## get1099_form
|
255
263
|
|
256
|
-
> <
|
264
|
+
> <Get1099Form200Response> get1099_form(id, avalara_version, opts)
|
257
265
|
|
258
266
|
Retrieves a 1099 form.
|
259
267
|
|
@@ -277,11 +285,14 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client
|
|
277
285
|
|
278
286
|
id = 'id_example' # String |
|
279
287
|
avalara_version = '2.0' # String | API version
|
280
|
-
|
288
|
+
opts = {
|
289
|
+
x_correlation_id: '0337ca27-1eff-4369-9488-3381cd275131', # String | Unique correlation Id in a GUID format
|
290
|
+
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/) .
|
291
|
+
}
|
281
292
|
|
282
293
|
begin
|
283
294
|
# Retrieves a 1099 form.
|
284
|
-
result = api_instance.get1099_form(id, avalara_version,
|
295
|
+
result = api_instance.get1099_form(id, avalara_version, opts)
|
285
296
|
p result
|
286
297
|
rescue AvalaraSdk::ApiError => e
|
287
298
|
puts "Error when calling Forms1099Api->get1099_form: #{e}"
|
@@ -292,15 +303,15 @@ end
|
|
292
303
|
|
293
304
|
This returns an Array which contains the response data, status code and headers.
|
294
305
|
|
295
|
-
> <Array(<
|
306
|
+
> <Array(<Get1099Form200Response>, Integer, Hash)> get1099_form_with_http_info(id, avalara_version, opts)
|
296
307
|
|
297
308
|
```ruby
|
298
309
|
begin
|
299
310
|
# Retrieves a 1099 form.
|
300
|
-
data, status_code, headers = api_instance.get1099_form_with_http_info(id, avalara_version,
|
311
|
+
data, status_code, headers = api_instance.get1099_form_with_http_info(id, avalara_version, opts)
|
301
312
|
p status_code # => 2xx
|
302
313
|
p headers # => { ... }
|
303
|
-
p data # => <
|
314
|
+
p data # => <Get1099Form200Response>
|
304
315
|
rescue AvalaraSdk::A1099::V2::ApiError => e
|
305
316
|
puts "Error when calling Forms1099Api->get1099_form_with_http_info: #{e}"
|
306
317
|
end
|
@@ -312,11 +323,12 @@ end
|
|
312
323
|
| ---- | ---- | ----------- | ----- |
|
313
324
|
| **id** | **String** | | |
|
314
325
|
| **avalara_version** | **String** | API version | |
|
315
|
-
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format |
|
326
|
+
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
|
327
|
+
| **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] |
|
316
328
|
|
317
329
|
### Return type
|
318
330
|
|
319
|
-
[**
|
331
|
+
[**Get1099Form200Response**](Get1099Form200Response.md)
|
320
332
|
|
321
333
|
### Authorization
|
322
334
|
|
@@ -330,7 +342,7 @@ end
|
|
330
342
|
|
331
343
|
## get1099_form_pdf
|
332
344
|
|
333
|
-
> <
|
345
|
+
> <Update1099Form200Response> get1099_form_pdf(id, avalara_version, opts)
|
334
346
|
|
335
347
|
Retrieves the PDF file for a single 1099 by form id.
|
336
348
|
|
@@ -354,14 +366,15 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client
|
|
354
366
|
|
355
367
|
id = 'id_example' # String |
|
356
368
|
avalara_version = '2.0' # String | API version
|
357
|
-
x_correlation_id = '314852b3-0f9f-42c3-aafe-f294a7c7fe12' # String | Unique correlation Id in a GUID format
|
358
369
|
opts = {
|
359
|
-
mark_edelivered: true # Boolean | The parameter for marked e-delivered
|
370
|
+
mark_edelivered: true, # Boolean | The parameter for marked e-delivered
|
371
|
+
x_correlation_id: '83662dec-e0b1-4251-9556-8f08cdc28490', # String | Unique correlation Id in a GUID format
|
372
|
+
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/) .
|
360
373
|
}
|
361
374
|
|
362
375
|
begin
|
363
376
|
# Retrieves the PDF file for a single 1099 by form id.
|
364
|
-
result = api_instance.get1099_form_pdf(id, avalara_version,
|
377
|
+
result = api_instance.get1099_form_pdf(id, avalara_version, opts)
|
365
378
|
p result
|
366
379
|
rescue AvalaraSdk::ApiError => e
|
367
380
|
puts "Error when calling Forms1099Api->get1099_form_pdf: #{e}"
|
@@ -372,15 +385,15 @@ end
|
|
372
385
|
|
373
386
|
This returns an Array which contains the response data, status code and headers.
|
374
387
|
|
375
|
-
> <Array(<
|
388
|
+
> <Array(<Update1099Form200Response>, Integer, Hash)> get1099_form_pdf_with_http_info(id, avalara_version, opts)
|
376
389
|
|
377
390
|
```ruby
|
378
391
|
begin
|
379
392
|
# Retrieves the PDF file for a single 1099 by form id.
|
380
|
-
data, status_code, headers = api_instance.get1099_form_pdf_with_http_info(id, avalara_version,
|
393
|
+
data, status_code, headers = api_instance.get1099_form_pdf_with_http_info(id, avalara_version, opts)
|
381
394
|
p status_code # => 2xx
|
382
395
|
p headers # => { ... }
|
383
|
-
p data # => <
|
396
|
+
p data # => <Update1099Form200Response>
|
384
397
|
rescue AvalaraSdk::A1099::V2::ApiError => e
|
385
398
|
puts "Error when calling Forms1099Api->get1099_form_pdf_with_http_info: #{e}"
|
386
399
|
end
|
@@ -392,12 +405,13 @@ end
|
|
392
405
|
| ---- | ---- | ----------- | ----- |
|
393
406
|
| **id** | **String** | | |
|
394
407
|
| **avalara_version** | **String** | API version | |
|
395
|
-
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format | |
|
396
408
|
| **mark_edelivered** | **Boolean** | The parameter for marked e-delivered | [optional] |
|
409
|
+
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
|
410
|
+
| **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] |
|
397
411
|
|
398
412
|
### Return type
|
399
413
|
|
400
|
-
[**
|
414
|
+
[**Update1099Form200Response**](Update1099Form200Response.md)
|
401
415
|
|
402
416
|
### Authorization
|
403
417
|
|
@@ -411,7 +425,7 @@ end
|
|
411
425
|
|
412
426
|
## list1099_forms
|
413
427
|
|
414
|
-
> <Form1099List> list1099_forms(avalara_version,
|
428
|
+
> <Form1099List> list1099_forms(avalara_version, opts)
|
415
429
|
|
416
430
|
Retrieves a list of 1099 forms based on query parameters.
|
417
431
|
|
@@ -434,17 +448,18 @@ api_client = AvalaraSdk::ApiClient.new config
|
|
434
448
|
api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client
|
435
449
|
|
436
450
|
avalara_version = '2.0' # String | API version
|
437
|
-
x_correlation_id = 'f37c790b-837b-4b6e-b884-0c0f7aae2ea8' # String | Unique correlation Id in a GUID format
|
438
451
|
opts = {
|
439
|
-
filter: 'filter_example', # String | A filter statement to identify specific records to retrieve. For more information on filtering, see <a href=\"https://developer.avalara.com/avatax/filtering-in-rest/\">Filtering in REST</a>. Collections support filtering only on certain fields. An attempt to filter on an unsupported field will receive a 400 Bad Request response. Supported filtering fields are as follows: issuerId issuerReferenceId taxYear addressVerificationStatus - possible values are: unknown, pending, failed, incomplete, unchanged, verified createdAt edeliveryStatus - possible values are: sent, unscheduled, bad_verify, bad_verify_limit, scheduled, bounced, accepted email federalEfileStatus - possible values are: unscheduled, scheduled, sent, corrected_scheduled, accepted, corrected, corrected_accepted, held
|
452
|
+
filter: 'filter_example', # String | A filter statement to identify specific records to retrieve. For more information on filtering, see <a href=\"https://developer.avalara.com/avatax/filtering-in-rest/\">Filtering in REST</a>. Collections support filtering only on certain fields. An attempt to filter on an unsupported field will receive a 400 Bad Request response. Supported filtering fields are as follows: issuerId issuerReferenceId taxYear addressVerificationStatus - possible values are: unknown, pending, failed, incomplete, unchanged, verified createdAt edeliveryStatus - possible values are: sent, unscheduled, bad_verify, bad_verify_limit, scheduled, bounced, accepted email federalEfileStatus - possible values are: unscheduled, scheduled, sent, corrected_scheduled, accepted, corrected, corrected_accepted, held recipientName mailStatus - possible values are: sent, unscheduled, pending, delivered referenceId tinMatchStatus - possible values are: none, pending, matched, failed type - possible values are: 940, 941, 943, 944, 945, 1042, 1042-S, 1095-B, 1095-C, 1097-BTC, 1098, 1098-C, 1098-E, 1098-Q, 1098-T, 3921, 3922, 5498, 5498-ESA, 5498-SA, 1099-MISC, 1099-A, 1099-B, 1099-C, 1099-CAP, 1099-DIV, 1099-G, 1099-INT, 1099-K, 1099-LS, 1099-LTC, 1099-NEC, 1099-OID, 1099-PATR, 1099-Q, 1099-R, 1099-S, 1099-SA, T4A, W-2, W-2G, 1099-HC updatedAt validity - possible values are: true, false
|
440
453
|
top: 56, # Integer | If nonzero, return no more than this number of results. Used with skip to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
|
441
454
|
skip: 56, # Integer | If nonzero, skip this number of results before returning data. Used with top to provide pagination for large datasets.
|
442
|
-
order_by: 'order_by_example' # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example issuerReferenceId ASC. Supported sorting fields are: issuerReferenceId taxYear createdAt
|
455
|
+
order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example issuerReferenceId ASC. Supported sorting fields are: issuerReferenceId taxYear createdAt recipientName updatedAt
|
456
|
+
x_correlation_id: '387dd228-efc0-4cec-80eb-230109b14a83', # String | Unique correlation Id in a GUID format
|
457
|
+
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/) .
|
443
458
|
}
|
444
459
|
|
445
460
|
begin
|
446
461
|
# Retrieves a list of 1099 forms based on query parameters.
|
447
|
-
result = api_instance.list1099_forms(avalara_version,
|
462
|
+
result = api_instance.list1099_forms(avalara_version, opts)
|
448
463
|
p result
|
449
464
|
rescue AvalaraSdk::ApiError => e
|
450
465
|
puts "Error when calling Forms1099Api->list1099_forms: #{e}"
|
@@ -455,12 +470,12 @@ end
|
|
455
470
|
|
456
471
|
This returns an Array which contains the response data, status code and headers.
|
457
472
|
|
458
|
-
> <Array(<Form1099List>, Integer, Hash)> list1099_forms_with_http_info(avalara_version,
|
473
|
+
> <Array(<Form1099List>, Integer, Hash)> list1099_forms_with_http_info(avalara_version, opts)
|
459
474
|
|
460
475
|
```ruby
|
461
476
|
begin
|
462
477
|
# Retrieves a list of 1099 forms based on query parameters.
|
463
|
-
data, status_code, headers = api_instance.list1099_forms_with_http_info(avalara_version,
|
478
|
+
data, status_code, headers = api_instance.list1099_forms_with_http_info(avalara_version, opts)
|
464
479
|
p status_code # => 2xx
|
465
480
|
p headers # => { ... }
|
466
481
|
p data # => <Form1099List>
|
@@ -474,11 +489,12 @@ end
|
|
474
489
|
| Name | Type | Description | Notes |
|
475
490
|
| ---- | ---- | ----------- | ----- |
|
476
491
|
| **avalara_version** | **String** | API version | |
|
477
|
-
| **
|
478
|
-
| **filter** | **String** | A filter statement to identify specific records to retrieve. For more information on filtering, see <a href=\"https://developer.avalara.com/avatax/filtering-in-rest/\">Filtering in REST</a>. Collections support filtering only on certain fields. An attempt to filter on an unsupported field will receive a 400 Bad Request response. Supported filtering fields are as follows: issuerId issuerReferenceId taxYear addressVerificationStatus - possible values are: unknown, pending, failed, incomplete, unchanged, verified createdAt edeliveryStatus - possible values are: sent, unscheduled, bad_verify, bad_verify_limit, scheduled, bounced, accepted email federalEfileStatus - possible values are: unscheduled, scheduled, sent, corrected_scheduled, accepted, corrected, corrected_accepted, held firstPayeeName mailStatus - possible values are: sent, unscheduled, pending, delivered referenceId tinMatchStatus - possible values are: none, pending, matched, failed type - possible values are: 940, 941, 943, 944, 945, 1042, 1042-S, 1095-B, 1095-C, 1097-BTC, 1098, 1098-C, 1098-E, 1098-Q, 1098-T, 3921, 3922, 5498, 5498-ESA, 5498-SA, 1099-MISC, 1099-A, 1099-B, 1099-C, 1099-CAP, 1099-DIV, 1099-G, 1099-INT, 1099-K, 1099-LS, 1099-LTC, 1099-NEC, 1099-OID, 1099-PATR, 1099-Q, 1099-R, 1099-S, 1099-SA, T4A, W-2, W-2G, 1099-HC updatedAt validity - possible values are: true, false | [optional] |
|
492
|
+
| **filter** | **String** | A filter statement to identify specific records to retrieve. For more information on filtering, see <a href=\"https://developer.avalara.com/avatax/filtering-in-rest/\">Filtering in REST</a>. Collections support filtering only on certain fields. An attempt to filter on an unsupported field will receive a 400 Bad Request response. Supported filtering fields are as follows: issuerId issuerReferenceId taxYear addressVerificationStatus - possible values are: unknown, pending, failed, incomplete, unchanged, verified createdAt edeliveryStatus - possible values are: sent, unscheduled, bad_verify, bad_verify_limit, scheduled, bounced, accepted email federalEfileStatus - possible values are: unscheduled, scheduled, sent, corrected_scheduled, accepted, corrected, corrected_accepted, held recipientName mailStatus - possible values are: sent, unscheduled, pending, delivered referenceId tinMatchStatus - possible values are: none, pending, matched, failed type - possible values are: 940, 941, 943, 944, 945, 1042, 1042-S, 1095-B, 1095-C, 1097-BTC, 1098, 1098-C, 1098-E, 1098-Q, 1098-T, 3921, 3922, 5498, 5498-ESA, 5498-SA, 1099-MISC, 1099-A, 1099-B, 1099-C, 1099-CAP, 1099-DIV, 1099-G, 1099-INT, 1099-K, 1099-LS, 1099-LTC, 1099-NEC, 1099-OID, 1099-PATR, 1099-Q, 1099-R, 1099-S, 1099-SA, T4A, W-2, W-2G, 1099-HC updatedAt validity - possible values are: true, false | [optional] |
|
479
493
|
| **top** | **Integer** | If nonzero, return no more than this number of results. Used with skip to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. | [optional][default to 10] |
|
480
494
|
| **skip** | **Integer** | If nonzero, skip this number of results before returning data. Used with top to provide pagination for large datasets. | [optional][default to 0] |
|
481
|
-
| **order_by** | **String** | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example issuerReferenceId ASC. Supported sorting fields are: issuerReferenceId taxYear createdAt
|
495
|
+
| **order_by** | **String** | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example issuerReferenceId ASC. Supported sorting fields are: issuerReferenceId taxYear createdAt recipientName updatedAt | [optional] |
|
496
|
+
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
|
497
|
+
| **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] |
|
482
498
|
|
483
499
|
### Return type
|
484
500
|
|
@@ -496,7 +512,7 @@ end
|
|
496
512
|
|
497
513
|
## update1099_form
|
498
514
|
|
499
|
-
> <
|
515
|
+
> <Update1099Form200Response> update1099_form(id, avalara_version, opts)
|
500
516
|
|
501
517
|
Updates a 1099 form.
|
502
518
|
|
@@ -520,14 +536,15 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client
|
|
520
536
|
|
521
537
|
id = 'id_example' # String |
|
522
538
|
avalara_version = '2.0' # String | API version
|
523
|
-
x_correlation_id = 'fb554f8c-95f6-4194-9043-900ae946030c' # String | Unique correlation Id in a GUID format
|
524
539
|
opts = {
|
540
|
+
x_correlation_id: '9d27c50f-0017-4ebb-ab34-d1e3131d5775', # String | Unique correlation Id in a GUID format
|
541
|
+
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/) .
|
525
542
|
i_update_form1099_request: AvalaraSdk::A1099::V2::Form1099DivRequest.new # IUpdateForm1099Request |
|
526
543
|
}
|
527
544
|
|
528
545
|
begin
|
529
546
|
# Updates a 1099 form.
|
530
|
-
result = api_instance.update1099_form(id, avalara_version,
|
547
|
+
result = api_instance.update1099_form(id, avalara_version, opts)
|
531
548
|
p result
|
532
549
|
rescue AvalaraSdk::ApiError => e
|
533
550
|
puts "Error when calling Forms1099Api->update1099_form: #{e}"
|
@@ -538,15 +555,15 @@ end
|
|
538
555
|
|
539
556
|
This returns an Array which contains the response data, status code and headers.
|
540
557
|
|
541
|
-
> <Array(<
|
558
|
+
> <Array(<Update1099Form200Response>, Integer, Hash)> update1099_form_with_http_info(id, avalara_version, opts)
|
542
559
|
|
543
560
|
```ruby
|
544
561
|
begin
|
545
562
|
# Updates a 1099 form.
|
546
|
-
data, status_code, headers = api_instance.update1099_form_with_http_info(id, avalara_version,
|
563
|
+
data, status_code, headers = api_instance.update1099_form_with_http_info(id, avalara_version, opts)
|
547
564
|
p status_code # => 2xx
|
548
565
|
p headers # => { ... }
|
549
|
-
p data # => <
|
566
|
+
p data # => <Update1099Form200Response>
|
550
567
|
rescue AvalaraSdk::A1099::V2::ApiError => e
|
551
568
|
puts "Error when calling Forms1099Api->update1099_form_with_http_info: #{e}"
|
552
569
|
end
|
@@ -558,12 +575,13 @@ end
|
|
558
575
|
| ---- | ---- | ----------- | ----- |
|
559
576
|
| **id** | **String** | | |
|
560
577
|
| **avalara_version** | **String** | API version | |
|
561
|
-
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format |
|
578
|
+
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
|
579
|
+
| **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] |
|
562
580
|
| **i_update_form1099_request** | [**IUpdateForm1099Request**](IUpdateForm1099Request.md) | | [optional] |
|
563
581
|
|
564
582
|
### Return type
|
565
583
|
|
566
|
-
[**
|
584
|
+
[**Update1099Form200Response**](Update1099Form200Response.md)
|
567
585
|
|
568
586
|
### Authorization
|
569
587
|
|