avatax 19.3.0 → 19.4.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.
Files changed (38) hide show
  1. checksums.yaml +4 -4
  2. data/lib/avatax/client/accounts.rb +28 -0
  3. data/lib/avatax/client/addresses.rb +10 -0
  4. data/lib/avatax/client/avafileforms.rb +30 -0
  5. data/lib/avatax/client/batches.rb +24 -0
  6. data/lib/avatax/client/certexpressinvites.rb +15 -0
  7. data/lib/avatax/client/certificates.rb +76 -1
  8. data/lib/avatax/client/companies.rb +66 -2
  9. data/lib/avatax/client/contacts.rb +24 -0
  10. data/lib/avatax/client/customers.rb +50 -0
  11. data/lib/avatax/client/datasources.rb +30 -0
  12. data/lib/avatax/client/definitions.rb +28 -4
  13. data/lib/avatax/client/distancethresholds.rb +24 -0
  14. data/lib/avatax/client/filingcalendars.rb +132 -0
  15. data/lib/avatax/client/filings.rb +164 -2
  16. data/lib/avatax/client/free.rb +4 -0
  17. data/lib/avatax/client/fundingrequests.rb +12 -0
  18. data/lib/avatax/client/items.rb +64 -23
  19. data/lib/avatax/client/jurisdictionoverrides.rb +24 -0
  20. data/lib/avatax/client/locations.rb +28 -0
  21. data/lib/avatax/client/multidocument.rb +50 -0
  22. data/lib/avatax/client/nexus.rb +34 -21
  23. data/lib/avatax/client/notices.rb +141 -2
  24. data/lib/avatax/client/notifications.rb +12 -0
  25. data/lib/avatax/client/onboarding.rb +12 -0
  26. data/lib/avatax/client/registrar.rb +44 -1
  27. data/lib/avatax/client/reports.rb +16 -0
  28. data/lib/avatax/client/settings.rb +24 -0
  29. data/lib/avatax/client/subscriptions.rb +12 -0
  30. data/lib/avatax/client/taxcodes.rb +24 -0
  31. data/lib/avatax/client/taxcontent.rb +14 -15
  32. data/lib/avatax/client/taxrules.rb +24 -0
  33. data/lib/avatax/client/transactions.rb +187 -1
  34. data/lib/avatax/client/upcs.rb +30 -0
  35. data/lib/avatax/client/users.rb +44 -14
  36. data/lib/avatax/client/utilities.rb +4 -0
  37. data/lib/avatax/version.rb +1 -1
  38. metadata +2 -2
@@ -18,6 +18,10 @@ module AvaTax
18
18
  # * Avalara compliance team members may change a company from `FirstFiling` to `Active`.
19
19
  #
20
20
  # All other status changes must be requested through the Avalara customer support team.
21
+ #
22
+ # ### Security Policies
23
+ #
24
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
21
25
  # @param id [Integer]
22
26
  # @param model [Object]
23
27
  # @return [String]
@@ -41,6 +45,10 @@ module AvaTax
41
45
  # This API only provides a limited subset of functionality compared to the 'Create Company' API call.
42
46
  # If you need additional features or options not present in this 'Quick Setup' API call, please use the full 'Create Company' call instead.
43
47
  # Please allow 1 minute before making transactions using the company.
48
+ #
49
+ # ### Security Policies
50
+ #
51
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
44
52
  # @param model [Object] Information about the company you wish to create.
45
53
  # @return [Object]
46
54
  def company_initialize(model)
@@ -54,6 +62,10 @@ module AvaTax
54
62
  # Create one or more new company objects.
55
63
  # A 'company' represents a single corporation or individual that is registered to handle transactional taxes.
56
64
  # 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.
65
+ #
66
+ # ### Security Policies
67
+ #
68
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
57
69
  # @param model [CompanyModel[]] Either a single company object or an array of companies to create
58
70
  # @return [CompanyModel[]]
59
71
  def create_companies(model)
@@ -74,6 +86,10 @@ module AvaTax
74
86
  # before approval.
75
87
  # This API records that an ambedded HTML funding setup widget was activated.
76
88
  # This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
89
+ #
90
+ # ### Security Policies
91
+ #
92
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
77
93
  # @param id [Integer] The unique identifier of the company
78
94
  # @param model [Object] The funding initialization request
79
95
  # @return [Object]
@@ -86,6 +102,10 @@ module AvaTax
86
102
  # Delete a single company
87
103
  #
88
104
  # Deleting a company will delete all child companies, and all users attached to this company.
105
+ #
106
+ # ### Security Policies
107
+ #
108
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
89
109
  # @param id [Integer] The ID of the company you wish to delete.
90
110
  # @return [ErrorDetail[]]
91
111
  def delete_company(id)
@@ -100,6 +120,12 @@ module AvaTax
100
120
  # Requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
101
121
  # Returns the funding configuration of the requested company.
102
122
  # .
123
+ #
124
+ # ### Security Policies
125
+ #
126
+ # * 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.
127
+ # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
128
+ # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
103
129
  # @param companyId [Integer] The unique identifier of the company
104
130
  # @return [Object]
105
131
  def funding_configuration_by_company(companyId)
@@ -114,6 +140,12 @@ module AvaTax
114
140
  # Requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
115
141
  # Returns the funding configuration of the requested company.
116
142
  # .
143
+ #
144
+ # ### Security Policies
145
+ #
146
+ # * 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.
147
+ # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
148
+ # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
117
149
  # @param companyId [Integer] The unique identifier of the company
118
150
  # @param currency [String] The currency of the funding. USD and CAD are the only valid currencies
119
151
  # @return [FundingConfigurationModel[]]
@@ -137,8 +169,12 @@ module AvaTax
137
169
  # * TaxCodes
138
170
  # * TaxRules
139
171
  # * UPC
172
+ #
173
+ # ### Security Policies
174
+ #
175
+ # * 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.
140
176
  # @param id [Integer] The ID of the company to retrieve.
141
- # @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", or "TaxRules". * Deleted objects - Specify "FetchDeleted" to retrieve information about previously deleted objects.
177
+ # @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.
142
178
  # @return [Object]
143
179
  def get_company(id, options={})
144
180
  path = "/api/v2/companies/#{id}"
@@ -160,6 +196,10 @@ module AvaTax
160
196
  #
161
197
  # Avalara-based company settings for `AvaCertServiceConfig` affect your company's exemption certificate
162
198
  # processing, and should be changed with care.
199
+ #
200
+ # ### Security Policies
201
+ #
202
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
163
203
  # @param id [Integer]
164
204
  # @return [CompanyConfigurationModel[]]
165
205
  def get_company_configuration(id)
@@ -183,6 +223,10 @@ module AvaTax
183
223
  # * `FilingRequested` - The company has requested to begin filing tax returns, but Avalara's compliance team has not yet begun filing.
184
224
  # * `FirstFiling` - The company has recently filing tax returns and is in a new status.
185
225
  # * `Active` - The company is currently active and is filing tax returns via Avalara Managed Returns.
226
+ #
227
+ # ### Security Policies
228
+ #
229
+ # * 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.
186
230
  # @param id [Integer]
187
231
  # @return [String]
188
232
  def get_filing_status(id)
@@ -197,6 +241,10 @@ module AvaTax
197
241
  # Requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
198
242
  # Returns a list of funding setup requests and their current status.
199
243
  # Each object in the result is a request that was made to setup or adjust funding status for this company.
244
+ #
245
+ # ### Security Policies
246
+ #
247
+ # * 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.
200
248
  # @param id [Integer] The unique identifier of the company
201
249
  # @return [FundingStatusModel[]]
202
250
  def list_funding_requests_by_company(id)
@@ -210,6 +258,10 @@ module AvaTax
210
258
  # This API is available by invitation only.
211
259
  #
212
260
  # Get a list of companies with an active MRS service.
261
+ #
262
+ # ### Security Policies
263
+ #
264
+ # * 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.
213
265
  # @return [FetchResult]
214
266
  def list_mrs_companies()
215
267
  path = "/api/v2/companies/mrs"
@@ -235,8 +287,12 @@ module AvaTax
235
287
  # * TaxCodes
236
288
  # * TaxRules
237
289
  # * UPC
290
+ #
291
+ # ### Security Policies
292
+ #
293
+ # * 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.
238
294
  # @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.
239
- # @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:* contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, exemptCerts
295
+ # @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:* contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts
240
296
  # @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.
241
297
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
242
298
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -261,6 +317,10 @@ module AvaTax
261
317
  #
262
318
  # Avalara-based company settings for `AvaCertServiceConfig` affect your company's exemption certificate
263
319
  # processing, and should be changed with care.
320
+ #
321
+ # ### Security Policies
322
+ #
323
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
264
324
  # @param id [Integer]
265
325
  # @param model [CompanyConfigurationModel[]]
266
326
  # @return [CompanyConfigurationModel[]]
@@ -281,6 +341,10 @@ module AvaTax
281
341
  # such as contacts, locations, or settings are not permitted. To update the nested objects
282
342
  #
283
343
  # To set a field's value to `null`, you may either set its value to `null` or omit that field from the object you PUT.
344
+ #
345
+ # ### Security Policies
346
+ #
347
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
284
348
  # @param id [Integer] The ID of the company you wish to update.
285
349
  # @param model [Object] The company object you wish to update.
286
350
  # @return [Object]
@@ -8,6 +8,10 @@ module AvaTax
8
8
  # Create one or more new contact objects.
9
9
  # A 'contact' is a person associated with a company who is designated to handle certain responsibilities of
10
10
  # a tax collecting and filing entity.
11
+ #
12
+ # ### Security Policies
13
+ #
14
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
11
15
  # @param companyId [Integer] The ID of the company that owns this contact.
12
16
  # @param model [ContactModel[]] The contacts you wish to create.
13
17
  # @return [ContactModel[]]
@@ -20,6 +24,10 @@ module AvaTax
20
24
  # Delete a single contact
21
25
  #
22
26
  # Mark the existing contact object at this URL as deleted.
27
+ #
28
+ # ### Security Policies
29
+ #
30
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
23
31
  # @param companyId [Integer] The ID of the company that owns this contact.
24
32
  # @param id [Integer] The ID of the contact you wish to delete.
25
33
  # @return [ErrorDetail[]]
@@ -34,6 +42,10 @@ module AvaTax
34
42
  # Get the contact object identified by this URL.
35
43
  # A 'contact' is a person associated with a company who is designated to handle certain responsibilities of
36
44
  # a tax collecting and filing entity.
45
+ #
46
+ # ### Security Policies
47
+ #
48
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
37
49
  # @param companyId [Integer] The ID of the company for this contact
38
50
  # @param id [Integer] The primary key of this contact
39
51
  # @return [Object]
@@ -49,6 +61,10 @@ module AvaTax
49
61
  #
50
62
  # 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/) .
51
63
  # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
64
+ #
65
+ # ### Security Policies
66
+ #
67
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
52
68
  # @param companyId [Integer] The ID of the company that owns these contacts
53
69
  # @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/).
54
70
  # @param include [String] A comma separated list of additional data to retrieve.
@@ -70,6 +86,10 @@ module AvaTax
70
86
  #
71
87
  # 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
88
  # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
89
+ #
90
+ # ### Security Policies
91
+ #
92
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
73
93
  # @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/).
74
94
  # @param include [String] A comma separated list of additional data to retrieve.
75
95
  # @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.
@@ -89,6 +109,10 @@ module AvaTax
89
109
  # a tax collecting and filing entity.
90
110
  # All data from the existing object will be replaced with data in the object you PUT.
91
111
  # 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.
112
+ #
113
+ # ### Security Policies
114
+ #
115
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
92
116
  # @param companyId [Integer] The ID of the company that this contact belongs to.
93
117
  # @param id [Integer] The ID of the contact you wish to update
94
118
  # @param model [Object] The contact you wish to update.
@@ -20,6 +20,11 @@ module AvaTax
20
20
  # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
21
21
  # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
22
22
  # storage for this company, call `RequestCertificateSetup`.
23
+ #
24
+ # ### Security Policies
25
+ #
26
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
27
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
23
28
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
24
29
  # @param model [CustomerModel[]] The list of customer objects to be created
25
30
  # @return [CustomerModel[]]
@@ -43,6 +48,11 @@ module AvaTax
43
48
  # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
44
49
  # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
45
50
  # storage for this company, call `RequestCertificateSetup`.
51
+ #
52
+ # ### Security Policies
53
+ #
54
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
55
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
46
56
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
47
57
  # @param customerCode [String] The unique code representing this customer
48
58
  # @return [Object]
@@ -71,6 +81,11 @@ module AvaTax
71
81
  # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
72
82
  # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
73
83
  # storage for this company, call `RequestCertificateSetup`.
84
+ #
85
+ # ### Security Policies
86
+ #
87
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
88
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
74
89
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
75
90
  # @param customerCode [String] The unique code representing this customer
76
91
  # @param include [String] Specify optional additional objects to include in this fetch request
@@ -95,6 +110,11 @@ module AvaTax
95
110
  # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
96
111
  # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
97
112
  # storage for this company, call `RequestCertificateSetup`.
113
+ #
114
+ # ### Security Policies
115
+ #
116
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
117
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
98
118
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
99
119
  # @param customerCode [String] The unique code representing this customer
100
120
  # @param model [Object] The list of certificates to link to this customer
@@ -120,6 +140,11 @@ module AvaTax
120
140
  #
121
141
  # Note that you can only link a ship-to customer record to a bill-to customer record. You may not link two customers
122
142
  # of the same kind together.
143
+ #
144
+ # ### Security Policies
145
+ #
146
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
147
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
123
148
  # @param companyId [Integer] The unique ID number of the company defining customers.
124
149
  # @param code [String] The code of the bill-to customer to link.
125
150
  # @param model [Object] A list of information about ship-to customers to link to this bill-to customer.
@@ -144,6 +169,11 @@ module AvaTax
144
169
  # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
145
170
  # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
146
171
  # storage for this company, call `RequestCertificateSetup`.
172
+ #
173
+ # ### Security Policies
174
+ #
175
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
176
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
147
177
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
148
178
  # @param customerCode [String] The unique code representing this customer
149
179
  # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate.
@@ -175,6 +205,11 @@ module AvaTax
175
205
  # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
176
206
  # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
177
207
  # storage for this company, call `RequestCertificateSetup`.
208
+ #
209
+ # ### Security Policies
210
+ #
211
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
212
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
178
213
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
179
214
  # @param customerCode [String] The unique code representing this customer
180
215
  # @param country [String] Search for certificates matching this country. Uses the ISO 3166 two character country code.
@@ -204,6 +239,11 @@ module AvaTax
204
239
  # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
205
240
  # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
206
241
  # storage for this company, call `RequestCertificateSetup`.
242
+ #
243
+ # ### Security Policies
244
+ #
245
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
246
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
207
247
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
208
248
  # @param include [String] OPTIONAL - You can specify the value `certificates` to fetch information about certificates linked to the customer.
209
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/).<br />*Not filterable:* shipTos
@@ -231,6 +271,11 @@ module AvaTax
231
271
  # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
232
272
  # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
233
273
  # storage for this company, call `RequestCertificateSetup`.
274
+ #
275
+ # ### Security Policies
276
+ #
277
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
278
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
234
279
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
235
280
  # @param customerCode [String] The unique code representing this customer
236
281
  # @param model [Object] The list of certificates to link to this customer
@@ -255,6 +300,11 @@ module AvaTax
255
300
  # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
256
301
  # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
257
302
  # storage for this company, call `RequestCertificateSetup`.
303
+ #
304
+ # ### Security Policies
305
+ #
306
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
307
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
258
308
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
259
309
  # @param customerCode [String] The unique code representing this customer
260
310
  # @param model [Object] The new customer model that will replace the existing record at this URL
@@ -6,6 +6,11 @@ module AvaTax
6
6
  # Create and store new datasources for the respective companies.
7
7
  #
8
8
  # Create one or more datasource objects.
9
+ #
10
+ # ### Security Policies
11
+ #
12
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
13
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
9
14
  # @param companyId [Integer] The id of the company you which to create the datasources
10
15
  # @param model [DataSourceModel[]]
11
16
  # @return [DataSourceModel[]]
@@ -18,6 +23,11 @@ module AvaTax
18
23
  # Delete a datasource by datasource id for a company.
19
24
  #
20
25
  # Marks the existing datasource for a company as deleted.
26
+ #
27
+ # ### Security Policies
28
+ #
29
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
30
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
21
31
  # @param companyId [Integer] The id of the company the datasource belongs to.
22
32
  # @param id [Integer] The id of the datasource you wish to delete.
23
33
  # @return [ErrorDetail[]]
@@ -30,6 +40,11 @@ module AvaTax
30
40
  # Get data source by data source id
31
41
  #
32
42
  # Retrieve the data source by its unique ID number.
43
+ #
44
+ # ### Security Policies
45
+ #
46
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
47
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
33
48
  # @param companyId [Integer]
34
49
  # @param id [Integer] data source id
35
50
  # @return [Object]
@@ -42,6 +57,11 @@ module AvaTax
42
57
  # Retrieve all datasources for this company
43
58
  #
44
59
  # Gets multiple datasource objects for a given company.
60
+ #
61
+ # ### Security Policies
62
+ #
63
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
64
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
45
65
  # @param companyId [Integer] The id of the company you wish to retrieve the datasources.
46
66
  # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* isEnabled, isSynced, isAuthorized
47
67
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
@@ -60,6 +80,11 @@ module AvaTax
60
80
  #
61
81
  # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
62
82
  # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
83
+ #
84
+ # ### Security Policies
85
+ #
86
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
87
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
63
88
  # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* isEnabled, isSynced, isAuthorized
64
89
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
65
90
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -74,6 +99,11 @@ module AvaTax
74
99
  # Update a datasource identified by id for a company
75
100
  #
76
101
  # Updates a datasource for a company.
102
+ #
103
+ # ### Security Policies
104
+ #
105
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
106
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
77
107
  # @param companyId [Integer] The id of the company the datasource belongs to.
78
108
  # @param id [Integer] The id of the datasource you wish to delete.
79
109
  # @param model [Object]
@@ -15,6 +15,10 @@ module AvaTax
15
15
  #
16
16
  # This API is intended to be useful to review the descriptive hierarchy of an HS Code, which can be particularly helpful
17
17
  # when HS Codes can have multiple levels of generic descriptions.
18
+ #
19
+ # ### Security Policies
20
+ #
21
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxGlobal.
18
22
  # @param country [String] The name or code of the destination country.
19
23
  # @param hsCode [String] The partial or full HS Code for which you would like to view all of the parents.
20
24
  # @return [FetchResult]
@@ -211,6 +215,10 @@ module AvaTax
211
215
  # Section/Chapter/Heading/Subheading/Classification.
212
216
  #
213
217
  # This API is intended to be useful to identify the correct HS Code to use for your item.
218
+ #
219
+ # ### Security Policies
220
+ #
221
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxGlobal.
214
222
  # @param country [String] The name or code of the destination country.
215
223
  # @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.
216
224
  # @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
@@ -232,6 +240,10 @@ module AvaTax
232
240
  #
233
241
  # This API is intended to be useful to identify the top level Sections for
234
242
  # further LandedCost HS Code lookups.
243
+ #
244
+ # ### Security Policies
245
+ #
246
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxGlobal.
235
247
  # @return [FetchResult]
236
248
  def list_cross_border_sections()
237
249
  path = "/api/v2/definitions/crossborder/sections"
@@ -382,7 +394,7 @@ module AvaTax
382
394
  # Returns the full list of all Avalara-supported nexus for all countries and regions.
383
395
  #
384
396
  # This API is intended to be useful if your user interface needs to display a selectable list of nexus.
385
- # @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, taxAuthorityId
397
+ # @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
386
398
  # @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.
387
399
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
388
400
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -407,7 +419,7 @@ module AvaTax
407
419
  # @param region [String] Name or ISO 3166 code identifying the region portion of the address. This field supports many different region identifiers: * Two and three character ISO 3166 region codes * Fully spelled out names of the region in ISO supported languages * Common alternative spellings for many regions For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
408
420
  # @param postalCode [String] The postal code or zip code portion of this address.
409
421
  # @param country [String] Name or ISO 3166 code identifying the country portion of this address. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
410
- # @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, taxAuthorityId
422
+ # @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
411
423
  # @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.
412
424
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
413
425
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -424,7 +436,7 @@ module AvaTax
424
436
  #
425
437
  # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country.
426
438
  # @param country [String] The country in which you want to fetch the system nexus
427
- # @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, taxAuthorityId
439
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* streamlinedSalesTax, isSSTActive, taxAuthorityId
428
440
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
429
441
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
430
442
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -442,7 +454,7 @@ module AvaTax
442
454
  # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region.
443
455
  # @param country [String] The two-character ISO-3166 code for the country.
444
456
  # @param region [String] The two or three character region code for the region.
445
- # @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, taxAuthorityId
457
+ # @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
446
458
  # @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.
447
459
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
448
460
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -466,6 +478,10 @@ module AvaTax
466
478
  # This API is intended to provide useful information when examining a tax form. If you are about to begin filing
467
479
  # a tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax
468
480
  # form in order to better understand how the form will be filled out.
481
+ #
482
+ # ### Security Policies
483
+ #
484
+ # * 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.
469
485
  # @param formCode [String] The form code that we are looking up the nexus for
470
486
  # @return [Object]
471
487
  def list_nexus_by_form_code(formCode)
@@ -643,6 +659,10 @@ module AvaTax
643
659
  # Retrieve the parameters by companyCode and itemCode.
644
660
  #
645
661
  # Returns the list of parameters based on the company country and state jurisdiction and the item code.
662
+ #
663
+ # ### Security Policies
664
+ #
665
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
646
666
  # @param companyCode [String] Company code.
647
667
  # @param itemCode [String] Item code.
648
668
  # @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
@@ -891,6 +911,10 @@ module AvaTax
891
911
  # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
892
912
  # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
893
913
  # taxability rules for this product in all supported jurisdictions.
914
+ #
915
+ # ### Security Policies
916
+ #
917
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
894
918
  # @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/).
895
919
  # @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.
896
920
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.