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 Companies
|
4
|
-
|
5
|
-
|
6
|
-
# Checks whether the integration being used to set up this company and run transactions onto this company is compliant to all requirements.
|
7
|
-
#
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module Companies
|
4
|
+
|
5
|
+
|
6
|
+
# Checks whether the integration being used to set up this company and run transactions onto this company is compliant to all requirements.
|
7
|
+
#
|
8
8
|
# Examines the most recent 100 transactions or data from the last month when verifying transaction-related integrations.
|
9
9
|
# For partners who write integrations against AvaTax for many clients, this API is a way to do a quick self testing to verify whether the
|
10
10
|
# written integrations for a company are sufficient enough to be delivered to the respective customers to start using it.
|
@@ -31,14 +31,14 @@ module AvaTax
|
|
31
31
|
#
|
32
32
|
# ### Security Policies
|
33
33
|
#
|
34
|
-
# * 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.
|
34
|
+
# * 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.
|
35
35
|
# @param id [Integer] The ID of the company to check if its integration is certified.
|
36
|
-
# @return [String]
|
37
|
-
def certify_integration(id) path = "/api/v2/companies/#{id}/certify"
|
38
|
-
get(path) end
|
39
|
-
|
40
|
-
# Change the filing status of this company
|
41
|
-
#
|
36
|
+
# @return [String]
|
37
|
+
def certify_integration(id) path = "/api/v2/companies/#{id}/certify"
|
38
|
+
get(path) end
|
39
|
+
|
40
|
+
# Change the filing status of this company
|
41
|
+
#
|
42
42
|
# Changes the current filing status of this company.
|
43
43
|
#
|
44
44
|
# For customers using Avalara's Managed Returns Service, each company within their account can request
|
@@ -55,15 +55,15 @@ module AvaTax
|
|
55
55
|
#
|
56
56
|
# ### Security Policies
|
57
57
|
#
|
58
|
-
# * 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.
|
58
|
+
# * 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.
|
59
59
|
# @param id [Integer]
|
60
60
|
# @param model [Object]
|
61
|
-
# @return [String]
|
62
|
-
def change_filing_status(id, model) path = "/api/v2/companies/#{id}/filingstatus"
|
63
|
-
post(path, model) end
|
64
|
-
|
65
|
-
# Quick setup for a company with a single physical address
|
66
|
-
#
|
61
|
+
# @return [String]
|
62
|
+
def change_filing_status(id, model) path = "/api/v2/companies/#{id}/filingstatus"
|
63
|
+
post(path, model) end
|
64
|
+
|
65
|
+
# Quick setup for a company with a single physical address
|
66
|
+
#
|
67
67
|
# Shortcut to quickly setup a single-physical-location company with critical information and activate it.
|
68
68
|
# This API provides quick and simple company setup functionality and does the following things:
|
69
69
|
#
|
@@ -79,14 +79,14 @@ module AvaTax
|
|
79
79
|
#
|
80
80
|
# ### Security Policies
|
81
81
|
#
|
82
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
82
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
83
83
|
# @param model [Object] Information about the company you wish to create.
|
84
|
-
# @return [Object]
|
85
|
-
def company_initialize(model) path = "/api/v2/companies/initialize"
|
86
|
-
post(path, model) end
|
87
|
-
|
88
|
-
# Create new companies
|
89
|
-
#
|
84
|
+
# @return [Object]
|
85
|
+
def company_initialize(model) path = "/api/v2/companies/initialize"
|
86
|
+
post(path, model) end
|
87
|
+
|
88
|
+
# Create new companies
|
89
|
+
#
|
90
90
|
# Create one or more new company objects.
|
91
91
|
# A 'company' represents a single corporation or individual that is registered to handle transactional taxes.
|
92
92
|
# You may attach nested data objects such as contacts, locations, and nexus with this CREATE call, and those objects will be created with the company.
|
@@ -95,14 +95,14 @@ module AvaTax
|
|
95
95
|
#
|
96
96
|
# ### Security Policies
|
97
97
|
#
|
98
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
98
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
99
99
|
# @param model [CompanyModel[]] Either a single company object or an array of companies to create
|
100
|
-
# @return [CompanyModel[]]
|
101
|
-
def create_companies(model) path = "/api/v2/companies"
|
102
|
-
post(path, model) end
|
103
|
-
|
104
|
-
# Add parameters to a company.
|
105
|
-
#
|
100
|
+
# @return [CompanyModel[]]
|
101
|
+
def create_companies(model) path = "/api/v2/companies"
|
102
|
+
post(path, model) end
|
103
|
+
|
104
|
+
# Add parameters to a company.
|
105
|
+
#
|
106
106
|
# Add parameters to a company.
|
107
107
|
#
|
108
108
|
# Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters".
|
@@ -117,15 +117,15 @@ module AvaTax
|
|
117
117
|
#
|
118
118
|
# ### Security Policies
|
119
119
|
#
|
120
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
120
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
121
121
|
# @param companyId [Integer] The ID of the company that owns this company parameter.
|
122
122
|
# @param model [CompanyParameterDetailModel[]] The company parameters you wish to create.
|
123
|
-
# @return [CompanyParameterDetailModel[]]
|
124
|
-
def create_company_parameters(companyId, model) path = "/api/v2/companies/#{companyId}/parameters"
|
125
|
-
post(path, model) end
|
126
|
-
|
127
|
-
# Request managed returns funding setup for a company
|
128
|
-
#
|
123
|
+
# @return [CompanyParameterDetailModel[]]
|
124
|
+
def create_company_parameters(companyId, model) path = "/api/v2/companies/#{companyId}/parameters"
|
125
|
+
post(path, model) end
|
126
|
+
|
127
|
+
# Request managed returns funding setup for a company
|
128
|
+
#
|
129
129
|
# This API is available by invitation only.
|
130
130
|
# Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are
|
131
131
|
# required to setup their funding configuration before Avalara can begin filing tax returns on their
|
@@ -139,28 +139,28 @@ module AvaTax
|
|
139
139
|
#
|
140
140
|
# ### Security Policies
|
141
141
|
#
|
142
|
-
# * This API depends on the following active services
|
143
|
-
# * 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.
|
142
|
+
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
143
|
+
# * 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.
|
144
144
|
# @param id [Integer] The unique identifier of the company
|
145
145
|
# @param model [Object] The funding initialization request
|
146
|
-
# @return [Object]
|
147
|
-
def create_funding_request(id, model) path = "/api/v2/companies/#{id}/funding/setup"
|
148
|
-
post(path, model) end
|
149
|
-
|
150
|
-
# Delete a single company
|
151
|
-
#
|
146
|
+
# @return [Object]
|
147
|
+
def create_funding_request(id, model) path = "/api/v2/companies/#{id}/funding/setup"
|
148
|
+
post(path, model) end
|
149
|
+
|
150
|
+
# Delete a single company
|
151
|
+
#
|
152
152
|
# Deleting a company will delete all child companies, and all users attached to this company.
|
153
153
|
#
|
154
154
|
# ### Security Policies
|
155
155
|
#
|
156
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
156
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
157
157
|
# @param id [Integer] The ID of the company you wish to delete.
|
158
|
-
# @return [ErrorDetail[]]
|
159
|
-
def delete_company(id) path = "/api/v2/companies/#{id}"
|
160
|
-
delete(path) end
|
161
|
-
|
162
|
-
# Delete a single company parameter
|
163
|
-
#
|
158
|
+
# @return [ErrorDetail[]]
|
159
|
+
def delete_company(id) path = "/api/v2/companies/#{id}"
|
160
|
+
delete(path) end
|
161
|
+
|
162
|
+
# Delete a single company parameter
|
163
|
+
#
|
164
164
|
# Delete a parameter of a company.
|
165
165
|
# Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters".
|
166
166
|
#
|
@@ -170,15 +170,15 @@ module AvaTax
|
|
170
170
|
#
|
171
171
|
# ### Security Policies
|
172
172
|
#
|
173
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
173
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
|
174
174
|
# @param companyId [Integer] The company id
|
175
175
|
# @param id [Integer] The parameter id
|
176
|
-
# @return [ErrorDetail[]]
|
177
|
-
def delete_company_parameter(companyId, id) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
178
|
-
delete(path) end
|
179
|
-
|
180
|
-
# Check the funding configuration of a company
|
181
|
-
#
|
176
|
+
# @return [ErrorDetail[]]
|
177
|
+
def delete_company_parameter(companyId, id) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
178
|
+
delete(path) end
|
179
|
+
|
180
|
+
# Check the funding configuration of a company
|
181
|
+
#
|
182
182
|
# This API is available by invitation only.
|
183
183
|
# Requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
|
184
184
|
# Returns the funding configuration of the requested company.
|
@@ -187,14 +187,14 @@ module AvaTax
|
|
187
187
|
# ### Security Policies
|
188
188
|
#
|
189
189
|
# * 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.
|
190
|
-
# * This API depends on the following active services
|
190
|
+
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
191
191
|
# @param companyId [Integer] The unique identifier of the company
|
192
|
-
# @return [Object]
|
193
|
-
def funding_configuration_by_company(companyId) path = "/api/v2/companies/#{companyId}/funding/configuration"
|
194
|
-
get(path) end
|
195
|
-
|
196
|
-
# Check the funding configuration of a company
|
197
|
-
#
|
192
|
+
# @return [Object]
|
193
|
+
def funding_configuration_by_company(companyId) path = "/api/v2/companies/#{companyId}/funding/configuration"
|
194
|
+
get(path) end
|
195
|
+
|
196
|
+
# Check the funding configuration of a company
|
197
|
+
#
|
198
198
|
# This API is available by invitation only.
|
199
199
|
# Requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
|
200
200
|
# Returns the funding configuration of the requested company.
|
@@ -203,15 +203,15 @@ module AvaTax
|
|
203
203
|
# ### Security Policies
|
204
204
|
#
|
205
205
|
# * 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.
|
206
|
-
# * This API depends on the following active services
|
206
|
+
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
|
207
207
|
# @param companyId [Integer] The unique identifier of the company
|
208
208
|
# @param currency [String] The currency of the funding. USD and CAD are the only valid currencies
|
209
|
-
# @return [FundingConfigurationModel[]]
|
210
|
-
def funding_configurations_by_company_and_currency(companyId, options={}) path = "/api/v2/companies/#{companyId}/funding/configurations"
|
211
|
-
get(path, options) end
|
212
|
-
|
213
|
-
# Retrieve a single company
|
214
|
-
#
|
209
|
+
# @return [FundingConfigurationModel[]]
|
210
|
+
def funding_configurations_by_company_and_currency(companyId, options={}) path = "/api/v2/companies/#{companyId}/funding/configurations"
|
211
|
+
get(path, options) end
|
212
|
+
|
213
|
+
# Retrieve a single company
|
214
|
+
#
|
215
215
|
# Get the company object identified by this URL.
|
216
216
|
# A 'company' represents a single corporation or individual that is registered to handle transactional taxes.
|
217
217
|
# You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values:
|
@@ -228,15 +228,15 @@ module AvaTax
|
|
228
228
|
#
|
229
229
|
# ### Security Policies
|
230
230
|
#
|
231
|
-
# * 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.
|
231
|
+
# * 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.
|
232
232
|
# @param id [Integer] The ID of the company to retrieve.
|
233
233
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. * Child objects - Specify one or more of the following to retrieve objects related to each company: "Contacts", "FilingCalendars", "Items", "Locations", "Nexus", "TaxCodes", "NonReportingChildren" or "TaxRules". * Deleted objects - Specify "FetchDeleted" to retrieve information about previously deleted objects.
|
234
|
-
# @return [Object]
|
235
|
-
def get_company(id, options={}) path = "/api/v2/companies/#{id}"
|
236
|
-
get(path, options) end
|
237
|
-
|
238
|
-
# Get configuration settings for this company
|
239
|
-
#
|
234
|
+
# @return [Object]
|
235
|
+
def get_company(id, options={}) path = "/api/v2/companies/#{id}"
|
236
|
+
get(path, options) end
|
237
|
+
|
238
|
+
# Get configuration settings for this company
|
239
|
+
#
|
240
240
|
# Retrieve a list of all configuration settings tied to this company.
|
241
241
|
#
|
242
242
|
# Configuration settings provide you with the ability to control features of your account and of your
|
@@ -252,14 +252,14 @@ module AvaTax
|
|
252
252
|
#
|
253
253
|
# ### Security Policies
|
254
254
|
#
|
255
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
255
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
256
256
|
# @param id [Integer]
|
257
|
-
# @return [CompanyConfigurationModel[]]
|
258
|
-
def get_company_configuration(id) path = "/api/v2/companies/#{id}/configuration"
|
259
|
-
get(path) end
|
260
|
-
|
261
|
-
# Retrieve a single company parameter
|
262
|
-
#
|
257
|
+
# @return [CompanyConfigurationModel[]]
|
258
|
+
def get_company_configuration(id) path = "/api/v2/companies/#{id}/configuration"
|
259
|
+
get(path) end
|
260
|
+
|
261
|
+
# Retrieve a single company parameter
|
262
|
+
#
|
263
263
|
# Retrieves a single parameter of a company.
|
264
264
|
#
|
265
265
|
# Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters".
|
@@ -270,15 +270,15 @@ module AvaTax
|
|
270
270
|
#
|
271
271
|
# ### Security Policies
|
272
272
|
#
|
273
|
-
# * 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.
|
273
|
+
# * 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.
|
274
274
|
# @param companyId [Integer]
|
275
275
|
# @param id [Integer]
|
276
|
-
# @return [Object]
|
277
|
-
def get_company_parameter_detail(companyId, id) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
278
|
-
get(path) end
|
279
|
-
|
280
|
-
# Get this company's filing status
|
281
|
-
#
|
276
|
+
# @return [Object]
|
277
|
+
def get_company_parameter_detail(companyId, id) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
278
|
+
get(path) end
|
279
|
+
|
280
|
+
# Get this company's filing status
|
281
|
+
#
|
282
282
|
# Retrieve the current filing status of this company.
|
283
283
|
#
|
284
284
|
# For customers using Avalara's Managed Returns Service, each company within their account can request
|
@@ -292,17 +292,18 @@ module AvaTax
|
|
292
292
|
# * `FilingRequested` - The company has requested to begin filing tax returns, but Avalara's compliance team has not yet begun filing.
|
293
293
|
# * `FirstFiling` - The company has recently filing tax returns and is in a new status.
|
294
294
|
# * `Active` - The company is currently active and is filing tax returns via Avalara Managed Returns.
|
295
|
+
# * `Inactive` - The company is currently inactive.
|
295
296
|
#
|
296
297
|
# ### Security Policies
|
297
298
|
#
|
298
|
-
# * 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.
|
299
|
+
# * 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.
|
299
300
|
# @param id [Integer]
|
300
|
-
# @return [String]
|
301
|
-
def get_filing_status(id) path = "/api/v2/companies/#{id}/filingstatus"
|
302
|
-
get(path) end
|
303
|
-
|
304
|
-
# Retrieve parameters for a company
|
305
|
-
#
|
301
|
+
# @return [String]
|
302
|
+
def get_filing_status(id) path = "/api/v2/companies/#{id}/filingstatus"
|
303
|
+
get(path) end
|
304
|
+
|
305
|
+
# Retrieve parameters for a company
|
306
|
+
#
|
306
307
|
# Retrieve all parameters of a company.
|
307
308
|
#
|
308
309
|
# Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters".
|
@@ -316,18 +317,18 @@ module AvaTax
|
|
316
317
|
#
|
317
318
|
# ### Security Policies
|
318
319
|
#
|
319
|
-
# * 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.
|
320
|
+
# * 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.
|
320
321
|
# @param companyId [Integer] The company id
|
321
322
|
# @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
|
322
323
|
# @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
|
323
324
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
324
325
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
325
|
-
# @return [FetchResult]
|
326
|
-
def list_company_parameter_details(companyId, options={}) path = "/api/v2/companies/#{companyId}/parameters"
|
327
|
-
get(path, options) end
|
328
|
-
|
329
|
-
# Check managed returns funding status for a company
|
330
|
-
#
|
326
|
+
# @return [FetchResult]
|
327
|
+
def list_company_parameter_details(companyId, options={}) path = "/api/v2/companies/#{companyId}/parameters"
|
328
|
+
get(path, options) end
|
329
|
+
|
330
|
+
# Check managed returns funding status for a company
|
331
|
+
#
|
331
332
|
# This API is available by invitation only.
|
332
333
|
# Requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
|
333
334
|
# Returns a list of funding setup requests and their current status.
|
@@ -335,28 +336,28 @@ module AvaTax
|
|
335
336
|
#
|
336
337
|
# ### Security Policies
|
337
338
|
#
|
338
|
-
# * This API depends on the following active services
|
339
|
-
# * 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.
|
339
|
+
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
340
|
+
# * 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.
|
340
341
|
# @param id [Integer] The unique identifier of the company
|
341
|
-
# @return [FundingStatusModel[]]
|
342
|
-
def list_funding_requests_by_company(id) path = "/api/v2/companies/#{id}/funding"
|
343
|
-
get(path) end
|
344
|
-
|
345
|
-
# Retrieve a list of MRS Companies with account
|
346
|
-
#
|
342
|
+
# @return [FundingStatusModel[]]
|
343
|
+
def list_funding_requests_by_company(id) path = "/api/v2/companies/#{id}/funding"
|
344
|
+
get(path) end
|
345
|
+
|
346
|
+
# Retrieve a list of MRS Companies with account
|
347
|
+
#
|
347
348
|
# This API is available by invitation only.
|
348
349
|
#
|
349
350
|
# Get a list of companies with an active MRS service.
|
350
351
|
#
|
351
352
|
# ### Security Policies
|
352
353
|
#
|
353
|
-
# * 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.
|
354
|
-
# @return [FetchResult]
|
355
|
-
def list_mrs_companies() path = "/api/v2/companies/mrs"
|
356
|
-
get(path) end
|
357
|
-
|
358
|
-
# Retrieve all companies
|
359
|
-
#
|
354
|
+
# * 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.
|
355
|
+
# @return [FetchResult]
|
356
|
+
def list_mrs_companies() path = "/api/v2/companies/mrs"
|
357
|
+
get(path) end
|
358
|
+
|
359
|
+
# Retrieve all companies
|
360
|
+
#
|
360
361
|
# Get multiple company objects.
|
361
362
|
#
|
362
363
|
# A `company` represents a single corporation or individual that is registered to handle transactional taxes.
|
@@ -377,18 +378,18 @@ module AvaTax
|
|
377
378
|
#
|
378
379
|
# ### Security Policies
|
379
380
|
#
|
380
|
-
# * 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.
|
381
|
+
# * 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.
|
381
382
|
# @param include [String] A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.
|
382
|
-
# @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:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters
|
383
|
+
# @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:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters, supplierandcustomers
|
383
384
|
# @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
|
384
385
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
385
386
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
386
|
-
# @return [FetchResult]
|
387
|
-
def query_companies(options={}) path = "/api/v2/companies"
|
388
|
-
get(path, options) end
|
389
|
-
|
390
|
-
# Change configuration settings for this company
|
391
|
-
#
|
387
|
+
# @return [FetchResult]
|
388
|
+
def query_companies(options={}) path = "/api/v2/companies"
|
389
|
+
get(path, options) end
|
390
|
+
|
391
|
+
# Change configuration settings for this company
|
392
|
+
#
|
392
393
|
# Update configuration settings tied to this company.
|
393
394
|
#
|
394
395
|
# Configuration settings provide you with the ability to control features of your account and of your
|
@@ -404,15 +405,15 @@ module AvaTax
|
|
404
405
|
#
|
405
406
|
# ### Security Policies
|
406
407
|
#
|
407
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
408
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
408
409
|
# @param id [Integer]
|
409
410
|
# @param model [CompanyConfigurationModel[]]
|
410
|
-
# @return [CompanyConfigurationModel[]]
|
411
|
-
def set_company_configuration(id, model) path = "/api/v2/companies/#{id}/configuration"
|
412
|
-
post(path, model) end
|
413
|
-
|
414
|
-
# Update a single company
|
415
|
-
#
|
411
|
+
# @return [CompanyConfigurationModel[]]
|
412
|
+
def set_company_configuration(id, model) path = "/api/v2/companies/#{id}/configuration"
|
413
|
+
post(path, model) end
|
414
|
+
|
415
|
+
# Update a single company
|
416
|
+
#
|
416
417
|
# Replace the existing company object at this URL with an updated object.
|
417
418
|
#
|
418
419
|
# A `CompanyModel` represents a single corporation or individual that is registered to handle transactional taxes.
|
@@ -427,15 +428,15 @@ module AvaTax
|
|
427
428
|
#
|
428
429
|
# ### Security Policies
|
429
430
|
#
|
430
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
431
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
431
432
|
# @param id [Integer] The ID of the company you wish to update.
|
432
433
|
# @param model [Object] The company object you wish to update.
|
433
|
-
# @return [Object]
|
434
|
-
def update_company(id, model) path = "/api/v2/companies/#{id}"
|
435
|
-
put(path, model) end
|
436
|
-
|
437
|
-
# Update a company parameter
|
438
|
-
#
|
434
|
+
# @return [Object]
|
435
|
+
def update_company(id, model) path = "/api/v2/companies/#{id}"
|
436
|
+
put(path, model) end
|
437
|
+
|
438
|
+
# Update a company parameter
|
439
|
+
#
|
439
440
|
# Update a parameter of a company.
|
440
441
|
#
|
441
442
|
# Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters".
|
@@ -446,13 +447,13 @@ module AvaTax
|
|
446
447
|
#
|
447
448
|
# ### Security Policies
|
448
449
|
#
|
449
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
450
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
450
451
|
# @param companyId [Integer] The company id.
|
451
452
|
# @param id [Integer] The company parameter id
|
452
453
|
# @param model [Object] The company parameter object you wish to update.
|
453
|
-
# @return [Object]
|
454
|
-
def update_company_parameter_detail(companyId, id, model) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
455
|
-
put(path, model) end
|
456
|
-
end
|
457
|
-
end
|
454
|
+
# @return [Object]
|
455
|
+
def update_company_parameter_detail(companyId, id, model) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
456
|
+
put(path, model) end
|
457
|
+
end
|
458
|
+
end
|
458
459
|
end
|