avatax 21.9.0 → 22.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (75) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +55 -55
  3. data/.rspec +1 -1
  4. data/.travis.yml +18 -18
  5. data/.vs/VSWorkspaceState.json +5 -5
  6. data/.yardopts +4 -4
  7. data/Gemfile +2 -2
  8. data/LICENSE +201 -201
  9. data/README.md +98 -98
  10. data/Rakefile +9 -9
  11. data/avatax.gemspec +38 -38
  12. data/example/avatax.rb +47 -47
  13. data/example/credentials.example.yaml +5 -5
  14. data/lib/avatax/api.rb +27 -27
  15. data/lib/avatax/client/accounts.rb +22 -11
  16. data/lib/avatax/client/addresses.rb +4 -2
  17. data/lib/avatax/client/advancedrules.rb +10 -5
  18. data/lib/avatax/client/ageverification.rb +29 -0
  19. data/lib/avatax/client/avafileforms.rb +10 -5
  20. data/lib/avatax/client/batches.rb +16 -8
  21. data/lib/avatax/client/certexpressinvites.rb +6 -3
  22. data/lib/avatax/client/certificates.rb +30 -15
  23. data/lib/avatax/client/companies.rb +61 -21
  24. data/lib/avatax/client/compliance.rb +25 -14
  25. data/lib/avatax/client/contacts.rb +12 -6
  26. data/lib/avatax/client/customers.rb +26 -13
  27. data/lib/avatax/client/datasources.rb +12 -6
  28. data/lib/avatax/client/definitions.rb +140 -70
  29. data/lib/avatax/client/distancethresholds.rb +12 -6
  30. data/lib/avatax/client/ecms.rb +73 -73
  31. data/lib/avatax/client/ecommercetoken.rb +4 -2
  32. data/lib/avatax/client/errortransactions.rb +61 -61
  33. data/lib/avatax/client/filingcalendars.rb +9 -4
  34. data/lib/avatax/client/filings.rb +6 -2
  35. data/lib/avatax/client/firmclientlinkages.rb +18 -9
  36. data/lib/avatax/client/free.rb +2 -1
  37. data/lib/avatax/client/fundingrequests.rb +4 -2
  38. data/lib/avatax/client/items.rb +50 -25
  39. data/lib/avatax/client/jurisdictionoverrides.rb +12 -6
  40. data/lib/avatax/client/locations.rb +24 -12
  41. data/lib/avatax/client/multidocument.rb +20 -10
  42. data/lib/avatax/client/nexus.rb +30 -15
  43. data/lib/avatax/client/notices.rb +8 -4
  44. data/lib/avatax/client/notifications.rb +6 -3
  45. data/lib/avatax/client/onboarding.rb +55 -55
  46. data/lib/avatax/client/pointofsale.rb +21 -21
  47. data/lib/avatax/client/provisioning.rb +4 -2
  48. data/lib/avatax/client/registrar.rb +22 -11
  49. data/lib/avatax/client/reports.rb +8 -4
  50. data/lib/avatax/client/settings.rb +12 -6
  51. data/lib/avatax/client/shippingverification.rb +66 -0
  52. data/lib/avatax/client/subscriptions.rb +6 -3
  53. data/lib/avatax/client/taxcodes.rb +12 -6
  54. data/lib/avatax/client/taxcontent.rb +10 -5
  55. data/lib/avatax/client/taxprofiles.rb +42 -42
  56. data/lib/avatax/client/taxrules.rb +12 -6
  57. data/lib/avatax/client/transactions.rb +42 -21
  58. data/lib/avatax/client/upcs.rb +12 -6
  59. data/lib/avatax/client/userdefinedfields.rb +52 -0
  60. data/lib/avatax/client/users.rb +16 -8
  61. data/lib/avatax/client/utilities.rb +6 -3
  62. data/lib/avatax/client.rb +37 -35
  63. data/lib/avatax/configuration.rb +76 -76
  64. data/lib/avatax/connection.rb +49 -49
  65. data/lib/avatax/request.rb +51 -42
  66. data/lib/avatax/version.rb +3 -3
  67. data/lib/avatax.rb +26 -26
  68. data/spec/avatax/client/accounts_spec.rb +13 -13
  69. data/spec/avatax/client/transactions_spec.rb +80 -80
  70. data/spec/avatax/request_spec.rb +25 -25
  71. data/spec/avatax_spec.rb +45 -45
  72. data/spec/credentials.yaml.example +4 -4
  73. data/spec/fixtures/accounts.json +15 -15
  74. data/spec/spec_helper.rb +27 -27
  75. metadata +9 -13
@@ -14,11 +14,12 @@ module AvaTax
14
14
  # ### Security Policies
15
15
  #
16
16
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
17
+ # Swagger Name: AvaTaxClient
17
18
  # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold
18
19
  # @param model [CompanyDistanceThresholdModel[]] The DistanceThreshold object or objects you wish to create.
19
20
  # @return [CompanyDistanceThresholdModel[]]
20
21
  def create_distance_threshold(companyId, model) path = "/api/v2/companies/#{companyId}/distancethresholds"
21
- post(path, model) end
22
+ post(path, model, {}, "22.2.0") end
22
23
 
23
24
  # Delete a single DistanceThreshold object
24
25
  #
@@ -31,11 +32,12 @@ module AvaTax
31
32
  # ### Security Policies
32
33
  #
33
34
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
35
+ # Swagger Name: AvaTaxClient
34
36
  # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold
35
37
  # @param id [Integer] The unique ID number of the DistanceThreshold object you wish to delete.
36
38
  # @return [ErrorDetail[]]
37
39
  def delete_distance_threshold(companyId, id) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
38
- delete(path) end
40
+ delete(path, {}, "22.2.0") end
39
41
 
40
42
  # Retrieve a single DistanceThreshold
41
43
  #
@@ -48,11 +50,12 @@ module AvaTax
48
50
  # ### Security Policies
49
51
  #
50
52
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
53
+ # Swagger Name: AvaTaxClient
51
54
  # @param companyId [Integer] The ID of the company that owns this DistanceThreshold object
52
55
  # @param id [Integer] The unique ID number referring to this DistanceThreshold object
53
56
  # @return [Object]
54
57
  def get_distance_threshold(companyId, id) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
55
- get(path) end
58
+ get(path, {}, "22.2.0") end
56
59
 
57
60
  # Retrieve all DistanceThresholds for this company.
58
61
  #
@@ -65,6 +68,7 @@ module AvaTax
65
68
  # ### Security Policies
66
69
  #
67
70
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
71
+ # Swagger Name: AvaTaxClient
68
72
  # @param companyId [Integer] The ID of the company whose DistanceThreshold objects you wish to list.
69
73
  # @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/).
70
74
  # @param include [String] A comma separated list of additional data to retrieve.
@@ -73,7 +77,7 @@ module AvaTax
73
77
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
74
78
  # @return [FetchResult]
75
79
  def list_distance_thresholds(companyId, options={}) path = "/api/v2/companies/#{companyId}/distancethresholds"
76
- get(path, options) end
80
+ get(path, options, "22.2.0") end
77
81
 
78
82
  # Retrieve all DistanceThreshold objects
79
83
  #
@@ -89,6 +93,7 @@ module AvaTax
89
93
  # ### Security Policies
90
94
  #
91
95
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
96
+ # Swagger Name: AvaTaxClient
92
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/).
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.
@@ -96,7 +101,7 @@ module AvaTax
96
101
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
97
102
  # @return [FetchResult]
98
103
  def query_distance_thresholds(options={}) path = "/api/v2/distancethresholds"
99
- get(path, options) end
104
+ get(path, options, "22.2.0") end
100
105
 
101
106
  # Update a DistanceThreshold object
102
107
  #
@@ -112,12 +117,13 @@ module AvaTax
112
117
  # ### Security Policies
113
118
  #
114
119
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
120
+ # Swagger Name: AvaTaxClient
115
121
  # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold object.
116
122
  # @param id [Integer] The unique ID number of the DistanceThreshold object to replace.
117
123
  # @param model [Object] The new DistanceThreshold object to store.
118
124
  # @return [Object]
119
125
  def update_distance_threshold(companyId, id, model) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
120
- put(path, model) end
126
+ put(path, model, {}, "22.2.0") end
121
127
  end
122
128
  end
123
129
  end
@@ -1,74 +1,74 @@
1
- module AvaTax
2
- class Client
3
- module Ecms
4
-
5
-
6
- # Get an ECMS identified by company id and ECMS id
7
- #
8
- # Get an ECMS identified by company id and ECMS id.
9
- # An ECMS data represents a documentation based on which companies can claim tax exemption
10
- # You may attach nested data objects such as exempt cert detail, and those objects will be created with certificate.
11
- # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
12
- #
13
- # * Details
14
- #
15
- # ### Security Policies
16
- #
17
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
18
- # * This API depends on the following active services<br />*Required* (all): AvaCert.
19
- # @param companyId [Integer] company to retrieve exempt certificate for
20
- # @param ecmsId [Integer] exempt certificate Id
21
- # @param include [String]
22
- # @return [Object]
23
- def get_e_c_m_s_by_id(companyId, ecmsId, options={}) path = "/api/v2/companies/#{companyId}/ecms/#{ecmsId}"
24
- get(path, options) end
25
-
26
- # Get list of ECMS data for this company
27
- #
28
- # Get list of ECMS data for this company
29
- # An ECMS data represents a documentation based on which companies can claim tax exemption
30
- # You may attach nested data objects such as ECMS detail, and those objects will be created with certificate.
31
- # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
32
- #
33
- # * Details
34
- #
35
- # ### Security Policies
36
- #
37
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
38
- # * This API depends on the following active services<br />*Required* (all): AvaCert.
39
- # @param companyId [Integer] which company to retrieve certificates from
40
- # @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:* details
41
- # @param include [String]
42
- # @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.
43
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
44
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
45
- # @return [FetchResult]
46
- def list_e_c_m_s_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/ecms"
47
- get(path, options) end
48
-
49
- # Get all exempt certificates
50
- #
51
- # Get all ECMS currently available in database.
52
- # An ECMS data represents a documentation based on which companies can claim tax exemption
53
- # You may attach nested data objects such as ECMS detail, and those objects will be created with certificate.
54
- # 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/) .
55
- # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
56
- # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
57
- #
58
- # * Details
59
- #
60
- # ### Security Policies
61
- #
62
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
63
- # * This API depends on the following active services<br />*Required* (all): AvaCert.
64
- # @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:* details
65
- # @param include [String]
66
- # @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.
67
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
68
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
69
- # @return [FetchResult]
70
- def query_e_c_m_s(options={}) path = "/api/v2/ecms"
71
- get(path, options) end
72
- end
73
- end
1
+ module AvaTax
2
+ class Client
3
+ module Ecms
4
+
5
+
6
+ # Get an ECMS identified by company id and ECMS id
7
+ #
8
+ # Get an ECMS identified by company id and ECMS id.
9
+ # An ECMS data represents a documentation based on which companies can claim tax exemption
10
+ # You may attach nested data objects such as exempt cert detail, and those objects will be created with certificate.
11
+ # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
12
+ #
13
+ # * Details
14
+ #
15
+ # ### Security Policies
16
+ #
17
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
18
+ # * This API depends on the following active services<br />*Required* (all): AvaCert.
19
+ # @param companyId [Integer] company to retrieve exempt certificate for
20
+ # @param ecmsId [Integer] exempt certificate Id
21
+ # @param include [String]
22
+ # @return [Object]
23
+ def get_e_c_m_s_by_id(companyId, ecmsId, options={}) path = "/api/v2/companies/#{companyId}/ecms/#{ecmsId}"
24
+ get(path, options) end
25
+
26
+ # Get list of ECMS data for this company
27
+ #
28
+ # Get list of ECMS data for this company
29
+ # An ECMS data represents a documentation based on which companies can claim tax exemption
30
+ # You may attach nested data objects such as ECMS detail, and those objects will be created with certificate.
31
+ # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
32
+ #
33
+ # * Details
34
+ #
35
+ # ### Security Policies
36
+ #
37
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
38
+ # * This API depends on the following active services<br />*Required* (all): AvaCert.
39
+ # @param companyId [Integer] which company to retrieve certificates from
40
+ # @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:* details
41
+ # @param include [String]
42
+ # @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.
43
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
44
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
45
+ # @return [FetchResult]
46
+ def list_e_c_m_s_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/ecms"
47
+ get(path, options) end
48
+
49
+ # Get all exempt certificates
50
+ #
51
+ # Get all ECMS currently available in database.
52
+ # An ECMS data represents a documentation based on which companies can claim tax exemption
53
+ # You may attach nested data objects such as ECMS detail, and those objects will be created with certificate.
54
+ # 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/) .
55
+ # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
56
+ # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
57
+ #
58
+ # * Details
59
+ #
60
+ # ### Security Policies
61
+ #
62
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
63
+ # * This API depends on the following active services<br />*Required* (all): AvaCert.
64
+ # @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:* details
65
+ # @param include [String]
66
+ # @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.
67
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
68
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
69
+ # @return [FetchResult]
70
+ def query_e_c_m_s(options={}) path = "/api/v2/ecms"
71
+ get(path, options) end
72
+ end
73
+ end
74
74
  end
@@ -12,11 +12,12 @@ module AvaTax
12
12
  # ### Security Policies
13
13
  #
14
14
  # * 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.
15
+ # Swagger Name: AvaTaxClient
15
16
  # @param companyId [Integer] The company ID that will be issued this certificate.
16
17
  # @param model [Object]
17
18
  # @return [Object]
18
19
  def create_e_commerce_token(companyId, model) path = "/api/v2/companies/#{companyId}/ecommercetokens"
19
- post(path, model) end
20
+ post(path, model, {}, "22.2.0") end
20
21
 
21
22
  # Refresh an eCommerce token.
22
23
  #
@@ -27,11 +28,12 @@ module AvaTax
27
28
  # ### Security Policies
28
29
  #
29
30
  # * 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.
31
+ # Swagger Name: AvaTaxClient
30
32
  # @param companyId [Integer] The company ID that the refreshed certificate belongs to.
31
33
  # @param model [Object]
32
34
  # @return [FetchResult]
33
35
  def refresh_e_commerce_token(companyId, model) path = "/api/v2/companies/#{companyId}/ecommercetokens"
34
- put(path, model) end
36
+ put(path, model, {}, "22.2.0") end
35
37
  end
36
38
  end
37
39
  end
@@ -1,62 +1,62 @@
1
- module AvaTax
2
- class Client
3
- module ErrorTransactions
4
-
5
-
6
- # Delete a batch of error transactions
7
- #
8
- # Delete a batch of error transactions attached to a company.
9
- #
10
- # If any of the provided error transaction isn't found then it'll be treated as a success.
11
- #
12
- # ### Security Policies
13
- #
14
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
15
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
16
- # @param companyId [Integer] ID number of the company to delete error transactions from.
17
- # @param model [Object] The request that contains error transactions to be deleted
18
- # @return [Object]
19
- def delete_error_transactions(companyId, model) path = "/api/v2/companies/#{companyId}/errortransactions"
20
- delete(path, model) end
21
-
22
- # Get a list of error transactions' error codes and its counts
23
- #
24
- # Get a list of error transactions' error codes and their counts
25
- # When you try to create or adjust a transaction with a datasource for a company and for any reason that call fails with an error,
26
- # those errors with their count can be retrieved by this API.
27
- #
28
- # ### Security Policies
29
- #
30
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
31
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
32
- # @param companyId [Integer] ID number of the company to query from.
33
- # @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.
34
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
35
- # @return [CappedFetchResult]
36
- def list_error_codes(companyId, options={}) path = "/api/v2/companies/#{companyId}/errortransactions/errorcodes"
37
- get(path, options) end
38
-
39
- # Retrieve list of error transactions
40
- #
41
- # List error transactions attached to this company. Results are dependent on `$filter` if provided.
42
- #
43
- # This endpoint is limited to returning 1000 error transactions at a time maximum.
44
- #
45
- # 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/) .
46
- # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
47
- #
48
- # ### Security Policies
49
- #
50
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
51
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
52
- # @param companyId [Integer] The company ID to filter error transactions on.
53
- # @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:* companyId, avataxErrorJson, avataxCreateTransactionJson, expiresAt
54
- # @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.
55
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
56
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
57
- # @return [CappedFetchResult]
58
- def list_error_transactions(companyId, options={}) path = "/api/v2/companies/#{companyId}/errortransactions"
59
- get(path, options) end
60
- end
61
- end
1
+ module AvaTax
2
+ class Client
3
+ module ErrorTransactions
4
+
5
+
6
+ # Delete a batch of error transactions
7
+ #
8
+ # Delete a batch of error transactions attached to a company.
9
+ #
10
+ # If any of the provided error transaction isn't found then it'll be treated as a success.
11
+ #
12
+ # ### Security Policies
13
+ #
14
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
15
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
16
+ # @param companyId [Integer] ID number of the company to delete error transactions from.
17
+ # @param model [Object] The request that contains error transactions to be deleted
18
+ # @return [Object]
19
+ def delete_error_transactions(companyId, model) path = "/api/v2/companies/#{companyId}/errortransactions"
20
+ delete(path, model) end
21
+
22
+ # Get a list of error transactions' error codes and its counts
23
+ #
24
+ # Get a list of error transactions' error codes and their counts
25
+ # When you try to create or adjust a transaction with a datasource for a company and for any reason that call fails with an error,
26
+ # those errors with their count can be retrieved by this API.
27
+ #
28
+ # ### Security Policies
29
+ #
30
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
31
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
32
+ # @param companyId [Integer] ID number of the company to query from.
33
+ # @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.
34
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
35
+ # @return [CappedFetchResult]
36
+ def list_error_codes(companyId, options={}) path = "/api/v2/companies/#{companyId}/errortransactions/errorcodes"
37
+ get(path, options) end
38
+
39
+ # Retrieve list of error transactions
40
+ #
41
+ # List error transactions attached to this company. Results are dependent on `$filter` if provided.
42
+ #
43
+ # This endpoint is limited to returning 1000 error transactions at a time maximum.
44
+ #
45
+ # 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/) .
46
+ # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
47
+ #
48
+ # ### Security Policies
49
+ #
50
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
51
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
52
+ # @param companyId [Integer] The company ID to filter error transactions on.
53
+ # @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:* companyId, avataxErrorJson, avataxCreateTransactionJson, expiresAt
54
+ # @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.
55
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
56
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
57
+ # @return [CappedFetchResult]
58
+ def list_error_transactions(companyId, options={}) path = "/api/v2/companies/#{companyId}/errortransactions"
59
+ get(path, options) end
60
+ end
61
+ end
62
62
  end
@@ -11,12 +11,14 @@ module AvaTax
11
11
  #
12
12
  # ### Security Policies
13
13
  #
14
+ # * This API requires openId bearer token for authentication
14
15
  # * 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.
16
+ # Swagger Name: AvaTaxClient
15
17
  # @param companyId [Integer] The unique ID of the company that owns the filing calendar object
16
18
  # @param model [Object] Cycle Safe Options Request
17
19
  # @return [Object]
18
20
  def cycle_safe_options(companyId, model) path = "/api/v2/companies/#{companyId}/filingcalendars/edit/cycleSafeOptions"
19
- post(path, model) end
21
+ post(path, model, {}, "22.2.0") end
20
22
 
21
23
  # Delete a company return setting
22
24
  #
@@ -24,13 +26,15 @@ module AvaTax
24
26
  #
25
27
  # ### Security Policies
26
28
  #
29
+ # * This API requires openId bearer token for authentication
27
30
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
31
+ # Swagger Name: AvaTaxClient
28
32
  # @param companyId [Integer] The unique ID of the company
29
33
  # @param filingCalendarId [Integer] The unique ID of the filing calendar that will remove setting
30
34
  # @param companyReturnSettingId [Integer] The unique ID of the company return setting that will be deleted from the filing calendar
31
35
  # @return [CompanyReturnSettingModel[]]
32
36
  def delete_company_return_settings(companyId, filingCalendarId, companyReturnSettingId) path = "/api/v2/companies/#{companyId}/filingcalendars/#{filingCalendarId}/setting/#{companyReturnSettingId}"
33
- delete(path) end
37
+ delete(path, {}, "22.2.0") end
34
38
 
35
39
  # Retrieve all legacy filing calendars for this company
36
40
  #
@@ -40,8 +44,9 @@ module AvaTax
40
44
  #
41
45
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
42
46
  # * 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.
47
+ # Swagger Name: AvaTaxClient
43
48
  # @param companyId [Integer] The ID of the company that owns these batches
44
- # @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:* taxAuthorityId, taxAuthorityName, taxAuthorityType, settings
49
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* taxTypes, taxAuthorityId, taxAuthorityName, taxAuthorityType, settings
45
50
  # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
46
51
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
47
52
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -49,7 +54,7 @@ module AvaTax
49
54
  # @param returnRegion [String] A comma separated list of regions
50
55
  # @return [FetchResult]
51
56
  def legacy_filing_calendars(companyId, options={}) path = "/api/v2/companies/#{companyId}/filingcalendars/Legacy"
52
- get(path, options) end
57
+ get(path, options, "22.2.0") end
53
58
  end
54
59
  end
55
60
  end
@@ -7,20 +7,24 @@ module AvaTax
7
7
  #
8
8
  # ### Security Policies
9
9
  #
10
+ # * This API requires openId bearer token for authentication
10
11
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
12
+ # Swagger Name: AvaTaxClient
11
13
  # @param companyId [Integer] The ID of the company that owns these returns
12
14
  # @param filingReturnId [Integer] The ID of the filing return
13
15
  # @return [FetchResult]
14
16
  def get_accrual_filings(companyId, filingReturnId) path = "/api/v2/companies/#{companyId}/filings/accrual/#{filingReturnId}"
15
- get(path) end
17
+ get(path, {}, "22.2.0") end
16
18
 
17
19
  # Retrieve a list of filed returns for the specified company in the year and month of a given filing period.
18
20
  #
19
21
  # ### Security Policies
20
22
  #
23
+ # * This API requires openId bearer token for authentication
21
24
  # * 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.
22
25
  # * This API is available by invitation only.*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser, CompanyUser, AccountUser, CompanyAdmin, AccountAdmin.
23
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
+ # Swagger Name: AvaTaxClient
24
28
  # @param companyId [Integer] The ID of the company that owns these batches
25
29
  # @param endPeriodMonth [Integer] The month of the period you are trying to retrieve
26
30
  # @param endPeriodYear [Integer] The year of the period you are trying to retrieve
@@ -32,7 +36,7 @@ module AvaTax
32
36
  # @param taxformCode [String] The unique tax form code of the form.
33
37
  # @return [FetchResult]
34
38
  def get_filed_returns(companyId, options={}) path = "/api/v2/companies/#{companyId}/filings/returns/filed"
35
- get(path, options) end
39
+ get(path, options, "22.2.0") end
36
40
  end
37
41
  end
38
42
  end
@@ -10,10 +10,11 @@ module AvaTax
10
10
  # ### Security Policies
11
11
  #
12
12
  # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
13
+ # Swagger Name: AvaTaxClient
13
14
  # @param id [Integer]
14
15
  # @return [Object]
15
16
  def approve_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/approve"
16
- post(path) end
17
+ post(path, {}, "22.2.0") end
17
18
 
18
19
  # Request a new FirmClient account and create an approved linkage to it
19
20
  #
@@ -31,10 +32,11 @@ module AvaTax
31
32
  # ### Security Policies
32
33
  #
33
34
  # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin.
35
+ # Swagger Name: AvaTaxClient
34
36
  # @param model [Object] Information about the account you wish to create.
35
37
  # @return [Object]
36
38
  def create_and_link_new_firm_client_account(model) path = "/api/v2/firmclientlinkages/createandlinkclient"
37
- post(path, model) end
39
+ post(path, model, {}, "22.2.0") end
38
40
 
39
41
  # Links a firm account with the client account
40
42
  #
@@ -43,10 +45,11 @@ module AvaTax
43
45
  # ### Security Policies
44
46
  #
45
47
  # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
48
+ # Swagger Name: AvaTaxClient
46
49
  # @param model [Object] FirmClientLinkageInputModel
47
50
  # @return [Object]
48
51
  def create_firm_client_linkage(model) path = "/api/v2/firmclientlinkages"
49
- post(path, model) end
52
+ post(path, model, {}, "22.2.0") end
50
53
 
51
54
  # Delete a linkage
52
55
  #
@@ -55,10 +58,11 @@ module AvaTax
55
58
  # ### Security Policies
56
59
  #
57
60
  # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
61
+ # Swagger Name: AvaTaxClient
58
62
  # @param id [Integer]
59
63
  # @return [ErrorDetail[]]
60
64
  def delete_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}"
61
- delete(path) end
65
+ delete(path, {}, "22.2.0") end
62
66
 
63
67
  # Get linkage between a firm and client by id
64
68
  #
@@ -67,10 +71,11 @@ module AvaTax
67
71
  # ### Security Policies
68
72
  #
69
73
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
74
+ # Swagger Name: AvaTaxClient
70
75
  # @param id [Integer]
71
76
  # @return [Object]
72
77
  def get_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}"
73
- get(path) end
78
+ get(path, {}, "22.2.0") end
74
79
 
75
80
  # List client linkages for a firm or client
76
81
  #
@@ -79,10 +84,11 @@ module AvaTax
79
84
  # ### Security Policies
80
85
  #
81
86
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
87
+ # Swagger Name: AvaTaxClient
82
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:* firmAccountName, clientAccountName
83
89
  # @return [FetchResult]
84
90
  def list_firm_client_linkage(options={}) path = "/api/v2/firmclientlinkages"
85
- get(path, options) end
91
+ get(path, options, "22.2.0") end
86
92
 
87
93
  # Rejects linkage to a firm for a client account
88
94
  #
@@ -91,10 +97,11 @@ module AvaTax
91
97
  # ### Security Policies
92
98
  #
93
99
  # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
100
+ # Swagger Name: AvaTaxClient
94
101
  # @param id [Integer]
95
102
  # @return [Object]
96
103
  def reject_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/reject"
97
- post(path) end
104
+ post(path, {}, "22.2.0") end
98
105
 
99
106
  # Reset linkage status between a client and firm back to requested
100
107
  #
@@ -103,10 +110,11 @@ module AvaTax
103
110
  # ### Security Policies
104
111
  #
105
112
  # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
113
+ # Swagger Name: AvaTaxClient
106
114
  # @param id [Integer]
107
115
  # @return [Object]
108
116
  def reset_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/reset"
109
- post(path) end
117
+ post(path, {}, "22.2.0") end
110
118
 
111
119
  # Revokes previously approved linkage to a firm for a client account
112
120
  #
@@ -115,10 +123,11 @@ module AvaTax
115
123
  # ### Security Policies
116
124
  #
117
125
  # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
126
+ # Swagger Name: AvaTaxClient
118
127
  # @param id [Integer]
119
128
  # @return [Object]
120
129
  def revoke_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/revoke"
121
- post(path) end
130
+ post(path, {}, "22.2.0") end
122
131
  end
123
132
  end
124
133
  end
@@ -19,10 +19,11 @@ module AvaTax
19
19
  # ### Security Policies
20
20
  #
21
21
  # * This API may be called without providing authentication credentials.
22
+ # Swagger Name: AvaTaxClient
22
23
  # @param model [Object] Required information to provision a free trial account.
23
24
  # @return [Object]
24
25
  def request_free_trial(model) path = "/api/v2/accounts/freetrials/request"
25
- post(path, model) end
26
+ post(path, model, {}, "22.2.0") end
26
27
  end
27
28
  end
28
29
  end