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
@@ -13,7 +13,7 @@ All URIs are relative to *https://api-ava1099.eta.sbx.us-east-1.aws.avalara.io/a
|
|
13
13
|
|
14
14
|
## create_issuer
|
15
15
|
|
16
|
-
> <IssuerResponse> create_issuer(avalara_version,
|
16
|
+
> <IssuerResponse> create_issuer(avalara_version, opts)
|
17
17
|
|
18
18
|
Create an issuer
|
19
19
|
|
@@ -38,14 +38,15 @@ api_client = AvalaraSdk::ApiClient.new config
|
|
38
38
|
api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
|
39
39
|
|
40
40
|
avalara_version = '2.0' # String | API version
|
41
|
-
x_correlation_id = 'bb3c3258-4a6e-4dc8-a958-a699cfb3772e' # String | Unique correlation Id in a GUID format
|
42
41
|
opts = {
|
42
|
+
x_correlation_id: 'c01c4ae6-a456-4171-9542-d2bea749dfd3', # String | Unique correlation Id in a GUID format
|
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/) .
|
43
44
|
issuer_command: AvalaraSdk::A1099::V2::IssuerCommand.new # IssuerCommand | The issuer to create
|
44
45
|
}
|
45
46
|
|
46
47
|
begin
|
47
48
|
# Create an issuer
|
48
|
-
result = api_instance.create_issuer(avalara_version,
|
49
|
+
result = api_instance.create_issuer(avalara_version, opts)
|
49
50
|
p result
|
50
51
|
rescue AvalaraSdk::ApiError => e
|
51
52
|
puts "Error when calling Issuers1099Api->create_issuer: #{e}"
|
@@ -56,12 +57,12 @@ end
|
|
56
57
|
|
57
58
|
This returns an Array which contains the response data, status code and headers.
|
58
59
|
|
59
|
-
> <Array(<IssuerResponse>, Integer, Hash)> create_issuer_with_http_info(avalara_version,
|
60
|
+
> <Array(<IssuerResponse>, Integer, Hash)> create_issuer_with_http_info(avalara_version, opts)
|
60
61
|
|
61
62
|
```ruby
|
62
63
|
begin
|
63
64
|
# Create an issuer
|
64
|
-
data, status_code, headers = api_instance.create_issuer_with_http_info(avalara_version,
|
65
|
+
data, status_code, headers = api_instance.create_issuer_with_http_info(avalara_version, opts)
|
65
66
|
p status_code # => 2xx
|
66
67
|
p headers # => { ... }
|
67
68
|
p data # => <IssuerResponse>
|
@@ -75,7 +76,8 @@ end
|
|
75
76
|
| Name | Type | Description | Notes |
|
76
77
|
| ---- | ---- | ----------- | ----- |
|
77
78
|
| **avalara_version** | **String** | API version | |
|
78
|
-
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format |
|
79
|
+
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
|
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] |
|
79
81
|
| **issuer_command** | [**IssuerCommand**](IssuerCommand.md) | The issuer to create | [optional] |
|
80
82
|
|
81
83
|
### Return type
|
@@ -94,7 +96,7 @@ end
|
|
94
96
|
|
95
97
|
## delete_issuer
|
96
98
|
|
97
|
-
> delete_issuer(id, avalara_version,
|
99
|
+
> delete_issuer(id, avalara_version, opts)
|
98
100
|
|
99
101
|
Delete an issuer
|
100
102
|
|
@@ -120,11 +122,14 @@ api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
|
|
120
122
|
|
121
123
|
id = 'id_example' # String | Id of the issuer to delete
|
122
124
|
avalara_version = '2.0' # String | API version
|
123
|
-
|
125
|
+
opts = {
|
126
|
+
x_correlation_id: 'a4cf1c4a-aba2-423e-b795-4f3b1aee3b0f', # String | Unique correlation Id in a GUID format
|
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
|
+
}
|
124
129
|
|
125
130
|
begin
|
126
131
|
# Delete an issuer
|
127
|
-
api_instance.delete_issuer(id, avalara_version,
|
132
|
+
api_instance.delete_issuer(id, avalara_version, opts)
|
128
133
|
rescue AvalaraSdk::ApiError => e
|
129
134
|
puts "Error when calling Issuers1099Api->delete_issuer: #{e}"
|
130
135
|
end
|
@@ -134,12 +139,12 @@ end
|
|
134
139
|
|
135
140
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
136
141
|
|
137
|
-
> <Array(nil, Integer, Hash)> delete_issuer_with_http_info(id, avalara_version,
|
142
|
+
> <Array(nil, Integer, Hash)> delete_issuer_with_http_info(id, avalara_version, opts)
|
138
143
|
|
139
144
|
```ruby
|
140
145
|
begin
|
141
146
|
# Delete an issuer
|
142
|
-
data, status_code, headers = api_instance.delete_issuer_with_http_info(id, avalara_version,
|
147
|
+
data, status_code, headers = api_instance.delete_issuer_with_http_info(id, avalara_version, opts)
|
143
148
|
p status_code # => 2xx
|
144
149
|
p headers # => { ... }
|
145
150
|
p data # => nil
|
@@ -154,7 +159,8 @@ end
|
|
154
159
|
| ---- | ---- | ----------- | ----- |
|
155
160
|
| **id** | **String** | Id of the issuer to delete | |
|
156
161
|
| **avalara_version** | **String** | API version | |
|
157
|
-
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format |
|
162
|
+
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
|
163
|
+
| **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] |
|
158
164
|
|
159
165
|
### Return type
|
160
166
|
|
@@ -172,7 +178,7 @@ nil (empty response body)
|
|
172
178
|
|
173
179
|
## get_issuer
|
174
180
|
|
175
|
-
> <IssuerResponse> get_issuer(id, avalara_version,
|
181
|
+
> <IssuerResponse> get_issuer(id, avalara_version, opts)
|
176
182
|
|
177
183
|
Get an issuer
|
178
184
|
|
@@ -198,11 +204,14 @@ api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
|
|
198
204
|
|
199
205
|
id = 'id_example' # String |
|
200
206
|
avalara_version = '2.0' # String | API version
|
201
|
-
|
207
|
+
opts = {
|
208
|
+
x_correlation_id: '7c125802-46dd-4703-a670-67a4a171b042', # String | Unique correlation Id in a GUID format
|
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
|
+
}
|
202
211
|
|
203
212
|
begin
|
204
213
|
# Get an issuer
|
205
|
-
result = api_instance.get_issuer(id, avalara_version,
|
214
|
+
result = api_instance.get_issuer(id, avalara_version, opts)
|
206
215
|
p result
|
207
216
|
rescue AvalaraSdk::ApiError => e
|
208
217
|
puts "Error when calling Issuers1099Api->get_issuer: #{e}"
|
@@ -213,12 +222,12 @@ end
|
|
213
222
|
|
214
223
|
This returns an Array which contains the response data, status code and headers.
|
215
224
|
|
216
|
-
> <Array(<IssuerResponse>, Integer, Hash)> get_issuer_with_http_info(id, avalara_version,
|
225
|
+
> <Array(<IssuerResponse>, Integer, Hash)> get_issuer_with_http_info(id, avalara_version, opts)
|
217
226
|
|
218
227
|
```ruby
|
219
228
|
begin
|
220
229
|
# Get an issuer
|
221
|
-
data, status_code, headers = api_instance.get_issuer_with_http_info(id, avalara_version,
|
230
|
+
data, status_code, headers = api_instance.get_issuer_with_http_info(id, avalara_version, opts)
|
222
231
|
p status_code # => 2xx
|
223
232
|
p headers # => { ... }
|
224
233
|
p data # => <IssuerResponse>
|
@@ -233,7 +242,8 @@ end
|
|
233
242
|
| ---- | ---- | ----------- | ----- |
|
234
243
|
| **id** | **String** | | |
|
235
244
|
| **avalara_version** | **String** | API version | |
|
236
|
-
| **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] |
|
237
247
|
|
238
248
|
### Return type
|
239
249
|
|
@@ -251,7 +261,7 @@ end
|
|
251
261
|
|
252
262
|
## get_issuers
|
253
263
|
|
254
|
-
> <PaginatedQueryResultModelIssuerResponse> get_issuers(avalara_version,
|
264
|
+
> <PaginatedQueryResultModelIssuerResponse> get_issuers(avalara_version, opts)
|
255
265
|
|
256
266
|
List issuers
|
257
267
|
|
@@ -276,19 +286,20 @@ api_client = AvalaraSdk::ApiClient.new config
|
|
276
286
|
api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
|
277
287
|
|
278
288
|
avalara_version = '2.0' # String | API version
|
279
|
-
x_correlation_id = 'a48293cc-19f2-4971-9fde-c856cc131200' # String | Unique correlation Id in a GUID format
|
280
289
|
opts = {
|
281
290
|
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>.
|
282
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.
|
283
292
|
skip: 56, # Integer | If nonzero, skip this number of results before returning data. Used with top to provide pagination for large datasets.
|
284
293
|
order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.
|
285
294
|
count: true, # Boolean | If true, return the global count of elements in the collection.
|
286
|
-
count_only: true # Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true.
|
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: '82a4cc41-cbb7-4b0d-9385-c4cd9c6d087f', # String | Unique correlation Id in a GUID format
|
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/) .
|
287
298
|
}
|
288
299
|
|
289
300
|
begin
|
290
301
|
# List issuers
|
291
|
-
result = api_instance.get_issuers(avalara_version,
|
302
|
+
result = api_instance.get_issuers(avalara_version, opts)
|
292
303
|
p result
|
293
304
|
rescue AvalaraSdk::ApiError => e
|
294
305
|
puts "Error when calling Issuers1099Api->get_issuers: #{e}"
|
@@ -299,12 +310,12 @@ end
|
|
299
310
|
|
300
311
|
This returns an Array which contains the response data, status code and headers.
|
301
312
|
|
302
|
-
> <Array(<PaginatedQueryResultModelIssuerResponse>, Integer, Hash)> get_issuers_with_http_info(avalara_version,
|
313
|
+
> <Array(<PaginatedQueryResultModelIssuerResponse>, Integer, Hash)> get_issuers_with_http_info(avalara_version, opts)
|
303
314
|
|
304
315
|
```ruby
|
305
316
|
begin
|
306
317
|
# List issuers
|
307
|
-
data, status_code, headers = api_instance.get_issuers_with_http_info(avalara_version,
|
318
|
+
data, status_code, headers = api_instance.get_issuers_with_http_info(avalara_version, opts)
|
308
319
|
p status_code # => 2xx
|
309
320
|
p headers # => { ... }
|
310
321
|
p data # => <PaginatedQueryResultModelIssuerResponse>
|
@@ -318,13 +329,14 @@ end
|
|
318
329
|
| Name | Type | Description | Notes |
|
319
330
|
| ---- | ---- | ----------- | ----- |
|
320
331
|
| **avalara_version** | **String** | API version | |
|
321
|
-
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format | |
|
322
332
|
| **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>. | [optional] |
|
323
333
|
| **top** | **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. | [optional] |
|
324
334
|
| **skip** | **Integer** | If nonzero, skip this number of results before returning data. Used with top to provide pagination for large datasets. | [optional] |
|
325
335
|
| **order_by** | **String** | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC. | [optional] |
|
326
336
|
| **count** | **Boolean** | If true, return the global count of elements in the collection. | [optional] |
|
327
337
|
| **count_only** | **Boolean** | If true, return ONLY the global count of elements in the collection. It only applies when count=true. | [optional] |
|
338
|
+
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
|
339
|
+
| **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] |
|
328
340
|
|
329
341
|
### Return type
|
330
342
|
|
@@ -342,7 +354,7 @@ end
|
|
342
354
|
|
343
355
|
## update_issuer
|
344
356
|
|
345
|
-
> update_issuer(id, avalara_version,
|
357
|
+
> update_issuer(id, avalara_version, opts)
|
346
358
|
|
347
359
|
Update an issuer
|
348
360
|
|
@@ -368,14 +380,15 @@ api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
|
|
368
380
|
|
369
381
|
id = 'id_example' # String | Id of the issuer to Update
|
370
382
|
avalara_version = '2.0' # String | API version
|
371
|
-
x_correlation_id = '0c618dc9-79c1-424f-8b6a-6a80c766d673' # String | Unique correlation Id in a GUID format
|
372
383
|
opts = {
|
384
|
+
x_correlation_id: '8d1cab49-aeb6-4655-abb0-d91b212b461f', # String | Unique correlation Id in a GUID format
|
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/) .
|
373
386
|
issuer_command: AvalaraSdk::A1099::V2::IssuerCommand.new # IssuerCommand | The issuer to update
|
374
387
|
}
|
375
388
|
|
376
389
|
begin
|
377
390
|
# Update an issuer
|
378
|
-
api_instance.update_issuer(id, avalara_version,
|
391
|
+
api_instance.update_issuer(id, avalara_version, opts)
|
379
392
|
rescue AvalaraSdk::ApiError => e
|
380
393
|
puts "Error when calling Issuers1099Api->update_issuer: #{e}"
|
381
394
|
end
|
@@ -385,12 +398,12 @@ end
|
|
385
398
|
|
386
399
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
387
400
|
|
388
|
-
> <Array(nil, Integer, Hash)> update_issuer_with_http_info(id, avalara_version,
|
401
|
+
> <Array(nil, Integer, Hash)> update_issuer_with_http_info(id, avalara_version, opts)
|
389
402
|
|
390
403
|
```ruby
|
391
404
|
begin
|
392
405
|
# Update an issuer
|
393
|
-
data, status_code, headers = api_instance.update_issuer_with_http_info(id, avalara_version,
|
406
|
+
data, status_code, headers = api_instance.update_issuer_with_http_info(id, avalara_version, opts)
|
394
407
|
p status_code # => 2xx
|
395
408
|
p headers # => { ... }
|
396
409
|
p data # => nil
|
@@ -405,7 +418,8 @@ end
|
|
405
418
|
| ---- | ---- | ----------- | ----- |
|
406
419
|
| **id** | **String** | Id of the issuer to Update | |
|
407
420
|
| **avalara_version** | **String** | API version | |
|
408
|
-
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format |
|
421
|
+
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
|
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] |
|
409
423
|
| **issuer_command** | [**IssuerCommand**](IssuerCommand.md) | The issuer to update | [optional] |
|
410
424
|
|
411
425
|
### Return type
|
@@ -9,7 +9,7 @@ All URIs are relative to *https://api-ava1099.eta.sbx.us-east-1.aws.avalara.io/a
|
|
9
9
|
|
10
10
|
## get_job
|
11
11
|
|
12
|
-
> <JobResult> get_job(id, avalara_version,
|
12
|
+
> <JobResult> get_job(id, avalara_version, opts)
|
13
13
|
|
14
14
|
Retrieves information about the job
|
15
15
|
|
@@ -35,11 +35,14 @@ api_instance = AvalaraSdk::A1099::V2::Jobs1099Api.new api_client
|
|
35
35
|
|
36
36
|
id = 'id_example' # String | Job id obtained from other API responses, like `/1099/bulk-upsert`.
|
37
37
|
avalara_version = '2.0' # String | API version
|
38
|
-
|
38
|
+
opts = {
|
39
|
+
x_correlation_id: 'b63b2c1f-52a6-4a88-92a4-d11b4c5da79f', # String | Unique correlation Id in a GUID format
|
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
|
+
}
|
39
42
|
|
40
43
|
begin
|
41
44
|
# Retrieves information about the job
|
42
|
-
result = api_instance.get_job(id, avalara_version,
|
45
|
+
result = api_instance.get_job(id, avalara_version, opts)
|
43
46
|
p result
|
44
47
|
rescue AvalaraSdk::ApiError => e
|
45
48
|
puts "Error when calling Jobs1099Api->get_job: #{e}"
|
@@ -50,12 +53,12 @@ end
|
|
50
53
|
|
51
54
|
This returns an Array which contains the response data, status code and headers.
|
52
55
|
|
53
|
-
> <Array(<JobResult>, Integer, Hash)> get_job_with_http_info(id, avalara_version,
|
56
|
+
> <Array(<JobResult>, Integer, Hash)> get_job_with_http_info(id, avalara_version, opts)
|
54
57
|
|
55
58
|
```ruby
|
56
59
|
begin
|
57
60
|
# Retrieves information about the job
|
58
|
-
data, status_code, headers = api_instance.get_job_with_http_info(id, avalara_version,
|
61
|
+
data, status_code, headers = api_instance.get_job_with_http_info(id, avalara_version, opts)
|
59
62
|
p status_code # => 2xx
|
60
63
|
p headers # => { ... }
|
61
64
|
p data # => <JobResult>
|
@@ -70,7 +73,8 @@ end
|
|
70
73
|
| ---- | ---- | ----------- | ----- |
|
71
74
|
| **id** | **String** | Job id obtained from other API responses, like `/1099/bulk-upsert`. | |
|
72
75
|
| **avalara_version** | **String** | API version | |
|
73
|
-
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format |
|
76
|
+
| **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
|
77
|
+
| **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] |
|
74
78
|
|
75
79
|
### Return type
|
76
80
|
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# AvalaraSdk::A1099::V2::StateAndLocalWithholdingResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **state_tax_withheld** | **Float** | | [optional] |
|
8
|
+
| **state** | **String** | | [optional] |
|
9
|
+
| **state_id_number** | **String** | | [optional] |
|
10
|
+
| **state_income** | **Float** | | [optional] |
|
11
|
+
| **local_tax_withheld** | **Float** | | [optional] |
|
12
|
+
| **locality** | **String** | | [optional] |
|
13
|
+
| **locality_id_number** | **String** | | [optional] |
|
14
|
+
| **local_income** | **Float** | | [optional] |
|
15
|
+
|
16
|
+
## Example
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'avalara_sdk'
|
20
|
+
|
21
|
+
instance = AvalaraSdk::A1099::V2::StateAndLocalWithholdingResponse.new(
|
22
|
+
state_tax_withheld: null,
|
23
|
+
state: null,
|
24
|
+
state_id_number: null,
|
25
|
+
state_income: null,
|
26
|
+
local_tax_withheld: null,
|
27
|
+
locality: null,
|
28
|
+
locality_id_number: null,
|
29
|
+
local_income: null
|
30
|
+
)
|
31
|
+
```
|
32
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# AvalaraSdk::A1099::V2::StateEfileStatusDetailApp
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **status** | **String** | | [optional] |
|
8
|
+
| **time** | **String** | | [optional] |
|
9
|
+
| **jurisdiction** | **String** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'avalara_sdk'
|
15
|
+
|
16
|
+
instance = AvalaraSdk::A1099::V2::StateEfileStatusDetailApp.new(
|
17
|
+
status: null,
|
18
|
+
time: null,
|
19
|
+
jurisdiction: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# AvalaraSdk::A1099::V2::StatusDetail
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **time** | **String** | | [optional] |
|
8
|
+
| **status** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'avalara_sdk'
|
14
|
+
|
15
|
+
instance = AvalaraSdk::A1099::V2::StatusDetail.new(
|
16
|
+
time: null,
|
17
|
+
status: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,53 @@
|
|
1
|
+
# AvalaraSdk::A1099::V2::Update1099Form200Response
|
2
|
+
|
3
|
+
## Class instance methods
|
4
|
+
|
5
|
+
### `openapi_one_of`
|
6
|
+
|
7
|
+
Returns the list of classes defined in oneOf.
|
8
|
+
|
9
|
+
#### Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'avalara_sdk'
|
13
|
+
|
14
|
+
AvalaraSdk::A1099::V2::Update1099Form200Response.openapi_one_of
|
15
|
+
# =>
|
16
|
+
# [
|
17
|
+
# :'Form1099DivResponse',
|
18
|
+
# :'Form1099MiscResponse',
|
19
|
+
# :'Form1099NecResponse',
|
20
|
+
# :'FormResponseBase'
|
21
|
+
# ]
|
22
|
+
```
|
23
|
+
|
24
|
+
### build
|
25
|
+
|
26
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
27
|
+
|
28
|
+
#### Example
|
29
|
+
|
30
|
+
```ruby
|
31
|
+
require 'avalara_sdk'
|
32
|
+
|
33
|
+
AvalaraSdk::A1099::V2::Update1099Form200Response.build(data)
|
34
|
+
# => #<Form1099DivResponse:0x00007fdd4aab02a0>
|
35
|
+
|
36
|
+
AvalaraSdk::A1099::V2::Update1099Form200Response.build(data_that_doesnt_match)
|
37
|
+
# => nil
|
38
|
+
```
|
39
|
+
|
40
|
+
#### Parameters
|
41
|
+
|
42
|
+
| Name | Type | Description |
|
43
|
+
| ---- | ---- | ----------- |
|
44
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
45
|
+
|
46
|
+
#### Return type
|
47
|
+
|
48
|
+
- `Form1099DivResponse`
|
49
|
+
- `Form1099MiscResponse`
|
50
|
+
- `Form1099NecResponse`
|
51
|
+
- `FormResponseBase`
|
52
|
+
- `nil` (if no type matches)
|
53
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# AvalaraSdk::A1099::V2::ValidationErrorApp
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **field** | **String** | | [optional] |
|
8
|
+
| **errors** | **Array<String>** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'avalara_sdk'
|
14
|
+
|
15
|
+
instance = AvalaraSdk::A1099::V2::ValidationErrorApp.new(
|
16
|
+
field: null,
|
17
|
+
errors: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -37,8 +37,8 @@ avalara_version = '1.2' # String | The HTTP Header meant to specify the version
|
|
37
37
|
opts = {
|
38
38
|
x_avalara_client: 'John's E-Invoicing-API Client', # String | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint.
|
39
39
|
filter: 'requiredFor/countryMandate eq AU-B2G-PEPPOL', # String | Filter by field name and value. This filter only supports <code>eq</code> and <code>contains</code>. Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering.
|
40
|
-
top:
|
41
|
-
skip:
|
40
|
+
top: 8.14, # Float | The number of items to include in the result.
|
41
|
+
skip: 'skip_example', # String | If nonzero, skip this number of results before returning data. Used with <code>$top</code> to provide pagination for large datasets.
|
42
42
|
count: 'true', # Boolean | When set to true, the count of the collection is also returned in the response body
|
43
43
|
count_only: 'true' # Boolean | When set to true, only the count of the collection is returned
|
44
44
|
}
|
@@ -77,8 +77,8 @@ end
|
|
77
77
|
| **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used | |
|
78
78
|
| **x_avalara_client** | **String** | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint. | [optional] |
|
79
79
|
| **filter** | **String** | Filter by field name and value. This filter only supports <code>eq</code> and <code>contains</code>. Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering. | [optional] |
|
80
|
-
| **top** | **Float** |
|
81
|
-
| **skip** | **
|
80
|
+
| **top** | **Float** | The number of items to include in the result. | [optional] |
|
81
|
+
| **skip** | **String** | If nonzero, skip this number of results before returning data. Used with <code>$top</code> to provide pagination for large datasets. | [optional] |
|
82
82
|
| **count** | **Boolean** | When set to true, the count of the collection is also returned in the response body | [optional] |
|
83
83
|
| **count_only** | **Boolean** | When set to true, only the count of the collection is returned | [optional] |
|
84
84
|
|
@@ -210,7 +210,7 @@ opts = {
|
|
210
210
|
count: 'true', # String | When set to true, the count of the collection is also returned in the response body
|
211
211
|
count_only: 'false', # String | When set to true, only the count of the collection is returned
|
212
212
|
filter: 'id eq 52f60401-44d0-4667-ad47-4afe519abb53', # String | Filter by field name and value. This filter only supports <code>eq</code> . Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering. Filtering will be done over the provided startDate and endDate. If no startDate or endDate is provided, defaults will be assumed.
|
213
|
-
top:
|
213
|
+
top: 8.14, # Float | The number of items to include in the result.
|
214
214
|
skip: '10' # String | If nonzero, skip this number of results before returning data. Used with <code>$top</code> to provide pagination for large datasets.
|
215
215
|
}
|
216
216
|
|
@@ -253,7 +253,7 @@ end
|
|
253
253
|
| **count** | **String** | When set to true, the count of the collection is also returned in the response body | [optional] |
|
254
254
|
| **count_only** | **String** | When set to true, only the count of the collection is returned | [optional] |
|
255
255
|
| **filter** | **String** | Filter by field name and value. This filter only supports <code>eq</code> . Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering. Filtering will be done over the provided startDate and endDate. If no startDate or endDate is provided, defaults will be assumed. | [optional] |
|
256
|
-
| **top** | **Float** |
|
256
|
+
| **top** | **Float** | The number of items to include in the result. | [optional] |
|
257
257
|
| **skip** | **String** | If nonzero, skip this number of results before returning data. Used with <code>$top</code> to provide pagination for large datasets. | [optional] |
|
258
258
|
|
259
259
|
### Return type
|
@@ -123,8 +123,8 @@ avalara_version = '1.2' # String | The HTTP Header meant to specify the version
|
|
123
123
|
opts = {
|
124
124
|
x_avalara_client: 'John's E-Invoicing-API Client', # String | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint.
|
125
125
|
filter: 'countryMandate eq DE-B2G-PEPPOL', # String | Filter by field name and value. This filter only supports <code>eq</code> and <code>contains</code>. Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering.
|
126
|
-
top:
|
127
|
-
skip:
|
126
|
+
top: 8.14, # Float | The number of items to include in the result.
|
127
|
+
skip: 'skip_example', # String | If nonzero, skip this number of results before returning data. Used with <code>$top</code> to provide pagination for large datasets.
|
128
128
|
count: 'true', # Boolean | When set to true, the count of the collection is also returned in the response body.
|
129
129
|
count_only: 'true' # Boolean | When set to true, only the count of the collection is returned
|
130
130
|
}
|
@@ -163,8 +163,8 @@ end
|
|
163
163
|
| **avalara_version** | **String** | The HTTP Header meant to specify the version of the API intended to be used | |
|
164
164
|
| **x_avalara_client** | **String** | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a fingerprint. | [optional] |
|
165
165
|
| **filter** | **String** | Filter by field name and value. This filter only supports <code>eq</code> and <code>contains</code>. Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering. | [optional] |
|
166
|
-
| **top** | **Float** |
|
167
|
-
| **skip** | **
|
166
|
+
| **top** | **Float** | The number of items to include in the result. | [optional] |
|
167
|
+
| **skip** | **String** | If nonzero, skip this number of results before returning data. Used with <code>$top</code> to provide pagination for large datasets. | [optional] |
|
168
168
|
| **count** | **Boolean** | When set to true, the count of the collection is also returned in the response body. | [optional] |
|
169
169
|
| **count_only** | **Boolean** | When set to true, only the count of the collection is returned | [optional] |
|
170
170
|
|
@@ -288,8 +288,8 @@ avalara_version = 'avalara_version_example' # String | The version of the API to
|
|
288
288
|
opts = {
|
289
289
|
x_correlation_id: 'x_correlation_id_example', # String | A unique identifier for tracking the request and its response
|
290
290
|
x_avalara_client: 'x_avalara_client_example', # String | Client application identification
|
291
|
-
top:
|
292
|
-
skip:
|
291
|
+
top: 8.14, # Float | The number of items to include in the result.
|
292
|
+
skip: 8.14, # Float | The number of items to skip in the result.
|
293
293
|
count: true, # Boolean | Whether to include the total count of records in the result.
|
294
294
|
count_only: true # Boolean | Whether to return only the count of records, without the list of records.
|
295
295
|
}
|
@@ -328,8 +328,8 @@ end
|
|
328
328
|
| **avalara_version** | **String** | The version of the API to use, e.g., \"1.3\". | |
|
329
329
|
| **x_correlation_id** | **String** | A unique identifier for tracking the request and its response | [optional] |
|
330
330
|
| **x_avalara_client** | **String** | Client application identification | [optional] |
|
331
|
-
| **top** | **
|
332
|
-
| **skip** | **
|
331
|
+
| **top** | **Float** | The number of items to include in the result. | [optional] |
|
332
|
+
| **skip** | **Float** | The number of items to skip in the result. | [optional] |
|
333
333
|
| **count** | **Boolean** | Whether to include the total count of records in the result. | [optional] |
|
334
334
|
| **count_only** | **Boolean** | Whether to return only the count of records, without the list of records. | [optional] |
|
335
335
|
|
@@ -295,7 +295,7 @@ opts = {
|
|
295
295
|
x_avalara_client: 'John's E-Invoicing-API Client', # String | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\"
|
296
296
|
filter: 'name eq 'Batch_Search_Import_V4'', # String | Filter by field name and value. This filter only supports <code>eq</code> .The parameters supported is <code>name</code>. Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering. Filtering will be done over the provided parameters.
|
297
297
|
count: true, # Boolean | When set to true, the count of the collection is included as @recordSetCount in the response body.
|
298
|
-
top:
|
298
|
+
top: 8.14, # Float | The number of items to include in the result.
|
299
299
|
skip: '10', # String | If nonzero, skip this number of results before returning data. Used with <code>$top</code> to provide pagination for large datasets.
|
300
300
|
order_by: 'name desc', # String | The $orderBy query parameter specifies the field and sorting direction for ordering the result set. The value is a string that combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space.
|
301
301
|
x_correlation_id: 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # String | The caller can use this as an identifier to use as a correlation id to trace the call.
|
@@ -336,7 +336,7 @@ end
|
|
336
336
|
| **x_avalara_client** | **String** | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\" | [optional] |
|
337
337
|
| **filter** | **String** | Filter by field name and value. This filter only supports <code>eq</code> .The parameters supported is <code>name</code>. Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering. Filtering will be done over the provided parameters. | [optional] |
|
338
338
|
| **count** | **Boolean** | When set to true, the count of the collection is included as @recordSetCount in the response body. | [optional] |
|
339
|
-
| **top** | **
|
339
|
+
| **top** | **Float** | The number of items to include in the result. | [optional] |
|
340
340
|
| **skip** | **String** | If nonzero, skip this number of results before returning data. Used with <code>$top</code> to provide pagination for large datasets. | [optional] |
|
341
341
|
| **order_by** | **String** | The $orderBy query parameter specifies the field and sorting direction for ordering the result set. The value is a string that combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space. | [optional] |
|
342
342
|
| **x_correlation_id** | **String** | The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] |
|
@@ -387,7 +387,7 @@ opts = {
|
|
387
387
|
x_avalara_client: 'John's E-Invoicing-API Client', # String | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\"
|
388
388
|
count: true, # Boolean | When set to true, the count of the collection is included as @recordSetCount in the response body.
|
389
389
|
filter: 'network eq 'Peppol' and country eq 'Australia'', # String | Filter by field name and value. This filter only supports <code>eq</code> .The parameters supported are <code>network</code>, <code>country</code>, <code>documentType</code>, <code>idType</code>. Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering. Filtering will be done over the provided parameters.
|
390
|
-
top:
|
390
|
+
top: 8.14, # Float | The number of items to include in the result.
|
391
391
|
skip: '10', # String | If nonzero, skip this number of results before returning data. Used with <code>$top</code> to provide pagination for large datasets.
|
392
392
|
order_by: 'name desc', # String | The $orderBy query parameter specifies the field and sorting direction for ordering the result set. The value is a string that combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space.
|
393
393
|
x_correlation_id: 'f3f0d19a-01a1-4748-8a58-f000d0424f43' # String | The caller can use this as an identifier to use as a correlation id to trace the call.
|
@@ -429,7 +429,7 @@ end
|
|
429
429
|
| **x_avalara_client** | **String** | You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a \"Fingerprint\" | [optional] |
|
430
430
|
| **count** | **Boolean** | When set to true, the count of the collection is included as @recordSetCount in the response body. | [optional] |
|
431
431
|
| **filter** | **String** | Filter by field name and value. This filter only supports <code>eq</code> .The parameters supported are <code>network</code>, <code>country</code>, <code>documentType</code>, <code>idType</code>. Refer to [https://developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering. Filtering will be done over the provided parameters. | [optional] |
|
432
|
-
| **top** | **
|
432
|
+
| **top** | **Float** | The number of items to include in the result. | [optional] |
|
433
433
|
| **skip** | **String** | If nonzero, skip this number of results before returning data. Used with <code>$top</code> to provide pagination for large datasets. | [optional] |
|
434
434
|
| **order_by** | **String** | The $orderBy query parameter specifies the field and sorting direction for ordering the result set. The value is a string that combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space. | [optional] |
|
435
435
|
| **x_correlation_id** | **String** | The caller can use this as an identifier to use as a correlation id to trace the call. | [optional] |
|