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