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