avatax 20.9.0 → 21.10.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (48) hide show
  1. checksums.yaml +4 -4
  2. data/.vs/slnx.sqlite +0 -0
  3. data/lib/avatax/client/accounts.rb +83 -83
  4. data/lib/avatax/client/addresses.rb +21 -21
  5. data/lib/avatax/client/advancedrules.rb +41 -51
  6. data/lib/avatax/client/avafileforms.rb +41 -41
  7. data/lib/avatax/client/batches.rb +62 -62
  8. data/lib/avatax/client/certexpressinvites.rb +39 -39
  9. data/lib/avatax/client/certificates.rb +163 -163
  10. data/lib/avatax/client/companies.rb +157 -156
  11. data/lib/avatax/client/contacts.rb +48 -48
  12. data/lib/avatax/client/customers.rb +145 -145
  13. data/lib/avatax/client/datasources.rb +48 -48
  14. data/lib/avatax/client/definitions.rb +591 -422
  15. data/lib/avatax/client/distancethresholds.rb +48 -48
  16. data/lib/avatax/client/ecms.rb +26 -31
  17. data/lib/avatax/client/ecommercetoken.rb +17 -17
  18. data/lib/avatax/client/errortransactions.rb +27 -15
  19. data/lib/avatax/client/filingcalendars.rb +48 -12
  20. data/lib/avatax/client/filings.rb +23 -21
  21. data/lib/avatax/client/firmclientlinkages.rb +69 -69
  22. data/lib/avatax/client/free.rb +13 -86
  23. data/lib/avatax/client/fundingrequests.rb +20 -20
  24. data/lib/avatax/client/items.rb +255 -137
  25. data/lib/avatax/client/jurisdictionoverrides.rb +48 -48
  26. data/lib/avatax/client/locations.rb +92 -92
  27. data/lib/avatax/client/multidocument.rb +78 -78
  28. data/lib/avatax/client/nexus.rb +133 -105
  29. data/lib/avatax/client/notices.rb +43 -504
  30. data/lib/avatax/client/notifications.rb +27 -27
  31. data/lib/avatax/client/provisioning.rb +20 -20
  32. data/lib/avatax/client/registrar.rb +85 -75
  33. data/lib/avatax/client/reports.rb +44 -35
  34. data/lib/avatax/client/settings.rb +55 -50
  35. data/lib/avatax/client/subscriptions.rb +27 -27
  36. data/lib/avatax/client/taxcodes.rb +48 -48
  37. data/lib/avatax/client/taxcontent.rb +90 -27
  38. data/lib/avatax/client/taxprofiles.rb +14 -10
  39. data/lib/avatax/client/taxrules.rb +50 -50
  40. data/lib/avatax/client/transactions.rb +155 -155
  41. data/lib/avatax/client/upcs.rb +48 -48
  42. data/lib/avatax/client/users.rb +64 -64
  43. data/lib/avatax/client/utilities.rb +27 -27
  44. data/lib/avatax/configuration.rb +1 -1
  45. data/lib/avatax/request.rb +11 -5
  46. data/lib/avatax/version.rb +1 -1
  47. data/spec/avatax/request_spec.rb +25 -0
  48. metadata +12 -4
@@ -1,10 +1,10 @@
1
- module AvaTax
2
- class Client
3
- module Definitions
4
-
5
-
6
- # Lists all parents of an HS Code.
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module Definitions
4
+
5
+
6
+ # Lists all parents of an HS Code.
7
+ #
8
8
  # Retrieves the specified HS code and all of its parents, reflecting all sections, chapters, headings, and subheadings
9
9
  #
10
10
  # a list of HS Codes that are the parents and information branches of the HS Code for the given
@@ -18,145 +18,169 @@ module AvaTax
18
18
  #
19
19
  # ### Security Policies
20
20
  #
21
- # * This API depends on the following active services<br />*Required* (all): AvaTaxGlobal.
21
+ # * This API depends on the following active services:*Required* (all): AvaTaxGlobal.
22
22
  # @param country [String] The name or code of the destination country.
23
23
  # @param hsCode [String] The partial or full HS Code for which you would like to view all of the parents.
24
- # @return [FetchResult]
25
- def get_cross_border_code(country, hsCode) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}/hierarchy"
26
- get(path) end
27
-
28
- # Test whether a form supports online login verification
29
- #
24
+ # @return [FetchResult]
25
+ def get_cross_border_code(country, hsCode) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}/hierarchy"
26
+ get(path) end
27
+
28
+ # Test whether a form supports online login verification
29
+ #
30
30
  # This API is intended to be useful to identify whether the user should be allowed
31
- # to automatically verify their login and password. This API will provide a result only if the form supports automatic online login verification.
31
+ # to automatically verify their login and password. This API will provide a result only if the form supports automatic online login verification.
32
32
  # @param form [String] The name of the form you would like to verify. This is the tax form code
33
33
  # @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/).<br />*Not filterable:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields
34
34
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
35
35
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
36
36
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
37
- # @return [FetchResult]
38
- def get_login_verifier_by_form(form, options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers/#{form}"
39
- get(path, options) end
40
-
41
- # Retrieve the full list of the AvaFile Forms available
42
- #
37
+ # @return [FetchResult]
38
+ def get_login_verifier_by_form(form, options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers/#{form}"
39
+ get(path, options) end
40
+
41
+ # List all market place locations.
42
+ #
43
+ # List all market place locations.
44
+ # @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/).
45
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
46
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
47
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
48
+ # @return [FetchResult]
49
+ def list_all_marketplace_locations(options={}) path = "/api/v2/definitions/listallmarketplacelocations"
50
+ get(path, options) end
51
+
52
+ # Retrieve the full list of the AvaFile Forms available
53
+ #
43
54
  # This API is deprecated.
44
55
  #
45
56
  # Please use the ListTaxForms API.
46
57
  #
47
58
  # Returns the full list of Avalara-supported AvaFile Forms
48
- # This API is intended to be useful to identify all the different AvaFile Forms
59
+ # This API is intended to be useful to identify all the different AvaFile Forms
49
60
  # @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/).<br />*Not filterable:* outletTypeId
50
61
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
51
62
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
52
63
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
53
- # @return [FetchResult]
54
- def list_ava_file_forms(options={}) path = "/api/v2/definitions/avafileforms"
55
- get(path, options) end
56
-
57
- # List certificate attributes used by a company
58
- #
64
+ # @return [FetchResult]
65
+ def list_ava_file_forms(options={}) path = "/api/v2/definitions/avafileforms"
66
+ get(path, options) end
67
+
68
+ # List certificate attributes used by a company
69
+ #
59
70
  # List the certificate attributes defined by a company either specified by the user or the user's default company.
60
71
  #
61
72
  # A certificate may have multiple attributes that control its behavior. You may apply or remove attributes to a
62
73
  # certificate at any time.
63
74
  #
64
75
  # If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
65
- # check and provision account.
76
+ # check and provision account.
66
77
  # @param companyid [Integer] Id of the company the user wish to fetch the certificates' attributes from. If not specified the API will use user's default company.
67
78
  # @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/).
68
79
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
69
80
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
70
81
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
71
- # @return [FetchResult]
72
- def list_certificate_attributes(options={}) path = "/api/v2/definitions/certificateattributes"
73
- get(path, options) end
74
-
75
- # List the certificate exempt reasons defined by a company
76
- #
82
+ # @return [FetchResult]
83
+ def list_certificate_attributes(options={}) path = "/api/v2/definitions/certificateattributes"
84
+ get(path, options) end
85
+
86
+ # List the certificate exempt reasons defined by a company
87
+ #
77
88
  # List the certificate exempt reasons defined by a company.
78
89
  #
79
90
  # An exemption reason defines why a certificate allows a customer to be exempt
80
91
  # for purposes of tax calculation.
81
92
  #
82
93
  # If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
83
- # check and provision account.
94
+ # check and provision account.
84
95
  # @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/).
85
96
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
86
97
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
87
98
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
88
- # @return [FetchResult]
89
- def list_certificate_exempt_reasons(options={}) path = "/api/v2/definitions/certificateexemptreasons"
90
- get(path, options) end
91
-
92
- # List certificate exposure zones used by a company
93
- #
99
+ # @return [FetchResult]
100
+ def list_certificate_exempt_reasons(options={}) path = "/api/v2/definitions/certificateexemptreasons"
101
+ get(path, options) end
102
+
103
+ # List certificate exposure zones used by a company
104
+ #
94
105
  # List the certificate exposure zones defined by a company.
95
106
  #
96
107
  # An exposure zone is a location where a certificate can be valid. Exposure zones may indicate a taxing
97
108
  # authority or other legal entity to which a certificate may apply.
98
109
  #
99
110
  # If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
100
- # check and provision account.
111
+ # check and provision account.
101
112
  # @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/).<br />*Not filterable:* id, companyId, name, tag, description, created, modified, region, country
102
113
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
103
114
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
104
115
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
105
- # @return [FetchResult]
106
- def list_certificate_exposure_zones(options={}) path = "/api/v2/definitions/certificateexposurezones"
107
- get(path, options) end
108
-
109
- # Retrieve the full list of communications service types
110
- #
111
- # Returns full list of service types for a given transaction type ID.
116
+ # @return [FetchResult]
117
+ def list_certificate_exposure_zones(options={}) path = "/api/v2/definitions/certificateexposurezones"
118
+ get(path, options) end
119
+
120
+ # Retrieve the full list of Avalara-supported usage of extra parameters for classification of a item.
121
+ #
122
+ # Returns the full list of Avalara-supported usage of extra parameters for item classification.
123
+ # The list of parameters is available for use with Item Classification.
124
+ # Some parameters are only available for use if you have subscribed to certain features of AvaTax.
125
+ # @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/).<br />*Not filterable:* values
126
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
127
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
128
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
129
+ # @return [FetchResult]
130
+ def list_classification_parameters_usage(options={}) path = "/api/v2/definitions/classification/parametersusage"
131
+ get(path, options) end
132
+
133
+ # Retrieve the full list of communications service types
134
+ #
135
+ # Returns full list of service types for a given transaction type ID.
112
136
  # @param id [Integer] The transaction type ID to examine
113
137
  # @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/).<br />*Not filterable:* requiredParameters
114
138
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
115
139
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
116
140
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
117
- # @return [FetchResult]
118
- def list_communications_service_types(id, options={}) path = "/api/v2/definitions/communications/transactiontypes/#{id}/servicetypes"
119
- get(path, options) end
120
-
121
- # Retrieve the full list of communications transactiontypes
122
- #
141
+ # @return [FetchResult]
142
+ def list_communications_service_types(id, options={}) path = "/api/v2/definitions/communications/transactiontypes/#{id}/servicetypes"
143
+ get(path, options) end
144
+
145
+ # Retrieve the full list of communications transactiontypes
146
+ #
123
147
  # Returns full list of communications transaction types which
124
- # are accepted in communication tax calculation requests.
148
+ # are accepted in communication tax calculation requests.
125
149
  # @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/).
126
150
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
127
151
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
128
152
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
129
- # @return [FetchResult]
130
- def list_communications_transaction_types(options={}) path = "/api/v2/definitions/communications/transactiontypes"
131
- get(path, options) end
132
-
133
- # Retrieve the full list of communications transaction/service type pairs
134
- #
153
+ # @return [FetchResult]
154
+ def list_communications_transaction_types(options={}) path = "/api/v2/definitions/communications/transactiontypes"
155
+ get(path, options) end
156
+
157
+ # Retrieve the full list of communications transaction/service type pairs
158
+ #
135
159
  # Returns full list of communications transaction/service type pairs which
136
- # are accepted in communication tax calculation requests.
160
+ # are accepted in communication tax calculation requests.
137
161
  # @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/).<br />*Not filterable:* requiredParameters
138
162
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
139
163
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
140
164
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
141
- # @return [FetchResult]
142
- def list_communications_t_s_pairs(options={}) path = "/api/v2/definitions/communications/tspairs"
143
- get(path, options) end
144
-
145
- # List all ISO 3166 countries
146
- #
165
+ # @return [FetchResult]
166
+ def list_communications_t_s_pairs(options={}) path = "/api/v2/definitions/communications/tspairs"
167
+ get(path, options) end
168
+
169
+ # List all ISO 3166 countries
170
+ #
147
171
  # Returns a list of all ISO 3166 country codes, and their US English friendly names.
148
172
  # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a country for
149
- # a shipping address.
173
+ # a shipping address.
150
174
  # @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/).<br />*Not filterable:* alpha3Code, isEuropeanUnion, localizedNames, addressesRequireRegion
151
175
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
152
176
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
153
177
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
154
- # @return [FetchResult]
155
- def list_countries(options={}) path = "/api/v2/definitions/countries"
156
- get(path, options) end
157
-
158
- # List certificate exposure zones used by a company
159
- #
178
+ # @return [FetchResult]
179
+ def list_countries(options={}) path = "/api/v2/definitions/countries"
180
+ get(path, options) end
181
+
182
+ # List certificate exposure zones used by a company
183
+ #
160
184
  # List available cover letters that can be used when sending invitation to use CertExpress to upload certificates.
161
185
  #
162
186
  # The CoverLetter model represents a message sent along with an invitation to use CertExpress to
@@ -164,17 +188,17 @@ module AvaTax
164
188
  # certificates directly; this cover letter explains why the invitation was sent.
165
189
  #
166
190
  # If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
167
- # check and provision account.
191
+ # check and provision account.
168
192
  # @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/).<br />*Not filterable:* id, companyId, subject, description, createdDate, modifiedDate, pageCount, templateFilename, version
169
193
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
170
194
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
171
195
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
172
- # @return [FetchResult]
173
- def list_cover_letters(options={}) path = "/api/v2/definitions/coverletters"
174
- get(path, options) end
175
-
176
- # Lists the next level of HS Codes given a destination country and HS Code prefix.
177
- #
196
+ # @return [FetchResult]
197
+ def list_cover_letters(options={}) path = "/api/v2/definitions/coverletters"
198
+ get(path, options) end
199
+
200
+ # Lists the next level of HS Codes given a destination country and HS Code prefix.
201
+ #
178
202
  # Retrieves a list of HS Codes that are the children of the prefix for the given destination country, if
179
203
  # additional children are available.
180
204
  #
@@ -186,19 +210,19 @@ module AvaTax
186
210
  #
187
211
  # ### Security Policies
188
212
  #
189
- # * This API depends on the following active services<br />*Required* (all): AvaTaxGlobal.
213
+ # * This API depends on the following active services:*Required* (all): AvaTaxGlobal.
190
214
  # @param country [String] The name or code of the destination country.
191
215
  # @param hsCode [String] The Section or partial HS Code for which you would like to view the next level of HS Code detail, if more detail is available.
192
216
  # @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/).<br />*Not filterable:* hsCodeSource, system, destinationCountry, isDecisionNode, zeroPaddingCount, isSystemDefined, isTaxable, effDate, endDate, hsCodeSourceLength
193
217
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
194
218
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
195
219
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
196
- # @return [FetchResult]
197
- def list_cross_border_codes(country, hsCode, options={}) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}"
198
- get(path, options) end
199
-
200
- # List top level HS Code Sections.
201
- #
220
+ # @return [FetchResult]
221
+ def list_cross_border_codes(country, hsCode, options={}) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}"
222
+ get(path, options) end
223
+
224
+ # List top level HS Code Sections.
225
+ #
202
226
  # Returns the full list of top level HS Code Sections. Sections are the broadest level of detail for
203
227
  # classifying tariff codes and the items to which they apply. HS Codes are organized
204
228
  # by Section/Chapter/Heading/Subheading/Classification.
@@ -208,77 +232,77 @@ module AvaTax
208
232
  #
209
233
  # ### Security Policies
210
234
  #
211
- # * This API depends on the following active services<br />*Required* (all): AvaTaxGlobal.
212
- # @return [FetchResult]
213
- def list_cross_border_sections() path = "/api/v2/definitions/crossborder/sections"
214
- get(path) end
215
-
216
- # List all ISO 4217 currencies supported by AvaTax.
217
- #
235
+ # * This API depends on the following active services:*Required* (all): AvaTaxGlobal.
236
+ # @return [FetchResult]
237
+ def list_cross_border_sections() path = "/api/v2/definitions/crossborder/sections"
238
+ get(path) end
239
+
240
+ # List all ISO 4217 currencies supported by AvaTax.
241
+ #
218
242
  # Lists all ISO 4217 currencies supported by AvaTax.
219
243
  #
220
244
  # This API produces a list of currency codes that can be used when calling AvaTax. The values from this API can be used to fill out the
221
- # `currencyCode` field in a `CreateTransactionModel`.
245
+ # `currencyCode` field in a `CreateTransactionModel`.
222
246
  # @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/).
223
247
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
224
248
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
225
249
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
226
- # @return [FetchResult]
227
- def list_currencies(options={}) path = "/api/v2/definitions/currencies"
228
- get(path, options) end
229
-
230
- # Retrieve the full list of Avalara-supported entity use codes
231
- #
250
+ # @return [FetchResult]
251
+ def list_currencies(options={}) path = "/api/v2/definitions/currencies"
252
+ get(path, options) end
253
+
254
+ # Retrieve the full list of Avalara-supported entity use codes
255
+ #
232
256
  # Returns the full list of Avalara-supported entity use codes.
233
257
  # Entity/Use Codes are definitions of the entity who is purchasing something, or the purpose for which the transaction
234
258
  # is occurring. This information is generally used to determine taxability of the product.
235
259
  # In order to facilitate correct reporting of your taxes, you are encouraged to select the proper entity use codes for
236
- # all transactions that are exempt.
260
+ # all transactions that are exempt.
237
261
  # @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/).<br />*Not filterable:* validCountries
238
262
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
239
263
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
240
264
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
241
- # @return [FetchResult]
242
- def list_entity_use_codes(options={}) path = "/api/v2/definitions/entityusecodes"
243
- get(path, options) end
244
-
245
- # Retrieve the full list of Avalara-supported filing frequencies.
246
- #
265
+ # @return [FetchResult]
266
+ def list_entity_use_codes(options={}) path = "/api/v2/definitions/entityusecodes"
267
+ get(path, options) end
268
+
269
+ # Retrieve the full list of Avalara-supported filing frequencies.
270
+ #
247
271
  # Returns the full list of Avalara-supported filing frequencies.
248
- # This API is intended to be useful to identify all the different filing frequencies that can be used in notices.
272
+ # This API is intended to be useful to identify all the different filing frequencies that can be used in notices.
249
273
  # @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
274
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
251
275
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
252
276
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
253
- # @return [FetchResult]
254
- def list_filing_frequencies(options={}) path = "/api/v2/definitions/filingfrequencies"
255
- get(path, options) end
256
-
257
- # List jurisdictions based on the filter provided
258
- #
277
+ # @return [FetchResult]
278
+ def list_filing_frequencies(options={}) path = "/api/v2/definitions/filingfrequencies"
279
+ get(path, options) end
280
+
281
+ # List jurisdictions based on the filter provided
282
+ #
259
283
  # Returns a list of all Avalara-supported taxing jurisdictions.
260
284
  #
261
285
  # This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying
262
286
  # SQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01'
263
287
  #
264
- # The rate, salesRate, and useRate fields are not available on the JurisdictionModels returned by this API.
288
+ # The rate, salesRate, and useRate fields are not available on the JurisdictionModels returned by this API.
265
289
  # @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/).<br />*Not filterable:* rate, salesRate, signatureCode, useRate
266
290
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
267
291
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
268
292
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
269
- # @return [FetchResult]
270
- def list_jurisdictions(options={}) path = "/api/v2/definitions/jurisdictions"
271
- get(path, options) end
272
-
273
- # List jurisdictions near a specific address
274
- #
293
+ # @return [FetchResult]
294
+ def list_jurisdictions(options={}) path = "/api/v2/definitions/jurisdictions"
295
+ get(path, options) end
296
+
297
+ # List jurisdictions near a specific address
298
+ #
275
299
  # Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.
276
300
  #
277
301
  # This API allows you to identify which jurisdictions are nearby a specific address according to the best available geocoding information.
278
302
  # It is intended to allow you to create a "Jurisdiction Override", which allows an address to be configured as belonging to a nearby
279
303
  # jurisdiction in AvaTax.
280
304
  #
281
- # The results of this API call can be passed to the `CreateJurisdictionOverride` API call.
305
+ # The results of this API call can be passed to the `CreateJurisdictionOverride` API call.
282
306
  # @param line1 [String] The first address line portion of this address.
283
307
  # @param line2 [String] The second address line portion of this address.
284
308
  # @param line3 [String] The third address line portion of this address.
@@ -290,18 +314,39 @@ module AvaTax
290
314
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
291
315
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
292
316
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
293
- # @return [FetchResult]
294
- def list_jurisdictions_by_address(options={}) path = "/api/v2/definitions/jurisdictionsnearaddress"
295
- get(path, options) end
296
-
297
- # Retrieve the list of questions that are required for a tax location
317
+ # @return [FetchResult]
318
+ def list_jurisdictions_by_address(options={}) path = "/api/v2/definitions/jurisdictionsnearaddress"
319
+ get(path, options) end
320
+
321
+ # List jurisdictions based on the TaxType, TaxSubType and RateType provided
322
+ #
323
+ # Returns a list of all Avalara-supported taxing jurisdictions filtered by TaxType, TaxSubType and RateType.
298
324
  #
325
+ # This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying
326
+ # SQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01'
327
+ #
328
+ # The jurisdictionType, effectiveDate, and endDate are filterable fields available on the JurisdictionRateTypeTaxTypeMappingModels returned by this API.
329
+ # @param country [String] The country for which you want to retrieve the jurisdiction information
330
+ # @param region [String] The region for which you want to retrieve the jurisdiction information
331
+ # @param taxTypeId [String] The taxtype for which you want to retrieve the jurisdiction information
332
+ # @param taxSubTypeId [String] The taxsubtype for which you want to retrieve the jurisdiction information
333
+ # @param rateTypeId [String] The ratetype for which you want to retrieve the jurisdiction information
334
+ # @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/).<br />*Not filterable:* id, country, state, jurisdictionCode, longName, taxTypeId, taxSubTypeId, taxTypeGroupId, rateTypeId
335
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
336
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
337
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
338
+ # @return [FetchResult]
339
+ def list_jurisdictions_by_rate_type_tax_type_mapping(country, region, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/jurisdictions/countries/#{country}/regions/#{region}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}"
340
+ get(path, options) end
341
+
342
+ # Retrieve the list of questions that are required for a tax location
343
+ #
299
344
  # Returns the list of additional questions you must answer when declaring a location in certain taxing jurisdictions.
300
345
  # Some tax jurisdictions require that you register or provide additional information to configure each physical place where
301
346
  # your company does business.
302
347
  # This information is not usually required in order to calculate tax correctly, but is almost always required to file your tax correctly.
303
348
  # You can call this API call for any address and obtain information about what questions must be answered in order to properly
304
- # file tax in that location.
349
+ # file tax in that location.
305
350
  # @param line1 [String] The first line of this location's address.
306
351
  # @param line2 [String] The second line of this location's address.
307
352
  # @param line3 [String] The third line of this location's address.
@@ -315,54 +360,54 @@ module AvaTax
315
360
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
316
361
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
317
362
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
318
- # @return [FetchResult]
319
- def list_location_questions_by_address(options={}) path = "/api/v2/definitions/locationquestions"
320
- get(path, options) end
321
-
322
- # List all forms where logins can be verified automatically
323
- #
363
+ # @return [FetchResult]
364
+ def list_location_questions_by_address(options={}) path = "/api/v2/definitions/locationquestions"
365
+ get(path, options) end
366
+
367
+ # List all forms where logins can be verified automatically
368
+ #
324
369
  # List all forms where logins can be verified automatically.
325
370
  # This API is intended to be useful to identify whether the user should be allowed
326
- # to automatically verify their login and password.
371
+ # to automatically verify their login and password.
327
372
  # @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/).<br />*Not filterable:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields
328
373
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
329
374
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
330
375
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
331
- # @return [FetchResult]
332
- def list_login_verifiers(options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers"
333
- get(path, options) end
334
-
335
- # Retrieve the list of locations for a marketplace.
336
- #
337
- # Retrieves the list of suggested locations for a marketplace.
376
+ # @return [FetchResult]
377
+ def list_login_verifiers(options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers"
378
+ get(path, options) end
379
+
380
+ # Retrieve the list of locations for a marketplace.
381
+ #
382
+ # Retrieves the list of suggested locations for a marketplace.
338
383
  # @param marketplaceId [String] MarketplaceId of a marketplace
339
384
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
340
385
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
341
386
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
342
- # @return [FetchResult]
343
- def list_marketplace_locations(options={}) path = "/api/v2/definitions/marketplacelocations"
344
- get(path, options) end
345
-
346
- # Retrieve the full list of Avalara-supported nexus for all countries and regions.
347
- #
387
+ # @return [FetchResult]
388
+ def list_marketplace_locations(options={}) path = "/api/v2/definitions/marketplacelocations"
389
+ get(path, options) end
390
+
391
+ # Retrieve the full list of Avalara-supported nexus for all countries and regions.
392
+ #
348
393
  # Returns the full list of all Avalara-supported nexus for all countries and regions.
349
394
  #
350
- # This API is intended to be useful if your user interface needs to display a selectable list of nexus.
351
- # @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/).<br />*Not filterable:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters
395
+ # This API is intended to be useful if your user interface needs to display a selectable list of nexus.
396
+ # @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/).<br />*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
352
397
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
353
398
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
354
399
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
355
- # @return [FetchResult]
356
- def list_nexus(options={}) path = "/api/v2/definitions/nexus"
357
- get(path, options) end
358
-
359
- # List all nexus that apply to a specific address.
360
- #
400
+ # @return [FetchResult]
401
+ def list_nexus(options={}) path = "/api/v2/definitions/nexus"
402
+ get(path, options) end
403
+
404
+ # List all nexus that apply to a specific address.
405
+ #
361
406
  # Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.
362
407
  # This API allows you to identify which tax authorities apply to a physical location, salesperson address, or point of sale.
363
408
  # In general, it is usually expected that a company will declare nexus in all the jurisdictions that apply to each physical address
364
409
  # where the company does business.
365
- # The results of this API call can be passed to the 'Create Nexus' API call to declare nexus for this address.
410
+ # The results of this API call can be passed to the 'Create Nexus' API call to declare nexus for this address.
366
411
  # @param line1 [String] The first address line portion of this address.
367
412
  # @param line2 [String] The first address line portion of this address.
368
413
  # @param line3 [String] The first address line portion of this address.
@@ -370,45 +415,45 @@ module AvaTax
370
415
  # @param region [String] Name or ISO 3166 code identifying the region portion of the address. This field supports many different region identifiers: * Two and three character ISO 3166 region codes * Fully spelled out names of the region in ISO supported languages * Common alternative spellings for many regions For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
371
416
  # @param postalCode [String] The postal code or zip code portion of this address.
372
417
  # @param country [String] Name or ISO 3166 code identifying the country portion of this address. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
373
- # @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/).<br />*Not filterable:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters
418
+ # @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/).<br />*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
374
419
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
375
420
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
376
421
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
377
- # @return [FetchResult]
378
- def list_nexus_by_address(options={}) path = "/api/v2/definitions/nexus/byaddress"
379
- get(path, options) end
380
-
381
- # Retrieve the full list of Avalara-supported nexus for a country.
382
- #
422
+ # @return [FetchResult]
423
+ def list_nexus_by_address(options={}) path = "/api/v2/definitions/nexus/byaddress"
424
+ get(path, options) end
425
+
426
+ # Retrieve the full list of Avalara-supported nexus for a country.
427
+ #
383
428
  # Returns all Avalara-supported nexus for the specified country.
384
429
  #
385
- # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country.
430
+ # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country.
386
431
  # @param country [String] The country in which you want to fetch the system nexus
387
- # @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/).<br />*Not filterable:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters
432
+ # @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/).<br />*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
388
433
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
389
434
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
390
435
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
391
- # @return [FetchResult]
392
- def list_nexus_by_country(country, options={}) path = "/api/v2/definitions/nexus/#{country}"
393
- get(path, options) end
394
-
395
- # Retrieve the full list of Avalara-supported nexus for a country and region.
396
- #
436
+ # @return [FetchResult]
437
+ def list_nexus_by_country(country, options={}) path = "/api/v2/definitions/nexus/#{country}"
438
+ get(path, options) end
439
+
440
+ # Retrieve the full list of Avalara-supported nexus for a country and region.
441
+ #
397
442
  # Returns all Avalara-supported nexus for the specified country and region.
398
443
  #
399
- # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region.
444
+ # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region.
400
445
  # @param country [String] The two-character ISO-3166 code for the country.
401
446
  # @param region [String] The two or three character region code for the region.
402
- # @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/).<br />*Not filterable:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters
447
+ # @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/).<br />*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
403
448
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
404
449
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
405
450
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
406
- # @return [FetchResult]
407
- def list_nexus_by_country_and_region(country, region, options={}) path = "/api/v2/definitions/nexus/#{country}/#{region}"
408
- get(path, options) end
409
-
410
- # List nexus related to a tax form
411
- #
451
+ # @return [FetchResult]
452
+ def list_nexus_by_country_and_region(country, region, options={}) path = "/api/v2/definitions/nexus/#{country}/#{region}"
453
+ get(path, options) end
454
+
455
+ # List nexus related to a tax form
456
+ #
412
457
  # Retrieves a list of nexus related to a tax form.
413
458
  #
414
459
  # The concept of `Nexus` indicates a place where your company has sufficient physical presence and is obligated
@@ -423,198 +468,221 @@ module AvaTax
423
468
  #
424
469
  # ### Security Policies
425
470
  #
426
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
471
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
427
472
  # @param formCode [String] The form code that we are looking up the nexus for
428
- # @return [Object]
429
- def list_nexus_by_form_code(formCode) path = "/api/v2/definitions/nexus/byform/#{formCode}"
430
- get(path) end
431
-
432
- # Retrieve the full list of nexus tax type groups
433
- #
473
+ # @return [Object]
474
+ def list_nexus_by_form_code(formCode) path = "/api/v2/definitions/nexus/byform/#{formCode}"
475
+ get(path) end
476
+
477
+ # Retrieve the full list of Avalara-supported nexus for a tax type group.
478
+ #
479
+ # Returns all Avalara-supported nexus for the specified specified tax type group.
480
+ #
481
+ # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by tax type group.
482
+ # @param taxTypeGroup [String] The tax type group to fetch the supporting system nexus for.
483
+ # @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/).<br />*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
484
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
485
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
486
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
487
+ # @return [FetchResult]
488
+ def list_nexus_by_tax_type_group(taxTypeGroup, options={}) path = "/api/v2/definitions/nexus/bytaxtypegroup/#{taxTypeGroup}"
489
+ get(path, options) end
490
+
491
+ # Retrieve the full list of nexus tax type groups
492
+ #
434
493
  # Returns the full list of Avalara-supported nexus tax type groups
435
- # This API is intended to be useful to identify all the different tax sub-types.
494
+ # This API is intended to be useful to identify all the different tax sub-types.
436
495
  # @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/).<br />*Not filterable:* subscriptionTypeId, subscriptionDescription, tabName, showColumn
437
496
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
438
497
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
439
498
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
440
- # @return [FetchResult]
441
- def list_nexus_tax_type_groups(options={}) path = "/api/v2/definitions/nexustaxtypegroups"
442
- get(path, options) end
443
-
444
- # Retrieve the full list of Avalara-supported tax notice customer funding options.
445
- #
499
+ # @return [FetchResult]
500
+ def list_nexus_tax_type_groups(options={}) path = "/api/v2/definitions/nexustaxtypegroups"
501
+ get(path, options) end
502
+
503
+ # Retrieve the full list of Avalara-supported tax notice customer funding options.
504
+ #
446
505
  # Returns the full list of Avalara-supported tax notice customer funding options.
447
- # This API is intended to be useful to identify all the different notice customer funding options that can be used in notices.
506
+ # This API is intended to be useful to identify all the different notice customer funding options that can be used in notices.
448
507
  # @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/).<br />*Not filterable:* activeFlag, sortOrder
449
508
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
450
509
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
451
510
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
452
- # @return [FetchResult]
453
- def list_notice_customer_funding_options(options={}) path = "/api/v2/definitions/noticecustomerfundingoptions"
454
- get(path, options) end
455
-
456
- # Retrieve the full list of Avalara-supported tax notice customer types.
457
- #
511
+ # @return [FetchResult]
512
+ def list_notice_customer_funding_options(options={}) path = "/api/v2/definitions/noticecustomerfundingoptions"
513
+ get(path, options) end
514
+
515
+ # Retrieve the full list of Avalara-supported tax notice customer types.
516
+ #
458
517
  # Returns the full list of Avalara-supported tax notice customer types.
459
- # This API is intended to be useful to identify all the different notice customer types.
518
+ # This API is intended to be useful to identify all the different notice customer types.
460
519
  # @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/).<br />*Not filterable:* activeFlag, sortOrder
461
520
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
462
521
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
463
522
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
464
- # @return [FetchResult]
465
- def list_notice_customer_types(options={}) path = "/api/v2/definitions/noticecustomertypes"
466
- get(path, options) end
467
-
468
- # Retrieve the full list of Avalara-supported tax notice filing types.
469
- #
523
+ # @return [FetchResult]
524
+ def list_notice_customer_types(options={}) path = "/api/v2/definitions/noticecustomertypes"
525
+ get(path, options) end
526
+
527
+ # Retrieve the full list of Avalara-supported tax notice filing types.
528
+ #
470
529
  # Returns the full list of Avalara-supported tax notice filing types.
471
- # This API is intended to be useful to identify all the different notice filing types that can be used in notices.
530
+ # This API is intended to be useful to identify all the different notice filing types that can be used in notices.
472
531
  # @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/).<br />*Not filterable:* description, activeFlag, sortOrder
473
532
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
474
533
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
475
534
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
476
- # @return [FetchResult]
477
- def list_notice_filingtypes(options={}) path = "/api/v2/definitions/noticefilingtypes"
478
- get(path, options) end
479
-
480
- # Retrieve the full list of Avalara-supported tax notice priorities.
481
- #
535
+ # @return [FetchResult]
536
+ def list_notice_filingtypes(options={}) path = "/api/v2/definitions/noticefilingtypes"
537
+ get(path, options) end
538
+
539
+ # Retrieve the full list of Avalara-supported tax notice priorities.
540
+ #
482
541
  # Returns the full list of Avalara-supported tax notice priorities.
483
- # This API is intended to be useful to identify all the different notice priorities that can be used in notices.
542
+ # This API is intended to be useful to identify all the different notice priorities that can be used in notices.
484
543
  # @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/).<br />*Not filterable:* activeFlag, sortOrder
485
544
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
486
545
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
487
546
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
488
- # @return [FetchResult]
489
- def list_notice_priorities(options={}) path = "/api/v2/definitions/noticepriorities"
490
- get(path, options) end
491
-
492
- # Retrieve the full list of Avalara-supported tax notice reasons.
493
- #
547
+ # @return [FetchResult]
548
+ def list_notice_priorities(options={}) path = "/api/v2/definitions/noticepriorities"
549
+ get(path, options) end
550
+
551
+ # Retrieve the full list of Avalara-supported tax notice reasons.
552
+ #
494
553
  # Returns the full list of Avalara-supported tax notice reasons.
495
- # This API is intended to be useful to identify all the different tax notice reasons.
554
+ # This API is intended to be useful to identify all the different tax notice reasons.
496
555
  # @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/).<br />*Not filterable:* description, activeFlag, sortOrder
497
556
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
498
557
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
499
558
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
500
- # @return [FetchResult]
501
- def list_notice_reasons(options={}) path = "/api/v2/definitions/noticereasons"
502
- get(path, options) end
503
-
504
- # Retrieve the full list of Avalara-supported tax notice responsibility ids
505
- #
559
+ # @return [FetchResult]
560
+ def list_notice_reasons(options={}) path = "/api/v2/definitions/noticereasons"
561
+ get(path, options) end
562
+
563
+ # Retrieve the full list of Avalara-supported tax notice responsibility ids
564
+ #
506
565
  # Returns the full list of Avalara-supported tax notice responsibility ids
507
- # This API is intended to be useful to identify all the different tax notice responsibilities.
566
+ # This API is intended to be useful to identify all the different tax notice responsibilities.
508
567
  # @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/).<br />*Not filterable:* sortOrder
509
568
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
510
569
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
511
570
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
512
- # @return [FetchResult]
513
- def list_notice_responsibilities(options={}) path = "/api/v2/definitions/noticeresponsibilities"
514
- get(path, options) end
515
-
516
- # Retrieve the full list of Avalara-supported tax notice root causes
517
- #
571
+ # @return [FetchResult]
572
+ def list_notice_responsibilities(options={}) path = "/api/v2/definitions/noticeresponsibilities"
573
+ get(path, options) end
574
+
575
+ # Retrieve the full list of Avalara-supported tax notice root causes
576
+ #
518
577
  # Returns the full list of Avalara-supported tax notice root causes
519
- # This API is intended to be useful to identify all the different tax notice root causes.
578
+ # This API is intended to be useful to identify all the different tax notice root causes.
520
579
  # @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/).<br />*Not filterable:* sortOrder
521
580
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
522
581
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
523
582
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
524
- # @return [FetchResult]
525
- def list_notice_root_causes(options={}) path = "/api/v2/definitions/noticerootcauses"
526
- get(path, options) end
527
-
528
- # Retrieve the full list of Avalara-supported tax notice statuses.
529
- #
583
+ # @return [FetchResult]
584
+ def list_notice_root_causes(options={}) path = "/api/v2/definitions/noticerootcauses"
585
+ get(path, options) end
586
+
587
+ # Retrieve the full list of Avalara-supported tax notice statuses.
588
+ #
530
589
  # Returns the full list of Avalara-supported tax notice statuses.
531
- # This API is intended to be useful to identify all the different tax notice statuses.
590
+ # This API is intended to be useful to identify all the different tax notice statuses.
532
591
  # @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/).<br />*Not filterable:* isOpen, sortOrder
533
592
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
534
593
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
535
594
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
536
- # @return [FetchResult]
537
- def list_notice_statuses(options={}) path = "/api/v2/definitions/noticestatuses"
538
- get(path, options) end
539
-
540
- # Retrieve the full list of Avalara-supported tax notice types.
541
- #
595
+ # @return [FetchResult]
596
+ def list_notice_statuses(options={}) path = "/api/v2/definitions/noticestatuses"
597
+ get(path, options) end
598
+
599
+ # Retrieve the full list of Avalara-supported tax notice types.
600
+ #
542
601
  # Returns the full list of Avalara-supported tax notice types.
543
- # This API is intended to be useful to identify all the different notice types that can be used in notices.
602
+ # This API is intended to be useful to identify all the different notice types that can be used in notices.
544
603
  # @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/).<br />*Not filterable:* activeFlag, sortOrder
545
604
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
546
605
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
547
606
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
548
- # @return [FetchResult]
549
- def list_notice_types(options={}) path = "/api/v2/definitions/noticetypes"
550
- get(path, options) end
551
-
552
- # Retrieve the full list of Avalara-supported extra parameters for creating transactions.
553
- #
607
+ # @return [FetchResult]
608
+ def list_notice_types(options={}) path = "/api/v2/definitions/noticetypes"
609
+ get(path, options) end
610
+
611
+ # Retrieve the full list of Avalara-supported extra parameters for creating transactions.
612
+ #
554
613
  # Returns the full list of Avalara-supported extra parameters for the 'Create Transaction' API call.
555
614
  # This list of parameters is available for use when configuring your transaction.
556
- # Some parameters are only available for use if you have subscribed to certain features of AvaTax.
615
+ # Some parameters are only available for use if you have subscribed to certain features of AvaTax.
557
616
  # @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/).<br />*Not filterable:* serviceTypes, regularExpression, values
558
617
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
559
618
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
560
619
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
561
- # @return [FetchResult]
562
- def list_parameters(options={}) path = "/api/v2/definitions/parameters"
563
- get(path, options) end
564
-
565
- # Retrieve the parameters by companyCode and itemCode.
566
- #
567
- # Returns the list of parameters based on the company country and state jurisdiction and the item code.
620
+ # @return [FetchResult]
621
+ def list_parameters(options={}) path = "/api/v2/definitions/parameters"
622
+ get(path, options) end
623
+
624
+ # Retrieve the parameters by companyCode and itemCode.
625
+ #
626
+ # Returns the list of parameters based on the company's service types and the item code.
627
+ # Ignores nexus if a service type is configured in the 'IgnoreNexusForServiceTypes' configuration section.
628
+ # Ignores nexus for the AvaAlcohol service type.
629
+ #
630
+ # NOTE: If your company code or item code contains any of these characters /, +, ? or a space, please use the following encoding before making a request:
631
+ # * Replace '/' with '\_-ava2f-\_' For example: 'Company/Code' becomes 'Company_-ava2f-_Code'
632
+ # * Replace '+' with '\_-ava2b-\_' For example: 'Company+Code' becomes 'Company_-ava2b-_Code'
633
+ # * Replace '?' with '\_-ava3f-\_' For example: 'Company?Code' becomes 'Company_-ava3f-_Code'
634
+ # * Replace '%' with '\_-ava25-\_' For example: 'Company%Code' becomes 'Company_-ava25-_Code'
635
+ # * Replace '#' with '\_-ava23-\_' For example: 'Company#Code' becomes 'Company_-ava23-_Code'
568
636
  #
569
637
  # ### Security Policies
570
638
  #
571
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
639
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
572
640
  # @param companyCode [String] Company code.
573
641
  # @param itemCode [String] Item code.
574
642
  # @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/).<br />*Not filterable:* serviceTypes, regularExpression, values
575
643
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
576
644
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
577
645
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
578
- # @return [FetchResult]
579
- def list_parameters_by_item(companyCode, itemCode, options={}) path = "/api/v2/definitions/parameters/byitem/#{companyCode}/#{itemCode}"
580
- get(path, options) end
581
-
582
- # Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions.
583
- #
646
+ # @return [FetchResult]
647
+ def list_parameters_by_item(companyCode, itemCode, options={}) path = "/api/v2/definitions/parameters/byitem/#{companyCode}/#{itemCode}"
648
+ get(path, options) end
649
+
650
+ # Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions.
651
+ #
584
652
  # Returns the full list of Avalara-supported usage of extra parameters for the 'Create Transaction' API call.
585
653
  # This list of parameters is available for use when configuring your transaction.
586
- # Some parameters are only available for use if you have subscribed to certain features of AvaTax.
654
+ # Some parameters are only available for use if you have subscribed to certain features of AvaTax.
587
655
  # @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/).<br />*Not filterable:* values
588
656
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
589
657
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
590
658
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
591
- # @return [FetchResult]
592
- def list_parameters_usage(options={}) path = "/api/v2/definitions/parametersusage"
593
- get(path, options) end
594
-
595
- # Retrieve the full list of Avalara-supported permissions
596
- #
659
+ # @return [FetchResult]
660
+ def list_parameters_usage(options={}) path = "/api/v2/definitions/parametersusage"
661
+ get(path, options) end
662
+
663
+ # Retrieve the full list of Avalara-supported permissions
664
+ #
597
665
  # Returns the full list of Avalara-supported permission types.
598
- # This API is intended to be useful to identify the capabilities of a particular user logon.
666
+ # This API is intended to be useful to identify the capabilities of a particular user logon.
599
667
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
600
668
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
601
- # @return [FetchResult]
602
- def list_permissions(options={}) path = "/api/v2/definitions/permissions"
603
- get(path, options) end
604
-
605
- # Retrieve the full list of Avalara-supported postal codes.
606
- #
607
- # Retrieves the list of Avalara-supported postal codes.
669
+ # @return [FetchResult]
670
+ def list_permissions(options={}) path = "/api/v2/definitions/permissions"
671
+ get(path, options) end
672
+
673
+ # Retrieve the full list of Avalara-supported postal codes.
674
+ #
675
+ # Retrieves the list of Avalara-supported postal codes.
608
676
  # @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/).
609
677
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
610
678
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
611
679
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
612
- # @return [FetchResult]
613
- def list_postal_codes(options={}) path = "/api/v2/definitions/postalcodes"
614
- get(path, options) end
615
-
616
- # List all customs duty programs recognized by AvaTax
617
- #
680
+ # @return [FetchResult]
681
+ def list_postal_codes(options={}) path = "/api/v2/definitions/postalcodes"
682
+ get(path, options) end
683
+
684
+ # List all customs duty programs recognized by AvaTax
685
+ #
618
686
  # List all preferred customs duty programs recognized by AvaTax.
619
687
  #
620
688
  # A customs duty program is an optional program you can use to obtain favorable treatment from customs and duty agents.
@@ -623,165 +691,212 @@ module AvaTax
623
691
  #
624
692
  # To select a preferred program for calculating customs and duty rates, call this API to find the appropriate code for your
625
693
  # preferred program. Next, set the parameter `AvaTax.LC.PreferredProgram` in your `CreateTransaction` call to the code of
626
- # the program.
694
+ # the program.
627
695
  # @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/).<br />*Not filterable:* effectiveDate, endDate
628
696
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
629
697
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
630
698
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
631
- # @return [FetchResult]
632
- def list_preferred_programs(options={}) path = "/api/v2/definitions/preferredprograms"
633
- get(path, options) end
634
-
635
- # List all available product classification systems.
636
- #
699
+ # @return [FetchResult]
700
+ def list_preferred_programs(options={}) path = "/api/v2/definitions/preferredprograms"
701
+ get(path, options) end
702
+
703
+ # List all available product classification systems.
704
+ #
637
705
  # List all available product classification systems.
638
706
  #
639
707
  # Tax authorities use product classification systems as a way to identify products and associate them with a tax rate.
640
- # More than one tax authority might use the same product classification system, but they might charge different tax rates for products.
708
+ # More than one tax authority might use the same product classification system, but they might charge different tax rates for products.
641
709
  # @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/).<br />*Not filterable:* countries
642
710
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
643
711
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
644
712
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
645
713
  # @param countryCode [String] If not null, return all records with this code.
646
- # @return [FetchResult]
647
- def list_product_classification_systems(options={}) path = "/api/v2/definitions/productclassificationsystems"
648
- get(path, options) end
649
-
650
- # List all product classification systems available to a company based on its nexus.
651
- #
714
+ # @return [FetchResult]
715
+ def list_product_classification_systems(options={}) path = "/api/v2/definitions/productclassificationsystems"
716
+ get(path, options) end
717
+
718
+ # List all product classification systems available to a company based on its nexus.
719
+ #
652
720
  # Lists all product classification systems available to a company based on its nexus.
653
721
  #
654
722
  # Tax authorities use product classification systems as a way to identify products and associate them with a tax rate.
655
723
  # More than one tax authority might use the same product classification system, but they might charge different tax rates for products.
724
+ #
725
+ #
726
+ # NOTE: If your company code contains any of these characters /, +, ? or a space, please use the following encoding before making a request:
727
+ # * Replace '/' with '\_-ava2f-\_' For example: 'Company/Code' becomes 'Company_-ava2f-_Code'
728
+ # * Replace '+' with '\_-ava2b-\_' For example: 'Company+Code' becomes 'Company_-ava2b-_Code'
729
+ # * Replace '?' with '\_-ava3f-\_' For example: 'Company?Code' becomes 'Company_-ava3f-_Code'
730
+ # * Replace '%' with '\_-ava25-\_' For example: 'Company%Code' becomes 'Company_-ava25-_Code'
731
+ # * Replace '#' with '\_-ava23-\_' For example: 'Company#Code' becomes 'Company_-ava23-_Code'
656
732
  # @param companyCode [String] The company code.
657
733
  # @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/).<br />*Not filterable:* countries
658
734
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
659
735
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
660
736
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
661
737
  # @param countryCode [String] If not null, return all records with this code.
662
- # @return [FetchResult]
663
- def list_product_classification_systems_by_company(companyCode, options={}) path = "/api/v2/definitions/productclassificationsystems/bycompany/#{companyCode}"
664
- get(path, options) end
665
-
666
- # Retrieve the full list of rate types for each country
667
- #
738
+ # @return [FetchResult]
739
+ def list_product_classification_systems_by_company(companyCode, options={}) path = "/api/v2/definitions/productclassificationsystems/bycompany/#{companyCode}"
740
+ get(path, options) end
741
+
742
+ # Retrieve the full list of rate types for each country
743
+ #
668
744
  # Returns the full list of Avalara-supported rate type file types
669
- # This API is intended to be useful to identify all the different rate types.
745
+ # This API is intended to be useful to identify all the different rate types.
670
746
  # @param country [String] The country to examine for rate types
671
747
  # @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/).
672
748
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
673
749
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
674
750
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
675
- # @return [FetchResult]
676
- def list_rate_types_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/ratetypes"
677
- get(path, options) end
678
-
679
- # List all ISO 3166 regions
680
- #
751
+ # @return [FetchResult]
752
+ def list_rate_types_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/ratetypes"
753
+ get(path, options) end
754
+
755
+ # Retrieve the list of rate types by country, TaxType and by TaxSubType
756
+ #
757
+ # Returns the list of Avalara-supported rate type file types
758
+ # This API is intended to be useful to identify all the different rate types.
759
+ # @param country [String] The country to examine for rate types
760
+ # @param taxTypeId [String] The taxType for the country to examine for rate types
761
+ # @param taxSubTypeId [String] The taxSubType for the country and taxType to examine for rate types
762
+ # @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/).<br />*Not filterable:* id, rateType, description
763
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
764
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
765
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
766
+ # @return [FetchResult]
767
+ def list_rate_types_by_country_tax_type_tax_sub_type(country, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}/ratetypes"
768
+ get(path, options) end
769
+
770
+ # List all ISO 3166 regions
771
+ #
681
772
  # Returns a list of all ISO 3166 region codes and their US English friendly names.
682
773
  # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region
683
- # within the country for a shipping addresses.
774
+ # within the country for a shipping addresses.
684
775
  # @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/).<br />*Not filterable:* localizedNames
685
776
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
686
777
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
687
778
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
688
- # @return [FetchResult]
689
- def list_regions(options={}) path = "/api/v2/definitions/regions"
690
- get(path, options) end
691
-
692
- # List all ISO 3166 regions for a country
693
- #
779
+ # @return [FetchResult]
780
+ def list_regions(options={}) path = "/api/v2/definitions/regions"
781
+ get(path, options) end
782
+
783
+ # List all ISO 3166 regions for a country
784
+ #
694
785
  # Returns a list of all ISO 3166 region codes for a specific country code, and their US English friendly names.
695
786
  # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region
696
- # within the country for a shipping addresses.
787
+ # within the country for a shipping addresses.
697
788
  # @param country [String] The country of which you want to fetch ISO 3166 regions
698
789
  # @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/).<br />*Not filterable:* localizedNames
699
790
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
700
791
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
701
792
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
702
- # @return [FetchResult]
703
- def list_regions_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/regions"
704
- get(path, options) end
705
-
706
- # Retrieve the full list of Avalara-supported resource file types
707
- #
793
+ # @return [FetchResult]
794
+ def list_regions_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/regions"
795
+ get(path, options) end
796
+
797
+ # Retrieve the full list of Avalara-supported resource file types
798
+ #
708
799
  # Returns the full list of Avalara-supported resource file types
709
- # This API is intended to be useful to identify all the different resource file types.
800
+ # This API is intended to be useful to identify all the different resource file types.
710
801
  # @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/).
711
802
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
712
803
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
713
804
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
714
- # @return [FetchResult]
715
- def list_resource_file_types(options={}) path = "/api/v2/definitions/resourcefiletypes"
716
- get(path, options) end
717
-
718
- # Retrieve the full list of Avalara-supported permissions
719
- #
805
+ # @return [FetchResult]
806
+ def list_resource_file_types(options={}) path = "/api/v2/definitions/resourcefiletypes"
807
+ get(path, options) end
808
+
809
+ # Retrieve the full list of Avalara-supported usage of parameters used for returns.
810
+ #
811
+ # Returns the full list of Avalara-supported usage of extra parameters for the returns.
812
+ # This list of parameters is available for use with Returns.
813
+ # Some parameters are only available for use if you have subscribed to certain features of AvaTax.
814
+ # @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/).<br />*Not filterable:* values
815
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
816
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
817
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
818
+ # @return [FetchResult]
819
+ def list_returns_parameters_usage(options={}) path = "/api/v2/definitions/returns/parametersusage"
820
+ get(path, options) end
821
+
822
+ # Retrieve the full list of Avalara-supported permissions
823
+ #
720
824
  # Returns the full list of Avalara-supported permission types.
721
825
  # This API is intended to be useful when designing a user interface for selecting the security role of a user account.
722
- # Some security roles are restricted for Avalara internal use.
826
+ # Some security roles are restricted for Avalara internal use.
723
827
  # @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/).
724
828
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
725
829
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
726
830
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
727
- # @return [FetchResult]
728
- def list_security_roles(options={}) path = "/api/v2/definitions/securityroles"
729
- get(path, options) end
730
-
731
- # Retrieve the full list of Avalara-supported subscription types
732
- #
831
+ # @return [FetchResult]
832
+ def list_security_roles(options={}) path = "/api/v2/definitions/securityroles"
833
+ get(path, options) end
834
+
835
+ # Retrieve the full list of Avalara-supported subscription types
836
+ #
733
837
  # Returns the full list of Avalara-supported subscription types.
734
838
  # This API is intended to be useful for identifying which features you have added to your account.
735
839
  # You may always contact Avalara's sales department for information on available products or services.
736
- # You cannot change your subscriptions directly through the API.
840
+ # You cannot change your subscriptions directly through the API.
737
841
  # @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/).
738
842
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
739
843
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
740
844
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
741
- # @return [FetchResult]
742
- def list_subscription_types(options={}) path = "/api/v2/definitions/subscriptiontypes"
743
- get(path, options) end
744
-
745
- # Retrieve the full list of Avalara-supported tax authorities.
746
- #
845
+ # @return [FetchResult]
846
+ def list_subscription_types(options={}) path = "/api/v2/definitions/subscriptiontypes"
847
+ get(path, options) end
848
+
849
+ # Retrieve the list all tags supported by avalara
850
+ #
851
+ # Retrieves the list of suggested locations for a marketplace.
852
+ # @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/).
853
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
854
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
855
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
856
+ # @return [FetchResult]
857
+ def list_tags(options={}) path = "/api/v2/definitions/tags"
858
+ get(path, options) end
859
+
860
+ # Retrieve the full list of Avalara-supported tax authorities.
861
+ #
747
862
  # Returns the full list of Avalara-supported tax authorities.
748
- # This API is intended to be useful to identify all the different authorities that receive tax.
863
+ # This API is intended to be useful to identify all the different authorities that receive tax.
749
864
  # @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/).
750
865
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
751
866
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
752
867
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
753
- # @return [FetchResult]
754
- def list_tax_authorities(options={}) path = "/api/v2/definitions/taxauthorities"
755
- get(path, options) end
756
-
757
- # Retrieve the full list of Avalara-supported forms for each tax authority.
758
- #
868
+ # @return [FetchResult]
869
+ def list_tax_authorities(options={}) path = "/api/v2/definitions/taxauthorities"
870
+ get(path, options) end
871
+
872
+ # Retrieve the full list of Avalara-supported forms for each tax authority.
873
+ #
759
874
  # Returns the full list of Avalara-supported forms for each tax authority.
760
875
  # This list represents tax forms that Avalara recognizes.
761
876
  # Customers who subscribe to Avalara Managed Returns Service can request these forms to be filed automatically
762
- # based on the customer's AvaTax data.
877
+ # based on the customer's AvaTax data.
763
878
  # @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/).
764
879
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
765
880
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
766
881
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
767
- # @return [FetchResult]
768
- def list_tax_authority_forms(options={}) path = "/api/v2/definitions/taxauthorityforms"
769
- get(path, options) end
770
-
771
- # Retrieve the full list of Avalara-supported tax authority types.
772
- #
882
+ # @return [FetchResult]
883
+ def list_tax_authority_forms(options={}) path = "/api/v2/definitions/taxauthorityforms"
884
+ get(path, options) end
885
+
886
+ # Retrieve the full list of Avalara-supported tax authority types.
887
+ #
773
888
  # Returns the full list of Avalara-supported tax authority types.
774
- # This API is intended to be useful to identify all the different authority types.
889
+ # This API is intended to be useful to identify all the different authority types.
775
890
  # @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/).
776
891
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
777
892
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
778
893
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
779
- # @return [FetchResult]
780
- def list_tax_authority_types(options={}) path = "/api/v2/definitions/taxauthoritytypes"
781
- get(path, options) end
782
-
783
- # Retrieve the full list of Avalara-supported tax codes.
784
- #
894
+ # @return [FetchResult]
895
+ def list_tax_authority_types(options={}) path = "/api/v2/definitions/taxauthoritytypes"
896
+ get(path, options) end
897
+
898
+ # Retrieve the full list of Avalara-supported tax codes.
899
+ #
785
900
  # Retrieves the list of Avalara-supported system tax codes.
786
901
  # A 'TaxCode' represents a uniquely identified type of product, good, or service.
787
902
  # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
@@ -790,74 +905,128 @@ module AvaTax
790
905
  #
791
906
  # ### Security Policies
792
907
  #
793
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
908
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
794
909
  # @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/).
795
910
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
796
911
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
797
912
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
798
- # @return [FetchResult]
799
- def list_tax_codes(options={}) path = "/api/v2/definitions/taxcodes"
800
- get(path, options) end
801
-
802
- # Retrieve the full list of Avalara-supported tax code types.
803
- #
913
+ # @return [FetchResult]
914
+ def list_tax_codes(options={}) path = "/api/v2/definitions/taxcodes"
915
+ get(path, options) end
916
+
917
+ # Retrieve the full list of Avalara-supported tax code types.
918
+ #
804
919
  # Returns the full list of recognized tax code types.
805
920
  # A 'Tax Code Type' represents a broad category of tax codes, and is less detailed than a single TaxCode.
806
- # This API is intended to be useful for broadly searching for tax codes by tax code type.
921
+ # This API is intended to be useful for broadly searching for tax codes by tax code type.
807
922
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
808
923
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
809
- # @return [Object]
810
- def list_tax_code_types(options={}) path = "/api/v2/definitions/taxcodetypes"
811
- get(path, options) end
812
-
813
- # Retrieve the full list of the Tax Forms available
814
- #
924
+ # @return [Object]
925
+ def list_tax_code_types(options={}) path = "/api/v2/definitions/taxcodetypes"
926
+ get(path, options) end
927
+
928
+ # Retrieve the full list of the Tax Forms available
929
+ #
815
930
  # Returns the full list of Avalara-supported Tax Forms
816
- # This API is intended to be useful to identify all the different Tax Forms
931
+ # This API is intended to be useful to identify all the different Tax Forms
817
932
  # @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/).
818
933
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
819
934
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
820
935
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
821
- # @return [FetchResult]
822
- def list_tax_forms(options={}) path = "/api/v2/definitions/taxforms"
823
- get(path, options) end
824
-
825
- # Retrieve the full list of tax sub types
826
- #
936
+ # @return [FetchResult]
937
+ def list_tax_forms(options={}) path = "/api/v2/definitions/taxforms"
938
+ get(path, options) end
939
+
940
+ # Retrieve the full list of tax sub types
941
+ #
827
942
  # Returns the full list of Avalara-supported tax sub-types
828
- # This API is intended to be useful to identify all the different tax sub-types.
943
+ # This API is intended to be useful to identify all the different tax sub-types.
829
944
  # @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/).
830
945
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
831
946
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
832
947
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
833
- # @return [FetchResult]
834
- def list_tax_sub_types(options={}) path = "/api/v2/definitions/taxsubtypes"
835
- get(path, options) end
836
-
837
- # Retrieve the full list of tax type groups
838
- #
948
+ # @return [FetchResult]
949
+ def list_tax_sub_types(options={}) path = "/api/v2/definitions/taxsubtypes"
950
+ get(path, options) end
951
+
952
+ # Retrieve the full list of tax sub types by Country and TaxType
953
+ #
954
+ # Returns the full list of Avalara-supported tax sub-types
955
+ # This API is intended to be useful to identify all the different tax sub-types for given country and TaxType.
956
+ # @param country [String] The country to examine for taxsubtype
957
+ # @param taxTypeId [String] The taxType for the country to examine for taxsubtype
958
+ # @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/).
959
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
960
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
961
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
962
+ # @return [FetchResult]
963
+ def list_tax_sub_types_by_country_and_tax_type(country, taxTypeId, options={}) path = "/api/v2/definitions/taxsubtypes/countries/#{country}/taxtypes/#{taxTypeId}"
964
+ get(path, options) end
965
+
966
+ # Retrieve the full list of tax sub types by jurisdiction code and region
967
+ #
968
+ # Returns the full list of Avalara-supported tax sub-types by jurisdiction and region
969
+ # This API is intended to be useful to identify all the different tax sub-types.
970
+ # @param jurisdictionCode [String] The jurisdiction code of the tax sub type.
971
+ # @param region [String] The region of the tax sub type.
972
+ # @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/).
973
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
974
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
975
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
976
+ # @return [FetchResult]
977
+ def list_tax_sub_types_by_jurisdiction_and_region(jurisdictionCode, region, options={}) path = "/api/v2/definitions/taxsubtypes/#{jurisdictionCode}/#{region}"
978
+ get(path, options) end
979
+
980
+ # Retrieve the full list of tax type groups
981
+ #
839
982
  # Returns the full list of Avalara-supported tax type groups
840
- # This API is intended to be useful to identify all the different tax type groups.
983
+ # This API is intended to be useful to identify all the different tax type groups.
841
984
  # @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/).<br />*Not filterable:* subscriptionTypeId, subscriptionDescription, tabName, showColumn, displaySequence
842
985
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
843
986
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
844
987
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
845
- # @return [FetchResult]
846
- def list_tax_type_groups(options={}) path = "/api/v2/definitions/taxtypegroups"
847
- get(path, options) end
848
-
849
- # List all defined units of measurement
850
- #
988
+ # @return [FetchResult]
989
+ def list_tax_type_groups(options={}) path = "/api/v2/definitions/taxtypegroups"
990
+ get(path, options) end
991
+
992
+ # Retrieve the list of applicable TaxTypes
993
+ #
994
+ # Retrieves the list of applicable TaxTypes based on Nexus of the company.
995
+ # @param country [String] The country for which you want to retrieve the unitofbasis information
996
+ # @param companyId [Integer] Your companyId to retrieve the applicable taxtypes
997
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
998
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
999
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1000
+ # @return [FetchResult]
1001
+ def list_tax_types_by_nexus_and_country(country, options={}) path = "/api/v2/definitions/taxtypes/countries/#{country}"
1002
+ get(path, options) end
1003
+
1004
+ # Retrieve the list of applicable UnitOfBasis
1005
+ #
1006
+ # Retrieves the list of applicable UnitOfBasis
1007
+ # @param country [String] The country for which you want to retrieve the unitofbasis information
1008
+ # @param taxTypeId [String] The taxtype for which you want to retrieve the unitofbasis information
1009
+ # @param taxSubTypeId [String] The taxsubtype for which you want to retrieve the unitofbasis information
1010
+ # @param rateTypeId [String] The ratetype for which you want to retrieve the unitofbasis information
1011
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
1012
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
1013
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1014
+ # @return [FetchResult]
1015
+ def list_unit_of_basis_by_country_and_tax_type_and_tax_sub_type_and_rate_type(country, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/unitofbasis/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}"
1016
+ get(path, options) end
1017
+
1018
+ # List all defined units of measurement
1019
+ #
851
1020
  # List all units of measurement systems defined by Avalara.
852
1021
  #
853
- # A unit of measurement system is a method of measuring a quantity, such as distance, mass, or others.
1022
+ # A unit of measurement system is a method of measuring a quantity, such as distance, mass, or others.
854
1023
  # @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/).<br />*Not filterable:* id
855
1024
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
856
1025
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
857
1026
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
858
- # @return [FetchResult]
859
- def list_unit_of_measurement(options={}) path = "/api/v2/definitions/unitofmeasurements"
860
- get(path, options) end
861
- end
862
- end
1027
+ # @return [FetchResult]
1028
+ def list_unit_of_measurement(options={}) path = "/api/v2/definitions/unitofmeasurements"
1029
+ get(path, options) end
1030
+ end
1031
+ end
863
1032
  end