avatax 20.9.0 → 21.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.vs/slnx.sqlite +0 -0
- data/lib/avatax/client/accounts.rb +83 -83
- data/lib/avatax/client/addresses.rb +21 -21
- data/lib/avatax/client/advancedrules.rb +41 -51
- data/lib/avatax/client/avafileforms.rb +41 -41
- data/lib/avatax/client/batches.rb +62 -62
- data/lib/avatax/client/certexpressinvites.rb +39 -39
- data/lib/avatax/client/certificates.rb +163 -163
- data/lib/avatax/client/companies.rb +157 -156
- 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 +591 -422
- data/lib/avatax/client/distancethresholds.rb +48 -48
- data/lib/avatax/client/ecms.rb +26 -31
- data/lib/avatax/client/ecommercetoken.rb +17 -17
- data/lib/avatax/client/errortransactions.rb +27 -15
- data/lib/avatax/client/filingcalendars.rb +48 -12
- data/lib/avatax/client/filings.rb +23 -21
- data/lib/avatax/client/firmclientlinkages.rb +69 -69
- data/lib/avatax/client/free.rb +13 -86
- data/lib/avatax/client/fundingrequests.rb +20 -20
- data/lib/avatax/client/items.rb +255 -137
- data/lib/avatax/client/jurisdictionoverrides.rb +48 -48
- data/lib/avatax/client/locations.rb +92 -92
- data/lib/avatax/client/multidocument.rb +78 -78
- data/lib/avatax/client/nexus.rb +133 -105
- data/lib/avatax/client/notices.rb +43 -504
- data/lib/avatax/client/notifications.rb +27 -27
- data/lib/avatax/client/provisioning.rb +20 -20
- data/lib/avatax/client/registrar.rb +85 -75
- data/lib/avatax/client/reports.rb +44 -35
- data/lib/avatax/client/settings.rb +55 -50
- data/lib/avatax/client/subscriptions.rb +27 -27
- data/lib/avatax/client/taxcodes.rb +48 -48
- data/lib/avatax/client/taxcontent.rb +90 -27
- data/lib/avatax/client/taxprofiles.rb +14 -10
- data/lib/avatax/client/taxrules.rb +50 -50
- data/lib/avatax/client/transactions.rb +155 -155
- data/lib/avatax/client/upcs.rb +48 -48
- data/lib/avatax/client/users.rb +64 -64
- data/lib/avatax/client/utilities.rb +27 -27
- data/lib/avatax/configuration.rb +1 -1
- data/lib/avatax/request.rb +11 -5
- data/lib/avatax/version.rb +1 -1
- data/spec/avatax/request_spec.rb +25 -0
- metadata +12 -4
@@ -1,10 +1,10 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module JurisdictionOverrides
|
4
|
-
|
5
|
-
|
6
|
-
# Create one or more overrides
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module JurisdictionOverrides
|
4
|
+
|
5
|
+
|
6
|
+
# Create one or more overrides
|
7
|
+
#
|
8
8
|
# Creates one or more jurisdiction override objects for this account.
|
9
9
|
#
|
10
10
|
# A Jurisdiction Override is a configuration setting that allows you to select the taxing
|
@@ -14,28 +14,28 @@ module AvaTax
|
|
14
14
|
#
|
15
15
|
# ### Security Policies
|
16
16
|
#
|
17
|
-
# * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
17
|
+
# * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
18
18
|
# @param accountId [Integer] The ID of the account that owns this override
|
19
19
|
# @param model [JurisdictionOverrideModel[]] The jurisdiction override objects to create
|
20
|
-
# @return [JurisdictionOverrideModel[]]
|
21
|
-
def create_jurisdiction_overrides(accountId, model) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
|
22
|
-
post(path, model) end
|
23
|
-
|
24
|
-
# Delete a single override
|
25
|
-
#
|
20
|
+
# @return [JurisdictionOverrideModel[]]
|
21
|
+
def create_jurisdiction_overrides(accountId, model) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
|
22
|
+
post(path, model) end
|
23
|
+
|
24
|
+
# Delete a single override
|
25
|
+
#
|
26
26
|
# Marks the item object at this URL as deleted.
|
27
27
|
#
|
28
28
|
# ### Security Policies
|
29
29
|
#
|
30
|
-
# * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
30
|
+
# * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
31
31
|
# @param accountId [Integer] The ID of the account that owns this override
|
32
32
|
# @param id [Integer] The ID of the override you wish to delete
|
33
|
-
# @return [ErrorDetail[]]
|
34
|
-
def delete_jurisdiction_override(accountId, id) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
|
35
|
-
delete(path) end
|
36
|
-
|
37
|
-
# Retrieve a single override
|
38
|
-
#
|
33
|
+
# @return [ErrorDetail[]]
|
34
|
+
def delete_jurisdiction_override(accountId, id) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
|
35
|
+
delete(path) end
|
36
|
+
|
37
|
+
# Retrieve a single override
|
38
|
+
#
|
39
39
|
# Get the item object identified by this URL.
|
40
40
|
#
|
41
41
|
# A Jurisdiction Override is a configuration setting that allows you to select the taxing
|
@@ -45,15 +45,15 @@ module AvaTax
|
|
45
45
|
#
|
46
46
|
# ### Security Policies
|
47
47
|
#
|
48
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
48
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
49
49
|
# @param accountId [Integer] The ID of the account that owns this override
|
50
50
|
# @param id [Integer] The primary key of this override
|
51
|
-
# @return [Object]
|
52
|
-
def get_jurisdiction_override(accountId, id) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
|
53
|
-
get(path) end
|
54
|
-
|
55
|
-
# Retrieve overrides for this account
|
56
|
-
#
|
51
|
+
# @return [Object]
|
52
|
+
def get_jurisdiction_override(accountId, id) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
|
53
|
+
get(path) end
|
54
|
+
|
55
|
+
# Retrieve overrides for this account
|
56
|
+
#
|
57
57
|
# List all jurisdiction override objects defined for this account.
|
58
58
|
#
|
59
59
|
# A Jurisdiction Override is a configuration setting that allows you to select the taxing
|
@@ -66,19 +66,19 @@ module AvaTax
|
|
66
66
|
#
|
67
67
|
# ### Security Policies
|
68
68
|
#
|
69
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
69
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
70
70
|
# @param accountId [Integer] The ID of the account that owns this override
|
71
71
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* country, Jurisdictions
|
72
72
|
# @param include [String] A comma separated list of additional data to retrieve.
|
73
73
|
# @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
|
74
74
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
75
75
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
76
|
-
# @return [FetchResult]
|
77
|
-
def list_jurisdiction_overrides_by_account(accountId, options={}) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
|
78
|
-
get(path, options) end
|
79
|
-
|
80
|
-
# Retrieve all overrides
|
81
|
-
#
|
76
|
+
# @return [FetchResult]
|
77
|
+
def list_jurisdiction_overrides_by_account(accountId, options={}) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
|
78
|
+
get(path, options) end
|
79
|
+
|
80
|
+
# Retrieve all overrides
|
81
|
+
#
|
82
82
|
# Get multiple jurisdiction override objects across all companies.
|
83
83
|
#
|
84
84
|
# A Jurisdiction Override is a configuration setting that allows you to select the taxing
|
@@ -91,29 +91,29 @@ module AvaTax
|
|
91
91
|
#
|
92
92
|
# ### Security Policies
|
93
93
|
#
|
94
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
94
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
95
95
|
# @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* country, Jurisdictions
|
96
96
|
# @param include [String] A comma separated list of additional data to retrieve.
|
97
97
|
# @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
|
98
98
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
99
99
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
100
|
-
# @return [FetchResult]
|
101
|
-
def query_jurisdiction_overrides(options={}) path = "/api/v2/jurisdictionoverrides"
|
102
|
-
get(path, options) end
|
103
|
-
|
104
|
-
# Update a single jurisdictionoverride
|
105
|
-
#
|
100
|
+
# @return [FetchResult]
|
101
|
+
def query_jurisdiction_overrides(options={}) path = "/api/v2/jurisdictionoverrides"
|
102
|
+
get(path, options) end
|
103
|
+
|
104
|
+
# Update a single jurisdictionoverride
|
105
|
+
#
|
106
106
|
# Replace the existing jurisdictionoverride object at this URL with an updated object.
|
107
107
|
#
|
108
108
|
# ### Security Policies
|
109
109
|
#
|
110
|
-
# * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
110
|
+
# * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
111
111
|
# @param accountId [Integer] The ID of the account that this jurisdictionoverride belongs to.
|
112
112
|
# @param id [Integer] The ID of the jurisdictionoverride you wish to update
|
113
113
|
# @param model [Object] The jurisdictionoverride object you wish to update.
|
114
|
-
# @return [Object]
|
115
|
-
def update_jurisdiction_override(accountId, id, model) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
|
116
|
-
put(path, model) end
|
117
|
-
end
|
118
|
-
end
|
114
|
+
# @return [Object]
|
115
|
+
def update_jurisdiction_override(accountId, id, model) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
|
116
|
+
put(path, model) end
|
117
|
+
end
|
118
|
+
end
|
119
119
|
end
|
@@ -1,10 +1,10 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module Locations
|
4
|
-
|
5
|
-
|
6
|
-
# Add parameters to a location.
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module Locations
|
4
|
+
|
5
|
+
|
6
|
+
# Add parameters to a location.
|
7
|
+
#
|
8
8
|
# Add parameters to a location.
|
9
9
|
#
|
10
10
|
# Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters".
|
@@ -19,42 +19,42 @@ module AvaTax
|
|
19
19
|
#
|
20
20
|
# ### Security Policies
|
21
21
|
#
|
22
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
22
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
23
23
|
# @param companyId [Integer] The ID of the company that owns this location parameter.
|
24
24
|
# @param locationId [Integer] The location id.
|
25
25
|
# @param model [LocationParameterModel[]] The location parameters you wish to create.
|
26
|
-
# @return [LocationParameterModel[]]
|
27
|
-
def create_location_parameters(companyId, locationId, model) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters"
|
28
|
-
post(path, model) end
|
29
|
-
|
30
|
-
# Create a new location
|
31
|
-
#
|
26
|
+
# @return [LocationParameterModel[]]
|
27
|
+
def create_location_parameters(companyId, locationId, model) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters"
|
28
|
+
post(path, model) end
|
29
|
+
|
30
|
+
# Create a new location
|
31
|
+
#
|
32
32
|
# Create one or more new location objects attached to this company.
|
33
33
|
#
|
34
34
|
# ### Security Policies
|
35
35
|
#
|
36
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
36
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
37
37
|
# @param companyId [Integer] The ID of the company that owns this location.
|
38
38
|
# @param model [LocationModel[]] The location you wish to create.
|
39
|
-
# @return [LocationModel[]]
|
40
|
-
def create_locations(companyId, model) path = "/api/v2/companies/#{companyId}/locations"
|
41
|
-
post(path, model) end
|
42
|
-
|
43
|
-
# Delete a single location
|
44
|
-
#
|
39
|
+
# @return [LocationModel[]]
|
40
|
+
def create_locations(companyId, model) path = "/api/v2/companies/#{companyId}/locations"
|
41
|
+
post(path, model) end
|
42
|
+
|
43
|
+
# Delete a single location
|
44
|
+
#
|
45
45
|
# Mark the location object at this URL as deleted.
|
46
46
|
#
|
47
47
|
# ### Security Policies
|
48
48
|
#
|
49
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
49
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
50
50
|
# @param companyId [Integer] The ID of the company that owns this location.
|
51
51
|
# @param id [Integer] The ID of the location you wish to delete.
|
52
|
-
# @return [ErrorDetail[]]
|
53
|
-
def delete_location(companyId, id) path = "/api/v2/companies/#{companyId}/locations/#{id}"
|
54
|
-
delete(path) end
|
55
|
-
|
56
|
-
# Delete a single location parameter
|
57
|
-
#
|
52
|
+
# @return [ErrorDetail[]]
|
53
|
+
def delete_location(companyId, id) path = "/api/v2/companies/#{companyId}/locations/#{id}"
|
54
|
+
delete(path) end
|
55
|
+
|
56
|
+
# Delete a single location parameter
|
57
|
+
#
|
58
58
|
# Delete a single location parameter.
|
59
59
|
#
|
60
60
|
# Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters".
|
@@ -65,16 +65,16 @@ module AvaTax
|
|
65
65
|
#
|
66
66
|
# ### Security Policies
|
67
67
|
#
|
68
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
68
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
69
69
|
# @param companyId [Integer] The company id
|
70
70
|
# @param locationId [Integer] The location id
|
71
71
|
# @param id [Integer] The parameter id
|
72
|
-
# @return [ErrorDetail[]]
|
73
|
-
def delete_location_parameter(companyId, locationId, id) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
|
74
|
-
delete(path) end
|
75
|
-
|
76
|
-
# Retrieve a single location
|
77
|
-
#
|
72
|
+
# @return [ErrorDetail[]]
|
73
|
+
def delete_location_parameter(companyId, locationId, id) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
|
74
|
+
delete(path) end
|
75
|
+
|
76
|
+
# Retrieve a single location
|
77
|
+
#
|
78
78
|
# Get the location object identified by this URL.
|
79
79
|
# An 'Location' represents a physical address where a company does business.
|
80
80
|
# Many taxing authorities require that you define a list of all locations where your company does business.
|
@@ -88,16 +88,16 @@ module AvaTax
|
|
88
88
|
#
|
89
89
|
# ### Security Policies
|
90
90
|
#
|
91
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
91
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
92
92
|
# @param companyId [Integer] The ID of the company that owns this location
|
93
93
|
# @param id [Integer] The primary key of this location
|
94
94
|
# @param include [String] A comma separated list of additional data to retrieve.
|
95
|
-
# @return [Object]
|
96
|
-
def get_location(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/locations/#{id}"
|
97
|
-
get(path, options) end
|
98
|
-
|
99
|
-
# Retrieve a single company location parameter
|
100
|
-
#
|
95
|
+
# @return [Object]
|
96
|
+
def get_location(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/locations/#{id}"
|
97
|
+
get(path, options) end
|
98
|
+
|
99
|
+
# Retrieve a single company location parameter
|
100
|
+
#
|
101
101
|
# Retrieve a single location parameter.
|
102
102
|
#
|
103
103
|
# Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters".
|
@@ -108,16 +108,16 @@ module AvaTax
|
|
108
108
|
#
|
109
109
|
# ### Security Policies
|
110
110
|
#
|
111
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
111
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
112
112
|
# @param companyId [Integer] The company id
|
113
113
|
# @param locationId [Integer] The location id
|
114
114
|
# @param id [Integer] The parameter id
|
115
|
-
# @return [Object]
|
116
|
-
def get_location_parameter(companyId, locationId, id) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
|
117
|
-
get(path) end
|
118
|
-
|
119
|
-
# Retrieve parameters for a location
|
120
|
-
#
|
115
|
+
# @return [Object]
|
116
|
+
def get_location_parameter(companyId, locationId, id) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
|
117
|
+
get(path) end
|
118
|
+
|
119
|
+
# Retrieve parameters for a location
|
120
|
+
#
|
121
121
|
# List parameters for a location.
|
122
122
|
#
|
123
123
|
# Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters".
|
@@ -131,19 +131,19 @@ module AvaTax
|
|
131
131
|
#
|
132
132
|
# ### Security Policies
|
133
133
|
#
|
134
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
134
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
135
135
|
# @param companyId [Integer] The company id
|
136
136
|
# @param locationId [Integer] The ID of the location
|
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:* name, unit
|
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_location_parameters(companyId, locationId, options={}) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters"
|
143
|
-
get(path, options) end
|
144
|
-
|
145
|
-
# Retrieve locations for this company
|
146
|
-
#
|
141
|
+
# @return [FetchResult]
|
142
|
+
def list_location_parameters(companyId, locationId, options={}) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters"
|
143
|
+
get(path, options) end
|
144
|
+
|
145
|
+
# Retrieve locations for this company
|
146
|
+
#
|
147
147
|
# List all location objects defined for this company.
|
148
148
|
# An 'Location' represents a physical address where a company does business.
|
149
149
|
# Many taxing authorities require that you define a list of all locations where your company does business.
|
@@ -159,19 +159,19 @@ module AvaTax
|
|
159
159
|
#
|
160
160
|
# ### Security Policies
|
161
161
|
#
|
162
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
162
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
163
163
|
# @param companyId [Integer] The ID of the company that owns these locations
|
164
|
-
# @param filter [String] A filter 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:* settings, parameters
|
164
|
+
# @param filter [String] A filter 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:* isMarketplaceOutsideUsa, settings, parameters
|
165
165
|
# @param include [String] A comma separated list of additional data to retrieve.
|
166
166
|
# @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
|
167
167
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
168
168
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
169
|
-
# @return [FetchResult]
|
170
|
-
def list_locations_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/locations"
|
171
|
-
get(path, options) end
|
172
|
-
|
173
|
-
# Retrieve all locations
|
174
|
-
#
|
169
|
+
# @return [FetchResult]
|
170
|
+
def list_locations_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/locations"
|
171
|
+
get(path, options) end
|
172
|
+
|
173
|
+
# Retrieve all locations
|
174
|
+
#
|
175
175
|
# Get multiple location objects across all companies.
|
176
176
|
# An 'Location' represents a physical address where a company does business.
|
177
177
|
# Many taxing authorities require that you define a list of all locations where your company does business.
|
@@ -188,34 +188,34 @@ module AvaTax
|
|
188
188
|
#
|
189
189
|
# ### Security Policies
|
190
190
|
#
|
191
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
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:* settings, parameters
|
191
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
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:* isMarketplaceOutsideUsa, settings, parameters
|
193
193
|
# @param include [String] A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.
|
194
194
|
# @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
|
195
195
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
196
196
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
197
|
-
# @return [FetchResult]
|
198
|
-
def query_locations(options={}) path = "/api/v2/locations"
|
199
|
-
get(path, options) end
|
200
|
-
|
201
|
-
# Update a single location
|
202
|
-
#
|
197
|
+
# @return [FetchResult]
|
198
|
+
def query_locations(options={}) path = "/api/v2/locations"
|
199
|
+
get(path, options) end
|
200
|
+
|
201
|
+
# Update a single location
|
202
|
+
#
|
203
203
|
# Replace the existing location object at this URL with an updated object.
|
204
204
|
# All data from the existing object will be replaced with data in the object you PUT.
|
205
205
|
# To set a field's value to null, you may either set its value to null or omit that field from the object you post.
|
206
206
|
#
|
207
207
|
# ### Security Policies
|
208
208
|
#
|
209
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
209
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
210
210
|
# @param companyId [Integer] The ID of the company that this location belongs to.
|
211
211
|
# @param id [Integer] The ID of the location you wish to update
|
212
212
|
# @param model [Object] The location you wish to update.
|
213
|
-
# @return [Object]
|
214
|
-
def update_location(companyId, id, model) path = "/api/v2/companies/#{companyId}/locations/#{id}"
|
215
|
-
put(path, model) end
|
216
|
-
|
217
|
-
# Update a location parameter
|
218
|
-
#
|
213
|
+
# @return [Object]
|
214
|
+
def update_location(companyId, id, model) path = "/api/v2/companies/#{companyId}/locations/#{id}"
|
215
|
+
put(path, model) end
|
216
|
+
|
217
|
+
# Update a location parameter
|
218
|
+
#
|
219
219
|
# Update a location parameter.
|
220
220
|
#
|
221
221
|
# Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters".
|
@@ -226,29 +226,29 @@ module AvaTax
|
|
226
226
|
#
|
227
227
|
# ### Security Policies
|
228
228
|
#
|
229
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
229
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
230
230
|
# @param companyId [Integer] The company id.
|
231
231
|
# @param locationId [Integer] The location id
|
232
232
|
# @param id [Integer] The location parameter id
|
233
233
|
# @param model [Object] The location parameter object you wish to update.
|
234
|
-
# @return [Object]
|
235
|
-
def update_location_parameter(companyId, locationId, id, model) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
|
236
|
-
put(path, model) end
|
237
|
-
|
238
|
-
# Validate the location against local requirements
|
239
|
-
#
|
234
|
+
# @return [Object]
|
235
|
+
def update_location_parameter(companyId, locationId, id, model) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
|
236
|
+
put(path, model) end
|
237
|
+
|
238
|
+
# Validate the location against local requirements
|
239
|
+
#
|
240
240
|
# Returns validation information for this location.
|
241
241
|
# This API call is intended to compare this location against the currently known taxing authority rules and regulations,
|
242
242
|
# and provide information about what additional work is required to completely setup this location.
|
243
243
|
#
|
244
244
|
# ### Security Policies
|
245
245
|
#
|
246
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
246
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
247
247
|
# @param companyId [Integer] The ID of the company that owns this location
|
248
248
|
# @param id [Integer] The primary key of this location
|
249
|
-
# @return [Object]
|
250
|
-
def validate_location(companyId, id) path = "/api/v2/companies/#{companyId}/locations/#{id}/validate"
|
251
|
-
get(path) end
|
252
|
-
end
|
253
|
-
end
|
249
|
+
# @return [Object]
|
250
|
+
def validate_location(companyId, id) path = "/api/v2/companies/#{companyId}/locations/#{id}/validate"
|
251
|
+
get(path) end
|
252
|
+
end
|
253
|
+
end
|
254
254
|
end
|