avatax 18.7.1 → 18.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 +12 -9
- data/lib/avatax/client/addresses.rb +0 -2
- data/lib/avatax/client/avafileforms.rb +2 -2
- data/lib/avatax/client/batches.rb +4 -4
- data/lib/avatax/client/certexpressinvites.rb +2 -2
- data/lib/avatax/client/certificates.rb +2 -2
- data/lib/avatax/client/companies.rb +2 -2
- data/lib/avatax/client/contacts.rb +4 -4
- data/lib/avatax/client/customers.rb +21 -9
- data/lib/avatax/client/datasources.rb +88 -0
- data/lib/avatax/client/definitions.rb +104 -108
- data/lib/avatax/client/distancethresholds.rb +4 -4
- data/lib/avatax/client/filingcalendars.rb +8 -8
- data/lib/avatax/client/filings.rb +3 -2
- data/lib/avatax/client/items.rb +9 -7
- data/lib/avatax/client/jurisdictionoverrides.rb +4 -4
- data/lib/avatax/client/locations.rb +4 -4
- data/lib/avatax/client/multidocument.rb +2 -2
- data/lib/avatax/client/nexus.rb +69 -48
- data/lib/avatax/client/notices.rb +4 -4
- data/lib/avatax/client/notifications.rb +2 -2
- data/lib/avatax/client/registrar.rb +0 -31
- data/lib/avatax/client/settings.rb +4 -4
- data/lib/avatax/client/subscriptions.rb +4 -4
- data/lib/avatax/client/taxcodes.rb +4 -4
- data/lib/avatax/client/taxcontent.rb +19 -1
- data/lib/avatax/client/taxrules.rb +79 -29
- data/lib/avatax/client/transactions.rb +4 -3
- data/lib/avatax/client/upcs.rb +4 -4
- data/lib/avatax/client/users.rb +38 -18
- data/lib/avatax/client/utilities.rb +29 -8
- data/lib/avatax/version.rb +1 -1
- metadata +3 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 266930dab7c3f2c1a25475c6d72c6e4a8a9ec31d84696be49603c178760676be
|
4
|
+
data.tar.gz: 0cdf1d120fba55984c4e26bbc23d71de1cb8ee11ee0ef9ba2201735d25985452
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b5cfe3390ad75bacaf6f0c1ce1a5bb8d1ae6badca71d7b349d07fb89c47c68e5d9048d947d4fbda0043f0ffb1ec0356d8dcfadb84d73cec1d92e2194d704ed1a
|
7
|
+
data.tar.gz: 6ad9fb13f1f158a4bbc266c8aab962b9fde5068d86c845e9c681ecec82dca2c0962a675d9b85af2bef4802544a39ca5cfdbe76e2c53b4c1ed7fc655856785662
|
@@ -50,22 +50,25 @@ module AvaTax
|
|
50
50
|
|
51
51
|
# Retrieve audit history for an account.
|
52
52
|
#
|
53
|
-
# Retrieve audit history for an account.
|
53
|
+
# Retrieve audit trace history for an account.
|
54
54
|
#
|
55
|
-
#
|
55
|
+
# Your audit trace history contains a record of all API calls made against the AvaTax REST API. You can use this API to investigate
|
56
|
+
# problems and see exactly what information was sent back and forth between your code and AvaTax.
|
56
57
|
#
|
57
58
|
# When specifying a start and end datetime, please include a valid timezone indicator, such as the "Z" present in the examples for the start and end query parameters.
|
58
59
|
# You can learn more about valid time zone designators at https://en.wikipedia.org/wiki/ISO_8601#Time_zone_designators.
|
59
60
|
#
|
60
|
-
#
|
61
|
+
# This API enforces limits to the amount of data retrieved. These limits are subject to change.
|
61
62
|
#
|
62
|
-
#
|
63
|
-
#
|
63
|
+
# * You may request data from a maximum of a one-hour time period.
|
64
|
+
# * The amount of data and number of API calls returned by this API are limited and may be adjusted at any time.
|
65
|
+
# * Old records may be migrated out of immediately available storage. To request older data, please contact your account manager.
|
66
|
+
# * New records must migrate to available storage before they can be retrieved. You may need to wait a period of time before newly created records can be fetched.
|
64
67
|
# @param id [Integer] The ID of the account you wish to audit.
|
65
68
|
# @param start [DateTime] The start datetime of audit history you with to retrieve, e.g. "2018-06-08T17:00:00Z". Defaults to the past 15 minutes.
|
66
69
|
# @param end [DateTime] The end datetime of audit history you with to retrieve, e.g. "2018-06-08T17:15:00Z. Defaults to the current time. Maximum of an hour after the start time.
|
67
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
68
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
70
|
+
# @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.
|
71
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
69
72
|
# @return [FetchResult]
|
70
73
|
def audit_account(id, options={})
|
71
74
|
path = "/api/v2/accounts/#{id}/audit"
|
@@ -127,8 +130,8 @@ module AvaTax
|
|
127
130
|
# For more information about filtering in REST, please see the documentation at http://developer.avalara.com/avatax/filtering-in-rest/ .
|
128
131
|
# @param include [String] A comma separated list of objects to fetch underneath this account. Any object with a URL path underneath this account can be fetched by specifying its name.
|
129
132
|
# @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/) .
|
130
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
131
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
133
|
+
# @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.
|
134
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
132
135
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
133
136
|
# @return [FetchResult]
|
134
137
|
def query_accounts(options={})
|
@@ -19,8 +19,6 @@ module AvaTax
|
|
19
19
|
# @param postalCode [String] Postal Code / Zip Code
|
20
20
|
# @param country [String] Two character ISO 3166 Country Code (see /api/v2/definitions/countries for a full list)
|
21
21
|
# @param textCase [String] selectable text case for address validation (See TextCase::* for a list of allowable values)
|
22
|
-
# @param latitude [BigDecimal] Geospatial latitude measurement
|
23
|
-
# @param longitude [BigDecimal] Geospatial longitude measurement
|
24
22
|
# @return [Object]
|
25
23
|
def resolve_address(options={})
|
26
24
|
path = "/api/v2/addresses/resolve"
|
@@ -43,8 +43,8 @@ module AvaTax
|
|
43
43
|
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
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 include [String] A comma separated list of additional data to retrieve.
|
46
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
47
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
46
|
+
# @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.
|
47
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
48
48
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
49
49
|
# @return [FetchResult]
|
50
50
|
def query_ava_file_forms(options={})
|
@@ -114,8 +114,8 @@ module AvaTax
|
|
114
114
|
# @param companyId [Integer] The ID of the company that owns these batches
|
115
115
|
# @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/) .
|
116
116
|
# @param include [String] A comma separated list of additional data to retrieve.
|
117
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
118
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
117
|
+
# @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.
|
118
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
119
119
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
120
120
|
# @return [FetchResult]
|
121
121
|
def list_batches_by_company(companyId, options={})
|
@@ -146,8 +146,8 @@ module AvaTax
|
|
146
146
|
# [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
|
147
147
|
# @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/) .
|
148
148
|
# @param include [String] A comma separated list of additional data to retrieve.
|
149
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
150
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
149
|
+
# @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.
|
150
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
151
151
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
152
152
|
# @return [FetchResult]
|
153
153
|
def query_batches(options={})
|
@@ -78,8 +78,8 @@ module AvaTax
|
|
78
78
|
# @param companyId [Integer] The unique ID number of the company that issued this invitation
|
79
79
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
|
80
80
|
# @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/) .
|
81
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
82
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
81
|
+
# @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.
|
82
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
83
83
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
84
84
|
# @return [FetchResult]
|
85
85
|
def list_cert_express_invitations(companyId, options={})
|
@@ -256,8 +256,8 @@ module AvaTax
|
|
256
256
|
# @param companyId [Integer] The ID number of the company to search
|
257
257
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * Customers - Retrieves the list of customers linked to the certificate. * PoNumbers - Retrieves all PO numbers tied to the certificate. * Attributes - Retrieves all attributes applied to the certificate.
|
258
258
|
# @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/) .
|
259
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
260
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
259
|
+
# @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.
|
260
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
261
261
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
262
262
|
# @return [FetchResult]
|
263
263
|
def query_certificates(companyId, options={})
|
@@ -237,8 +237,8 @@ module AvaTax
|
|
237
237
|
# * UPC
|
238
238
|
# @param include [String] A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.
|
239
239
|
# @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/) .
|
240
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
241
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
240
|
+
# @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.
|
241
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
242
242
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
243
243
|
# @return [FetchResult]
|
244
244
|
def query_companies(options={})
|
@@ -52,8 +52,8 @@ module AvaTax
|
|
52
52
|
# @param companyId [Integer] The ID of the company that owns these contacts
|
53
53
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
54
54
|
# @param include [String] A comma separated list of additional data to retrieve.
|
55
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
56
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
55
|
+
# @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.
|
56
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
57
57
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
58
58
|
# @return [FetchResult]
|
59
59
|
def list_contacts_by_company(companyId, options={})
|
@@ -72,8 +72,8 @@ module AvaTax
|
|
72
72
|
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
73
73
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
74
74
|
# @param include [String] A comma separated list of additional data to retrieve.
|
75
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
76
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
75
|
+
# @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.
|
76
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
77
77
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
78
78
|
# @return [FetchResult]
|
79
79
|
def query_contacts(options={})
|
@@ -105,12 +105,24 @@ module AvaTax
|
|
105
105
|
end
|
106
106
|
|
107
107
|
|
108
|
-
#
|
108
|
+
# Link two customer records together
|
109
109
|
#
|
110
|
-
#
|
111
|
-
#
|
112
|
-
#
|
113
|
-
#
|
110
|
+
# Links a Ship-To customer record with a Bill-To customer record.
|
111
|
+
#
|
112
|
+
# Customer records represent businesses or individuals who can provide exemption certificates. Some customers
|
113
|
+
# may have certificates that are linked to their shipping address or their billing address. To group these
|
114
|
+
# customer records together, you may link multiple bill-to and ship-to addresses together to represent a single
|
115
|
+
# entity that has multiple different addresses of different kinds.
|
116
|
+
#
|
117
|
+
# In general, a customer will have only one primary billing address and multiple ship-to addresses, representing
|
118
|
+
# all of the different locations where they receive goods. To facilitate this type of customer, you can send in
|
119
|
+
# one bill-to customer code and multiple ship-to customer codes in a single API call.
|
120
|
+
#
|
121
|
+
# Note that you can only link a ship-to customer record to a bill-to customer record. You may not link two customers
|
122
|
+
# of the same kind together.
|
123
|
+
# @param companyId [Integer] The unique ID number of the company defining customers.
|
124
|
+
# @param code [String] The code of the bill-to customer to link.
|
125
|
+
# @param model [Object] A list of information about ship-to customers to link to this bill-to customer.
|
114
126
|
# @return [Object]
|
115
127
|
def link_ship_to_customers_to_bill_customer(companyId, code, model)
|
116
128
|
path = "/api/v2/companies/#{companyId}/customers/billto/#{code}/shipto/link"
|
@@ -136,8 +148,8 @@ module AvaTax
|
|
136
148
|
# @param customerCode [String] The unique code representing this customer
|
137
149
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * Customers - Retrieves the list of customers linked to the certificate. * PoNumbers - Retrieves all PO numbers tied to the certificate. * Attributes - Retrieves all attributes applied to the certificate.
|
138
150
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
139
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
140
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
151
|
+
# @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
|
152
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
141
153
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
142
154
|
# @return [FetchResult]
|
143
155
|
def list_certificates_for_customer(companyId, customerCode, options={})
|
@@ -195,8 +207,8 @@ module AvaTax
|
|
195
207
|
# @param companyId [Integer] The unique ID number of the company that recorded this customer
|
196
208
|
# @param include [String] OPTIONAL - You can specify the value `certificates` to fetch information about certificates linked to the customer.
|
197
209
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
198
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
199
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
210
|
+
# @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.
|
211
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
200
212
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
201
213
|
# @return [FetchResult]
|
202
214
|
def query_customers(companyId, options={})
|
@@ -0,0 +1,88 @@
|
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module DataSources
|
4
|
+
|
5
|
+
|
6
|
+
# Create and store new datasources for the respective companies.
|
7
|
+
#
|
8
|
+
# Create one or more datasource objects.
|
9
|
+
# @param companyId [Integer] The id of the company you which to create the datasources
|
10
|
+
# @param model [DataSourceModel[]]
|
11
|
+
# @return [DataSourceModel[]]
|
12
|
+
def create_data_sources(companyId, model)
|
13
|
+
path = "/api/v2/companies/#{companyId}/datasources"
|
14
|
+
post(path, model)
|
15
|
+
end
|
16
|
+
|
17
|
+
|
18
|
+
# Delete a datasource by datasource id for a company.
|
19
|
+
#
|
20
|
+
# Marks the existing datasource for a company as deleted.
|
21
|
+
# @param companyId [Integer] The id of the company the datasource belongs to.
|
22
|
+
# @param id [Integer] The id of the datasource you wish to delete.
|
23
|
+
# @return [ErrorDetail[]]
|
24
|
+
def delete_data_source(companyId, id)
|
25
|
+
path = "/api/v2/companies/#{companyId}/datasources/#{id}"
|
26
|
+
delete(path)
|
27
|
+
end
|
28
|
+
|
29
|
+
|
30
|
+
# Get data source by data source id
|
31
|
+
#
|
32
|
+
# Retrieve the data source by its unique ID number.
|
33
|
+
# @param companyId [Integer]
|
34
|
+
# @param id [Integer] data source id
|
35
|
+
# @return [Object]
|
36
|
+
def get_data_source_by_id(companyId, id)
|
37
|
+
path = "/api/v2/companies/#{companyId}/datasources/#{id}"
|
38
|
+
get(path)
|
39
|
+
end
|
40
|
+
|
41
|
+
|
42
|
+
# Retrieve all datasources for this company
|
43
|
+
#
|
44
|
+
# Gets multiple datasource objects for a given company.
|
45
|
+
# @param companyId [Integer] The id of the company you wish to retrieve the datasources.
|
46
|
+
# @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/) .
|
47
|
+
# @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.
|
48
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
49
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
50
|
+
# @return [FetchResult]
|
51
|
+
def list_data_sources(companyId, options={})
|
52
|
+
path = "/api/v2/companies/#{companyId}/datasources"
|
53
|
+
get(path, options)
|
54
|
+
end
|
55
|
+
|
56
|
+
|
57
|
+
# Retrieve all datasources
|
58
|
+
#
|
59
|
+
# Get multiple datasource objects across all companies.
|
60
|
+
#
|
61
|
+
# Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
62
|
+
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
63
|
+
# @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/) .
|
64
|
+
# @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.
|
65
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
66
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
67
|
+
# @return [FetchResult]
|
68
|
+
def query_data_sources(options={})
|
69
|
+
path = "/api/v2/datasources"
|
70
|
+
get(path, options)
|
71
|
+
end
|
72
|
+
|
73
|
+
|
74
|
+
# Update a datasource identified by id for a company
|
75
|
+
#
|
76
|
+
# Updates a datasource for a company.
|
77
|
+
# @param companyId [Integer] The id of the company the datasource belongs to.
|
78
|
+
# @param id [Integer] The id of the datasource you wish to delete.
|
79
|
+
# @param model [Object]
|
80
|
+
# @return [Object]
|
81
|
+
def update_data_source(companyId, id, model)
|
82
|
+
path = "/api/v2/companies/#{companyId}/datasources/#{id}"
|
83
|
+
put(path, model)
|
84
|
+
end
|
85
|
+
|
86
|
+
end
|
87
|
+
end
|
88
|
+
end
|
@@ -30,8 +30,8 @@ module AvaTax
|
|
30
30
|
# to automatically verify their login and password.
|
31
31
|
# @param form [String] The name of the form you would like to verify. This can be the tax form code or the legacy return name
|
32
32
|
# @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/) .
|
33
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
34
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
33
|
+
# @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.
|
34
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
35
35
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
36
36
|
# @return [FetchResult]
|
37
37
|
def get_login_verifier_by_form(form, options={})
|
@@ -49,8 +49,8 @@ module AvaTax
|
|
49
49
|
# Returns the full list of Avalara-supported AvaFile Forms
|
50
50
|
# This API is intended to be useful to identify all the different AvaFile Forms
|
51
51
|
# @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/) .
|
52
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
53
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
52
|
+
# @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.
|
53
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
54
54
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
55
55
|
# @return [FetchResult]
|
56
56
|
def list_ava_file_forms(options={})
|
@@ -69,8 +69,8 @@ module AvaTax
|
|
69
69
|
# If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
|
70
70
|
# check and provision account.
|
71
71
|
# @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/) .
|
72
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
73
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
72
|
+
# @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.
|
73
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
74
74
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
75
75
|
# @return [FetchResult]
|
76
76
|
def list_certificate_attributes(options={})
|
@@ -89,8 +89,8 @@ module AvaTax
|
|
89
89
|
# If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
|
90
90
|
# check and provision account.
|
91
91
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
92
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
93
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
92
|
+
# @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.
|
93
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
94
94
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
95
95
|
# @return [FetchResult]
|
96
96
|
def list_certificate_exempt_reasons(options={})
|
@@ -109,8 +109,8 @@ module AvaTax
|
|
109
109
|
# If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
|
110
110
|
# check and provision account.
|
111
111
|
# @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/) .
|
112
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
113
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
112
|
+
# @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.
|
113
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
114
114
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
115
115
|
# @return [FetchResult]
|
116
116
|
def list_certificate_exposure_zones(options={})
|
@@ -124,8 +124,8 @@ module AvaTax
|
|
124
124
|
# Returns full list of service types for a given transaction type ID.
|
125
125
|
# @param id [Integer] The transaction type ID to examine
|
126
126
|
# @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/) .
|
127
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
128
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
127
|
+
# @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
|
128
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
129
129
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
130
130
|
# @return [FetchResult]
|
131
131
|
def list_communications_service_types(id, options={})
|
@@ -139,8 +139,8 @@ module AvaTax
|
|
139
139
|
# Returns full list of communications transaction types which
|
140
140
|
# are accepted in communication tax calculation requests.
|
141
141
|
# @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/) .
|
142
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
143
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
142
|
+
# @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.
|
143
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
144
144
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
145
145
|
# @return [FetchResult]
|
146
146
|
def list_communications_transaction_types(options={})
|
@@ -154,8 +154,8 @@ module AvaTax
|
|
154
154
|
# Returns full list of communications transaction/service type pairs which
|
155
155
|
# are accepted in communication tax calculation requests.
|
156
156
|
# @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/) .
|
157
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
158
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
157
|
+
# @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.
|
158
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
159
159
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
160
160
|
# @return [FetchResult]
|
161
161
|
def list_communications_t_s_pairs(options={})
|
@@ -170,8 +170,8 @@ module AvaTax
|
|
170
170
|
# This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a country for
|
171
171
|
# a shipping address.
|
172
172
|
# @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/) .
|
173
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
174
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
173
|
+
# @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.
|
174
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
175
175
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
176
176
|
# @return [FetchResult]
|
177
177
|
def list_countries(options={})
|
@@ -191,8 +191,8 @@ module AvaTax
|
|
191
191
|
# If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to
|
192
192
|
# check and provision account.
|
193
193
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
194
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
195
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
194
|
+
# @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.
|
195
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
196
196
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
197
197
|
# @return [FetchResult]
|
198
198
|
def list_cover_letters(options={})
|
@@ -214,8 +214,8 @@ module AvaTax
|
|
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/) .
|
217
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
218
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
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
|
+
# @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
220
|
# @return [FetchResult]
|
221
221
|
def list_cross_border_codes(country, hsCode, options={})
|
@@ -246,8 +246,8 @@ module AvaTax
|
|
246
246
|
# 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
|
247
247
|
# `currencyCode` field in a `CreateTransactionModel`.
|
248
248
|
# @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/) .
|
249
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
250
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
249
|
+
# @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.
|
250
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
251
251
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
252
252
|
# @return [FetchResult]
|
253
253
|
def list_currencies(options={})
|
@@ -264,8 +264,8 @@ module AvaTax
|
|
264
264
|
# In order to facilitate correct reporting of your taxes, you are encouraged to select the proper entity use codes for
|
265
265
|
# all transactions that are exempt.
|
266
266
|
# @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/) .
|
267
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
268
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
267
|
+
# @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.
|
268
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
269
269
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
270
270
|
# @return [FetchResult]
|
271
271
|
def list_entity_use_codes(options={})
|
@@ -279,8 +279,8 @@ module AvaTax
|
|
279
279
|
# Returns the full list of Avalara-supported filing frequencies.
|
280
280
|
# This API is intended to be useful to identify all the different filing frequencies that can be used in notices.
|
281
281
|
# @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/) .
|
282
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
283
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
282
|
+
# @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.
|
283
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
284
284
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
285
285
|
# @return [FetchResult]
|
286
286
|
def list_filing_frequencies(options={})
|
@@ -296,8 +296,8 @@ module AvaTax
|
|
296
296
|
# This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying
|
297
297
|
# SQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01'
|
298
298
|
# @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/) .
|
299
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
300
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
299
|
+
# @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.
|
300
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
301
301
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
302
302
|
# @return [FetchResult]
|
303
303
|
def list_jurisdictions(options={})
|
@@ -323,8 +323,8 @@ module AvaTax
|
|
323
323
|
# @param postalCode [String] The postal code or zip code portion of this address.
|
324
324
|
# @param country [String] The two-character ISO-3166 code of the country portion of this address.
|
325
325
|
# @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/) .
|
326
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
327
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
326
|
+
# @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.
|
327
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
328
328
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
329
329
|
# @return [FetchResult]
|
330
330
|
def list_jurisdictions_by_address(options={})
|
@@ -351,8 +351,8 @@ module AvaTax
|
|
351
351
|
# @param latitude [BigDecimal] Optionally identify the location via latitude/longitude instead of via address.
|
352
352
|
# @param longitude [BigDecimal] Optionally identify the location via latitude/longitude instead of via address.
|
353
353
|
# @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/) .
|
354
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
355
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
354
|
+
# @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.
|
355
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
356
356
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
357
357
|
# @return [FetchResult]
|
358
358
|
def list_location_questions_by_address(options={})
|
@@ -367,8 +367,8 @@ module AvaTax
|
|
367
367
|
# This API is intended to be useful to identify whether the user should be allowed
|
368
368
|
# to automatically verify their login and password.
|
369
369
|
# @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/) .
|
370
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
371
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
370
|
+
# @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.
|
371
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
372
372
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
373
373
|
# @return [FetchResult]
|
374
374
|
def list_login_verifiers(options={})
|
@@ -383,8 +383,8 @@ module AvaTax
|
|
383
383
|
#
|
384
384
|
# This API is intended to be useful if your user interface needs to display a selectable list of nexus.
|
385
385
|
# @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/) .
|
386
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
387
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
386
|
+
# @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.
|
387
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
388
388
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
389
389
|
# @return [FetchResult]
|
390
390
|
def list_nexus(options={})
|
@@ -408,8 +408,8 @@ module AvaTax
|
|
408
408
|
# @param postalCode [String] The postal code or zip code portion of this address.
|
409
409
|
# @param country [String] Name or ISO 3166 code identifying the country portion of this address. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
|
410
410
|
# @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/) .
|
411
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
412
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
411
|
+
# @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.
|
412
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
413
413
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
414
414
|
# @return [FetchResult]
|
415
415
|
def list_nexus_by_address(options={})
|
@@ -425,8 +425,8 @@ module AvaTax
|
|
425
425
|
# This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country.
|
426
426
|
# @param country [String] The country in which you want to fetch the system nexus
|
427
427
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
428
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
429
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
428
|
+
# @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.
|
429
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
430
430
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
431
431
|
# @return [FetchResult]
|
432
432
|
def list_nexus_by_country(country, options={})
|
@@ -443,8 +443,8 @@ module AvaTax
|
|
443
443
|
# @param country [String] The two-character ISO-3166 code for the country.
|
444
444
|
# @param region [String] The two or three character region code for the region.
|
445
445
|
# @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/) .
|
446
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
447
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
446
|
+
# @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.
|
447
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
448
448
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
449
449
|
# @return [FetchResult]
|
450
450
|
def list_nexus_by_country_and_region(country, region, options={})
|
@@ -467,14 +467,10 @@ module AvaTax
|
|
467
467
|
# a tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax
|
468
468
|
# form in order to better understand how the form will be filled out.
|
469
469
|
# @param formCode [String] The form code that we are looking up the nexus for
|
470
|
-
# @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/) .
|
471
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
|
472
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
|
473
|
-
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
474
470
|
# @return [Object]
|
475
|
-
def list_nexus_by_form_code(formCode
|
471
|
+
def list_nexus_by_form_code(formCode)
|
476
472
|
path = "/api/v2/definitions/nexus/byform/#{formCode}"
|
477
|
-
get(path
|
473
|
+
get(path)
|
478
474
|
end
|
479
475
|
|
480
476
|
|
@@ -483,8 +479,8 @@ module AvaTax
|
|
483
479
|
# Returns the full list of Avalara-supported nexus tax type groups
|
484
480
|
# This API is intended to be useful to identify all the different tax sub-types.
|
485
481
|
# @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/) .
|
486
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
487
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
482
|
+
# @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.
|
483
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
488
484
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
489
485
|
# @return [FetchResult]
|
490
486
|
def list_nexus_tax_type_groups(options={})
|
@@ -498,8 +494,8 @@ module AvaTax
|
|
498
494
|
# Returns the full list of Avalara-supported tax notice customer funding options.
|
499
495
|
# This API is intended to be useful to identify all the different notice customer funding options that can be used in notices.
|
500
496
|
# @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/) .
|
501
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
502
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
497
|
+
# @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
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
503
499
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
504
500
|
# @return [FetchResult]
|
505
501
|
def list_notice_customer_funding_options(options={})
|
@@ -513,8 +509,8 @@ module AvaTax
|
|
513
509
|
# Returns the full list of Avalara-supported tax notice customer types.
|
514
510
|
# This API is intended to be useful to identify all the different notice customer types.
|
515
511
|
# @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/) .
|
516
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
517
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
512
|
+
# @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.
|
513
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
518
514
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
519
515
|
# @return [FetchResult]
|
520
516
|
def list_notice_customer_types(options={})
|
@@ -528,8 +524,8 @@ module AvaTax
|
|
528
524
|
# Returns the full list of Avalara-supported tax notice filing types.
|
529
525
|
# This API is intended to be useful to identify all the different notice filing types that can be used in notices.
|
530
526
|
# @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/) .
|
531
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
532
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
527
|
+
# @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.
|
528
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
533
529
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
534
530
|
# @return [FetchResult]
|
535
531
|
def list_notice_filingtypes(options={})
|
@@ -543,8 +539,8 @@ module AvaTax
|
|
543
539
|
# Returns the full list of Avalara-supported tax notice priorities.
|
544
540
|
# This API is intended to be useful to identify all the different notice priorities that can be used in notices.
|
545
541
|
# @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/) .
|
546
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
547
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
542
|
+
# @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.
|
543
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
548
544
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
549
545
|
# @return [FetchResult]
|
550
546
|
def list_notice_priorities(options={})
|
@@ -558,8 +554,8 @@ module AvaTax
|
|
558
554
|
# Returns the full list of Avalara-supported tax notice reasons.
|
559
555
|
# This API is intended to be useful to identify all the different tax notice reasons.
|
560
556
|
# @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/) .
|
561
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
562
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
557
|
+
# @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
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
563
559
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
564
560
|
# @return [FetchResult]
|
565
561
|
def list_notice_reasons(options={})
|
@@ -573,8 +569,8 @@ module AvaTax
|
|
573
569
|
# Returns the full list of Avalara-supported tax notice responsibility ids
|
574
570
|
# This API is intended to be useful to identify all the different tax notice responsibilities.
|
575
571
|
# @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/) .
|
576
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
577
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
572
|
+
# @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.
|
573
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
578
574
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
579
575
|
# @return [FetchResult]
|
580
576
|
def list_notice_responsibilities(options={})
|
@@ -588,8 +584,8 @@ module AvaTax
|
|
588
584
|
# Returns the full list of Avalara-supported tax notice root causes
|
589
585
|
# This API is intended to be useful to identify all the different tax notice root causes.
|
590
586
|
# @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/) .
|
591
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
592
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
587
|
+
# @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.
|
588
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
593
589
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
594
590
|
# @return [FetchResult]
|
595
591
|
def list_notice_root_causes(options={})
|
@@ -603,8 +599,8 @@ module AvaTax
|
|
603
599
|
# Returns the full list of Avalara-supported tax notice statuses.
|
604
600
|
# This API is intended to be useful to identify all the different tax notice statuses.
|
605
601
|
# @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/) .
|
606
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
607
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
602
|
+
# @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.
|
603
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
608
604
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
609
605
|
# @return [FetchResult]
|
610
606
|
def list_notice_statuses(options={})
|
@@ -618,8 +614,8 @@ module AvaTax
|
|
618
614
|
# Returns the full list of Avalara-supported tax notice types.
|
619
615
|
# This API is intended to be useful to identify all the different notice types that can be used in notices.
|
620
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/) .
|
621
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
622
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
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.
|
618
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
623
619
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
624
620
|
# @return [FetchResult]
|
625
621
|
def list_notice_types(options={})
|
@@ -634,8 +630,8 @@ module AvaTax
|
|
634
630
|
# This list of parameters is available for use when configuring your transaction.
|
635
631
|
# Some parameters are only available for use if you have subscribed to certain features of AvaTax.
|
636
632
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
637
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
638
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
633
|
+
# @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.
|
634
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
639
635
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
640
636
|
# @return [FetchResult]
|
641
637
|
def list_parameters(options={})
|
@@ -648,8 +644,8 @@ module AvaTax
|
|
648
644
|
#
|
649
645
|
# Returns the full list of Avalara-supported permission types.
|
650
646
|
# This API is intended to be useful to identify the capabilities of a particular user logon.
|
651
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
652
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
647
|
+
# @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.
|
648
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
653
649
|
# @return [FetchResult]
|
654
650
|
def list_permissions(options={})
|
655
651
|
path = "/api/v2/definitions/permissions"
|
@@ -661,8 +657,8 @@ module AvaTax
|
|
661
657
|
#
|
662
658
|
# Retrieves the list of Avalara-supported postal codes.
|
663
659
|
# @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/) .
|
664
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
665
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
660
|
+
# @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.
|
661
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
666
662
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
667
663
|
# @return [FetchResult]
|
668
664
|
def list_postal_codes(options={})
|
@@ -683,8 +679,8 @@ module AvaTax
|
|
683
679
|
# preferred program. Next, set the parameter `AvaTax.LC.PreferredProgram` in your `CreateTransaction` call to the code of
|
684
680
|
# the program.
|
685
681
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
686
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
687
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
682
|
+
# @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.
|
683
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
688
684
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
689
685
|
# @return [FetchResult]
|
690
686
|
def list_preferred_programs(options={})
|
@@ -699,8 +695,8 @@ module AvaTax
|
|
699
695
|
# This API is intended to be useful to identify all the different rate types.
|
700
696
|
# @param country [String] The country to examine for rate types
|
701
697
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
702
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
703
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
698
|
+
# @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.
|
699
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
704
700
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
705
701
|
# @return [FetchResult]
|
706
702
|
def list_rate_types_by_country(country, options={})
|
@@ -715,8 +711,8 @@ module AvaTax
|
|
715
711
|
# This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region
|
716
712
|
# within the country for a shipping addresses.
|
717
713
|
# @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/) .
|
718
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
719
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
714
|
+
# @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.
|
715
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
720
716
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
721
717
|
# @return [FetchResult]
|
722
718
|
def list_regions(options={})
|
@@ -732,8 +728,8 @@ module AvaTax
|
|
732
728
|
# within the country for a shipping addresses.
|
733
729
|
# @param country [String] The country of which you want to fetch ISO 3166 regions
|
734
730
|
# @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/) .
|
735
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
736
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
731
|
+
# @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.
|
732
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
737
733
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
738
734
|
# @return [FetchResult]
|
739
735
|
def list_regions_by_country(country, options={})
|
@@ -747,8 +743,8 @@ module AvaTax
|
|
747
743
|
# Returns the full list of Avalara-supported resource file types
|
748
744
|
# This API is intended to be useful to identify all the different resource file types.
|
749
745
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
750
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
751
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
746
|
+
# @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.
|
747
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
752
748
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
753
749
|
# @return [FetchResult]
|
754
750
|
def list_resource_file_types(options={})
|
@@ -763,8 +759,8 @@ module AvaTax
|
|
763
759
|
# This API is intended to be useful when designing a user interface for selecting the security role of a user account.
|
764
760
|
# Some security roles are restricted for Avalara internal use.
|
765
761
|
# @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/) .
|
766
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
767
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
762
|
+
# @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.
|
763
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
768
764
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
769
765
|
# @return [FetchResult]
|
770
766
|
def list_security_roles(options={})
|
@@ -780,8 +776,8 @@ module AvaTax
|
|
780
776
|
# You may always contact Avalara's sales department for information on available products or services.
|
781
777
|
# You cannot change your subscriptions directly through the API.
|
782
778
|
# @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/) .
|
783
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
784
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
779
|
+
# @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.
|
780
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
785
781
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
786
782
|
# @return [FetchResult]
|
787
783
|
def list_subscription_types(options={})
|
@@ -795,8 +791,8 @@ module AvaTax
|
|
795
791
|
# Returns the full list of Avalara-supported tax authorities.
|
796
792
|
# This API is intended to be useful to identify all the different authorities that receive tax.
|
797
793
|
# @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/) .
|
798
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
799
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
794
|
+
# @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.
|
795
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
800
796
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
801
797
|
# @return [FetchResult]
|
802
798
|
def list_tax_authorities(options={})
|
@@ -812,8 +808,8 @@ module AvaTax
|
|
812
808
|
# Customers who subscribe to Avalara Managed Returns Service can request these forms to be filed automatically
|
813
809
|
# based on the customer's AvaTax data.
|
814
810
|
# @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
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
816
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
811
|
+
# @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.
|
812
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
817
813
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
818
814
|
# @return [FetchResult]
|
819
815
|
def list_tax_authority_forms(options={})
|
@@ -827,8 +823,8 @@ module AvaTax
|
|
827
823
|
# Returns the full list of Avalara-supported tax authority types.
|
828
824
|
# This API is intended to be useful to identify all the different authority types.
|
829
825
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
|
830
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
831
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
826
|
+
# @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.
|
827
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
832
828
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
833
829
|
# @return [FetchResult]
|
834
830
|
def list_tax_authority_types(options={})
|
@@ -845,8 +841,8 @@ module AvaTax
|
|
845
841
|
# If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
|
846
842
|
# taxability rules for this product in all supported jurisdictions.
|
847
843
|
# @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/) .
|
848
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
849
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
844
|
+
# @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.
|
845
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
850
846
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
851
847
|
# @return [FetchResult]
|
852
848
|
def list_tax_codes(options={})
|
@@ -860,8 +856,8 @@ module AvaTax
|
|
860
856
|
# Returns the full list of recognized tax code types.
|
861
857
|
# A 'Tax Code Type' represents a broad category of tax codes, and is less detailed than a single TaxCode.
|
862
858
|
# This API is intended to be useful for broadly searching for tax codes by tax code type.
|
863
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
864
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
859
|
+
# @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.
|
860
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
865
861
|
# @return [Object]
|
866
862
|
def list_tax_code_types(options={})
|
867
863
|
path = "/api/v2/definitions/taxcodetypes"
|
@@ -874,8 +870,8 @@ module AvaTax
|
|
874
870
|
# Returns the full list of Avalara-supported Tax Forms
|
875
871
|
# This API is intended to be useful to identify all the different Tax Forms
|
876
872
|
# @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/) .
|
877
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
878
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
873
|
+
# @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.
|
874
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
879
875
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
880
876
|
# @return [FetchResult]
|
881
877
|
def list_tax_forms(options={})
|
@@ -889,8 +885,8 @@ module AvaTax
|
|
889
885
|
# Returns the full list of Avalara-supported tax sub-types
|
890
886
|
# This API is intended to be useful to identify all the different tax sub-types.
|
891
887
|
# @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/) .
|
892
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
893
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
888
|
+
# @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.
|
889
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
894
890
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
895
891
|
# @return [FetchResult]
|
896
892
|
def list_tax_sub_types(options={})
|
@@ -904,8 +900,8 @@ module AvaTax
|
|
904
900
|
# Returns the full list of Avalara-supported tax type groups
|
905
901
|
# This API is intended to be useful to identify all the different tax type groups.
|
906
902
|
# @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/) .
|
907
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
908
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
903
|
+
# @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.
|
904
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
909
905
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
910
906
|
# @return [FetchResult]
|
911
907
|
def list_tax_type_groups(options={})
|
@@ -920,8 +916,8 @@ module AvaTax
|
|
920
916
|
#
|
921
917
|
# A unit of measurement system is a method of measuring a quantity, such as distance, mass, or others.
|
922
918
|
# @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/) .
|
923
|
-
# @param top [Integer] If nonzero, return no more than this number of results. Used with
|
924
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with
|
919
|
+
# @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.
|
920
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
925
921
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
926
922
|
# @return [FetchResult]
|
927
923
|
def list_unit_of_measurement(options={})
|