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