avatax 17.5.0 → 17.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,109 +4,97 @@ module AvaTax
4
4
 
5
5
 
6
6
  # Create a new contact
7
- #
7
+ #
8
8
  # Create one or more new contact objects.
9
9
  # A 'contact' is a person associated with a company who is designated to handle certain responsibilities of
10
10
  # a tax collecting and filing entity.
11
- #
12
- # @param int companyId The ID of the company that owns this contact.
13
- # @param ContactModel[] model The contacts you wish to create.
14
- # @return ContactModel[]
11
+ # @param companyId [Integer] The ID of the company that owns this contact.
12
+ # @param model [object[]] The contacts you wish to create.
13
+ # @return [object[]]
15
14
  def create_contacts(companyId, model)
16
15
  path = "/api/v2/companies/#{companyId}/contacts"
17
-
18
16
  post(path, model)
19
17
  end
20
18
 
21
19
 
22
20
  # Delete a single contact
23
- #
21
+ #
24
22
  # Mark the existing contact object at this URL as deleted.
25
- #
26
- # @param int companyId The ID of the company that owns this contact.
27
- # @param int id The ID of the contact you wish to delete.
28
- # @return ErrorDetail[]
23
+ # @param companyId [Integer] The ID of the company that owns this contact.
24
+ # @param id [Integer] The ID of the contact you wish to delete.
25
+ # @return [object[]]
29
26
  def delete_contact(companyId, id)
30
27
  path = "/api/v2/companies/#{companyId}/contacts/#{id}"
31
-
32
28
  delete(path)
33
29
  end
34
30
 
35
31
 
36
32
  # Retrieve a single contact
37
- #
33
+ #
38
34
  # Get the contact object identified by this URL.
39
35
  # A 'contact' is a person associated with a company who is designated to handle certain responsibilities of
40
36
  # a tax collecting and filing entity.
41
- #
42
- # @param int companyId The ID of the company for this contact
43
- # @param int id The primary key of this contact
44
- # @return ContactModel
37
+ # @param companyId [Integer] The ID of the company for this contact
38
+ # @param id [Integer] The primary key of this contact
39
+ # @return [Object]
45
40
  def get_contact(companyId, id)
46
41
  path = "/api/v2/companies/#{companyId}/contacts/#{id}"
47
-
48
42
  get(path)
49
43
  end
50
44
 
51
45
 
52
46
  # Retrieve contacts for this company
53
- #
47
+ #
54
48
  # List all contact objects assigned to this company.
55
- #
49
+ #
56
50
  # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
57
51
  # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
58
- #
59
- # @param int companyId The ID of the company that owns these contacts
60
- # @param string filter 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/) .
61
- # @param string include A comma separated list of child objects to return underneath the primary object.
62
- # @param int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
63
- # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
64
- # @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
65
- # @return FetchResult
52
+ # @param companyId [Integer] The ID of the company that owns these contacts
53
+ # @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/) .
54
+ # @param include [String] A comma separated list of child objects to return underneath the primary object.
55
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
56
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
57
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
58
+ # @return [FetchResult]
66
59
  def list_contacts_by_company(companyId, options={})
67
60
  path = "/api/v2/companies/#{companyId}/contacts"
68
-
69
61
  get(path, options)
70
62
  end
71
63
 
72
64
 
73
65
  # Retrieve all contacts
74
- #
66
+ #
75
67
  # Get multiple contact objects across all companies.
76
68
  # A 'contact' is a person associated with a company who is designated to handle certain responsibilities of
77
69
  # a tax collecting and filing entity.
78
- #
70
+ #
79
71
  # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
80
72
  # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
81
- #
82
- # @param string filter 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/) .
83
- # @param string include A comma separated list of child objects to return underneath the primary object.
84
- # @param int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
85
- # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
86
- # @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
87
- # @return FetchResult
73
+ # @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/) .
74
+ # @param include [String] A comma separated list of child objects to return underneath the primary object.
75
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
76
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
77
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
78
+ # @return [FetchResult]
88
79
  def query_contacts(options={})
89
80
  path = "/api/v2/contacts"
90
-
91
81
  get(path, options)
92
82
  end
93
83
 
94
84
 
95
85
  # Update a single contact
96
- #
86
+ #
97
87
  # Replace the existing contact object at this URL with an updated object.
98
88
  # A 'contact' is a person associated with a company who is designated to handle certain responsibilities of
99
89
  # a tax collecting and filing entity.
100
- # All data from the existing object will be replaced with data in the object you PUT.
90
+ # All data from the existing object will be replaced with data in the object you PUT.
101
91
  # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
102
- #
103
- # @param int companyId The ID of the company that this contact belongs to.
104
- # @param int id The ID of the contact you wish to update
105
- # @param ContactModel model The contact you wish to update.
106
- # @return ContactModel
92
+ # @param companyId [Integer] The ID of the company that this contact belongs to.
93
+ # @param id [Integer] The ID of the contact you wish to update
94
+ # @param model [Object] The contact you wish to update.
95
+ # @return [Object]
107
96
  def update_contact(companyId, id, model)
108
97
  path = "/api/v2/companies/#{companyId}/contacts/#{id}"
109
-
110
98
  put(path, model)
111
99
  end
112
100
 
@@ -3,564 +3,522 @@ module AvaTax
3
3
  module Definitions
4
4
 
5
5
 
6
- # Retrieve the full list of Avalara-supported nexus for a country and region.
7
- #
8
- # Returns all Avalara-supported nexus for the specified country and region.
9
- # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region.
10
- #
11
- # @param string country The two-character ISO-3166 code for the country.
12
- # @param string region The two or three character region code for the region.
13
- # @return FetchResult
14
- def api_v2_definitions_nexus_by_country_by_region_get(country, region)
15
- path = "/api/v2/definitions/nexus/#{country}/#{region}"
16
-
6
+ # Test whether a form supports online login verification
7
+ #
8
+ # This API is intended to be useful to identify whether the user should be allowed
9
+ # to automatically verify their login and password.
10
+ # @param form [String] The name of the form you would like to verify. This can be the tax form code or the legacy return name
11
+ # @return [FetchResult]
12
+ def get_login_verifier_by_form(form)
13
+ path = "/api/v2/definitions/filingcalendars/loginverifiers/#{form}"
17
14
  get(path)
18
15
  end
19
16
 
20
17
 
21
- # Retrieve the full list of Avalara-supported nexus for a country.
22
- #
23
- # Returns all Avalara-supported nexus for the specified country.
24
- # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country.
25
- #
26
- # @param string country
27
- # @return FetchResult
28
- def api_v2_definitions_nexus_by_country_get(country)
29
- path = "/api/v2/definitions/nexus/#{country}"
30
-
18
+ # Retrieve the full list of the AvaFile Forms available
19
+ #
20
+ # Returns the full list of Avalara-supported AvaFile Forms
21
+ # This API is intended to be useful to identify all the different AvaFile Forms
22
+ # @return [FetchResult]
23
+ def list_ava_file_forms()
24
+ path = "/api/v2/definitions/avafileforms"
31
25
  get(path)
32
26
  end
33
27
 
34
28
 
35
- # Retrieve the full list of Avalara-supported nexus for all countries and regions.
36
- #
37
- # Returns the full list of all Avalara-supported nexus for all countries and regions.
38
- # This API is intended to be useful if your user interface needs to display a selectable list of nexus.
39
- #
40
- # @return FetchResult
41
- def api_v2_definitions_nexus_get()
42
- path = "/api/v2/definitions/nexus"
43
-
29
+ # Retrieve the full list of communications transactiontypes
30
+ #
31
+ # Returns full list of communications transaction types which
32
+ # are accepted in communication tax calculation requests.
33
+ # @param id [Integer]
34
+ # @return [FetchResult]
35
+ def list_communications_service_types(id)
36
+ path = "/api/v2/definitions/communications/transactiontypes/#{id}/servicetypes"
44
37
  get(path)
45
38
  end
46
39
 
47
40
 
48
- # Test whether a form supports online login verification
49
- #
50
- # This API is intended to be useful to identify whether the user should be allowed
51
- # to automatically verify their login and password.
52
- #
53
- # @param string form The name of the form you would like to verify. This can be the tax form code or the legacy return name
54
- # @return FetchResult
55
- def get_login_verifier_by_form(form)
56
- path = "/api/v2/definitions/filingcalendars/loginverifiers/#{form}"
57
-
41
+ # Retrieve the full list of communications transactiontypes
42
+ #
43
+ # Returns full list of communications transaction types which
44
+ # are accepted in communication tax calculation requests.
45
+ # @return [FetchResult]
46
+ def list_communications_transaction_types()
47
+ path = "/api/v2/definitions/communications/transactiontypes"
58
48
  get(path)
59
49
  end
60
50
 
61
51
 
62
- # Retrieve the full list of the AvaFile Forms available
63
- #
64
- # Returns the full list of Avalara-supported AvaFile Forms
65
- # This API is intended to be useful to identify all the different AvaFile Forms
66
- #
67
- # @return FetchResult
68
- def list_ava_file_forms()
69
- path = "/api/v2/definitions/avafileforms"
70
-
52
+ # Retrieve the full list of communications transaction/service type pairs
53
+ #
54
+ # Returns full list of communications transaction/service type pairs which
55
+ # are accepted in communication tax calculation requests.
56
+ # @return [FetchResult]
57
+ def list_communications_t_s_pairs()
58
+ path = "/api/v2/definitions/communications/tspairs"
71
59
  get(path)
72
60
  end
73
61
 
74
62
 
75
63
  # List all ISO 3166 countries
76
- #
64
+ #
77
65
  # Returns a list of all ISO 3166 country codes, and their US English friendly names.
78
- # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a country for
66
+ # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a country for
79
67
  # a shipping address.
80
- #
81
- # @return FetchResult
68
+ # @return [FetchResult]
82
69
  def list_countries()
83
70
  path = "/api/v2/definitions/countries"
84
-
85
71
  get(path)
86
72
  end
87
73
 
88
74
 
89
75
  # Retrieve the full list of Avalara-supported entity use codes
90
- #
76
+ #
91
77
  # Returns the full list of Avalara-supported entity use codes.
92
78
  # Entity/Use Codes are definitions of the entity who is purchasing something, or the purpose for which the transaction
93
79
  # is occurring. This information is generally used to determine taxability of the product.
94
80
  # In order to facilitate correct reporting of your taxes, you are encouraged to select the proper entity use codes for
95
81
  # all transactions that are exempt.
96
- #
97
- # @return FetchResult
82
+ # @return [FetchResult]
98
83
  def list_entity_use_codes()
99
84
  path = "/api/v2/definitions/entityusecodes"
100
-
101
85
  get(path)
102
86
  end
103
87
 
104
88
 
105
89
  # Retrieve the full list of Avalara-supported filing frequencies.
106
- #
90
+ #
107
91
  # Returns the full list of Avalara-supported filing frequencies.
108
92
  # This API is intended to be useful to identify all the different filing frequencies that can be used in notices.
109
- #
110
- # @return FetchResult
93
+ # @return [FetchResult]
111
94
  def list_filing_frequencies()
112
95
  path = "/api/v2/definitions/filingfrequencies"
113
-
114
96
  get(path)
115
97
  end
116
98
 
117
99
 
118
100
  # List jurisdictions near a specific address
119
- #
101
+ #
120
102
  # Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.
121
- #
103
+ #
122
104
  # This API allows you to identify which jurisdictions are nearby a specific address according to the best available geocoding information.
123
- # It is intended to allow you to create a "Jurisdiction Override", which allows an address to be configured as belonging to a nearby
105
+ # It is intended to allow you to create a "Jurisdiction Override", which allows an address to be configured as belonging to a nearby
124
106
  # jurisdiction in AvaTax.
125
- #
107
+ #
126
108
  # The results of this API call can be passed to the `CreateJurisdictionOverride` API call.
127
- #
128
- # @param string line1 The first address line portion of this address.
129
- # @param string line2 The second address line portion of this address.
130
- # @param string line3 The third address line portion of this address.
131
- # @param string city The city portion of this address.
132
- # @param string region The region, state, or province code portion of this address.
133
- # @param string postalCode The postal code or zip code portion of this address.
134
- # @param string country The two-character ISO-3166 code of the country portion of this address.
135
- # @return FetchResult
109
+ # @param line1 [String] The first address line portion of this address.
110
+ # @param line2 [String] The second address line portion of this address.
111
+ # @param line3 [String] The third address line portion of this address.
112
+ # @param city [String] The city portion of this address.
113
+ # @param region [String] The region, state, or province code portion of this address.
114
+ # @param postalCode [String] The postal code or zip code portion of this address.
115
+ # @param country [String] The two-character ISO-3166 code of the country portion of this address.
116
+ # @return [FetchResult]
136
117
  def list_jurisdictions_by_address(options={})
137
118
  path = "/api/v2/definitions/jurisdictionsnearaddress"
138
-
139
119
  get(path, options)
140
120
  end
141
121
 
142
122
 
143
123
  # Retrieve the list of questions that are required for a tax location
144
- #
124
+ #
145
125
  # Returns the list of additional questions you must answer when declaring a location in certain taxing jurisdictions.
146
126
  # Some tax jurisdictions require that you register or provide additional information to configure each physical place where
147
127
  # your company does business.
148
128
  # This information is not usually required in order to calculate tax correctly, but is almost always required to file your tax correctly.
149
129
  # You can call this API call for any address and obtain information about what questions must be answered in order to properly
150
130
  # file tax in that location.
151
- #
152
- # @param string line1 The first line of this location's address.
153
- # @param string line2 The second line of this location's address.
154
- # @param string line3 The third line of this location's address.
155
- # @param string city The city part of this location's address.
156
- # @param string region The region, state, or province part of this location's address.
157
- # @param string postalCode The postal code of this location's address.
158
- # @param string country The country part of this location's address.
159
- # @param float latitude Optionally identify the location via latitude/longitude instead of via address.
160
- # @param float longitude Optionally identify the location via latitude/longitude instead of via address.
161
- # @return FetchResult
131
+ # @param line1 [String] The first line of this location's address.
132
+ # @param line2 [String] The second line of this location's address.
133
+ # @param line3 [String] The third line of this location's address.
134
+ # @param city [String] The city part of this location's address.
135
+ # @param region [String] The region, state, or province part of this location's address.
136
+ # @param postalCode [String] The postal code of this location's address.
137
+ # @param country [String] The country part of this location's address.
138
+ # @param latitude [BigDecimal] Optionally identify the location via latitude/longitude instead of via address.
139
+ # @param longitude [BigDecimal] Optionally identify the location via latitude/longitude instead of via address.
140
+ # @return [FetchResult]
162
141
  def list_location_questions_by_address(options={})
163
142
  path = "/api/v2/definitions/locationquestions"
164
-
165
143
  get(path, options)
166
144
  end
167
145
 
168
146
 
169
147
  # List all forms where logins can be verified automatically
170
- #
148
+ #
171
149
  # List all forms where logins can be verified automatically.
172
150
  # This API is intended to be useful to identify whether the user should be allowed
173
151
  # to automatically verify their login and password.
174
- #
175
- # @return FetchResult
152
+ # @return [FetchResult]
176
153
  def list_login_verifiers()
177
154
  path = "/api/v2/definitions/filingcalendars/loginverifiers"
178
-
155
+ get(path)
156
+ end
157
+
158
+
159
+ # Retrieve the full list of Avalara-supported nexus for all countries and regions.
160
+ #
161
+ # Returns the full list of all Avalara-supported nexus for all countries and regions.
162
+ # This API is intended to be useful if your user interface needs to display a selectable list of nexus.
163
+ # @return [FetchResult]
164
+ def list_nexus()
165
+ path = "/api/v2/definitions/nexus"
179
166
  get(path)
180
167
  end
181
168
 
182
169
 
183
170
  # List all nexus that apply to a specific address.
184
- #
171
+ #
185
172
  # Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.
186
173
  # This API allows you to identify which tax authorities apply to a physical location, salesperson address, or point of sale.
187
174
  # In general, it is usually expected that a company will declare nexus in all the jurisdictions that apply to each physical address
188
175
  # where the company does business.
189
176
  # The results of this API call can be passed to the 'Create Nexus' API call to declare nexus for this address.
190
- #
191
- # @param string line1 The first address line portion of this address.
192
- # @param string line2 The first address line portion of this address.
193
- # @param string line3 The first address line portion of this address.
194
- # @param string city The city portion of this address.
195
- # @param string region The region, state, or province code portion of this address.
196
- # @param string postalCode The postal code or zip code portion of this address.
197
- # @param string country The two-character ISO-3166 code of the country portion of this address.
198
- # @return FetchResult
177
+ # @param line1 [String] The first address line portion of this address.
178
+ # @param line2 [String] The first address line portion of this address.
179
+ # @param line3 [String] The first address line portion of this address.
180
+ # @param city [String] The city portion of this address.
181
+ # @param region [String] The region, state, or province code portion of this address.
182
+ # @param postalCode [String] The postal code or zip code portion of this address.
183
+ # @param country [String] The two-character ISO-3166 code of the country portion of this address.
184
+ # @return [FetchResult]
199
185
  def list_nexus_by_address(options={})
200
186
  path = "/api/v2/definitions/nexus/byaddress"
201
-
202
187
  get(path, options)
203
188
  end
204
189
 
205
190
 
191
+ # Retrieve the full list of Avalara-supported nexus for a country.
192
+ #
193
+ # Returns all Avalara-supported nexus for the specified country.
194
+ # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country.
195
+ # @param country [String]
196
+ # @return [FetchResult]
197
+ def list_nexus_by_country(country)
198
+ path = "/api/v2/definitions/nexus/#{country}"
199
+ get(path)
200
+ end
201
+
202
+
203
+ # Retrieve the full list of Avalara-supported nexus for a country and region.
204
+ #
205
+ # Returns all Avalara-supported nexus for the specified country and region.
206
+ # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region.
207
+ # @param country [String] The two-character ISO-3166 code for the country.
208
+ # @param region [String] The two or three character region code for the region.
209
+ # @return [FetchResult]
210
+ def list_nexus_by_country_and_region(country, region)
211
+ path = "/api/v2/definitions/nexus/#{country}/#{region}"
212
+ get(path)
213
+ end
214
+
215
+
206
216
  # List nexus related to a tax form
207
- #
217
+ #
208
218
  # Retrieves a list of nexus related to a tax form.
209
- #
219
+ #
210
220
  # The concept of `Nexus` indicates a place where your company has sufficient physical presence and is obligated
211
221
  # to collect and remit transaction-based taxes.
212
- #
222
+ #
213
223
  # When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax
214
224
  # in all jurisdictions affected by your transactions.
215
- #
225
+ #
216
226
  # This API is intended to provide useful information when examining a tax form. If you are about to begin filing
217
- # a tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax
227
+ # a tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax
218
228
  # form in order to better understand how the form will be filled out.
219
- #
220
- # @param string formCode The form code that we are looking up the nexus for
221
- # @return NexusByTaxFormModel
229
+ # @param formCode [String] The form code that we are looking up the nexus for
230
+ # @return [Object]
222
231
  def list_nexus_by_form_code(formCode)
223
232
  path = "/api/v2/definitions/nexus/byform/#{formCode}"
224
-
225
233
  get(path)
226
234
  end
227
235
 
228
236
 
229
237
  # Retrieve the full list of nexus tax type groups
230
- #
238
+ #
231
239
  # Returns the full list of Avalara-supported nexus tax type groups
232
240
  # This API is intended to be useful to identify all the different tax sub-types.
233
- #
234
- # @return FetchResult
241
+ # @return [FetchResult]
235
242
  def list_nexus_tax_type_groups()
236
243
  path = "/api/v2/definitions/nexustaxtypegroups"
237
-
238
244
  get(path)
239
245
  end
240
246
 
241
247
 
242
248
  # Retrieve the full list of Avalara-supported tax notice customer funding options.
243
- #
249
+ #
244
250
  # Returns the full list of Avalara-supported tax notice customer funding options.
245
251
  # This API is intended to be useful to identify all the different notice customer funding options that can be used in notices.
246
- #
247
- # @return FetchResult
252
+ # @return [FetchResult]
248
253
  def list_notice_customer_funding_options()
249
254
  path = "/api/v2/definitions/noticecustomerfundingoptions"
250
-
251
255
  get(path)
252
256
  end
253
257
 
254
258
 
255
259
  # Retrieve the full list of Avalara-supported tax notice customer types.
256
- #
260
+ #
257
261
  # Returns the full list of Avalara-supported tax notice customer types.
258
262
  # This API is intended to be useful to identify all the different notice customer types.
259
- #
260
- # @return FetchResult
263
+ # @return [FetchResult]
261
264
  def list_notice_customer_types()
262
265
  path = "/api/v2/definitions/noticecustomertypes"
263
-
264
266
  get(path)
265
267
  end
266
268
 
267
269
 
268
270
  # Retrieve the full list of Avalara-supported tax notice filing types.
269
- #
271
+ #
270
272
  # Returns the full list of Avalara-supported tax notice filing types.
271
273
  # This API is intended to be useful to identify all the different notice filing types that can be used in notices.
272
- #
273
- # @return FetchResult
274
+ # @return [FetchResult]
274
275
  def list_notice_filingtypes()
275
276
  path = "/api/v2/definitions/noticefilingtypes"
276
-
277
277
  get(path)
278
278
  end
279
279
 
280
280
 
281
281
  # Retrieve the full list of Avalara-supported tax notice priorities.
282
- #
282
+ #
283
283
  # Returns the full list of Avalara-supported tax notice priorities.
284
284
  # This API is intended to be useful to identify all the different notice priorities that can be used in notices.
285
- #
286
- # @return FetchResult
285
+ # @return [FetchResult]
287
286
  def list_notice_priorities()
288
287
  path = "/api/v2/definitions/noticepriorities"
289
-
290
288
  get(path)
291
289
  end
292
290
 
293
291
 
294
292
  # Retrieve the full list of Avalara-supported tax notice reasons.
295
- #
293
+ #
296
294
  # Returns the full list of Avalara-supported tax notice reasons.
297
295
  # This API is intended to be useful to identify all the different tax notice reasons.
298
- #
299
- # @return FetchResult
296
+ # @return [FetchResult]
300
297
  def list_notice_reasons()
301
298
  path = "/api/v2/definitions/noticereasons"
302
-
303
299
  get(path)
304
300
  end
305
301
 
306
302
 
307
303
  # Retrieve the full list of Avalara-supported tax notice responsibility ids
308
- #
304
+ #
309
305
  # Returns the full list of Avalara-supported tax notice responsibility ids
310
306
  # This API is intended to be useful to identify all the different tax notice responsibilities.
311
- #
312
- # @return FetchResult
307
+ # @return [FetchResult]
313
308
  def list_notice_responsibilities()
314
309
  path = "/api/v2/definitions/noticeresponsibilities"
315
-
316
310
  get(path)
317
311
  end
318
312
 
319
313
 
320
314
  # Retrieve the full list of Avalara-supported tax notice root causes
321
- #
315
+ #
322
316
  # Returns the full list of Avalara-supported tax notice root causes
323
317
  # This API is intended to be useful to identify all the different tax notice root causes.
324
- #
325
- # @return FetchResult
318
+ # @return [FetchResult]
326
319
  def list_notice_root_causes()
327
320
  path = "/api/v2/definitions/noticerootcauses"
328
-
329
321
  get(path)
330
322
  end
331
323
 
332
324
 
333
325
  # Retrieve the full list of Avalara-supported tax notice statuses.
334
- #
326
+ #
335
327
  # Returns the full list of Avalara-supported tax notice statuses.
336
328
  # This API is intended to be useful to identify all the different tax notice statuses.
337
- #
338
- # @return FetchResult
329
+ # @return [FetchResult]
339
330
  def list_notice_statuses()
340
331
  path = "/api/v2/definitions/noticestatuses"
341
-
342
332
  get(path)
343
333
  end
344
334
 
345
335
 
346
336
  # Retrieve the full list of Avalara-supported tax notice types.
347
- #
337
+ #
348
338
  # Returns the full list of Avalara-supported tax notice types.
349
339
  # This API is intended to be useful to identify all the different notice types that can be used in notices.
350
- #
351
- # @return FetchResult
340
+ # @return [FetchResult]
352
341
  def list_notice_types()
353
342
  path = "/api/v2/definitions/noticetypes"
354
-
355
343
  get(path)
356
344
  end
357
345
 
358
346
 
359
347
  # Retrieve the full list of Avalara-supported extra parameters for creating transactions.
360
- #
348
+ #
361
349
  # Returns the full list of Avalara-supported extra parameters for the 'Create Transaction' API call.
362
350
  # This list of parameters is available for use when configuring your transaction.
363
351
  # Some parameters are only available for use if you have subscribed to certain features of AvaTax.
364
- #
365
- # @return FetchResult
352
+ # @return [FetchResult]
366
353
  def list_parameters()
367
354
  path = "/api/v2/definitions/parameters"
368
-
369
355
  get(path)
370
356
  end
371
357
 
372
358
 
373
359
  # Retrieve the full list of Avalara-supported permissions
374
- #
360
+ #
375
361
  # Returns the full list of Avalara-supported permission types.
376
362
  # This API is intended to be useful to identify the capabilities of a particular user logon.
377
- #
378
- # @return FetchResult
363
+ # @return [FetchResult]
379
364
  def list_permissions()
380
365
  path = "/api/v2/definitions/permissions"
381
-
382
366
  get(path)
383
367
  end
384
368
 
385
369
 
386
370
  # Retrieve the full list of rate types for each country
387
- #
371
+ #
388
372
  # Returns the full list of Avalara-supported rate type file types
389
373
  # This API is intended to be useful to identify all the different rate types.
390
- #
391
- # @param string country
392
- # @return FetchResult
374
+ # @param country [String]
375
+ # @return [FetchResult]
393
376
  def list_rate_types_by_country(country)
394
377
  path = "/api/v2/definitions/countries/#{country}/ratetypes"
395
-
396
378
  get(path)
397
379
  end
398
380
 
399
381
 
400
382
  # List all ISO 3166 regions
401
- #
383
+ #
402
384
  # Returns a list of all ISO 3166 region codes and their US English friendly names.
403
- # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region
385
+ # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region
404
386
  # within the country for a shipping addresses.
405
- #
406
- # @return FetchResult
387
+ # @return [FetchResult]
407
388
  def list_regions()
408
389
  path = "/api/v2/definitions/regions"
409
-
410
390
  get(path)
411
391
  end
412
392
 
413
393
 
414
394
  # List all ISO 3166 regions for a country
415
- #
395
+ #
416
396
  # Returns a list of all ISO 3166 region codes for a specific country code, and their US English friendly names.
417
- # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region
397
+ # This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region
418
398
  # within the country for a shipping addresses.
419
- #
420
- # @param string country
421
- # @return FetchResult
399
+ # @param country [String]
400
+ # @return [FetchResult]
422
401
  def list_regions_by_country(country)
423
402
  path = "/api/v2/definitions/countries/#{country}/regions"
424
-
425
403
  get(path)
426
404
  end
427
405
 
428
406
 
429
407
  # Retrieve the full list of Avalara-supported resource file types
430
- #
408
+ #
431
409
  # Returns the full list of Avalara-supported resource file types
432
410
  # This API is intended to be useful to identify all the different resource file types.
433
- #
434
- # @return FetchResult
411
+ # @return [FetchResult]
435
412
  def list_resource_file_types()
436
413
  path = "/api/v2/definitions/resourcefiletypes"
437
-
438
414
  get(path)
439
415
  end
440
416
 
441
417
 
442
418
  # Retrieve the full list of Avalara-supported permissions
443
- #
419
+ #
444
420
  # Returns the full list of Avalara-supported permission types.
445
421
  # This API is intended to be useful when designing a user interface for selecting the security role of a user account.
446
422
  # Some security roles are restricted for Avalara internal use.
447
- #
448
- # @return FetchResult
423
+ # @return [FetchResult]
449
424
  def list_security_roles()
450
425
  path = "/api/v2/definitions/securityroles"
451
-
452
426
  get(path)
453
427
  end
454
428
 
455
429
 
456
430
  # Retrieve the full list of Avalara-supported subscription types
457
- #
431
+ #
458
432
  # Returns the full list of Avalara-supported subscription types.
459
433
  # This API is intended to be useful for identifying which features you have added to your account.
460
434
  # You may always contact Avalara's sales department for information on available products or services.
461
435
  # You cannot change your subscriptions directly through the API.
462
- #
463
- # @return FetchResult
436
+ # @return [FetchResult]
464
437
  def list_subscription_types()
465
438
  path = "/api/v2/definitions/subscriptiontypes"
466
-
467
439
  get(path)
468
440
  end
469
441
 
470
442
 
471
443
  # Retrieve the full list of Avalara-supported tax authorities.
472
- #
444
+ #
473
445
  # Returns the full list of Avalara-supported tax authorities.
474
446
  # This API is intended to be useful to identify all the different authorities that receive tax.
475
- #
476
- # @return FetchResult
447
+ # @return [FetchResult]
477
448
  def list_tax_authorities()
478
449
  path = "/api/v2/definitions/taxauthorities"
479
-
480
450
  get(path)
481
451
  end
482
452
 
483
453
 
484
454
  # Retrieve the full list of Avalara-supported forms for each tax authority.
485
- #
455
+ #
486
456
  # Returns the full list of Avalara-supported forms for each tax authority.
487
457
  # This list represents tax forms that Avalara recognizes.
488
- # Customers who subscribe to Avalara Managed Returns Service can request these forms to be filed automatically
458
+ # Customers who subscribe to Avalara Managed Returns Service can request these forms to be filed automatically
489
459
  # based on the customer's AvaTax data.
490
- #
491
- # @return FetchResult
460
+ # @return [FetchResult]
492
461
  def list_tax_authority_forms()
493
462
  path = "/api/v2/definitions/taxauthorityforms"
494
-
495
463
  get(path)
496
464
  end
497
465
 
498
466
 
499
467
  # Retrieve the full list of Avalara-supported tax authority types.
500
- #
468
+ #
501
469
  # Returns the full list of Avalara-supported tax authority types.
502
470
  # This API is intended to be useful to identify all the different authority types.
503
- #
504
- # @return FetchResult
471
+ # @return [FetchResult]
505
472
  def list_tax_authority_types()
506
473
  path = "/api/v2/definitions/taxauthoritytypes"
507
-
508
474
  get(path)
509
475
  end
510
476
 
511
477
 
512
478
  # Retrieve the full list of Avalara-supported tax codes.
513
- #
479
+ #
514
480
  # Retrieves the list of Avalara-supported system tax codes.
515
481
  # A 'TaxCode' represents a uniquely identified type of product, good, or service.
516
482
  # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
517
483
  # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
518
484
  # taxability rules for this product in all supported jurisdictions.
519
- #
520
- # @return FetchResult
485
+ # @return [FetchResult]
521
486
  def list_tax_codes()
522
487
  path = "/api/v2/definitions/taxcodes"
523
-
524
488
  get(path)
525
489
  end
526
490
 
527
491
 
528
492
  # Retrieve the full list of Avalara-supported tax code types.
529
- #
493
+ #
530
494
  # Returns the full list of recognized tax code types.
531
495
  # A 'Tax Code Type' represents a broad category of tax codes, and is less detailed than a single TaxCode.
532
496
  # This API is intended to be useful for broadly searching for tax codes by tax code type.
533
- #
534
- # @return TaxCodeTypesModel
497
+ # @return [Object]
535
498
  def list_tax_code_types()
536
499
  path = "/api/v2/definitions/taxcodetypes"
537
-
538
500
  get(path)
539
501
  end
540
502
 
541
503
 
542
504
  # Retrieve the full list of tax sub types
543
- #
505
+ #
544
506
  # Returns the full list of Avalara-supported tax sub-types
545
507
  # This API is intended to be useful to identify all the different tax sub-types.
546
- #
547
- # @return FetchResult
508
+ # @return [FetchResult]
548
509
  def list_tax_sub_types()
549
510
  path = "/api/v2/definitions/taxsubtypes"
550
-
551
511
  get(path)
552
512
  end
553
513
 
554
514
 
555
515
  # Retrieve the full list of tax type groups
556
- #
516
+ #
557
517
  # Returns the full list of Avalara-supported tax type groups
558
518
  # This API is intended to be useful to identify all the different tax type groups.
559
- #
560
- # @return FetchResult
519
+ # @return [FetchResult]
561
520
  def list_tax_type_groups()
562
521
  path = "/api/v2/definitions/taxtypegroups"
563
-
564
522
  get(path)
565
523
  end
566
524