avatax 21.3.1 → 21.6.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f954acc262e0f93e75cfa135773ab4ba008c032d396499c4550109efb59114b8
4
- data.tar.gz: 2cdc43d59f4efe0f6a6d4ceca7922f549a67c3a1318a5513390564f4f67ccab1
3
+ metadata.gz: acf8e863c32d81a5e93a697495aeaa81205d4f474d461e5773cb654fe0338c76
4
+ data.tar.gz: 665d929cdbf4e98a2f7dd32d51e979a46af7f5c384a35a9ca740a3c9c816d10a
5
5
  SHA512:
6
- metadata.gz: 79ed773916600f4ff09733e1d04d892f738da10ffddfa50357f01ba929333636d7430afb40496b956e27cd3e65736f5490d958e7c749b8c111fcb702a6b7c4db
7
- data.tar.gz: 49cbe74ffdba0cd4bafe3eff81c6c28621d4e1ae599feea50741d382ae82a8138c04a2dc0ab322153317b84871279c96bc5fff1a8076aa4f4c7b7393b1342dc7
6
+ metadata.gz: 433144353772bf44e370ee01982969d59a03b6d82151a9fbfcebb58ecdf793c9af280d8bf552730d1033eacdff2b01f65997c7dba1c719301e35d4150d1976b5
7
+ data.tar.gz: c9a8d018ce16be9e2b71496adc9f6642b1f1600522a36fa91bd03f40d2eb83b3bf369522a6526f5e7f91e2ec88eeea05df394ace7c14f1a7da8fc503b90c478e
@@ -106,6 +106,19 @@ module AvaTax
106
106
  def list_certificate_exposure_zones(options={}) path = "/api/v2/definitions/certificateexposurezones"
107
107
  get(path, options) end
108
108
 
109
+ # Retrieve the full list of Avalara-supported usage of extra parameters for classification of a item.
110
+ #
111
+ # Returns the full list of Avalara-supported usage of extra parameters for item classification.
112
+ # The list of parameters is available for use with Item Classification.
113
+ # Some parameters are only available for use if you have subscribed to certain features of AvaTax.
114
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* values
115
+ # @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.
116
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
117
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
118
+ # @return [FetchResult]
119
+ def list_classification_parameters_usage(options={}) path = "/api/v2/definitions/classification/parametersusage"
120
+ get(path, options) end
121
+
109
122
  # Retrieve the full list of communications service types
110
123
  #
111
124
  # Returns full list of service types for a given transaction type ID.
@@ -564,7 +577,16 @@ module AvaTax
564
577
 
565
578
  # Retrieve the parameters by companyCode and itemCode.
566
579
  #
567
- # Returns the list of parameters based on the company country and state jurisdiction and the item code.
580
+ # Returns the list of parameters based on the company's service types and the item code.
581
+ # Ignores nexus if a service type is configured in the 'IgnoreNexusForServiceTypes' configuration section.
582
+ # Ignores nexus for the AvaAlcohol service type.
583
+ #
584
+ # NOTE: If your company code or item code contains any of these characters /, +, ? or a space, please use the following encoding before making a request:
585
+ # * Replace '/' with '\_-ava2f-\_' For example: 'Company/Code' becomes 'Company_-ava2f-_Code'
586
+ # * Replace '+' with '\_-ava2b-\_' For example: 'Company+Code' becomes 'Company_-ava2b-_Code'
587
+ # * Replace '?' with '\_-ava3f-\_' For example: 'Company?Code' becomes 'Company_-ava3f-_Code'
588
+ # * Replace '%' with '\_-ava25-\_' For example: 'Company%Code' becomes 'Company_-ava25-_Code'
589
+ # * Replace '#' with '\_-ava23-\_' For example: 'Company#Code' becomes 'Company_-ava23-_Code'
568
590
  #
569
591
  # ### Security Policies
570
592
  #
@@ -653,6 +675,14 @@ module AvaTax
653
675
  #
654
676
  # Tax authorities use product classification systems as a way to identify products and associate them with a tax rate.
655
677
  # More than one tax authority might use the same product classification system, but they might charge different tax rates for products.
678
+ #
679
+ #
680
+ # NOTE: If your company code contains any of these characters /, +, ? or a space, please use the following encoding before making a request:
681
+ # * Replace '/' with '\_-ava2f-\_' For example: 'Company/Code' becomes 'Company_-ava2f-_Code'
682
+ # * Replace '+' with '\_-ava2b-\_' For example: 'Company+Code' becomes 'Company_-ava2b-_Code'
683
+ # * Replace '?' with '\_-ava3f-\_' For example: 'Company?Code' becomes 'Company_-ava3f-_Code'
684
+ # * Replace '%' with '\_-ava25-\_' For example: 'Company%Code' becomes 'Company_-ava25-_Code'
685
+ # * Replace '#' with '\_-ava23-\_' For example: 'Company#Code' becomes 'Company_-ava23-_Code'
656
686
  # @param companyCode [String] The company code.
657
687
  # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* countries
658
688
  # @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.
@@ -715,6 +745,19 @@ module AvaTax
715
745
  def list_resource_file_types(options={}) path = "/api/v2/definitions/resourcefiletypes"
716
746
  get(path, options) end
717
747
 
748
+ # Retrieve the full list of Avalara-supported usage of parameters used for returns.
749
+ #
750
+ # Returns the full list of Avalara-supported usage of extra parameters for the returns.
751
+ # This list of parameters is available for use with Returns.
752
+ # Some parameters are only available for use if you have subscribed to certain features of AvaTax.
753
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* values
754
+ # @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.
755
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
756
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
757
+ # @return [FetchResult]
758
+ def list_returns_parameters_usage(options={}) path = "/api/v2/definitions/returns/parametersusage"
759
+ get(path, options) end
760
+
718
761
  # Retrieve the full list of Avalara-supported permissions
719
762
  #
720
763
  # Returns the full list of Avalara-supported permission types.
@@ -742,6 +785,17 @@ module AvaTax
742
785
  def list_subscription_types(options={}) path = "/api/v2/definitions/subscriptiontypes"
743
786
  get(path, options) end
744
787
 
788
+ # Retrieve the list all tags supported by avalara
789
+ #
790
+ # Retrieves the list of suggested locations for a marketplace.
791
+ # @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/).
792
+ # @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.
793
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
794
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
795
+ # @return [FetchResult]
796
+ def list_tags(options={}) path = "/api/v2/definitions/tags"
797
+ get(path, options) end
798
+
745
799
  # Retrieve the full list of Avalara-supported tax authorities.
746
800
  #
747
801
  # Returns the full list of Avalara-supported tax authorities.
@@ -39,6 +39,27 @@ module AvaTax
39
39
  def batch_delete_item_parameters(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
40
40
  delete(path) end
41
41
 
42
+ # Bulk upload items from a product catalog
43
+ #
44
+ # Create/Update one or more item objects attached to this company.
45
+ #
46
+ # Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
47
+ # can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,
48
+ # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
49
+ # from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance
50
+ # team can manage your item catalog and adjust the tax behavior of items without having to modify your software.
51
+ #
52
+ # The tax code takes precedence over the tax code id if both are provided.
53
+ #
54
+ # ### Security Policies
55
+ #
56
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
57
+ # @param companyId [Integer] The ID of the company that owns this items.
58
+ # @param model [Object] The items you wish to upload.
59
+ # @return [Object]
60
+ def bulk_upload_items(companyId, model) path = "/api/v2/companies/#{companyId}/items/upload"
61
+ post(path, model) end
62
+
42
63
  # Add classifications to an item.
43
64
  #
44
65
  # Add classifications to an item.
@@ -104,6 +125,22 @@ module AvaTax
104
125
  def create_items(companyId, model) path = "/api/v2/companies/#{companyId}/items"
105
126
  post(path, model) end
106
127
 
128
+ # Create tags for a item
129
+ #
130
+ # Creates one or more new `Tag` objects attached to this Item.
131
+ #
132
+ # Item tags puts multiple labels for an item. So that item can be easily grouped by these tags.
133
+ #
134
+ # ### Security Policies
135
+ #
136
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
137
+ # @param companyId [Integer] The ID of the company that defined these items
138
+ # @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
139
+ # @param model [ItemTagDetailModel[]] Tags you wish to associate with the Item
140
+ # @return [ItemTagDetailModel[]]
141
+ def create_item_tags(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags"
142
+ post(path, model) end
143
+
107
144
  # Delete a single item
108
145
  #
109
146
  # Deletes the item object at this URL.
@@ -163,6 +200,37 @@ module AvaTax
163
200
  def delete_item_parameter(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
164
201
  delete(path) end
165
202
 
203
+ # Delete item tag by id
204
+ #
205
+ # Deletes the `Tag` object of an Item at this URL.
206
+ #
207
+ # Item tags puts multiple labels for an item. So that item can be easily grouped by these tags.
208
+ #
209
+ # ### Security Policies
210
+ #
211
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
212
+ # @param companyId [Integer] The ID of the company that defined these items
213
+ # @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
214
+ # @param itemTagDetailId [Integer] The ID of the item tag detail you wish to delete.
215
+ # @return [ErrorDetail[]]
216
+ def delete_item_tag(companyId, itemId, itemTagDetailId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags/#{itemTagDetailId}"
217
+ delete(path) end
218
+
219
+ # Delete all item tags
220
+ #
221
+ # Deletes all `Tags` objects of an Item at this URL.
222
+ #
223
+ # Item tags puts multiple labels for an item. So that item can be easily grouped by these tags.
224
+ #
225
+ # ### Security Policies
226
+ #
227
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
228
+ # @param companyId [Integer] The ID of the company that defined these items.
229
+ # @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
230
+ # @return [ErrorDetail[]]
231
+ def delete_item_tags(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags"
232
+ delete(path) end
233
+
166
234
  # Retrieve a single item
167
235
  #
168
236
  # Get the `Item` object identified by this URL.
@@ -221,6 +289,24 @@ module AvaTax
221
289
  def get_item_parameter(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
222
290
  get(path) end
223
291
 
292
+ # Retrieve tags for an item
293
+ #
294
+ # Get the `Tag` objects of an Item identified by this URL.
295
+ #
296
+ # Item tags puts multiple labels for an item. So that item can be easily grouped by these tags.
297
+ #
298
+ # ### Security Policies
299
+ #
300
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
301
+ # @param companyId [Integer] The ID of the company that defined these items
302
+ # @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
303
+ # @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:* tagName
304
+ # @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.
305
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
306
+ # @return [FetchResult]
307
+ def get_item_tags(companyId, itemId, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags"
308
+ get(path, options) end
309
+
224
310
  # Retrieve classifications for an item.
225
311
  #
226
312
  # List classifications for an item.
@@ -263,7 +349,7 @@ module AvaTax
263
349
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
264
350
  # @param companyId [Integer] The company id
265
351
  # @param itemId [Integer] The item id
266
- # @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
352
+ # @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, isNeededForCalculation, isNeededForReturns, isNeededForClassification
267
353
  # @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.
268
354
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
269
355
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -294,7 +380,7 @@ module AvaTax
294
380
  #
295
381
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
296
382
  # @param companyId [Integer] The ID of the company that defined these items
297
- # @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:* taxCode, classifications, 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:* taxCode, classifications, parameters, tags
298
384
  # @param include [String] A comma separated list of additional data to retrieve.
299
385
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
300
386
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -320,7 +406,7 @@ module AvaTax
320
406
  # ### Security Policies
321
407
  #
322
408
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
323
- # @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:* taxCode, classifications, parameters
409
+ # @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:* taxCode, classifications, parameters, tags
324
410
  # @param include [String] A comma separated list of additional data to retrieve.
325
411
  # @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.
326
412
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -329,6 +415,34 @@ module AvaTax
329
415
  def query_items(options={}) path = "/api/v2/items"
330
416
  get(path, options) end
331
417
 
418
+ # Retrieve all items associated with given tag
419
+ #
420
+ # Get multiple item objects associated with given tag.
421
+ #
422
+ # Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
423
+ # can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,
424
+ # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
425
+ # from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance
426
+ # team can manage your item catalog and adjust the tax behavior of items without having to modify your software.
427
+ #
428
+ # 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/) .
429
+ #
430
+ # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
431
+ #
432
+ # ### Security Policies
433
+ #
434
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
435
+ # @param companyId [Integer] The ID of the company that defined these items.
436
+ # @param tag [String] The master tag to be associated with item.
437
+ # @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:* taxCode, classifications, parameters, tags
438
+ # @param include [String] A comma separated list of additional data to retrieve.
439
+ # @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.
440
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
441
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
442
+ # @return [FetchResult]
443
+ def query_items_by_tag(companyId, tag, options={}) path = "/api/v2/companies/#{companyId}/items/bytags/#{tag}"
444
+ get(path, options) end
445
+
332
446
  # Sync items from a product catalog
333
447
  #
334
448
  # Syncs a list of items with AvaTax without waiting for them to be created. It is ideal for syncing large product catalogs
@@ -3,424 +3,55 @@ module AvaTax
3
3
  module Notices
4
4
 
5
5
 
6
- # Create a new notice comment.
6
+ # Creates a new tax notice responsibility type.
7
7
  #
8
- # This API is available by invitation only.
9
- # 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.
10
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
11
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
8
+ # This API is available by invitation only and only available for users with Compliance admin access.
12
9
  #
13
10
  # ### Security Policies
14
11
  #
15
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
16
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
17
- # @param companyId [Integer] The ID of the company that owns this notice.
18
- # @param id [Integer] The ID of the tax notice we are adding the comment for.
19
- # @param model [NoticeCommentModel[]] The notice comments you wish to create.
20
- # @return [NoticeCommentModel[]]
21
- def create_notice_comment(companyId, id, model) path = "/api/v2/companies/#{companyId}/notices/#{id}/comments"
22
- post(path, model) end
23
-
24
- # Create a new notice finance details.
25
- #
26
- # This API is available by invitation only.
27
- # 'Notice finance details' is the categorical breakdown of the total charge levied by the tax authority on our customer,
28
- # as broken down in our "notice log" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'.
29
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
30
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
31
- #
32
- # ### Security Policies
33
- #
34
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
35
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
36
- # @param companyId [Integer] The ID of the company that owns this notice.
37
- # @param id [Integer] The ID of the notice added to the finance details.
38
- # @param model [NoticeFinanceModel[]] The notice finance details you wish to create.
39
- # @return [NoticeFinanceModel[]]
40
- def create_notice_finance_details(companyId, id, model) path = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails"
41
- post(path, model) end
42
-
43
- # Create a new notice responsibility.
44
- #
45
- # This API is available by invitation only.
46
- # 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.
47
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
48
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
49
- #
50
- # ### Security Policies
51
- #
52
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
53
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
54
- # @param companyId [Integer] The ID of the company that owns this notice.
55
- # @param id [Integer] The ID of the tax notice we are adding the responsibility for.
56
- # @param model [NoticeResponsibilityDetailModel[]] The notice responsibilities you wish to create.
57
- # @return [NoticeResponsibilityDetailModel[]]
58
- def create_notice_responsibilities(companyId, id, model) path = "/api/v2/companies/#{companyId}/notices/#{id}/responsibilities"
59
- post(path, model) end
60
-
61
- # Create a new notice root cause.
62
- #
63
- # This API is available by invitation only.
64
- # 'Notice root causes' are are those who are responsible for the notice.
65
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
66
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
67
- #
68
- # ### Security Policies
69
- #
70
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
71
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
72
- # @param companyId [Integer] The ID of the company that owns this notice.
73
- # @param id [Integer] The ID of the tax notice we are adding the responsibility for.
74
- # @param model [NoticeRootCauseDetailModel[]] The notice root causes you wish to create.
75
- # @return [NoticeRootCauseDetailModel[]]
76
- def create_notice_root_causes(companyId, id, model) path = "/api/v2/companies/#{companyId}/notices/#{id}/rootcauses"
12
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
13
+ # * 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.
14
+ # @param model [Object] The responsibility type to create
15
+ # @return [Object]
16
+ def create_notice_responsibility_type(model) path = "/api/v2/notices/responsibilities"
77
17
  post(path, model) end
78
18
 
79
- # Create a new notice.
19
+ # Creates a new tax notice root cause type.
80
20
  #
81
- # This API is available by invitation only.
82
- # Create one or more new notice objects.
83
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
84
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
21
+ # This API is available by invitation only and only available for users with Compliance admin access.
85
22
  #
86
23
  # ### Security Policies
87
24
  #
88
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
89
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
90
- # @param companyId [Integer] The ID of the company that owns this notice.
91
- # @param model [NoticeModel[]] The notice object you wish to create.
92
- # @return [NoticeModel[]]
93
- def create_notices(companyId, model) path = "/api/v2/companies/#{companyId}/notices"
25
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
26
+ # * 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.
27
+ # @param model [Object] The root cause type to create
28
+ # @return [Object]
29
+ def create_notice_root_cause_type(model) path = "/api/v2/notices/rootcauses"
94
30
  post(path, model) end
95
31
 
96
- # Delete a single notice.
97
- #
98
- # This API is available by invitation only.
99
- # 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.
100
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
101
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
102
- #
103
- # ### Security Policies
104
- #
105
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
106
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
107
- # @param companyId [Integer] The ID of the company that owns this notice.
108
- # @param id [Integer] The ID of the notice you wish to delete the finance detail from.
109
- # @param commentDetailsId [Integer] The ID of the comment you wish to delete.
110
- # @return [ErrorDetail[]]
111
- def delete_comment_details(companyId, id, commentDetailsId) path = "/api/v2/companies/#{companyId}/notices/#{id}/commentdetails/#{commentdetailsid}"
112
- delete(path) end
113
-
114
- # Delete a single notice.
115
- #
116
- # This API is available by invitation only.
117
- # 'Notice finance details' is the categorical breakdown of the total charge levied by the tax authority on our customer,
118
- # as broken down in our "notice log" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'.
119
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
120
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
121
- #
122
- # ### Security Policies
123
- #
124
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
125
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
126
- # @param companyId [Integer] The ID of the company that owns this notice.
127
- # @param id [Integer] The ID of the notice you wish to delete the finance detail from.
128
- # @param financeDetailsId [Integer] The ID of the finance detail you wish to delete.
129
- # @return [ErrorDetail[]]
130
- def delete_finance_details(companyId, id, financeDetailsId) path = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails/#{financedetailsid}"
131
- delete(path) end
132
-
133
- # Delete a single notice.
32
+ # Delete a tax notice responsibility type.
134
33
  #
135
- # This API is available by invitation only.
136
- # Mark the existing notice object at this URL as deleted.
137
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
138
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
34
+ # This API is available by invitation only and only available for users with Compliance admin access.
139
35
  #
140
36
  # ### Security Policies
141
37
  #
142
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
143
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
144
- # @param companyId [Integer] The ID of the company that owns this notice.
145
- # @param id [Integer] The ID of the notice you wish to delete.
38
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
39
+ # @param responsibilityId [Integer] The unique ID of the responsibility type
146
40
  # @return [ErrorDetail[]]
147
- def delete_notice(companyId, id) path = "/api/v2/companies/#{companyId}/notices/#{id}"
41
+ def delete_notice_responsibility_type(responsibilityId) path = "/api/v2/notices/responsibilities/#{responsibilityId}"
148
42
  delete(path) end
149
43
 
150
- # Delete a single responsibility
44
+ # Delete a tax notice root cause type.
151
45
  #
152
- # This API is available by invitation only.
153
- # Mark the existing notice object at this URL as deleted.
154
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
155
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
46
+ # This API is available by invitation only and only available for users with Compliance admin access.
156
47
  #
157
48
  # ### Security Policies
158
49
  #
159
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
160
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
161
- # @param companyId [Integer] The ID of the company that owns this notice.
162
- # @param noticeId [Integer] The ID of the notice you wish to delete.
163
- # @param id [Integer] The ID of the responsibility you wish to delete.
50
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
51
+ # @param rootCauseId [Integer] The unique ID of the root cause type
164
52
  # @return [ErrorDetail[]]
165
- def delete_responsibilities(companyId, noticeId, id) path = "/api/v2/companies/#{companyId}/notices/#{noticeId}/responsibilities/#{id}"
53
+ def delete_notice_root_cause_type(rootCauseId) path = "/api/v2/notices/rootcauses/#{rootCauseId}"
166
54
  delete(path) end
167
-
168
- # Delete a single root cause.
169
- #
170
- # This API is available by invitation only.
171
- # Mark the existing notice object at this URL as deleted.
172
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
173
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
174
- #
175
- # ### Security Policies
176
- #
177
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
178
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
179
- # @param companyId [Integer] The ID of the company that owns this notice.
180
- # @param noticeId [Integer] The ID of the notice you wish to delete.
181
- # @param id [Integer] The ID of the root cause you wish to delete.
182
- # @return [ErrorDetail[]]
183
- def delete_root_causes(companyId, noticeId, id) path = "/api/v2/companies/#{companyId}/notices/#{noticeId}/rootcauses/#{id}"
184
- delete(path) end
185
-
186
- # Retrieve a single attachment
187
- #
188
- # This API is available by invitation only.
189
- # Get the file attachment identified by this URL.
190
- #
191
- # ### Security Policies
192
- #
193
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
194
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
195
- # @param companyId [Integer] The ID of the company for this attachment.
196
- # @param id [Integer] The ResourceFileId of the attachment to download.
197
- # @return [Object]
198
- def download_notice_attachment(companyId, id) path = "/api/v2/companies/#{companyId}/notices/files/#{id}/attachment"
199
- get(path) end
200
-
201
- # Retrieve a single notice.
202
- #
203
- # This API is available by invitation only.
204
- # Get the tax notice object identified by this URL.
205
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
206
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
207
- #
208
- # ### Security Policies
209
- #
210
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
211
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
212
- # @param companyId [Integer] The ID of the company for this notice.
213
- # @param id [Integer] The ID of this notice.
214
- # @return [Object]
215
- def get_notice(companyId, id) path = "/api/v2/companies/#{companyId}/notices/#{id}"
216
- get(path) end
217
-
218
- # Retrieve notice comments for a specific notice.
219
- #
220
- # This API is available by invitation only.
221
- # 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.
222
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
223
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
224
- #
225
- # ### Security Policies
226
- #
227
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
228
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
229
- # @param id [Integer] The ID of the notice.
230
- # @param companyId [Integer] The ID of the company that owns these notices.
231
- # @return [FetchResult]
232
- def get_notice_comments(id, companyId) path = "/api/v2/companies/#{companyId}/notices/#{id}/comments"
233
- get(path) end
234
-
235
- # Retrieve notice finance details for a specific notice.
236
- #
237
- # This API is available by invitation only.
238
- # 'Notice finance details' is the categorical breakdown of the total charge levied by the tax authority on our customer,
239
- # as broken down in our "notice log" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'.
240
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
241
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
242
- #
243
- # ### Security Policies
244
- #
245
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
246
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
247
- # @param id [Integer] The ID of the company that owns these notices.
248
- # @param companyId [Integer] The ID of the company that owns these notices.
249
- # @return [FetchResult]
250
- def get_notice_finance_details(id, companyId) path = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails"
251
- get(path) end
252
-
253
- # Retrieve notice responsibilities for a specific notice.
254
- #
255
- # This API is available by invitation only.
256
- # 'Notice responsibilities' are are those who are responsible for the notice.
257
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
258
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
259
- #
260
- # ### Security Policies
261
- #
262
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
263
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
264
- # @param id [Integer] The ID of the notice.
265
- # @param companyId [Integer] The ID of the company that owns these notices.
266
- # @return [FetchResult]
267
- def get_notice_responsibilities(id, companyId) path = "/api/v2/companies/#{companyId}/notices/#{id}/responsibilities"
268
- get(path) end
269
-
270
- # Retrieve notice root causes for a specific notice.
271
- #
272
- # This API is available by invitation only.
273
- # 'Notice root causes' are are those who are responsible for the notice.
274
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
275
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
276
- #
277
- # ### Security Policies
278
- #
279
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
280
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
281
- # @param id [Integer] The ID of the notice.
282
- # @param companyId [Integer] The ID of the company that owns these notices.
283
- # @return [FetchResult]
284
- def get_notice_root_causes(id, companyId) path = "/api/v2/companies/#{companyId}/notices/#{id}/rootcauses"
285
- get(path) end
286
-
287
- # Retrieve notices for a company.
288
- #
289
- # This API is available by invitation only.
290
- # List all tax notice objects assigned to this company.
291
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
292
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
293
- #
294
- # 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/) .
295
- # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
296
- #
297
- # ### Security Policies
298
- #
299
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
300
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
301
- # @param companyId [Integer] The ID of the company that owns these notices.
302
- # @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:* status, totalRemit, ticketReferenceNo, ticketReferenceUrl, reason, type, createdByUserName, documentReference, jurisdictionName, jurisdictionType, comments, finances, responsibility, rootCause
303
- # @param include [String] A comma separated list of additional data to retrieve.
304
- # @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.
305
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
306
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
307
- # @return [FetchResult]
308
- def list_notices_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/notices"
309
- get(path, options) end
310
-
311
- # Retrieve all notices.
312
- #
313
- # This API is available by invitation only.
314
- #
315
- # This API is deprecated - please use POST `/api/v2/notices/query` API.
316
- #
317
- # Get multiple notice objects across all companies.
318
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
319
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
320
- #
321
- # 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/) .
322
- # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
323
- #
324
- # ### Security Policies
325
- #
326
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
327
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
328
- # @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:* status, totalRemit, ticketReferenceNo, ticketReferenceUrl, reason, type, createdByUserName, documentReference, jurisdictionName, jurisdictionType, comments, finances, responsibility, rootCause
329
- # @param include [String] A comma separated list of additional data to retrieve.
330
- # @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.
331
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
332
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
333
- # @return [FetchResult]
334
- def query_notices(options={}) path = "/api/v2/notices"
335
- get(path, options) end
336
-
337
- # Retrieve all notices.
338
- #
339
- # This API is available by invitation only.
340
- #
341
- # This API is intended to replace the GET `/api/v2/notices` API. The fetch request object is posted on the body of the request instead of the URI, so it's not limited by a set number of characters.
342
- # The documentation of the GET API shows how filtering, sorting and pagination works.
343
- #
344
- # ### Security Policies
345
- #
346
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
347
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
348
- # @param model [Object] Query object to filter, sort and paginate the filing calendars.
349
- # @return [FetchResult]
350
- def query_notices_post(model) path = "/api/v2/notices/query"
351
- post(path, model) end
352
-
353
- # Update a single notice finance detail.
354
- #
355
- # This API is available by invitation only.
356
- # All data from the existing object will be replaced with data in the object you PUT.
357
- # 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.
358
- #
359
- # ### Security Policies
360
- #
361
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
362
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
363
- # @param companyId [Integer] The ID of the company that this notice finance detail belongs to.
364
- # @param noticeid [Integer] The ID of the notice finance detail you wish to update.
365
- # @param financeDetailsId [Integer] The ID of the finance detail you wish to delete.
366
- # @param model [Object] The notice finance detail object you wish to update.
367
- # @return [Object]
368
- def update_finance_details(companyId, noticeid, financeDetailsId, model) path = "/api/v2/companies/#{companyId}/notices/#{noticeid}/financedetails/#{financedetailsid}"
369
- put(path, model) end
370
-
371
- # Update a single notice.
372
- #
373
- # This API is available by invitation only.
374
- # Replace the existing notice object at this URL with an updated object.
375
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
376
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
377
- # All data from the existing object will be replaced with data in the object you PUT.
378
- # 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.
379
- #
380
- # ### Security Policies
381
- #
382
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
383
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
384
- # @param companyId [Integer] The ID of the company that this notice belongs to.
385
- # @param id [Integer] The ID of the notice you wish to update.
386
- # @param model [Object] The notice object you wish to update.
387
- # @return [Object]
388
- def update_notice(companyId, id, model) path = "/api/v2/companies/#{companyId}/notices/#{id}"
389
- put(path, model) end
390
-
391
- # Update a single notice comment.
392
- #
393
- # This API is available by invitation only.
394
- # All data from the existing object will be replaced with data in the object you PUT.
395
- # 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.
396
- #
397
- # ### Security Policies
398
- #
399
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
400
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
401
- # @param companyId [Integer] The ID of the company that this notice comment belongs to.
402
- # @param noticeid [Integer] The ID of the notice you wish to update.
403
- # @param commentDetailsId [Integer] The ID of the comment you wish to update.
404
- # @param model [Object] The notice comment object you wish to update.
405
- # @return [Object]
406
- def update_notice_comments(companyId, noticeid, commentDetailsId, model) path = "/api/v2/companies/#{companyId}/notices/#{noticeid}/commentdetails/#{commentdetailsid}"
407
- put(path, model) end
408
-
409
- # Upload a new notice attachment.
410
- #
411
- # This API is available by invitation only.
412
- #
413
- # Uploads a file attachment for a tax notice.
414
- #
415
- # ### Security Policies
416
- #
417
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
418
- # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
419
- # @param companyId [Integer] The ID of the company for this attachment.
420
- # @param model [Object] The upload request.
421
- # @return [Object]
422
- def upload_attachment(companyId, model) path = "/api/v2/companies/#{companyId}/notices/files/attachment"
423
- post(path, model) end
424
55
  end
425
56
  end
426
57
  end
@@ -18,7 +18,7 @@ module AvaTax
18
18
  # * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
19
19
  # * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
20
20
  #
21
- # This API works for all report types.
21
+ # * We throttle this API. You can only call this API up to 5 times in a minute.
22
22
  #
23
23
  # ### Security Policies
24
24
  #
@@ -16,6 +16,11 @@ module AvaTax
16
16
  # When creating this object, you may define your own `set`, `name`, and `value` parameters.
17
17
  # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
18
18
  #
19
+ # Use Set = Transactions, Name = TaxCodePrioritization/HSCodePrioritization and Value = Transaction/ItemMaster for prioritizing which TaxCodes/HsCodes should be used for calculating taxes.
20
+ #
21
+ # Example: To prioritize TaxCodes passed in a Transaction over values stored with Items when calculating tax, use
22
+ # Set = Transactions, Name = TaxCodePrioritization, Value = Transaction
23
+ #
19
24
  # ### Security Policies
20
25
  #
21
26
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
@@ -89,7 +94,7 @@ module AvaTax
89
94
  #
90
95
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
91
96
  # @param companyId [Integer] The ID of the company that owns these settings
92
- # @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/).
97
+ # @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:* modifiedDate, ModifiedUserId
93
98
  # @param include [String] A comma separated list of additional data to retrieve.
94
99
  # @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.
95
100
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -117,7 +122,7 @@ module AvaTax
117
122
  # ### Security Policies
118
123
  #
119
124
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
120
- # @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/).
125
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* modifiedDate, ModifiedUserId
121
126
  # @param include [String] A comma separated list of additional data to retrieve.
122
127
  # @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.
123
128
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -524,7 +524,7 @@ module AvaTax
524
524
  # @param companyCode [String] The company code of the company that recorded this transaction
525
525
  # @param dataSourceId [Integer] Optionally filter transactions to those from a specific data source.
526
526
  # @param include [String] Specifies objects to include in this fetch call
527
- # @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:* exchangeRateCurrencyCode, totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, messages, invoiceMessages, isFakeTransaction
527
+ # @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:* exchangeRateCurrencyCode, totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, userDefinedFields, messages, invoiceMessages, isFakeTransaction, deliveryTerms
528
528
  # @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.
529
529
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
530
530
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -126,7 +126,7 @@ module AvaTax
126
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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
127
127
  # @param accountId [Integer] The accountID of the user you wish to list.
128
128
  # @param include [String] Optional fetch commands.
129
- # @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/).
129
+ # @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:* SuppressNewUserEmail
130
130
  # @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.
131
131
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
132
132
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -155,7 +155,7 @@ module AvaTax
155
155
  #
156
156
  # * 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
157
157
  # @param include [String] Optional fetch commands.
158
- # @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/).
158
+ # @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:* SuppressNewUserEmail
159
159
  # @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.
160
160
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
161
161
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -1,3 +1,3 @@
1
1
  module AvaTax
2
- VERSION = '21.3.1'.freeze unless defined?(::AvaTax::VERSION)
2
+ VERSION = '21.6.0'.freeze unless defined?(::AvaTax::VERSION)
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: avatax
3
3
  version: !ruby/object:Gem::Version
4
- version: 21.3.1
4
+ version: 21.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Marcus Vorwaller
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-04-01 00:00:00.000000000 Z
11
+ date: 2021-06-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rake