avatax 17.6.0 → 17.7.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: d024291daa0229f26ee75f83545a01c700dd1927
4
- data.tar.gz: be58b1cb99c75e3a66b541b85252660ad3892573
3
+ metadata.gz: b088786169c533591b743fd4460e1136dc0460f7
4
+ data.tar.gz: 50ac24f14e1c1142a05cbce53367b822e8e84ea9
5
5
  SHA512:
6
- metadata.gz: 00f33c72ce25f9a0050371362695909e6f8222cef7f6edf27b4df9eb06be2baf1fd29dab70c4198e119c6e5fb208742b2f090c9186511c386d91eb5f301930ad
7
- data.tar.gz: 86c779153a8aa1520b5a745691ebbca58123686d5d7ca59ef93fd7b15aabe74071a4b0012f96602496a67926d98dcccfeb28c9226fc05ad56aa850d76364b612
6
+ metadata.gz: 1ae9d96449e719193fa053f4bb3ca72d8cdc42952bc811f00b9b2c75c252dc687155b79b2f11f7f30f708a7b9e1b140652c793cf92796e839cc1c2c241f04b21
7
+ data.tar.gz: 94c154fe634fa2a7bb62f86112897385123bce3c429b172c85c0547f6feb9c2df14a9afdbce1dc639fa31aac5e6f68204754707f3b4eef8d0e8a1e90da6a24c3
@@ -27,11 +27,12 @@ module AvaTax
27
27
  # If you have not read or accepted the terms and conditions, this API call will return the
28
28
  # unchanged account model.
29
29
  # @param id [Integer] The ID of the account to activate
30
+ # @param include [String] A comma separated list of child objects to return underneath the primary object.
30
31
  # @param model [Object] The activation request
31
32
  # @return [Object]
32
- def activate_account(id, model)
33
+ def activate_account(id, model, options={})
33
34
  path = "/api/v2/accounts/#{id}/activate"
34
- post(path, model)
35
+ post(path, model, options)
35
36
  end
36
37
 
37
38
 
@@ -6,10 +6,9 @@ module AvaTax
6
6
  # Create a new batch
7
7
  #
8
8
  # Create one or more new batch objects attached to this company.
9
- # A batch object is a large collection of API calls stored in a compact file.
10
- # When you create a batch, it is added to the AvaTax Batch Queue and will be processed in the order it was received.
9
+ # When you create a batch, it is added to the AvaTaxBatch.Batch table and will be processed in the order it was received.
11
10
  # You may fetch a batch to check on its status and retrieve the results of the batch operation.
12
- # Each batch object may have one or more file objects attached.
11
+ # Each batch object may have one or more file objects (currently only one file is supported).
13
12
  # @param companyId [Integer] The ID of the company that owns this batch.
14
13
  # @param model [object[]] The batch you wish to create.
15
14
  # @return [object[]]
@@ -21,7 +20,7 @@ module AvaTax
21
20
 
22
21
  # Delete a single batch
23
22
  #
24
- # Mark the existing batch object at this URL as deleted.
23
+ #
25
24
  # @param companyId [Integer] The ID of the company that owns this batch.
26
25
  # @param id [Integer] The ID of the batch you wish to delete.
27
26
  # @return [object[]]
@@ -117,6 +117,16 @@ module AvaTax
117
117
  end
118
118
 
119
119
 
120
+ #
121
+ #
122
+ #
123
+ # @return [FetchResult]
124
+ def get_company()
125
+ path = "/api/v2/companies/mrs"
126
+ get(path)
127
+ end
128
+
129
+
120
130
  # Get configuration settings for this company
121
131
  #
122
132
  # Retrieve a list of all configuration settings tied to this company.
@@ -8,10 +8,14 @@ module AvaTax
8
8
  # This API is intended to be useful to identify whether the user should be allowed
9
9
  # to automatically verify their login and password.
10
10
  # @param form [String] The name of the form you would like to verify. This can be the tax form code or the legacy return name
11
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
12
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
13
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
14
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
11
15
  # @return [FetchResult]
12
- def get_login_verifier_by_form(form)
16
+ def get_login_verifier_by_form(form, options={})
13
17
  path = "/api/v2/definitions/filingcalendars/loginverifiers/#{form}"
14
- get(path)
18
+ get(path, options)
15
19
  end
16
20
 
17
21
 
@@ -19,10 +23,14 @@ module AvaTax
19
23
  #
20
24
  # Returns the full list of Avalara-supported AvaFile Forms
21
25
  # This API is intended to be useful to identify all the different AvaFile Forms
26
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
27
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
28
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
29
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
22
30
  # @return [FetchResult]
23
- def list_ava_file_forms()
31
+ def list_ava_file_forms(options={})
24
32
  path = "/api/v2/definitions/avafileforms"
25
- get(path)
33
+ get(path, options)
26
34
  end
27
35
 
28
36
 
@@ -31,10 +39,14 @@ module AvaTax
31
39
  # Returns full list of communications transaction types which
32
40
  # are accepted in communication tax calculation requests.
33
41
  # @param id [Integer]
42
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
43
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
44
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
45
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
34
46
  # @return [FetchResult]
35
- def list_communications_service_types(id)
47
+ def list_communications_service_types(id, options={})
36
48
  path = "/api/v2/definitions/communications/transactiontypes/#{id}/servicetypes"
37
- get(path)
49
+ get(path, options)
38
50
  end
39
51
 
40
52
 
@@ -42,10 +54,14 @@ module AvaTax
42
54
  #
43
55
  # Returns full list of communications transaction types which
44
56
  # are accepted in communication tax calculation requests.
57
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
58
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
59
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
60
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
45
61
  # @return [FetchResult]
46
- def list_communications_transaction_types()
62
+ def list_communications_transaction_types(options={})
47
63
  path = "/api/v2/definitions/communications/transactiontypes"
48
- get(path)
64
+ get(path, options)
49
65
  end
50
66
 
51
67
 
@@ -53,10 +69,14 @@ module AvaTax
53
69
  #
54
70
  # Returns full list of communications transaction/service type pairs which
55
71
  # are accepted in communication tax calculation requests.
72
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
73
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
74
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
75
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
56
76
  # @return [FetchResult]
57
- def list_communications_t_s_pairs()
77
+ def list_communications_t_s_pairs(options={})
58
78
  path = "/api/v2/definitions/communications/tspairs"
59
- get(path)
79
+ get(path, options)
60
80
  end
61
81
 
62
82
 
@@ -65,10 +85,14 @@ module AvaTax
65
85
  # Returns a list of all ISO 3166 country codes, and their US English friendly names.
66
86
  # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a country for
67
87
  # a shipping address.
88
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
89
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
90
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
91
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
68
92
  # @return [FetchResult]
69
- def list_countries()
93
+ def list_countries(options={})
70
94
  path = "/api/v2/definitions/countries"
71
- get(path)
95
+ get(path, options)
72
96
  end
73
97
 
74
98
 
@@ -79,10 +103,14 @@ module AvaTax
79
103
  # is occurring. This information is generally used to determine taxability of the product.
80
104
  # In order to facilitate correct reporting of your taxes, you are encouraged to select the proper entity use codes for
81
105
  # all transactions that are exempt.
106
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
107
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
108
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
109
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
82
110
  # @return [FetchResult]
83
- def list_entity_use_codes()
111
+ def list_entity_use_codes(options={})
84
112
  path = "/api/v2/definitions/entityusecodes"
85
- get(path)
113
+ get(path, options)
86
114
  end
87
115
 
88
116
 
@@ -90,10 +118,31 @@ module AvaTax
90
118
  #
91
119
  # Returns the full list of Avalara-supported filing frequencies.
92
120
  # This API is intended to be useful to identify all the different filing frequencies that can be used in notices.
121
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
122
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
123
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
124
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
93
125
  # @return [FetchResult]
94
- def list_filing_frequencies()
126
+ def list_filing_frequencies(options={})
95
127
  path = "/api/v2/definitions/filingfrequencies"
96
- get(path)
128
+ get(path, options)
129
+ end
130
+
131
+
132
+ # List jurisdictions based on the filter provided
133
+ #
134
+ # Returns a list of all Avalara-supported taxing jurisdictions.
135
+ #
136
+ # This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying
137
+ # SQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01'
138
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
139
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
140
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
141
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
142
+ # @return [FetchResult]
143
+ def list_jurisdictions(options={})
144
+ path = "/api/v2/definitions/jurisdictions"
145
+ get(path, options)
97
146
  end
98
147
 
99
148
 
@@ -113,6 +162,10 @@ module AvaTax
113
162
  # @param region [String] The region, state, or province code portion of this address.
114
163
  # @param postalCode [String] The postal code or zip code portion of this address.
115
164
  # @param country [String] The two-character ISO-3166 code of the country portion of this address.
165
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
166
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
167
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
168
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
116
169
  # @return [FetchResult]
117
170
  def list_jurisdictions_by_address(options={})
118
171
  path = "/api/v2/definitions/jurisdictionsnearaddress"
@@ -137,6 +190,10 @@ module AvaTax
137
190
  # @param country [String] The country part of this location's address.
138
191
  # @param latitude [BigDecimal] Optionally identify the location via latitude/longitude instead of via address.
139
192
  # @param longitude [BigDecimal] Optionally identify the location via latitude/longitude instead of via address.
193
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
194
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
195
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
196
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
140
197
  # @return [FetchResult]
141
198
  def list_location_questions_by_address(options={})
142
199
  path = "/api/v2/definitions/locationquestions"
@@ -149,10 +206,14 @@ module AvaTax
149
206
  # List all forms where logins can be verified automatically.
150
207
  # This API is intended to be useful to identify whether the user should be allowed
151
208
  # to automatically verify their login and password.
209
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
210
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
211
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
212
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
152
213
  # @return [FetchResult]
153
- def list_login_verifiers()
214
+ def list_login_verifiers(options={})
154
215
  path = "/api/v2/definitions/filingcalendars/loginverifiers"
155
- get(path)
216
+ get(path, options)
156
217
  end
157
218
 
158
219
 
@@ -160,10 +221,14 @@ module AvaTax
160
221
  #
161
222
  # Returns the full list of all Avalara-supported nexus for all countries and regions.
162
223
  # This API is intended to be useful if your user interface needs to display a selectable list of nexus.
224
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
225
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
226
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
227
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
163
228
  # @return [FetchResult]
164
- def list_nexus()
229
+ def list_nexus(options={})
165
230
  path = "/api/v2/definitions/nexus"
166
- get(path)
231
+ get(path, options)
167
232
  end
168
233
 
169
234
 
@@ -181,6 +246,10 @@ module AvaTax
181
246
  # @param region [String] The region, state, or province code portion of this address.
182
247
  # @param postalCode [String] The postal code or zip code portion of this address.
183
248
  # @param country [String] The two-character ISO-3166 code of the country portion of this address.
249
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
250
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
251
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
252
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
184
253
  # @return [FetchResult]
185
254
  def list_nexus_by_address(options={})
186
255
  path = "/api/v2/definitions/nexus/byaddress"
@@ -192,11 +261,15 @@ module AvaTax
192
261
  #
193
262
  # Returns all Avalara-supported nexus for the specified country.
194
263
  # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country.
195
- # @param country [String]
264
+ # @param country [String] The country in which you want to fetch the system nexus
265
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
266
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
267
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
268
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
196
269
  # @return [FetchResult]
197
- def list_nexus_by_country(country)
270
+ def list_nexus_by_country(country, options={})
198
271
  path = "/api/v2/definitions/nexus/#{country}"
199
- get(path)
272
+ get(path, options)
200
273
  end
201
274
 
202
275
 
@@ -206,10 +279,14 @@ module AvaTax
206
279
  # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region.
207
280
  # @param country [String] The two-character ISO-3166 code for the country.
208
281
  # @param region [String] The two or three character region code for the region.
282
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
283
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
284
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
285
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
209
286
  # @return [FetchResult]
210
- def list_nexus_by_country_and_region(country, region)
287
+ def list_nexus_by_country_and_region(country, region, options={})
211
288
  path = "/api/v2/definitions/nexus/#{country}/#{region}"
212
- get(path)
289
+ get(path, options)
213
290
  end
214
291
 
215
292
 
@@ -227,10 +304,14 @@ module AvaTax
227
304
  # a tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax
228
305
  # form in order to better understand how the form will be filled out.
229
306
  # @param formCode [String] The form code that we are looking up the nexus for
307
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
308
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
309
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
310
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
230
311
  # @return [Object]
231
- def list_nexus_by_form_code(formCode)
312
+ def list_nexus_by_form_code(formCode, options={})
232
313
  path = "/api/v2/definitions/nexus/byform/#{formCode}"
233
- get(path)
314
+ get(path, options)
234
315
  end
235
316
 
236
317
 
@@ -238,10 +319,14 @@ module AvaTax
238
319
  #
239
320
  # Returns the full list of Avalara-supported nexus tax type groups
240
321
  # This API is intended to be useful to identify all the different tax sub-types.
322
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
323
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
324
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
325
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
241
326
  # @return [FetchResult]
242
- def list_nexus_tax_type_groups()
327
+ def list_nexus_tax_type_groups(options={})
243
328
  path = "/api/v2/definitions/nexustaxtypegroups"
244
- get(path)
329
+ get(path, options)
245
330
  end
246
331
 
247
332
 
@@ -249,10 +334,14 @@ module AvaTax
249
334
  #
250
335
  # Returns the full list of Avalara-supported tax notice customer funding options.
251
336
  # This API is intended to be useful to identify all the different notice customer funding options that can be used in notices.
337
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
338
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
339
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
340
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
252
341
  # @return [FetchResult]
253
- def list_notice_customer_funding_options()
342
+ def list_notice_customer_funding_options(options={})
254
343
  path = "/api/v2/definitions/noticecustomerfundingoptions"
255
- get(path)
344
+ get(path, options)
256
345
  end
257
346
 
258
347
 
@@ -260,10 +349,14 @@ module AvaTax
260
349
  #
261
350
  # Returns the full list of Avalara-supported tax notice customer types.
262
351
  # This API is intended to be useful to identify all the different notice customer types.
352
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
353
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
354
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
355
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
263
356
  # @return [FetchResult]
264
- def list_notice_customer_types()
357
+ def list_notice_customer_types(options={})
265
358
  path = "/api/v2/definitions/noticecustomertypes"
266
- get(path)
359
+ get(path, options)
267
360
  end
268
361
 
269
362
 
@@ -271,10 +364,14 @@ module AvaTax
271
364
  #
272
365
  # Returns the full list of Avalara-supported tax notice filing types.
273
366
  # This API is intended to be useful to identify all the different notice filing types that can be used in notices.
367
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
368
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
369
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
370
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
274
371
  # @return [FetchResult]
275
- def list_notice_filingtypes()
372
+ def list_notice_filingtypes(options={})
276
373
  path = "/api/v2/definitions/noticefilingtypes"
277
- get(path)
374
+ get(path, options)
278
375
  end
279
376
 
280
377
 
@@ -282,10 +379,14 @@ module AvaTax
282
379
  #
283
380
  # Returns the full list of Avalara-supported tax notice priorities.
284
381
  # This API is intended to be useful to identify all the different notice priorities that can be used in notices.
382
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
383
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
384
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
385
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
285
386
  # @return [FetchResult]
286
- def list_notice_priorities()
387
+ def list_notice_priorities(options={})
287
388
  path = "/api/v2/definitions/noticepriorities"
288
- get(path)
389
+ get(path, options)
289
390
  end
290
391
 
291
392
 
@@ -293,10 +394,14 @@ module AvaTax
293
394
  #
294
395
  # Returns the full list of Avalara-supported tax notice reasons.
295
396
  # This API is intended to be useful to identify all the different tax notice reasons.
397
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
398
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
399
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
400
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
296
401
  # @return [FetchResult]
297
- def list_notice_reasons()
402
+ def list_notice_reasons(options={})
298
403
  path = "/api/v2/definitions/noticereasons"
299
- get(path)
404
+ get(path, options)
300
405
  end
301
406
 
302
407
 
@@ -304,10 +409,14 @@ module AvaTax
304
409
  #
305
410
  # Returns the full list of Avalara-supported tax notice responsibility ids
306
411
  # This API is intended to be useful to identify all the different tax notice responsibilities.
412
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
413
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
414
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
415
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
307
416
  # @return [FetchResult]
308
- def list_notice_responsibilities()
417
+ def list_notice_responsibilities(options={})
309
418
  path = "/api/v2/definitions/noticeresponsibilities"
310
- get(path)
419
+ get(path, options)
311
420
  end
312
421
 
313
422
 
@@ -315,10 +424,14 @@ module AvaTax
315
424
  #
316
425
  # Returns the full list of Avalara-supported tax notice root causes
317
426
  # This API is intended to be useful to identify all the different tax notice root causes.
427
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
428
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
429
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
430
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
318
431
  # @return [FetchResult]
319
- def list_notice_root_causes()
432
+ def list_notice_root_causes(options={})
320
433
  path = "/api/v2/definitions/noticerootcauses"
321
- get(path)
434
+ get(path, options)
322
435
  end
323
436
 
324
437
 
@@ -326,10 +439,14 @@ module AvaTax
326
439
  #
327
440
  # Returns the full list of Avalara-supported tax notice statuses.
328
441
  # This API is intended to be useful to identify all the different tax notice statuses.
442
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
443
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
444
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
445
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
329
446
  # @return [FetchResult]
330
- def list_notice_statuses()
447
+ def list_notice_statuses(options={})
331
448
  path = "/api/v2/definitions/noticestatuses"
332
- get(path)
449
+ get(path, options)
333
450
  end
334
451
 
335
452
 
@@ -337,10 +454,14 @@ module AvaTax
337
454
  #
338
455
  # Returns the full list of Avalara-supported tax notice types.
339
456
  # This API is intended to be useful to identify all the different notice types that can be used in notices.
457
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
458
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
459
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
460
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
340
461
  # @return [FetchResult]
341
- def list_notice_types()
462
+ def list_notice_types(options={})
342
463
  path = "/api/v2/definitions/noticetypes"
343
- get(path)
464
+ get(path, options)
344
465
  end
345
466
 
346
467
 
@@ -349,10 +470,14 @@ module AvaTax
349
470
  # Returns the full list of Avalara-supported extra parameters for the 'Create Transaction' API call.
350
471
  # This list of parameters is available for use when configuring your transaction.
351
472
  # Some parameters are only available for use if you have subscribed to certain features of AvaTax.
473
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
474
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
475
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
476
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
352
477
  # @return [FetchResult]
353
- def list_parameters()
478
+ def list_parameters(options={})
354
479
  path = "/api/v2/definitions/parameters"
355
- get(path)
480
+ get(path, options)
356
481
  end
357
482
 
358
483
 
@@ -360,10 +485,14 @@ module AvaTax
360
485
  #
361
486
  # Returns the full list of Avalara-supported permission types.
362
487
  # This API is intended to be useful to identify the capabilities of a particular user logon.
488
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
489
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
490
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
491
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
363
492
  # @return [FetchResult]
364
- def list_permissions()
493
+ def list_permissions(options={})
365
494
  path = "/api/v2/definitions/permissions"
366
- get(path)
495
+ get(path, options)
367
496
  end
368
497
 
369
498
 
@@ -372,10 +501,14 @@ module AvaTax
372
501
  # Returns the full list of Avalara-supported rate type file types
373
502
  # This API is intended to be useful to identify all the different rate types.
374
503
  # @param country [String]
504
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
505
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
506
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
507
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
375
508
  # @return [FetchResult]
376
- def list_rate_types_by_country(country)
509
+ def list_rate_types_by_country(country, options={})
377
510
  path = "/api/v2/definitions/countries/#{country}/ratetypes"
378
- get(path)
511
+ get(path, options)
379
512
  end
380
513
 
381
514
 
@@ -384,10 +517,14 @@ module AvaTax
384
517
  # Returns a list of all ISO 3166 region codes and their US English friendly names.
385
518
  # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region
386
519
  # within the country for a shipping addresses.
520
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
521
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
522
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
523
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
387
524
  # @return [FetchResult]
388
- def list_regions()
525
+ def list_regions(options={})
389
526
  path = "/api/v2/definitions/regions"
390
- get(path)
527
+ get(path, options)
391
528
  end
392
529
 
393
530
 
@@ -396,11 +533,15 @@ module AvaTax
396
533
  # Returns a list of all ISO 3166 region codes for a specific country code, and their US English friendly names.
397
534
  # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region
398
535
  # within the country for a shipping addresses.
399
- # @param country [String]
536
+ # @param country [String] The country of which you want to fetch ISO 3166 regions
537
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
538
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
539
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
540
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
400
541
  # @return [FetchResult]
401
- def list_regions_by_country(country)
542
+ def list_regions_by_country(country, options={})
402
543
  path = "/api/v2/definitions/countries/#{country}/regions"
403
- get(path)
544
+ get(path, options)
404
545
  end
405
546
 
406
547
 
@@ -408,10 +549,14 @@ module AvaTax
408
549
  #
409
550
  # Returns the full list of Avalara-supported resource file types
410
551
  # This API is intended to be useful to identify all the different resource file types.
552
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
553
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
554
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
555
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
411
556
  # @return [FetchResult]
412
- def list_resource_file_types()
557
+ def list_resource_file_types(options={})
413
558
  path = "/api/v2/definitions/resourcefiletypes"
414
- get(path)
559
+ get(path, options)
415
560
  end
416
561
 
417
562
 
@@ -420,10 +565,14 @@ module AvaTax
420
565
  # Returns the full list of Avalara-supported permission types.
421
566
  # This API is intended to be useful when designing a user interface for selecting the security role of a user account.
422
567
  # Some security roles are restricted for Avalara internal use.
568
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
569
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
570
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
571
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
423
572
  # @return [FetchResult]
424
- def list_security_roles()
573
+ def list_security_roles(options={})
425
574
  path = "/api/v2/definitions/securityroles"
426
- get(path)
575
+ get(path, options)
427
576
  end
428
577
 
429
578
 
@@ -433,10 +582,14 @@ module AvaTax
433
582
  # This API is intended to be useful for identifying which features you have added to your account.
434
583
  # You may always contact Avalara's sales department for information on available products or services.
435
584
  # You cannot change your subscriptions directly through the API.
585
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
586
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
587
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
588
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
436
589
  # @return [FetchResult]
437
- def list_subscription_types()
590
+ def list_subscription_types(options={})
438
591
  path = "/api/v2/definitions/subscriptiontypes"
439
- get(path)
592
+ get(path, options)
440
593
  end
441
594
 
442
595
 
@@ -444,10 +597,14 @@ module AvaTax
444
597
  #
445
598
  # Returns the full list of Avalara-supported tax authorities.
446
599
  # This API is intended to be useful to identify all the different authorities that receive tax.
600
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
601
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
602
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
603
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
447
604
  # @return [FetchResult]
448
- def list_tax_authorities()
605
+ def list_tax_authorities(options={})
449
606
  path = "/api/v2/definitions/taxauthorities"
450
- get(path)
607
+ get(path, options)
451
608
  end
452
609
 
453
610
 
@@ -457,10 +614,14 @@ module AvaTax
457
614
  # This list represents tax forms that Avalara recognizes.
458
615
  # Customers who subscribe to Avalara Managed Returns Service can request these forms to be filed automatically
459
616
  # based on the customer's AvaTax data.
617
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
618
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
619
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
620
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
460
621
  # @return [FetchResult]
461
- def list_tax_authority_forms()
622
+ def list_tax_authority_forms(options={})
462
623
  path = "/api/v2/definitions/taxauthorityforms"
463
- get(path)
624
+ get(path, options)
464
625
  end
465
626
 
466
627
 
@@ -468,10 +629,14 @@ module AvaTax
468
629
  #
469
630
  # Returns the full list of Avalara-supported tax authority types.
470
631
  # This API is intended to be useful to identify all the different authority types.
632
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
633
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
634
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
635
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
471
636
  # @return [FetchResult]
472
- def list_tax_authority_types()
637
+ def list_tax_authority_types(options={})
473
638
  path = "/api/v2/definitions/taxauthoritytypes"
474
- get(path)
639
+ get(path, options)
475
640
  end
476
641
 
477
642
 
@@ -482,10 +647,14 @@ module AvaTax
482
647
  # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
483
648
  # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
484
649
  # taxability rules for this product in all supported jurisdictions.
650
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
651
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
652
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
653
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
485
654
  # @return [FetchResult]
486
- def list_tax_codes()
655
+ def list_tax_codes(options={})
487
656
  path = "/api/v2/definitions/taxcodes"
488
- get(path)
657
+ get(path, options)
489
658
  end
490
659
 
491
660
 
@@ -494,10 +663,14 @@ module AvaTax
494
663
  # Returns the full list of recognized tax code types.
495
664
  # A 'Tax Code Type' represents a broad category of tax codes, and is less detailed than a single TaxCode.
496
665
  # This API is intended to be useful for broadly searching for tax codes by tax code type.
666
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
667
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
668
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
669
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
497
670
  # @return [Object]
498
- def list_tax_code_types()
671
+ def list_tax_code_types(options={})
499
672
  path = "/api/v2/definitions/taxcodetypes"
500
- get(path)
673
+ get(path, options)
501
674
  end
502
675
 
503
676
 
@@ -505,10 +678,14 @@ module AvaTax
505
678
  #
506
679
  # Returns the full list of Avalara-supported tax sub-types
507
680
  # This API is intended to be useful to identify all the different tax sub-types.
681
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
682
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
683
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
684
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
508
685
  # @return [FetchResult]
509
- def list_tax_sub_types()
686
+ def list_tax_sub_types(options={})
510
687
  path = "/api/v2/definitions/taxsubtypes"
511
- get(path)
688
+ get(path, options)
512
689
  end
513
690
 
514
691
 
@@ -516,10 +693,14 @@ module AvaTax
516
693
  #
517
694
  # Returns the full list of Avalara-supported tax type groups
518
695
  # This API is intended to be useful to identify all the different tax type groups.
696
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
697
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
698
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
699
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
519
700
  # @return [FetchResult]
520
- def list_tax_type_groups()
701
+ def list_tax_type_groups(options={})
521
702
  path = "/api/v2/definitions/taxtypegroups"
522
- get(path)
703
+ get(path, options)
523
704
  end
524
705
 
525
706
  end
@@ -148,6 +148,8 @@ module AvaTax
148
148
  # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
149
149
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
150
150
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
151
+ # @param returnCountry [String] A comma separated list of countries
152
+ # @param returnRegion [String] A comma separated list of regions
151
153
  # @return [FetchResult]
152
154
  def list_filing_calendars(companyId, options={})
153
155
  path = "/api/v2/companies/#{companyId}/filingcalendars"
@@ -206,6 +208,8 @@ module AvaTax
206
208
  # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
207
209
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
208
210
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
211
+ # @param returnCountry [String]
212
+ # @param returnRegion [String]
209
213
  # @return [FetchResult]
210
214
  def query_filing_calendars(options={})
211
215
  path = "/api/v2/filingcalendars"
@@ -109,6 +109,28 @@ module AvaTax
109
109
  end
110
110
 
111
111
 
112
+ # Add an payment to a given filing.
113
+ #
114
+ # This API is available by invitation only.
115
+ # An "Payment" is usually an increase or decrease to customer funding to Avalara,
116
+ # such as early filer discount amounts that are refunded to the customer, or efile fees from websites.
117
+ # Sometimes may be a manual change in tax liability similar to an augmentation.
118
+ # This API creates a new payment for an existing tax filing.
119
+ # This API can only be used when the filing has not yet been approved.
120
+ # @param companyId [Integer] The ID of the company that owns the filing being adjusted.
121
+ # @param year [Integer] The year of the filing's filing period being adjusted.
122
+ # @param month [Integer] The month of the filing's filing period being adjusted.
123
+ # @param country [String] The two-character ISO-3166 code for the country of the filing being adjusted.
124
+ # @param region [String] The two or three character region code for the region.
125
+ # @param formCode [String] The unique code of the form being adjusted.
126
+ # @param model [object[]] A list of Payments to be created for the specified filing.
127
+ # @return [object[]]
128
+ def create_return_payment(companyId, year, month, country, region, formCode, model)
129
+ path = "/api/v2/companies/#{companyId}/filings/#{year}/#{month}/#{country}/#{region}/#{formCode}/payment"
130
+ post(path, model)
131
+ end
132
+
133
+
112
134
  # Delete an adjustment for a given filing.
113
135
  #
114
136
  # This API is available by invitation only.
@@ -142,6 +164,23 @@ module AvaTax
142
164
  end
143
165
 
144
166
 
167
+ # Delete an payment for a given filing.
168
+ #
169
+ # This API is available by invitation only.
170
+ # An "Payment" is usually an increase or decrease to customer funding to Avalara,
171
+ # such as early filer discount amounts that are refunded to the customer, or efile fees from websites.
172
+ # Sometimes may be a manual change in tax liability similar to an augmentation.
173
+ # This API deletes an payment for an existing tax filing.
174
+ # This API can only be used when the filing has been unapproved.
175
+ # @param companyId [Integer] The ID of the company that owns the filing being adjusted.
176
+ # @param id [Integer] The ID of the payment being deleted.
177
+ # @return [object[]]
178
+ def delete_return_payment(companyId, id)
179
+ path = "/api/v2/companies/#{companyId}/filings/payment/#{id}"
180
+ delete(path)
181
+ end
182
+
183
+
145
184
  # Retrieve worksheet checkup report for company and filing period.
146
185
  #
147
186
  # This API is available by invitation only.
@@ -210,6 +249,20 @@ module AvaTax
210
249
  end
211
250
 
212
251
 
252
+ # Retrieve a filing for the specified company and id.
253
+ #
254
+ # This API is available by invitation only.
255
+ # A "filing period" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,
256
+ # based on filing frequency of filing.
257
+ # @param companyId [Integer] The ID of the company that owns the filings.
258
+ # @param id [Integer] The id of the filing return your retrieving
259
+ # @return [FetchResult]
260
+ def get_filing_return(companyId, id)
261
+ path = "/api/v2/companies/#{companyId}/filings/returns/#{id}"
262
+ get(path)
263
+ end
264
+
265
+
213
266
  # Retrieve a list of filings for the specified company in the year and month of a given filing period.
214
267
  #
215
268
  # This API is available by invitation only.
@@ -388,6 +441,24 @@ module AvaTax
388
441
  put(path, model)
389
442
  end
390
443
 
444
+
445
+ # Edit an payment for a given filing.
446
+ #
447
+ # This API is available by invitation only.
448
+ # An "Payment" is usually an increase or decrease to customer funding to Avalara,
449
+ # such as early filer discount amounts that are refunded to the customer, or efile fees from websites.
450
+ # Sometimes may be a manual change in tax liability similar to an augmentation.
451
+ # This API modifies an payment for an existing tax filing.
452
+ # This API can only be used when the filing has not yet been approved.
453
+ # @param companyId [Integer] The ID of the company that owns the filing being adjusted.
454
+ # @param id [Integer] The ID of the payment being edited.
455
+ # @param model [Object] The updated Payment.
456
+ # @return [Object]
457
+ def update_return_payment(companyId, id, model)
458
+ path = "/api/v2/companies/#{companyId}/filings/payment/#{id}"
459
+ put(path, model)
460
+ end
461
+
391
462
  end
392
463
  end
393
464
  end
@@ -34,12 +34,17 @@ module AvaTax
34
34
  # Many taxing authorities require that you define a list of all locations where your company does business.
35
35
  # These locations may require additional custom configuration or tax registration with these authorities.
36
36
  # For more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API.
37
+ #
38
+ # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
39
+ #
40
+ # * LocationSettings
37
41
  # @param companyId [Integer] The ID of the company that owns this location
38
42
  # @param id [Integer] The primary key of this location
43
+ # @param include [String] A comma separated list of child objects to return underneath the primary object.
39
44
  # @return [Object]
40
- def get_location(companyId, id)
45
+ def get_location(companyId, id, options={})
41
46
  path = "/api/v2/companies/#{companyId}/locations/#{id}"
42
- get(path)
47
+ get(path, options)
43
48
  end
44
49
 
45
50
 
@@ -53,6 +58,9 @@ module AvaTax
53
58
  #
54
59
  # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
55
60
  # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
61
+ # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
62
+ #
63
+ # * LocationSettings
56
64
  # @param companyId [Integer] The ID of the company that owns these locations
57
65
  # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
58
66
  # @param include [String] A comma separated list of child objects to return underneath the primary object.
@@ -76,6 +84,10 @@ module AvaTax
76
84
  #
77
85
  # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
78
86
  # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
87
+ #
88
+ # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
89
+ #
90
+ # * LocationSettings
79
91
  # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
80
92
  # @param include [String] A comma separated list of child objects to return underneath the primary object.
81
93
  # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
@@ -1,3 +1,3 @@
1
1
  module AvaTax
2
- VERSION = '17.6.0'.freeze unless defined?(::AvaTax::VERSION)
2
+ VERSION = '17.7.0'.freeze unless defined?(::AvaTax::VERSION)
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: avatax
3
3
  version: !ruby/object:Gem::Version
4
- version: 17.6.0
4
+ version: 17.7.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Marcus Vorwaller
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2017-06-22 00:00:00.000000000 Z
11
+ date: 2017-07-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rake