avatax 21.6.0 → 21.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/avatax/client/accounts.rb +83 -83
- data/lib/avatax/client/addresses.rb +20 -20
- data/lib/avatax/client/advancedrules.rb +41 -41
- data/lib/avatax/client/avafileforms.rb +41 -41
- data/lib/avatax/client/batches.rb +62 -62
- data/lib/avatax/client/certexpressinvites.rb +27 -27
- data/lib/avatax/client/certificates.rb +111 -111
- data/lib/avatax/client/companies.rb +153 -153
- data/lib/avatax/client/contacts.rb +48 -48
- data/lib/avatax/client/customers.rb +97 -97
- data/lib/avatax/client/datasources.rb +48 -48
- data/lib/avatax/client/definitions.rb +558 -443
- data/lib/avatax/client/distancethresholds.rb +48 -48
- data/lib/avatax/client/ecommercetoken.rb +16 -16
- data/lib/avatax/client/filingcalendars.rb +41 -20
- data/lib/avatax/client/filings.rb +22 -20
- data/lib/avatax/client/firmclientlinkages.rb +69 -69
- data/lib/avatax/client/free.rb +13 -13
- data/lib/avatax/client/fundingrequests.rb +20 -20
- data/lib/avatax/client/items.rb +185 -181
- data/lib/avatax/client/jurisdictionoverrides.rb +48 -48
- data/lib/avatax/client/locations.rb +90 -90
- data/lib/avatax/client/multidocument.rb +76 -76
- data/lib/avatax/client/nexus.rb +133 -105
- data/lib/avatax/client/notices.rb +22 -22
- data/lib/avatax/client/notifications.rb +27 -27
- data/lib/avatax/client/provisioning.rb +20 -20
- data/lib/avatax/client/registrar.rb +85 -75
- data/lib/avatax/client/reports.rb +34 -34
- data/lib/avatax/client/settings.rb +48 -48
- data/lib/avatax/client/subscriptions.rb +27 -27
- data/lib/avatax/client/taxcodes.rb +48 -48
- data/lib/avatax/client/taxcontent.rb +41 -41
- data/lib/avatax/client/taxrules.rb +50 -50
- data/lib/avatax/client/transactions.rb +153 -153
- data/lib/avatax/client/upcs.rb +48 -48
- data/lib/avatax/client/users.rb +62 -62
- data/lib/avatax/client/utilities.rb +27 -27
- data/lib/avatax/request.rb +11 -3
- data/lib/avatax/version.rb +1 -1
- metadata +11 -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,158 +18,169 @@ module AvaTax
|
|
18
18
|
#
|
19
19
|
# ### Security Policies
|
20
20
|
#
|
21
|
-
# * This API depends on the following active services:*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
|
-
#
|
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 Avalara-supported usage of extra parameters for classification of a item.
|
110
|
-
#
|
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
|
+
#
|
111
122
|
# Returns the full list of Avalara-supported usage of extra parameters for item classification.
|
112
123
|
# The list of parameters is available for use with Item Classification.
|
113
|
-
# Some parameters are only available for use if you have subscribed to certain features of AvaTax.
|
124
|
+
# Some parameters are only available for use if you have subscribed to certain features of AvaTax.
|
114
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
|
115
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.
|
116
127
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
117
128
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
118
|
-
# @return [FetchResult]
|
119
|
-
def list_classification_parameters_usage(options={}) path = "/api/v2/definitions/classification/parametersusage"
|
120
|
-
get(path, options) end
|
121
|
-
|
122
|
-
# Retrieve the full list of communications service types
|
123
|
-
#
|
124
|
-
# Returns full list of service types for a given transaction type ID.
|
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.
|
125
136
|
# @param id [Integer] The transaction type ID to examine
|
126
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
|
127
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.
|
128
139
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
129
140
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
130
|
-
# @return [FetchResult]
|
131
|
-
def list_communications_service_types(id, options={}) path = "/api/v2/definitions/communications/transactiontypes/#{id}/servicetypes"
|
132
|
-
get(path, options) end
|
133
|
-
|
134
|
-
# Retrieve the full list of communications transactiontypes
|
135
|
-
#
|
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
|
+
#
|
136
147
|
# Returns full list of communications transaction types which
|
137
|
-
# are accepted in communication tax calculation requests.
|
148
|
+
# are accepted in communication tax calculation requests.
|
138
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/).
|
139
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.
|
140
151
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
141
152
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
142
|
-
# @return [FetchResult]
|
143
|
-
def list_communications_transaction_types(options={}) path = "/api/v2/definitions/communications/transactiontypes"
|
144
|
-
get(path, options) end
|
145
|
-
|
146
|
-
# Retrieve the full list of communications transaction/service type pairs
|
147
|
-
#
|
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
|
+
#
|
148
159
|
# Returns full list of communications transaction/service type pairs which
|
149
|
-
# are accepted in communication tax calculation requests.
|
160
|
+
# are accepted in communication tax calculation requests.
|
150
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
|
151
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.
|
152
163
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
153
164
|
# @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_communications_t_s_pairs(options={}) path = "/api/v2/definitions/communications/tspairs"
|
156
|
-
get(path, options) end
|
157
|
-
|
158
|
-
# List all ISO 3166 countries
|
159
|
-
#
|
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
|
+
#
|
160
171
|
# Returns a list of all ISO 3166 country codes, and their US English friendly names.
|
161
172
|
# This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a country for
|
162
|
-
# a shipping address.
|
173
|
+
# a shipping address.
|
163
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
|
164
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.
|
165
176
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
166
177
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
167
|
-
# @return [FetchResult]
|
168
|
-
def list_countries(options={}) path = "/api/v2/definitions/countries"
|
169
|
-
get(path, options) end
|
170
|
-
|
171
|
-
# List certificate exposure zones used by a company
|
172
|
-
#
|
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
|
+
#
|
173
184
|
# List available cover letters that can be used when sending invitation to use CertExpress to upload certificates.
|
174
185
|
#
|
175
186
|
# The CoverLetter model represents a message sent along with an invitation to use CertExpress to
|
@@ -177,17 +188,17 @@ module AvaTax
|
|
177
188
|
# certificates directly; this cover letter explains why the invitation was sent.
|
178
189
|
#
|
179
190
|
# If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
|
180
|
-
# check and provision account.
|
191
|
+
# check and provision account.
|
181
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
|
182
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.
|
183
194
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
184
195
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
185
|
-
# @return [FetchResult]
|
186
|
-
def list_cover_letters(options={}) path = "/api/v2/definitions/coverletters"
|
187
|
-
get(path, options) end
|
188
|
-
|
189
|
-
# Lists the next level of HS Codes given a destination country and HS Code prefix.
|
190
|
-
#
|
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
|
+
#
|
191
202
|
# Retrieves a list of HS Codes that are the children of the prefix for the given destination country, if
|
192
203
|
# additional children are available.
|
193
204
|
#
|
@@ -199,19 +210,19 @@ module AvaTax
|
|
199
210
|
#
|
200
211
|
# ### Security Policies
|
201
212
|
#
|
202
|
-
# * This API depends on the following active services:*Required* (all): AvaTaxGlobal.
|
213
|
+
# * This API depends on the following active services:*Required* (all): AvaTaxGlobal.
|
203
214
|
# @param country [String] The name or code of the destination country.
|
204
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.
|
205
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
|
206
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.
|
207
218
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
208
219
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
209
|
-
# @return [FetchResult]
|
210
|
-
def list_cross_border_codes(country, hsCode, options={}) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}"
|
211
|
-
get(path, options) end
|
212
|
-
|
213
|
-
# List top level HS Code Sections.
|
214
|
-
#
|
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
|
+
#
|
215
226
|
# Returns the full list of top level HS Code Sections. Sections are the broadest level of detail for
|
216
227
|
# classifying tariff codes and the items to which they apply. HS Codes are organized
|
217
228
|
# by Section/Chapter/Heading/Subheading/Classification.
|
@@ -221,77 +232,77 @@ module AvaTax
|
|
221
232
|
#
|
222
233
|
# ### Security Policies
|
223
234
|
#
|
224
|
-
# * This API depends on the following active services:*Required* (all): AvaTaxGlobal.
|
225
|
-
# @return [FetchResult]
|
226
|
-
def list_cross_border_sections() path = "/api/v2/definitions/crossborder/sections"
|
227
|
-
get(path) end
|
228
|
-
|
229
|
-
# List all ISO 4217 currencies supported by AvaTax.
|
230
|
-
#
|
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
|
+
#
|
231
242
|
# Lists all ISO 4217 currencies supported by AvaTax.
|
232
243
|
#
|
233
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
|
234
|
-
# `currencyCode` field in a `CreateTransactionModel`.
|
245
|
+
# `currencyCode` field in a `CreateTransactionModel`.
|
235
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/).
|
236
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.
|
237
248
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
238
249
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
239
|
-
# @return [FetchResult]
|
240
|
-
def list_currencies(options={}) path = "/api/v2/definitions/currencies"
|
241
|
-
get(path, options) end
|
242
|
-
|
243
|
-
# Retrieve the full list of Avalara-supported entity use codes
|
244
|
-
#
|
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
|
+
#
|
245
256
|
# Returns the full list of Avalara-supported entity use codes.
|
246
257
|
# Entity/Use Codes are definitions of the entity who is purchasing something, or the purpose for which the transaction
|
247
258
|
# is occurring. This information is generally used to determine taxability of the product.
|
248
259
|
# In order to facilitate correct reporting of your taxes, you are encouraged to select the proper entity use codes for
|
249
|
-
# all transactions that are exempt.
|
260
|
+
# all transactions that are exempt.
|
250
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
|
251
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.
|
252
263
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
253
264
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
254
|
-
# @return [FetchResult]
|
255
|
-
def list_entity_use_codes(options={}) path = "/api/v2/definitions/entityusecodes"
|
256
|
-
get(path, options) end
|
257
|
-
|
258
|
-
# Retrieve the full list of Avalara-supported filing frequencies.
|
259
|
-
#
|
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
|
+
#
|
260
271
|
# Returns the full list of Avalara-supported filing frequencies.
|
261
|
-
# 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.
|
262
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/).
|
263
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.
|
264
275
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
265
276
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
266
|
-
# @return [FetchResult]
|
267
|
-
def list_filing_frequencies(options={}) path = "/api/v2/definitions/filingfrequencies"
|
268
|
-
get(path, options) end
|
269
|
-
|
270
|
-
# List jurisdictions based on the filter provided
|
271
|
-
#
|
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
|
+
#
|
272
283
|
# Returns a list of all Avalara-supported taxing jurisdictions.
|
273
284
|
#
|
274
285
|
# This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying
|
275
286
|
# SQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01'
|
276
287
|
#
|
277
|
-
# 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.
|
278
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
|
279
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.
|
280
291
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
281
292
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
282
|
-
# @return [FetchResult]
|
283
|
-
def list_jurisdictions(options={}) path = "/api/v2/definitions/jurisdictions"
|
284
|
-
get(path, options) end
|
285
|
-
|
286
|
-
# List jurisdictions near a specific address
|
287
|
-
#
|
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
|
+
#
|
288
299
|
# Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.
|
289
300
|
#
|
290
301
|
# This API allows you to identify which jurisdictions are nearby a specific address according to the best available geocoding information.
|
291
302
|
# It is intended to allow you to create a "Jurisdiction Override", which allows an address to be configured as belonging to a nearby
|
292
303
|
# jurisdiction in AvaTax.
|
293
304
|
#
|
294
|
-
# 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.
|
295
306
|
# @param line1 [String] The first address line portion of this address.
|
296
307
|
# @param line2 [String] The second address line portion of this address.
|
297
308
|
# @param line3 [String] The third address line portion of this address.
|
@@ -303,18 +314,39 @@ module AvaTax
|
|
303
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.
|
304
315
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
305
316
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
306
|
-
# @return [FetchResult]
|
307
|
-
def list_jurisdictions_by_address(options={}) path = "/api/v2/definitions/jurisdictionsnearaddress"
|
308
|
-
get(path, options) end
|
309
|
-
|
310
|
-
#
|
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.
|
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'
|
311
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
|
+
#
|
312
344
|
# Returns the list of additional questions you must answer when declaring a location in certain taxing jurisdictions.
|
313
345
|
# Some tax jurisdictions require that you register or provide additional information to configure each physical place where
|
314
346
|
# your company does business.
|
315
347
|
# This information is not usually required in order to calculate tax correctly, but is almost always required to file your tax correctly.
|
316
348
|
# You can call this API call for any address and obtain information about what questions must be answered in order to properly
|
317
|
-
# file tax in that location.
|
349
|
+
# file tax in that location.
|
318
350
|
# @param line1 [String] The first line of this location's address.
|
319
351
|
# @param line2 [String] The second line of this location's address.
|
320
352
|
# @param line3 [String] The third line of this location's address.
|
@@ -328,54 +360,54 @@ module AvaTax
|
|
328
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.
|
329
361
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
330
362
|
# @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_location_questions_by_address(options={}) path = "/api/v2/definitions/locationquestions"
|
333
|
-
get(path, options) end
|
334
|
-
|
335
|
-
# List all forms where logins can be verified automatically
|
336
|
-
#
|
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
|
+
#
|
337
369
|
# List all forms where logins can be verified automatically.
|
338
370
|
# This API is intended to be useful to identify whether the user should be allowed
|
339
|
-
# to automatically verify their login and password.
|
371
|
+
# to automatically verify their login and password.
|
340
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
|
341
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.
|
342
374
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
343
375
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
344
|
-
# @return [FetchResult]
|
345
|
-
def list_login_verifiers(options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers"
|
346
|
-
get(path, options) end
|
347
|
-
|
348
|
-
# Retrieve the list of locations for a marketplace.
|
349
|
-
#
|
350
|
-
# 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.
|
351
383
|
# @param marketplaceId [String] MarketplaceId of a marketplace
|
352
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.
|
353
385
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
354
386
|
# @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_marketplace_locations(options={}) path = "/api/v2/definitions/marketplacelocations"
|
357
|
-
get(path, options) end
|
358
|
-
|
359
|
-
# Retrieve the full list of Avalara-supported nexus for all countries and regions.
|
360
|
-
#
|
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
|
+
#
|
361
393
|
# Returns the full list of all Avalara-supported nexus for all countries and regions.
|
362
394
|
#
|
363
|
-
# This API is intended to be useful if your user interface needs to display a selectable list of nexus.
|
364
|
-
# @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, taxableNexus
|
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
|
365
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.
|
366
398
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
367
399
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
368
|
-
# @return [FetchResult]
|
369
|
-
def list_nexus(options={}) path = "/api/v2/definitions/nexus"
|
370
|
-
get(path, options) end
|
371
|
-
|
372
|
-
# List all nexus that apply to a specific address.
|
373
|
-
#
|
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
|
+
#
|
374
406
|
# Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.
|
375
407
|
# This API allows you to identify which tax authorities apply to a physical location, salesperson address, or point of sale.
|
376
408
|
# In general, it is usually expected that a company will declare nexus in all the jurisdictions that apply to each physical address
|
377
409
|
# where the company does business.
|
378
|
-
# 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.
|
379
411
|
# @param line1 [String] The first address line portion of this address.
|
380
412
|
# @param line2 [String] The first address line portion of this address.
|
381
413
|
# @param line3 [String] The first address line portion of this address.
|
@@ -383,45 +415,45 @@ module AvaTax
|
|
383
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`.
|
384
416
|
# @param postalCode [String] The postal code or zip code portion of this address.
|
385
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`.
|
386
|
-
# @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, taxableNexus
|
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
|
387
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.
|
388
420
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
389
421
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
390
|
-
# @return [FetchResult]
|
391
|
-
def list_nexus_by_address(options={}) path = "/api/v2/definitions/nexus/byaddress"
|
392
|
-
get(path, options) end
|
393
|
-
|
394
|
-
# Retrieve the full list of Avalara-supported nexus for a country.
|
395
|
-
#
|
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
|
+
#
|
396
428
|
# Returns all Avalara-supported nexus for the specified country.
|
397
429
|
#
|
398
|
-
# 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.
|
399
431
|
# @param country [String] The country in which you want to fetch the system nexus
|
400
|
-
# @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, taxableNexus
|
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
|
401
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.
|
402
434
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
403
435
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
404
|
-
# @return [FetchResult]
|
405
|
-
def list_nexus_by_country(country, options={}) path = "/api/v2/definitions/nexus/#{country}"
|
406
|
-
get(path, options) end
|
407
|
-
|
408
|
-
# Retrieve the full list of Avalara-supported nexus for a country and region.
|
409
|
-
#
|
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
|
+
#
|
410
442
|
# Returns all Avalara-supported nexus for the specified country and region.
|
411
443
|
#
|
412
|
-
# 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.
|
413
445
|
# @param country [String] The two-character ISO-3166 code for the country.
|
414
446
|
# @param region [String] The two or three character region code for the region.
|
415
|
-
# @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, taxableNexus
|
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
|
416
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.
|
417
449
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
418
450
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
419
|
-
# @return [FetchResult]
|
420
|
-
def list_nexus_by_country_and_region(country, region, options={}) path = "/api/v2/definitions/nexus/#{country}/#{region}"
|
421
|
-
get(path, options) end
|
422
|
-
|
423
|
-
# List nexus related to a tax form
|
424
|
-
#
|
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
|
+
#
|
425
457
|
# Retrieves a list of nexus related to a tax form.
|
426
458
|
#
|
427
459
|
# The concept of `Nexus` indicates a place where your company has sufficient physical presence and is obligated
|
@@ -436,147 +468,161 @@ module AvaTax
|
|
436
468
|
#
|
437
469
|
# ### Security Policies
|
438
470
|
#
|
439
|
-
# * 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.
|
440
472
|
# @param formCode [String] The form code that we are looking up the nexus for
|
441
|
-
# @return [Object]
|
442
|
-
def list_nexus_by_form_code(formCode) path = "/api/v2/definitions/nexus/byform/#{formCode}"
|
443
|
-
get(path) end
|
444
|
-
|
445
|
-
# Retrieve the full list of nexus tax type
|
446
|
-
#
|
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
|
+
#
|
447
493
|
# Returns the full list of Avalara-supported nexus tax type groups
|
448
|
-
# 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.
|
449
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
|
450
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.
|
451
497
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
452
498
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
453
|
-
# @return [FetchResult]
|
454
|
-
def list_nexus_tax_type_groups(options={}) path = "/api/v2/definitions/nexustaxtypegroups"
|
455
|
-
get(path, options) end
|
456
|
-
|
457
|
-
# Retrieve the full list of Avalara-supported tax notice customer funding options.
|
458
|
-
#
|
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
|
+
#
|
459
505
|
# Returns the full list of Avalara-supported tax notice customer funding options.
|
460
|
-
# 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.
|
461
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
|
462
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.
|
463
509
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
464
510
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
465
|
-
# @return [FetchResult]
|
466
|
-
def list_notice_customer_funding_options(options={}) path = "/api/v2/definitions/noticecustomerfundingoptions"
|
467
|
-
get(path, options) end
|
468
|
-
|
469
|
-
# Retrieve the full list of Avalara-supported tax notice customer types.
|
470
|
-
#
|
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
|
+
#
|
471
517
|
# Returns the full list of Avalara-supported tax notice customer types.
|
472
|
-
# 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.
|
473
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
|
474
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.
|
475
521
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
476
522
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
477
|
-
# @return [FetchResult]
|
478
|
-
def list_notice_customer_types(options={}) path = "/api/v2/definitions/noticecustomertypes"
|
479
|
-
get(path, options) end
|
480
|
-
|
481
|
-
# Retrieve the full list of Avalara-supported tax notice filing types.
|
482
|
-
#
|
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
|
+
#
|
483
529
|
# Returns the full list of Avalara-supported tax notice filing types.
|
484
|
-
# 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.
|
485
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
|
486
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.
|
487
533
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
488
534
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
489
|
-
# @return [FetchResult]
|
490
|
-
def list_notice_filingtypes(options={}) path = "/api/v2/definitions/noticefilingtypes"
|
491
|
-
get(path, options) end
|
492
|
-
|
493
|
-
# Retrieve the full list of Avalara-supported tax notice priorities.
|
494
|
-
#
|
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
|
+
#
|
495
541
|
# Returns the full list of Avalara-supported tax notice priorities.
|
496
|
-
# 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.
|
497
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
|
498
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.
|
499
545
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
500
546
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
501
|
-
# @return [FetchResult]
|
502
|
-
def list_notice_priorities(options={}) path = "/api/v2/definitions/noticepriorities"
|
503
|
-
get(path, options) end
|
504
|
-
|
505
|
-
# Retrieve the full list of Avalara-supported tax notice reasons.
|
506
|
-
#
|
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
|
+
#
|
507
553
|
# Returns the full list of Avalara-supported tax notice reasons.
|
508
|
-
# 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.
|
509
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
|
510
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.
|
511
557
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
512
558
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
513
|
-
# @return [FetchResult]
|
514
|
-
def list_notice_reasons(options={}) path = "/api/v2/definitions/noticereasons"
|
515
|
-
get(path, options) end
|
516
|
-
|
517
|
-
# Retrieve the full list of Avalara-supported tax notice responsibility ids
|
518
|
-
#
|
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
|
+
#
|
519
565
|
# Returns the full list of Avalara-supported tax notice responsibility ids
|
520
|
-
# 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.
|
521
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
|
522
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.
|
523
569
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
524
570
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
525
|
-
# @return [FetchResult]
|
526
|
-
def list_notice_responsibilities(options={}) path = "/api/v2/definitions/noticeresponsibilities"
|
527
|
-
get(path, options) end
|
528
|
-
|
529
|
-
# Retrieve the full list of Avalara-supported tax notice root causes
|
530
|
-
#
|
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
|
+
#
|
531
577
|
# Returns the full list of Avalara-supported tax notice root causes
|
532
|
-
# 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.
|
533
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
|
534
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.
|
535
581
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
536
582
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
537
|
-
# @return [FetchResult]
|
538
|
-
def list_notice_root_causes(options={}) path = "/api/v2/definitions/noticerootcauses"
|
539
|
-
get(path, options) end
|
540
|
-
|
541
|
-
# Retrieve the full list of Avalara-supported tax notice statuses.
|
542
|
-
#
|
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
|
+
#
|
543
589
|
# Returns the full list of Avalara-supported tax notice statuses.
|
544
|
-
# 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.
|
545
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
|
546
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.
|
547
593
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
548
594
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
549
|
-
# @return [FetchResult]
|
550
|
-
def list_notice_statuses(options={}) path = "/api/v2/definitions/noticestatuses"
|
551
|
-
get(path, options) end
|
552
|
-
|
553
|
-
# Retrieve the full list of Avalara-supported tax notice types.
|
554
|
-
#
|
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
|
+
#
|
555
601
|
# Returns the full list of Avalara-supported tax notice types.
|
556
|
-
# 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.
|
557
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
|
558
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.
|
559
605
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
560
606
|
# @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_notice_types(options={}) path = "/api/v2/definitions/noticetypes"
|
563
|
-
get(path, options) end
|
564
|
-
|
565
|
-
# Retrieve the full list of Avalara-supported extra parameters for creating transactions.
|
566
|
-
#
|
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
|
+
#
|
567
613
|
# Returns the full list of Avalara-supported extra parameters for the 'Create Transaction' API call.
|
568
614
|
# This list of parameters is available for use when configuring your transaction.
|
569
|
-
# 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.
|
570
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
|
571
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.
|
572
618
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
573
619
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
574
|
-
# @return [FetchResult]
|
575
|
-
def list_parameters(options={}) path = "/api/v2/definitions/parameters"
|
576
|
-
get(path, options) end
|
577
|
-
|
578
|
-
# Retrieve the parameters by companyCode and itemCode.
|
579
|
-
#
|
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
|
+
#
|
580
626
|
# Returns the list of parameters based on the company's service types and the item code.
|
581
627
|
# Ignores nexus if a service type is configured in the 'IgnoreNexusForServiceTypes' configuration section.
|
582
628
|
# Ignores nexus for the AvaAlcohol service type.
|
@@ -590,53 +636,53 @@ module AvaTax
|
|
590
636
|
#
|
591
637
|
# ### Security Policies
|
592
638
|
#
|
593
|
-
# * 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.
|
594
640
|
# @param companyCode [String] Company code.
|
595
641
|
# @param itemCode [String] Item code.
|
596
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
|
597
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.
|
598
644
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
599
645
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
600
|
-
# @return [FetchResult]
|
601
|
-
def list_parameters_by_item(companyCode, itemCode, options={}) path = "/api/v2/definitions/parameters/byitem/#{companyCode}/#{itemCode}"
|
602
|
-
get(path, options) end
|
603
|
-
|
604
|
-
# Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions.
|
605
|
-
#
|
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
|
+
#
|
606
652
|
# Returns the full list of Avalara-supported usage of extra parameters for the 'Create Transaction' API call.
|
607
653
|
# This list of parameters is available for use when configuring your transaction.
|
608
|
-
# 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.
|
609
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
|
610
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.
|
611
657
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
612
658
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
613
|
-
# @return [FetchResult]
|
614
|
-
def list_parameters_usage(options={}) path = "/api/v2/definitions/parametersusage"
|
615
|
-
get(path, options) end
|
616
|
-
|
617
|
-
# Retrieve the full list of Avalara-supported permissions
|
618
|
-
#
|
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
|
+
#
|
619
665
|
# Returns the full list of Avalara-supported permission types.
|
620
|
-
# 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.
|
621
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.
|
622
668
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
623
|
-
# @return [FetchResult]
|
624
|
-
def list_permissions(options={}) path = "/api/v2/definitions/permissions"
|
625
|
-
get(path, options) end
|
626
|
-
|
627
|
-
# Retrieve the full list of Avalara-supported postal codes.
|
628
|
-
#
|
629
|
-
# 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.
|
630
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/).
|
631
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.
|
632
678
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
633
679
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
634
|
-
# @return [FetchResult]
|
635
|
-
def list_postal_codes(options={}) path = "/api/v2/definitions/postalcodes"
|
636
|
-
get(path, options) end
|
637
|
-
|
638
|
-
# List all customs duty programs recognized by AvaTax
|
639
|
-
#
|
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
|
+
#
|
640
686
|
# List all preferred customs duty programs recognized by AvaTax.
|
641
687
|
#
|
642
688
|
# A customs duty program is an optional program you can use to obtain favorable treatment from customs and duty agents.
|
@@ -645,32 +691,32 @@ module AvaTax
|
|
645
691
|
#
|
646
692
|
# To select a preferred program for calculating customs and duty rates, call this API to find the appropriate code for your
|
647
693
|
# preferred program. Next, set the parameter `AvaTax.LC.PreferredProgram` in your `CreateTransaction` call to the code of
|
648
|
-
# the program.
|
694
|
+
# the program.
|
649
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
|
650
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.
|
651
697
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
652
698
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
653
|
-
# @return [FetchResult]
|
654
|
-
def list_preferred_programs(options={}) path = "/api/v2/definitions/preferredprograms"
|
655
|
-
get(path, options) end
|
656
|
-
|
657
|
-
# List all available product classification systems.
|
658
|
-
#
|
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
|
+
#
|
659
705
|
# List all available product classification systems.
|
660
706
|
#
|
661
707
|
# Tax authorities use product classification systems as a way to identify products and associate them with a tax rate.
|
662
|
-
# 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.
|
663
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
|
664
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.
|
665
711
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
666
712
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
667
713
|
# @param countryCode [String] If not null, return all records with this code.
|
668
|
-
# @return [FetchResult]
|
669
|
-
def list_product_classification_systems(options={}) path = "/api/v2/definitions/productclassificationsystems"
|
670
|
-
get(path, options) end
|
671
|
-
|
672
|
-
# List all product classification systems available to a company based on its nexus.
|
673
|
-
#
|
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
|
+
#
|
674
720
|
# Lists all product classification systems available to a company based on its nexus.
|
675
721
|
#
|
676
722
|
# Tax authorities use product classification systems as a way to identify products and associate them with a tax rate.
|
@@ -682,160 +728,175 @@ module AvaTax
|
|
682
728
|
# * Replace '+' with '\_-ava2b-\_' For example: 'Company+Code' becomes 'Company_-ava2b-_Code'
|
683
729
|
# * Replace '?' with '\_-ava3f-\_' For example: 'Company?Code' becomes 'Company_-ava3f-_Code'
|
684
730
|
# * Replace '%' with '\_-ava25-\_' For example: 'Company%Code' becomes 'Company_-ava25-_Code'
|
685
|
-
# * Replace '#' with '\_-ava23-\_' For example: 'Company#Code' becomes 'Company_-ava23-_Code'
|
731
|
+
# * Replace '#' with '\_-ava23-\_' For example: 'Company#Code' becomes 'Company_-ava23-_Code'
|
686
732
|
# @param companyCode [String] The company code.
|
687
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
|
688
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.
|
689
735
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
690
736
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
691
737
|
# @param countryCode [String] If not null, return all records with this code.
|
692
|
-
# @return [FetchResult]
|
693
|
-
def list_product_classification_systems_by_company(companyCode, options={}) path = "/api/v2/definitions/productclassificationsystems/bycompany/#{companyCode}"
|
694
|
-
get(path, options) end
|
695
|
-
|
696
|
-
# Retrieve the full list of rate types for each country
|
697
|
-
#
|
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
|
+
#
|
698
744
|
# Returns the full list of Avalara-supported rate type file types
|
699
|
-
# 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.
|
700
746
|
# @param country [String] The country to examine for rate types
|
701
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/).
|
702
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.
|
703
749
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
704
750
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
705
|
-
# @return [FetchResult]
|
706
|
-
def list_rate_types_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/ratetypes"
|
707
|
-
get(path, options) end
|
708
|
-
|
709
|
-
#
|
710
|
-
#
|
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
|
+
#
|
711
772
|
# Returns a list of all ISO 3166 region codes and their US English friendly names.
|
712
773
|
# This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region
|
713
|
-
# within the country for a shipping addresses.
|
774
|
+
# within the country for a shipping addresses.
|
714
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
|
715
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.
|
716
777
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
717
778
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
718
|
-
# @return [FetchResult]
|
719
|
-
def list_regions(options={}) path = "/api/v2/definitions/regions"
|
720
|
-
get(path, options) end
|
721
|
-
|
722
|
-
# List all ISO 3166 regions for a country
|
723
|
-
#
|
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
|
+
#
|
724
785
|
# Returns a list of all ISO 3166 region codes for a specific country code, and their US English friendly names.
|
725
786
|
# This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region
|
726
|
-
# within the country for a shipping addresses.
|
787
|
+
# within the country for a shipping addresses.
|
727
788
|
# @param country [String] The country of which you want to fetch ISO 3166 regions
|
728
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
|
729
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.
|
730
791
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
731
792
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
732
|
-
# @return [FetchResult]
|
733
|
-
def list_regions_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/regions"
|
734
|
-
get(path, options) end
|
735
|
-
|
736
|
-
# Retrieve the full list of Avalara-supported resource file types
|
737
|
-
#
|
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
|
+
#
|
738
799
|
# Returns the full list of Avalara-supported resource file types
|
739
|
-
# 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.
|
740
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/).
|
741
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.
|
742
803
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
743
804
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
744
|
-
# @return [FetchResult]
|
745
|
-
def list_resource_file_types(options={}) path = "/api/v2/definitions/resourcefiletypes"
|
746
|
-
get(path, options) end
|
747
|
-
|
748
|
-
# Retrieve the full list of Avalara-supported usage of parameters used for returns.
|
749
|
-
#
|
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
|
+
#
|
750
811
|
# Returns the full list of Avalara-supported usage of extra parameters for the returns.
|
751
812
|
# This list of parameters is available for use with Returns.
|
752
|
-
# Some parameters are only available for use if you have subscribed to certain features of AvaTax.
|
813
|
+
# Some parameters are only available for use if you have subscribed to certain features of AvaTax.
|
753
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
|
754
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.
|
755
816
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
756
817
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
757
|
-
# @return [FetchResult]
|
758
|
-
def list_returns_parameters_usage(options={}) path = "/api/v2/definitions/returns/parametersusage"
|
759
|
-
get(path, options) end
|
760
|
-
|
761
|
-
# Retrieve the full list of Avalara-supported permissions
|
762
|
-
#
|
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
|
+
#
|
763
824
|
# Returns the full list of Avalara-supported permission types.
|
764
825
|
# This API is intended to be useful when designing a user interface for selecting the security role of a user account.
|
765
|
-
# Some security roles are restricted for Avalara internal use.
|
826
|
+
# Some security roles are restricted for Avalara internal use.
|
766
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/).
|
767
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.
|
768
829
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
769
830
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
770
|
-
# @return [FetchResult]
|
771
|
-
def list_security_roles(options={}) path = "/api/v2/definitions/securityroles"
|
772
|
-
get(path, options) end
|
773
|
-
|
774
|
-
# Retrieve the full list of Avalara-supported subscription types
|
775
|
-
#
|
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
|
+
#
|
776
837
|
# Returns the full list of Avalara-supported subscription types.
|
777
838
|
# This API is intended to be useful for identifying which features you have added to your account.
|
778
839
|
# You may always contact Avalara's sales department for information on available products or services.
|
779
|
-
# You cannot change your subscriptions directly through the API.
|
840
|
+
# You cannot change your subscriptions directly through the API.
|
780
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/).
|
781
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.
|
782
843
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
783
844
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
784
|
-
# @return [FetchResult]
|
785
|
-
def list_subscription_types(options={}) path = "/api/v2/definitions/subscriptiontypes"
|
786
|
-
get(path, options) end
|
787
|
-
|
788
|
-
# Retrieve the list all tags supported by avalara
|
789
|
-
#
|
790
|
-
# Retrieves the list of suggested locations for a marketplace.
|
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.
|
791
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/).
|
792
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.
|
793
854
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
794
855
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
795
|
-
# @return [FetchResult]
|
796
|
-
def list_tags(options={}) path = "/api/v2/definitions/tags"
|
797
|
-
get(path, options) end
|
798
|
-
|
799
|
-
# Retrieve the full list of Avalara-supported tax authorities.
|
800
|
-
#
|
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
|
+
#
|
801
862
|
# Returns the full list of Avalara-supported tax authorities.
|
802
|
-
# 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.
|
803
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/).
|
804
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.
|
805
866
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
806
867
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
807
|
-
# @return [FetchResult]
|
808
|
-
def list_tax_authorities(options={}) path = "/api/v2/definitions/taxauthorities"
|
809
|
-
get(path, options) end
|
810
|
-
|
811
|
-
# Retrieve the full list of Avalara-supported forms for each tax authority.
|
812
|
-
#
|
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
|
+
#
|
813
874
|
# Returns the full list of Avalara-supported forms for each tax authority.
|
814
875
|
# This list represents tax forms that Avalara recognizes.
|
815
876
|
# Customers who subscribe to Avalara Managed Returns Service can request these forms to be filed automatically
|
816
|
-
# based on the customer's AvaTax data.
|
877
|
+
# based on the customer's AvaTax data.
|
817
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/).
|
818
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.
|
819
880
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
820
881
|
# @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_authority_forms(options={}) path = "/api/v2/definitions/taxauthorityforms"
|
823
|
-
get(path, options) end
|
824
|
-
|
825
|
-
# Retrieve the full list of Avalara-supported tax authority types.
|
826
|
-
#
|
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
|
+
#
|
827
888
|
# Returns the full list of Avalara-supported tax authority types.
|
828
|
-
# 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.
|
829
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/).
|
830
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.
|
831
892
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
832
893
|
# @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_authority_types(options={}) path = "/api/v2/definitions/taxauthoritytypes"
|
835
|
-
get(path, options) end
|
836
|
-
|
837
|
-
# Retrieve the full list of Avalara-supported tax codes.
|
838
|
-
#
|
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
|
+
#
|
839
900
|
# Retrieves the list of Avalara-supported system tax codes.
|
840
901
|
# A 'TaxCode' represents a uniquely identified type of product, good, or service.
|
841
902
|
# Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
|
@@ -844,74 +905,128 @@ module AvaTax
|
|
844
905
|
#
|
845
906
|
# ### Security Policies
|
846
907
|
#
|
847
|
-
# * 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.
|
848
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/).
|
849
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.
|
850
911
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
851
912
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
852
|
-
# @return [FetchResult]
|
853
|
-
def list_tax_codes(options={}) path = "/api/v2/definitions/taxcodes"
|
854
|
-
get(path, options) end
|
855
|
-
|
856
|
-
# Retrieve the full list of Avalara-supported tax code types.
|
857
|
-
#
|
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
|
+
#
|
858
919
|
# Returns the full list of recognized tax code types.
|
859
920
|
# A 'Tax Code Type' represents a broad category of tax codes, and is less detailed than a single TaxCode.
|
860
|
-
# 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.
|
861
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.
|
862
923
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
863
|
-
# @return [Object]
|
864
|
-
def list_tax_code_types(options={}) path = "/api/v2/definitions/taxcodetypes"
|
865
|
-
get(path, options) end
|
866
|
-
|
867
|
-
# Retrieve the full list of the Tax Forms available
|
868
|
-
#
|
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
|
+
#
|
869
930
|
# Returns the full list of Avalara-supported Tax Forms
|
870
|
-
# 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
|
871
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/).
|
872
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.
|
873
934
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
874
935
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
875
|
-
# @return [FetchResult]
|
876
|
-
def list_tax_forms(options={}) path = "/api/v2/definitions/taxforms"
|
877
|
-
get(path, options) end
|
878
|
-
|
879
|
-
# Retrieve the full list of tax sub types
|
880
|
-
#
|
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
|
+
#
|
881
942
|
# Returns the full list of Avalara-supported tax sub-types
|
882
|
-
# 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.
|
883
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/).
|
884
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.
|
885
946
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
886
947
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
887
|
-
# @return [FetchResult]
|
888
|
-
def list_tax_sub_types(options={}) path = "/api/v2/definitions/taxsubtypes"
|
889
|
-
get(path, options) end
|
890
|
-
|
891
|
-
# Retrieve the full list of tax
|
892
|
-
#
|
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
|
+
#
|
893
982
|
# Returns the full list of Avalara-supported tax type groups
|
894
|
-
# 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.
|
895
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
|
896
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.
|
897
986
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
898
987
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
899
|
-
# @return [FetchResult]
|
900
|
-
def list_tax_type_groups(options={}) path = "/api/v2/definitions/taxtypegroups"
|
901
|
-
get(path, options) end
|
902
|
-
|
903
|
-
#
|
904
|
-
#
|
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
|
+
#
|
905
1020
|
# List all units of measurement systems defined by Avalara.
|
906
1021
|
#
|
907
|
-
# 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.
|
908
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
|
909
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.
|
910
1025
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
911
1026
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
912
|
-
# @return [FetchResult]
|
913
|
-
def list_unit_of_measurement(options={}) path = "/api/v2/definitions/unitofmeasurements"
|
914
|
-
get(path, options) end
|
915
|
-
end
|
916
|
-
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
|
917
1032
|
end
|