avatax 20.6.0 → 21.1.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (51) hide show
  1. checksums.yaml +4 -4
  2. data/.vs/slnx.sqlite +0 -0
  3. data/avatax.gemspec +0 -1
  4. data/lib/avatax/client/accounts.rb +22 -55
  5. data/lib/avatax/client/addresses.rb +7 -13
  6. data/lib/avatax/client/advancedrules.rb +10 -25
  7. data/lib/avatax/client/avafileforms.rb +15 -30
  8. data/lib/avatax/client/batches.rb +16 -40
  9. data/lib/avatax/client/certexpressinvites.rb +21 -30
  10. data/lib/avatax/client/certificates.rb +97 -142
  11. data/lib/avatax/client/companies.rb +137 -80
  12. data/lib/avatax/client/compliance.rb +2 -5
  13. data/lib/avatax/client/contacts.rb +12 -30
  14. data/lib/avatax/client/customers.rb +87 -126
  15. data/lib/avatax/client/datasources.rb +18 -36
  16. data/lib/avatax/client/definitions.rb +128 -303
  17. data/lib/avatax/client/distancethresholds.rb +12 -30
  18. data/lib/avatax/client/ecms.rb +26 -31
  19. data/lib/avatax/client/ecommercetoken.rb +37 -0
  20. data/lib/avatax/client/errortransactions.rb +27 -15
  21. data/lib/avatax/client/filingcalendars.rb +17 -5
  22. data/lib/avatax/client/filings.rb +15 -7
  23. data/lib/avatax/client/firmclientlinkages.rb +18 -45
  24. data/lib/avatax/client/free.rb +2 -84
  25. data/lib/avatax/client/fundingrequests.rb +6 -12
  26. data/lib/avatax/client/items.rb +38 -95
  27. data/lib/avatax/client/jurisdictionoverrides.rb +12 -30
  28. data/lib/avatax/client/locations.rb +128 -38
  29. data/lib/avatax/client/multidocument.rb +52 -62
  30. data/lib/avatax/client/nexus.rb +138 -37
  31. data/lib/avatax/client/notices.rb +47 -139
  32. data/lib/avatax/client/notifications.rb +6 -15
  33. data/lib/avatax/client/provisioning.rb +4 -10
  34. data/lib/avatax/client/registrar.rb +20 -50
  35. data/lib/avatax/client/reports.rb +17 -20
  36. data/lib/avatax/client/settings.rb +12 -30
  37. data/lib/avatax/client/subscriptions.rb +6 -15
  38. data/lib/avatax/client/taxcodes.rb +12 -30
  39. data/lib/avatax/client/taxcontent.rb +70 -16
  40. data/lib/avatax/client/taxprofiles.rb +14 -10
  41. data/lib/avatax/client/taxrules.rb +12 -30
  42. data/lib/avatax/client/transactions.rb +93 -126
  43. data/lib/avatax/client/upcs.rb +18 -36
  44. data/lib/avatax/client/users.rb +16 -40
  45. data/lib/avatax/client/utilities.rb +6 -15
  46. data/lib/avatax/configuration.rb +1 -1
  47. data/lib/avatax/connection.rb +2 -2
  48. data/lib/avatax/request.rb +0 -2
  49. data/lib/avatax/version.rb +1 -1
  50. data/spec/avatax/request_spec.rb +25 -0
  51. metadata +4 -16
@@ -17,11 +17,8 @@ module AvaTax
17
17
  # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold
18
18
  # @param model [CompanyDistanceThresholdModel[]] The DistanceThreshold object or objects you wish to create.
19
19
  # @return [CompanyDistanceThresholdModel[]]
20
- def create_distance_threshold(companyId, model)
21
- path = "/api/v2/companies/#{companyId}/distancethresholds"
22
- post(path, model)
23
- end
24
-
20
+ def create_distance_threshold(companyId, model) path = "/api/v2/companies/#{companyId}/distancethresholds"
21
+ post(path, model) end
25
22
 
26
23
  # Delete a single DistanceThreshold object
27
24
  #
@@ -37,11 +34,8 @@ module AvaTax
37
34
  # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold
38
35
  # @param id [Integer] The unique ID number of the DistanceThreshold object you wish to delete.
39
36
  # @return [ErrorDetail[]]
40
- def delete_distance_threshold(companyId, id)
41
- path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
42
- delete(path)
43
- end
44
-
37
+ def delete_distance_threshold(companyId, id) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
38
+ delete(path) end
45
39
 
46
40
  # Retrieve a single DistanceThreshold
47
41
  #
@@ -57,11 +51,8 @@ module AvaTax
57
51
  # @param companyId [Integer] The ID of the company that owns this DistanceThreshold object
58
52
  # @param id [Integer] The unique ID number referring to this DistanceThreshold object
59
53
  # @return [Object]
60
- def get_distance_threshold(companyId, id)
61
- path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
62
- get(path)
63
- end
64
-
54
+ def get_distance_threshold(companyId, id) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
55
+ get(path) end
65
56
 
66
57
  # Retrieve all DistanceThresholds for this company.
67
58
  #
@@ -81,11 +72,8 @@ module AvaTax
81
72
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
82
73
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
83
74
  # @return [FetchResult]
84
- def list_distance_thresholds(companyId, options={})
85
- path = "/api/v2/companies/#{companyId}/distancethresholds"
86
- get(path, options)
87
- end
88
-
75
+ def list_distance_thresholds(companyId, options={}) path = "/api/v2/companies/#{companyId}/distancethresholds"
76
+ get(path, options) end
89
77
 
90
78
  # Retrieve all DistanceThreshold objects
91
79
  #
@@ -107,11 +95,8 @@ module AvaTax
107
95
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
108
96
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
109
97
  # @return [FetchResult]
110
- def query_distance_thresholds(options={})
111
- path = "/api/v2/distancethresholds"
112
- get(path, options)
113
- end
114
-
98
+ def query_distance_thresholds(options={}) path = "/api/v2/distancethresholds"
99
+ get(path, options) end
115
100
 
116
101
  # Update a DistanceThreshold object
117
102
  #
@@ -131,11 +116,8 @@ module AvaTax
131
116
  # @param id [Integer] The unique ID number of the DistanceThreshold object to replace.
132
117
  # @param model [Object] The new DistanceThreshold object to store.
133
118
  # @return [Object]
134
- def update_distance_threshold(companyId, id, model)
135
- path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
136
- put(path, model)
137
- end
138
-
119
+ def update_distance_threshold(companyId, id, model) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
120
+ put(path, model) end
139
121
  end
140
122
  end
141
123
  end
@@ -1,17 +1,6 @@
1
1
  module AvaTax
2
2
  class Client
3
- module ECMS
4
-
5
-
6
- # Bridge API for integration of validated certificates
7
- #
8
- # This API is for use by invitation only.
9
- # @param model [EcmsModel[]] Either a single exempt certificate or an array of certificates to create
10
- # @return [EcmsModel[]]
11
- def cert_capture_bridge(model)
12
- path = "/api/v2/certcapturebridge"
13
- post(path, model)
14
- end
3
+ module Ecms
15
4
 
16
5
 
17
6
  # Get an ECMS identified by company id and ECMS id
@@ -22,15 +11,17 @@ module AvaTax
22
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:
23
12
  #
24
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.
25
19
  # @param companyId [Integer] company to retrieve exempt certificate for
26
20
  # @param ecmsId [Integer] exempt certificate Id
27
21
  # @param include [String]
28
22
  # @return [Object]
29
- def get_e_c_m_s_by_id(companyId, ecmsId, options={})
30
- path = "/api/v2/companies/#{companyId}/ecms/#{ecmsId}"
31
- get(path, options)
32
- end
33
-
23
+ def get_e_c_m_s_by_id(companyId, ecmsId, options={}) path = "/api/v2/companies/#{companyId}/ecms/#{ecmsId}"
24
+ get(path, options) end
34
25
 
35
26
  # Get list of ECMS data for this company
36
27
  #
@@ -40,18 +31,20 @@ module AvaTax
40
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:
41
32
  #
42
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.
43
39
  # @param companyId [Integer] which company to retrieve certificates from
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/).
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
45
41
  # @param include [String]
46
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.
47
43
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
48
44
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
49
- # @return [EcmsModel[]]
50
- def list_e_c_m_s_by_company(companyId, options={})
51
- path = "/api/v2/companies/#{companyId}/ecms"
52
- get(path, options)
53
- end
54
-
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
55
48
 
56
49
  # Get all exempt certificates
57
50
  #
@@ -63,17 +56,19 @@ module AvaTax
63
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:
64
57
  #
65
58
  # * Details
66
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
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
67
65
  # @param include [String]
68
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.
69
67
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
70
68
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
71
- # @return [EcmsModel[]]
72
- def query_e_c_m_s(options={})
73
- path = "/api/v2/ecms"
74
- get(path, options)
75
- end
76
-
69
+ # @return [FetchResult]
70
+ def query_e_c_m_s(options={}) path = "/api/v2/ecms"
71
+ get(path, options) end
77
72
  end
78
73
  end
79
74
  end
@@ -0,0 +1,37 @@
1
+ module AvaTax
2
+ class Client
3
+ module ECommerceToken
4
+
5
+
6
+ # Create a new eCommerce token.
7
+ #
8
+ # Creates a new eCommerce token.
9
+ #
10
+ # This API is used to create a new eCommerce token. An eCommerce token is required in order to launch the CertCapture eCommerce plugin. Create a token for each of your CertCapture customers.
11
+ #
12
+ # ### Security Policies
13
+ #
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
+ # @param companyId [Integer] The company ID that will be issued this certificate.
16
+ # @param model [Object]
17
+ # @return [Object]
18
+ def create_e_commerce_token(companyId, model) path = "/api/v2/companies/#{companyId}/ecommercetokens"
19
+ post(path, model) end
20
+
21
+ # Refresh an eCommerce token.
22
+ #
23
+ # Refresh an eCommerce token.
24
+ #
25
+ # CertCapture eCommerce tokens expire after one hour. This API is used to refresh an eCommerce token that is about to expire. This API can only be used with active tokens. If your token has expired, you must generate a new one.
26
+ #
27
+ # ### Security Policies
28
+ #
29
+ # * 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.
30
+ # @param companyId [Integer] The company ID that the refreshed certificate belongs to.
31
+ # @param model [Object]
32
+ # @return [FetchResult]
33
+ def refresh_e_commerce_token(companyId, model) path = "/api/v2/companies/#{companyId}/ecommercetokens"
34
+ put(path, model) end
35
+ end
36
+ end
37
+ end
@@ -12,20 +12,35 @@ module AvaTax
12
12
  # ### Security Policies
13
13
  #
14
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.
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.
16
17
  # @param model [Object] The request that contains error transactions to be deleted
17
18
  # @return [Object]
18
- def delete_error_transactions(model)
19
- path = "/api/v2/errortransactions"
20
- delete(path, model)
21
- end
19
+ def delete_error_transactions(companyId, model) path = "/api/v2/companies/#{companyId}/errortransactions"
20
+ delete(path, model) end
22
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
23
38
 
24
39
  # Retrieve list of error transactions
25
40
  #
26
41
  # List error transactions attached to this company. Results are dependent on `$filter` if provided.
27
42
  #
28
- # This endpoint is limited to returning 250 error transactions at a time maximum.
43
+ # This endpoint is limited to returning 1000 error transactions at a time maximum.
29
44
  #
30
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/) .
31
46
  # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
@@ -33,18 +48,15 @@ module AvaTax
33
48
  # ### Security Policies
34
49
  #
35
50
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
36
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
37
- # @param companyCode [String] The company code to filter on. This query parameter is required.
38
- # @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
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
39
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.
40
55
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
41
56
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
42
- # @return [FetchResult]
43
- def list_error_transactions(options={})
44
- path = "/api/v2/errortransactions"
45
- get(path, options)
46
- end
47
-
57
+ # @return [CappedFetchResult]
58
+ def list_error_transactions(companyId, options={}) path = "/api/v2/companies/#{companyId}/errortransactions"
59
+ get(path, options) end
48
60
  end
49
61
  end
50
62
  end
@@ -3,6 +3,21 @@ module AvaTax
3
3
  module FilingCalendars
4
4
 
5
5
 
6
+ # Add or Edit options
7
+ #
8
+ # Returns a list of options for adding tax forms for the company and tax form code specified.
9
+ # Returns edit options when modifying a filing calendar.
10
+ # This API is available by invitation only.
11
+ #
12
+ # ### Security Policies
13
+ #
14
+ # * 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.
15
+ # @param companyId [Integer] The unique ID of the company that owns the filing calendar object
16
+ # @param model [Object] Cycle Safe Options Request
17
+ # @return [Object]
18
+ def cycle_safe_options(companyId, model) path = "/api/v2/companies/#{companyId}/filingcalendars/edit/cycleSafeOptions"
19
+ post(path, model) end
20
+
6
21
  # Delete a company return setting
7
22
  #
8
23
  # This API is available by invitation only and only available for users with Compliance access
@@ -14,11 +29,8 @@ module AvaTax
14
29
  # @param filingCalendarId [Integer] The unique ID of the filing calendar that will remove setting
15
30
  # @param companyReturnSettingId [Integer] The unique ID of the company return setting that will be deleted from the filing calendar
16
31
  # @return [CompanyReturnSettingModel[]]
17
- def delete_company_return_settings(companyId, filingCalendarId, companyReturnSettingId)
18
- path = "/api/v2/companies/#{companyId}/filingcalendars/#{filingCalendarId}/setting/#{companyReturnSettingId}"
19
- delete(path)
20
- end
21
-
32
+ def delete_company_return_settings(companyId, filingCalendarId, companyReturnSettingId) path = "/api/v2/companies/#{companyId}/filingcalendars/#{filingCalendarId}/setting/#{companyReturnSettingId}"
33
+ delete(path) end
22
34
  end
23
35
  end
24
36
  end
@@ -3,13 +3,24 @@ module AvaTax
3
3
  module Filings
4
4
 
5
5
 
6
+ # Retrieve a filing containing the return and all its accrual returns.
7
+ #
8
+ # ### Security Policies
9
+ #
10
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
11
+ # @param companyId [Integer] The ID of the company that owns these returns
12
+ # @param filingReturnId [Integer] The ID of the filing return
13
+ # @return [FetchResult]
14
+ def get_accrual_filings(companyId, filingReturnId) path = "/api/v2/companies/#{companyId}/filings/accrual/#{filingReturnId}"
15
+ get(path) end
16
+
6
17
  # Retrieve a list of filed returns for the specified company in the year and month of a given filing period.
7
18
  #
8
19
  # ### Security Policies
9
20
  #
10
21
  # * 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.
11
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser, CompanyUser, AccountUser, CompanyAdmin, AccountAdmin.
12
- # * 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.
22
+ # * This API is available by invitation only.*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser, CompanyUser, AccountUser, CompanyAdmin, AccountAdmin.
23
+ # * 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.
13
24
  # @param companyId [Integer] The ID of the company that owns these batches
14
25
  # @param endPeriodMonth [Integer] The month of the period you are trying to retrieve
15
26
  # @param endPeriodYear [Integer] The year of the period you are trying to retrieve
@@ -20,11 +31,8 @@ module AvaTax
20
31
  # @param filingCalendarId [Integer] The filing calendar id of the return you are trying to retrieve
21
32
  # @param taxformCode [String] The unique tax form code of the form.
22
33
  # @return [FetchResult]
23
- def get_filed_returns(companyId, options={})
24
- path = "/api/v2/companies/#{companyId}/filings/returns/filed"
25
- get(path, options)
26
- end
27
-
34
+ def get_filed_returns(companyId, options={}) path = "/api/v2/companies/#{companyId}/filings/returns/filed"
35
+ get(path, options) end
28
36
  end
29
37
  end
30
38
  end
@@ -12,11 +12,8 @@ module AvaTax
12
12
  # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
13
13
  # @param id [Integer]
14
14
  # @return [Object]
15
- def approve_firm_client_linkage(id)
16
- path = "/api/v2/firmclientlinkages/#{id}/approve"
17
- post(path)
18
- end
19
-
15
+ def approve_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/approve"
16
+ post(path) end
20
17
 
21
18
  # Request a new FirmClient account and create an approved linkage to it
22
19
  #
@@ -36,11 +33,8 @@ module AvaTax
36
33
  # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin.
37
34
  # @param model [Object] Information about the account you wish to create.
38
35
  # @return [Object]
39
- def create_and_link_new_firm_client_account(model)
40
- path = "/api/v2/firmclientlinkages/createandlinkclient"
41
- post(path, model)
42
- end
43
-
36
+ def create_and_link_new_firm_client_account(model) path = "/api/v2/firmclientlinkages/createandlinkclient"
37
+ post(path, model) end
44
38
 
45
39
  # Links a firm account with the client account
46
40
  #
@@ -51,11 +45,8 @@ module AvaTax
51
45
  # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
52
46
  # @param model [Object] FirmClientLinkageInputModel
53
47
  # @return [Object]
54
- def create_firm_client_linkage(model)
55
- path = "/api/v2/firmclientlinkages"
56
- post(path, model)
57
- end
58
-
48
+ def create_firm_client_linkage(model) path = "/api/v2/firmclientlinkages"
49
+ post(path, model) end
59
50
 
60
51
  # Delete a linkage
61
52
  #
@@ -66,11 +57,8 @@ module AvaTax
66
57
  # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
67
58
  # @param id [Integer]
68
59
  # @return [ErrorDetail[]]
69
- def delete_firm_client_linkage(id)
70
- path = "/api/v2/firmclientlinkages/#{id}"
71
- delete(path)
72
- end
73
-
60
+ def delete_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}"
61
+ delete(path) end
74
62
 
75
63
  # Get linkage between a firm and client by id
76
64
  #
@@ -81,11 +69,8 @@ module AvaTax
81
69
  # * 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.
82
70
  # @param id [Integer]
83
71
  # @return [Object]
84
- def get_firm_client_linkage(id)
85
- path = "/api/v2/firmclientlinkages/#{id}"
86
- get(path)
87
- end
88
-
72
+ def get_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}"
73
+ get(path) end
89
74
 
90
75
  # List client linkages for a firm or client
91
76
  #
@@ -96,11 +81,8 @@ module AvaTax
96
81
  # * 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.
97
82
  # @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
98
83
  # @return [FetchResult]
99
- def list_firm_client_linkage(options={})
100
- path = "/api/v2/firmclientlinkages"
101
- get(path, options)
102
- end
103
-
84
+ def list_firm_client_linkage(options={}) path = "/api/v2/firmclientlinkages"
85
+ get(path, options) end
104
86
 
105
87
  # Rejects linkage to a firm for a client account
106
88
  #
@@ -111,11 +93,8 @@ module AvaTax
111
93
  # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
112
94
  # @param id [Integer]
113
95
  # @return [Object]
114
- def reject_firm_client_linkage(id)
115
- path = "/api/v2/firmclientlinkages/#{id}/reject"
116
- post(path)
117
- end
118
-
96
+ def reject_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/reject"
97
+ post(path) end
119
98
 
120
99
  # Reset linkage status between a client and firm back to requested
121
100
  #
@@ -126,11 +105,8 @@ module AvaTax
126
105
  # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
127
106
  # @param id [Integer]
128
107
  # @return [Object]
129
- def reset_firm_client_linkage(id)
130
- path = "/api/v2/firmclientlinkages/#{id}/reset"
131
- post(path)
132
- end
133
-
108
+ def reset_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/reset"
109
+ post(path) end
134
110
 
135
111
  # Revokes previously approved linkage to a firm for a client account
136
112
  #
@@ -141,11 +117,8 @@ module AvaTax
141
117
  # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
142
118
  # @param id [Integer]
143
119
  # @return [Object]
144
- def revoke_firm_client_linkage(id)
145
- path = "/api/v2/firmclientlinkages/#{id}/revoke"
146
- post(path)
147
- end
148
-
120
+ def revoke_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/revoke"
121
+ post(path) end
149
122
  end
150
123
  end
151
124
  end