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